Completed
Push — develop ( 171df5...06a03a )
by Gary
02:38
created

class-tgm-plugin-activation.php (1 issue)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
/**
3
 * Plugin installation and activation for WordPress themes.
4
 *
5
 * Please note that this is a drop-in library for a theme or plugin.
6
 * The authors of this library (Thomas, Gary and Juliette) are NOT responsible
7
 * for the support of your plugin or theme. Please contact the plugin
8
 * or theme author for support.
9
 *
10
 * @package   TGM-Plugin-Activation
11
 * @version   2.5.2
12
 * @link      http://tgmpluginactivation.com/
13
 * @author    Thomas Griffin, Gary Jones, Juliette Reinders Folmer
14
 * @copyright Copyright (c) 2011, Thomas Griffin
15
 * @license   GPL-2.0+
16
 */
17
18
/*
19
	Copyright 2011 Thomas Griffin (thomasgriffinmedia.com)
20
21
	This program is free software; you can redistribute it and/or modify
22
	it under the terms of the GNU General Public License, version 2, as
23
	published by the Free Software Foundation.
24
25
	This program is distributed in the hope that it will be useful,
26
	but WITHOUT ANY WARRANTY; without even the implied warranty of
27
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28
	GNU General Public License for more details.
29
30
	You should have received a copy of the GNU General Public License
31
	along with this program; if not, write to the Free Software
32
	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
33
*/
34
35
if ( ! class_exists( 'TGM_Plugin_Activation' ) ) {
36
37
	/**
38
	 * Automatic plugin installation and activation library.
39
	 *
40
	 * Creates a way to automatically install and activate plugins from within themes.
41
	 * The plugins can be either bundled, downloaded from the WordPress
42
	 * Plugin Repository or downloaded from another external source.
43
	 *
44
	 * @since 1.0.0
45
	 *
46
	 * @package TGM-Plugin-Activation
47
	 * @author  Thomas Griffin
48
	 * @author  Gary Jones
49
	 */
50
	class TGM_Plugin_Activation {
51
		/**
52
		 * TGMPA version number.
53
		 *
54
		 * @since 2.5.0
55
		 *
56
		 * @const string Version number.
57
		 */
58
		const TGMPA_VERSION = '2.5.2';
59
60
		/**
61
		 * Regular expression to test if a URL is a WP plugin repo URL.
62
		 *
63
		 * @const string Regex.
64
		 *
65
		 * @since 2.5.0
66
		 */
67
		const WP_REPO_REGEX = '|^http[s]?://wordpress\.org/(?:extend/)?plugins/|';
68
69
		/**
70
		 * Arbitrary regular expression to test if a string starts with a URL.
71
		 *
72
		 * @const string Regex.
73
		 *
74
		 * @since 2.5.0
75
		 */
76
		const IS_URL_REGEX = '|^http[s]?://|';
77
78
		/**
79
		 * Holds a copy of itself, so it can be referenced by the class name.
80
		 *
81
		 * @since 1.0.0
82
		 *
83
		 * @var TGM_Plugin_Activation
84
		 */
85
		public static $instance;
86
87
		/**
88
		 * Holds arrays of plugin details.
89
		 *
90
		 * @since 1.0.0
91
		 *
92
		 * @since 2.5.0 the array has the plugin slug as an associative key.
93
		 *
94
		 * @var array
95
		 */
96
		public $plugins = array();
97
98
		/**
99
		 * Holds arrays of plugin names to use to sort the plugins array.
100
		 *
101
		 * @since 2.5.0
102
		 *
103
		 * @var array
104
		 */
105
		protected $sort_order = array();
106
107
		/**
108
		 * Whether any plugins have the 'force_activation' setting set to true.
109
		 *
110
		 * @since 2.5.0
111
		 *
112
		 * @var bool
113
		 */
114
		protected $has_forced_activation = false;
115
116
		/**
117
		 * Whether any plugins have the 'force_deactivation' setting set to true.
118
		 *
119
		 * @since 2.5.0
120
		 *
121
		 * @var bool
122
		 */
123
		protected $has_forced_deactivation = false;
124
125
		/**
126
		 * Name of the unique ID to hash notices.
127
		 *
128
		 * @since 2.4.0
129
		 *
130
		 * @var string
131
		 */
132
		public $id = 'tgmpa';
133
134
		/**
135
		 * Name of the query-string argument for the admin page.
136
		 *
137
		 * @since 1.0.0
138
		 *
139
		 * @var string
140
		 */
141
		protected $menu = 'tgmpa-install-plugins';
142
143
		/**
144
		 * Parent menu file slug.
145
		 *
146
		 * @since 2.5.0
147
		 *
148
		 * @var string
149
		 */
150
		public $parent_slug = 'themes.php';
151
152
		/**
153
		 * Capability needed to view the plugin installation menu item.
154
		 *
155
		 * @since 2.5.0
156
		 *
157
		 * @var string
158
		 */
159
		public $capability = 'edit_theme_options';
160
161
		/**
162
		 * Default absolute path to folder containing bundled plugin zip files.
163
		 *
164
		 * @since 2.0.0
165
		 *
166
		 * @var string Absolute path prefix to zip file location for bundled plugins. Default is empty string.
167
		 */
168
		public $default_path = '';
169
170
		/**
171
		 * Flag to show admin notices or not.
172
		 *
173
		 * @since 2.1.0
174
		 *
175
		 * @var boolean
176
		 */
177
		public $has_notices = true;
178
179
		/**
180
		 * Flag to determine if the user can dismiss the notice nag.
181
		 *
182
		 * @since 2.4.0
183
		 *
184
		 * @var boolean
185
		 */
186
		public $dismissable = true;
187
188
		/**
189
		 * Message to be output above nag notice if dismissable is false.
190
		 *
191
		 * @since 2.4.0
192
		 *
193
		 * @var string
194
		 */
195
		public $dismiss_msg = '';
196
197
		/**
198
		 * Flag to set automatic activation of plugins. Off by default.
199
		 *
200
		 * @since 2.2.0
201
		 *
202
		 * @var boolean
203
		 */
204
		public $is_automatic = false;
205
206
		/**
207
		 * Optional message to display before the plugins table.
208
		 *
209
		 * @since 2.2.0
210
		 *
211
		 * @var string Message filtered by wp_kses_post(). Default is empty string.
212
		 */
213
		public $message = '';
214
215
		/**
216
		 * Holds configurable array of strings.
217
		 *
218
		 * Default values are added in the constructor.
219
		 *
220
		 * @since 2.0.0
221
		 *
222
		 * @var array
223
		 */
224
		public $strings = array();
225
226
		/**
227
		 * Holds the version of WordPress.
228
		 *
229
		 * @since 2.4.0
230
		 *
231
		 * @var int
232
		 */
233
		public $wp_version;
234
235
		/**
236
		 * Holds the hook name for the admin page.
237
		 *
238
		 * @since 2.5.0
239
		 *
240
		 * @var string
241
		 */
242
		public $page_hook;
243
244
		/**
245
		 * Adds a reference of this object to $instance, populates default strings,
246
		 * does the tgmpa_init action hook, and hooks in the interactions to init.
247
		 *
248
		 * {@internal This method should be `protected`, but as too many TGMPA implementations
249
		 * haven't upgraded beyond v2.3.6 yet, this gives backward compatibility issues.
250
		 * Reverted back to public for the time being.}}
251
		 *
252
		 * @since 1.0.0
253
		 *
254
		 * @see TGM_Plugin_Activation::init()
255
		 */
256
		public function __construct() {
257
			// Set the current WordPress version.
258
			$this->wp_version = $GLOBALS['wp_version'];
259
260
			// Announce that the class is ready, and pass the object (for advanced use).
261
			do_action_ref_array( 'tgmpa_init', array( $this ) );
262
263
			/*
264
			 * Load our text domain and allow for overloading the fall-back file.
265
			 *
266
			 * {@internal IMPORTANT! If this code changes, review the regex in the custom TGMPA
267
			 * generator on the website.}}
268
			 */
269
			add_action( 'init', array( $this, 'load_textdomain' ), 5 );
270
			add_filter( 'load_textdomain_mofile', array( $this, 'overload_textdomain_mofile' ), 10, 2 );
271
272
			// When the rest of WP has loaded, kick-start the rest of the class.
273
			add_action( 'init', array( $this, 'init' ) );
274
		}
275
276
		/**
277
		 * Magic method to (not) set protected properties from outside of this class.
278
		 *
279
		 * {@internal hackedihack... There is a serious bug in v2.3.2 - 2.3.6  where the `menu` property
280
		 * is being assigned rather than tested in a conditional, effectively rendering it useless.
281
		 * This 'hack' prevents this from happening.}}
282
		 *
283
		 * @see https://github.com/TGMPA/TGM-Plugin-Activation/blob/2.3.6/tgm-plugin-activation/class-tgm-plugin-activation.php#L1593
284
		 *
285
		 * @param string $name  Name of an inaccessible property.
286
		 * @param mixed  $value Value to assign to the property.
287
		 * @return void  Silently fail to set the property when this is tried from outside of this class context.
288
		 *               (Inside this class context, the __set() method if not used as there is direct access.)
289
		 */
290
		public function __set( $name, $value ) {
291
			return;
292
		}
293
294
		/**
295
		 * Magic method to get the value of a protected property outside of this class context.
296
		 *
297
		 * @param string $name Name of an inaccessible property.
298
		 * @return mixed The property value.
299
		 */
300
		public function __get( $name ) {
301
			return $this->{$name};
302
		}
303
304
		/**
305
		 * Initialise the interactions between this class and WordPress.
306
		 *
307
		 * Hooks in three new methods for the class: admin_menu, notices and styles.
308
		 *
309
		 * @since 2.0.0
310
		 *
311
		 * @see TGM_Plugin_Activation::admin_menu()
312
		 * @see TGM_Plugin_Activation::notices()
313
		 * @see TGM_Plugin_Activation::styles()
314
		 */
315
		public function init() {
316
			/**
317
			 * By default TGMPA only loads on the WP back-end and not in an Ajax call. Using this filter
318
			 * you can overrule that behaviour.
319
			 *
320
			 * @since 2.5.0
321
			 *
322
			 * @param bool $load Whether or not TGMPA should load.
323
			 *                   Defaults to the return of `is_admin() && ! defined( 'DOING_AJAX' )`.
324
			 */
325
			if ( true !== apply_filters( 'tgmpa_load', ( is_admin() && ! defined( 'DOING_AJAX' ) ) ) ) {
326
				return;
327
			}
328
329
			// Load class strings.
330
			$this->strings = array(
331
				'page_title'                      => __( 'Install Required Plugins', 'tgmpa' ),
332
				'menu_title'                      => __( 'Install Plugins', 'tgmpa' ),
333
				'installing'                      => __( 'Installing Plugin: %s', 'tgmpa' ),
334
				'updating'                        => __( 'Updating Plugin: %s', 'tgmpa' ),
335
				'oops'                            => __( 'Something went wrong with the plugin API.', 'tgmpa' ),
336
				'notice_can_install_required'     => _n_noop(
337
					'This theme requires the following plugin: %1$s.',
338
					'This theme requires the following plugins: %1$s.',
339
					'tgmpa'
340
				),
341
				'notice_can_install_recommended'  => _n_noop(
342
					'This theme recommends the following plugin: %1$s.',
343
					'This theme recommends the following plugins: %1$s.',
344
					'tgmpa'
345
				),
346
				'notice_ask_to_update'            => _n_noop(
347
					'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.',
348
					'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.',
349
					'tgmpa'
350
				),
351
				'notice_ask_to_update_maybe'      => _n_noop(
352
					'There is an update available for: %1$s.',
353
					'There are updates available for the following plugins: %1$s.',
354
					'tgmpa'
355
				),
356
				'notice_can_activate_required'    => _n_noop(
357
					'The following required plugin is currently inactive: %1$s.',
358
					'The following required plugins are currently inactive: %1$s.',
359
					'tgmpa'
360
				),
361
				'notice_can_activate_recommended' => _n_noop(
362
					'The following recommended plugin is currently inactive: %1$s.',
363
					'The following recommended plugins are currently inactive: %1$s.',
364
					'tgmpa'
365
				),
366
				'install_link'                    => _n_noop(
367
					'Begin installing plugin',
368
					'Begin installing plugins',
369
					'tgmpa'
370
				),
371
				'update_link'                     => _n_noop(
372
					'Begin updating plugin',
373
					'Begin updating plugins',
374
					'tgmpa'
375
				),
376
				'activate_link'                   => _n_noop(
377
					'Begin activating plugin',
378
					'Begin activating plugins',
379
					'tgmpa'
380
				),
381
				'return'                          => __( 'Return to Required Plugins Installer', 'tgmpa' ),
382
				'dashboard'                       => __( 'Return to the dashboard', 'tgmpa' ),
383
				'plugin_activated'                => __( 'Plugin activated successfully.', 'tgmpa' ),
384
				'activated_successfully'          => __( 'The following plugin was activated successfully:', 'tgmpa' ),
385
				'plugin_already_active'           => __( 'No action taken. Plugin %1$s was already active.', 'tgmpa' ),
386
				'plugin_needs_higher_version'     => __( 'Plugin not activated. A higher version of %s is needed for this theme. Please update the plugin.', 'tgmpa' ),
387
				'complete'                        => __( 'All plugins installed and activated successfully. %1$s', 'tgmpa' ),
388
				'dismiss'                         => __( 'Dismiss this notice', 'tgmpa' ),
389
				'notice_cannot_install_activate'  => __( 'There are one or more required or recommended plugins to install, update or activate.', 'tgmpa' ),
390
				'contact_admin'                   => __( 'Please contact the administrator of this site for help.', 'tgmpa' ),
391
			);
392
393
			do_action( 'tgmpa_register' );
394
395
			/* After this point, the plugins should be registered and the configuration set. */
396
397
			// Proceed only if we have plugins to handle.
398
			if ( empty( $this->plugins ) || ! is_array( $this->plugins ) ) {
399
				return;
400
			}
401
402
			// Set up the menu and notices if we still have outstanding actions.
403
			if ( true !== $this->is_tgmpa_complete() ) {
404
				// Sort the plugins.
405
				array_multisort( $this->sort_order, SORT_ASC, $this->plugins );
406
407
				add_action( 'admin_menu', array( $this, 'admin_menu' ) );
408
				add_action( 'admin_head', array( $this, 'dismiss' ) );
409
410
				// Prevent the normal links from showing underneath a single install/update page.
411
				add_filter( 'install_plugin_complete_actions', array( $this, 'actions' ) );
412
				add_filter( 'update_plugin_complete_actions', array( $this, 'actions' ) );
413
414
				if ( $this->has_notices ) {
415
					add_action( 'admin_notices', array( $this, 'notices' ) );
416
					add_action( 'admin_init', array( $this, 'admin_init' ), 1 );
417
					add_action( 'admin_enqueue_scripts', array( $this, 'thickbox' ) );
418
				}
419
			}
420
421
			// If needed, filter plugin action links.
422
			add_action( 'load-plugins.php', array( $this, 'add_plugin_action_link_filters' ), 1 );
423
424
			// Make sure things get reset on switch theme.
425
			add_action( 'switch_theme', array( $this, 'flush_plugins_cache' ) );
426
427
			if ( $this->has_notices ) {
428
				add_action( 'switch_theme', array( $this, 'update_dismiss' ) );
429
			}
430
431
			// Setup the force activation hook.
432
			if ( true === $this->has_forced_activation ) {
433
				add_action( 'admin_init', array( $this, 'force_activation' ) );
434
			}
435
436
			// Setup the force deactivation hook.
437
			if ( true === $this->has_forced_deactivation ) {
438
				add_action( 'switch_theme', array( $this, 'force_deactivation' ) );
439
			}
440
		}
441
442
		/**
443
		 * Load translations.
444
		 *
445
		 * @since 2.x.x
446
		 *
447
		 * (@internal Uses `load_theme_textdomain()` rather than `load_plugin_textdomain()` to
448
		 * get round the different ways of handling the path and deprecated notices being thrown
449
		 * and such. For plugins, the actual file name will be corrected by a filter.}}
450
		 *
451
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
452
		 * generator on the website.}}
453
		 */
454
		public function load_textdomain() {
455
			if ( is_textdomain_loaded( 'tgmpa' ) ) {
456
				return;
457
			}
458
459
			if ( false !== strpos( __FILE__, WP_PLUGIN_DIR ) || false !== strpos( __FILE__, WPMU_PLUGIN_DIR ) ) {
460
				// Plugin, we'll need to adjust the file name.
461
				add_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10, 2 );
462
				load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
463
				remove_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10 );
464
			} else {
465
				load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
466
			}
467
		}
468
469
		/**
470
		 * Correct the .mo file name for (must-use) plugins.
471
		 *
472
		 * Themese use `/path/{locale}.mo` while plugins use `/path/{text-domain}-{locale}.mo`.
473
		 *
474
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
475
		 * generator on the website.}}
476
		 *
477
		 * @since 2.x.x
478
		 *
479
		 * @param string $mofile Full path to the target mofile.
480
		 * @param string $domain The domain for which a language file is being loaded.
481
		 * @return string $mofile
482
		 */
483
		public function correct_plugin_mofile( $mofile, $domain ) {
484
			// Exit early if not our domain (just in case).
485
			if ( 'tgmpa' !== $domain ) {
486
				return $mofile;
487
			}
488
			return preg_replace( '`/([a-z]{2}_[A-Z]{2}.mo)$`', '/tgmpa-$1', $mofile );
489
		}
490
491
		/**
492
		 * Potentially overload the fall-back translation file for the current language.
493
		 *
494
		 * WP, by default since WP 3.7, will load a local translation first and if none
495
		 * can be found, will try and find a translation in the /wp-content/languages/ directory.
496
		 * As this library is theme/plugin agnostic, translation files for TGMPA can exist both
497
		 * in the WP_LANG_DIR /plugins/ subdirectory as well as in the /themes/ subdirectory.
498
		 *
499
		 * This method makes sure both directories are checked.
500
		 *
501
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
502
		 * generator on the website.}}
503
		 *
504
		 * @since 2.x.x
505
		 *
506
		 * @param string $mofile Full path to the target mofile.
507
		 * @param string $domain The domain for which a language file is being loaded.
508
		 * @return string $mofile
509
		 */
510
		public function overload_textdomain_mofile( $mofile, $domain ) {
511
			// Exit early if not our domain, not a WP_LANG_DIR load or if the file exists and is readable.
512
			if ( 'tgmpa' !== $domain || false === strpos( $mofile, WP_LANG_DIR ) || @is_readable( $mofile ) ) {
513
				return $mofile;
514
			}
515
516
			// Current fallback file is not valid, let's try the alternative option.
517
			if ( false !== strpos( $mofile, '/themes/' ) ) {
518
				return str_replace( '/themes/', '/plugins/', $mofile );
519
			} elseif ( false !== strpos( $mofile, '/plugins/' ) ) {
520
				return str_replace( '/plugins/', '/themes/', $mofile );
521
			} else {
522
				return $mofile;
523
			}
524
		}
525
526
		/**
527
		 * Hook in plugin action link filters for the WP native plugins page.
528
		 *
529
		 * - Prevent activation of plugins which don't meet the minimum version requirements.
530
		 * - Prevent deactivation of force-activated plugins.
531
		 * - Add update notice if update available.
532
		 *
533
		 * @since 2.5.0
534
		 */
535
		public function add_plugin_action_link_filters() {
536
			foreach ( $this->plugins as $slug => $plugin ) {
537
				if ( false === $this->can_plugin_activate( $slug ) ) {
538
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_activate' ), 20 );
539
				}
540
541
				if ( true === $plugin['force_activation'] ) {
542
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_deactivate' ), 20 );
543
				}
544
545
				if ( false !== $this->does_plugin_require_update( $slug ) ) {
546
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_update' ), 20 );
547
				}
548
			}
549
		}
550
551
		/**
552
		 * Remove the 'Activate' link on the WP native plugins page if the plugin does not meet the
553
		 * minimum version requirements.
554
		 *
555
		 * @since 2.5.0
556
		 *
557
		 * @param array $actions Action links.
558
		 * @return array
559
		 */
560
		public function filter_plugin_action_links_activate( $actions ) {
561
			unset( $actions['activate'] );
562
563
			return $actions;
564
		}
565
566
		/**
567
		 * Remove the 'Deactivate' link on the WP native plugins page if the plugin has been set to force activate.
568
		 *
569
		 * @since 2.5.0
570
		 *
571
		 * @param array $actions Action links.
572
		 * @return array
573
		 */
574
		public function filter_plugin_action_links_deactivate( $actions ) {
575
			unset( $actions['deactivate'] );
576
577
			return $actions;
578
		}
579
580
		/**
581
		 * Add a 'Requires update' link on the WP native plugins page if the plugin does not meet the
582
		 * minimum version requirements.
583
		 *
584
		 * @since 2.5.0
585
		 *
586
		 * @param array $actions Action links.
587
		 * @return array
588
		 */
589
		public function filter_plugin_action_links_update( $actions ) {
590
			$actions['update'] = sprintf(
591
				'<a href="%1$s" title="%2$s" class="edit">%3$s</a>',
592
				esc_url( $this->get_tgmpa_status_url( 'update' ) ),
593
				esc_attr__( 'This plugin needs to be updated to be compatible with your theme.', 'tgmpa' ),
594
				esc_html__( 'Update Required', 'tgmpa' )
595
			);
596
597
			return $actions;
598
		}
599
600
		/**
601
		 * Handles calls to show plugin information via links in the notices.
602
		 *
603
		 * We get the links in the admin notices to point to the TGMPA page, rather
604
		 * than the typical plugin-install.php file, so we can prepare everything
605
		 * beforehand.
606
		 *
607
		 * WP does not make it easy to show the plugin information in the thickbox -
608
		 * here we have to require a file that includes a function that does the
609
		 * main work of displaying it, enqueue some styles, set up some globals and
610
		 * finally call that function before exiting.
611
		 *
612
		 * Down right easy once you know how...
613
		 *
614
		 * Returns early if not the TGMPA page.
615
		 *
616
		 * @since 2.1.0
617
		 *
618
		 * @global string $tab Used as iframe div class names, helps with styling
619
		 * @global string $body_id Used as the iframe body ID, helps with styling
620
		 *
621
		 * @return null Returns early if not the TGMPA page.
622
		 */
623
		public function admin_init() {
624
			if ( ! $this->is_tgmpa_page() ) {
625
				return;
626
			}
627
628
			if ( isset( $_REQUEST['tab'] ) && 'plugin-information' === $_REQUEST['tab'] ) {
629
				// Needed for install_plugin_information().
630
				require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
631
632
				wp_enqueue_style( 'plugin-install' );
633
634
				global $tab, $body_id;
635
				$body_id = 'plugin-information';
636
				// @codingStandardsIgnoreStart
637
				$tab     = 'plugin-information';
638
				// @codingStandardsIgnoreEnd
639
640
				install_plugin_information();
641
642
				exit;
643
			}
644
		}
645
646
		/**
647
		 * Enqueue thickbox scripts/styles for plugin info.
648
		 *
649
		 * Thickbox is not automatically included on all admin pages, so we must
650
		 * manually enqueue it for those pages.
651
		 *
652
		 * Thickbox is only loaded if the user has not dismissed the admin
653
		 * notice or if there are any plugins left to install and activate.
654
		 *
655
		 * @since 2.1.0
656
		 */
657
		public function thickbox() {
658
			if ( ! get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) ) {
659
				add_thickbox();
660
			}
661
		}
662
663
		/**
664
		 * Adds submenu page if there are plugin actions to take.
665
		 *
666
		 * This method adds the submenu page letting users know that a required
667
		 * plugin needs to be installed.
668
		 *
669
		 * This page disappears once the plugin has been installed and activated.
670
		 *
671
		 * @since 1.0.0
672
		 *
673
		 * @see TGM_Plugin_Activation::init()
674
		 * @see TGM_Plugin_Activation::install_plugins_page()
675
		 *
676
		 * @return null Return early if user lacks capability to install a plugin.
677
		 */
678
		public function admin_menu() {
679
			// Make sure privileges are correct to see the page.
680
			if ( ! current_user_can( 'install_plugins' ) ) {
681
				return;
682
			}
683
684
			$args = apply_filters(
685
				'tgmpa_admin_menu_args',
686
				array(
687
					'parent_slug' => $this->parent_slug,                     // Parent Menu slug.
688
					'page_title'  => $this->strings['page_title'],           // Page title.
689
					'menu_title'  => $this->strings['menu_title'],           // Menu title.
690
					'capability'  => $this->capability,                      // Capability.
691
					'menu_slug'   => $this->menu,                            // Menu slug.
692
					'function'    => array( $this, 'install_plugins_page' ), // Callback.
693
				)
694
			);
695
696
			$this->add_admin_menu( $args );
697
		}
698
699
		/**
700
		 * Add the menu item.
701
		 *
702
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
703
		 * generator on the website.}}
704
		 *
705
		 * @since 2.5.0
706
		 *
707
		 * @param array $args Menu item configuration.
708
		 */
709
		protected function add_admin_menu( array $args ) {
710
			if ( has_filter( 'tgmpa_admin_menu_use_add_theme_page' ) ) {
711
				_deprecated_function( 'The "tgmpa_admin_menu_use_add_theme_page" filter', '2.5.0', esc_html__( 'Set the parent_slug config variable instead.', 'tgmpa' ) );
712
			}
713
714
			if ( 'themes.php' === $this->parent_slug ) {
715
				$this->page_hook = call_user_func( 'add_theme_page', $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
716
			} else {
717
				$this->page_hook = call_user_func( 'add_submenu_page', $args['parent_slug'], $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
718
			}
719
		}
720
721
		/**
722
		 * Echoes plugin installation form.
723
		 *
724
		 * This method is the callback for the admin_menu method function.
725
		 * This displays the admin page and form area where the user can select to install and activate the plugin.
726
		 * Aborts early if we're processing a plugin installation action.
727
		 *
728
		 * @since 1.0.0
729
		 *
730
		 * @return null Aborts early if we're processing a plugin installation action.
731
		 */
732
		public function install_plugins_page() {
733
			// Store new instance of plugin table in object.
734
			$plugin_table = new TGMPA_List_Table;
735
736
			// Return early if processing a plugin installation action.
737
			if ( ( ( 'tgmpa-bulk-install' === $plugin_table->current_action() || 'tgmpa-bulk-update' === $plugin_table->current_action() ) && $plugin_table->process_bulk_actions() ) || $this->do_plugin_install() ) {
738
				return;
739
			}
740
741
			// Force refresh of available plugin information so we'll know about manual updates/deletes.
742
			wp_clean_plugins_cache( false );
743
744
			?>
745
			<div class="tgmpa wrap">
746
				<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
747
				<?php $plugin_table->prepare_items(); ?>
748
749
				<?php
750
				if ( ! empty( $this->message ) && is_string( $this->message ) ) {
751
					echo wp_kses_post( $this->message );
752
				}
753
				?>
754
				<?php $plugin_table->views(); ?>
755
756
				<form id="tgmpa-plugins" action="" method="post">
757
					<input type="hidden" name="tgmpa-page" value="<?php echo esc_attr( $this->menu ); ?>" />
758
					<input type="hidden" name="plugin_status" value="<?php echo esc_attr( $plugin_table->view_context ); ?>" />
759
					<?php $plugin_table->display(); ?>
760
				</form>
761
			</div>
762
			<?php
763
		}
764
765
		/**
766
		 * Installs, updates or activates a plugin depending on the action link clicked by the user.
767
		 *
768
		 * Checks the $_GET variable to see which actions have been
769
		 * passed and responds with the appropriate method.
770
		 *
771
		 * Uses WP_Filesystem to process and handle the plugin installation
772
		 * method.
773
		 *
774
		 * @since 1.0.0
775
		 *
776
		 * @uses WP_Filesystem
777
		 * @uses WP_Error
778
		 * @uses WP_Upgrader
779
		 * @uses Plugin_Upgrader
780
		 * @uses Plugin_Installer_Skin
781
		 * @uses Plugin_Upgrader_Skin
782
		 *
783
		 * @return boolean True on success, false on failure.
784
		 */
785
		protected function do_plugin_install() {
786
			if ( empty( $_GET['plugin'] ) ) {
787
				return false;
788
			}
789
790
			// All plugin information will be stored in an array for processing.
791
			$slug = $this->sanitize_key( urldecode( $_GET['plugin'] ) );
792
793
			if ( ! isset( $this->plugins[ $slug ] ) ) {
794
				return false;
795
			}
796
797
			// Was an install or upgrade action link clicked?
798
			if ( ( isset( $_GET['tgmpa-install'] ) && 'install-plugin' === $_GET['tgmpa-install'] ) || ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) ) {
799
800
				$install_type = 'install';
801
				if ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) {
802
					$install_type = 'update';
803
				}
804
805
				check_admin_referer( 'tgmpa-' . $install_type, 'tgmpa-nonce' );
806
807
				// Pass necessary information via URL if WP_Filesystem is needed.
808
				$url = wp_nonce_url(
809
					add_query_arg(
810
						array(
811
							'plugin'                 => urlencode( $slug ),
812
							'tgmpa-' . $install_type => $install_type . '-plugin',
813
						),
814
						$this->get_tgmpa_url()
815
					),
816
					'tgmpa-' . $install_type,
817
					'tgmpa-nonce'
818
				);
819
820
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
821
822
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, array() ) ) ) {
823
					return true;
824
				}
825
826 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
827
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem.
828
					return true;
829
				}
830
831
				/* If we arrive here, we have the filesystem. */
832
833
				// Prep variables for Plugin_Installer_Skin class.
834
				$extra         = array();
835
				$extra['slug'] = $slug; // Needed for potentially renaming of directory name.
836
				$source        = $this->get_download_url( $slug );
837
				$api           = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null;
838
				$api           = ( false !== $api ) ? $api : null;
839
840
				$url = add_query_arg(
841
					array(
842
						'action' => $install_type . '-plugin',
843
						'plugin' => urlencode( $slug ),
844
					),
845
					'update.php'
846
				);
847
848
				if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
849
					require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
850
				}
851
852
				$title     = ( 'update' === $install_type ) ? $this->strings['updating'] : $this->strings['installing'];
853
				$skin_args = array(
854
					'type'   => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload',
855
					'title'  => sprintf( $title, $this->plugins[ $slug ]['name'] ),
856
					'url'    => esc_url_raw( $url ),
857
					'nonce'  => $install_type . '-plugin_' . $slug,
858
					'plugin' => '',
859
					'api'    => $api,
860
					'extra'  => $extra,
861
				);
862
				unset( $title );
863
864
				if ( 'update' === $install_type ) {
865
					$skin_args['plugin'] = $this->plugins[ $slug ]['file_path'];
866
					$skin                = new Plugin_Upgrader_Skin( $skin_args );
867
				} else {
868
					$skin = new Plugin_Installer_Skin( $skin_args );
869
				}
870
871
				// Create a new instance of Plugin_Upgrader.
872
				$upgrader = new Plugin_Upgrader( $skin );
873
874
				// Perform the action and install the plugin from the $source urldecode().
875
				add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
876
877
				if ( 'update' === $install_type ) {
878
					// Inject our info into the update transient.
879
					$to_inject                    = array( $slug => $this->plugins[ $slug ] );
880
					$to_inject[ $slug ]['source'] = $source;
881
					$this->inject_update_info( $to_inject );
882
883
					$upgrader->upgrade( $this->plugins[ $slug ]['file_path'] );
884
				} else {
885
					$upgrader->install( $source );
886
				}
887
888
				remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1 );
889
890
				// Make sure we have the correct file path now the plugin is installed/updated.
891
				$this->populate_file_path( $slug );
892
893
				// Only activate plugins if the config option is set to true and the plugin isn't
894
				// already active (upgrade).
895
				if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) {
896
					$plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method.
897
					if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) {
898
						return true; // Finish execution of the function early as we encountered an error.
899
					}
900
				}
901
902
				$this->show_tgmpa_version();
903
904
				// Display message based on if all plugins are now active or not.
905
				if ( $this->is_tgmpa_complete() ) {
906
					echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>' ), '</p>';
907
					echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
908
				} else {
909
					echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
910
				}
911
912
				return true;
913
			} elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) {
914
				// Activate action link was clicked.
915
				check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' );
916
917
				if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) {
918
					return true; // Finish execution of the function early as we encountered an error.
919
				}
920
			}
921
922
			return false;
923
		}
924
925
		/**
926
		 * Inject information into the 'update_plugins' site transient as WP checks that before running an update.
927
		 *
928
		 * @since 2.5.0
929
		 *
930
		 * @param array $plugins The plugin information for the plugins which are to be updated.
931
		 */
932
		public function inject_update_info( $plugins ) {
933
			$repo_updates = get_site_transient( 'update_plugins' );
934
935
			if ( ! is_object( $repo_updates ) ) {
936
				$repo_updates = new stdClass;
937
			}
938
939
			foreach ( $plugins as $slug => $plugin ) {
940
				$file_path = $plugin['file_path'];
941
942
				if ( empty( $repo_updates->response[ $file_path ] ) ) {
943
					$repo_updates->response[ $file_path ] = new stdClass;
944
				}
945
946
				// We only really need to set package, but let's do all we can in case WP changes something.
947
				$repo_updates->response[ $file_path ]->slug        = $slug;
948
				$repo_updates->response[ $file_path ]->plugin      = $file_path;
949
				$repo_updates->response[ $file_path ]->new_version = $plugin['version'];
950
				$repo_updates->response[ $file_path ]->package     = $plugin['source'];
951
				if ( empty( $repo_updates->response[ $file_path ]->url ) && ! empty( $plugin['external_url'] ) ) {
952
					$repo_updates->response[ $file_path ]->url = $plugin['external_url'];
953
				}
954
			}
955
956
			set_site_transient( 'update_plugins', $repo_updates );
957
		}
958
959
		/**
960
		 * Adjust the plugin directory name if necessary.
961
		 *
962
		 * The final destination directory of a plugin is based on the subdirectory name found in the
963
		 * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this
964
		 * subdirectory name is not the same as the expected slug and the plugin will not be recognized
965
		 * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to
966
		 * the expected plugin slug.
967
		 *
968
		 * @since 2.5.0
969
		 *
970
		 * @param string       $source        Path to upgrade/zip-file-name.tmp/subdirectory/.
971
		 * @param string       $remote_source Path to upgrade/zip-file-name.tmp.
972
		 * @param \WP_Upgrader $upgrader      Instance of the upgrader which installs the plugin.
973
		 * @return string $source
974
		 */
975
		public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
976
			if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) {
977
				return $source;
978
			}
979
980
			// Check for single file plugins.
981
			$source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) );
982
			if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) {
983
				return $source;
984
			}
985
986
			// Multi-file plugin, let's see if the directory is correctly named.
987
			$desired_slug = '';
988
989
			// Figure out what the slug is supposed to be.
990
			if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) {
991
				$desired_slug = $upgrader->skin->options['extra']['slug'];
992
			} else {
993
				// Bulk installer contains less info, so fall back on the info registered here.
994
				foreach ( $this->plugins as $slug => $plugin ) {
995
					if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) {
996
						$desired_slug = $slug;
997
						break;
998
					}
999
				}
1000
				unset( $slug, $plugin );
1001
			}
1002
1003
			if ( ! empty( $desired_slug ) ) {
1004
				$subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
1005
1006
				if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
1007
					$from = untrailingslashit( $source );
1008
					$to   = trailingslashit( $remote_source ) . $desired_slug;
1009
1010
					if ( true === $GLOBALS['wp_filesystem']->move( $from, $to ) ) {
1011
						return trailingslashit( $to );
1012 View Code Duplication
					} else {
1013
						return new WP_Error( 'rename_failed', esc_html__( 'The remote plugin package does not contain a folder with the desired slug and renaming did not work.', 'tgmpa' ) . ' ' . esc_html__( 'Please contact the plugin provider and ask them to package their plugin according to the WordPress guidelines.', 'tgmpa' ), array( 'found' => $subdir_name, 'expected' => $desired_slug ) );
1014
					}
1015 View Code Duplication
				} elseif ( empty( $subdir_name ) ) {
1016
					return new WP_Error( 'packaged_wrong', esc_html__( 'The remote plugin package consists of more than one file, but the files are not packaged in a folder.', 'tgmpa' ) . ' ' . esc_html__( 'Please contact the plugin provider and ask them to package their plugin according to the WordPress guidelines.', 'tgmpa' ), array( 'found' => $subdir_name, 'expected' => $desired_slug ) );
1017
				}
1018
			}
1019
1020
			return $source;
1021
		}
1022
1023
		/**
1024
		 * Activate a single plugin and send feedback about the result to the screen.
1025
		 *
1026
		 * @since 2.5.0
1027
		 *
1028
		 * @param string $file_path Path within wp-plugins/ to main plugin file.
1029
		 * @param string $slug      Plugin slug.
1030
		 * @param bool   $automatic Whether this is an automatic activation after an install. Defaults to false.
1031
		 *                          This determines the styling of the output messages.
1032
		 * @return bool False if an error was encountered, true otherwise.
1033
		 */
1034
		protected function activate_single_plugin( $file_path, $slug, $automatic = false ) {
1035
			if ( $this->can_plugin_activate( $slug ) ) {
1036
				$activate = activate_plugin( $file_path );
1037
1038
				if ( is_wp_error( $activate ) ) {
1039
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>',
1040
						'<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
1041
1042
					return false; // End it here if there is an error with activation.
1043
				} else {
1044
					if ( ! $automatic ) {
1045
						// Make sure message doesn't display again if bulk activation is performed
1046
						// immediately after a single activation.
1047
						if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1048
							echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>';
1049
						}
1050
					} else {
1051
						// Simpler message layout for use on the plugin install page.
1052
						echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>';
1053
					}
1054
				}
1055 View Code Duplication
			} elseif ( $this->is_plugin_active( $slug ) ) {
1056
				// No simpler message format provided as this message should never be encountered
1057
				// on the plugin install page.
1058
				echo '<div id="message" class="error"><p>',
1059
					sprintf(
1060
						esc_html( $this->strings['plugin_already_active'] ),
1061
						'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1062
					),
1063
					'</p></div>';
1064
			} elseif ( $this->does_plugin_require_update( $slug ) ) {
1065
				if ( ! $automatic ) {
1066
					// Make sure message doesn't display again if bulk activation is performed
1067
					// immediately after a single activation.
1068 View Code Duplication
					if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1069
						echo '<div id="message" class="error"><p>',
1070
							sprintf(
1071
								esc_html( $this->strings['plugin_needs_higher_version'] ),
1072
								'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1073
							),
1074
							'</p></div>';
1075
					}
1076
				} else {
1077
					// Simpler message layout for use on the plugin install page.
1078
					echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>';
1079
				}
1080
			}
1081
1082
			return true;
1083
		}
1084
1085
		/**
1086
		 * Echoes required plugin notice.
1087
		 *
1088
		 * Outputs a message telling users that a specific plugin is required for
1089
		 * their theme. If appropriate, it includes a link to the form page where
1090
		 * users can install and activate the plugin.
1091
		 *
1092
		 * Returns early if we're on the Install page.
1093
		 *
1094
		 * @since 1.0.0
1095
		 *
1096
		 * @global object $current_screen
1097
		 *
1098
		 * @return null Returns early if we're on the Install page.
1099
		 */
1100
		public function notices() {
1101
			// Remove nag on the install page / Return early if the nag message has been dismissed or user < author.
1102
			if ( $this->is_tgmpa_page() || get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) || ! current_user_can( apply_filters( 'tgmpa_show_admin_notice_capability', 'publish_posts' ) ) ) {
1103
				return;
1104
			}
1105
1106
			// Store for the plugin slugs by message type.
1107
			$message = array();
1108
1109
			// Initialize counters used to determine plurality of action link texts.
1110
			$install_link_count          = 0;
1111
			$update_link_count           = 0;
1112
			$activate_link_count         = 0;
1113
			$total_required_action_count = 0;
1114
1115
			foreach ( $this->plugins as $slug => $plugin ) {
1116
				if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) {
1117
					continue;
1118
				}
1119
1120
				if ( ! $this->is_plugin_installed( $slug ) ) {
1121
					if ( current_user_can( 'install_plugins' ) ) {
1122
						$install_link_count++;
1123
1124
						if ( true === $plugin['required'] ) {
1125
							$message['notice_can_install_required'][] = $slug;
1126
						} else {
1127
							$message['notice_can_install_recommended'][] = $slug;
1128
						}
1129
					}
1130
					if ( true === $plugin['required'] ) {
1131
						$total_required_action_count++;
1132
					}
1133
				} else {
1134
					if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) {
1135
						if ( current_user_can( 'activate_plugins' ) ) {
1136
							$activate_link_count++;
1137
1138
							if ( true === $plugin['required'] ) {
1139
								$message['notice_can_activate_required'][] = $slug;
1140
							} else {
1141
								$message['notice_can_activate_recommended'][] = $slug;
1142
							}
1143
						}
1144
						if ( true === $plugin['required'] ) {
1145
							$total_required_action_count++;
1146
						}
1147
					}
1148
1149
					if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1150
1151
						if ( current_user_can( 'update_plugins' ) ) {
1152
							$update_link_count++;
1153
1154
							if ( $this->does_plugin_require_update( $slug ) ) {
1155
								$message['notice_ask_to_update'][] = $slug;
1156
							} elseif ( false !== $this->does_plugin_have_update( $slug ) ) {
1157
								$message['notice_ask_to_update_maybe'][] = $slug;
1158
							}
1159
						}
1160
						if ( true === $plugin['required'] ) {
1161
							$total_required_action_count++;
1162
						}
1163
					}
1164
				}
1165
			}
1166
			unset( $slug, $plugin );
1167
1168
			// If we have notices to display, we move forward.
1169
			if ( ! empty( $message ) || $total_required_action_count > 0 ) {
1170
				krsort( $message ); // Sort messages.
1171
				$rendered = '';
1172
1173
				// As add_settings_error() wraps the final message in a <p> and as the final message can't be
1174
				// filtered, using <p>'s in our html would render invalid html output.
1175
				$line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n";
1176
1177
				if ( ! current_user_can( 'activate_plugins' ) && ! current_user_can( 'install_plugins' ) && ! current_user_can( 'update_plugins' ) ) {
1178
					$rendered = esc_html__( $this->strings['notice_cannot_install_activate'] ) . ' ' . esc_html__( $this->strings['contact_admin'] );
1179
					$rendered .= $this->create_user_action_links_for_notice( 0, 0, 0, $line_template );
1180
				} else {
1181
1182
					// If dismissable is false and a message is set, output it now.
1183
					if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) {
1184
						$rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) );
1185
					}
1186
1187
					// Render the individual message lines for the notice.
1188
					foreach ( $message as $type => $plugin_group ) {
1189
						$linked_plugins = array();
1190
1191
						// Get the external info link for a plugin if one is available.
1192
						foreach ( $plugin_group as $plugin_slug ) {
1193
							$linked_plugins[] = $this->get_info_link( $plugin_slug );
1194
						}
1195
						unset( $plugin_slug );
1196
1197
						$count          = count( $plugin_group );
1198
						$linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins );
1199
						$last_plugin    = array_pop( $linked_plugins ); // Pop off last name to prep for readability.
1200
						$imploded       = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
1201
1202
						$rendered .= sprintf(
1203
							$line_template,
1204
							sprintf(
1205
								translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ),
1206
								$imploded,
1207
								$count
1208
							)
1209
						);
1210
1211
					}
1212
					unset( $type, $plugin_group, $linked_plugins, $count, $last_plugin, $imploded );
1213
1214
					$rendered .= $this->create_user_action_links_for_notice( $install_link_count, $update_link_count, $activate_link_count, $line_template );
1215
				}
1216
1217
				// Register the nag messages and prepare them to be processed.
1218
				add_settings_error( 'tgmpa', 'tgmpa', $rendered, $this->get_admin_notice_class() );
1219
			}
1220
1221
			// Admin options pages already output settings_errors, so this is to avoid duplication.
1222
			if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) {
1223
				$this->display_settings_errors();
1224
			}
1225
		}
1226
1227
		/**
1228
		 * Generate the user action links for the admin notice.
1229
		 *
1230
		 * @since 2.x.x
1231
		 *
1232
		 * @param int $install_count  Number of plugins to install.
1233
		 * @param int $update_count   Number of plugins to update.
1234
		 * @param int $activate_count Number of plugins to activate.
1235
		 * @param int $line_template  Template for the HTML tag to output a line.
1236
		 * @return string Action links.
1237
		 */
1238
		protected function create_user_action_links_for_notice( $install_count, $update_count, $activate_count, $line_template ) {
1239
			// Setup action links.
1240
			$action_links = array(
1241
				'install'  => '',
1242
				'update'   => '',
1243
				'activate' => '',
1244
				'dismiss'  => $this->dismissable ? '<a href="' . esc_url( wp_nonce_url( add_query_arg( 'tgmpa-dismiss', 'dismiss_admin_notices' ), 'tgmpa-dismiss-' . get_current_user_id() ) ) . '" class="dismiss-notice" target="_parent">' . esc_html( $this->strings['dismiss'] ) . '</a>' : '',
1245
			);
1246
1247
			$link_template = '<a href="%2$s">%1$s</a>';
1248
1249
			if ( current_user_can( 'install_plugins' ) ) {
1250 View Code Duplication
				if ( $install_count > 0 ) {
1251
					$action_links['install'] = sprintf(
1252
						$link_template,
1253
						translate_nooped_plural( $this->strings['install_link'], $install_count, 'tgmpa' ),
1254
						esc_url( $this->get_tgmpa_status_url( 'install' ) )
1255
					);
1256
				}
1257 View Code Duplication
				if ( $update_count > 0 ) {
1258
					$action_links['update'] = sprintf(
1259
						$link_template,
1260
						translate_nooped_plural( $this->strings['update_link'], $update_count, 'tgmpa' ),
1261
						esc_url( $this->get_tgmpa_status_url( 'update' ) )
1262
					);
1263
				}
1264
			}
1265
1266 View Code Duplication
			if ( current_user_can( 'activate_plugins' ) && $activate_count > 0 ) {
1267
				$action_links['activate'] = sprintf(
1268
					$link_template,
1269
					translate_nooped_plural( $this->strings['activate_link'], $activate_count, 'tgmpa' ),
1270
					esc_url( $this->get_tgmpa_status_url( 'activate' ) )
1271
				);
1272
			}
1273
1274
			$action_links = apply_filters( 'tgmpa_notice_action_links', $action_links );
1275
1276
			$action_links = array_filter( (array) $action_links ); // Remove any empty array items.
1277
1278
			if ( ! empty( $action_links ) ) {
1279
				$action_links = sprintf( $line_template, implode( ' | ', $action_links ) );
1280
				return apply_filters( 'tgmpa_notice_rendered_action_links', $action_links );
1281
			} else {
1282
				return '';
1283
			}
1284
		}
1285
1286
		/**
1287
		 * Get admin notice class.
1288
		 *
1289
		 * Work around all the changes to the various admin notice classes between WP 4.4 and 3.7
1290
		 * (lowest supported version by TGMPA).
1291
		 *
1292
		 * @since 2.x.x
1293
		 *
1294
		 * @return string
1295
		 */
1296
		protected function get_admin_notice_class() {
1297
			if ( ! empty( $this->strings['nag_type'] ) ) {
1298
				return sanitize_html_class( strtolower( $this->strings['nag_type'] ) );
1299
			} else {
1300
				if ( version_compare( $this->wp_version, '4.2', '>=' ) ) {
1301
					return 'notice-warning';
1302
				} elseif ( version_compare( $this->wp_version, '4.1', '>=' ) ) {
1303
					return 'notice';
1304
				} else {
1305
					return 'updated';
1306
				}
1307
			}
1308
		}
1309
1310
		/**
1311
		 * Display settings errors and remove those which have been displayed to avoid duplicate messages showing
1312
		 *
1313
		 * @since 2.5.0
1314
		 */
1315
		protected function display_settings_errors() {
1316
			global $wp_settings_errors;
1317
1318
			settings_errors( 'tgmpa' );
1319
1320
			foreach ( (array) $wp_settings_errors as $key => $details ) {
1321
				if ( 'tgmpa' === $details['setting'] ) {
1322
					unset( $wp_settings_errors[ $key ] );
1323
					break;
1324
				}
1325
			}
1326
		}
1327
1328
		/**
1329
		 * Register dismissal of admin notices.
1330
		 *
1331
		 * Acts on the dismiss link in the admin nag messages.
1332
		 * If clicked, the admin notice disappears and will no longer be visible to this user.
1333
		 *
1334
		 * @since 2.1.0
1335
		 */
1336
		public function dismiss() {
1337
			if ( isset( $_GET['tgmpa-dismiss'] ) && check_admin_referer( 'tgmpa-dismiss-' . get_current_user_id() ) ) {
1338
				update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
1339
			}
1340
		}
1341
1342
		/**
1343
		 * Add individual plugin to our collection of plugins.
1344
		 *
1345
		 * If the required keys are not set or the plugin has already
1346
		 * been registered, the plugin is not added.
1347
		 *
1348
		 * @since 2.0.0
1349
		 *
1350
		 * @param array|null $plugin Array of plugin arguments or null if invalid argument.
1351
		 * @return null Return early if incorrect argument.
1352
		 */
1353
		public function register( $plugin ) {
1354
			if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
1355
				return;
1356
			}
1357
1358
			if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
1359
				return;
1360
			}
1361
1362
			$defaults = array(
1363
				'name'               => '',      // String
1364
				'slug'               => '',      // String
1365
				'source'             => 'repo',  // String
1366
				'required'           => false,   // Boolean
1367
				'version'            => '',      // String
1368
				'force_activation'   => false,   // Boolean
1369
				'force_deactivation' => false,   // Boolean
1370
				'external_url'       => '',      // String
1371
				'is_callable'        => '',      // String|Array.
1372
			);
1373
1374
			// Prepare the received data.
1375
			$plugin = wp_parse_args( $plugin, $defaults );
1376
1377
			// Standardize the received slug.
1378
			$plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
1379
1380
			// Forgive users for using string versions of booleans or floats for version number.
1381
			$plugin['version']            = (string) $plugin['version'];
1382
			$plugin['source']             = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
1383
			$plugin['required']           = TGMPA_Utils::validate_bool( $plugin['required'] );
1384
			$plugin['force_activation']   = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
1385
			$plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
1386
1387
			// Enrich the received data.
1388
			$plugin['file_path']   = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
1389
			$plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
1390
1391
			// Set the class properties.
1392
			$this->plugins[ $plugin['slug'] ]    = $plugin;
1393
			$this->sort_order[ $plugin['slug'] ] = $plugin['name'];
1394
1395
			// Should we add the force activation hook ?
1396
			if ( true === $plugin['force_activation'] ) {
1397
				$this->has_forced_activation = true;
1398
			}
1399
1400
			// Should we add the force deactivation hook ?
1401
			if ( true === $plugin['force_deactivation'] ) {
1402
				$this->has_forced_deactivation = true;
1403
			}
1404
		}
1405
1406
		/**
1407
		 * Determine what type of source the plugin comes from.
1408
		 *
1409
		 * @since 2.5.0
1410
		 *
1411
		 * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
1412
		 *                       (= bundled) or an external URL.
1413
		 * @return string 'repo', 'external', or 'bundled'
1414
		 */
1415
		protected function get_plugin_source_type( $source ) {
1416
			if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
1417
				return 'repo';
1418
			} elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
1419
				return 'external';
1420
			} else {
1421
				return 'bundled';
1422
			}
1423
		}
1424
1425
		/**
1426
		 * Sanitizes a string key.
1427
		 *
1428
		 * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
1429
		 * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
1430
		 * characters in the plugin directory path/slug. Silly them.
1431
		 *
1432
		 * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
1433
		 *
1434
		 * @since 2.5.0
1435
		 *
1436
		 * @param string $key String key.
1437
		 * @return string Sanitized key
1438
		 */
1439
		public function sanitize_key( $key ) {
1440
			$raw_key = $key;
1441
			$key     = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
1442
1443
			/**
1444
			* Filter a sanitized key string.
1445
			*
1446
			* @since 3.0.0
1447
			*
1448
			* @param string $key     Sanitized key.
1449
			* @param string $raw_key The key prior to sanitization.
1450
			*/
1451
			return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
1452
		}
1453
1454
		/**
1455
		 * Amend default configuration settings.
1456
		 *
1457
		 * @since 2.0.0
1458
		 *
1459
		 * @param array $config Array of config options to pass as class properties.
1460
		 */
1461
		public function config( $config ) {
1462
			$keys = array(
1463
				'id',
1464
				'default_path',
1465
				'has_notices',
1466
				'dismissable',
1467
				'dismiss_msg',
1468
				'menu',
1469
				'parent_slug',
1470
				'capability',
1471
				'is_automatic',
1472
				'message',
1473
				'strings',
1474
			);
1475
1476
			foreach ( $keys as $key ) {
1477
				if ( isset( $config[ $key ] ) ) {
1478
					if ( is_array( $config[ $key ] ) ) {
1479
						$this->$key = array_merge( $this->$key, $config[ $key ] );
1480
					} else {
1481
						$this->$key = $config[ $key ];
1482
					}
1483
				}
1484
			}
1485
		}
1486
1487
		/**
1488
		 * Amend action link after plugin installation.
1489
		 *
1490
		 * @since 2.0.0
1491
		 *
1492
		 * @param array $install_actions Existing array of actions.
1493
		 * @return array Amended array of actions.
1494
		 */
1495
		public function actions( $install_actions ) {
1496
			// Remove action links on the TGMPA install page.
1497
			if ( $this->is_tgmpa_page() ) {
1498
				return false;
1499
			}
1500
1501
			return $install_actions;
1502
		}
1503
1504
		/**
1505
		 * Flushes the plugins cache on theme switch to prevent stale entries
1506
		 * from remaining in the plugin table.
1507
		 *
1508
		 * @since 2.4.0
1509
		 *
1510
		 * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
1511
		 *                                 Parameter added in v2.5.0.
1512
		 */
1513
		public function flush_plugins_cache( $clear_update_cache = true ) {
1514
			wp_clean_plugins_cache( $clear_update_cache );
1515
		}
1516
1517
		/**
1518
		 * Set file_path key for each installed plugin.
1519
		 *
1520
		 * @since 2.1.0
1521
		 *
1522
		 * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
1523
		 *                            Parameter added in v2.5.0.
1524
		 */
1525
		public function populate_file_path( $plugin_slug = '' ) {
1526
			if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
1527
				$this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
1528
			} else {
1529
				// Add file_path key for all plugins.
1530
				foreach ( $this->plugins as $slug => $values ) {
1531
					$this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
1532
				}
1533
			}
1534
		}
1535
1536
		/**
1537
		 * Helper function to extract the file path of the plugin file from the
1538
		 * plugin slug, if the plugin is installed.
1539
		 *
1540
		 * @since 2.0.0
1541
		 *
1542
		 * @param string $slug Plugin slug (typically folder name) as provided by the developer.
1543
		 * @return string Either file path for plugin if installed, or just the plugin slug.
1544
		 */
1545
		protected function _get_plugin_basename_from_slug( $slug ) {
1546
			$keys = array_keys( $this->get_plugins() );
1547
1548
			foreach ( $keys as $key ) {
1549
				if ( preg_match( '|^' . $slug . '/|', $key ) ) {
1550
					return $key;
1551
				}
1552
			}
1553
1554
			return $slug;
1555
		}
1556
1557
		/**
1558
		 * Retrieve plugin data, given the plugin name.
1559
		 *
1560
		 * Loops through the registered plugins looking for $name. If it finds it,
1561
		 * it returns the $data from that plugin. Otherwise, returns false.
1562
		 *
1563
		 * @since 2.1.0
1564
		 *
1565
		 * @param string $name Name of the plugin, as it was registered.
1566
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
1567
		 * @return string|boolean Plugin slug if found, false otherwise.
1568
		 */
1569
		public function _get_plugin_data_from_name( $name, $data = 'slug' ) {
1570
			foreach ( $this->plugins as $values ) {
1571
				if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
1572
					return $values[ $data ];
1573
				}
1574
			}
1575
1576
			return false;
1577
		}
1578
1579
		/**
1580
		 * Retrieve the download URL for a package.
1581
		 *
1582
		 * @since 2.5.0
1583
		 *
1584
		 * @param string $slug Plugin slug.
1585
		 * @return string Plugin download URL or path to local file or empty string if undetermined.
1586
		 */
1587
		public function get_download_url( $slug ) {
1588
			$dl_source = '';
1589
1590
			switch ( $this->plugins[ $slug ]['source_type'] ) {
1591
				case 'repo':
1592
					return $this->get_wp_repo_download_url( $slug );
1593
				case 'external':
1594
					return $this->plugins[ $slug ]['source'];
1595
				case 'bundled':
1596
					return $this->default_path . $this->plugins[ $slug ]['source'];
1597
			}
1598
1599
			return $dl_source; // Should never happen.
1600
		}
1601
1602
		/**
1603
		 * Retrieve the download URL for a WP repo package.
1604
		 *
1605
		 * @since 2.5.0
1606
		 *
1607
		 * @param string $slug Plugin slug.
1608
		 * @return string Plugin download URL.
1609
		 */
1610
		protected function get_wp_repo_download_url( $slug ) {
1611
			$source = '';
1612
			$api    = $this->get_plugins_api( $slug );
1613
1614
			if ( false !== $api && isset( $api->download_link ) ) {
1615
				$source = $api->download_link;
1616
			}
1617
1618
			return $source;
1619
		}
1620
1621
		/**
1622
		 * Try to grab information from WordPress API.
1623
		 *
1624
		 * @since 2.5.0
1625
		 *
1626
		 * @param string $slug Plugin slug.
1627
		 * @return object Plugins_api response object on success, WP_Error on failure.
1628
		 */
1629
		protected function get_plugins_api( $slug ) {
1630
			static $api = array(); // Cache received responses.
1631
1632
			if ( ! isset( $api[ $slug ] ) ) {
1633
				if ( ! function_exists( 'plugins_api' ) ) {
1634
					require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
1635
				}
1636
1637
				$response = plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false ) ) );
1638
1639
				$api[ $slug ] = false;
1640
1641
				if ( is_wp_error( $response ) ) {
1642
					wp_die( esc_html( $this->strings['oops'] ) );
1643
				} else {
1644
					$api[ $slug ] = $response;
1645
				}
1646
			}
1647
1648
			return $api[ $slug ];
1649
		}
1650
1651
		/**
1652
		 * Retrieve a link to a plugin information page.
1653
		 *
1654
		 * @since 2.5.0
1655
		 *
1656
		 * @param string $slug Plugin slug.
1657
		 * @return string Fully formed html link to a plugin information page if available
1658
		 *                or the plugin name if not.
1659
		 */
1660
		public function get_info_link( $slug ) {
1661
			if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
1662
				$link = sprintf(
1663
					'<a href="%1$s" target="_blank">%2$s</a>',
1664
					esc_url( $this->plugins[ $slug ]['external_url'] ),
1665
					esc_html( $this->plugins[ $slug ]['name'] )
1666
				);
1667
			} elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
1668
				$url = add_query_arg(
1669
					array(
1670
						'tab'       => 'plugin-information',
1671
						'plugin'    => urlencode( $slug ),
1672
						'TB_iframe' => 'true',
1673
						'width'     => '640',
1674
						'height'    => '500',
1675
					),
1676
					self_admin_url( 'plugin-install.php' )
1677
				);
1678
1679
				$link = sprintf(
1680
					'<a href="%1$s" class="thickbox">%2$s</a>',
1681
					esc_url( $url ),
1682
					esc_html( $this->plugins[ $slug ]['name'] )
1683
				);
1684
			} else {
1685
				$link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
1686
			}
1687
1688
			return $link;
1689
		}
1690
1691
		/**
1692
		 * Determine if we're on the TGMPA Install page.
1693
		 *
1694
		 * @since 2.1.0
1695
		 *
1696
		 * @return boolean True when on the TGMPA page, false otherwise.
1697
		 */
1698
		protected function is_tgmpa_page() {
1699
			return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
1700
		}
1701
1702
		/**
1703
		 * Retrieve the URL to the TGMPA Install page.
1704
		 *
1705
		 * I.e. depending on the config settings passed something along the lines of:
1706
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
1707
		 *
1708
		 * @since 2.5.0
1709
		 *
1710
		 * @return string Properly encoded URL (not escaped).
1711
		 */
1712
		public function get_tgmpa_url() {
1713
			static $url;
1714
1715
			if ( ! isset( $url ) ) {
1716
				$parent = $this->parent_slug;
1717
				if ( false === strpos( $parent, '.php' ) ) {
1718
					$parent = 'admin.php';
1719
				}
1720
				$url = add_query_arg(
1721
					array(
1722
						'page' => urlencode( $this->menu ),
1723
					),
1724
					self_admin_url( $parent )
1725
				);
1726
			}
1727
1728
			return $url;
1729
		}
1730
1731
		/**
1732
		 * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
1733
		 *
1734
		 * I.e. depending on the config settings passed something along the lines of:
1735
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install
1736
		 *
1737
		 * @since 2.5.0
1738
		 *
1739
		 * @param string $status Plugin status - either 'install', 'update' or 'activate'.
1740
		 * @return string Properly encoded URL (not escaped).
1741
		 */
1742
		public function get_tgmpa_status_url( $status ) {
1743
			return add_query_arg(
1744
				array(
1745
					'plugin_status' => urlencode( $status ),
1746
				),
1747
				$this->get_tgmpa_url()
1748
			);
1749
		}
1750
1751
		/**
1752
		 * Determine whether there are open actions for plugins registered with TGMPA.
1753
		 *
1754
		 * @since 2.5.0
1755
		 *
1756
		 * @return bool True if complete, i.e. no outstanding actions. False otherwise.
1757
		 */
1758
		public function is_tgmpa_complete() {
1759
			$complete = true;
1760
			foreach ( $this->plugins as $slug => $plugin ) {
1761
				if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1762
					$complete = false;
1763
					break;
1764
				}
1765
			}
1766
1767
			return $complete;
1768
		}
1769
1770
		/**
1771
		 * Check if a plugin is installed. Does not take must-use plugins into account.
1772
		 *
1773
		 * @since 2.5.0
1774
		 *
1775
		 * @param string $slug Plugin slug.
1776
		 * @return bool True if installed, false otherwise.
1777
		 */
1778
		public function is_plugin_installed( $slug ) {
1779
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1780
1781
			return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
1782
		}
1783
1784
		/**
1785
		 * Check if a plugin is active.
1786
		 *
1787
		 * @since 2.5.0
1788
		 *
1789
		 * @param string $slug Plugin slug.
1790
		 * @return bool True if active, false otherwise.
1791
		 */
1792
		public function is_plugin_active( $slug ) {
1793
			return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) ) || is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
1794
		}
1795
1796
		/**
1797
		 * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
1798
		 * available, check whether the current install meets them.
1799
		 *
1800
		 * @since 2.5.0
1801
		 *
1802
		 * @param string $slug Plugin slug.
1803
		 * @return bool True if OK to update, false otherwise.
1804
		 */
1805
		public function can_plugin_update( $slug ) {
1806
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1807
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1808
				return true;
1809
			}
1810
1811
			$api = $this->get_plugins_api( $slug );
1812
1813
			if ( false !== $api && isset( $api->requires ) ) {
1814
				return version_compare( $this->wp_version, $api->requires, '>=' );
1815
			}
1816
1817
			// No usable info received from the plugins API, presume we can update.
1818
			return true;
1819
		}
1820
1821
		/**
1822
		 * Check to see if the plugin is 'updatetable', i.e. installed, with an update available
1823
		 * and no WP version requirements blocking it.
1824
		 *
1825
		 * @since 2.x.x
1826
		 *
1827
		 * @param string $slug Plugin slug.
1828
		 * @return bool True if OK to proceed with update, false otherwise.
1829
		 */
1830
		public function is_plugin_updatetable( $slug ) {
1831
			if ( ! $this->is_plugin_installed( $slug ) ) {
1832
				return false;
1833
			} else {
1834
				return ( $this->does_plugin_have_update( $slug ) && $this->can_plugin_update( $slug ) );
1835
			}
1836
		}
1837
1838
		/**
1839
		 * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
1840
		 * plugin version requirements set in TGMPA (if any).
1841
		 *
1842
		 * @since 2.5.0
1843
		 *
1844
		 * @param string $slug Plugin slug.
1845
		 * @return bool True if OK to activate, false otherwise.
1846
		 */
1847
		public function can_plugin_activate( $slug ) {
1848
			return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
1849
		}
1850
1851
		/**
1852
		 * Retrieve the version number of an installed plugin.
1853
		 *
1854
		 * @since 2.5.0
1855
		 *
1856
		 * @param string $slug Plugin slug.
1857
		 * @return string Version number as string or an empty string if the plugin is not installed
1858
		 *                or version unknown (plugins which don't comply with the plugin header standard).
1859
		 */
1860
		public function get_installed_version( $slug ) {
1861
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1862
1863
			if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
1864
				return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
1865
			}
1866
1867
			return '';
1868
		}
1869
1870
		/**
1871
		 * Check whether a plugin complies with the minimum version requirements.
1872
		 *
1873
		 * @since 2.5.0
1874
		 *
1875
		 * @param string $slug Plugin slug.
1876
		 * @return bool True when a plugin needs to be updated, otherwise false.
1877
		 */
1878
		public function does_plugin_require_update( $slug ) {
1879
			$installed_version = $this->get_installed_version( $slug );
1880
			$minimum_version   = $this->plugins[ $slug ]['version'];
1881
1882
			return version_compare( $minimum_version, $installed_version, '>' );
1883
		}
1884
1885
		/**
1886
		 * Check whether there is an update available for a plugin.
1887
		 *
1888
		 * @since 2.5.0
1889
		 *
1890
		 * @param string $slug Plugin slug.
1891
		 * @return false|string Version number string of the available update or false if no update available.
1892
		 */
1893
		public function does_plugin_have_update( $slug ) {
1894
			// Presume bundled and external plugins will point to a package which meets the minimum required version.
1895
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1896
				if ( $this->does_plugin_require_update( $slug ) ) {
1897
					return $this->plugins[ $slug ]['version'];
1898
				}
1899
1900
				return false;
1901
			}
1902
1903
			$repo_updates = get_site_transient( 'update_plugins' );
1904
1905 View Code Duplication
			if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
1906
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
1907
			}
1908
1909
			return false;
1910
		}
1911
1912
		/**
1913
		 * Retrieve potential upgrade notice for a plugin.
1914
		 *
1915
		 * @since 2.5.0
1916
		 *
1917
		 * @param string $slug Plugin slug.
1918
		 * @return string The upgrade notice or an empty string if no message was available or provided.
1919
		 */
1920
		public function get_upgrade_notice( $slug ) {
1921
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1922
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1923
				return '';
1924
			}
1925
1926
			$repo_updates = get_site_transient( 'update_plugins' );
1927
1928 View Code Duplication
			if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
1929
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
1930
			}
1931
1932
			return '';
1933
		}
1934
1935
		/**
1936
		 * Wrapper around the core WP get_plugins function, making sure it's actually available.
1937
		 *
1938
		 * @since 2.5.0
1939
		 *
1940
		 * @param string $plugin_folder Optional. Relative path to single plugin folder.
1941
		 * @return array Array of installed plugins with plugin information.
1942
		 */
1943
		public function get_plugins( $plugin_folder = '' ) {
1944
			if ( ! function_exists( 'get_plugins' ) ) {
1945
				require_once ABSPATH . 'wp-admin/includes/plugin.php';
1946
			}
1947
1948
			return get_plugins( $plugin_folder );
1949
		}
1950
1951
		/**
1952
		 * Delete dismissable nag option when theme is switched.
1953
		 *
1954
		 * This ensures that the user(s) is/are again reminded via nag of required
1955
		 * and/or recommended plugins if they re-activate the theme.
1956
		 *
1957
		 * @since 2.1.1
1958
		 */
1959
		public function update_dismiss() {
1960
			delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
1961
		}
1962
1963
		/**
1964
		 * Forces plugin activation if the parameter 'force_activation' is
1965
		 * set to true.
1966
		 *
1967
		 * This allows theme authors to specify certain plugins that must be
1968
		 * active at all times while using the current theme.
1969
		 *
1970
		 * Please take special care when using this parameter as it has the
1971
		 * potential to be harmful if not used correctly. Setting this parameter
1972
		 * to true will not allow the specified plugin to be deactivated unless
1973
		 * the user switches themes.
1974
		 *
1975
		 * @since 2.2.0
1976
		 */
1977
		public function force_activation() {
1978
			foreach ( $this->plugins as $slug => $plugin ) {
1979
				if ( true === $plugin['force_activation'] ) {
1980
					if ( ! $this->is_plugin_installed( $slug ) ) {
1981
						// Oops, plugin isn't there so iterate to next condition.
1982
						continue;
1983
					} elseif ( $this->can_plugin_activate( $slug ) ) {
1984
						// There we go, activate the plugin.
1985
						activate_plugin( $plugin['file_path'] );
1986
					}
1987
				}
1988
			}
1989
		}
1990
1991
		/**
1992
		 * Forces plugin deactivation if the parameter 'force_deactivation'
1993
		 * is set to true.
1994
		 *
1995
		 * This allows theme authors to specify certain plugins that must be
1996
		 * deactivated upon switching from the current theme to another.
1997
		 *
1998
		 * Please take special care when using this parameter as it has the
1999
		 * potential to be harmful if not used correctly.
2000
		 *
2001
		 * @since 2.2.0
2002
		 */
2003
		public function force_deactivation() {
2004
			foreach ( $this->plugins as $slug => $plugin ) {
2005
				// Only proceed forward if the parameter is set to true and plugin is active.
2006
				if ( true === $plugin['force_deactivation'] && $this->is_plugin_active( $slug ) ) {
2007
					deactivate_plugins( $plugin['file_path'] );
2008
				}
2009
			}
2010
		}
2011
2012
		/**
2013
		 * Echo the current TGMPA version number to the page.
2014
		 */
2015
		public function show_tgmpa_version() {
2016
			echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
2017
				esc_html( sprintf( _x( 'TGMPA v%s', '%s = version number', 'tgmpa' ), self::TGMPA_VERSION ) ),
2018
				'</small></strong></p>';
2019
		}
2020
2021
		/**
2022
		 * Returns the singleton instance of the class.
2023
		 *
2024
		 * @since 2.4.0
2025
		 *
2026
		 * @return object The TGM_Plugin_Activation object.
2027
		 */
2028
		public static function get_instance() {
2029
			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
2030
				self::$instance = new self();
2031
			}
2032
2033
			return self::$instance;
2034
		}
2035
	}
2036
2037
	if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
2038
		/**
2039
		 * Ensure only one instance of the class is ever invoked.
2040
		 */
2041
		function load_tgm_plugin_activation() {
2042
			$GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
2043
		}
2044
	}
2045
2046
	if ( did_action( 'plugins_loaded' ) ) {
2047
		load_tgm_plugin_activation();
2048
	} else {
2049
		add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
2050
	}
2051
}
2052
2053
if ( ! function_exists( 'tgmpa' ) ) {
2054
	/**
2055
	 * Helper function to register a collection of required plugins.
2056
	 *
2057
	 * @since 2.0.0
2058
	 * @api
2059
	 *
2060
	 * @param array $plugins An array of plugin arrays.
2061
	 * @param array $config  Optional. An array of configuration values.
2062
	 */
2063
	function tgmpa( $plugins, $config = array() ) {
2064
		$instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2065
2066
		foreach ( $plugins as $plugin ) {
2067
			call_user_func( array( $instance, 'register' ), $plugin );
2068
		}
2069
2070
		if ( ! empty( $config ) && is_array( $config ) ) {
2071
			// Send out notices for deprecated arguments passed.
2072
			if ( isset( $config['notices'] ) ) {
2073
				_deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
2074
				if ( ! isset( $config['has_notices'] ) ) {
2075
					$config['has_notices'] = $config['notices'];
2076
				}
2077
			}
2078
2079
			if ( isset( $config['parent_menu_slug'] ) ) {
2080
				_deprecated_argument( __FUNCTION__, '2.4.0', 'The `parent_menu_slug` config parameter was removed in TGMPA 2.4.0. In TGMPA 2.5.0 an alternative was (re-)introduced. Please adjust your configuration. For more information visit the website: http://tgmpluginactivation.com/configuration/#h-configuration-options.' );
2081
			}
2082
			if ( isset( $config['parent_url_slug'] ) ) {
2083
				_deprecated_argument( __FUNCTION__, '2.4.0', 'The `parent_url_slug` config parameter was removed in TGMPA 2.4.0. In TGMPA 2.5.0 an alternative was (re-)introduced. Please adjust your configuration. For more information visit the website: http://tgmpluginactivation.com/configuration/#h-configuration-options.' );
2084
			}
2085
2086
			call_user_func( array( $instance, 'config' ), $config );
2087
		}
2088
	}
2089
}
2090
2091
/**
2092
 * WP_List_Table isn't always available. If it isn't available,
2093
 * we load it here.
2094
 *
2095
 * @since 2.2.0
2096
 */
2097
if ( ! class_exists( 'WP_List_Table' ) ) {
2098
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
2099
}
2100
2101
if ( ! class_exists( 'TGMPA_List_Table' ) ) {
2102
2103
	/**
2104
	 * List table class for handling plugins.
2105
	 *
2106
	 * Extends the WP_List_Table class to provide a future-compatible
2107
	 * way of listing out all required/recommended plugins.
2108
	 *
2109
	 * Gives users an interface similar to the Plugin Administration
2110
	 * area with similar (albeit stripped down) capabilities.
2111
	 *
2112
	 * This class also allows for the bulk install of plugins.
2113
	 *
2114
	 * @since 2.2.0
2115
	 *
2116
	 * @package TGM-Plugin-Activation
2117
	 * @author  Thomas Griffin
2118
	 * @author  Gary Jones
2119
	 */
2120
	class TGMPA_List_Table extends WP_List_Table {
2121
		/**
2122
		 * TGMPA instance.
2123
		 *
2124
		 * @since 2.5.0
2125
		 *
2126
		 * @var object
2127
		 */
2128
		protected $tgmpa;
2129
2130
		/**
2131
		 * The currently chosen view.
2132
		 *
2133
		 * @since 2.5.0
2134
		 *
2135
		 * @var string One of: 'all', 'install', 'update', 'activate'
2136
		 */
2137
		public $view_context = 'all';
2138
2139
		/**
2140
		 * The plugin counts for the various views.
2141
		 *
2142
		 * @since 2.5.0
2143
		 *
2144
		 * @var array
2145
		 */
2146
		protected $view_totals = array(
2147
			'all'      => 0,
2148
			'install'  => 0,
2149
			'update'   => 0,
2150
			'activate' => 0,
2151
		);
2152
2153
		/**
2154
		 * References parent constructor and sets defaults for class.
2155
		 *
2156
		 * @since 2.2.0
2157
		 */
2158
		public function __construct() {
2159
			$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2160
2161
			parent::__construct(
2162
				array(
2163
					'singular' => 'plugin',
2164
					'plural'   => 'plugins',
2165
					'ajax'     => false,
2166
				)
2167
			);
2168
2169
			if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
2170
				$this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
2171
			}
2172
2173
			add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
2174
		}
2175
2176
		/**
2177
		 * Get a list of CSS classes for the <table> tag.
2178
		 *
2179
		 * Overruled to prevent the 'plural' argument from being added.
2180
		 *
2181
		 * @since 2.5.0
2182
		 *
2183
		 * @return array CSS classnames.
2184
		 */
2185
		public function get_table_classes() {
2186
			return array( 'widefat', 'fixed' );
2187
		}
2188
2189
		/**
2190
		 * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
2191
		 *
2192
		 * @since 2.2.0
2193
		 *
2194
		 * @return array $table_data Information for use in table.
2195
		 */
2196
		protected function _gather_plugin_data() {
2197
			// Load thickbox for plugin links.
2198
			$this->tgmpa->admin_init();
2199
			$this->tgmpa->thickbox();
2200
2201
			// Categorize the plugins which have open actions.
2202
			$plugins = $this->categorize_plugins_to_views();
2203
2204
			// Set the counts for the view links.
2205
			$this->set_view_totals( $plugins );
2206
2207
			// Prep variables for use and grab list of all installed plugins.
2208
			$table_data = array();
2209
			$i          = 0;
2210
2211
			// Redirect to the 'all' view if no plugins were found for the selected view context.
2212
			if ( empty( $plugins[ $this->view_context ] ) ) {
2213
				$this->view_context = 'all';
2214
			}
2215
2216
			foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
2217
				$table_data[ $i ]['sanitized_plugin']  = $plugin['name'];
2218
				$table_data[ $i ]['slug']              = $slug;
2219
				$table_data[ $i ]['plugin']            = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
2220
				$table_data[ $i ]['source']            = $this->get_plugin_source_type_text( $plugin['source_type'] );
2221
				$table_data[ $i ]['type']              = $this->get_plugin_advise_type_text( $plugin['required'] );
2222
				$table_data[ $i ]['status']            = $this->get_plugin_status_text( $slug );
2223
				$table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
2224
				$table_data[ $i ]['minimum_version']   = $plugin['version'];
2225
				$table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
2226
2227
				// Prep the upgrade notice info.
2228
				$upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
2229
				if ( ! empty( $upgrade_notice ) ) {
2230
					$table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
2231
2232
					add_action( "tgmpa_after_plugin_row_$slug", array( $this, 'wp_plugin_update_row' ), 10, 2 );
2233
				}
2234
2235
				$table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
2236
2237
				$i++;
2238
			}
2239
2240
			return $table_data;
2241
		}
2242
2243
		/**
2244
		 * Categorize the plugins which have open actions into views for the TGMPA page.
2245
		 *
2246
		 * @since 2.5.0
2247
		 */
2248
		protected function categorize_plugins_to_views() {
2249
			$plugins = array(
2250
				'all'      => array(), // Meaning: all plugins which still have open actions.
2251
				'install'  => array(),
2252
				'update'   => array(),
2253
				'activate' => array(),
2254
			);
2255
2256
			foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
2257
				if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2258
					// No need to display plugins if they are installed, up-to-date and active.
2259
					continue;
2260
				} else {
2261
					$plugins['all'][ $slug ] = $plugin;
2262
2263
					if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2264
						$plugins['install'][ $slug ] = $plugin;
2265
					} else {
2266
						if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2267
							$plugins['update'][ $slug ] = $plugin;
2268
						}
2269
2270
						if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2271
							$plugins['activate'][ $slug ] = $plugin;
2272
						}
2273
					}
2274
				}
2275
			}
2276
2277
			return $plugins;
2278
		}
2279
2280
		/**
2281
		 * Set the counts for the view links.
2282
		 *
2283
		 * @since 2.5.0
2284
		 *
2285
		 * @param array $plugins Plugins order by view.
2286
		 */
2287
		protected function set_view_totals( $plugins ) {
2288
			foreach ( $plugins as $type => $list ) {
2289
				$this->view_totals[ $type ] = count( $list );
2290
			}
2291
		}
2292
2293
		/**
2294
		 * Get the plugin required/recommended text string.
2295
		 *
2296
		 * @since 2.5.0
2297
		 *
2298
		 * @param string $required Plugin required setting.
2299
		 * @return string
2300
		 */
2301
		protected function get_plugin_advise_type_text( $required ) {
2302
			if ( true === $required ) {
2303
				return __( 'Required', 'tgmpa' );
2304
			}
2305
2306
			return __( 'Recommended', 'tgmpa' );
2307
		}
2308
2309
		/**
2310
		 * Get the plugin source type text string.
2311
		 *
2312
		 * @since 2.5.0
2313
		 *
2314
		 * @param string $type Plugin type.
2315
		 * @return string
2316
		 */
2317
		protected function get_plugin_source_type_text( $type ) {
2318
			$string = '';
2319
2320
			switch ( $type ) {
2321
				case 'repo':
2322
					$string = __( 'WordPress Repository', 'tgmpa' );
2323
					break;
2324
				case 'external':
2325
					$string = __( 'External Source', 'tgmpa' );
2326
					break;
2327
				case 'bundled':
2328
					$string = __( 'Pre-Packaged', 'tgmpa' );
2329
					break;
2330
			}
2331
2332
			return $string;
2333
		}
2334
2335
		/**
2336
		 * Determine the plugin status message.
2337
		 *
2338
		 * @since 2.5.0
2339
		 *
2340
		 * @param string $slug Plugin slug.
2341
		 * @return string
2342
		 */
2343
		protected function get_plugin_status_text( $slug ) {
2344
			if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2345
				return __( 'Not Installed', 'tgmpa' );
2346
			}
2347
2348
			if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
2349
				$install_status = __( 'Installed But Not Activated', 'tgmpa' );
2350
			} else {
2351
				$install_status = __( 'Active', 'tgmpa' );
2352
			}
2353
2354
			$update_status = '';
2355
2356
			if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2357
				$update_status = __( 'Required Update not Available', 'tgmpa' );
2358
2359
			} elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
2360
				$update_status = __( 'Requires Update', 'tgmpa' );
2361
2362
			} elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2363
				$update_status = __( 'Update recommended', 'tgmpa' );
2364
			}
2365
2366
			if ( '' === $update_status ) {
2367
				return $install_status;
2368
			}
2369
2370
			return sprintf(
2371
				_x( '%1$s, %2$s', '%1$s = install status, %2$s = update status', 'tgmpa' ),
2372
				$install_status,
2373
				$update_status
2374
			);
2375
		}
2376
2377
		/**
2378
		 * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
2379
		 *
2380
		 * @since 2.5.0
2381
		 *
2382
		 * @param array $items Prepared table items.
2383
		 * @return array Sorted table items.
2384
		 */
2385
		public function sort_table_items( $items ) {
2386
			$type = array();
2387
			$name = array();
2388
2389
			foreach ( $items as $i => $plugin ) {
2390
				$type[ $i ] = $plugin['type']; // Required / recommended.
2391
				$name[ $i ] = $plugin['sanitized_plugin'];
2392
			}
2393
2394
			array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
2395
2396
			return $items;
2397
		}
2398
2399
		/**
2400
		 * Get an associative array ( id => link ) of the views available on this table.
2401
		 *
2402
		 * @since 2.5.0
2403
		 *
2404
		 * @return array
2405
		 */
2406
		public function get_views() {
2407
			$status_links = array();
2408
2409
			foreach ( $this->view_totals as $type => $count ) {
2410
				if ( $count < 1 ) {
2411
					continue;
2412
				}
2413
2414
				switch ( $type ) {
2415
					case 'all':
2416
						$text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
2417
						break;
2418
					case 'install':
2419
						$text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
2420
						break;
2421
					case 'update':
2422
						$text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
2423
						break;
2424
					case 'activate':
2425
						$text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
2426
						break;
2427
					default:
2428
						$text = '';
2429
						break;
2430
				}
2431
2432
				if ( ! empty( $text ) ) {
2433
2434
					$status_links[ $type ] = sprintf(
2435
						'<a href="%s"%s>%s</a>',
2436
						esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
2437
						( $type === $this->view_context ) ? ' class="current"' : '',
2438
						sprintf( $text, number_format_i18n( $count ) )
2439
					);
2440
				}
2441
			}
2442
2443
			return $status_links;
2444
		}
2445
2446
		/**
2447
		 * Create default columns to display important plugin information
2448
		 * like type, action and status.
2449
		 *
2450
		 * @since 2.2.0
2451
		 *
2452
		 * @param array  $item        Array of item data.
2453
		 * @param string $column_name The name of the column.
2454
		 * @return string
2455
		 */
2456
		public function column_default( $item, $column_name ) {
2457
			return $item[ $column_name ];
2458
		}
2459
2460
		/**
2461
		 * Required for bulk installing.
2462
		 *
2463
		 * Adds a checkbox for each plugin.
2464
		 *
2465
		 * @since 2.2.0
2466
		 *
2467
		 * @param array $item Array of item data.
2468
		 * @return string The input checkbox with all necessary info.
2469
		 */
2470
		public function column_cb( $item ) {
2471
			return sprintf(
2472
				'<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
2473
				esc_attr( $this->_args['singular'] ),
2474
				esc_attr( $item['slug'] ),
2475
				esc_attr( $item['sanitized_plugin'] )
2476
			);
2477
		}
2478
2479
		/**
2480
		 * Create default title column along with the action links.
2481
		 *
2482
		 * @since 2.2.0
2483
		 *
2484
		 * @param array $item Array of item data.
2485
		 * @return string The plugin name and action links.
2486
		 */
2487
		public function column_plugin( $item ) {
2488
			return sprintf(
2489
				'%1$s %2$s',
2490
				$item['plugin'],
2491
				$this->row_actions( $this->get_row_actions( $item ), true )
2492
			);
2493
		}
2494
2495
		/**
2496
		 * Create version information column.
2497
		 *
2498
		 * @since 2.5.0
2499
		 *
2500
		 * @param array $item Array of item data.
2501
		 * @return string HTML-formatted version information.
2502
		 */
2503
		public function column_version( $item ) {
2504
			$output = array();
2505
2506
			if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2507
				$installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
2508
2509
				$color = '';
2510
				if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
2511
					$color = ' color: #ff0000; font-weight: bold;';
2512
				}
2513
2514
				$output[] = sprintf(
2515
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
2516
					$color,
2517
					$installed
2518
				);
2519
			}
2520
2521
			if ( ! empty( $item['minimum_version'] ) ) {
2522
				$output[] = sprintf(
2523
					'<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
2524
					$item['minimum_version']
2525
				);
2526
			}
2527
2528
			if ( ! empty( $item['available_version'] ) ) {
2529
				$color = '';
2530
				if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
2531
					$color = ' color: #71C671; font-weight: bold;';
2532
				}
2533
2534
				$output[] = sprintf(
2535
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
2536
					$color,
2537
					$item['available_version']
2538
				);
2539
			}
2540
2541
			if ( empty( $output ) ) {
2542
				return '&nbsp;'; // Let's not break the table layout.
2543
			} else {
2544
				return implode( "\n", $output );
2545
			}
2546
		}
2547
2548
		/**
2549
		 * Sets default message within the plugins table if no plugins
2550
		 * are left for interaction.
2551
		 *
2552
		 * Hides the menu item to prevent the user from clicking and
2553
		 * getting a permissions error.
2554
		 *
2555
		 * @since 2.2.0
2556
		 */
2557
		public function no_items() {
2558
			printf( wp_kses_post( __( 'No plugins to install, update or activate. <a href="%1$s">Return to the Dashboard</a>', 'tgmpa' ) ), esc_url( self_admin_url() ) );
2559
			echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
2560
		}
2561
2562
		/**
2563
		 * Output all the column information within the table.
2564
		 *
2565
		 * @since 2.2.0
2566
		 *
2567
		 * @return array $columns The column names.
2568
		 */
2569
		public function get_columns() {
2570
			$columns = array(
2571
				'cb'     => '<input type="checkbox" />',
2572
				'plugin' => __( 'Plugin', 'tgmpa' ),
2573
				'source' => __( 'Source', 'tgmpa' ),
2574
				'type'   => __( 'Type', 'tgmpa' ),
2575
			);
2576
2577
			if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
2578
				$columns['version'] = __( 'Version', 'tgmpa' );
2579
				$columns['status']  = __( 'Status', 'tgmpa' );
2580
			}
2581
2582
			return apply_filters( 'tgmpa_table_columns', $columns );
2583
		}
2584
2585
		/**
2586
		 * Get name of default primary column
2587
		 *
2588
		 * @since 2.5.0 / WP 4.3+ compatibility
2589
		 * @access protected
2590
		 *
2591
		 * @return string
2592
		 */
2593
		protected function get_default_primary_column_name() {
2594
			return 'plugin';
2595
		}
2596
2597
		/**
2598
		 * Get the name of the primary column.
2599
		 *
2600
		 * @since 2.5.0 / WP 4.3+ compatibility
2601
		 * @access protected
2602
		 *
2603
		 * @return string The name of the primary column.
2604
		 */
2605
		protected function get_primary_column_name() {
2606
			if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
2607
				return parent::get_primary_column_name();
2608
			} else {
2609
				return $this->get_default_primary_column_name();
2610
			}
2611
		}
2612
2613
		/**
2614
		 * Get the actions which are relevant for a specific plugin row.
2615
		 *
2616
		 * @since 2.5.0
2617
		 *
2618
		 * @param array $item Array of item data.
2619
		 * @return array Array with relevant action links.
2620
		 */
2621
		protected function get_row_actions( $item ) {
2622
			$actions      = array();
2623
			$action_links = array();
2624
2625
			// Display the 'Install' action link if the plugin is not yet available.
2626
			if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2627
				$actions['install'] = _x( 'Install %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2628
			} else {
2629
				// Display the 'Update' action link if an update is available and WP complies with plugin minimum.
2630
				if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
2631
					$actions['update'] = _x( 'Update %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2632
				}
2633
2634
				// Display the 'Activate' action link, but only if the plugin meets the minimum version.
2635
				if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
2636
					$actions['activate'] = _x( 'Activate %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2637
				}
2638
			}
2639
2640
			// Create the actual links.
2641
			foreach ( $actions as $action => $text ) {
2642
				$nonce_url = wp_nonce_url(
2643
					add_query_arg(
2644
						array(
2645
							'plugin'           => urlencode( $item['slug'] ),
2646
							'tgmpa-' . $action => $action . '-plugin',
2647
						),
2648
						$this->tgmpa->get_tgmpa_url()
2649
					),
2650
					'tgmpa-' . $action,
2651
					'tgmpa-nonce'
2652
				);
2653
2654
				$action_links[ $action ] = sprintf(
2655
					'<a href="%1$s">' . esc_html( $text ) . '</a>',
2656
					esc_url( $nonce_url ),
2657
					'<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
2658
				);
2659
			}
2660
2661
			$prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
2662
			return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
2663
		}
2664
2665
		/**
2666
		 * Generates content for a single row of the table.
2667
		 *
2668
		 * @since 2.5.0
2669
		 *
2670
		 * @param object $item The current item.
2671
		 */
2672
		public function single_row( $item ) {
2673
			parent::single_row( $item );
2674
2675
			/**
2676
			 * Fires after each specific row in the TGMPA Plugins list table.
2677
			 *
2678
			 * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
2679
			 * for the plugin.
2680
			 *
2681
			 * @since 2.5.0
2682
			 */
2683
			do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
2684
		}
2685
2686
		/**
2687
		 * Show the upgrade notice below a plugin row if there is one.
2688
		 *
2689
		 * @since 2.5.0
2690
		 *
2691
		 * @see /wp-admin/includes/update.php
2692
		 *
2693
		 * @param string $slug Plugin slug.
2694
		 * @param array  $item The information available in this table row.
2695
		 * @return null Return early if upgrade notice is empty.
2696
		 */
2697
		public function wp_plugin_update_row( $slug, $item ) {
2698
			if ( empty( $item['upgrade_notice'] ) ) {
2699
				return;
2700
			}
2701
2702
			echo '
2703
				<tr class="plugin-update-tr">
2704
					<td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
2705
						<div class="update-message">',
2706
							esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
2707
							' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
2708
						</div>
2709
					</td>
2710
				</tr>';
2711
		}
2712
2713
		/**
2714
		 * Extra controls to be displayed between bulk actions and pagination.
2715
		 *
2716
		 * @since 2.5.0
2717
		 *
2718
		 * @param string $which 'top' or 'bottom' table navigation.
2719
		 */
2720
		public function extra_tablenav( $which ) {
2721
			if ( 'bottom' === $which ) {
2722
				$this->tgmpa->show_tgmpa_version();
2723
			}
2724
		}
2725
2726
		/**
2727
		 * Defines the bulk actions for handling registered plugins.
2728
		 *
2729
		 * @since 2.2.0
2730
		 *
2731
		 * @return array $actions The bulk actions for the plugin install table.
2732
		 */
2733
		public function get_bulk_actions() {
2734
2735
			$actions = array();
2736
2737
			if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
2738
				if ( current_user_can( 'install_plugins' ) ) {
2739
					$actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
2740
				}
2741
			}
2742
2743
			if ( 'install' !== $this->view_context ) {
2744
				if ( current_user_can( 'update_plugins' ) ) {
2745
					$actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
2746
				}
2747
				if ( current_user_can( 'activate_plugins' ) ) {
2748
					$actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
2749
				}
2750
			}
2751
2752
			return $actions;
2753
		}
2754
2755
		/**
2756
		 * Processes bulk installation and activation actions.
2757
		 *
2758
		 * The bulk installation process looks for the $_POST information and passes that
2759
		 * through if a user has to use WP_Filesystem to enter their credentials.
2760
		 *
2761
		 * @since 2.2.0
2762
		 */
2763
		public function process_bulk_actions() {
2764
			// Bulk installation process.
2765
			if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
2766
2767
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2768
2769
				$install_type = 'install';
2770
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2771
					$install_type = 'update';
2772
				}
2773
2774
				$plugins_to_install = array();
2775
2776
				// Did user actually select any plugins to install/update ?
2777 View Code Duplication
				if ( empty( $_POST['plugin'] ) ) {
2778
					if ( 'install' === $install_type ) {
2779
						$message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
2780
					} else {
2781
						$message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
2782
					}
2783
2784
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2785
2786
					return false;
2787
				}
2788
2789
				if ( is_array( $_POST['plugin'] ) ) {
2790
					$plugins_to_install = (array) $_POST['plugin'];
2791
				} elseif ( is_string( $_POST['plugin'] ) ) {
2792
					// Received via Filesystem page - un-flatten array (WP bug #19643).
2793
					$plugins_to_install = explode( ',', $_POST['plugin'] );
2794
				}
2795
2796
				// Sanitize the received input.
2797
				$plugins_to_install = array_map( 'urldecode', $plugins_to_install );
2798
				$plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
2799
2800
				// Validate the received input.
2801
				foreach ( $plugins_to_install as $key => $slug ) {
2802
					// Check if the plugin was registered with TGMPA and remove if not.
2803
					if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
2804
						unset( $plugins_to_install[ $key ] );
2805
						continue;
2806
					}
2807
2808
					// For install: make sure this is a plugin we *can* install and not one already installed.
2809
					if ( 'install' === $install_type && true === $this->tgmpa->is_plugin_installed( $slug ) ) {
2810
						unset( $plugins_to_install[ $key ] );
2811
					}
2812
2813
					// For updates: make sure this is a plugin we *can* update (update available and WP version ok).
2814
					if ( 'update' === $install_type && false === $this->tgmpa->is_plugin_updatetable( $slug ) ) {
2815
						unset( $plugins_to_install[ $key ] );
2816
					}
2817
				}
2818
2819
				// No need to proceed further if we have no plugins to handle.
2820 View Code Duplication
				if ( empty( $plugins_to_install ) ) {
2821
					if ( 'install' === $install_type ) {
2822
						$message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
2823
					} else {
2824
						$message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
2825
					}
2826
2827
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2828
2829
					return false;
2830
				}
2831
2832
				// Pass all necessary information if WP_Filesystem is needed.
2833
				$url = wp_nonce_url(
2834
					$this->tgmpa->get_tgmpa_url(),
2835
					'bulk-' . $this->_args['plural']
2836
				);
2837
2838
				// Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
2839
				$_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
2840
2841
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
2842
				$fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
2843
2844 View Code Duplication
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields ) ) ) {
2845
					return true; // Stop the normal page form from displaying, credential request form will be shown.
2846
				}
2847
2848
				// Now we have some credentials, setup WP_Filesystem.
2849 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
0 ignored issues
show
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
2850
					// Our credentials were no good, ask the user for them again.
2851
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
2852
2853
					return true;
2854
				}
2855
2856
				/* If we arrive here, we have the filesystem */
2857
2858
				// Store all information in arrays since we are processing a bulk installation.
2859
				$names      = array();
2860
				$sources    = array(); // Needed for installs.
2861
				$file_paths = array(); // Needed for upgrades.
2862
				$to_inject  = array(); // Information to inject into the update_plugins transient.
2863
2864
				// Prepare the data for validated plugins for the install/upgrade.
2865
				foreach ( $plugins_to_install as $slug ) {
2866
					$name   = $this->tgmpa->plugins[ $slug ]['name'];
2867
					$source = $this->tgmpa->get_download_url( $slug );
2868
2869
					if ( ! empty( $name ) && ! empty( $source ) ) {
2870
						$names[] = $name;
2871
2872
						switch ( $install_type ) {
2873
2874
							case 'install':
2875
								$sources[] = $source;
2876
								break;
2877
2878
							case 'update':
2879
								$file_paths[]                 = $this->tgmpa->plugins[ $slug ]['file_path'];
2880
								$to_inject[ $slug ]           = $this->tgmpa->plugins[ $slug ];
2881
								$to_inject[ $slug ]['source'] = $source;
2882
								break;
2883
						}
2884
					}
2885
				}
2886
				unset( $slug, $name, $source );
2887
2888
				// Create a new instance of TGMPA_Bulk_Installer.
2889
				$installer = new TGMPA_Bulk_Installer(
2890
					new TGMPA_Bulk_Installer_Skin(
2891
						array(
2892
							'url'          => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
2893
							'nonce'        => 'bulk-' . $this->_args['plural'],
2894
							'names'        => $names,
2895
							'install_type' => $install_type,
2896
						)
2897
					)
2898
				);
2899
2900
				// Wrap the install process with the appropriate HTML.
2901
				echo '<div class="tgmpa">',
2902
					'<h2 style="font-size: 23px; font-weight: 400; line-height: 29px; margin: 0; padding: 9px 15px 4px 0;">', esc_html( get_admin_page_title() ), '</h2>
2903
					<div class="update-php" style="width: 100%; height: 98%; min-height: 850px; padding-top: 1px;">';
2904
2905
				// Process the bulk installation submissions.
2906
				add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
2907
2908
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2909
					// Inject our info into the update transient.
2910
					$this->tgmpa->inject_update_info( $to_inject );
2911
2912
					$installer->bulk_upgrade( $file_paths );
2913
				} else {
2914
					$installer->bulk_install( $sources );
2915
				}
2916
2917
				remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1 );
2918
2919
				echo '</div></div>';
2920
2921
				return true;
2922
			}
2923
2924
			// Bulk activation process.
2925
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
2926
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2927
2928
				// Did user actually select any plugins to activate ?
2929
				if ( empty( $_POST['plugin'] ) ) {
2930
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
2931
2932
					return false;
2933
				}
2934
2935
				// Grab plugin data from $_POST.
2936
				$plugins = array();
2937
				if ( isset( $_POST['plugin'] ) ) {
2938
					$plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
2939
					$plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
2940
				}
2941
2942
				$plugins_to_activate = array();
2943
				$plugin_names        = array();
2944
2945
				// Grab the file paths for the selected & inactive plugins from the registration array.
2946
				foreach ( $plugins as $slug ) {
2947
					if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2948
						$plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
2949
						$plugin_names[]        = $this->tgmpa->plugins[ $slug ]['name'];
2950
					}
2951
				}
2952
				unset( $slug );
2953
2954
				// Return early if there are no plugins to activate.
2955
				if ( empty( $plugins_to_activate ) ) {
2956
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
2957
2958
					return false;
2959
				}
2960
2961
				// Now we are good to go - let's start activating plugins.
2962
				$activate = activate_plugins( $plugins_to_activate );
2963
2964
				if ( is_wp_error( $activate ) ) {
2965
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
2966
				} else {
2967
					$count        = count( $plugin_names ); // Count so we can use _n function.
2968
					$plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
2969
					$last_plugin  = array_pop( $plugin_names ); // Pop off last name to prep for readability.
2970
					$imploded     = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
2971
2972
					printf( // WPCS: xss ok.
2973
						'<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
2974
						esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
2975
						$imploded
2976
					);
2977
2978
					// Update recently activated plugins option.
2979
					$recent = (array) get_option( 'recently_activated' );
2980
					foreach ( $plugins_to_activate as $plugin => $time ) {
2981
						if ( isset( $recent[ $plugin ] ) ) {
2982
							unset( $recent[ $plugin ] );
2983
						}
2984
					}
2985
					update_option( 'recently_activated', $recent );
2986
				}
2987
2988
				unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
2989
2990
				return true;
2991
			}
2992
2993
			return false;
2994
		}
2995
2996
		/**
2997
		 * Prepares all of our information to be outputted into a usable table.
2998
		 *
2999
		 * @since 2.2.0
3000
		 */
3001
		public function prepare_items() {
3002
			$columns               = $this->get_columns(); // Get all necessary column information.
3003
			$hidden                = array(); // No columns to hide, but we must set as an array.
3004
			$sortable              = array(); // No reason to make sortable columns.
3005
			$primary               = $this->get_primary_column_name(); // Column which has the row actions.
3006
			$this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
3007
3008
			// Process our bulk activations here.
3009
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3010
				$this->process_bulk_actions();
3011
			}
3012
3013
			// Store all of our plugin data into $items array so WP_List_Table can use it.
3014
			$this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
3015
		}
3016
3017
		/* *********** DEPRECATED METHODS *********** */
3018
3019
		/**
3020
		 * Retrieve plugin data, given the plugin name.
3021
		 *
3022
		 * @since      2.2.0
3023
		 * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
3024
		 * @see        TGM_Plugin_Activation::_get_plugin_data_from_name()
3025
		 *
3026
		 * @param string $name Name of the plugin, as it was registered.
3027
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
3028
		 * @return string|boolean Plugin slug if found, false otherwise.
3029
		 */
3030
		protected function _get_plugin_data_from_name( $name, $data = 'slug' ) {
3031
			_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
3032
3033
			return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
3034
		}
3035
	}
3036
}
3037
3038
3039
if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
3040
3041
	/**
3042
	 * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
3043
	 */
3044
	class TGM_Bulk_Installer {
3045
	}
3046
}
3047
if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
3048
3049
	/**
3050
	 * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
3051
	 */
3052
	class TGM_Bulk_Installer_Skin {
3053
	}
3054
}
3055
3056
/**
3057
 * The WP_Upgrader file isn't always available. If it isn't available,
3058
 * we load it here.
3059
 *
3060
 * We check to make sure no action or activation keys are set so that WordPress
3061
 * does not try to re-include the class when processing upgrades or installs outside
3062
 * of the class.
3063
 *
3064
 * @since 2.2.0
3065
 */
3066
add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
3067
if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
3068
	/**
3069
	 * Load bulk installer
3070
	 */
3071
	function tgmpa_load_bulk_installer() {
3072
		// Silently fail if 2.5+ is loaded *after* an older version.
3073
		if ( ! isset( $GLOBALS['tgmpa'] ) ) {
3074
			return;
3075
		}
3076
3077
		// Get TGMPA class instance.
3078
		$tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3079
3080
		if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
3081
			if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
3082
				require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
3083
			}
3084
3085
			if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
3086
3087
				/**
3088
				 * Installer class to handle bulk plugin installations.
3089
				 *
3090
				 * Extends WP_Upgrader and customizes to suit the installation of multiple
3091
				 * plugins.
3092
				 *
3093
				 * @since 2.2.0
3094
				 *
3095
				 * {@internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader.}}
3096
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
3097
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3098
				 *
3099
				 * @package TGM-Plugin-Activation
3100
				 * @author  Thomas Griffin
3101
				 * @author  Gary Jones
3102
				 */
3103
				class TGMPA_Bulk_Installer extends Plugin_Upgrader {
3104
					/**
3105
					 * Holds result of bulk plugin installation.
3106
					 *
3107
					 * @since 2.2.0
3108
					 *
3109
					 * @var string
3110
					 */
3111
					public $result;
3112
3113
					/**
3114
					 * Flag to check if bulk installation is occurring or not.
3115
					 *
3116
					 * @since 2.2.0
3117
					 *
3118
					 * @var boolean
3119
					 */
3120
					public $bulk = false;
3121
3122
					/**
3123
					 * TGMPA instance
3124
					 *
3125
					 * @since 2.5.0
3126
					 *
3127
					 * @var object
3128
					 */
3129
					protected $tgmpa;
3130
3131
					/**
3132
					 * Whether or not the destination directory needs to be cleared ( = on update).
3133
					 *
3134
					 * @since 2.5.0
3135
					 *
3136
					 * @var bool
3137
					 */
3138
					protected $clear_destination = false;
3139
3140
					/**
3141
					 * References parent constructor and sets defaults for class.
3142
					 *
3143
					 * @since 2.2.0
3144
					 *
3145
					 * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
3146
					 */
3147
					public function __construct( $skin = null ) {
3148
						// Get TGMPA class instance.
3149
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3150
3151
						parent::__construct( $skin );
3152
3153
						if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
3154
							$this->clear_destination = true;
3155
						}
3156
3157
						if ( $this->tgmpa->is_automatic ) {
3158
							$this->activate_strings();
3159
						}
3160
3161
						add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
3162
					}
3163
3164
					/**
3165
					 * Sets the correct activation strings for the installer skin to use.
3166
					 *
3167
					 * @since 2.2.0
3168
					 */
3169
					public function activate_strings() {
3170
						$this->strings['activation_failed']  = __( 'Plugin activation failed.', 'tgmpa' );
3171
						$this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
3172
					}
3173
3174
					/**
3175
					 * Performs the actual installation of each plugin.
3176
					 *
3177
					 * @since 2.2.0
3178
					 *
3179
					 * @see WP_Upgrader::run()
3180
					 *
3181
					 * @param array $options The installation config options.
3182
					 * @return null|array Return early if error, array of installation data on success.
3183
					 */
3184
					public function run( $options ) {
3185
						$result = parent::run( $options );
3186
3187
						// Reset the strings in case we changed one during automatic activation.
3188
						if ( $this->tgmpa->is_automatic ) {
3189
							if ( 'update' === $this->skin->options['install_type'] ) {
3190
								$this->upgrade_strings();
3191
							} else {
3192
								$this->install_strings();
3193
							}
3194
						}
3195
3196
						return $result;
3197
					}
3198
3199
					/**
3200
					 * Processes the bulk installation of plugins.
3201
					 *
3202
					 * @since 2.2.0
3203
					 *
3204
					 * {@internal This is basically a near identical copy of the WP Core
3205
					 * Plugin_Upgrader::bulk_upgrade() method, with minor adjustments to deal with
3206
					 * new installs instead of upgrades.
3207
					 * For ease of future synchronizations, the adjustments are clearly commented, but no other
3208
					 * comments are added. Code style has been made to comply.}}
3209
					 *
3210
					 * @see Plugin_Upgrader::bulk_upgrade()
3211
					 * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
3212
					 * (@internal Last synced: Dec 31st 2015 against https://core.trac.wordpress.org/browser/trunk?rev=36134}}
3213
					 *
3214
					 * @param array $plugins The plugin sources needed for installation.
3215
					 * @param array $args    Arbitrary passed extra arguments.
3216
					 * @return string|bool Install confirmation messages on success, false on failure.
3217
					 */
3218
					public function bulk_install( $plugins, $args = array() ) {
3219
						// [TGMPA + ] Hook auto-activation in.
3220
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3221
3222
						$defaults    = array(
3223
							'clear_update_cache' => true,
3224
						);
3225
						$parsed_args = wp_parse_args( $args, $defaults );
3226
3227
						$this->init();
3228
						$this->bulk = true;
3229
3230
						$this->install_strings(); // [TGMPA + ] adjusted.
3231
3232
						/* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
3233
3234
						/* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
3235
3236
						$this->skin->header();
3237
3238
						// Connect to the Filesystem first.
3239
						$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
3240
						if ( ! $res ) {
3241
							$this->skin->footer();
3242
							return false;
3243
						}
3244
3245
						$this->skin->bulk_header();
3246
3247
						/*
3248
						 * Only start maintenance mode if:
3249
						 * - running Multisite and there are one or more plugins specified, OR
3250
						 * - a plugin with an update available is currently active.
3251
						 * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
3252
						 */
3253
						$maintenance = ( is_multisite() && ! empty( $plugins ) );
3254
3255
						/*
3256
						[TGMPA - ]
3257
						foreach ( $plugins as $plugin )
3258
							$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
3259
						*/
3260
						if ( $maintenance ) {
3261
							$this->maintenance_mode( true );
3262
						}
3263
3264
						$results = array();
3265
3266
						$this->update_count   = count( $plugins );
3267
						$this->update_current = 0;
3268
						foreach ( $plugins as $plugin ) {
3269
							$this->update_current++;
3270
3271
							/*
3272
							[TGMPA - ]
3273
							$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
3274
3275
							if ( !isset( $current->response[ $plugin ] ) ) {
3276
								$this->skin->set_result('up_to_date');
3277
								$this->skin->before();
3278
								$this->skin->feedback('up_to_date');
3279
								$this->skin->after();
3280
								$results[$plugin] = true;
3281
								continue;
3282
							}
3283
3284
							// Get the URL to the zip file.
3285
							$r = $current->response[ $plugin ];
3286
3287
							$this->skin->plugin_active = is_plugin_active($plugin);
3288
							*/
3289
3290
							$result = $this->run(
3291
								array(
3292
									'package'           => $plugin, // [TGMPA + ] adjusted.
3293
									'destination'       => WP_PLUGIN_DIR,
3294
									'clear_destination' => false, // [TGMPA + ] adjusted.
3295
									'clear_working'     => true,
3296
									'is_multi'          => true,
3297
									'hook_extra'        => array(
3298
										'plugin' => $plugin,
3299
									),
3300
								)
3301
							);
3302
3303
							$results[ $plugin ] = $this->result;
3304
3305
							// Prevent credentials auth screen from displaying multiple times.
3306
							if ( false === $result ) {
3307
								break;
3308
							}
3309
						} //end foreach $plugins
3310
3311
						$this->maintenance_mode( false );
3312
3313
						/**
3314
						 * Fires when the bulk upgrader process is complete.
3315
						 *
3316
						 * @since WP 3.6.0 / TGMPA 2.5.0
3317
						 *
3318
						 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
3319
						 *                              be a Theme_Upgrader or Core_Upgrade instance.
3320
						 * @param array           $data {
3321
						 *     Array of bulk item update data.
3322
						 *
3323
						 *     @type string $action   Type of action. Default 'update'.
3324
						 *     @type string $type     Type of update process. Accepts 'plugin', 'theme', or 'core'.
3325
						 *     @type bool   $bulk     Whether the update process is a bulk update. Default true.
3326
						 *     @type array  $packages Array of plugin, theme, or core packages to update.
3327
						 * }
3328
						 */
3329
						do_action( 'upgrader_process_complete', $this, array(
3330
							'action'  => 'install', // [TGMPA + ] adjusted.
3331
							'type'    => 'plugin',
3332
							'bulk'    => true,
3333
							'plugins' => $plugins,
3334
						) );
3335
3336
						$this->skin->bulk_footer();
3337
3338
						$this->skin->footer();
3339
3340
						// Cleanup our hooks, in case something else does a upgrade on this connection.
3341
						/* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
3342
3343
						// [TGMPA + ] Remove our auto-activation hook.
3344
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3345
3346
						// Force refresh of plugin update information.
3347
						wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
3348
3349
						return $results;
3350
					}
3351
3352
					/**
3353
					 * Handle a bulk upgrade request.
3354
					 *
3355
					 * @since 2.5.0
3356
					 *
3357
					 * @see Plugin_Upgrader::bulk_upgrade()
3358
					 *
3359
					 * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
3360
					 * @param array $args    Arbitrary passed extra arguments.
3361
					 * @return string|bool Install confirmation messages on success, false on failure.
3362
					 */
3363
					public function bulk_upgrade( $plugins, $args = array() ) {
3364
3365
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3366
3367
						$result = parent::bulk_upgrade( $plugins, $args );
3368
3369
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3370
3371
						return $result;
3372
					}
3373
3374
					/**
3375
					 * Abuse a filter to auto-activate plugins after installation.
3376
					 *
3377
					 * Hooked into the 'upgrader_post_install' filter hook.
3378
					 *
3379
					 * @since 2.5.0
3380
					 *
3381
					 * @param bool $bool The value we need to give back (true).
3382
					 * @return bool
3383
					 */
3384
					public function auto_activate( $bool ) {
3385
						// Only process the activation of installed plugins if the automatic flag is set to true.
3386
						if ( $this->tgmpa->is_automatic ) {
3387
							// Flush plugins cache so the headers of the newly installed plugins will be read correctly.
3388
							wp_clean_plugins_cache();
3389
3390
							// Get the installed plugin file.
3391
							$plugin_info = $this->plugin_info();
3392
3393
							// Don't try to activate on upgrade of active plugin as WP will do this already.
3394
							if ( ! is_plugin_active( $plugin_info ) ) {
3395
								$activate = activate_plugin( $plugin_info );
3396
3397
								// Adjust the success string based on the activation result.
3398
								$this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
3399
3400
								if ( is_wp_error( $activate ) ) {
3401
									$this->skin->error( $activate );
3402
									$this->strings['process_success'] .= $this->strings['activation_failed'];
3403
								} else {
3404
									$this->strings['process_success'] .= $this->strings['activation_success'];
3405
								}
3406
							}
3407
						}
3408
3409
						return $bool;
3410
					}
3411
				}
3412
			}
3413
3414
			if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
3415
3416
				/**
3417
				 * Installer skin to set strings for the bulk plugin installations..
3418
				 *
3419
				 * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
3420
				 * plugins.
3421
				 *
3422
				 * @since 2.2.0
3423
				 *
3424
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
3425
				 *           TGMPA_Bulk_Installer_Skin.
3426
				 *           This was done to prevent backward compatibility issues with v2.3.6.}}
3427
				 *
3428
				 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
3429
				 *
3430
				 * @package TGM-Plugin-Activation
3431
				 * @author  Thomas Griffin
3432
				 * @author  Gary Jones
3433
				 */
3434
				class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
3435
					/**
3436
					 * Holds plugin info for each individual plugin installation.
3437
					 *
3438
					 * @since 2.2.0
3439
					 *
3440
					 * @var array
3441
					 */
3442
					public $plugin_info = array();
3443
3444
					/**
3445
					 * Holds names of plugins that are undergoing bulk installations.
3446
					 *
3447
					 * @since 2.2.0
3448
					 *
3449
					 * @var array
3450
					 */
3451
					public $plugin_names = array();
3452
3453
					/**
3454
					 * Integer to use for iteration through each plugin installation.
3455
					 *
3456
					 * @since 2.2.0
3457
					 *
3458
					 * @var integer
3459
					 */
3460
					public $i = 0;
3461
3462
					/**
3463
					 * TGMPA instance
3464
					 *
3465
					 * @since 2.5.0
3466
					 *
3467
					 * @var object
3468
					 */
3469
					protected $tgmpa;
3470
3471
					/**
3472
					 * Constructor. Parses default args with new ones and extracts them for use.
3473
					 *
3474
					 * @since 2.2.0
3475
					 *
3476
					 * @param array $args Arguments to pass for use within the class.
3477
					 */
3478
					public function __construct( $args = array() ) {
3479
						// Get TGMPA class instance.
3480
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3481
3482
						// Parse default and new args.
3483
						$defaults = array(
3484
							'url'          => '',
3485
							'nonce'        => '',
3486
							'names'        => array(),
3487
							'install_type' => 'install',
3488
						);
3489
						$args     = wp_parse_args( $args, $defaults );
3490
3491
						// Set plugin names to $this->plugin_names property.
3492
						$this->plugin_names = $args['names'];
3493
3494
						// Extract the new args.
3495
						parent::__construct( $args );
3496
					}
3497
3498
					/**
3499
					 * Sets install skin strings for each individual plugin.
3500
					 *
3501
					 * Checks to see if the automatic activation flag is set and uses the
3502
					 * the proper strings accordingly.
3503
					 *
3504
					 * @since 2.2.0
3505
					 */
3506
					public function add_strings() {
3507
						if ( 'update' === $this->options['install_type'] ) {
3508
							parent::add_strings();
3509
							$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3510
						} else {
3511
							$this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
3512
							$this->upgrader->strings['skin_update_failed']       = __( 'The installation of %1$s failed.', 'tgmpa' );
3513
3514
							if ( $this->tgmpa->is_automatic ) {
3515
								// Automatic activation strings.
3516
								$this->upgrader->strings['skin_upgrade_start']        = __( 'The installation and activation process is starting. This process may take a while on some hosts, so please be patient.', 'tgmpa' );
3517
								$this->upgrader->strings['skin_update_successful']    = __( '%1$s installed and activated successfully.', 'tgmpa' ) . ' <a href="#" class="hide-if-no-js" onclick="%2$s"><span>' . esc_html__( 'Show Details', 'tgmpa' ) . '</span><span class="hidden">' . esc_html__( 'Hide Details', 'tgmpa' ) . '</span>.</a>';
3518
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations and activations have been completed.', 'tgmpa' );
3519
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3520
							} else {
3521
								// Default installation strings.
3522
								$this->upgrader->strings['skin_upgrade_start']        = __( 'The installation process is starting. This process may take a while on some hosts, so please be patient.', 'tgmpa' );
3523
								$this->upgrader->strings['skin_update_successful']    = esc_html__( '%1$s installed successfully.', 'tgmpa' ) . ' <a href="#" class="hide-if-no-js" onclick="%2$s"><span>' . esc_html__( 'Show Details', 'tgmpa' ) . '</span><span class="hidden">' . esc_html__( 'Hide Details', 'tgmpa' ) . '</span>.</a>';
3524
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations have been completed.', 'tgmpa' );
3525
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3526
							}
3527
						}
3528
					}
3529
3530
					/**
3531
					 * Outputs the header strings and necessary JS before each plugin installation.
3532
					 *
3533
					 * @since 2.2.0
3534
					 *
3535
					 * @param string $title Unused in this implementation.
3536
					 */
3537
					public function before( $title = '' ) {
3538
						if ( empty( $title ) ) {
3539
							$title = esc_html( $this->plugin_names[ $this->i ] );
3540
						}
3541
						parent::before( $title );
3542
					}
3543
3544
					/**
3545
					 * Outputs the footer strings and necessary JS after each plugin installation.
3546
					 *
3547
					 * Checks for any errors and outputs them if they exist, else output
3548
					 * success strings.
3549
					 *
3550
					 * @since 2.2.0
3551
					 *
3552
					 * @param string $title Unused in this implementation.
3553
					 */
3554
					public function after( $title = '' ) {
3555
						if ( empty( $title ) ) {
3556
							$title = esc_html( $this->plugin_names[ $this->i ] );
3557
						}
3558
						parent::after( $title );
3559
3560
						$this->i++;
3561
					}
3562
3563
					/**
3564
					 * Outputs links after bulk plugin installation is complete.
3565
					 *
3566
					 * @since 2.2.0
3567
					 */
3568
					public function bulk_footer() {
3569
						// Serve up the string to say installations (and possibly activations) are complete.
3570
						parent::bulk_footer();
3571
3572
						// Flush plugins cache so we can make sure that the installed plugins list is always up to date.
3573
						wp_clean_plugins_cache();
3574
3575
						$this->tgmpa->show_tgmpa_version();
3576
3577
						// Display message based on if all plugins are now active or not.
3578
						$update_actions = array();
3579
3580
						if ( $this->tgmpa->is_tgmpa_complete() ) {
3581
							// All plugins are active, so we display the complete string and hide the menu to protect users.
3582
							echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
3583
							$update_actions['dashboard'] = sprintf(
3584
								esc_html( $this->tgmpa->strings['complete'] ),
3585
								'<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>'
3586
							);
3587
						} else {
3588
							$update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
3589
						}
3590
3591
						/**
3592
						 * Filter the list of action links available following bulk plugin installs/updates.
3593
						 *
3594
						 * @since 2.5.0
3595
						 *
3596
						 * @param array $update_actions Array of plugin action links.
3597
						 * @param array $plugin_info    Array of information for the last-handled plugin.
3598
						 */
3599
						$update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
3600
3601
						if ( ! empty( $update_actions ) ) {
3602
							$this->feedback( implode( ' | ', (array) $update_actions ) );
3603
						}
3604
					}
3605
3606
					/* *********** DEPRECATED METHODS *********** */
3607
3608
					/**
3609
					 * Flush header output buffer.
3610
					 *
3611
					 * @since      2.2.0
3612
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3613
					 * @see        Bulk_Upgrader_Skin::flush_output()
3614
					 */
3615
					public function before_flush_output() {
3616
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3617
						$this->flush_output();
3618
					}
3619
3620
					/**
3621
					 * Flush footer output buffer and iterate $this->i to make sure the
3622
					 * installation strings reference the correct plugin.
3623
					 *
3624
					 * @since      2.2.0
3625
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3626
					 * @see        Bulk_Upgrader_Skin::flush_output()
3627
					 */
3628
					public function after_flush_output() {
3629
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3630
						$this->flush_output();
3631
						$this->i++;
3632
					}
3633
				}
3634
			}
3635
		}
3636
	}
3637
}
3638
3639
if ( ! class_exists( 'TGMPA_Utils' ) ) {
3640
3641
	/**
3642
	 * Generic utilities for TGMPA.
3643
	 *
3644
	 * All methods are static, poor-dev name-spacing class wrapper.
3645
	 *
3646
	 * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
3647
	 *
3648
	 * @since 2.5.0
3649
	 *
3650
	 * @package TGM-Plugin-Activation
3651
	 * @author  Juliette Reinders Folmer
3652
	 */
3653
	class TGMPA_Utils {
3654
		/**
3655
		 * Whether the PHP filter extension is enabled.
3656
		 *
3657
		 * @see http://php.net/book.filter
3658
		 *
3659
		 * @since 2.5.0
3660
		 *
3661
		 * @static
3662
		 *
3663
		 * @var bool $has_filters True is the extension is enabled.
3664
		 */
3665
		public static $has_filters;
3666
3667
		/**
3668
		 * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
3669
		 *
3670
		 * @since 2.5.0
3671
		 *
3672
		 * @static
3673
		 *
3674
		 * @param string $string Text to be wrapped.
3675
		 * @return string
3676
		 */
3677
		public static function wrap_in_em( $string ) {
3678
			return '<em>' . wp_kses_post( $string ) . '</em>';
3679
		}
3680
3681
		/**
3682
		 * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
3683
		 *
3684
		 * @since 2.5.0
3685
		 *
3686
		 * @static
3687
		 *
3688
		 * @param string $string Text to be wrapped.
3689
		 * @return string
3690
		 */
3691
		public static function wrap_in_strong( $string ) {
3692
			return '<strong>' . wp_kses_post( $string ) . '</strong>';
3693
		}
3694
3695
		/**
3696
		 * Helper function: Validate a value as boolean
3697
		 *
3698
		 * @since 2.5.0
3699
		 *
3700
		 * @static
3701
		 *
3702
		 * @param mixed $value Arbitrary value.
3703
		 * @return bool
3704
		 */
3705
		public static function validate_bool( $value ) {
3706
			if ( ! isset( self::$has_filters ) ) {
3707
				self::$has_filters = extension_loaded( 'filter' );
3708
			}
3709
3710
			if ( self::$has_filters ) {
3711
				return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
3712
			} else {
3713
				return self::emulate_filter_bool( $value );
3714
			}
3715
		}
3716
3717
		/**
3718
		 * Helper function: Cast a value to bool
3719
		 *
3720
		 * @since 2.5.0
3721
		 *
3722
		 * @static
3723
		 *
3724
		 * @param mixed $value Value to cast.
3725
		 * @return bool
3726
		 */
3727
		protected static function emulate_filter_bool( $value ) {
3728
			// @codingStandardsIgnoreStart
3729
			static $true  = array(
3730
				'1',
3731
				'true', 'True', 'TRUE',
3732
				'y', 'Y',
3733
				'yes', 'Yes', 'YES',
3734
				'on', 'On', 'ON',
3735
			);
3736
			static $false = array(
3737
				'0',
3738
				'false', 'False', 'FALSE',
3739
				'n', 'N',
3740
				'no', 'No', 'NO',
3741
				'off', 'Off', 'OFF',
3742
			);
3743
			// @codingStandardsIgnoreEnd
3744
3745
			if ( is_bool( $value ) ) {
3746
				return $value;
3747
			} else if ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
3748
				return (bool) $value;
3749
			} else if ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
3750
				return (bool) $value;
3751
			} else if ( is_string( $value ) ) {
3752
				$value = trim( $value );
3753
				if ( in_array( $value, $true, true ) ) {
3754
					return true;
3755
				} else if ( in_array( $value, $false, true ) ) {
3756
					return false;
3757
				} else {
3758
					return false;
3759
				}
3760
			}
3761
3762
			return false;
3763
		}
3764
	} // End of class TGMPA_Utils
3765
} // End of class_exists wrapper
3766