Completed
Pull Request — develop (#569)
by
unknown
02:20
created

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

Upgrade to new PHP Analysis Engine

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

1
<?php
2
/**
3
 * Plugin installation and activation for WordPress themes.
4
 *
5
 * Please note that this is a drop-in library for a theme or plugin.
6
 * The authors of this library (Thomas, Gary and Juliette) are NOT responsible
7
 * for the support of your plugin or theme. Please contact the plugin
8
 * or theme author for support.
9
 *
10
 * @package   TGM-Plugin-Activation
11
 * @version   2.5.2
12
 * @link      http://tgmpluginactivation.com/
13
 * @author    Thomas Griffin, Gary Jones, Juliette Reinders Folmer
14
 * @copyright Copyright (c) 2011, Thomas Griffin
15
 * @license   GPL-2.0+
16
 */
17
18
/*
19
	Copyright 2011 Thomas Griffin (thomasgriffinmedia.com)
20
21
	This program is free software; you can redistribute it and/or modify
22
	it under the terms of the GNU General Public License, version 2, as
23
	published by the Free Software Foundation.
24
25
	This program is distributed in the hope that it will be useful,
26
	but WITHOUT ANY WARRANTY; without even the implied warranty of
27
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28
	GNU General Public License for more details.
29
30
	You should have received a copy of the GNU General Public License
31
	along with this program; if not, write to the Free Software
32
	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
33
*/
34
35
if ( ! class_exists( 'TGM_Plugin_Activation' ) ) {
36
37
	/**
38
	 * Automatic plugin installation and activation library.
39
	 *
40
	 * Creates a way to automatically install and activate plugins from within themes.
41
	 * The plugins can be either bundled, downloaded from the WordPress
42
	 * Plugin Repository or downloaded from another external source.
43
	 *
44
	 * @since 1.0.0
45
	 *
46
	 * @package TGM-Plugin-Activation
47
	 * @author  Thomas Griffin
48
	 * @author  Gary Jones
49
	 */
50
	class TGM_Plugin_Activation {
51
		/**
52
		 * TGMPA version number.
53
		 *
54
		 * @since 2.5.0
55
		 *
56
		 * @const string Version number.
57
		 */
58
		const TGMPA_VERSION = '2.5.2';
59
60
		/**
61
		 * Regular expression to test if a URL is a WP plugin repo URL.
62
		 *
63
		 * @const string Regex.
64
		 *
65
		 * @since 2.5.0
66
		 */
67
		const WP_REPO_REGEX = '|^http[s]?://wordpress\.org/(?:extend/)?plugins/|';
68
69
		/**
70
		 * Arbitrary regular expression to test if a string starts with a URL.
71
		 *
72
		 * @const string Regex.
73
		 *
74
		 * @since 2.5.0
75
		 */
76
		const IS_URL_REGEX = '|^http[s]?://|';
77
78
		/**
79
		 * Holds a copy of itself, so it can be referenced by the class name.
80
		 *
81
		 * @since 1.0.0
82
		 *
83
		 * @var TGM_Plugin_Activation
84
		 */
85
		public static $instance;
86
87
		/**
88
		 * Holds arrays of plugin details.
89
		 *
90
		 * @since 1.0.0
91
		 *
92
		 * @since 2.5.0 the array has the plugin slug as an associative key.
93
		 *
94
		 * @var array
95
		 */
96
		public $plugins = array();
97
98
		/**
99
		 * Holds arrays of plugin names to use to sort the plugins array.
100
		 *
101
		 * @since 2.5.0
102
		 *
103
		 * @var array
104
		 */
105
		protected $sort_order = array();
106
107
		/**
108
		 * Whether any plugins have the 'force_activation' setting set to true.
109
		 *
110
		 * @since 2.5.0
111
		 *
112
		 * @var bool
113
		 */
114
		protected $has_forced_activation = false;
115
116
		/**
117
		 * Whether any plugins have the 'force_deactivation' setting set to true.
118
		 *
119
		 * @since 2.5.0
120
		 *
121
		 * @var bool
122
		 */
123
		protected $has_forced_deactivation = false;
124
125
		/**
126
		 * Name of the unique ID to hash notices.
127
		 *
128
		 * @since 2.4.0
129
		 *
130
		 * @var string
131
		 */
132
		public $id = 'tgmpa';
133
134
		/**
135
		 * Name of the query-string argument for the admin page.
136
		 *
137
		 * @since 1.0.0
138
		 *
139
		 * @var string
140
		 */
141
		protected $menu = 'tgmpa-install-plugins';
142
143
		/**
144
		 * Parent menu file slug.
145
		 *
146
		 * @since 2.5.0
147
		 *
148
		 * @var string
149
		 */
150
		public $parent_slug = 'themes.php';
151
152
		/**
153
		 * Capability needed to view the plugin installation menu item.
154
		 *
155
		 * @since 2.5.0
156
		 *
157
		 * @var string
158
		 */
159
		public $capability = 'edit_theme_options';
160
161
		/**
162
		 * Default absolute path to folder containing bundled plugin zip files.
163
		 *
164
		 * @since 2.0.0
165
		 *
166
		 * @var string Absolute path prefix to zip file location for bundled plugins. Default is empty string.
167
		 */
168
		public $default_path = '';
169
170
		/**
171
		 * Flag to show admin notices or not.
172
		 *
173
		 * @since 2.1.0
174
		 *
175
		 * @var boolean
176
		 */
177
		public $has_notices = true;
178
179
		/**
180
		 * Flag to determine if the user can dismiss the notice nag.
181
		 *
182
		 * @since 2.4.0
183
		 *
184
		 * @var boolean
185
		 */
186
		public $dismissable = true;
187
188
		/**
189
		 * Message to be output above nag notice if dismissable is false.
190
		 *
191
		 * @since 2.4.0
192
		 *
193
		 * @var string
194
		 */
195
		public $dismiss_msg = '';
196
197
		/**
198
		 * Flag to set automatic activation of plugins. Off by default.
199
		 *
200
		 * @since 2.2.0
201
		 *
202
		 * @var boolean
203
		 */
204
		public $is_automatic = false;
205
206
		/**
207
		 * Optional message to display before the plugins table.
208
		 *
209
		 * @since 2.2.0
210
		 *
211
		 * @var string Message filtered by wp_kses_post(). Default is empty string.
212
		 */
213
		public $message = '';
214
215
		/**
216
		 * Holds configurable array of strings.
217
		 *
218
		 * Default values are added in the constructor.
219
		 *
220
		 * @since 2.0.0
221
		 *
222
		 * @var array
223
		 */
224
		public $strings = array();
225
226
		/**
227
		 * Holds the version of WordPress.
228
		 *
229
		 * @since 2.4.0
230
		 *
231
		 * @var int
232
		 */
233
		public $wp_version;
234
235
		/**
236
		 * Holds the hook name for the admin page.
237
		 *
238
		 * @since 2.5.0
239
		 *
240
		 * @var string
241
		 */
242
		public $page_hook;
243
244
		/**
245
		 * Adds a reference of this object to $instance, populates default strings,
246
		 * does the tgmpa_init action hook, and hooks in the interactions to init.
247
		 *
248
		 * {@internal This method should be `protected`, but as too many TGMPA implementations
249
		 * haven't upgraded beyond v2.3.6 yet, this gives backward compatibility issues.
250
		 * Reverted back to public for the time being.}}
251
		 *
252
		 * @since 1.0.0
253
		 *
254
		 * @see TGM_Plugin_Activation::init()
255
		 */
256
		public function __construct() {
257
			// Set the current WordPress version.
258
			$this->wp_version = $GLOBALS['wp_version'];
259
260
			// Announce that the class is ready, and pass the object (for advanced use).
261
			do_action_ref_array( 'tgmpa_init', array( $this ) );
262
263
			/*
264
			 * Load our text domain and allow for overloading the fall-back file.
265
			 *
266
			 * {@internal IMPORTANT! If this code changes, review the regex in the custom TGMPA
267
			 * generator on the website.}}
268
			 */
269
			add_action( 'init', array( $this, 'load_textdomain' ), 5 );
270
			add_filter( 'load_textdomain_mofile', array( $this, 'overload_textdomain_mofile' ), 10, 2 );
271
272
			// When the rest of WP has loaded, kick-start the rest of the class.
273
			add_action( 'init', array( $this, 'init' ) );
274
		}
275
276
		/**
277
		 * Magic method to (not) set protected properties from outside of this class.
278
		 *
279
		 * {@internal hackedihack... There is a serious bug in v2.3.2 - 2.3.6  where the `menu` property
280
		 * is being assigned rather than tested in a conditional, effectively rendering it useless.
281
		 * This 'hack' prevents this from happening.}}
282
		 *
283
		 * @see https://github.com/TGMPA/TGM-Plugin-Activation/blob/2.3.6/tgm-plugin-activation/class-tgm-plugin-activation.php#L1593
284
		 *
285
		 * @param string $name  Name of an inaccessible property.
286
		 * @param mixed  $value Value to assign to the property.
287
		 * @return void  Silently fail to set the property when this is tried from outside of this class context.
288
		 *               (Inside this class context, the __set() method if not used as there is direct access.)
289
		 */
290
		public function __set( $name, $value ) {
291
			return;
292
		}
293
294
		/**
295
		 * Magic method to get the value of a protected property outside of this class context.
296
		 *
297
		 * @param string $name Name of an inaccessible property.
298
		 * @return mixed The property value.
299
		 */
300
		public function __get( $name ) {
301
			return $this->{$name};
302
		}
303
304
		/**
305
		 * Initialise the interactions between this class and WordPress.
306
		 *
307
		 * Hooks in three new methods for the class: admin_menu, notices and styles.
308
		 *
309
		 * @since 2.0.0
310
		 *
311
		 * @see TGM_Plugin_Activation::admin_menu()
312
		 * @see TGM_Plugin_Activation::notices()
313
		 * @see TGM_Plugin_Activation::styles()
314
		 */
315
		public function init() {
316
			/**
317
			 * By default TGMPA only loads on the WP back-end and not in an Ajax call. Using this filter
318
			 * you can overrule that behaviour.
319
			 *
320
			 * @since 2.5.0
321
			 *
322
			 * @param bool $load Whether or not TGMPA should load.
323
			 *                   Defaults to the return of `is_admin() && ! defined( 'DOING_AJAX' )`.
324
			 */
325
			if ( true !== apply_filters( 'tgmpa_load', ( is_admin() && ! defined( 'DOING_AJAX' ) ) ) ) {
326
				return;
327
			}
328
329
			// Load class strings.
330
			$this->strings = array(
331
				'page_title'                      => __( 'Install Required Plugins', 'tgmpa' ),
332
				'menu_title'                      => __( 'Install Plugins', 'tgmpa' ),
333
				/* translators: %s: plugin name. */
334
				'installing'                      => __( 'Installing Plugin: %s', 'tgmpa' ),
335
				/* translators: %s: plugin name. */
336
				'updating'                        => __( 'Updating Plugin: %s', 'tgmpa' ),
337
				'oops'                            => __( 'Something went wrong with the plugin API.', 'tgmpa' ),
338
				'notice_can_install_required'     => _n_noop(
339
					/* translators: 1: plugin name(s). */
340
					'This theme requires the following plugin: %1$s.',
341
					'This theme requires the following plugins: %1$s.',
342
					'tgmpa'
343
				),
344
				'notice_can_install_recommended'  => _n_noop(
345
					/* translators: 1: plugin name(s). */
346
					'This theme recommends the following plugin: %1$s.',
347
					'This theme recommends the following plugins: %1$s.',
348
					'tgmpa'
349
				),
350
				'notice_ask_to_update'            => _n_noop(
351
					/* translators: 1: plugin name(s). */
352
					'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.',
353
					'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.',
354
					'tgmpa'
355
				),
356
				'notice_ask_to_update_maybe'      => _n_noop(
357
					/* translators: 1: plugin name(s). */
358
					'There is an update available for: %1$s.',
359
					'There are updates available for the following plugins: %1$s.',
360
					'tgmpa'
361
				),
362
				'notice_can_activate_required'    => _n_noop(
363
					/* translators: 1: plugin name(s). */
364
					'The following required plugin is currently inactive: %1$s.',
365
					'The following required plugins are currently inactive: %1$s.',
366
					'tgmpa'
367
				),
368
				'notice_can_activate_recommended' => _n_noop(
369
					/* translators: 1: plugin name(s). */
370
					'The following recommended plugin is currently inactive: %1$s.',
371
					'The following recommended plugins are currently inactive: %1$s.',
372
					'tgmpa'
373
				),
374
				'notice_force_activation'         => _n_noop(
375
					'The following plugin has been automatically activated because it is required by the current theme: %s', 'The following plugins have been automatically activated because they are required by the current theme: %s'
376
				),
377
				'install_link'                    => _n_noop(
378
					'Begin installing plugin',
379
					'Begin installing plugins',
380
					'tgmpa'
381
				),
382
				'update_link'                     => _n_noop(
383
					'Begin updating plugin',
384
					'Begin updating plugins',
385
					'tgmpa'
386
				),
387
				'activate_link'                   => _n_noop(
388
					'Begin activating plugin',
389
					'Begin activating plugins',
390
					'tgmpa'
391
				),
392
				'return'                          => __( 'Return to Required Plugins Installer', 'tgmpa' ),
393
				'dashboard'                       => __( 'Return to the Dashboard', 'tgmpa' ),
394
				'plugin_activated'                => __( 'Plugin activated successfully.', 'tgmpa' ),
395
				'activated_successfully'          => __( 'The following plugin was activated successfully:', 'tgmpa' ),
396
				/* translators: 1: plugin name. */
397
				'plugin_already_active'           => __( 'No action taken. Plugin %1$s was already active.', 'tgmpa' ),
398
				/* translators: 1: plugin name. */
399
				'plugin_needs_higher_version'     => __( 'Plugin not activated. A higher version of %s is needed for this theme. Please update the plugin.', 'tgmpa' ),
400
				/* translators: 1: dashboard link. */
401
				'complete'                        => __( 'All plugins installed and activated successfully. %1$s', 'tgmpa' ),
402
				'dismiss'                         => __( 'Dismiss this notice', 'tgmpa' ),
403
				'notice_cannot_install_activate'  => __( 'There are one or more required or recommended plugins to install, update or activate.', 'tgmpa' ),
404
				'contact_admin'                   => __( 'Please contact the administrator of this site for help.', 'tgmpa' ),
405
			);
406
407
			do_action( 'tgmpa_register' );
408
409
			/* After this point, the plugins should be registered and the configuration set. */
410
411
			// Proceed only if we have plugins to handle.
412
			if ( empty( $this->plugins ) || ! is_array( $this->plugins ) ) {
413
				return;
414
			}
415
416
			// Set up the menu and notices if we still have outstanding actions.
417
			if ( true !== $this->is_tgmpa_complete() ) {
418
				// Sort the plugins.
419
				array_multisort( $this->sort_order, SORT_ASC, $this->plugins );
420
421
				add_action( 'admin_menu', array( $this, 'admin_menu' ) );
422
				add_action( 'admin_head', array( $this, 'dismiss' ) );
423
424
				// Prevent the normal links from showing underneath a single install/update page.
425
				add_filter( 'install_plugin_complete_actions', array( $this, 'actions' ) );
426
				add_filter( 'update_plugin_complete_actions', array( $this, 'actions' ) );
427
428
				if ( $this->has_notices ) {
429
					add_action( 'admin_notices', array( $this, 'notices' ) );
430
					add_action( 'admin_init', array( $this, 'admin_init' ), 1 );
431
					add_action( 'admin_enqueue_scripts', array( $this, 'thickbox' ) );
432
				}
433
			}
434
435
			// If needed, filter plugin action links.
436
			add_action( 'load-plugins.php', array( $this, 'add_plugin_action_link_filters' ), 1 );
437
438
			// Make sure things get reset on switch theme.
439
			add_action( 'switch_theme', array( $this, 'flush_plugins_cache' ) );
440
441
			if ( $this->has_notices ) {
442
				add_action( 'switch_theme', array( $this, 'update_dismiss' ) );
443
			}
444
445
			// Setup the force activation hook.
446
			if ( true === $this->has_forced_activation ) {
447
				add_action( 'admin_init', array( $this, 'force_activation' ) );
448
			}
449
450
			// Setup the force deactivation hook.
451
			if ( true === $this->has_forced_deactivation ) {
452
				add_action( 'switch_theme', array( $this, 'force_deactivation' ) );
453
			}
454
455
			// Display forced activation notice, if present
456
			if ( current_user_can( 'manage_options' ) && is_admin() ) {
457
				add_action( 'admin_notices', array( $this, 'display_forced_activation_notice' ) );
458
			}
459
		}
460
461
		/**
462
		 * Load translations.
463
		 *
464
		 * @since 2.x.x
465
		 *
466
		 * (@internal Uses `load_theme_textdomain()` rather than `load_plugin_textdomain()` to
467
		 * get round the different ways of handling the path and deprecated notices being thrown
468
		 * and such. For plugins, the actual file name will be corrected by a filter.}}
469
		 *
470
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
471
		 * generator on the website.}}
472
		 */
473
		public function load_textdomain() {
474
			if ( is_textdomain_loaded( 'tgmpa' ) ) {
475
				return;
476
			}
477
478
			if ( false !== strpos( __FILE__, WP_PLUGIN_DIR ) || false !== strpos( __FILE__, WPMU_PLUGIN_DIR ) ) {
479
				// Plugin, we'll need to adjust the file name.
480
				add_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10, 2 );
481
				load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
482
				remove_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10 );
483
			} else {
484
				load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
485
			}
486
		}
487
488
		/**
489
		 * Correct the .mo file name for (must-use) plugins.
490
		 *
491
		 * Themese use `/path/{locale}.mo` while plugins use `/path/{text-domain}-{locale}.mo`.
492
		 *
493
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
494
		 * generator on the website.}}
495
		 *
496
		 * @since 2.x.x
497
		 *
498
		 * @param string $mofile Full path to the target mofile.
499
		 * @param string $domain The domain for which a language file is being loaded.
500
		 * @return string $mofile
501
		 */
502
		public function correct_plugin_mofile( $mofile, $domain ) {
503
			// Exit early if not our domain (just in case).
504
			if ( 'tgmpa' !== $domain ) {
505
				return $mofile;
506
			}
507
			return preg_replace( '`/([a-z]{2}_[A-Z]{2}.mo)$`', '/tgmpa-$1', $mofile );
508
		}
509
510
		/**
511
		 * Potentially overload the fall-back translation file for the current language.
512
		 *
513
		 * WP, by default since WP 3.7, will load a local translation first and if none
514
		 * can be found, will try and find a translation in the /wp-content/languages/ directory.
515
		 * As this library is theme/plugin agnostic, translation files for TGMPA can exist both
516
		 * in the WP_LANG_DIR /plugins/ subdirectory as well as in the /themes/ subdirectory.
517
		 *
518
		 * This method makes sure both directories are checked.
519
		 *
520
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
521
		 * generator on the website.}}
522
		 *
523
		 * @since 2.x.x
524
		 *
525
		 * @param string $mofile Full path to the target mofile.
526
		 * @param string $domain The domain for which a language file is being loaded.
527
		 * @return string $mofile
528
		 */
529
		public function overload_textdomain_mofile( $mofile, $domain ) {
530
			// Exit early if not our domain, not a WP_LANG_DIR load or if the file exists and is readable.
531
			if ( 'tgmpa' !== $domain || false === strpos( $mofile, WP_LANG_DIR ) || @is_readable( $mofile ) ) {
532
				return $mofile;
533
			}
534
535
			// Current fallback file is not valid, let's try the alternative option.
536
			if ( false !== strpos( $mofile, '/themes/' ) ) {
537
				return str_replace( '/themes/', '/plugins/', $mofile );
538
			} elseif ( false !== strpos( $mofile, '/plugins/' ) ) {
539
				return str_replace( '/plugins/', '/themes/', $mofile );
540
			} else {
541
				return $mofile;
542
			}
543
		}
544
545
		/**
546
		 * Hook in plugin action link filters for the WP native plugins page.
547
		 *
548
		 * - Prevent activation of plugins which don't meet the minimum version requirements.
549
		 * - Prevent deactivation of force-activated plugins.
550
		 * - Add update notice if update available.
551
		 *
552
		 * @since 2.5.0
553
		 */
554
		public function add_plugin_action_link_filters() {
555
			foreach ( $this->plugins as $slug => $plugin ) {
556
				if ( false === $this->can_plugin_activate( $slug ) ) {
557
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_activate' ), 20 );
558
				}
559
560
				if ( true === $plugin['force_activation'] ) {
561
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_deactivate' ), 20 );
562
				}
563
564
				if ( false !== $this->does_plugin_require_update( $slug ) ) {
565
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_update' ), 20 );
566
				}
567
			}
568
		}
569
570
		/**
571
		 * Remove the 'Activate' link on the WP native plugins page if the plugin does not meet the
572
		 * minimum version requirements.
573
		 *
574
		 * @since 2.5.0
575
		 *
576
		 * @param array $actions Action links.
577
		 * @return array
578
		 */
579
		public function filter_plugin_action_links_activate( $actions ) {
580
			unset( $actions['activate'] );
581
582
			return $actions;
583
		}
584
585
		/**
586
		 * Remove the 'Deactivate' link on the WP native plugins page if the plugin has been set to force activate.
587
		 *
588
		 * @since 2.5.0
589
		 *
590
		 * @param array $actions Action links.
591
		 * @return array
592
		 */
593
		public function filter_plugin_action_links_deactivate( $actions ) {
594
			unset( $actions['deactivate'] );
595
596
			return $actions;
597
		}
598
599
		/**
600
		 * Add a 'Requires update' link on the WP native plugins page if the plugin does not meet the
601
		 * minimum version requirements.
602
		 *
603
		 * @since 2.5.0
604
		 *
605
		 * @param array $actions Action links.
606
		 * @return array
607
		 */
608
		public function filter_plugin_action_links_update( $actions ) {
609
			$actions['update'] = sprintf(
610
				'<a href="%1$s" title="%2$s" class="edit">%3$s</a>',
611
				esc_url( $this->get_tgmpa_status_url( 'update' ) ),
612
				esc_attr__( 'This plugin needs to be updated to be compatible with your theme.', 'tgmpa' ),
613
				esc_html__( 'Update Required', 'tgmpa' )
614
			);
615
616
			return $actions;
617
		}
618
619
		/**
620
		 * Handles calls to show plugin information via links in the notices.
621
		 *
622
		 * We get the links in the admin notices to point to the TGMPA page, rather
623
		 * than the typical plugin-install.php file, so we can prepare everything
624
		 * beforehand.
625
		 *
626
		 * WP does not make it easy to show the plugin information in the thickbox -
627
		 * here we have to require a file that includes a function that does the
628
		 * main work of displaying it, enqueue some styles, set up some globals and
629
		 * finally call that function before exiting.
630
		 *
631
		 * Down right easy once you know how...
632
		 *
633
		 * Returns early if not the TGMPA page.
634
		 *
635
		 * @since 2.1.0
636
		 *
637
		 * @global string $tab Used as iframe div class names, helps with styling
638
		 * @global string $body_id Used as the iframe body ID, helps with styling
639
		 *
640
		 * @return null Returns early if not the TGMPA page.
641
		 */
642
		public function admin_init() {
643
			if ( ! $this->is_tgmpa_page() ) {
644
				return;
645
			}
646
647
			if ( isset( $_REQUEST['tab'] ) && 'plugin-information' === $_REQUEST['tab'] ) {
648
				// Needed for install_plugin_information().
649
				require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
650
651
				wp_enqueue_style( 'plugin-install' );
652
653
				global $tab, $body_id;
654
				$body_id = 'plugin-information';
655
				// @codingStandardsIgnoreStart
656
				$tab     = 'plugin-information';
657
				// @codingStandardsIgnoreEnd
658
659
				install_plugin_information();
660
661
				exit;
662
			}
663
		}
664
665
		/**
666
		 * Enqueue thickbox scripts/styles for plugin info.
667
		 *
668
		 * Thickbox is not automatically included on all admin pages, so we must
669
		 * manually enqueue it for those pages.
670
		 *
671
		 * Thickbox is only loaded if the user has not dismissed the admin
672
		 * notice or if there are any plugins left to install and activate.
673
		 *
674
		 * @since 2.1.0
675
		 */
676
		public function thickbox() {
677
			if ( ! get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) ) {
678
				add_thickbox();
679
			}
680
		}
681
682
		/**
683
		 * Adds submenu page if there are plugin actions to take.
684
		 *
685
		 * This method adds the submenu page letting users know that a required
686
		 * plugin needs to be installed.
687
		 *
688
		 * This page disappears once the plugin has been installed and activated.
689
		 *
690
		 * @since 1.0.0
691
		 *
692
		 * @see TGM_Plugin_Activation::init()
693
		 * @see TGM_Plugin_Activation::install_plugins_page()
694
		 *
695
		 * @return null Return early if user lacks capability to install a plugin.
696
		 */
697
		public function admin_menu() {
698
			// Make sure privileges are correct to see the page.
699
			if ( ! current_user_can( 'install_plugins' ) ) {
700
				return;
701
			}
702
703
			$args = apply_filters(
704
				'tgmpa_admin_menu_args',
705
				array(
706
					'parent_slug' => $this->parent_slug,                     // Parent Menu slug.
707
					'page_title'  => $this->strings['page_title'],           // Page title.
708
					'menu_title'  => $this->strings['menu_title'],           // Menu title.
709
					'capability'  => $this->capability,                      // Capability.
710
					'menu_slug'   => $this->menu,                            // Menu slug.
711
					'function'    => array( $this, 'install_plugins_page' ), // Callback.
712
				)
713
			);
714
715
			$this->add_admin_menu( $args );
716
		}
717
718
		/**
719
		 * Add the menu item.
720
		 *
721
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
722
		 * generator on the website.}}
723
		 *
724
		 * @since 2.5.0
725
		 *
726
		 * @param array $args Menu item configuration.
727
		 */
728
		protected function add_admin_menu( array $args ) {
729
			if ( has_filter( 'tgmpa_admin_menu_use_add_theme_page' ) ) {
730
				_deprecated_function( 'The "tgmpa_admin_menu_use_add_theme_page" filter', '2.5.0', esc_html__( 'Set the parent_slug config variable instead.', 'tgmpa' ) );
731
			}
732
733
			if ( 'themes.php' === $this->parent_slug ) {
734
				$this->page_hook = call_user_func( 'add_theme_page', $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
735
			} else {
736
				$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'] );
737
			}
738
		}
739
740
		/**
741
		 * Echoes plugin installation form.
742
		 *
743
		 * This method is the callback for the admin_menu method function.
744
		 * This displays the admin page and form area where the user can select to install and activate the plugin.
745
		 * Aborts early if we're processing a plugin installation action.
746
		 *
747
		 * @since 1.0.0
748
		 *
749
		 * @return null Aborts early if we're processing a plugin installation action.
750
		 */
751
		public function install_plugins_page() {
752
			// Store new instance of plugin table in object.
753
			$plugin_table = new TGMPA_List_Table;
754
755
			// Return early if processing a plugin installation action.
756
			if ( ( ( 'tgmpa-bulk-install' === $plugin_table->current_action() || 'tgmpa-bulk-update' === $plugin_table->current_action() ) && $plugin_table->process_bulk_actions() ) || $this->do_plugin_install() ) {
757
				return;
758
			}
759
760
			// Force refresh of available plugin information so we'll know about manual updates/deletes.
761
			wp_clean_plugins_cache( false );
762
763
			?>
764
			<div class="tgmpa wrap">
765
				<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
766
				<?php $plugin_table->prepare_items(); ?>
767
768
				<?php
769
				if ( ! empty( $this->message ) && is_string( $this->message ) ) {
770
					echo wp_kses_post( $this->message );
771
				}
772
				?>
773
				<?php $plugin_table->views(); ?>
774
775
				<form id="tgmpa-plugins" action="" method="post">
776
					<input type="hidden" name="tgmpa-page" value="<?php echo esc_attr( $this->menu ); ?>" />
777
					<input type="hidden" name="plugin_status" value="<?php echo esc_attr( $plugin_table->view_context ); ?>" />
778
					<?php $plugin_table->display(); ?>
779
				</form>
780
			</div>
781
			<?php
782
		}
783
784
		/**
785
		 * Installs, updates or activates a plugin depending on the action link clicked by the user.
786
		 *
787
		 * Checks the $_GET variable to see which actions have been
788
		 * passed and responds with the appropriate method.
789
		 *
790
		 * Uses WP_Filesystem to process and handle the plugin installation
791
		 * method.
792
		 *
793
		 * @since 1.0.0
794
		 *
795
		 * @uses WP_Filesystem
796
		 * @uses WP_Error
797
		 * @uses WP_Upgrader
798
		 * @uses Plugin_Upgrader
799
		 * @uses Plugin_Installer_Skin
800
		 * @uses Plugin_Upgrader_Skin
801
		 *
802
		 * @return boolean True on success, false on failure.
803
		 */
804
		protected function do_plugin_install() {
805
			if ( empty( $_GET['plugin'] ) ) {
806
				return false;
807
			}
808
809
			// All plugin information will be stored in an array for processing.
810
			$slug = $this->sanitize_key( urldecode( $_GET['plugin'] ) );
811
812
			if ( ! isset( $this->plugins[ $slug ] ) ) {
813
				return false;
814
			}
815
816
			// Was an install or upgrade action link clicked?
817
			if ( ( isset( $_GET['tgmpa-install'] ) && 'install-plugin' === $_GET['tgmpa-install'] ) || ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) ) {
818
819
				$install_type = 'install';
820
				if ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) {
821
					$install_type = 'update';
822
				}
823
824
				check_admin_referer( 'tgmpa-' . $install_type, 'tgmpa-nonce' );
825
826
				// Pass necessary information via URL if WP_Filesystem is needed.
827
				$url = wp_nonce_url(
828
					add_query_arg(
829
						array(
830
							'plugin'                 => urlencode( $slug ),
831
							'tgmpa-' . $install_type => $install_type . '-plugin',
832
						),
833
						$this->get_tgmpa_url()
834
					),
835
					'tgmpa-' . $install_type,
836
					'tgmpa-nonce'
837
				);
838
839
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
840
841
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, array() ) ) ) {
842
					return true;
843
				}
844
845
				if ( ! WP_Filesystem( $creds ) ) {
1 ignored issue
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...
846
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem.
847
					return true;
848
				}
849
850
				/* If we arrive here, we have the filesystem. */
851
852
				// Prep variables for Plugin_Installer_Skin class.
853
				$extra         = array();
854
				$extra['slug'] = $slug; // Needed for potentially renaming of directory name.
855
				$source        = $this->get_download_url( $slug );
856
				$api           = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null;
857
				$api           = ( false !== $api ) ? $api : null;
858
859
				$url = add_query_arg(
860
					array(
861
						'action' => $install_type . '-plugin',
862
						'plugin' => urlencode( $slug ),
863
					),
864
					'update.php'
865
				);
866
867
				if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
868
					require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
869
				}
870
871
				$title     = ( 'update' === $install_type ) ? $this->strings['updating'] : $this->strings['installing'];
872
				$skin_args = array(
873
					'type'   => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload',
874
					'title'  => sprintf( $title, $this->plugins[ $slug ]['name'] ),
875
					'url'    => esc_url_raw( $url ),
876
					'nonce'  => $install_type . '-plugin_' . $slug,
877
					'plugin' => '',
878
					'api'    => $api,
879
					'extra'  => $extra,
880
				);
881
				unset( $title );
882
883
				if ( 'update' === $install_type ) {
884
					$skin_args['plugin'] = $this->plugins[ $slug ]['file_path'];
885
					$skin                = new Plugin_Upgrader_Skin( $skin_args );
886
				} else {
887
					$skin = new Plugin_Installer_Skin( $skin_args );
888
				}
889
890
				// Create a new instance of Plugin_Upgrader.
891
				$upgrader = new Plugin_Upgrader( $skin );
892
893
				// Perform the action and install the plugin from the $source urldecode().
894
				add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
895
896
				if ( 'update' === $install_type ) {
897
					// Inject our info into the update transient.
898
					$to_inject                    = array( $slug => $this->plugins[ $slug ] );
899
					$to_inject[ $slug ]['source'] = $source;
900
					$this->inject_update_info( $to_inject );
901
902
					$upgrader->upgrade( $this->plugins[ $slug ]['file_path'] );
903
				} else {
904
					$upgrader->install( $source );
905
				}
906
907
				remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1 );
908
909
				// Make sure we have the correct file path now the plugin is installed/updated.
910
				$this->populate_file_path( $slug );
911
912
				// Only activate plugins if the config option is set to true and the plugin isn't
913
				// already active (upgrade).
914
				if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) {
915
					$plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method.
916
					if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) {
917
						return true; // Finish execution of the function early as we encountered an error.
918
					}
919
				}
920
921
				$this->show_tgmpa_version();
922
923
				// Display message based on if all plugins are now active or not.
924
				if ( $this->is_tgmpa_complete() ) {
925
					echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>' ), '</p>';
926
					echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
927
				} else {
928
					echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
929
				}
930
931
				return true;
932
			} elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) {
933
				// Activate action link was clicked.
934
				check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' );
935
936
				if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) {
937
					return true; // Finish execution of the function early as we encountered an error.
938
				}
939
			}
940
941
			return false;
942
		}
943
944
		/**
945
		 * Inject information into the 'update_plugins' site transient as WP checks that before running an update.
946
		 *
947
		 * @since 2.5.0
948
		 *
949
		 * @param array $plugins The plugin information for the plugins which are to be updated.
950
		 */
951
		public function inject_update_info( $plugins ) {
952
			$repo_updates = get_site_transient( 'update_plugins' );
953
954
			if ( ! is_object( $repo_updates ) ) {
955
				$repo_updates = new stdClass;
956
			}
957
958
			foreach ( $plugins as $slug => $plugin ) {
959
				$file_path = $plugin['file_path'];
960
961
				if ( empty( $repo_updates->response[ $file_path ] ) ) {
962
					$repo_updates->response[ $file_path ] = new stdClass;
963
				}
964
965
				// We only really need to set package, but let's do all we can in case WP changes something.
966
				$repo_updates->response[ $file_path ]->slug        = $slug;
967
				$repo_updates->response[ $file_path ]->plugin      = $file_path;
968
				$repo_updates->response[ $file_path ]->new_version = $plugin['version'];
969
				$repo_updates->response[ $file_path ]->package     = $plugin['source'];
970
				if ( empty( $repo_updates->response[ $file_path ]->url ) && ! empty( $plugin['external_url'] ) ) {
971
					$repo_updates->response[ $file_path ]->url = $plugin['external_url'];
972
				}
973
			}
974
975
			set_site_transient( 'update_plugins', $repo_updates );
976
		}
977
978
		/**
979
		 * Adjust the plugin directory name if necessary.
980
		 *
981
		 * The final destination directory of a plugin is based on the subdirectory name found in the
982
		 * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this
983
		 * subdirectory name is not the same as the expected slug and the plugin will not be recognized
984
		 * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to
985
		 * the expected plugin slug.
986
		 *
987
		 * @since 2.5.0
988
		 *
989
		 * @param string       $source        Path to upgrade/zip-file-name.tmp/subdirectory/.
990
		 * @param string       $remote_source Path to upgrade/zip-file-name.tmp.
991
		 * @param \WP_Upgrader $upgrader      Instance of the upgrader which installs the plugin.
992
		 * @return string $source
993
		 */
994
		public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
995
			if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) {
996
				return $source;
997
			}
998
999
			// Check for single file plugins.
1000
			$source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) );
1001
			if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) {
1002
				return $source;
1003
			}
1004
1005
			// Multi-file plugin, let's see if the directory is correctly named.
1006
			$desired_slug = '';
1007
1008
			// Figure out what the slug is supposed to be.
1009
			if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) {
1010
				$desired_slug = $upgrader->skin->options['extra']['slug'];
1011
			} else {
1012
				// Bulk installer contains less info, so fall back on the info registered here.
1013
				foreach ( $this->plugins as $slug => $plugin ) {
1014
					if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) {
1015
						$desired_slug = $slug;
1016
						break;
1017
					}
1018
				}
1019
				unset( $slug, $plugin );
1020
			}
1021
1022
			if ( ! empty( $desired_slug ) ) {
1023
				$subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
1024
1025
				if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
1026
					$from_path = untrailingslashit( $source );
1027
					$to_path   = trailingslashit( $remote_source ) . $desired_slug;
1028
1029
					if ( true === $GLOBALS['wp_filesystem']->move( $from_path, $to_path ) ) {
1030
						return trailingslashit( $to_path );
1031 View Code Duplication
					} else {
1032
						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 ) );
1033
					}
1034 View Code Duplication
				} elseif ( empty( $subdir_name ) ) {
1035
					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 ) );
1036
				}
1037
			}
1038
1039
			return $source;
1040
		}
1041
1042
		/**
1043
		 * Activate a single plugin and send feedback about the result to the screen.
1044
		 *
1045
		 * @since 2.5.0
1046
		 *
1047
		 * @param string $file_path Path within wp-plugins/ to main plugin file.
1048
		 * @param string $slug      Plugin slug.
1049
		 * @param bool   $automatic Whether this is an automatic activation after an install. Defaults to false.
1050
		 *                          This determines the styling of the output messages.
1051
		 * @return bool False if an error was encountered, true otherwise.
1052
		 */
1053
		protected function activate_single_plugin( $file_path, $slug, $automatic = false ) {
1054
			if ( $this->can_plugin_activate( $slug ) ) {
1055
				$activate = activate_plugin( $file_path );
1056
1057
				if ( is_wp_error( $activate ) ) {
1058
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>',
1059
						'<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
1060
1061
					return false; // End it here if there is an error with activation.
1062
				} else {
1063
					if ( ! $automatic ) {
1064
						// Make sure message doesn't display again if bulk activation is performed
1065
						// immediately after a single activation.
1066
						if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1067
							echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>';
1068
						}
1069
					} else {
1070
						// Simpler message layout for use on the plugin install page.
1071
						echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>';
1072
					}
1073
				}
1074 View Code Duplication
			} elseif ( $this->is_plugin_active( $slug ) ) {
1075
				// No simpler message format provided as this message should never be encountered
1076
				// on the plugin install page.
1077
				echo '<div id="message" class="error"><p>',
1078
					sprintf(
1079
						esc_html( $this->strings['plugin_already_active'] ),
1080
						'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1081
					),
1082
					'</p></div>';
1083
			} elseif ( $this->does_plugin_require_update( $slug ) ) {
1084
				if ( ! $automatic ) {
1085
					// Make sure message doesn't display again if bulk activation is performed
1086
					// immediately after a single activation.
1087 View Code Duplication
					if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1088
						echo '<div id="message" class="error"><p>',
1089
							sprintf(
1090
								esc_html( $this->strings['plugin_needs_higher_version'] ),
1091
								'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1092
							),
1093
							'</p></div>';
1094
					}
1095
				} else {
1096
					// Simpler message layout for use on the plugin install page.
1097
					echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>';
1098
				}
1099
			}
1100
1101
			return true;
1102
		}
1103
1104
		/**
1105
		 * Echoes required plugin notice.
1106
		 *
1107
		 * Outputs a message telling users that a specific plugin is required for
1108
		 * their theme. If appropriate, it includes a link to the form page where
1109
		 * users can install and activate the plugin.
1110
		 *
1111
		 * Returns early if we're on the Install page.
1112
		 *
1113
		 * @since 1.0.0
1114
		 *
1115
		 * @global object $current_screen
1116
		 *
1117
		 * @return null Returns early if we're on the Install page.
1118
		 */
1119
		public function notices() {
1120
			// Remove nag on the install page / Return early if the nag message has been dismissed or user < author.
1121
			if ( ( $this->is_tgmpa_page() || $this->is_core_update_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' ) ) ) {
1122
				return;
1123
			}
1124
1125
			// Store for the plugin slugs by message type.
1126
			$message = array();
1127
1128
			// Initialize counters used to determine plurality of action link texts.
1129
			$install_link_count          = 0;
1130
			$update_link_count           = 0;
1131
			$activate_link_count         = 0;
1132
			$total_required_action_count = 0;
1133
1134
			foreach ( $this->plugins as $slug => $plugin ) {
1135
				if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) {
1136
					continue;
1137
				}
1138
1139
				if ( ! $this->is_plugin_installed( $slug ) ) {
1140
					if ( current_user_can( 'install_plugins' ) ) {
1141
						$install_link_count++;
1142
1143
						if ( true === $plugin['required'] ) {
1144
							$message['notice_can_install_required'][] = $slug;
1145
						} else {
1146
							$message['notice_can_install_recommended'][] = $slug;
1147
						}
1148
					}
1149
					if ( true === $plugin['required'] ) {
1150
						$total_required_action_count++;
1151
					}
1152
				} else {
1153
					if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) {
1154
						if ( current_user_can( 'activate_plugins' ) ) {
1155
							$activate_link_count++;
1156
1157
							if ( true === $plugin['required'] ) {
1158
								$message['notice_can_activate_required'][] = $slug;
1159
							} else {
1160
								$message['notice_can_activate_recommended'][] = $slug;
1161
							}
1162
						}
1163
						if ( true === $plugin['required'] ) {
1164
							$total_required_action_count++;
1165
						}
1166
					}
1167
1168
					if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1169
1170
						if ( current_user_can( 'update_plugins' ) ) {
1171
							$update_link_count++;
1172
1173
							if ( $this->does_plugin_require_update( $slug ) ) {
1174
								$message['notice_ask_to_update'][] = $slug;
1175
							} elseif ( false !== $this->does_plugin_have_update( $slug ) ) {
1176
								$message['notice_ask_to_update_maybe'][] = $slug;
1177
							}
1178
						}
1179
						if ( true === $plugin['required'] ) {
1180
							$total_required_action_count++;
1181
						}
1182
					}
1183
				}
1184
			}
1185
			unset( $slug, $plugin );
1186
1187
			// If we have notices to display, we move forward.
1188
			if ( ! empty( $message ) || $total_required_action_count > 0 ) {
1189
				$rendered = '';
1190
1191
				// As add_settings_error() wraps the final message in a <p> and as the final message can't be
1192
				// filtered, using <p>'s in our html would render invalid html output.
1193
				$line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n";
1194
1195
				if ( ! current_user_can( 'activate_plugins' ) && ! current_user_can( 'install_plugins' ) && ! current_user_can( 'update_plugins' ) ) {
1196
					$rendered  = esc_html__( $this->strings['notice_cannot_install_activate'] ) . ' ' . esc_html__( $this->strings['contact_admin'] );
1197
					$rendered .= $this->create_user_action_links_for_notice( 0, 0, 0, $line_template );
1198
				} else {
1199
1200
					// If dismissable is false and a message is set, output it now.
1201
					if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) {
1202
						$rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) );
1203
					}
1204
1205
					$rendered .= $this->build_message( $message, $line_template );
1206
1207
					$rendered .= $this->create_user_action_links_for_notice( $install_link_count, $update_link_count, $activate_link_count, $line_template );
1208
				}
1209
1210
				// Register the nag messages and prepare them to be processed.
1211
				add_settings_error( 'tgmpa', 'tgmpa', $rendered, $this->get_admin_notice_class() );
1212
			}
1213
1214
			// Admin options pages already output settings_errors, so this is to avoid duplication.
1215
			if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) {
1216
				$this->display_settings_errors();
1217
			}
1218
		}
1219
1220
		/**
1221
		 * Build a message string that specifies what actions are needed and the plugins that need those actions.
1222
		 *
1223
		 * @since 2.6.0
1224
		 *
1225
		 * @param  array $message Associative array of actions: each key is an action and each value is an array of plugin slugs that need that action
1226
		 * @param  string $line_template String that sprintf is applied to in creating a line of html markup for each action
1227
		 * @return string Message
1228
		 */
1229
		protected function build_message( $message, $line_template = '%s' ) {
1230
			$message_output = '';
1231
1232
			krsort( $message ); // Sort messages.
1233
1234
			// Render the individual message lines for the notice.
1235
			foreach ( $message as $type => $plugin_group ) {
1236
				$linked_plugins = array();
1237
1238
				// Get the external info link for a plugin if one is available.
1239
				foreach ( $plugin_group as $plugin_slug ) {
1240
					$linked_plugins[] = $this->get_info_link( $plugin_slug );
1241
				}
1242
				unset( $plugin_slug );
1243
1244
				$count          = count( $plugin_group );
1245
				$linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins );
1246
				$last_plugin    = array_pop( $linked_plugins ); // Pop off last name to prep for readability.
1247
				$imploded       = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
1248
1249
				$message_output .= sprintf(
1250
					$line_template,
1251
					sprintf(
1252
						translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ),
1253
						$imploded,
1254
						$count
1255
					)
1256
				);
1257
1258
			}
1259
1260
			return $message_output;
1261
		}
1262
1263
		/**
1264
		 * Generate the user action links for the admin notice.
1265
		 *
1266
		 * @since 2.x.x
1267
		 *
1268
		 * @param int $install_count  Number of plugins to install.
1269
		 * @param int $update_count   Number of plugins to update.
1270
		 * @param int $activate_count Number of plugins to activate.
1271
		 * @param int $line_template  Template for the HTML tag to output a line.
1272
		 * @return string Action links.
1273
		 */
1274
		protected function create_user_action_links_for_notice( $install_count, $update_count, $activate_count, $line_template ) {
1275
			// Setup action links.
1276
			$action_links = array(
1277
				'install'  => '',
1278
				'update'   => '',
1279
				'activate' => '',
1280
				'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>' : '',
1281
			);
1282
1283
			$link_template = '<a href="%2$s">%1$s</a>';
1284
1285
			if ( current_user_can( 'install_plugins' ) ) {
1286 View Code Duplication
				if ( $install_count > 0 ) {
1287
					$action_links['install'] = sprintf(
1288
						$link_template,
1289
						translate_nooped_plural( $this->strings['install_link'], $install_count, 'tgmpa' ),
1290
						esc_url( $this->get_tgmpa_status_url( 'install' ) )
1291
					);
1292
				}
1293 View Code Duplication
				if ( $update_count > 0 ) {
1294
					$action_links['update'] = sprintf(
1295
						$link_template,
1296
						translate_nooped_plural( $this->strings['update_link'], $update_count, 'tgmpa' ),
1297
						esc_url( $this->get_tgmpa_status_url( 'update' ) )
1298
					);
1299
				}
1300
			}
1301
1302 View Code Duplication
			if ( current_user_can( 'activate_plugins' ) && $activate_count > 0 ) {
1303
				$action_links['activate'] = sprintf(
1304
					$link_template,
1305
					translate_nooped_plural( $this->strings['activate_link'], $activate_count, 'tgmpa' ),
1306
					esc_url( $this->get_tgmpa_status_url( 'activate' ) )
1307
				);
1308
			}
1309
1310
			$action_links = apply_filters( 'tgmpa_notice_action_links', $action_links );
1311
1312
			$action_links = array_filter( (array) $action_links ); // Remove any empty array items.
1313
1314
			if ( ! empty( $action_links ) ) {
1315
				$action_links = sprintf( $line_template, implode( ' | ', $action_links ) );
1316
				return apply_filters( 'tgmpa_notice_rendered_action_links', $action_links );
1317
			} else {
1318
				return '';
1319
			}
1320
		}
1321
1322
		/**
1323
		 * Get admin notice class.
1324
		 *
1325
		 * Work around all the changes to the various admin notice classes between WP 4.4 and 3.7
1326
		 * (lowest supported version by TGMPA).
1327
		 *
1328
		 * @since 2.x.x
1329
		 *
1330
		 * @return string
1331
		 */
1332
		protected function get_admin_notice_class() {
1333
			if ( ! empty( $this->strings['nag_type'] ) ) {
1334
				return sanitize_html_class( strtolower( $this->strings['nag_type'] ) );
1335
			} else {
1336
				if ( version_compare( $this->wp_version, '4.2', '>=' ) ) {
1337
					return 'notice-warning';
1338
				} elseif ( version_compare( $this->wp_version, '4.1', '>=' ) ) {
1339
					return 'notice';
1340
				} else {
1341
					return 'updated';
1342
				}
1343
			}
1344
		}
1345
1346
		/**
1347
		 * Display settings errors and remove those which have been displayed to avoid duplicate messages showing
1348
		 *
1349
		 * @since 2.5.0
1350
		 */
1351
		protected function display_settings_errors() {
1352
			global $wp_settings_errors;
1353
1354
			settings_errors( 'tgmpa' );
1355
1356
			foreach ( (array) $wp_settings_errors as $key => $details ) {
1357
				if ( 'tgmpa' === $details['setting'] ) {
1358
					unset( $wp_settings_errors[ $key ] );
1359
					break;
1360
				}
1361
			}
1362
		}
1363
1364
		/**
1365
		 * Display admin notice if plugins have been force activated.
1366
		 *
1367
		 * @since 2.6.0
1368
		 */
1369
		public function display_forced_activation_notice() {
1370
			if ( $force_activated_plugins = get_transient( 'tgmpa_force_activated_plugins' ) ) {
1371
				?>
1372
				<div class="notice <?php echo $this->get_admin_notice_class(); ?> is-dismissible">
1373
					<p><strong><?php echo $this->build_message( array( 'notice_force_activation' => $force_activated_plugins ) ); ?></strong></p>
1374
				</div>
1375
				<?php
1376
				delete_transient( 'tgmpa_force_activated_plugins' );
1377
			}
1378
		}
1379
1380
		/**
1381
		 * Register dismissal of admin notices.
1382
		 *
1383
		 * Acts on the dismiss link in the admin nag messages.
1384
		 * If clicked, the admin notice disappears and will no longer be visible to this user.
1385
		 *
1386
		 * @since 2.1.0
1387
		 */
1388
		public function dismiss() {
1389
			if ( isset( $_GET['tgmpa-dismiss'] ) && check_admin_referer( 'tgmpa-dismiss-' . get_current_user_id() ) ) {
1390
				update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
1391
			}
1392
		}
1393
1394
		/**
1395
		 * Add individual plugin to our collection of plugins.
1396
		 *
1397
		 * If the required keys are not set or the plugin has already
1398
		 * been registered, the plugin is not added.
1399
		 *
1400
		 * @since 2.0.0
1401
		 *
1402
		 * @param array|null $plugin Array of plugin arguments or null if invalid argument.
1403
		 * @return null Return early if incorrect argument.
1404
		 */
1405
		public function register( $plugin ) {
1406
			if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
1407
				return;
1408
			}
1409
1410
			if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
1411
				return;
1412
			}
1413
1414
			$defaults = array(
1415
				'name'               => '',      // String
1416
				'slug'               => '',      // String
1417
				'source'             => 'repo',  // String
1418
				'required'           => false,   // Boolean
1419
				'version'            => '',      // String
1420
				'force_activation'   => false,   // Boolean
1421
				'force_deactivation' => false,   // Boolean
1422
				'external_url'       => '',      // String
1423
				'is_callable'        => '',      // String|Array.
1424
			);
1425
1426
			// Prepare the received data.
1427
			$plugin = wp_parse_args( $plugin, $defaults );
1428
1429
			// Standardize the received slug.
1430
			$plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
1431
1432
			// Forgive users for using string versions of booleans or floats for version number.
1433
			$plugin['version']            = (string) $plugin['version'];
1434
			$plugin['source']             = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
1435
			$plugin['required']           = TGMPA_Utils::validate_bool( $plugin['required'] );
1436
			$plugin['force_activation']   = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
1437
			$plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
1438
1439
			// Enrich the received data.
1440
			$plugin['file_path']   = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
1441
			$plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
1442
1443
			// Set the class properties.
1444
			$this->plugins[ $plugin['slug'] ]    = $plugin;
1445
			$this->sort_order[ $plugin['slug'] ] = $plugin['name'];
1446
1447
			// Should we add the force activation hook ?
1448
			if ( true === $plugin['force_activation'] ) {
1449
				$this->has_forced_activation = true;
1450
			}
1451
1452
			// Should we add the force deactivation hook ?
1453
			if ( true === $plugin['force_deactivation'] ) {
1454
				$this->has_forced_deactivation = true;
1455
			}
1456
		}
1457
1458
		/**
1459
		 * Determine what type of source the plugin comes from.
1460
		 *
1461
		 * @since 2.5.0
1462
		 *
1463
		 * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
1464
		 *                       (= bundled) or an external URL.
1465
		 * @return string 'repo', 'external', or 'bundled'
1466
		 */
1467
		protected function get_plugin_source_type( $source ) {
1468
			if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
1469
				return 'repo';
1470
			} elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
1471
				return 'external';
1472
			} else {
1473
				return 'bundled';
1474
			}
1475
		}
1476
1477
		/**
1478
		 * Sanitizes a string key.
1479
		 *
1480
		 * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
1481
		 * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
1482
		 * characters in the plugin directory path/slug. Silly them.
1483
		 *
1484
		 * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
1485
		 *
1486
		 * @since 2.5.0
1487
		 *
1488
		 * @param string $key String key.
1489
		 * @return string Sanitized key
1490
		 */
1491
		public function sanitize_key( $key ) {
1492
			$raw_key = $key;
1493
			$key     = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
1494
1495
			/**
1496
			 * Filter a sanitized key string.
1497
			 *
1498
			 * @since 2.5.0
1499
			 *
1500
			 * @param string $key     Sanitized key.
1501
			 * @param string $raw_key The key prior to sanitization.
1502
			 */
1503
			return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
1504
		}
1505
1506
		/**
1507
		 * Amend default configuration settings.
1508
		 *
1509
		 * @since 2.0.0
1510
		 *
1511
		 * @param array $config Array of config options to pass as class properties.
1512
		 */
1513
		public function config( $config ) {
1514
			$keys = array(
1515
				'id',
1516
				'default_path',
1517
				'has_notices',
1518
				'dismissable',
1519
				'dismiss_msg',
1520
				'menu',
1521
				'parent_slug',
1522
				'capability',
1523
				'is_automatic',
1524
				'message',
1525
				'strings',
1526
			);
1527
1528
			foreach ( $keys as $key ) {
1529
				if ( isset( $config[ $key ] ) ) {
1530
					if ( is_array( $config[ $key ] ) ) {
1531
						$this->$key = array_merge( $this->$key, $config[ $key ] );
1532
					} else {
1533
						$this->$key = $config[ $key ];
1534
					}
1535
				}
1536
			}
1537
		}
1538
1539
		/**
1540
		 * Amend action link after plugin installation.
1541
		 *
1542
		 * @since 2.0.0
1543
		 *
1544
		 * @param array $install_actions Existing array of actions.
1545
		 * @return false|array Amended array of actions.
1546
		 */
1547
		public function actions( $install_actions ) {
1548
			// Remove action links on the TGMPA install page.
1549
			if ( $this->is_tgmpa_page() ) {
1550
				return false;
1551
			}
1552
1553
			return $install_actions;
1554
		}
1555
1556
		/**
1557
		 * Flushes the plugins cache on theme switch to prevent stale entries
1558
		 * from remaining in the plugin table.
1559
		 *
1560
		 * @since 2.4.0
1561
		 *
1562
		 * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
1563
		 *                                 Parameter added in v2.5.0.
1564
		 */
1565
		public function flush_plugins_cache( $clear_update_cache = true ) {
1566
			wp_clean_plugins_cache( $clear_update_cache );
1567
		}
1568
1569
		/**
1570
		 * Set file_path key for each installed plugin.
1571
		 *
1572
		 * @since 2.1.0
1573
		 *
1574
		 * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
1575
		 *                            Parameter added in v2.5.0.
1576
		 */
1577
		public function populate_file_path( $plugin_slug = '' ) {
1578
			if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
1579
				$this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
1580
			} else {
1581
				// Add file_path key for all plugins.
1582
				foreach ( $this->plugins as $slug => $values ) {
1583
					$this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
1584
				}
1585
			}
1586
		}
1587
1588
		/**
1589
		 * Helper function to extract the file path of the plugin file from the
1590
		 * plugin slug, if the plugin is installed.
1591
		 *
1592
		 * @since 2.0.0
1593
		 *
1594
		 * @param string $slug Plugin slug (typically folder name) as provided by the developer.
1595
		 * @return string Either file path for plugin if installed, or just the plugin slug.
1596
		 */
1597
		protected function _get_plugin_basename_from_slug( $slug ) {
1598
			$keys = array_keys( $this->get_plugins() );
1599
1600
			foreach ( $keys as $key ) {
1601
				if ( preg_match( '|^' . $slug . '/|', $key ) ) {
1602
					return $key;
1603
				}
1604
			}
1605
1606
			return $slug;
1607
		}
1608
1609
		/**
1610
		 * Retrieve plugin data, given the plugin name.
1611
		 *
1612
		 * Loops through the registered plugins looking for $name. If it finds it,
1613
		 * it returns the $data from that plugin. Otherwise, returns false.
1614
		 *
1615
		 * @since 2.1.0
1616
		 *
1617
		 * @param string $name Name of the plugin, as it was registered.
1618
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
1619
		 * @return string|boolean Plugin slug if found, false otherwise.
1620
		 */
1621
		public function _get_plugin_data_from_name( $name, $data = 'slug' ) {
1622
			foreach ( $this->plugins as $values ) {
1623
				if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
1624
					return $values[ $data ];
1625
				}
1626
			}
1627
1628
			return false;
1629
		}
1630
1631
		/**
1632
		 * Retrieve the download URL for a package.
1633
		 *
1634
		 * @since 2.5.0
1635
		 *
1636
		 * @param string $slug Plugin slug.
1637
		 * @return string Plugin download URL or path to local file or empty string if undetermined.
1638
		 */
1639
		public function get_download_url( $slug ) {
1640
			$dl_source = '';
1641
1642
			switch ( $this->plugins[ $slug ]['source_type'] ) {
1643
				case 'repo':
1644
					return $this->get_wp_repo_download_url( $slug );
1645
				case 'external':
1646
					return $this->plugins[ $slug ]['source'];
1647
				case 'bundled':
1648
					return $this->default_path . $this->plugins[ $slug ]['source'];
1649
			}
1650
1651
			return $dl_source; // Should never happen.
1652
		}
1653
1654
		/**
1655
		 * Retrieve the download URL for a WP repo package.
1656
		 *
1657
		 * @since 2.5.0
1658
		 *
1659
		 * @param string $slug Plugin slug.
1660
		 * @return string Plugin download URL.
1661
		 */
1662
		protected function get_wp_repo_download_url( $slug ) {
1663
			$source = '';
1664
			$api    = $this->get_plugins_api( $slug );
1665
1666
			if ( false !== $api && isset( $api->download_link ) ) {
1667
				$source = $api->download_link;
1668
			}
1669
1670
			return $source;
1671
		}
1672
1673
		/**
1674
		 * Try to grab information from WordPress API.
1675
		 *
1676
		 * @since 2.5.0
1677
		 *
1678
		 * @param string $slug Plugin slug.
1679
		 * @return object Plugins_api response object on success, WP_Error on failure.
1680
		 */
1681
		protected function get_plugins_api( $slug ) {
1682
			static $api = array(); // Cache received responses.
1683
1684
			if ( ! isset( $api[ $slug ] ) ) {
1685
				if ( ! function_exists( 'plugins_api' ) ) {
1686
					require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
1687
				}
1688
1689
				$response = plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false ) ) );
1690
1691
				$api[ $slug ] = false;
1692
1693
				if ( is_wp_error( $response ) ) {
1694
					wp_die( esc_html( $this->strings['oops'] ) );
1695
				} else {
1696
					$api[ $slug ] = $response;
1697
				}
1698
			}
1699
1700
			return $api[ $slug ];
1701
		}
1702
1703
		/**
1704
		 * Retrieve a link to a plugin information page.
1705
		 *
1706
		 * @since 2.5.0
1707
		 *
1708
		 * @param string $slug Plugin slug.
1709
		 * @return string Fully formed html link to a plugin information page if available
1710
		 *                or the plugin name if not.
1711
		 */
1712
		public function get_info_link( $slug ) {
1713
			if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
1714
				$link = sprintf(
1715
					'<a href="%1$s" target="_blank">%2$s</a>',
1716
					esc_url( $this->plugins[ $slug ]['external_url'] ),
1717
					esc_html( $this->plugins[ $slug ]['name'] )
1718
				);
1719
			} elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
1720
				$url = add_query_arg(
1721
					array(
1722
						'tab'       => 'plugin-information',
1723
						'plugin'    => urlencode( $slug ),
1724
						'TB_iframe' => 'true',
1725
						'width'     => '640',
1726
						'height'    => '500',
1727
					),
1728
					self_admin_url( 'plugin-install.php' )
1729
				);
1730
1731
				$link = sprintf(
1732
					'<a href="%1$s" class="thickbox">%2$s</a>',
1733
					esc_url( $url ),
1734
					esc_html( $this->plugins[ $slug ]['name'] )
1735
				);
1736
			} else {
1737
				$link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
1738
			}
1739
1740
			return $link;
1741
		}
1742
1743
		/**
1744
		 * Determine if we're on the TGMPA Install page.
1745
		 *
1746
		 * @since 2.1.0
1747
		 *
1748
		 * @return boolean True when on the TGMPA page, false otherwise.
1749
		 */
1750
		protected function is_tgmpa_page() {
1751
			return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
1752
		}
1753
1754
		/**
1755
		 * Determine if we're on a WP Core installation/upgrade page.
1756
		 *
1757
		 * @since 2.x.x
1758
		 *
1759
		 * @return boolean True when on a WP Core installation/upgrade page, false otherwise.
1760
		 */
1761
		protected function is_core_update_page() {
1762
			// Current screen is not always available, most notably on the customizer screen.
1763
			if ( ! function_exists( 'get_current_screen' ) ) {
1764
				return false;
1765
			}
1766
1767
			$screen = get_current_screen();
1768
1769
			if ( 'update-core' === $screen->base ) {
1770
				// Core update screen.
1771
				return true;
1772
			} elseif ( 'plugins' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
1773
				// Plugins bulk update screen.
1774
				return true;
1775
			} elseif ( 'update' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
1776
				// Individual updates (ajax call).
1777
				return true;
1778
			}
1779
1780
			return false;
1781
		}
1782
1783
		/**
1784
		 * Retrieve the URL to the TGMPA Install page.
1785
		 *
1786
		 * I.e. depending on the config settings passed something along the lines of:
1787
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
1788
		 *
1789
		 * @since 2.5.0
1790
		 *
1791
		 * @return string Properly encoded URL (not escaped).
1792
		 */
1793
		public function get_tgmpa_url() {
1794
			static $url;
1795
1796
			if ( ! isset( $url ) ) {
1797
				$parent = $this->parent_slug;
1798
				if ( false === strpos( $parent, '.php' ) ) {
1799
					$parent = 'admin.php';
1800
				}
1801
				$url = add_query_arg(
1802
					array(
1803
						'page' => urlencode( $this->menu ),
1804
					),
1805
					self_admin_url( $parent )
1806
				);
1807
			}
1808
1809
			return $url;
1810
		}
1811
1812
		/**
1813
		 * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
1814
		 *
1815
		 * I.e. depending on the config settings passed something along the lines of:
1816
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install
1817
		 *
1818
		 * @since 2.5.0
1819
		 *
1820
		 * @param string $status Plugin status - either 'install', 'update' or 'activate'.
1821
		 * @return string Properly encoded URL (not escaped).
1822
		 */
1823
		public function get_tgmpa_status_url( $status ) {
1824
			return add_query_arg(
1825
				array(
1826
					'plugin_status' => urlencode( $status ),
1827
				),
1828
				$this->get_tgmpa_url()
1829
			);
1830
		}
1831
1832
		/**
1833
		 * Determine whether there are open actions for plugins registered with TGMPA.
1834
		 *
1835
		 * @since 2.5.0
1836
		 *
1837
		 * @return bool True if complete, i.e. no outstanding actions. False otherwise.
1838
		 */
1839
		public function is_tgmpa_complete() {
1840
			$complete = true;
1841
			foreach ( $this->plugins as $slug => $plugin ) {
1842
				if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1843
					$complete = false;
1844
					break;
1845
				}
1846
			}
1847
1848
			return $complete;
1849
		}
1850
1851
		/**
1852
		 * Check if a plugin is installed. Does not take must-use plugins into account.
1853
		 *
1854
		 * @since 2.5.0
1855
		 *
1856
		 * @param string $slug Plugin slug.
1857
		 * @return bool True if installed, false otherwise.
1858
		 */
1859
		public function is_plugin_installed( $slug ) {
1860
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1861
1862
			return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
1863
		}
1864
1865
		/**
1866
		 * Check if a plugin is active.
1867
		 *
1868
		 * @since 2.5.0
1869
		 *
1870
		 * @param string $slug Plugin slug.
1871
		 * @return bool True if active, false otherwise.
1872
		 */
1873
		public function is_plugin_active( $slug ) {
1874
			return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) ) || is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
1875
		}
1876
1877
		/**
1878
		 * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
1879
		 * available, check whether the current install meets them.
1880
		 *
1881
		 * @since 2.5.0
1882
		 *
1883
		 * @param string $slug Plugin slug.
1884
		 * @return bool True if OK to update, false otherwise.
1885
		 */
1886
		public function can_plugin_update( $slug ) {
1887
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1888
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1889
				return true;
1890
			}
1891
1892
			$api = $this->get_plugins_api( $slug );
1893
1894
			if ( false !== $api && isset( $api->requires ) ) {
1895
				return version_compare( $this->wp_version, $api->requires, '>=' );
1896
			}
1897
1898
			// No usable info received from the plugins API, presume we can update.
1899
			return true;
1900
		}
1901
1902
		/**
1903
		 * Check to see if the plugin is 'updatetable', i.e. installed, with an update available
1904
		 * and no WP version requirements blocking it.
1905
		 *
1906
		 * @since 2.x.x
1907
		 *
1908
		 * @param string $slug Plugin slug.
1909
		 * @return bool True if OK to proceed with update, false otherwise.
1910
		 */
1911
		public function is_plugin_updatetable( $slug ) {
1912
			if ( ! $this->is_plugin_installed( $slug ) ) {
1913
				return false;
1914
			} else {
1915
				return ( false !== $this->does_plugin_have_update( $slug ) && $this->can_plugin_update( $slug ) );
1916
			}
1917
		}
1918
1919
		/**
1920
		 * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
1921
		 * plugin version requirements set in TGMPA (if any).
1922
		 *
1923
		 * @since 2.5.0
1924
		 *
1925
		 * @param string $slug Plugin slug.
1926
		 * @return bool True if OK to activate, false otherwise.
1927
		 */
1928
		public function can_plugin_activate( $slug ) {
1929
			return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
1930
		}
1931
1932
		/**
1933
		 * Retrieve the version number of an installed plugin.
1934
		 *
1935
		 * @since 2.5.0
1936
		 *
1937
		 * @param string $slug Plugin slug.
1938
		 * @return string Version number as string or an empty string if the plugin is not installed
1939
		 *                or version unknown (plugins which don't comply with the plugin header standard).
1940
		 */
1941
		public function get_installed_version( $slug ) {
1942
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1943
1944
			if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
1945
				return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
1946
			}
1947
1948
			return '';
1949
		}
1950
1951
		/**
1952
		 * Check whether a plugin complies with the minimum version requirements.
1953
		 *
1954
		 * @since 2.5.0
1955
		 *
1956
		 * @param string $slug Plugin slug.
1957
		 * @return bool True when a plugin needs to be updated, otherwise false.
1958
		 */
1959
		public function does_plugin_require_update( $slug ) {
1960
			$installed_version = $this->get_installed_version( $slug );
1961
			$minimum_version   = $this->plugins[ $slug ]['version'];
1962
1963
			return version_compare( $minimum_version, $installed_version, '>' );
1964
		}
1965
1966
		/**
1967
		 * Check whether there is an update available for a plugin.
1968
		 *
1969
		 * @since 2.5.0
1970
		 *
1971
		 * @param string $slug Plugin slug.
1972
		 * @return false|string Version number string of the available update or false if no update available.
1973
		 */
1974
		public function does_plugin_have_update( $slug ) {
1975
			// Presume bundled and external plugins will point to a package which meets the minimum required version.
1976
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1977
				if ( $this->does_plugin_require_update( $slug ) ) {
1978
					return $this->plugins[ $slug ]['version'];
1979
				}
1980
1981
				return false;
1982
			}
1983
1984
			$repo_updates = get_site_transient( 'update_plugins' );
1985
1986 View Code Duplication
			if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
1987
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
1988
			}
1989
1990
			return false;
1991
		}
1992
1993
		/**
1994
		 * Retrieve potential upgrade notice for a plugin.
1995
		 *
1996
		 * @since 2.5.0
1997
		 *
1998
		 * @param string $slug Plugin slug.
1999
		 * @return string The upgrade notice or an empty string if no message was available or provided.
2000
		 */
2001
		public function get_upgrade_notice( $slug ) {
2002
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
2003
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
2004
				return '';
2005
			}
2006
2007
			$repo_updates = get_site_transient( 'update_plugins' );
2008
2009 View Code Duplication
			if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
2010
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
2011
			}
2012
2013
			return '';
2014
		}
2015
2016
		/**
2017
		 * Wrapper around the core WP get_plugins function, making sure it's actually available.
2018
		 *
2019
		 * @since 2.5.0
2020
		 *
2021
		 * @param string $plugin_folder Optional. Relative path to single plugin folder.
2022
		 * @return array Array of installed plugins with plugin information.
2023
		 */
2024
		public function get_plugins( $plugin_folder = '' ) {
2025
			if ( ! function_exists( 'get_plugins' ) ) {
2026
				require_once ABSPATH . 'wp-admin/includes/plugin.php';
2027
			}
2028
2029
			return get_plugins( $plugin_folder );
2030
		}
2031
2032
		/**
2033
		 * Delete dismissable nag option when theme is switched.
2034
		 *
2035
		 * This ensures that the user(s) is/are again reminded via nag of required
2036
		 * and/or recommended plugins if they re-activate the theme.
2037
		 *
2038
		 * @since 2.1.1
2039
		 */
2040
		public function update_dismiss() {
2041
			delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
2042
		}
2043
2044
		/**
2045
		 * Forces plugin activation if the parameter 'force_activation' is
2046
		 * set to true.
2047
		 *
2048
		 * This allows theme authors to specify certain plugins that must be
2049
		 * active at all times while using the current theme.
2050
		 *
2051
		 * Please take special care when using this parameter as it has the
2052
		 * potential to be harmful if not used correctly. Setting this parameter
2053
		 * to true will not allow the specified plugin to be deactivated unless
2054
		 * the user switches themes.
2055
		 *
2056
		 * @since 2.2.0
2057
		 */
2058
		public function force_activation() {
2059
			foreach ( $this->plugins as $slug => $plugin ) {
2060
				if ( true === $plugin['force_activation'] ) {
2061
					if ( ! $this->is_plugin_installed( $slug ) ) {
2062
						// Oops, plugin isn't there so iterate to next condition.
2063
						continue;
2064
					} elseif ( $this->can_plugin_activate( $slug ) ) {
2065
						// There we go, activate the plugin.
2066
						activate_plugin( $plugin['file_path'] );
2067
						$this->append_transient( 'tgmpa_force_activated_plugins', $slug );
2068
					}
2069
				}
2070
			}
2071
		}
2072
2073
		/**
2074
		 * Set/update a transient, appending the new value if the transient already exists.
2075
		 *
2076
		 * @since 2.6.0
2077
		 *
2078
		 * @param string $transient_key
2079
		 * @param string|array $data To set or add to transient
2080
		 */
2081
		protected function append_transient( $transient_key, $data ) {
2082
			if ( $transient_data = get_transient( $transient_key ) ) {
2083
				(array) $transient_data[] = $data;
2084
			} else {
2085
				$transient_data = (array) $data;
2086
			}
2087
2088
			set_transient( $transient_key, $transient_data );
2089
		}
2090
2091
		/**
2092
		 * Forces plugin deactivation if the parameter 'force_deactivation'
2093
		 * is set to true and adds the plugin to the 'recently active' plugins list.
2094
		 *
2095
		 * This allows theme authors to specify certain plugins that must be
2096
		 * deactivated upon switching from the current theme to another.
2097
		 *
2098
		 * Please take special care when using this parameter as it has the
2099
		 * potential to be harmful if not used correctly.
2100
		 *
2101
		 * @since 2.2.0
2102
		 */
2103
		public function force_deactivation() {
2104
			$deactivated = array();
2105
2106
			foreach ( $this->plugins as $slug => $plugin ) {
2107
				/*
2108
				 * Only proceed forward if the parameter is set to true and plugin is active
2109
				 * as a 'normal' (not must-use) plugin.
2110
				 */
2111
				if ( true === $plugin['force_deactivation'] && is_plugin_active( $plugin['file_path'] ) ) {
2112
					deactivate_plugins( $plugin['file_path'] );
2113
					$deactivated[ $plugin['file_path'] ] = time();
2114
				}
2115
			}
2116
2117
			if ( ! empty( $deactivated ) ) {
2118
				update_option( 'recently_activated', $deactivated + (array) get_option( 'recently_activated' ) );
2119
			}
2120
		}
2121
2122
		/**
2123
		 * Echo the current TGMPA version number to the page.
2124
		 */
2125
		public function show_tgmpa_version() {
2126
			echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
2127
				esc_html(
2128
					sprintf(
2129
						/* translators: %s: version number */
2130
						__( 'TGMPA v%s', 'tgmpa' ),
2131
						self::TGMPA_VERSION
2132
					)
2133
				),
2134
				'</small></strong></p>';
2135
		}
2136
2137
		/**
2138
		 * Returns the singleton instance of the class.
2139
		 *
2140
		 * @since 2.4.0
2141
		 *
2142
		 * @return \TGM_Plugin_Activation The TGM_Plugin_Activation object.
2143
		 */
2144
		public static function get_instance() {
2145
			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
2146
				self::$instance = new self();
2147
			}
2148
2149
			return self::$instance;
2150
		}
2151
	}
2152
2153
	if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
2154
		/**
2155
		 * Ensure only one instance of the class is ever invoked.
2156
		 */
2157
		function load_tgm_plugin_activation() {
2158
			$GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
2159
		}
2160
	}
2161
2162
	if ( did_action( 'plugins_loaded' ) ) {
2163
		load_tgm_plugin_activation();
2164
	} else {
2165
		add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
2166
	}
2167
}
2168
2169
if ( ! function_exists( 'tgmpa' ) ) {
2170
	/**
2171
	 * Helper function to register a collection of required plugins.
2172
	 *
2173
	 * @since 2.0.0
2174
	 * @api
2175
	 *
2176
	 * @param array $plugins An array of plugin arrays.
2177
	 * @param array $config  Optional. An array of configuration values.
2178
	 */
2179
	function tgmpa( $plugins, $config = array() ) {
2180
		$instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2181
2182
		foreach ( $plugins as $plugin ) {
2183
			call_user_func( array( $instance, 'register' ), $plugin );
2184
		}
2185
2186
		if ( ! empty( $config ) && is_array( $config ) ) {
2187
			// Send out notices for deprecated arguments passed.
2188
			if ( isset( $config['notices'] ) ) {
2189
				_deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
2190
				if ( ! isset( $config['has_notices'] ) ) {
2191
					$config['has_notices'] = $config['notices'];
2192
				}
2193
			}
2194
2195
			if ( isset( $config['parent_menu_slug'] ) ) {
2196
				_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.' );
2197
			}
2198
			if ( isset( $config['parent_url_slug'] ) ) {
2199
				_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.' );
2200
			}
2201
2202
			call_user_func( array( $instance, 'config' ), $config );
2203
		}
2204
	}
2205
}
2206
2207
/**
2208
 * WP_List_Table isn't always available. If it isn't available,
2209
 * we load it here.
2210
 *
2211
 * @since 2.2.0
2212
 */
2213
if ( ! class_exists( 'WP_List_Table' ) ) {
2214
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
2215
}
2216
2217
if ( ! class_exists( 'TGMPA_List_Table' ) ) {
2218
2219
	/**
2220
	 * List table class for handling plugins.
2221
	 *
2222
	 * Extends the WP_List_Table class to provide a future-compatible
2223
	 * way of listing out all required/recommended plugins.
2224
	 *
2225
	 * Gives users an interface similar to the Plugin Administration
2226
	 * area with similar (albeit stripped down) capabilities.
2227
	 *
2228
	 * This class also allows for the bulk install of plugins.
2229
	 *
2230
	 * @since 2.2.0
2231
	 *
2232
	 * @package TGM-Plugin-Activation
2233
	 * @author  Thomas Griffin
2234
	 * @author  Gary Jones
2235
	 */
2236
	class TGMPA_List_Table extends WP_List_Table {
2237
		/**
2238
		 * TGMPA instance.
2239
		 *
2240
		 * @since 2.5.0
2241
		 *
2242
		 * @var object
2243
		 */
2244
		protected $tgmpa;
2245
2246
		/**
2247
		 * The currently chosen view.
2248
		 *
2249
		 * @since 2.5.0
2250
		 *
2251
		 * @var string One of: 'all', 'install', 'update', 'activate'
2252
		 */
2253
		public $view_context = 'all';
2254
2255
		/**
2256
		 * The plugin counts for the various views.
2257
		 *
2258
		 * @since 2.5.0
2259
		 *
2260
		 * @var array
2261
		 */
2262
		protected $view_totals = array(
2263
			'all'      => 0,
2264
			'install'  => 0,
2265
			'update'   => 0,
2266
			'activate' => 0,
2267
		);
2268
2269
		/**
2270
		 * References parent constructor and sets defaults for class.
2271
		 *
2272
		 * @since 2.2.0
2273
		 */
2274
		public function __construct() {
2275
			$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2276
2277
			parent::__construct(
2278
				array(
2279
					'singular' => 'plugin',
2280
					'plural'   => 'plugins',
2281
					'ajax'     => false,
2282
				)
2283
			);
2284
2285
			if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
2286
				$this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
2287
			}
2288
2289
			add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
2290
		}
2291
2292
		/**
2293
		 * Get a list of CSS classes for the <table> tag.
2294
		 *
2295
		 * Overruled to prevent the 'plural' argument from being added.
2296
		 *
2297
		 * @since 2.5.0
2298
		 *
2299
		 * @return array CSS classnames.
2300
		 */
2301
		public function get_table_classes() {
2302
			return array( 'widefat', 'fixed' );
2303
		}
2304
2305
		/**
2306
		 * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
2307
		 *
2308
		 * @since 2.2.0
2309
		 *
2310
		 * @return array $table_data Information for use in table.
2311
		 */
2312
		protected function _gather_plugin_data() {
2313
			// Load thickbox for plugin links.
2314
			$this->tgmpa->admin_init();
2315
			$this->tgmpa->thickbox();
2316
2317
			// Categorize the plugins which have open actions.
2318
			$plugins = $this->categorize_plugins_to_views();
2319
2320
			// Set the counts for the view links.
2321
			$this->set_view_totals( $plugins );
2322
2323
			// Prep variables for use and grab list of all installed plugins.
2324
			$table_data = array();
2325
			$i          = 0;
2326
2327
			// Redirect to the 'all' view if no plugins were found for the selected view context.
2328
			if ( empty( $plugins[ $this->view_context ] ) ) {
2329
				$this->view_context = 'all';
2330
			}
2331
2332
			foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
2333
				$table_data[ $i ]['sanitized_plugin']  = $plugin['name'];
2334
				$table_data[ $i ]['slug']              = $slug;
2335
				$table_data[ $i ]['plugin']            = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
2336
				$table_data[ $i ]['source']            = $this->get_plugin_source_type_text( $plugin['source_type'] );
2337
				$table_data[ $i ]['type']              = $this->get_plugin_advise_type_text( $plugin['required'] );
2338
				$table_data[ $i ]['status']            = $this->get_plugin_status_text( $slug );
2339
				$table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
2340
				$table_data[ $i ]['minimum_version']   = $plugin['version'];
2341
				$table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
2342
2343
				// Prep the upgrade notice info.
2344
				$upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
2345
				if ( ! empty( $upgrade_notice ) ) {
2346
					$table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
2347
2348
					add_action( "tgmpa_after_plugin_row_{$slug}", array( $this, 'wp_plugin_update_row' ), 10, 2 );
2349
				}
2350
2351
				$table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
2352
2353
				$i++;
2354
			}
2355
2356
			return $table_data;
2357
		}
2358
2359
		/**
2360
		 * Categorize the plugins which have open actions into views for the TGMPA page.
2361
		 *
2362
		 * @since 2.5.0
2363
		 */
2364
		protected function categorize_plugins_to_views() {
2365
			$plugins = array(
2366
				'all'      => array(), // Meaning: all plugins which still have open actions.
2367
				'install'  => array(),
2368
				'update'   => array(),
2369
				'activate' => array(),
2370
			);
2371
2372
			foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
2373
				if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2374
					// No need to display plugins if they are installed, up-to-date and active.
2375
					continue;
2376
				} else {
2377
					$plugins['all'][ $slug ] = $plugin;
2378
2379
					if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2380
						$plugins['install'][ $slug ] = $plugin;
2381
					} else {
2382
						if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2383
							$plugins['update'][ $slug ] = $plugin;
2384
						}
2385
2386
						if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2387
							$plugins['activate'][ $slug ] = $plugin;
2388
						}
2389
					}
2390
				}
2391
			}
2392
2393
			return $plugins;
2394
		}
2395
2396
		/**
2397
		 * Set the counts for the view links.
2398
		 *
2399
		 * @since 2.5.0
2400
		 *
2401
		 * @param array $plugins Plugins order by view.
2402
		 */
2403
		protected function set_view_totals( $plugins ) {
2404
			foreach ( $plugins as $type => $list ) {
2405
				$this->view_totals[ $type ] = count( $list );
2406
			}
2407
		}
2408
2409
		/**
2410
		 * Get the plugin required/recommended text string.
2411
		 *
2412
		 * @since 2.5.0
2413
		 *
2414
		 * @param string $required Plugin required setting.
2415
		 * @return string
2416
		 */
2417
		protected function get_plugin_advise_type_text( $required ) {
2418
			if ( true === $required ) {
2419
				return __( 'Required', 'tgmpa' );
2420
			}
2421
2422
			return __( 'Recommended', 'tgmpa' );
2423
		}
2424
2425
		/**
2426
		 * Get the plugin source type text string.
2427
		 *
2428
		 * @since 2.5.0
2429
		 *
2430
		 * @param string $type Plugin type.
2431
		 * @return string
2432
		 */
2433
		protected function get_plugin_source_type_text( $type ) {
2434
			$string = '';
2435
2436
			switch ( $type ) {
2437
				case 'repo':
2438
					$string = __( 'WordPress Repository', 'tgmpa' );
2439
					break;
2440
				case 'external':
2441
					$string = __( 'External Source', 'tgmpa' );
2442
					break;
2443
				case 'bundled':
2444
					$string = __( 'Pre-Packaged', 'tgmpa' );
2445
					break;
2446
			}
2447
2448
			return $string;
2449
		}
2450
2451
		/**
2452
		 * Determine the plugin status message.
2453
		 *
2454
		 * @since 2.5.0
2455
		 *
2456
		 * @param string $slug Plugin slug.
2457
		 * @return string
2458
		 */
2459
		protected function get_plugin_status_text( $slug ) {
2460
			if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2461
				return __( 'Not Installed', 'tgmpa' );
2462
			}
2463
2464
			if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
2465
				$install_status = __( 'Installed But Not Activated', 'tgmpa' );
2466
			} else {
2467
				$install_status = __( 'Active', 'tgmpa' );
2468
			}
2469
2470
			$update_status = '';
2471
2472
			if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2473
				$update_status = __( 'Required Update not Available', 'tgmpa' );
2474
2475
			} elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
2476
				$update_status = __( 'Requires Update', 'tgmpa' );
2477
2478
			} elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2479
				$update_status = __( 'Update recommended', 'tgmpa' );
2480
			}
2481
2482
			if ( '' === $update_status ) {
2483
				return $install_status;
2484
			}
2485
2486
			return sprintf(
2487
				/* translators: 1: install status, 2: update status */
2488
				_x( '%1$s, %2$s', 'Install/Update Status', 'tgmpa' ),
2489
				$install_status,
2490
				$update_status
2491
			);
2492
		}
2493
2494
		/**
2495
		 * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
2496
		 *
2497
		 * @since 2.5.0
2498
		 *
2499
		 * @param array $items Prepared table items.
2500
		 * @return array Sorted table items.
2501
		 */
2502
		public function sort_table_items( $items ) {
2503
			$type = array();
2504
			$name = array();
2505
2506
			foreach ( $items as $i => $plugin ) {
2507
				$type[ $i ] = $plugin['type']; // Required / recommended.
2508
				$name[ $i ] = $plugin['sanitized_plugin'];
2509
			}
2510
2511
			array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
2512
2513
			return $items;
2514
		}
2515
2516
		/**
2517
		 * Get an associative array ( id => link ) of the views available on this table.
2518
		 *
2519
		 * @since 2.5.0
2520
		 *
2521
		 * @return array
2522
		 */
2523
		public function get_views() {
2524
			$status_links = array();
2525
2526
			foreach ( $this->view_totals as $type => $count ) {
2527
				if ( $count < 1 ) {
2528
					continue;
2529
				}
2530
2531
				switch ( $type ) {
2532
					case 'all':
2533
						/* translators: 1: number of plugins. */
2534
						$text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
2535
						break;
2536
					case 'install':
2537
						/* translators: 1: number of plugins. */
2538
						$text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
2539
						break;
2540
					case 'update':
2541
						/* translators: 1: number of plugins. */
2542
						$text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
2543
						break;
2544
					case 'activate':
2545
						/* translators: 1: number of plugins. */
2546
						$text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
2547
						break;
2548
					default:
2549
						$text = '';
2550
						break;
2551
				}
2552
2553
				if ( ! empty( $text ) ) {
2554
2555
					$status_links[ $type ] = sprintf(
2556
						'<a href="%s"%s>%s</a>',
2557
						esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
2558
						( $type === $this->view_context ) ? ' class="current"' : '',
2559
						sprintf( $text, number_format_i18n( $count ) )
2560
					);
2561
				}
2562
			}
2563
2564
			return $status_links;
2565
		}
2566
2567
		/**
2568
		 * Create default columns to display important plugin information
2569
		 * like type, action and status.
2570
		 *
2571
		 * @since 2.2.0
2572
		 *
2573
		 * @param array  $item        Array of item data.
2574
		 * @param string $column_name The name of the column.
2575
		 * @return string
2576
		 */
2577
		public function column_default( $item, $column_name ) {
2578
			return $item[ $column_name ];
2579
		}
2580
2581
		/**
2582
		 * Required for bulk installing.
2583
		 *
2584
		 * Adds a checkbox for each plugin.
2585
		 *
2586
		 * @since 2.2.0
2587
		 *
2588
		 * @param array $item Array of item data.
2589
		 * @return string The input checkbox with all necessary info.
2590
		 */
2591
		public function column_cb( $item ) {
2592
			return sprintf(
2593
				'<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
2594
				esc_attr( $this->_args['singular'] ),
2595
				esc_attr( $item['slug'] ),
2596
				esc_attr( $item['sanitized_plugin'] )
2597
			);
2598
		}
2599
2600
		/**
2601
		 * Create default title column along with the action links.
2602
		 *
2603
		 * @since 2.2.0
2604
		 *
2605
		 * @param array $item Array of item data.
2606
		 * @return string The plugin name and action links.
2607
		 */
2608
		public function column_plugin( $item ) {
2609
			return sprintf(
2610
				'%1$s %2$s',
2611
				$item['plugin'],
2612
				$this->row_actions( $this->get_row_actions( $item ), true )
2613
			);
2614
		}
2615
2616
		/**
2617
		 * Create version information column.
2618
		 *
2619
		 * @since 2.5.0
2620
		 *
2621
		 * @param array $item Array of item data.
2622
		 * @return string HTML-formatted version information.
2623
		 */
2624
		public function column_version( $item ) {
2625
			$output = array();
2626
2627
			if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2628
				$installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
2629
2630
				$color = '';
2631
				if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
2632
					$color = ' color: #ff0000; font-weight: bold;';
2633
				}
2634
2635
				$output[] = sprintf(
2636
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
2637
					$color,
2638
					$installed
2639
				);
2640
			}
2641
2642
			if ( ! empty( $item['minimum_version'] ) ) {
2643
				$output[] = sprintf(
2644
					'<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
2645
					$item['minimum_version']
2646
				);
2647
			}
2648
2649
			if ( ! empty( $item['available_version'] ) ) {
2650
				$color = '';
2651
				if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
2652
					$color = ' color: #71C671; font-weight: bold;';
2653
				}
2654
2655
				$output[] = sprintf(
2656
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
2657
					$color,
2658
					$item['available_version']
2659
				);
2660
			}
2661
2662
			if ( empty( $output ) ) {
2663
				return '&nbsp;'; // Let's not break the table layout.
2664
			} else {
2665
				return implode( "\n", $output );
2666
			}
2667
		}
2668
2669
		/**
2670
		 * Sets default message within the plugins table if no plugins
2671
		 * are left for interaction.
2672
		 *
2673
		 * Hides the menu item to prevent the user from clicking and
2674
		 * getting a permissions error.
2675
		 *
2676
		 * @since 2.2.0
2677
		 */
2678
		public function no_items() {
2679
			echo esc_html__( 'No plugins to install, update or activate.', 'tgmpa' ) . ' <a href="' . esc_url( self_admin_url() ) . '"> ' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>';
2680
			echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
2681
		}
2682
2683
		/**
2684
		 * Output all the column information within the table.
2685
		 *
2686
		 * @since 2.2.0
2687
		 *
2688
		 * @return array $columns The column names.
2689
		 */
2690
		public function get_columns() {
2691
			$columns = array(
2692
				'cb'     => '<input type="checkbox" />',
2693
				'plugin' => __( 'Plugin', 'tgmpa' ),
2694
				'source' => __( 'Source', 'tgmpa' ),
2695
				'type'   => __( 'Type', 'tgmpa' ),
2696
			);
2697
2698
			if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
2699
				$columns['version'] = __( 'Version', 'tgmpa' );
2700
				$columns['status']  = __( 'Status', 'tgmpa' );
2701
			}
2702
2703
			return apply_filters( 'tgmpa_table_columns', $columns );
2704
		}
2705
2706
		/**
2707
		 * Get name of default primary column
2708
		 *
2709
		 * @since 2.5.0 / WP 4.3+ compatibility
2710
		 * @access protected
2711
		 *
2712
		 * @return string
2713
		 */
2714
		protected function get_default_primary_column_name() {
2715
			return 'plugin';
2716
		}
2717
2718
		/**
2719
		 * Get the name of the primary column.
2720
		 *
2721
		 * @since 2.5.0 / WP 4.3+ compatibility
2722
		 * @access protected
2723
		 *
2724
		 * @return string The name of the primary column.
2725
		 */
2726
		protected function get_primary_column_name() {
2727
			if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
2728
				return parent::get_primary_column_name();
2729
			} else {
2730
				return $this->get_default_primary_column_name();
2731
			}
2732
		}
2733
2734
		/**
2735
		 * Get the actions which are relevant for a specific plugin row.
2736
		 *
2737
		 * @since 2.5.0
2738
		 *
2739
		 * @param array $item Array of item data.
2740
		 * @return array Array with relevant action links.
2741
		 */
2742
		protected function get_row_actions( $item ) {
2743
			$actions      = array();
2744
			$action_links = array();
2745
2746
			// Display the 'Install' action link if the plugin is not yet available.
2747
			if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2748
				/* translators: %s: plugin name in screen reader markup */
2749
				$actions['install'] = __( 'Install %s', 'tgmpa' );
2750
			} else {
2751
				// Display the 'Update' action link if an update is available and WP complies with plugin minimum.
2752
				if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
2753
					/* translators: %s: plugin name in screen reader markup */
2754
					$actions['update'] = __( 'Update %s', 'tgmpa' );
2755
				}
2756
2757
				// Display the 'Activate' action link, but only if the plugin meets the minimum version.
2758
				if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
2759
					/* translators: %s: plugin name in screen reader markup */
2760
					$actions['activate'] = __( 'Activate %s', 'tgmpa' );
2761
				}
2762
			}
2763
2764
			// Create the actual links.
2765
			foreach ( $actions as $action => $text ) {
2766
				$nonce_url = wp_nonce_url(
2767
					add_query_arg(
2768
						array(
2769
							'plugin'           => urlencode( $item['slug'] ),
2770
							'tgmpa-' . $action => $action . '-plugin',
2771
						),
2772
						$this->tgmpa->get_tgmpa_url()
2773
					),
2774
					'tgmpa-' . $action,
2775
					'tgmpa-nonce'
2776
				);
2777
2778
				$action_links[ $action ] = sprintf(
2779
					'<a href="%1$s">' . esc_html( $text ) . '</a>',
2780
					esc_url( $nonce_url ),
2781
					'<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
2782
				);
2783
			}
2784
2785
			$prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
2786
			return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
2787
		}
2788
2789
		/**
2790
		 * Generates content for a single row of the table.
2791
		 *
2792
		 * @since 2.5.0
2793
		 *
2794
		 * @param object $item The current item.
2795
		 */
2796
		public function single_row( $item ) {
2797
			parent::single_row( $item );
2798
2799
			/**
2800
			 * Fires after each specific row in the TGMPA Plugins list table.
2801
			 *
2802
			 * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
2803
			 * for the plugin.
2804
			 *
2805
			 * @since 2.5.0
2806
			 */
2807
			do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
2808
		}
2809
2810
		/**
2811
		 * Show the upgrade notice below a plugin row if there is one.
2812
		 *
2813
		 * @since 2.5.0
2814
		 *
2815
		 * @see /wp-admin/includes/update.php
2816
		 *
2817
		 * @param string $slug Plugin slug.
2818
		 * @param array  $item The information available in this table row.
2819
		 * @return null Return early if upgrade notice is empty.
2820
		 */
2821
		public function wp_plugin_update_row( $slug, $item ) {
2822
			if ( empty( $item['upgrade_notice'] ) ) {
2823
				return;
2824
			}
2825
2826
			echo '
2827
				<tr class="plugin-update-tr">
2828
					<td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
2829
						<div class="update-message">',
2830
							esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
2831
							' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
2832
						</div>
2833
					</td>
2834
				</tr>';
2835
		}
2836
2837
		/**
2838
		 * Extra controls to be displayed between bulk actions and pagination.
2839
		 *
2840
		 * @since 2.5.0
2841
		 *
2842
		 * @param string $which 'top' or 'bottom' table navigation.
2843
		 */
2844
		public function extra_tablenav( $which ) {
2845
			if ( 'bottom' === $which ) {
2846
				$this->tgmpa->show_tgmpa_version();
2847
			}
2848
		}
2849
2850
		/**
2851
		 * Defines the bulk actions for handling registered plugins.
2852
		 *
2853
		 * @since 2.2.0
2854
		 *
2855
		 * @return array $actions The bulk actions for the plugin install table.
2856
		 */
2857
		public function get_bulk_actions() {
2858
2859
			$actions = array();
2860
2861
			if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
2862
				if ( current_user_can( 'install_plugins' ) ) {
2863
					$actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
2864
				}
2865
			}
2866
2867
			if ( 'install' !== $this->view_context ) {
2868
				if ( current_user_can( 'update_plugins' ) ) {
2869
					$actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
2870
				}
2871
				if ( current_user_can( 'activate_plugins' ) ) {
2872
					$actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
2873
				}
2874
			}
2875
2876
			return $actions;
2877
		}
2878
2879
		/**
2880
		 * Processes bulk installation and activation actions.
2881
		 *
2882
		 * The bulk installation process looks for the $_POST information and passes that
2883
		 * through if a user has to use WP_Filesystem to enter their credentials.
2884
		 *
2885
		 * @since 2.2.0
2886
		 */
2887
		public function process_bulk_actions() {
2888
			// Bulk installation process.
2889
			if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
2890
2891
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2892
2893
				$install_type = 'install';
2894
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2895
					$install_type = 'update';
2896
				}
2897
2898
				$plugins_to_install = array();
2899
2900
				// Did user actually select any plugins to install/update ?
2901 View Code Duplication
				if ( empty( $_POST['plugin'] ) ) {
2902
					if ( 'install' === $install_type ) {
2903
						$message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
2904
					} else {
2905
						$message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
2906
					}
2907
2908
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2909
2910
					return false;
2911
				}
2912
2913
				if ( is_array( $_POST['plugin'] ) ) {
2914
					$plugins_to_install = (array) $_POST['plugin'];
2915
				} elseif ( is_string( $_POST['plugin'] ) ) {
2916
					// Received via Filesystem page - un-flatten array (WP bug #19643).
2917
					$plugins_to_install = explode( ',', $_POST['plugin'] );
2918
				}
2919
2920
				// Sanitize the received input.
2921
				$plugins_to_install = array_map( 'urldecode', $plugins_to_install );
2922
				$plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
2923
2924
				// Validate the received input.
2925
				foreach ( $plugins_to_install as $key => $slug ) {
2926
					// Check if the plugin was registered with TGMPA and remove if not.
2927
					if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
2928
						unset( $plugins_to_install[ $key ] );
2929
						continue;
2930
					}
2931
2932
					// For install: make sure this is a plugin we *can* install and not one already installed.
2933
					if ( 'install' === $install_type && true === $this->tgmpa->is_plugin_installed( $slug ) ) {
2934
						unset( $plugins_to_install[ $key ] );
2935
					}
2936
2937
					// For updates: make sure this is a plugin we *can* update (update available and WP version ok).
2938
					if ( 'update' === $install_type && false === $this->tgmpa->is_plugin_updatetable( $slug ) ) {
2939
						unset( $plugins_to_install[ $key ] );
2940
					}
2941
				}
2942
2943
				// No need to proceed further if we have no plugins to handle.
2944 View Code Duplication
				if ( empty( $plugins_to_install ) ) {
2945
					if ( 'install' === $install_type ) {
2946
						$message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
2947
					} else {
2948
						$message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
2949
					}
2950
2951
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2952
2953
					return false;
2954
				}
2955
2956
				// Pass all necessary information if WP_Filesystem is needed.
2957
				$url = wp_nonce_url(
2958
					$this->tgmpa->get_tgmpa_url(),
2959
					'bulk-' . $this->_args['plural']
2960
				);
2961
2962
				// Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
2963
				$_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
2964
2965
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
2966
				$fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
2967
2968
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields ) ) ) {
2969
					return true; // Stop the normal page form from displaying, credential request form will be shown.
2970
				}
2971
2972
				// Now we have some credentials, setup WP_Filesystem.
2973
				if ( ! WP_Filesystem( $creds ) ) {
2974
					// Our credentials were no good, ask the user for them again.
2975
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
2976
2977
					return true;
2978
				}
2979
2980
				/* If we arrive here, we have the filesystem */
2981
2982
				// Store all information in arrays since we are processing a bulk installation.
2983
				$names      = array();
2984
				$sources    = array(); // Needed for installs.
2985
				$file_paths = array(); // Needed for upgrades.
2986
				$to_inject  = array(); // Information to inject into the update_plugins transient.
2987
2988
				// Prepare the data for validated plugins for the install/upgrade.
2989
				foreach ( $plugins_to_install as $slug ) {
2990
					$name   = $this->tgmpa->plugins[ $slug ]['name'];
2991
					$source = $this->tgmpa->get_download_url( $slug );
2992
2993
					if ( ! empty( $name ) && ! empty( $source ) ) {
2994
						$names[] = $name;
2995
2996
						switch ( $install_type ) {
2997
2998
							case 'install':
2999
								$sources[] = $source;
3000
								break;
3001
3002
							case 'update':
3003
								$file_paths[]                 = $this->tgmpa->plugins[ $slug ]['file_path'];
3004
								$to_inject[ $slug ]           = $this->tgmpa->plugins[ $slug ];
3005
								$to_inject[ $slug ]['source'] = $source;
3006
								break;
3007
						}
3008
					}
3009
				}
3010
				unset( $slug, $name, $source );
3011
3012
				// Create a new instance of TGMPA_Bulk_Installer.
3013
				$installer = new TGMPA_Bulk_Installer(
3014
					new TGMPA_Bulk_Installer_Skin(
3015
						array(
3016
							'url'          => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
3017
							'nonce'        => 'bulk-' . $this->_args['plural'],
3018
							'names'        => $names,
3019
							'install_type' => $install_type,
3020
						)
3021
					)
3022
				);
3023
3024
				// Wrap the install process with the appropriate HTML.
3025
				echo '<div class="tgmpa">',
3026
					'<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>
3027
					<div class="update-php" style="width: 100%; height: 98%; min-height: 850px; padding-top: 1px;">';
3028
3029
				// Process the bulk installation submissions.
3030
				add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
3031
3032
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
3033
					// Inject our info into the update transient.
3034
					$this->tgmpa->inject_update_info( $to_inject );
3035
3036
					$installer->bulk_upgrade( $file_paths );
3037
				} else {
3038
					$installer->bulk_install( $sources );
3039
				}
3040
3041
				remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1 );
3042
3043
				echo '</div></div>';
3044
3045
				return true;
3046
			}
3047
3048
			// Bulk activation process.
3049
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3050
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
3051
3052
				// Did user actually select any plugins to activate ?
3053
				if ( empty( $_POST['plugin'] ) ) {
3054
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
3055
3056
					return false;
3057
				}
3058
3059
				// Grab plugin data from $_POST.
3060
				$plugins = array();
3061
				if ( isset( $_POST['plugin'] ) ) {
3062
					$plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
3063
					$plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
3064
				}
3065
3066
				$plugins_to_activate = array();
3067
				$plugin_names        = array();
3068
3069
				// Grab the file paths for the selected & inactive plugins from the registration array.
3070
				foreach ( $plugins as $slug ) {
3071
					if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
3072
						$plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
3073
						$plugin_names[]        = $this->tgmpa->plugins[ $slug ]['name'];
3074
					}
3075
				}
3076
				unset( $slug );
3077
3078
				// Return early if there are no plugins to activate.
3079
				if ( empty( $plugins_to_activate ) ) {
3080
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
3081
3082
					return false;
3083
				}
3084
3085
				// Now we are good to go - let's start activating plugins.
3086
				$activate = activate_plugins( $plugins_to_activate );
3087
3088
				if ( is_wp_error( $activate ) ) {
3089
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
3090
				} else {
3091
					$count        = count( $plugin_names ); // Count so we can use _n function.
3092
					$plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
3093
					$last_plugin  = array_pop( $plugin_names ); // Pop off last name to prep for readability.
3094
					$imploded     = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
3095
3096
					printf( // WPCS: xss ok.
3097
						'<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
3098
						esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
3099
						$imploded
3100
					);
3101
3102
					// Update recently activated plugins option.
3103
					$recent = (array) get_option( 'recently_activated' );
3104
					foreach ( $plugins_to_activate as $plugin => $time ) {
3105
						if ( isset( $recent[ $plugin ] ) ) {
3106
							unset( $recent[ $plugin ] );
3107
						}
3108
					}
3109
					update_option( 'recently_activated', $recent );
3110
				}
3111
3112
				unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
3113
3114
				return true;
3115
			}
3116
3117
			return false;
3118
		}
3119
3120
		/**
3121
		 * Prepares all of our information to be outputted into a usable table.
3122
		 *
3123
		 * @since 2.2.0
3124
		 */
3125
		public function prepare_items() {
3126
			$columns               = $this->get_columns(); // Get all necessary column information.
3127
			$hidden                = array(); // No columns to hide, but we must set as an array.
3128
			$sortable              = array(); // No reason to make sortable columns.
3129
			$primary               = $this->get_primary_column_name(); // Column which has the row actions.
3130
			$this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
3131
3132
			// Process our bulk activations here.
3133
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3134
				$this->process_bulk_actions();
3135
			}
3136
3137
			// Store all of our plugin data into $items array so WP_List_Table can use it.
3138
			$this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
3139
		}
3140
3141
		/* *********** DEPRECATED METHODS *********** */
3142
3143
		/**
3144
		 * Retrieve plugin data, given the plugin name.
3145
		 *
3146
		 * @since      2.2.0
3147
		 * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
3148
		 * @see        TGM_Plugin_Activation::_get_plugin_data_from_name()
3149
		 *
3150
		 * @param string $name Name of the plugin, as it was registered.
3151
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
3152
		 * @return string|boolean Plugin slug if found, false otherwise.
3153
		 */
3154
		protected function _get_plugin_data_from_name( $name, $data = 'slug' ) {
3155
			_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
3156
3157
			return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
3158
		}
3159
	}
3160
}
3161
3162
3163
if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
3164
3165
	/**
3166
	 * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
3167
	 */
3168
	class TGM_Bulk_Installer {
3169
	}
3170
}
3171
if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
3172
3173
	/**
3174
	 * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
3175
	 */
3176
	class TGM_Bulk_Installer_Skin {
3177
	}
3178
}
3179
3180
/**
3181
 * The WP_Upgrader file isn't always available. If it isn't available,
3182
 * we load it here.
3183
 *
3184
 * We check to make sure no action or activation keys are set so that WordPress
3185
 * does not try to re-include the class when processing upgrades or installs outside
3186
 * of the class.
3187
 *
3188
 * @since 2.2.0
3189
 */
3190
add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
3191
if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
3192
	/**
3193
	 * Load bulk installer
3194
	 */
3195
	function tgmpa_load_bulk_installer() {
3196
		// Silently fail if 2.5+ is loaded *after* an older version.
3197
		if ( ! isset( $GLOBALS['tgmpa'] ) ) {
3198
			return;
3199
		}
3200
3201
		// Get TGMPA class instance.
3202
		$tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3203
3204
		if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
3205
			if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
3206
				require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
3207
			}
3208
3209
			if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
3210
3211
				/**
3212
				 * Installer class to handle bulk plugin installations.
3213
				 *
3214
				 * Extends WP_Upgrader and customizes to suit the installation of multiple
3215
				 * plugins.
3216
				 *
3217
				 * @since 2.2.0
3218
				 *
3219
				 * {@internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader.}}
3220
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
3221
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3222
				 *
3223
				 * @package TGM-Plugin-Activation
3224
				 * @author  Thomas Griffin
3225
				 * @author  Gary Jones
3226
				 */
3227
				class TGMPA_Bulk_Installer extends Plugin_Upgrader {
3228
					/**
3229
					 * Holds result of bulk plugin installation.
3230
					 *
3231
					 * @since 2.2.0
3232
					 *
3233
					 * @var string
3234
					 */
3235
					public $result;
3236
3237
					/**
3238
					 * Flag to check if bulk installation is occurring or not.
3239
					 *
3240
					 * @since 2.2.0
3241
					 *
3242
					 * @var boolean
3243
					 */
3244
					public $bulk = false;
3245
3246
					/**
3247
					 * TGMPA instance
3248
					 *
3249
					 * @since 2.5.0
3250
					 *
3251
					 * @var object
3252
					 */
3253
					protected $tgmpa;
3254
3255
					/**
3256
					 * Whether or not the destination directory needs to be cleared ( = on update).
3257
					 *
3258
					 * @since 2.5.0
3259
					 *
3260
					 * @var bool
3261
					 */
3262
					protected $clear_destination = false;
3263
3264
					/**
3265
					 * References parent constructor and sets defaults for class.
3266
					 *
3267
					 * @since 2.2.0
3268
					 *
3269
					 * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
3270
					 */
3271
					public function __construct( $skin = null ) {
3272
						// Get TGMPA class instance.
3273
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3274
3275
						parent::__construct( $skin );
3276
3277
						if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
3278
							$this->clear_destination = true;
3279
						}
3280
3281
						if ( $this->tgmpa->is_automatic ) {
3282
							$this->activate_strings();
3283
						}
3284
3285
						add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
3286
					}
3287
3288
					/**
3289
					 * Sets the correct activation strings for the installer skin to use.
3290
					 *
3291
					 * @since 2.2.0
3292
					 */
3293
					public function activate_strings() {
3294
						$this->strings['activation_failed']  = __( 'Plugin activation failed.', 'tgmpa' );
3295
						$this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
3296
					}
3297
3298
					/**
3299
					 * Performs the actual installation of each plugin.
3300
					 *
3301
					 * @since 2.2.0
3302
					 *
3303
					 * @see WP_Upgrader::run()
3304
					 *
3305
					 * @param array $options The installation config options.
3306
					 * @return null|array Return early if error, array of installation data on success.
3307
					 */
3308
					public function run( $options ) {
3309
						$result = parent::run( $options );
3310
3311
						// Reset the strings in case we changed one during automatic activation.
3312
						if ( $this->tgmpa->is_automatic ) {
3313
							if ( 'update' === $this->skin->options['install_type'] ) {
3314
								$this->upgrade_strings();
3315
							} else {
3316
								$this->install_strings();
3317
							}
3318
						}
3319
3320
						return $result;
3321
					}
3322
3323
					/**
3324
					 * Processes the bulk installation of plugins.
3325
					 *
3326
					 * @since 2.2.0
3327
					 *
3328
					 * {@internal This is basically a near identical copy of the WP Core
3329
					 * Plugin_Upgrader::bulk_upgrade() method, with minor adjustments to deal with
3330
					 * new installs instead of upgrades.
3331
					 * For ease of future synchronizations, the adjustments are clearly commented, but no other
3332
					 * comments are added. Code style has been made to comply.}}
3333
					 *
3334
					 * @see Plugin_Upgrader::bulk_upgrade()
3335
					 * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
3336
					 * (@internal Last synced: Dec 31st 2015 against https://core.trac.wordpress.org/browser/trunk?rev=36134}}
3337
					 *
3338
					 * @param array $plugins The plugin sources needed for installation.
3339
					 * @param array $args    Arbitrary passed extra arguments.
3340
					 * @return array|false   Install confirmation messages on success, false on failure.
3341
					 */
3342
					public function bulk_install( $plugins, $args = array() ) {
3343
						// [TGMPA + ] Hook auto-activation in.
3344
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3345
3346
						$defaults    = array(
3347
							'clear_update_cache' => true,
3348
						);
3349
						$parsed_args = wp_parse_args( $args, $defaults );
3350
3351
						$this->init();
3352
						$this->bulk = true;
3353
3354
						$this->install_strings(); // [TGMPA + ] adjusted.
3355
3356
						/* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
3357
3358
						/* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
3359
3360
						$this->skin->header();
3361
3362
						// Connect to the Filesystem first.
3363
						$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
3364
						if ( ! $res ) {
3365
							$this->skin->footer();
3366
							return false;
3367
						}
3368
3369
						$this->skin->bulk_header();
3370
3371
						/*
3372
						 * Only start maintenance mode if:
3373
						 * - running Multisite and there are one or more plugins specified, OR
3374
						 * - a plugin with an update available is currently active.
3375
						 * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
3376
						 */
3377
						$maintenance = ( is_multisite() && ! empty( $plugins ) );
3378
3379
						/*
3380
						[TGMPA - ]
3381
						foreach ( $plugins as $plugin )
3382
							$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
3383
						*/
3384
						if ( $maintenance ) {
3385
							$this->maintenance_mode( true );
3386
						}
3387
3388
						$results = array();
3389
3390
						$this->update_count   = count( $plugins );
3391
						$this->update_current = 0;
3392
						foreach ( $plugins as $plugin ) {
3393
							$this->update_current++;
3394
3395
							/*
3396
							[TGMPA - ]
3397
							$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
3398
3399
							if ( !isset( $current->response[ $plugin ] ) ) {
3400
								$this->skin->set_result('up_to_date');
3401
								$this->skin->before();
3402
								$this->skin->feedback('up_to_date');
3403
								$this->skin->after();
3404
								$results[$plugin] = true;
3405
								continue;
3406
							}
3407
3408
							// Get the URL to the zip file.
3409
							$r = $current->response[ $plugin ];
3410
3411
							$this->skin->plugin_active = is_plugin_active($plugin);
3412
							*/
3413
3414
							$result = $this->run(
3415
								array(
3416
									'package'           => $plugin, // [TGMPA + ] adjusted.
3417
									'destination'       => WP_PLUGIN_DIR,
3418
									'clear_destination' => false, // [TGMPA + ] adjusted.
3419
									'clear_working'     => true,
3420
									'is_multi'          => true,
3421
									'hook_extra'        => array(
3422
										'plugin' => $plugin,
3423
									),
3424
								)
3425
							);
3426
3427
							$results[ $plugin ] = $this->result;
3428
3429
							// Prevent credentials auth screen from displaying multiple times.
3430
							if ( false === $result ) {
3431
								break;
3432
							}
3433
						} //end foreach $plugins
3434
3435
						$this->maintenance_mode( false );
3436
3437
						/**
3438
						 * Fires when the bulk upgrader process is complete.
3439
						 *
3440
						 * @since WP 3.6.0 / TGMPA 2.5.0
3441
						 *
3442
						 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
3443
						 *                              be a Theme_Upgrader or Core_Upgrade instance.
3444
						 * @param array           $data {
3445
						 *     Array of bulk item update data.
3446
						 *
3447
						 *     @type string $action   Type of action. Default 'update'.
3448
						 *     @type string $type     Type of update process. Accepts 'plugin', 'theme', or 'core'.
3449
						 *     @type bool   $bulk     Whether the update process is a bulk update. Default true.
3450
						 *     @type array  $packages Array of plugin, theme, or core packages to update.
3451
						 * }
3452
						 */
3453
						do_action( 'upgrader_process_complete', $this, array(
3454
							'action'  => 'install', // [TGMPA + ] adjusted.
3455
							'type'    => 'plugin',
3456
							'bulk'    => true,
3457
							'plugins' => $plugins,
3458
						) );
3459
3460
						$this->skin->bulk_footer();
3461
3462
						$this->skin->footer();
3463
3464
						// Cleanup our hooks, in case something else does a upgrade on this connection.
3465
						/* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
3466
3467
						// [TGMPA + ] Remove our auto-activation hook.
3468
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3469
3470
						// Force refresh of plugin update information.
3471
						wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
3472
3473
						return $results;
3474
					}
3475
3476
					/**
3477
					 * Handle a bulk upgrade request.
3478
					 *
3479
					 * @since 2.5.0
3480
					 *
3481
					 * @see Plugin_Upgrader::bulk_upgrade()
3482
					 *
3483
					 * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
3484
					 * @param array $args    Arbitrary passed extra arguments.
3485
					 * @return string|bool Install confirmation messages on success, false on failure.
3486
					 */
3487
					public function bulk_upgrade( $plugins, $args = array() ) {
3488
3489
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3490
3491
						$result = parent::bulk_upgrade( $plugins, $args );
3492
3493
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3494
3495
						return $result;
3496
					}
3497
3498
					/**
3499
					 * Abuse a filter to auto-activate plugins after installation.
3500
					 *
3501
					 * Hooked into the 'upgrader_post_install' filter hook.
3502
					 *
3503
					 * @since 2.5.0
3504
					 *
3505
					 * @param bool $bool The value we need to give back (true).
3506
					 * @return bool
3507
					 */
3508
					public function auto_activate( $bool ) {
3509
						// Only process the activation of installed plugins if the automatic flag is set to true.
3510
						if ( $this->tgmpa->is_automatic ) {
3511
							// Flush plugins cache so the headers of the newly installed plugins will be read correctly.
3512
							wp_clean_plugins_cache();
3513
3514
							// Get the installed plugin file.
3515
							$plugin_info = $this->plugin_info();
3516
3517
							// Don't try to activate on upgrade of active plugin as WP will do this already.
3518
							if ( ! is_plugin_active( $plugin_info ) ) {
3519
								$activate = activate_plugin( $plugin_info );
3520
3521
								// Adjust the success string based on the activation result.
3522
								$this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
3523
3524
								if ( is_wp_error( $activate ) ) {
3525
									$this->skin->error( $activate );
3526
									$this->strings['process_success'] .= $this->strings['activation_failed'];
3527
								} else {
3528
									$this->strings['process_success'] .= $this->strings['activation_success'];
3529
								}
3530
							}
3531
						}
3532
3533
						return $bool;
3534
					}
3535
				}
3536
			}
3537
3538
			if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
3539
3540
				/**
3541
				 * Installer skin to set strings for the bulk plugin installations..
3542
				 *
3543
				 * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
3544
				 * plugins.
3545
				 *
3546
				 * @since 2.2.0
3547
				 *
3548
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
3549
				 *           TGMPA_Bulk_Installer_Skin.
3550
				 *           This was done to prevent backward compatibility issues with v2.3.6.}}
3551
				 *
3552
				 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
3553
				 *
3554
				 * @package TGM-Plugin-Activation
3555
				 * @author  Thomas Griffin
3556
				 * @author  Gary Jones
3557
				 */
3558
				class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
3559
					/**
3560
					 * Holds plugin info for each individual plugin installation.
3561
					 *
3562
					 * @since 2.2.0
3563
					 *
3564
					 * @var array
3565
					 */
3566
					public $plugin_info = array();
3567
3568
					/**
3569
					 * Holds names of plugins that are undergoing bulk installations.
3570
					 *
3571
					 * @since 2.2.0
3572
					 *
3573
					 * @var array
3574
					 */
3575
					public $plugin_names = array();
3576
3577
					/**
3578
					 * Integer to use for iteration through each plugin installation.
3579
					 *
3580
					 * @since 2.2.0
3581
					 *
3582
					 * @var integer
3583
					 */
3584
					public $i = 0;
3585
3586
					/**
3587
					 * TGMPA instance
3588
					 *
3589
					 * @since 2.5.0
3590
					 *
3591
					 * @var object
3592
					 */
3593
					protected $tgmpa;
3594
3595
					/**
3596
					 * Constructor. Parses default args with new ones and extracts them for use.
3597
					 *
3598
					 * @since 2.2.0
3599
					 *
3600
					 * @param array $args Arguments to pass for use within the class.
3601
					 */
3602
					public function __construct( $args = array() ) {
3603
						// Get TGMPA class instance.
3604
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3605
3606
						// Parse default and new args.
3607
						$defaults = array(
3608
							'url'          => '',
3609
							'nonce'        => '',
3610
							'names'        => array(),
3611
							'install_type' => 'install',
3612
						);
3613
						$args     = wp_parse_args( $args, $defaults );
3614
3615
						// Set plugin names to $this->plugin_names property.
3616
						$this->plugin_names = $args['names'];
3617
3618
						// Extract the new args.
3619
						parent::__construct( $args );
3620
					}
3621
3622
					/**
3623
					 * Sets install skin strings for each individual plugin.
3624
					 *
3625
					 * Checks to see if the automatic activation flag is set and uses the
3626
					 * the proper strings accordingly.
3627
					 *
3628
					 * @since 2.2.0
3629
					 */
3630
					public function add_strings() {
3631
						if ( 'update' === $this->options['install_type'] ) {
3632
							parent::add_strings();
3633
							/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3634
							$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3635
						} else {
3636
							/* translators: 1: plugin name, 2: error message. */
3637
							$this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
3638
							/* translators: 1: plugin name. */
3639
							$this->upgrader->strings['skin_update_failed'] = __( 'The installation of %1$s failed.', 'tgmpa' );
3640
3641
							if ( $this->tgmpa->is_automatic ) {
3642
								// Automatic activation strings.
3643
								$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' );
3644
								/* translators: 1: plugin name. */
3645
								$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>';
3646
								$this->upgrader->strings['skin_upgrade_end']       = __( 'All installations and activations have been completed.', 'tgmpa' );
3647
								/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3648
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3649
							} else {
3650
								// Default installation strings.
3651
								$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' );
3652
								/* translators: 1: plugin name. */
3653
								$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>';
3654
								$this->upgrader->strings['skin_upgrade_end']       = __( 'All installations have been completed.', 'tgmpa' );
3655
								/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3656
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3657
							}
3658
						}
3659
					}
3660
3661
					/**
3662
					 * Outputs the header strings and necessary JS before each plugin installation.
3663
					 *
3664
					 * @since 2.2.0
3665
					 *
3666
					 * @param string $title Unused in this implementation.
3667
					 */
3668
					public function before( $title = '' ) {
3669
						if ( empty( $title ) ) {
3670
							$title = esc_html( $this->plugin_names[ $this->i ] );
3671
						}
3672
						parent::before( $title );
3673
					}
3674
3675
					/**
3676
					 * Outputs the footer strings and necessary JS after each plugin installation.
3677
					 *
3678
					 * Checks for any errors and outputs them if they exist, else output
3679
					 * success strings.
3680
					 *
3681
					 * @since 2.2.0
3682
					 *
3683
					 * @param string $title Unused in this implementation.
3684
					 */
3685
					public function after( $title = '' ) {
3686
						if ( empty( $title ) ) {
3687
							$title = esc_html( $this->plugin_names[ $this->i ] );
3688
						}
3689
						parent::after( $title );
3690
3691
						$this->i++;
3692
					}
3693
3694
					/**
3695
					 * Outputs links after bulk plugin installation is complete.
3696
					 *
3697
					 * @since 2.2.0
3698
					 */
3699
					public function bulk_footer() {
3700
						// Serve up the string to say installations (and possibly activations) are complete.
3701
						parent::bulk_footer();
3702
3703
						// Flush plugins cache so we can make sure that the installed plugins list is always up to date.
3704
						wp_clean_plugins_cache();
3705
3706
						$this->tgmpa->show_tgmpa_version();
3707
3708
						// Display message based on if all plugins are now active or not.
3709
						$update_actions = array();
3710
3711
						if ( $this->tgmpa->is_tgmpa_complete() ) {
3712
							// All plugins are active, so we display the complete string and hide the menu to protect users.
3713
							echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
3714
							$update_actions['dashboard'] = sprintf(
3715
								esc_html( $this->tgmpa->strings['complete'] ),
3716
								'<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>'
3717
							);
3718
						} else {
3719
							$update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
3720
						}
3721
3722
						/**
3723
						 * Filter the list of action links available following bulk plugin installs/updates.
3724
						 *
3725
						 * @since 2.5.0
3726
						 *
3727
						 * @param array $update_actions Array of plugin action links.
3728
						 * @param array $plugin_info    Array of information for the last-handled plugin.
3729
						 */
3730
						$update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
3731
3732
						if ( ! empty( $update_actions ) ) {
3733
							$this->feedback( implode( ' | ', (array) $update_actions ) );
3734
						}
3735
					}
3736
3737
					/* *********** DEPRECATED METHODS *********** */
3738
3739
					/**
3740
					 * Flush header output buffer.
3741
					 *
3742
					 * @since      2.2.0
3743
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3744
					 * @see        Bulk_Upgrader_Skin::flush_output()
3745
					 */
3746
					public function before_flush_output() {
3747
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3748
						$this->flush_output();
3749
					}
3750
3751
					/**
3752
					 * Flush footer output buffer and iterate $this->i to make sure the
3753
					 * installation strings reference the correct plugin.
3754
					 *
3755
					 * @since      2.2.0
3756
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3757
					 * @see        Bulk_Upgrader_Skin::flush_output()
3758
					 */
3759
					public function after_flush_output() {
3760
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3761
						$this->flush_output();
3762
						$this->i++;
3763
					}
3764
				}
3765
			}
3766
		}
3767
	}
3768
}
3769
3770
if ( ! class_exists( 'TGMPA_Utils' ) ) {
3771
3772
	/**
3773
	 * Generic utilities for TGMPA.
3774
	 *
3775
	 * All methods are static, poor-dev name-spacing class wrapper.
3776
	 *
3777
	 * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
3778
	 *
3779
	 * @since 2.5.0
3780
	 *
3781
	 * @package TGM-Plugin-Activation
3782
	 * @author  Juliette Reinders Folmer
3783
	 */
3784
	class TGMPA_Utils {
3785
		/**
3786
		 * Whether the PHP filter extension is enabled.
3787
		 *
3788
		 * @see http://php.net/book.filter
3789
		 *
3790
		 * @since 2.5.0
3791
		 *
3792
		 * @static
3793
		 *
3794
		 * @var bool $has_filters True is the extension is enabled.
3795
		 */
3796
		public static $has_filters;
3797
3798
		/**
3799
		 * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
3800
		 *
3801
		 * @since 2.5.0
3802
		 *
3803
		 * @static
3804
		 *
3805
		 * @param string $string Text to be wrapped.
3806
		 * @return string
3807
		 */
3808
		public static function wrap_in_em( $string ) {
3809
			return '<em>' . wp_kses_post( $string ) . '</em>';
3810
		}
3811
3812
		/**
3813
		 * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
3814
		 *
3815
		 * @since 2.5.0
3816
		 *
3817
		 * @static
3818
		 *
3819
		 * @param string $string Text to be wrapped.
3820
		 * @return string
3821
		 */
3822
		public static function wrap_in_strong( $string ) {
3823
			return '<strong>' . wp_kses_post( $string ) . '</strong>';
3824
		}
3825
3826
		/**
3827
		 * Helper function: Validate a value as boolean
3828
		 *
3829
		 * @since 2.5.0
3830
		 *
3831
		 * @static
3832
		 *
3833
		 * @param mixed $value Arbitrary value.
3834
		 * @return bool
3835
		 */
3836
		public static function validate_bool( $value ) {
3837
			if ( ! isset( self::$has_filters ) ) {
3838
				self::$has_filters = extension_loaded( 'filter' );
3839
			}
3840
3841
			if ( self::$has_filters ) {
3842
				return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
3843
			} else {
3844
				return self::emulate_filter_bool( $value );
3845
			}
3846
		}
3847
3848
		/**
3849
		 * Helper function: Cast a value to bool
3850
		 *
3851
		 * @since 2.5.0
3852
		 *
3853
		 * @static
3854
		 *
3855
		 * @param mixed $value Value to cast.
3856
		 * @return bool
3857
		 */
3858
		protected static function emulate_filter_bool( $value ) {
3859
			// @codingStandardsIgnoreStart
3860
			static $true  = array(
3861
				'1',
3862
				'true', 'True', 'TRUE',
3863
				'y', 'Y',
3864
				'yes', 'Yes', 'YES',
3865
				'on', 'On', 'ON',
3866
			);
3867
			static $false = array(
3868
				'0',
3869
				'false', 'False', 'FALSE',
3870
				'n', 'N',
3871
				'no', 'No', 'NO',
3872
				'off', 'Off', 'OFF',
3873
			);
3874
			// @codingStandardsIgnoreEnd
3875
3876
			if ( is_bool( $value ) ) {
3877
				return $value;
3878
			} else if ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
3879
				return (bool) $value;
3880
			} else if ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
3881
				return (bool) $value;
3882
			} else if ( is_string( $value ) ) {
3883
				$value = trim( $value );
3884
				if ( in_array( $value, $true, true ) ) {
3885
					return true;
3886
				} else if ( in_array( $value, $false, true ) ) {
3887
					return false;
3888
				} else {
3889
					return false;
3890
				}
3891
			}
3892
3893
			return false;
3894
		}
3895
	} // End of class TGMPA_Utils
3896
} // End of class_exists wrapper
3897