Completed
Push — develop ( 86f1d7...36ccf5 )
by Gary
02:08
created

class-tgm-plugin-activation.php (2 issues)

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, 3 );
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;
0 ignored issues
show
Comprehensibility Naming introduced by
The variable name $total_required_action_count exceeds the maximum configured length of 25.

Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose.

Loading history...
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
		 * Add dismissable admin notices.
1330
		 *
1331
		 * Appends a link to the admin nag messages. If clicked, the admin notice disappears and no longer is visible to users.
1332
		 *
1333
		 * @since 2.1.0
1334
		 */
1335
		public function dismiss() {
1336
			if ( isset( $_GET['tgmpa-dismiss'] ) && check_admin_referer( 'tgmpa-dismis-' . get_current_user_id() ) ) {
1337
				update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
1338
			}
1339
		}
1340
1341
		/**
1342
		 * Add individual plugin to our collection of plugins.
1343
		 *
1344
		 * If the required keys are not set or the plugin has already
1345
		 * been registered, the plugin is not added.
1346
		 *
1347
		 * @since 2.0.0
1348
		 *
1349
		 * @param array|null $plugin Array of plugin arguments or null if invalid argument.
1350
		 * @return null Return early if incorrect argument.
1351
		 */
1352
		public function register( $plugin ) {
1353
			if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
1354
				return;
1355
			}
1356
1357
			if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
1358
				return;
1359
			}
1360
1361
			$defaults = array(
1362
				'name'               => '',      // String
1363
				'slug'               => '',      // String
1364
				'source'             => 'repo',  // String
1365
				'required'           => false,   // Boolean
1366
				'version'            => '',      // String
1367
				'force_activation'   => false,   // Boolean
1368
				'force_deactivation' => false,   // Boolean
1369
				'external_url'       => '',      // String
1370
				'is_callable'        => '',      // String|Array.
1371
			);
1372
1373
			// Prepare the received data.
1374
			$plugin = wp_parse_args( $plugin, $defaults );
1375
1376
			// Standardize the received slug.
1377
			$plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
1378
1379
			// Forgive users for using string versions of booleans or floats for version number.
1380
			$plugin['version']            = (string) $plugin['version'];
1381
			$plugin['source']             = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
1382
			$plugin['required']           = TGMPA_Utils::validate_bool( $plugin['required'] );
1383
			$plugin['force_activation']   = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
1384
			$plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
1385
1386
			// Enrich the received data.
1387
			$plugin['file_path']   = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
1388
			$plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
1389
1390
			// Set the class properties.
1391
			$this->plugins[ $plugin['slug'] ]    = $plugin;
1392
			$this->sort_order[ $plugin['slug'] ] = $plugin['name'];
1393
1394
			// Should we add the force activation hook ?
1395
			if ( true === $plugin['force_activation'] ) {
1396
				$this->has_forced_activation = true;
1397
			}
1398
1399
			// Should we add the force deactivation hook ?
1400
			if ( true === $plugin['force_deactivation'] ) {
1401
				$this->has_forced_deactivation = true;
1402
			}
1403
		}
1404
1405
		/**
1406
		 * Determine what type of source the plugin comes from.
1407
		 *
1408
		 * @since 2.5.0
1409
		 *
1410
		 * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
1411
		 *                       (= bundled) or an external URL.
1412
		 * @return string 'repo', 'external', or 'bundled'
1413
		 */
1414
		protected function get_plugin_source_type( $source ) {
1415
			if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
1416
				return 'repo';
1417
			} elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
1418
				return 'external';
1419
			} else {
1420
				return 'bundled';
1421
			}
1422
		}
1423
1424
		/**
1425
		 * Sanitizes a string key.
1426
		 *
1427
		 * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
1428
		 * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
1429
		 * characters in the plugin directory path/slug. Silly them.
1430
		 *
1431
		 * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
1432
		 *
1433
		 * @since 2.5.0
1434
		 *
1435
		 * @param string $key String key.
1436
		 * @return string Sanitized key
1437
		 */
1438
		public function sanitize_key( $key ) {
1439
			$raw_key = $key;
1440
			$key     = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
1441
1442
			/**
1443
			* Filter a sanitized key string.
1444
			*
1445
			* @since 3.0.0
1446
			*
1447
			* @param string $key     Sanitized key.
1448
			* @param string $raw_key The key prior to sanitization.
1449
			*/
1450
			return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
1451
		}
1452
1453
		/**
1454
		 * Amend default configuration settings.
1455
		 *
1456
		 * @since 2.0.0
1457
		 *
1458
		 * @param array $config Array of config options to pass as class properties.
1459
		 */
1460
		public function config( $config ) {
1461
			$keys = array(
1462
				'id',
1463
				'default_path',
1464
				'has_notices',
1465
				'dismissable',
1466
				'dismiss_msg',
1467
				'menu',
1468
				'parent_slug',
1469
				'capability',
1470
				'is_automatic',
1471
				'message',
1472
				'strings',
1473
			);
1474
1475
			foreach ( $keys as $key ) {
1476
				if ( isset( $config[ $key ] ) ) {
1477
					if ( is_array( $config[ $key ] ) ) {
1478
						$this->$key = array_merge( $this->$key, $config[ $key ] );
1479
					} else {
1480
						$this->$key = $config[ $key ];
1481
					}
1482
				}
1483
			}
1484
		}
1485
1486
		/**
1487
		 * Amend action link after plugin installation.
1488
		 *
1489
		 * @since 2.0.0
1490
		 *
1491
		 * @param array $install_actions Existing array of actions.
1492
		 * @return array Amended array of actions.
1493
		 */
1494
		public function actions( $install_actions ) {
1495
			// Remove action links on the TGMPA install page.
1496
			if ( $this->is_tgmpa_page() ) {
1497
				return false;
1498
			}
1499
1500
			return $install_actions;
1501
		}
1502
1503
		/**
1504
		 * Flushes the plugins cache on theme switch to prevent stale entries
1505
		 * from remaining in the plugin table.
1506
		 *
1507
		 * @since 2.4.0
1508
		 *
1509
		 * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
1510
		 *                                 Parameter added in v2.5.0.
1511
		 */
1512
		public function flush_plugins_cache( $clear_update_cache = true ) {
1513
			wp_clean_plugins_cache( $clear_update_cache );
1514
		}
1515
1516
		/**
1517
		 * Set file_path key for each installed plugin.
1518
		 *
1519
		 * @since 2.1.0
1520
		 *
1521
		 * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
1522
		 *                            Parameter added in v2.5.0.
1523
		 */
1524
		public function populate_file_path( $plugin_slug = '' ) {
1525
			if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
1526
				$this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
1527
			} else {
1528
				// Add file_path key for all plugins.
1529
				foreach ( $this->plugins as $slug => $values ) {
1530
					$this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
1531
				}
1532
			}
1533
		}
1534
1535
		/**
1536
		 * Helper function to extract the file path of the plugin file from the
1537
		 * plugin slug, if the plugin is installed.
1538
		 *
1539
		 * @since 2.0.0
1540
		 *
1541
		 * @param string $slug Plugin slug (typically folder name) as provided by the developer.
1542
		 * @return string Either file path for plugin if installed, or just the plugin slug.
1543
		 */
1544
		protected function _get_plugin_basename_from_slug( $slug ) {
1545
			$keys = array_keys( $this->get_plugins() );
1546
1547
			foreach ( $keys as $key ) {
1548
				if ( preg_match( '|^' . $slug . '/|', $key ) ) {
1549
					return $key;
1550
				}
1551
			}
1552
1553
			return $slug;
1554
		}
1555
1556
		/**
1557
		 * Retrieve plugin data, given the plugin name.
1558
		 *
1559
		 * Loops through the registered plugins looking for $name. If it finds it,
1560
		 * it returns the $data from that plugin. Otherwise, returns false.
1561
		 *
1562
		 * @since 2.1.0
1563
		 *
1564
		 * @param string $name Name of the plugin, as it was registered.
1565
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
1566
		 * @return string|boolean Plugin slug if found, false otherwise.
1567
		 */
1568
		public function _get_plugin_data_from_name( $name, $data = 'slug' ) {
1569
			foreach ( $this->plugins as $values ) {
1570
				if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
1571
					return $values[ $data ];
1572
				}
1573
			}
1574
1575
			return false;
1576
		}
1577
1578
		/**
1579
		 * Retrieve the download URL for a package.
1580
		 *
1581
		 * @since 2.5.0
1582
		 *
1583
		 * @param string $slug Plugin slug.
1584
		 * @return string Plugin download URL or path to local file or empty string if undetermined.
1585
		 */
1586
		public function get_download_url( $slug ) {
1587
			$dl_source = '';
1588
1589
			switch ( $this->plugins[ $slug ]['source_type'] ) {
1590
				case 'repo':
1591
					return $this->get_wp_repo_download_url( $slug );
1592
				case 'external':
1593
					return $this->plugins[ $slug ]['source'];
1594
				case 'bundled':
1595
					return $this->default_path . $this->plugins[ $slug ]['source'];
1596
			}
1597
1598
			return $dl_source; // Should never happen.
1599
		}
1600
1601
		/**
1602
		 * Retrieve the download URL for a WP repo package.
1603
		 *
1604
		 * @since 2.5.0
1605
		 *
1606
		 * @param string $slug Plugin slug.
1607
		 * @return string Plugin download URL.
1608
		 */
1609
		protected function get_wp_repo_download_url( $slug ) {
1610
			$source = '';
1611
			$api    = $this->get_plugins_api( $slug );
1612
1613
			if ( false !== $api && isset( $api->download_link ) ) {
1614
				$source = $api->download_link;
1615
			}
1616
1617
			return $source;
1618
		}
1619
1620
		/**
1621
		 * Try to grab information from WordPress API.
1622
		 *
1623
		 * @since 2.5.0
1624
		 *
1625
		 * @param string $slug Plugin slug.
1626
		 * @return object Plugins_api response object on success, WP_Error on failure.
1627
		 */
1628
		protected function get_plugins_api( $slug ) {
1629
			static $api = array(); // Cache received responses.
1630
1631
			if ( ! isset( $api[ $slug ] ) ) {
1632
				if ( ! function_exists( 'plugins_api' ) ) {
1633
					require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
1634
				}
1635
1636
				$response = plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false ) ) );
1637
1638
				$api[ $slug ] = false;
1639
1640
				if ( is_wp_error( $response ) ) {
1641
					wp_die( esc_html( $this->strings['oops'] ) );
1642
				} else {
1643
					$api[ $slug ] = $response;
1644
				}
1645
			}
1646
1647
			return $api[ $slug ];
1648
		}
1649
1650
		/**
1651
		 * Retrieve a link to a plugin information page.
1652
		 *
1653
		 * @since 2.5.0
1654
		 *
1655
		 * @param string $slug Plugin slug.
1656
		 * @return string Fully formed html link to a plugin information page if available
1657
		 *                or the plugin name if not.
1658
		 */
1659
		public function get_info_link( $slug ) {
1660
			if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
1661
				$link = sprintf(
1662
					'<a href="%1$s" target="_blank">%2$s</a>',
1663
					esc_url( $this->plugins[ $slug ]['external_url'] ),
1664
					esc_html( $this->plugins[ $slug ]['name'] )
1665
				);
1666
			} elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
1667
				$url = add_query_arg(
1668
					array(
1669
						'tab'       => 'plugin-information',
1670
						'plugin'    => urlencode( $slug ),
1671
						'TB_iframe' => 'true',
1672
						'width'     => '640',
1673
						'height'    => '500',
1674
					),
1675
					self_admin_url( 'plugin-install.php' )
1676
				);
1677
1678
				$link = sprintf(
1679
					'<a href="%1$s" class="thickbox">%2$s</a>',
1680
					esc_url( $url ),
1681
					esc_html( $this->plugins[ $slug ]['name'] )
1682
				);
1683
			} else {
1684
				$link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
1685
			}
1686
1687
			return $link;
1688
		}
1689
1690
		/**
1691
		 * Determine if we're on the TGMPA Install page.
1692
		 *
1693
		 * @since 2.1.0
1694
		 *
1695
		 * @return boolean True when on the TGMPA page, false otherwise.
1696
		 */
1697
		protected function is_tgmpa_page() {
1698
			return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
1699
		}
1700
1701
		/**
1702
		 * Retrieve the URL to the TGMPA Install page.
1703
		 *
1704
		 * I.e. depending on the config settings passed something along the lines of:
1705
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
1706
		 *
1707
		 * @since 2.5.0
1708
		 *
1709
		 * @return string Properly encoded URL (not escaped).
1710
		 */
1711
		public function get_tgmpa_url() {
1712
			static $url;
1713
1714
			if ( ! isset( $url ) ) {
1715
				$parent = $this->parent_slug;
1716
				if ( false === strpos( $parent, '.php' ) ) {
1717
					$parent = 'admin.php';
1718
				}
1719
				$url = add_query_arg(
1720
					array(
1721
						'page' => urlencode( $this->menu ),
1722
					),
1723
					self_admin_url( $parent )
1724
				);
1725
			}
1726
1727
			return $url;
1728
		}
1729
1730
		/**
1731
		 * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
1732
		 *
1733
		 * I.e. depending on the config settings passed something along the lines of:
1734
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install
1735
		 *
1736
		 * @since 2.5.0
1737
		 *
1738
		 * @param string $status Plugin status - either 'install', 'update' or 'activate'.
1739
		 * @return string Properly encoded URL (not escaped).
1740
		 */
1741
		public function get_tgmpa_status_url( $status ) {
1742
			return add_query_arg(
1743
				array(
1744
					'plugin_status' => urlencode( $status ),
1745
				),
1746
				$this->get_tgmpa_url()
1747
			);
1748
		}
1749
1750
		/**
1751
		 * Determine whether there are open actions for plugins registered with TGMPA.
1752
		 *
1753
		 * @since 2.5.0
1754
		 *
1755
		 * @return bool True if complete, i.e. no outstanding actions. False otherwise.
1756
		 */
1757
		public function is_tgmpa_complete() {
1758
			$complete = true;
1759
			foreach ( $this->plugins as $slug => $plugin ) {
1760
				if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1761
					$complete = false;
1762
					break;
1763
				}
1764
			}
1765
1766
			return $complete;
1767
		}
1768
1769
		/**
1770
		 * Check if a plugin is installed. Does not take must-use plugins into account.
1771
		 *
1772
		 * @since 2.5.0
1773
		 *
1774
		 * @param string $slug Plugin slug.
1775
		 * @return bool True if installed, false otherwise.
1776
		 */
1777
		public function is_plugin_installed( $slug ) {
1778
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1779
1780
			return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
1781
		}
1782
1783
		/**
1784
		 * Check if a plugin is active.
1785
		 *
1786
		 * @since 2.5.0
1787
		 *
1788
		 * @param string $slug Plugin slug.
1789
		 * @return bool True if active, false otherwise.
1790
		 */
1791
		public function is_plugin_active( $slug ) {
1792
			return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) ) || is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
1793
		}
1794
1795
		/**
1796
		 * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
1797
		 * available, check whether the current install meets them.
1798
		 *
1799
		 * @since 2.5.0
1800
		 *
1801
		 * @param string $slug Plugin slug.
1802
		 * @return bool True if OK to update, false otherwise.
1803
		 */
1804
		public function can_plugin_update( $slug ) {
1805
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1806
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1807
				return true;
1808
			}
1809
1810
			$api = $this->get_plugins_api( $slug );
1811
1812
			if ( false !== $api && isset( $api->requires ) ) {
1813
				return version_compare( $this->wp_version, $api->requires, '>=' );
1814
			}
1815
1816
			// No usable info received from the plugins API, presume we can update.
1817
			return true;
1818
		}
1819
1820
		/**
1821
		 * Check to see if the plugin is 'updatetable', i.e. installed, with an update available
1822
		 * and no WP version requirements blocking it.
1823
		 *
1824
		 * @since 2.x.x
1825
		 *
1826
		 * @param string $slug Plugin slug.
1827
		 * @return bool True if OK to proceed with update, false otherwise.
1828
		 */
1829
		public function is_plugin_updatetable( $slug ) {
1830
			if ( ! $this->is_plugin_installed( $slug ) ) {
1831
				return false;
1832
			} else {
1833
				return ( $this->does_plugin_have_update( $slug ) && $this->can_plugin_update( $slug ) );
1834
			}
1835
		}
1836
1837
		/**
1838
		 * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
1839
		 * plugin version requirements set in TGMPA (if any).
1840
		 *
1841
		 * @since 2.5.0
1842
		 *
1843
		 * @param string $slug Plugin slug.
1844
		 * @return bool True if OK to activate, false otherwise.
1845
		 */
1846
		public function can_plugin_activate( $slug ) {
1847
			return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
1848
		}
1849
1850
		/**
1851
		 * Retrieve the version number of an installed plugin.
1852
		 *
1853
		 * @since 2.5.0
1854
		 *
1855
		 * @param string $slug Plugin slug.
1856
		 * @return string Version number as string or an empty string if the plugin is not installed
1857
		 *                or version unknown (plugins which don't comply with the plugin header standard).
1858
		 */
1859
		public function get_installed_version( $slug ) {
1860
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1861
1862
			if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
1863
				return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
1864
			}
1865
1866
			return '';
1867
		}
1868
1869
		/**
1870
		 * Check whether a plugin complies with the minimum version requirements.
1871
		 *
1872
		 * @since 2.5.0
1873
		 *
1874
		 * @param string $slug Plugin slug.
1875
		 * @return bool True when a plugin needs to be updated, otherwise false.
1876
		 */
1877
		public function does_plugin_require_update( $slug ) {
1878
			$installed_version = $this->get_installed_version( $slug );
1879
			$minimum_version   = $this->plugins[ $slug ]['version'];
1880
1881
			return version_compare( $minimum_version, $installed_version, '>' );
1882
		}
1883
1884
		/**
1885
		 * Check whether there is an update available for a plugin.
1886
		 *
1887
		 * @since 2.5.0
1888
		 *
1889
		 * @param string $slug Plugin slug.
1890
		 * @return false|string Version number string of the available update or false if no update available.
1891
		 */
1892
		public function does_plugin_have_update( $slug ) {
1893
			// Presume bundled and external plugins will point to a package which meets the minimum required version.
1894
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1895
				if ( $this->does_plugin_require_update( $slug ) ) {
1896
					return $this->plugins[ $slug ]['version'];
1897
				}
1898
1899
				return false;
1900
			}
1901
1902
			$repo_updates = get_site_transient( 'update_plugins' );
1903
1904 View Code Duplication
			if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
1905
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
1906
			}
1907
1908
			return false;
1909
		}
1910
1911
		/**
1912
		 * Retrieve potential upgrade notice for a plugin.
1913
		 *
1914
		 * @since 2.5.0
1915
		 *
1916
		 * @param string $slug Plugin slug.
1917
		 * @return string The upgrade notice or an empty string if no message was available or provided.
1918
		 */
1919
		public function get_upgrade_notice( $slug ) {
1920
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1921
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1922
				return '';
1923
			}
1924
1925
			$repo_updates = get_site_transient( 'update_plugins' );
1926
1927 View Code Duplication
			if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
1928
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
1929
			}
1930
1931
			return '';
1932
		}
1933
1934
		/**
1935
		 * Wrapper around the core WP get_plugins function, making sure it's actually available.
1936
		 *
1937
		 * @since 2.5.0
1938
		 *
1939
		 * @param string $plugin_folder Optional. Relative path to single plugin folder.
1940
		 * @return array Array of installed plugins with plugin information.
1941
		 */
1942
		public function get_plugins( $plugin_folder = '' ) {
1943
			if ( ! function_exists( 'get_plugins' ) ) {
1944
				require_once ABSPATH . 'wp-admin/includes/plugin.php';
1945
			}
1946
1947
			return get_plugins( $plugin_folder );
1948
		}
1949
1950
		/**
1951
		 * Delete dismissable nag option when theme is switched.
1952
		 *
1953
		 * This ensures that the user(s) is/are again reminded via nag of required
1954
		 * and/or recommended plugins if they re-activate the theme.
1955
		 *
1956
		 * @since 2.1.1
1957
		 */
1958
		public function update_dismiss() {
1959
			delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
1960
		}
1961
1962
		/**
1963
		 * Forces plugin activation if the parameter 'force_activation' is
1964
		 * set to true.
1965
		 *
1966
		 * This allows theme authors to specify certain plugins that must be
1967
		 * active at all times while using the current theme.
1968
		 *
1969
		 * Please take special care when using this parameter as it has the
1970
		 * potential to be harmful if not used correctly. Setting this parameter
1971
		 * to true will not allow the specified plugin to be deactivated unless
1972
		 * the user switches themes.
1973
		 *
1974
		 * @since 2.2.0
1975
		 */
1976
		public function force_activation() {
1977
			foreach ( $this->plugins as $slug => $plugin ) {
1978
				if ( true === $plugin['force_activation'] ) {
1979
					if ( ! $this->is_plugin_installed( $slug ) ) {
1980
						// Oops, plugin isn't there so iterate to next condition.
1981
						continue;
1982
					} elseif ( $this->can_plugin_activate( $slug ) ) {
1983
						// There we go, activate the plugin.
1984
						activate_plugin( $plugin['file_path'] );
1985
					}
1986
				}
1987
			}
1988
		}
1989
1990
		/**
1991
		 * Forces plugin deactivation if the parameter 'force_deactivation'
1992
		 * is set to true.
1993
		 *
1994
		 * This allows theme authors to specify certain plugins that must be
1995
		 * deactivated upon switching from the current theme to another.
1996
		 *
1997
		 * Please take special care when using this parameter as it has the
1998
		 * potential to be harmful if not used correctly.
1999
		 *
2000
		 * @since 2.2.0
2001
		 */
2002
		public function force_deactivation() {
2003
			foreach ( $this->plugins as $slug => $plugin ) {
2004
				// Only proceed forward if the parameter is set to true and plugin is active.
2005
				if ( true === $plugin['force_deactivation'] && $this->is_plugin_active( $slug ) ) {
2006
					deactivate_plugins( $plugin['file_path'] );
2007
				}
2008
			}
2009
		}
2010
2011
		/**
2012
		 * Echo the current TGMPA version number to the page.
2013
		 */
2014
		public function show_tgmpa_version() {
2015
			echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
2016
				esc_html( sprintf( _x( 'TGMPA v%s', '%s = version number', 'tgmpa' ), self::TGMPA_VERSION ) ),
2017
				'</small></strong></p>';
2018
		}
2019
2020
		/**
2021
		 * Returns the singleton instance of the class.
2022
		 *
2023
		 * @since 2.4.0
2024
		 *
2025
		 * @return object The TGM_Plugin_Activation object.
2026
		 */
2027
		public static function get_instance() {
2028
			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
2029
				self::$instance = new self();
2030
			}
2031
2032
			return self::$instance;
2033
		}
2034
	}
2035
2036
	if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
2037
		/**
2038
		 * Ensure only one instance of the class is ever invoked.
2039
		 */
2040
		function load_tgm_plugin_activation() {
2041
			$GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
2042
		}
2043
	}
2044
2045
	if ( did_action( 'plugins_loaded' ) ) {
2046
		load_tgm_plugin_activation();
2047
	} else {
2048
		add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
2049
	}
2050
}
2051
2052
if ( ! function_exists( 'tgmpa' ) ) {
2053
	/**
2054
	 * Helper function to register a collection of required plugins.
2055
	 *
2056
	 * @since 2.0.0
2057
	 * @api
2058
	 *
2059
	 * @param array $plugins An array of plugin arrays.
2060
	 * @param array $config  Optional. An array of configuration values.
2061
	 */
2062
	function tgmpa( $plugins, $config = array() ) {
2063
		$instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2064
2065
		foreach ( $plugins as $plugin ) {
2066
			call_user_func( array( $instance, 'register' ), $plugin );
2067
		}
2068
2069
		if ( ! empty( $config ) && is_array( $config ) ) {
2070
			// Send out notices for deprecated arguments passed.
2071
			if ( isset( $config['notices'] ) ) {
2072
				_deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
2073
				if ( ! isset( $config['has_notices'] ) ) {
2074
					$config['has_notices'] = $config['notices'];
2075
				}
2076
			}
2077
2078
			if ( isset( $config['parent_menu_slug'] ) ) {
2079
				_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.' );
2080
			}
2081
			if ( isset( $config['parent_url_slug'] ) ) {
2082
				_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.' );
2083
			}
2084
2085
			call_user_func( array( $instance, 'config' ), $config );
2086
		}
2087
	}
2088
}
2089
2090
/**
2091
 * WP_List_Table isn't always available. If it isn't available,
2092
 * we load it here.
2093
 *
2094
 * @since 2.2.0
2095
 */
2096
if ( ! class_exists( 'WP_List_Table' ) ) {
2097
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
2098
}
2099
2100
if ( ! class_exists( 'TGMPA_List_Table' ) ) {
2101
2102
	/**
2103
	 * List table class for handling plugins.
2104
	 *
2105
	 * Extends the WP_List_Table class to provide a future-compatible
2106
	 * way of listing out all required/recommended plugins.
2107
	 *
2108
	 * Gives users an interface similar to the Plugin Administration
2109
	 * area with similar (albeit stripped down) capabilities.
2110
	 *
2111
	 * This class also allows for the bulk install of plugins.
2112
	 *
2113
	 * @since 2.2.0
2114
	 *
2115
	 * @package TGM-Plugin-Activation
2116
	 * @author  Thomas Griffin
2117
	 * @author  Gary Jones
2118
	 */
2119
	class TGMPA_List_Table extends WP_List_Table {
2120
		/**
2121
		 * TGMPA instance.
2122
		 *
2123
		 * @since 2.5.0
2124
		 *
2125
		 * @var object
2126
		 */
2127
		protected $tgmpa;
2128
2129
		/**
2130
		 * The currently chosen view.
2131
		 *
2132
		 * @since 2.5.0
2133
		 *
2134
		 * @var string One of: 'all', 'install', 'update', 'activate'
2135
		 */
2136
		public $view_context = 'all';
2137
2138
		/**
2139
		 * The plugin counts for the various views.
2140
		 *
2141
		 * @since 2.5.0
2142
		 *
2143
		 * @var array
2144
		 */
2145
		protected $view_totals = array(
2146
			'all'      => 0,
2147
			'install'  => 0,
2148
			'update'   => 0,
2149
			'activate' => 0,
2150
		);
2151
2152
		/**
2153
		 * References parent constructor and sets defaults for class.
2154
		 *
2155
		 * @since 2.2.0
2156
		 */
2157
		public function __construct() {
2158
			$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2159
2160
			parent::__construct(
2161
				array(
2162
					'singular' => 'plugin',
2163
					'plural'   => 'plugins',
2164
					'ajax'     => false,
2165
				)
2166
			);
2167
2168
			if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
2169
				$this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
2170
			}
2171
2172
			add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
2173
		}
2174
2175
		/**
2176
		 * Get a list of CSS classes for the <table> tag.
2177
		 *
2178
		 * Overruled to prevent the 'plural' argument from being added.
2179
		 *
2180
		 * @since 2.5.0
2181
		 *
2182
		 * @return array CSS classnames.
2183
		 */
2184
		public function get_table_classes() {
2185
			return array( 'widefat', 'fixed' );
2186
		}
2187
2188
		/**
2189
		 * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
2190
		 *
2191
		 * @since 2.2.0
2192
		 *
2193
		 * @return array $table_data Information for use in table.
2194
		 */
2195
		protected function _gather_plugin_data() {
2196
			// Load thickbox for plugin links.
2197
			$this->tgmpa->admin_init();
2198
			$this->tgmpa->thickbox();
2199
2200
			// Categorize the plugins which have open actions.
2201
			$plugins = $this->categorize_plugins_to_views();
2202
2203
			// Set the counts for the view links.
2204
			$this->set_view_totals( $plugins );
2205
2206
			// Prep variables for use and grab list of all installed plugins.
2207
			$table_data = array();
2208
			$i          = 0;
2209
2210
			// Redirect to the 'all' view if no plugins were found for the selected view context.
2211
			if ( empty( $plugins[ $this->view_context ] ) ) {
2212
				$this->view_context = 'all';
2213
			}
2214
2215
			foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
2216
				$table_data[ $i ]['sanitized_plugin']  = $plugin['name'];
2217
				$table_data[ $i ]['slug']              = $slug;
2218
				$table_data[ $i ]['plugin']            = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
2219
				$table_data[ $i ]['source']            = $this->get_plugin_source_type_text( $plugin['source_type'] );
2220
				$table_data[ $i ]['type']              = $this->get_plugin_advise_type_text( $plugin['required'] );
2221
				$table_data[ $i ]['status']            = $this->get_plugin_status_text( $slug );
2222
				$table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
2223
				$table_data[ $i ]['minimum_version']   = $plugin['version'];
2224
				$table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
2225
2226
				// Prep the upgrade notice info.
2227
				$upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
2228
				if ( ! empty( $upgrade_notice ) ) {
2229
					$table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
2230
2231
					add_action( "tgmpa_after_plugin_row_$slug", array( $this, 'wp_plugin_update_row' ), 10, 2 );
2232
				}
2233
2234
				$table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
2235
2236
				$i++;
2237
			}
2238
2239
			return $table_data;
2240
		}
2241
2242
		/**
2243
		 * Categorize the plugins which have open actions into views for the TGMPA page.
2244
		 *
2245
		 * @since 2.5.0
2246
		 */
2247
		protected function categorize_plugins_to_views() {
2248
			$plugins = array(
2249
				'all'      => array(), // Meaning: all plugins which still have open actions.
2250
				'install'  => array(),
2251
				'update'   => array(),
2252
				'activate' => array(),
2253
			);
2254
2255
			foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
2256
				if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2257
					// No need to display plugins if they are installed, up-to-date and active.
2258
					continue;
2259
				} else {
2260
					$plugins['all'][ $slug ] = $plugin;
2261
2262
					if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2263
						$plugins['install'][ $slug ] = $plugin;
2264
					} else {
2265
						if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2266
							$plugins['update'][ $slug ] = $plugin;
2267
						}
2268
2269
						if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2270
							$plugins['activate'][ $slug ] = $plugin;
2271
						}
2272
					}
2273
				}
2274
			}
2275
2276
			return $plugins;
2277
		}
2278
2279
		/**
2280
		 * Set the counts for the view links.
2281
		 *
2282
		 * @since 2.5.0
2283
		 *
2284
		 * @param array $plugins Plugins order by view.
2285
		 */
2286
		protected function set_view_totals( $plugins ) {
2287
			foreach ( $plugins as $type => $list ) {
2288
				$this->view_totals[ $type ] = count( $list );
2289
			}
2290
		}
2291
2292
		/**
2293
		 * Get the plugin required/recommended text string.
2294
		 *
2295
		 * @since 2.5.0
2296
		 *
2297
		 * @param string $required Plugin required setting.
2298
		 * @return string
2299
		 */
2300
		protected function get_plugin_advise_type_text( $required ) {
2301
			if ( true === $required ) {
2302
				return __( 'Required', 'tgmpa' );
2303
			}
2304
2305
			return __( 'Recommended', 'tgmpa' );
2306
		}
2307
2308
		/**
2309
		 * Get the plugin source type text string.
2310
		 *
2311
		 * @since 2.5.0
2312
		 *
2313
		 * @param string $type Plugin type.
2314
		 * @return string
2315
		 */
2316
		protected function get_plugin_source_type_text( $type ) {
2317
			$string = '';
2318
2319
			switch ( $type ) {
2320
				case 'repo':
2321
					$string = __( 'WordPress Repository', 'tgmpa' );
2322
					break;
2323
				case 'external':
2324
					$string = __( 'External Source', 'tgmpa' );
2325
					break;
2326
				case 'bundled':
2327
					$string = __( 'Pre-Packaged', 'tgmpa' );
2328
					break;
2329
			}
2330
2331
			return $string;
2332
		}
2333
2334
		/**
2335
		 * Determine the plugin status message.
2336
		 *
2337
		 * @since 2.5.0
2338
		 *
2339
		 * @param string $slug Plugin slug.
2340
		 * @return string
2341
		 */
2342
		protected function get_plugin_status_text( $slug ) {
2343
			if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2344
				return __( 'Not Installed', 'tgmpa' );
2345
			}
2346
2347
			if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
2348
				$install_status = __( 'Installed But Not Activated', 'tgmpa' );
2349
			} else {
2350
				$install_status = __( 'Active', 'tgmpa' );
2351
			}
2352
2353
			$update_status = '';
2354
2355
			if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2356
				$update_status = __( 'Required Update not Available', 'tgmpa' );
2357
2358
			} elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
2359
				$update_status = __( 'Requires Update', 'tgmpa' );
2360
2361
			} elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2362
				$update_status = __( 'Update recommended', 'tgmpa' );
2363
			}
2364
2365
			if ( '' === $update_status ) {
2366
				return $install_status;
2367
			}
2368
2369
			return sprintf(
2370
				_x( '%1$s, %2$s', '%1$s = install status, %2$s = update status', 'tgmpa' ),
2371
				$install_status,
2372
				$update_status
2373
			);
2374
		}
2375
2376
		/**
2377
		 * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
2378
		 *
2379
		 * @since 2.5.0
2380
		 *
2381
		 * @param array $items Prepared table items.
2382
		 * @return array Sorted table items.
2383
		 */
2384
		public function sort_table_items( $items ) {
2385
			$type = array();
2386
			$name = array();
2387
2388
			foreach ( $items as $i => $plugin ) {
2389
				$type[ $i ] = $plugin['type']; // Required / recommended.
2390
				$name[ $i ] = $plugin['sanitized_plugin'];
2391
			}
2392
2393
			array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
2394
2395
			return $items;
2396
		}
2397
2398
		/**
2399
		 * Get an associative array ( id => link ) of the views available on this table.
2400
		 *
2401
		 * @since 2.5.0
2402
		 *
2403
		 * @return array
2404
		 */
2405
		public function get_views() {
2406
			$status_links = array();
2407
2408
			foreach ( $this->view_totals as $type => $count ) {
2409
				if ( $count < 1 ) {
2410
					continue;
2411
				}
2412
2413
				switch ( $type ) {
2414
					case 'all':
2415
						$text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
2416
						break;
2417
					case 'install':
2418
						$text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
2419
						break;
2420
					case 'update':
2421
						$text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
2422
						break;
2423
					case 'activate':
2424
						$text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
2425
						break;
2426
					default:
2427
						$text = '';
2428
						break;
2429
				}
2430
2431
				if ( ! empty( $text ) ) {
2432
2433
					$status_links[ $type ] = sprintf(
2434
						'<a href="%s"%s>%s</a>',
2435
						esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
2436
						( $type === $this->view_context ) ? ' class="current"' : '',
2437
						sprintf( $text, number_format_i18n( $count ) )
2438
					);
2439
				}
2440
			}
2441
2442
			return $status_links;
2443
		}
2444
2445
		/**
2446
		 * Create default columns to display important plugin information
2447
		 * like type, action and status.
2448
		 *
2449
		 * @since 2.2.0
2450
		 *
2451
		 * @param array  $item        Array of item data.
2452
		 * @param string $column_name The name of the column.
2453
		 * @return string
2454
		 */
2455
		public function column_default( $item, $column_name ) {
2456
			return $item[ $column_name ];
2457
		}
2458
2459
		/**
2460
		 * Required for bulk installing.
2461
		 *
2462
		 * Adds a checkbox for each plugin.
2463
		 *
2464
		 * @since 2.2.0
2465
		 *
2466
		 * @param array $item Array of item data.
2467
		 * @return string The input checkbox with all necessary info.
2468
		 */
2469
		public function column_cb( $item ) {
2470
			return sprintf(
2471
				'<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
2472
				esc_attr( $this->_args['singular'] ),
2473
				esc_attr( $item['slug'] ),
2474
				esc_attr( $item['sanitized_plugin'] )
2475
			);
2476
		}
2477
2478
		/**
2479
		 * Create default title column along with the action links.
2480
		 *
2481
		 * @since 2.2.0
2482
		 *
2483
		 * @param array $item Array of item data.
2484
		 * @return string The plugin name and action links.
2485
		 */
2486
		public function column_plugin( $item ) {
2487
			return sprintf(
2488
				'%1$s %2$s',
2489
				$item['plugin'],
2490
				$this->row_actions( $this->get_row_actions( $item ), true )
2491
			);
2492
		}
2493
2494
		/**
2495
		 * Create version information column.
2496
		 *
2497
		 * @since 2.5.0
2498
		 *
2499
		 * @param array $item Array of item data.
2500
		 * @return string HTML-formatted version information.
2501
		 */
2502
		public function column_version( $item ) {
2503
			$output = array();
2504
2505
			if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2506
				$installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
2507
2508
				$color = '';
2509
				if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
2510
					$color = ' color: #ff0000; font-weight: bold;';
2511
				}
2512
2513
				$output[] = sprintf(
2514
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
2515
					$color,
2516
					$installed
2517
				);
2518
			}
2519
2520
			if ( ! empty( $item['minimum_version'] ) ) {
2521
				$output[] = sprintf(
2522
					'<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
2523
					$item['minimum_version']
2524
				);
2525
			}
2526
2527
			if ( ! empty( $item['available_version'] ) ) {
2528
				$color = '';
2529
				if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
2530
					$color = ' color: #71C671; font-weight: bold;';
2531
				}
2532
2533
				$output[] = sprintf(
2534
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
2535
					$color,
2536
					$item['available_version']
2537
				);
2538
			}
2539
2540
			if ( empty( $output ) ) {
2541
				return '&nbsp;'; // Let's not break the table layout.
2542
			} else {
2543
				return implode( "\n", $output );
2544
			}
2545
		}
2546
2547
		/**
2548
		 * Sets default message within the plugins table if no plugins
2549
		 * are left for interaction.
2550
		 *
2551
		 * Hides the menu item to prevent the user from clicking and
2552
		 * getting a permissions error.
2553
		 *
2554
		 * @since 2.2.0
2555
		 */
2556
		public function no_items() {
2557
			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() ) );
2558
			echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
2559
		}
2560
2561
		/**
2562
		 * Output all the column information within the table.
2563
		 *
2564
		 * @since 2.2.0
2565
		 *
2566
		 * @return array $columns The column names.
2567
		 */
2568
		public function get_columns() {
2569
			$columns = array(
2570
				'cb'     => '<input type="checkbox" />',
2571
				'plugin' => __( 'Plugin', 'tgmpa' ),
2572
				'source' => __( 'Source', 'tgmpa' ),
2573
				'type'   => __( 'Type', 'tgmpa' ),
2574
			);
2575
2576
			if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
2577
				$columns['version'] = __( 'Version', 'tgmpa' );
2578
				$columns['status']  = __( 'Status', 'tgmpa' );
2579
			}
2580
2581
			return apply_filters( 'tgmpa_table_columns', $columns );
2582
		}
2583
2584
		/**
2585
		 * Get name of default primary column
2586
		 *
2587
		 * @since 2.5.0 / WP 4.3+ compatibility
2588
		 * @access protected
2589
		 *
2590
		 * @return string
2591
		 */
2592
		protected function get_default_primary_column_name() {
2593
			return 'plugin';
2594
		}
2595
2596
		/**
2597
		 * Get the name of the primary column.
2598
		 *
2599
		 * @since 2.5.0 / WP 4.3+ compatibility
2600
		 * @access protected
2601
		 *
2602
		 * @return string The name of the primary column.
2603
		 */
2604
		protected function get_primary_column_name() {
2605
			if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
2606
				return parent::get_primary_column_name();
2607
			} else {
2608
				return $this->get_default_primary_column_name();
2609
			}
2610
		}
2611
2612
		/**
2613
		 * Get the actions which are relevant for a specific plugin row.
2614
		 *
2615
		 * @since 2.5.0
2616
		 *
2617
		 * @param array $item Array of item data.
2618
		 * @return array Array with relevant action links.
2619
		 */
2620
		protected function get_row_actions( $item ) {
2621
			$actions      = array();
2622
			$action_links = array();
2623
2624
			// Display the 'Install' action link if the plugin is not yet available.
2625
			if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2626
				$actions['install'] = _x( 'Install %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2627
			} else {
2628
				// Display the 'Update' action link if an update is available and WP complies with plugin minimum.
2629
				if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
2630
					$actions['update'] = _x( 'Update %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2631
				}
2632
2633
				// Display the 'Activate' action link, but only if the plugin meets the minimum version.
2634
				if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
2635
					$actions['activate'] = _x( 'Activate %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2636
				}
2637
			}
2638
2639
			// Create the actual links.
2640
			foreach ( $actions as $action => $text ) {
2641
				$nonce_url = wp_nonce_url(
2642
					add_query_arg(
2643
						array(
2644
							'plugin'           => urlencode( $item['slug'] ),
2645
							'tgmpa-' . $action => $action . '-plugin',
2646
						),
2647
						$this->tgmpa->get_tgmpa_url()
2648
					),
2649
					'tgmpa-' . $action,
2650
					'tgmpa-nonce'
2651
				);
2652
2653
				$action_links[ $action ] = sprintf(
2654
					'<a href="%1$s">' . esc_html( $text ) . '</a>',
2655
					esc_url( $nonce_url ),
2656
					'<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
2657
				);
2658
			}
2659
2660
			$prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
2661
			return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
2662
		}
2663
2664
		/**
2665
		 * Generates content for a single row of the table.
2666
		 *
2667
		 * @since 2.5.0
2668
		 *
2669
		 * @param object $item The current item.
2670
		 */
2671
		public function single_row( $item ) {
2672
			parent::single_row( $item );
2673
2674
			/**
2675
			 * Fires after each specific row in the TGMPA Plugins list table.
2676
			 *
2677
			 * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
2678
			 * for the plugin.
2679
			 *
2680
			 * @since 2.5.0
2681
			 */
2682
			do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
2683
		}
2684
2685
		/**
2686
		 * Show the upgrade notice below a plugin row if there is one.
2687
		 *
2688
		 * @since 2.5.0
2689
		 *
2690
		 * @see /wp-admin/includes/update.php
2691
		 *
2692
		 * @param string $slug Plugin slug.
2693
		 * @param array  $item The information available in this table row.
2694
		 * @return null Return early if upgrade notice is empty.
2695
		 */
2696
		public function wp_plugin_update_row( $slug, $item ) {
2697
			if ( empty( $item['upgrade_notice'] ) ) {
2698
				return;
2699
			}
2700
2701
			echo '
2702
				<tr class="plugin-update-tr">
2703
					<td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
2704
						<div class="update-message">',
2705
							esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
2706
							' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
2707
						</div>
2708
					</td>
2709
				</tr>';
2710
		}
2711
2712
		/**
2713
		 * Extra controls to be displayed between bulk actions and pagination.
2714
		 *
2715
		 * @since 2.5.0
2716
		 *
2717
		 * @param string $which 'top' or 'bottom' table navigation.
2718
		 */
2719
		public function extra_tablenav( $which ) {
2720
			if ( 'bottom' === $which ) {
2721
				$this->tgmpa->show_tgmpa_version();
2722
			}
2723
		}
2724
2725
		/**
2726
		 * Defines the bulk actions for handling registered plugins.
2727
		 *
2728
		 * @since 2.2.0
2729
		 *
2730
		 * @return array $actions The bulk actions for the plugin install table.
2731
		 */
2732
		public function get_bulk_actions() {
2733
2734
			$actions = array();
2735
2736
			if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
2737
				if ( current_user_can( 'install_plugins' ) ) {
2738
					$actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
2739
				}
2740
			}
2741
2742
			if ( 'install' !== $this->view_context ) {
2743
				if ( current_user_can( 'update_plugins' ) ) {
2744
					$actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
2745
				}
2746
				if ( current_user_can( 'activate_plugins' ) ) {
2747
					$actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
2748
				}
2749
			}
2750
2751
			return $actions;
2752
		}
2753
2754
		/**
2755
		 * Processes bulk installation and activation actions.
2756
		 *
2757
		 * The bulk installation process looks for the $_POST information and passes that
2758
		 * through if a user has to use WP_Filesystem to enter their credentials.
2759
		 *
2760
		 * @since 2.2.0
2761
		 */
2762
		public function process_bulk_actions() {
2763
			// Bulk installation process.
2764
			if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
2765
2766
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2767
2768
				$install_type = 'install';
2769
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2770
					$install_type = 'update';
2771
				}
2772
2773
				$plugins_to_install = array();
2774
2775
				// Did user actually select any plugins to install/update ?
2776 View Code Duplication
				if ( empty( $_POST['plugin'] ) ) {
2777
					if ( 'install' === $install_type ) {
2778
						$message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
2779
					} else {
2780
						$message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
2781
					}
2782
2783
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2784
2785
					return false;
2786
				}
2787
2788
				if ( is_array( $_POST['plugin'] ) ) {
2789
					$plugins_to_install = (array) $_POST['plugin'];
2790
				} elseif ( is_string( $_POST['plugin'] ) ) {
2791
					// Received via Filesystem page - un-flatten array (WP bug #19643).
2792
					$plugins_to_install = explode( ',', $_POST['plugin'] );
2793
				}
2794
2795
				// Sanitize the received input.
2796
				$plugins_to_install = array_map( 'urldecode', $plugins_to_install );
2797
				$plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
2798
2799
				// Validate the received input.
2800
				foreach ( $plugins_to_install as $key => $slug ) {
2801
					// Check if the plugin was registered with TGMPA and remove if not.
2802
					if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
2803
						unset( $plugins_to_install[ $key ] );
2804
						continue;
2805
					}
2806
2807
					// For install: make sure this is a plugin we *can* install and not one already installed.
2808
					if ( 'install' === $install_type && true === $this->tgmpa->is_plugin_installed( $slug ) ) {
2809
						unset( $plugins_to_install[ $key ] );
2810
					}
2811
2812
					// For updates: make sure this is a plugin we *can* update (update available and WP version ok).
2813
					if ( 'update' === $install_type && false === $this->tgmpa->is_plugin_updatetable( $slug ) ) {
2814
						unset( $plugins_to_install[ $key ] );
2815
					}
2816
				}
2817
2818
				// No need to proceed further if we have no plugins to handle.
2819 View Code Duplication
				if ( empty( $plugins_to_install ) ) {
2820
					if ( 'install' === $install_type ) {
2821
						$message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
2822
					} else {
2823
						$message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
2824
					}
2825
2826
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2827
2828
					return false;
2829
				}
2830
2831
				// Pass all necessary information if WP_Filesystem is needed.
2832
				$url = wp_nonce_url(
2833
					$this->tgmpa->get_tgmpa_url(),
2834
					'bulk-' . $this->_args['plural']
2835
				);
2836
2837
				// Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
2838
				$_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
2839
2840
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
2841
				$fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
2842
2843 View Code Duplication
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields ) ) ) {
2844
					return true; // Stop the normal page form from displaying, credential request form will be shown.
2845
				}
2846
2847
				// Now we have some credentials, setup WP_Filesystem.
2848 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...
2849
					// Our credentials were no good, ask the user for them again.
2850
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
2851
2852
					return true;
2853
				}
2854
2855
				/* If we arrive here, we have the filesystem */
2856
2857
				// Store all information in arrays since we are processing a bulk installation.
2858
				$names      = array();
2859
				$sources    = array(); // Needed for installs.
2860
				$file_paths = array(); // Needed for upgrades.
2861
				$to_inject  = array(); // Information to inject into the update_plugins transient.
2862
2863
				// Prepare the data for validated plugins for the install/upgrade.
2864
				foreach ( $plugins_to_install as $slug ) {
2865
					$name   = $this->tgmpa->plugins[ $slug ]['name'];
2866
					$source = $this->tgmpa->get_download_url( $slug );
2867
2868
					if ( ! empty( $name ) && ! empty( $source ) ) {
2869
						$names[] = $name;
2870
2871
						switch ( $install_type ) {
2872
2873
							case 'install':
2874
								$sources[] = $source;
2875
								break;
2876
2877
							case 'update':
2878
								$file_paths[]                 = $this->tgmpa->plugins[ $slug ]['file_path'];
2879
								$to_inject[ $slug ]           = $this->tgmpa->plugins[ $slug ];
2880
								$to_inject[ $slug ]['source'] = $source;
2881
								break;
2882
						}
2883
					}
2884
				}
2885
				unset( $slug, $name, $source );
2886
2887
				// Create a new instance of TGMPA_Bulk_Installer.
2888
				$installer = new TGMPA_Bulk_Installer(
2889
					new TGMPA_Bulk_Installer_Skin(
2890
						array(
2891
							'url'          => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
2892
							'nonce'        => 'bulk-' . $this->_args['plural'],
2893
							'names'        => $names,
2894
							'install_type' => $install_type,
2895
						)
2896
					)
2897
				);
2898
2899
				// Wrap the install process with the appropriate HTML.
2900
				echo '<div class="tgmpa">',
2901
					'<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>
2902
					<div class="update-php" style="width: 100%; height: 98%; min-height: 850px; padding-top: 1px;">';
2903
2904
				// Process the bulk installation submissions.
2905
				add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
2906
2907
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2908
					// Inject our info into the update transient.
2909
					$this->tgmpa->inject_update_info( $to_inject );
2910
2911
					$installer->bulk_upgrade( $file_paths );
2912
				} else {
2913
					$installer->bulk_install( $sources );
2914
				}
2915
2916
				remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
2917
2918
				echo '</div></div>';
2919
2920
				return true;
2921
			}
2922
2923
			// Bulk activation process.
2924
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
2925
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2926
2927
				// Did user actually select any plugins to activate ?
2928
				if ( empty( $_POST['plugin'] ) ) {
2929
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
2930
2931
					return false;
2932
				}
2933
2934
				// Grab plugin data from $_POST.
2935
				$plugins = array();
2936
				if ( isset( $_POST['plugin'] ) ) {
2937
					$plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
2938
					$plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
2939
				}
2940
2941
				$plugins_to_activate = array();
2942
				$plugin_names        = array();
2943
2944
				// Grab the file paths for the selected & inactive plugins from the registration array.
2945
				foreach ( $plugins as $slug ) {
2946
					if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2947
						$plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
2948
						$plugin_names[]        = $this->tgmpa->plugins[ $slug ]['name'];
2949
					}
2950
				}
2951
				unset( $slug );
2952
2953
				// Return early if there are no plugins to activate.
2954
				if ( empty( $plugins_to_activate ) ) {
2955
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
2956
2957
					return false;
2958
				}
2959
2960
				// Now we are good to go - let's start activating plugins.
2961
				$activate = activate_plugins( $plugins_to_activate );
2962
2963
				if ( is_wp_error( $activate ) ) {
2964
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
2965
				} else {
2966
					$count        = count( $plugin_names ); // Count so we can use _n function.
2967
					$plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
2968
					$last_plugin  = array_pop( $plugin_names ); // Pop off last name to prep for readability.
2969
					$imploded     = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
2970
2971
					printf( // WPCS: xss ok.
2972
						'<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
2973
						esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
2974
						$imploded
2975
					);
2976
2977
					// Update recently activated plugins option.
2978
					$recent = (array) get_option( 'recently_activated' );
2979
					foreach ( $plugins_to_activate as $plugin => $time ) {
2980
						if ( isset( $recent[ $plugin ] ) ) {
2981
							unset( $recent[ $plugin ] );
2982
						}
2983
					}
2984
					update_option( 'recently_activated', $recent );
2985
				}
2986
2987
				unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
2988
2989
				return true;
2990
			}
2991
2992
			return false;
2993
		}
2994
2995
		/**
2996
		 * Prepares all of our information to be outputted into a usable table.
2997
		 *
2998
		 * @since 2.2.0
2999
		 */
3000
		public function prepare_items() {
3001
			$columns               = $this->get_columns(); // Get all necessary column information.
3002
			$hidden                = array(); // No columns to hide, but we must set as an array.
3003
			$sortable              = array(); // No reason to make sortable columns.
3004
			$primary               = $this->get_primary_column_name(); // Column which has the row actions.
3005
			$this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
3006
3007
			// Process our bulk activations here.
3008
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3009
				$this->process_bulk_actions();
3010
			}
3011
3012
			// Store all of our plugin data into $items array so WP_List_Table can use it.
3013
			$this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
3014
		}
3015
3016
		/* *********** DEPRECATED METHODS *********** */
3017
3018
		/**
3019
		 * Retrieve plugin data, given the plugin name.
3020
		 *
3021
		 * @since      2.2.0
3022
		 * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
3023
		 * @see        TGM_Plugin_Activation::_get_plugin_data_from_name()
3024
		 *
3025
		 * @param string $name Name of the plugin, as it was registered.
3026
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
3027
		 * @return string|boolean Plugin slug if found, false otherwise.
3028
		 */
3029
		protected function _get_plugin_data_from_name( $name, $data = 'slug' ) {
3030
			_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
3031
3032
			return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
3033
		}
3034
	}
3035
}
3036
3037
3038
if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
3039
3040
	/**
3041
	 * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
3042
	 */
3043
	class TGM_Bulk_Installer {
3044
	}
3045
}
3046
if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
3047
3048
	/**
3049
	 * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
3050
	 */
3051
	class TGM_Bulk_Installer_Skin {
3052
	}
3053
}
3054
3055
/**
3056
 * The WP_Upgrader file isn't always available. If it isn't available,
3057
 * we load it here.
3058
 *
3059
 * We check to make sure no action or activation keys are set so that WordPress
3060
 * does not try to re-include the class when processing upgrades or installs outside
3061
 * of the class.
3062
 *
3063
 * @since 2.2.0
3064
 */
3065
add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
3066
if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
3067
	/**
3068
	 * Load bulk installer
3069
	 */
3070
	function tgmpa_load_bulk_installer() {
3071
		// Silently fail if 2.5+ is loaded *after* an older version.
3072
		if ( ! isset( $GLOBALS['tgmpa'] ) ) {
3073
			return;
3074
		}
3075
3076
		// Get TGMPA class instance.
3077
		$tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3078
3079
		if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
3080
			if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
3081
				require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
3082
			}
3083
3084
			if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
3085
3086
				/**
3087
				 * Installer class to handle bulk plugin installations.
3088
				 *
3089
				 * Extends WP_Upgrader and customizes to suit the installation of multiple
3090
				 * plugins.
3091
				 *
3092
				 * @since 2.2.0
3093
				 *
3094
				 * {@internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader.}}
3095
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
3096
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3097
				 *
3098
				 * @package TGM-Plugin-Activation
3099
				 * @author  Thomas Griffin
3100
				 * @author  Gary Jones
3101
				 */
3102
				class TGMPA_Bulk_Installer extends Plugin_Upgrader {
3103
					/**
3104
					 * Holds result of bulk plugin installation.
3105
					 *
3106
					 * @since 2.2.0
3107
					 *
3108
					 * @var string
3109
					 */
3110
					public $result;
3111
3112
					/**
3113
					 * Flag to check if bulk installation is occurring or not.
3114
					 *
3115
					 * @since 2.2.0
3116
					 *
3117
					 * @var boolean
3118
					 */
3119
					public $bulk = false;
3120
3121
					/**
3122
					 * TGMPA instance
3123
					 *
3124
					 * @since 2.5.0
3125
					 *
3126
					 * @var object
3127
					 */
3128
					protected $tgmpa;
3129
3130
					/**
3131
					 * Whether or not the destination directory needs to be cleared ( = on update).
3132
					 *
3133
					 * @since 2.5.0
3134
					 *
3135
					 * @var bool
3136
					 */
3137
					protected $clear_destination = false;
3138
3139
					/**
3140
					 * References parent constructor and sets defaults for class.
3141
					 *
3142
					 * @since 2.2.0
3143
					 *
3144
					 * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
3145
					 */
3146
					public function __construct( $skin = null ) {
3147
						// Get TGMPA class instance.
3148
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3149
3150
						parent::__construct( $skin );
3151
3152
						if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
3153
							$this->clear_destination = true;
3154
						}
3155
3156
						if ( $this->tgmpa->is_automatic ) {
3157
							$this->activate_strings();
3158
						}
3159
3160
						add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
3161
					}
3162
3163
					/**
3164
					 * Sets the correct activation strings for the installer skin to use.
3165
					 *
3166
					 * @since 2.2.0
3167
					 */
3168
					public function activate_strings() {
3169
						$this->strings['activation_failed']  = __( 'Plugin activation failed.', 'tgmpa' );
3170
						$this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
3171
					}
3172
3173
					/**
3174
					 * Performs the actual installation of each plugin.
3175
					 *
3176
					 * @since 2.2.0
3177
					 *
3178
					 * @see WP_Upgrader::run()
3179
					 *
3180
					 * @param array $options The installation config options.
3181
					 * @return null|array Return early if error, array of installation data on success.
3182
					 */
3183
					public function run( $options ) {
3184
						$result = parent::run( $options );
3185
3186
						// Reset the strings in case we changed one during automatic activation.
3187
						if ( $this->tgmpa->is_automatic ) {
3188
							if ( 'update' === $this->skin->options['install_type'] ) {
3189
								$this->upgrade_strings();
3190
							} else {
3191
								$this->install_strings();
3192
							}
3193
						}
3194
3195
						return $result;
3196
					}
3197
3198
					/**
3199
					 * Processes the bulk installation of plugins.
3200
					 *
3201
					 * @since 2.2.0
3202
					 *
3203
					 * {@internal This is basically a near identical copy of the WP Core
3204
					 * Plugin_Upgrader::bulk_upgrade() method, with minor adjustments to deal with
3205
					 * new installs instead of upgrades.
3206
					 * For ease of future synchronizations, the adjustments are clearly commented, but no other
3207
					 * comments are added. Code style has been made to comply.}}
3208
					 *
3209
					 * @see Plugin_Upgrader::bulk_upgrade()
3210
					 * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
3211
					 * (@internal Last synced: Dec 31st 2015 against https://core.trac.wordpress.org/browser/trunk?rev=36134}}
3212
					 *
3213
					 * @param array $plugins The plugin sources needed for installation.
3214
					 * @param array $args    Arbitrary passed extra arguments.
3215
					 * @return string|bool Install confirmation messages on success, false on failure.
3216
					 */
3217
					public function bulk_install( $plugins, $args = array() ) {
3218
						// [TGMPA + ] Hook auto-activation in.
3219
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3220
3221
						$defaults    = array(
3222
							'clear_update_cache' => true,
3223
						);
3224
						$parsed_args = wp_parse_args( $args, $defaults );
3225
3226
						$this->init();
3227
						$this->bulk = true;
3228
3229
						$this->install_strings(); // [TGMPA + ] adjusted.
3230
3231
						/* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
3232
3233
						/* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
3234
3235
						$this->skin->header();
3236
3237
						// Connect to the Filesystem first.
3238
						$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
3239
						if ( ! $res ) {
3240
							$this->skin->footer();
3241
							return false;
3242
						}
3243
3244
						$this->skin->bulk_header();
3245
3246
						/*
3247
						 * Only start maintenance mode if:
3248
						 * - running Multisite and there are one or more plugins specified, OR
3249
						 * - a plugin with an update available is currently active.
3250
						 * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
3251
						 */
3252
						$maintenance = ( is_multisite() && ! empty( $plugins ) );
3253
3254
						/*
3255
						[TGMPA - ]
3256
						foreach ( $plugins as $plugin )
3257
							$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
3258
						*/
3259
						if ( $maintenance ) {
3260
							$this->maintenance_mode( true );
3261
						}
3262
3263
						$results = array();
3264
3265
						$this->update_count   = count( $plugins );
3266
						$this->update_current = 0;
3267
						foreach ( $plugins as $plugin ) {
3268
							$this->update_current++;
3269
3270
							/*
3271
							[TGMPA - ]
3272
							$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
3273
3274
							if ( !isset( $current->response[ $plugin ] ) ) {
3275
								$this->skin->set_result('up_to_date');
3276
								$this->skin->before();
3277
								$this->skin->feedback('up_to_date');
3278
								$this->skin->after();
3279
								$results[$plugin] = true;
3280
								continue;
3281
							}
3282
3283
							// Get the URL to the zip file.
3284
							$r = $current->response[ $plugin ];
3285
3286
							$this->skin->plugin_active = is_plugin_active($plugin);
3287
							*/
3288
3289
							$result = $this->run(
3290
								array(
3291
									'package'           => $plugin, // [TGMPA + ] adjusted.
3292
									'destination'       => WP_PLUGIN_DIR,
3293
									'clear_destination' => false, // [TGMPA + ] adjusted.
3294
									'clear_working'     => true,
3295
									'is_multi'          => true,
3296
									'hook_extra'        => array(
3297
										'plugin' => $plugin,
3298
									),
3299
								)
3300
							);
3301
3302
							$results[ $plugin ] = $this->result;
3303
3304
							// Prevent credentials auth screen from displaying multiple times.
3305
							if ( false === $result ) {
3306
								break;
3307
							}
3308
						} //end foreach $plugins
3309
3310
						$this->maintenance_mode( false );
3311
3312
						/**
3313
						 * Fires when the bulk upgrader process is complete.
3314
						 *
3315
						 * @since WP 3.6.0 / TGMPA 2.5.0
3316
						 *
3317
						 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
3318
						 *                              be a Theme_Upgrader or Core_Upgrade instance.
3319
						 * @param array           $data {
3320
						 *     Array of bulk item update data.
3321
						 *
3322
						 *     @type string $action   Type of action. Default 'update'.
3323
						 *     @type string $type     Type of update process. Accepts 'plugin', 'theme', or 'core'.
3324
						 *     @type bool   $bulk     Whether the update process is a bulk update. Default true.
3325
						 *     @type array  $packages Array of plugin, theme, or core packages to update.
3326
						 * }
3327
						 */
3328
						do_action( 'upgrader_process_complete', $this, array(
3329
							'action'  => 'install', // [TGMPA + ] adjusted.
3330
							'type'    => 'plugin',
3331
							'bulk'    => true,
3332
							'plugins' => $plugins,
3333
						) );
3334
3335
						$this->skin->bulk_footer();
3336
3337
						$this->skin->footer();
3338
3339
						// Cleanup our hooks, in case something else does a upgrade on this connection.
3340
						/* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
3341
3342
						// [TGMPA + ] Remove our auto-activation hook.
3343
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3344
3345
						// Force refresh of plugin update information.
3346
						wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
3347
3348
						return $results;
3349
					}
3350
3351
					/**
3352
					 * Handle a bulk upgrade request.
3353
					 *
3354
					 * @since 2.5.0
3355
					 *
3356
					 * @see Plugin_Upgrader::bulk_upgrade()
3357
					 *
3358
					 * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
3359
					 * @param array $args    Arbitrary passed extra arguments.
3360
					 * @return string|bool Install confirmation messages on success, false on failure.
3361
					 */
3362
					public function bulk_upgrade( $plugins, $args = array() ) {
3363
3364
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3365
3366
						$result = parent::bulk_upgrade( $plugins, $args );
3367
3368
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3369
3370
						return $result;
3371
					}
3372
3373
					/**
3374
					 * Abuse a filter to auto-activate plugins after installation.
3375
					 *
3376
					 * Hooked into the 'upgrader_post_install' filter hook.
3377
					 *
3378
					 * @since 2.5.0
3379
					 *
3380
					 * @param bool $bool The value we need to give back (true).
3381
					 * @return bool
3382
					 */
3383
					public function auto_activate( $bool ) {
3384
						// Only process the activation of installed plugins if the automatic flag is set to true.
3385
						if ( $this->tgmpa->is_automatic ) {
3386
							// Flush plugins cache so the headers of the newly installed plugins will be read correctly.
3387
							wp_clean_plugins_cache();
3388
3389
							// Get the installed plugin file.
3390
							$plugin_info = $this->plugin_info();
3391
3392
							// Don't try to activate on upgrade of active plugin as WP will do this already.
3393
							if ( ! is_plugin_active( $plugin_info ) ) {
3394
								$activate = activate_plugin( $plugin_info );
3395
3396
								// Adjust the success string based on the activation result.
3397
								$this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
3398
3399
								if ( is_wp_error( $activate ) ) {
3400
									$this->skin->error( $activate );
3401
									$this->strings['process_success'] .= $this->strings['activation_failed'];
3402
								} else {
3403
									$this->strings['process_success'] .= $this->strings['activation_success'];
3404
								}
3405
							}
3406
						}
3407
3408
						return $bool;
3409
					}
3410
				}
3411
			}
3412
3413
			if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
3414
3415
				/**
3416
				 * Installer skin to set strings for the bulk plugin installations..
3417
				 *
3418
				 * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
3419
				 * plugins.
3420
				 *
3421
				 * @since 2.2.0
3422
				 *
3423
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
3424
				 *           TGMPA_Bulk_Installer_Skin.
3425
				 *           This was done to prevent backward compatibility issues with v2.3.6.}}
3426
				 *
3427
				 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
3428
				 *
3429
				 * @package TGM-Plugin-Activation
3430
				 * @author  Thomas Griffin
3431
				 * @author  Gary Jones
3432
				 */
3433
				class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
3434
					/**
3435
					 * Holds plugin info for each individual plugin installation.
3436
					 *
3437
					 * @since 2.2.0
3438
					 *
3439
					 * @var array
3440
					 */
3441
					public $plugin_info = array();
3442
3443
					/**
3444
					 * Holds names of plugins that are undergoing bulk installations.
3445
					 *
3446
					 * @since 2.2.0
3447
					 *
3448
					 * @var array
3449
					 */
3450
					public $plugin_names = array();
3451
3452
					/**
3453
					 * Integer to use for iteration through each plugin installation.
3454
					 *
3455
					 * @since 2.2.0
3456
					 *
3457
					 * @var integer
3458
					 */
3459
					public $i = 0;
3460
3461
					/**
3462
					 * TGMPA instance
3463
					 *
3464
					 * @since 2.5.0
3465
					 *
3466
					 * @var object
3467
					 */
3468
					protected $tgmpa;
3469
3470
					/**
3471
					 * Constructor. Parses default args with new ones and extracts them for use.
3472
					 *
3473
					 * @since 2.2.0
3474
					 *
3475
					 * @param array $args Arguments to pass for use within the class.
3476
					 */
3477
					public function __construct( $args = array() ) {
3478
						// Get TGMPA class instance.
3479
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3480
3481
						// Parse default and new args.
3482
						$defaults = array(
3483
							'url'          => '',
3484
							'nonce'        => '',
3485
							'names'        => array(),
3486
							'install_type' => 'install',
3487
						);
3488
						$args     = wp_parse_args( $args, $defaults );
3489
3490
						// Set plugin names to $this->plugin_names property.
3491
						$this->plugin_names = $args['names'];
3492
3493
						// Extract the new args.
3494
						parent::__construct( $args );
3495
					}
3496
3497
					/**
3498
					 * Sets install skin strings for each individual plugin.
3499
					 *
3500
					 * Checks to see if the automatic activation flag is set and uses the
3501
					 * the proper strings accordingly.
3502
					 *
3503
					 * @since 2.2.0
3504
					 */
3505
					public function add_strings() {
3506
						if ( 'update' === $this->options['install_type'] ) {
3507
							parent::add_strings();
3508
							$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3509
						} else {
3510
							$this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
3511
							$this->upgrader->strings['skin_update_failed']       = __( 'The installation of %1$s failed.', 'tgmpa' );
3512
3513
							if ( $this->tgmpa->is_automatic ) {
3514
								// Automatic activation strings.
3515
								$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' );
3516
								$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>';
3517
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations and activations have been completed.', 'tgmpa' );
3518
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3519
							} else {
3520
								// Default installation strings.
3521
								$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' );
3522
								$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>';
3523
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations have been completed.', 'tgmpa' );
3524
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3525
							}
3526
						}
3527
					}
3528
3529
					/**
3530
					 * Outputs the header strings and necessary JS before each plugin installation.
3531
					 *
3532
					 * @since 2.2.0
3533
					 *
3534
					 * @param string $title Unused in this implementation.
3535
					 */
3536
					public function before( $title = '' ) {
3537
						if ( empty( $title ) ) {
3538
							$title = esc_html( $this->plugin_names[ $this->i ] );
3539
						}
3540
						parent::before( $title );
3541
					}
3542
3543
					/**
3544
					 * Outputs the footer strings and necessary JS after each plugin installation.
3545
					 *
3546
					 * Checks for any errors and outputs them if they exist, else output
3547
					 * success strings.
3548
					 *
3549
					 * @since 2.2.0
3550
					 *
3551
					 * @param string $title Unused in this implementation.
3552
					 */
3553
					public function after( $title = '' ) {
3554
						if ( empty( $title ) ) {
3555
							$title = esc_html( $this->plugin_names[ $this->i ] );
3556
						}
3557
						parent::after( $title );
3558
3559
						$this->i++;
3560
					}
3561
3562
					/**
3563
					 * Outputs links after bulk plugin installation is complete.
3564
					 *
3565
					 * @since 2.2.0
3566
					 */
3567
					public function bulk_footer() {
3568
						// Serve up the string to say installations (and possibly activations) are complete.
3569
						parent::bulk_footer();
3570
3571
						// Flush plugins cache so we can make sure that the installed plugins list is always up to date.
3572
						wp_clean_plugins_cache();
3573
3574
						$this->tgmpa->show_tgmpa_version();
3575
3576
						// Display message based on if all plugins are now active or not.
3577
						$update_actions = array();
3578
3579
						if ( $this->tgmpa->is_tgmpa_complete() ) {
3580
							// All plugins are active, so we display the complete string and hide the menu to protect users.
3581
							echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
3582
							$update_actions['dashboard'] = sprintf(
3583
								esc_html( $this->tgmpa->strings['complete'] ),
3584
								'<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>'
3585
							);
3586
						} else {
3587
							$update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
3588
						}
3589
3590
						/**
3591
						 * Filter the list of action links available following bulk plugin installs/updates.
3592
						 *
3593
						 * @since 2.5.0
3594
						 *
3595
						 * @param array $update_actions Array of plugin action links.
3596
						 * @param array $plugin_info    Array of information for the last-handled plugin.
3597
						 */
3598
						$update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
3599
3600
						if ( ! empty( $update_actions ) ) {
3601
							$this->feedback( implode( ' | ', (array) $update_actions ) );
3602
						}
3603
					}
3604
3605
					/* *********** DEPRECATED METHODS *********** */
3606
3607
					/**
3608
					 * Flush header output buffer.
3609
					 *
3610
					 * @since      2.2.0
3611
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3612
					 * @see        Bulk_Upgrader_Skin::flush_output()
3613
					 */
3614
					public function before_flush_output() {
3615
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3616
						$this->flush_output();
3617
					}
3618
3619
					/**
3620
					 * Flush footer output buffer and iterate $this->i to make sure the
3621
					 * installation strings reference the correct plugin.
3622
					 *
3623
					 * @since      2.2.0
3624
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3625
					 * @see        Bulk_Upgrader_Skin::flush_output()
3626
					 */
3627
					public function after_flush_output() {
3628
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3629
						$this->flush_output();
3630
						$this->i++;
3631
					}
3632
				}
3633
			}
3634
		}
3635
	}
3636
}
3637
3638
if ( ! class_exists( 'TGMPA_Utils' ) ) {
3639
3640
	/**
3641
	 * Generic utilities for TGMPA.
3642
	 *
3643
	 * All methods are static, poor-dev name-spacing class wrapper.
3644
	 *
3645
	 * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
3646
	 *
3647
	 * @since 2.5.0
3648
	 *
3649
	 * @package TGM-Plugin-Activation
3650
	 * @author  Juliette Reinders Folmer
3651
	 */
3652
	class TGMPA_Utils {
3653
		/**
3654
		 * Whether the PHP filter extension is enabled.
3655
		 *
3656
		 * @see http://php.net/book.filter
3657
		 *
3658
		 * @since 2.5.0
3659
		 *
3660
		 * @static
3661
		 *
3662
		 * @var bool $has_filters True is the extension is enabled.
3663
		 */
3664
		public static $has_filters;
3665
3666
		/**
3667
		 * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
3668
		 *
3669
		 * @since 2.5.0
3670
		 *
3671
		 * @static
3672
		 *
3673
		 * @param string $string Text to be wrapped.
3674
		 * @return string
3675
		 */
3676
		public static function wrap_in_em( $string ) {
3677
			return '<em>' . wp_kses_post( $string ) . '</em>';
3678
		}
3679
3680
		/**
3681
		 * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
3682
		 *
3683
		 * @since 2.5.0
3684
		 *
3685
		 * @static
3686
		 *
3687
		 * @param string $string Text to be wrapped.
3688
		 * @return string
3689
		 */
3690
		public static function wrap_in_strong( $string ) {
3691
			return '<strong>' . wp_kses_post( $string ) . '</strong>';
3692
		}
3693
3694
		/**
3695
		 * Helper function: Validate a value as boolean
3696
		 *
3697
		 * @since 2.5.0
3698
		 *
3699
		 * @static
3700
		 *
3701
		 * @param mixed $value Arbitrary value.
3702
		 * @return bool
3703
		 */
3704
		public static function validate_bool( $value ) {
3705
			if ( ! isset( self::$has_filters ) ) {
3706
				self::$has_filters = extension_loaded( 'filter' );
3707
			}
3708
3709
			if ( self::$has_filters ) {
3710
				return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
3711
			} else {
3712
				return self::emulate_filter_bool( $value );
3713
			}
3714
		}
3715
3716
		/**
3717
		 * Helper function: Cast a value to bool
3718
		 *
3719
		 * @since 2.5.0
3720
		 *
3721
		 * @static
3722
		 *
3723
		 * @param mixed $value Value to cast.
3724
		 * @return bool
3725
		 */
3726
		protected static function emulate_filter_bool( $value ) {
3727
			// @codingStandardsIgnoreStart
3728
			static $true  = array(
3729
				'1',
3730
				'true', 'True', 'TRUE',
3731
				'y', 'Y',
3732
				'yes', 'Yes', 'YES',
3733
				'on', 'On', 'ON',
3734
			);
3735
			static $false = array(
3736
				'0',
3737
				'false', 'False', 'FALSE',
3738
				'n', 'N',
3739
				'no', 'No', 'NO',
3740
				'off', 'Off', 'OFF',
3741
			);
3742
			// @codingStandardsIgnoreEnd
3743
3744
			if ( is_bool( $value ) ) {
3745
				return $value;
3746
			} else if ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
3747
				return (bool) $value;
3748
			} else if ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
3749
				return (bool) $value;
3750
			} else if ( is_string( $value ) ) {
3751
				$value = trim( $value );
3752
				if ( in_array( $value, $true, true ) ) {
3753
					return true;
3754
				} else if ( in_array( $value, $false, true ) ) {
3755
					return false;
3756
				} else {
3757
					return false;
3758
				}
3759
			}
3760
3761
			return false;
3762
		}
3763
	} // End of class TGMPA_Utils
3764
} // End of class_exists wrapper
3765