Completed
Pull Request — develop (#601)
by
unknown
03:00
created

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

Upgrade to new PHP Analysis Engine

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

1
<?php
2
/**
3
 * Plugin installation and activation for WordPress themes.
4
 *
5
 * Please note that this is a drop-in library for a theme or plugin.
6
 * The authors of this library (Thomas, Gary and Juliette) are NOT responsible
7
 * for the support of your plugin or theme. Please contact the plugin
8
 * or theme author for support.
9
 *
10
 * @package   TGM-Plugin-Activation
11
 * @version   2.6.1
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.6.1';
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
		 * @since 2.5.0 the array has the plugin slug as an associative key.
92
		 *
93
		 * @var array
94
		 */
95
		public $plugins = array();
96
97
		/**
98
		 * Holds arrays of plugin names to use to sort the plugins array.
99
		 *
100
		 * @since 2.5.0
101
		 *
102
		 * @var array
103
		 */
104
		protected $sort_order = array();
105
106
		/**
107
		 * Whether any plugins have the 'force_activation' setting set to true.
108
		 *
109
		 * @since 2.5.0
110
		 *
111
		 * @var bool
112
		 */
113
		protected $has_forced_activation = false;
114
115
		/**
116
		 * Whether any plugins have the 'force_deactivation' setting set to true.
117
		 *
118
		 * @since 2.5.0
119
		 *
120
		 * @var bool
121
		 */
122
		protected $has_forced_deactivation = false;
123
124
		/**
125
		 * Name of the unique ID to hash notices.
126
		 *
127
		 * @since 2.4.0
128
		 *
129
		 * @var string
130
		 */
131
		public $id = 'tgmpa';
132
133
		/**
134
		 * Name of the query-string argument for the admin page.
135
		 *
136
		 * @since 1.0.0
137
		 *
138
		 * @var string
139
		 */
140
		protected $menu = 'tgmpa-install-plugins';
141
142
		/**
143
		 * Parent menu file slug.
144
		 *
145
		 * @since 2.5.0
146
		 *
147
		 * @var string
148
		 */
149
		public $parent_slug = 'themes.php';
150
151
		/**
152
		 * Capability needed to view the plugin installation menu item.
153
		 *
154
		 * @since 2.5.0
155
		 *
156
		 * @var string
157
		 */
158
		public $capability = 'edit_theme_options';
159
160
		/**
161
		 * Default absolute path to folder containing bundled plugin zip files.
162
		 *
163
		 * @since 2.0.0
164
		 *
165
		 * @var string Absolute path prefix to zip file location for bundled plugins. Default is empty string.
166
		 */
167
		public $default_path = '';
168
169
		/**
170
		 * Flag to show admin notices or not.
171
		 *
172
		 * @since 2.1.0
173
		 *
174
		 * @var boolean
175
		 */
176
		public $has_notices = true;
177
178
		/**
179
		 * Flag to determine if the user can dismiss the notice nag.
180
		 *
181
		 * @since 2.4.0
182
		 *
183
		 * @var boolean
184
		 */
185
		public $dismissable = true;
186
187
		/**
188
		 * Message to be output above nag notice if dismissable is false.
189
		 *
190
		 * @since 2.4.0
191
		 *
192
		 * @var string
193
		 */
194
		public $dismiss_msg = '';
195
196
		/**
197
		 * Flag to set automatic activation of plugins. Off by default.
198
		 *
199
		 * @since 2.2.0
200
		 *
201
		 * @var boolean
202
		 */
203
		public $is_automatic = false;
204
205
		/**
206
		 * Optional message to display before the plugins table.
207
		 *
208
		 * @since 2.2.0
209
		 *
210
		 * @var string Message filtered by wp_kses_post(). Default is empty string.
211
		 */
212
		public $message = '';
213
214
		/**
215
		 * Holds configurable array of strings.
216
		 *
217
		 * Default values are added in the constructor.
218
		 *
219
		 * @since 2.0.0
220
		 *
221
		 * @var array
222
		 */
223
		public $strings = array();
224
225
		/**
226
		 * Holds the version of WordPress.
227
		 *
228
		 * @since 2.4.0
229
		 *
230
		 * @var int
231
		 */
232
		public $wp_version;
233
234
		/**
235
		 * Holds the hook name for the admin page.
236
		 *
237
		 * @since 2.5.0
238
		 *
239
		 * @var string
240
		 */
241
		public $page_hook;
242
243
		/**
244
		 * Adds a reference of this object to $instance, populates default strings,
245
		 * does the tgmpa_init action hook, and hooks in the interactions to init.
246
		 *
247
		 * {@internal This method should be `protected`, but as too many TGMPA implementations
248
		 * haven't upgraded beyond v2.3.6 yet, this gives backward compatibility issues.
249
		 * Reverted back to public for the time being.}}
250
		 *
251
		 * @since 1.0.0
252
		 *
253
		 * @see TGM_Plugin_Activation::init()
254
		 */
255
		public function __construct() {
256
			// Set the current WordPress version.
257
			$this->wp_version = $GLOBALS['wp_version'];
258
259
			// Announce that the class is ready, and pass the object (for advanced use).
260
			do_action_ref_array( 'tgmpa_init', array( $this ) );
261
262
			/*
263
			 * Load our text domain and allow for overloading the fall-back file.
264
			 *
265
			 * {@internal IMPORTANT! If this code changes, review the regex in the custom TGMPA
266
			 * generator on the website.}}
267
			 */
268
			add_action( 'init', array( $this, 'load_textdomain' ), 5 );
269
			add_filter( 'load_textdomain_mofile', array( $this, 'overload_textdomain_mofile' ), 10, 2 );
270
271
			// When the rest of WP has loaded, kick-start the rest of the class.
272
			add_action( 'init', array( $this, 'init' ) );
273
		}
274
275
		/**
276
		 * Magic method to (not) set protected properties from outside of this class.
277
		 *
278
		 * {@internal hackedihack... There is a serious bug in v2.3.2 - 2.3.6  where the `menu` property
279
		 * is being assigned rather than tested in a conditional, effectively rendering it useless.
280
		 * This 'hack' prevents this from happening.}}
281
		 *
282
		 * @see https://github.com/TGMPA/TGM-Plugin-Activation/blob/2.3.6/tgm-plugin-activation/class-tgm-plugin-activation.php#L1593
283
		 *
284
		 * @since 2.5.2
285
		 *
286
		 * @param string $name  Name of an inaccessible property.
287
		 * @param mixed  $value Value to assign to the property.
288
		 * @return void  Silently fail to set the property when this is tried from outside of this class context.
289
		 *               (Inside this class context, the __set() method if not used as there is direct access.)
290
		 */
291
		public function __set( $name, $value ) {
292
			return;
293
		}
294
295
		/**
296
		 * Magic method to get the value of a protected property outside of this class context.
297
		 *
298
		 * @since 2.5.2
299
		 *
300
		 * @param string $name Name of an inaccessible property.
301
		 * @return mixed The property value.
302
		 */
303
		public function __get( $name ) {
304
			return $this->{$name};
305
		}
306
307
		/**
308
		 * Initialise the interactions between this class and WordPress.
309
		 *
310
		 * Hooks in three new methods for the class: admin_menu, notices and styles.
311
		 *
312
		 * @since 2.0.0
313
		 *
314
		 * @see TGM_Plugin_Activation::admin_menu()
315
		 * @see TGM_Plugin_Activation::notices()
316
		 * @see TGM_Plugin_Activation::styles()
317
		 */
318
		public function init() {
319
			/**
320
			 * By default TGMPA only loads on the WP back-end and not in an Ajax call. Using this filter
321
			 * you can overrule that behaviour.
322
			 *
323
			 * @since 2.5.0
324
			 *
325
			 * @param bool $load Whether or not TGMPA should load.
326
			 *                   Defaults to the return of `is_admin() && ! defined( 'DOING_AJAX' )`.
327
			 */
328
			if ( true !== apply_filters( 'tgmpa_load', ( is_admin() && ! defined( 'DOING_AJAX' ) ) ) ) {
329
				return;
330
			}
331
332
			// Load class strings.
333
			$this->strings = array(
334
				'page_title'                      => __( 'Install Required Plugins', 'tgmpa' ),
335
				'menu_title'                      => __( 'Install Plugins', 'tgmpa' ),
336
				/* translators: %s: plugin name. */
337
				'installing'                      => __( 'Installing Plugin: %s', 'tgmpa' ),
338
				/* translators: %s: plugin name. */
339
				'updating'                        => __( 'Updating Plugin: %s', 'tgmpa' ),
340
				'oops'                            => __( 'Something went wrong with the plugin API.', 'tgmpa' ),
341
				'notice_can_install_required'     => _n_noop(
342
					/* translators: 1: plugin name(s). */
343
					'This theme requires the following plugin: %1$s.',
344
					'This theme requires the following plugins: %1$s.',
345
					'tgmpa'
346
				),
347
				'notice_can_install_recommended'  => _n_noop(
348
					/* translators: 1: plugin name(s). */
349
					'This theme recommends the following plugin: %1$s.',
350
					'This theme recommends the following plugins: %1$s.',
351
					'tgmpa'
352
				),
353
				'notice_ask_to_update'            => _n_noop(
354
					/* translators: 1: plugin name(s). */
355
					'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.',
356
					'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.',
357
					'tgmpa'
358
				),
359
				'notice_ask_to_update_maybe'      => _n_noop(
360
					/* translators: 1: plugin name(s). */
361
					'There is an update available for: %1$s.',
362
					'There are updates available for the following plugins: %1$s.',
363
					'tgmpa'
364
				),
365
				'notice_can_activate_required'    => _n_noop(
366
					/* translators: 1: plugin name(s). */
367
					'The following required plugin is currently inactive: %1$s.',
368
					'The following required plugins are currently inactive: %1$s.',
369
					'tgmpa'
370
				),
371
				'notice_can_activate_recommended' => _n_noop(
372
					/* translators: 1: plugin name(s). */
373
					'The following recommended plugin is currently inactive: %1$s.',
374
					'The following recommended plugins are currently inactive: %1$s.',
375
					'tgmpa'
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
456
		/**
457
		 * Load translations.
458
		 *
459
		 * @since 2.6.0
460
		 *
461
		 * (@internal Uses `load_theme_textdomain()` rather than `load_plugin_textdomain()` to
462
		 * get round the different ways of handling the path and deprecated notices being thrown
463
		 * and such. For plugins, the actual file name will be corrected by a filter.}}
464
		 *
465
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
466
		 * generator on the website.}}
467
		 */
468
		public function load_textdomain() {
469
			if ( is_textdomain_loaded( 'tgmpa' ) ) {
470
				return;
471
			}
472
473
			if ( false !== strpos( __FILE__, WP_PLUGIN_DIR ) || false !== strpos( __FILE__, WPMU_PLUGIN_DIR ) ) {
474
				// Plugin, we'll need to adjust the file name.
475
				add_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10, 2 );
476
				load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
477
				remove_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10 );
478
			} else {
479
				$mofile = untrailingslashit( dirname( __FILE__ ) . '/languages' ) . '/tgmpa-' . get_locale() . '.mo';
480
				load_textdomain( 'tgmpa', $mofile );
481
			}
482
		}
483
484
		/**
485
		 * Correct the .mo file name for (must-use) plugins.
486
		 *
487
		 * Themese use `/path/{locale}.mo` while plugins use `/path/{text-domain}-{locale}.mo`.
488
		 *
489
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
490
		 * generator on the website.}}
491
		 *
492
		 * @since 2.6.0
493
		 *
494
		 * @param string $mofile Full path to the target mofile.
495
		 * @param string $domain The domain for which a language file is being loaded.
496
		 * @return string $mofile
497
		 */
498
		public function correct_plugin_mofile( $mofile, $domain ) {
499
			// Exit early if not our domain (just in case).
500
			if ( 'tgmpa' !== $domain ) {
501
				return $mofile;
502
			}
503
			return preg_replace( '`/([a-z]{2}_[A-Z]{2}.mo)$`', '/tgmpa-$1', $mofile );
504
		}
505
506
		/**
507
		 * Potentially overload the fall-back translation file for the current language.
508
		 *
509
		 * WP, by default since WP 3.7, will load a local translation first and if none
510
		 * can be found, will try and find a translation in the /wp-content/languages/ directory.
511
		 * As this library is theme/plugin agnostic, translation files for TGMPA can exist both
512
		 * in the WP_LANG_DIR /plugins/ subdirectory as well as in the /themes/ subdirectory.
513
		 *
514
		 * This method makes sure both directories are checked.
515
		 *
516
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
517
		 * generator on the website.}}
518
		 *
519
		 * @since 2.6.0
520
		 *
521
		 * @param string $mofile Full path to the target mofile.
522
		 * @param string $domain The domain for which a language file is being loaded.
523
		 * @return string $mofile
524
		 */
525
		public function overload_textdomain_mofile( $mofile, $domain ) {
526
			// Exit early if not our domain, not a WP_LANG_DIR load or if the file exists and is readable.
527
			if ( 'tgmpa' !== $domain || false === strpos( $mofile, WP_LANG_DIR ) || @is_readable( $mofile ) ) {
528
				return $mofile;
529
			}
530
531
			// Current fallback file is not valid, let's try the alternative option.
532
			if ( false !== strpos( $mofile, '/themes/' ) ) {
533
				return str_replace( '/themes/', '/plugins/', $mofile );
534
			} elseif ( false !== strpos( $mofile, '/plugins/' ) ) {
535
				return str_replace( '/plugins/', '/themes/', $mofile );
536
			} else {
537
				return $mofile;
538
			}
539
		}
540
541
		/**
542
		 * Hook in plugin action link filters for the WP native plugins page.
543
		 *
544
		 * - Prevent activation of plugins which don't meet the minimum version requirements.
545
		 * - Prevent deactivation of force-activated plugins.
546
		 * - Add update notice if update available.
547
		 *
548
		 * @since 2.5.0
549
		 */
550
		public function add_plugin_action_link_filters() {
551
			foreach ( $this->plugins as $slug => $plugin ) {
552
				if ( false === $this->can_plugin_activate( $slug ) ) {
553
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_activate' ), 20 );
554
				}
555
556
				if ( true === $plugin['force_activation'] ) {
557
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_deactivate' ), 20 );
558
				}
559
560
				if ( false !== $this->does_plugin_require_update( $slug ) ) {
561
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_update' ), 20 );
562
				}
563
			}
564
		}
565
566
		/**
567
		 * Remove the 'Activate' link on the WP native plugins page if the plugin does not meet the
568
		 * minimum version requirements.
569
		 *
570
		 * @since 2.5.0
571
		 *
572
		 * @param array $actions Action links.
573
		 * @return array
574
		 */
575
		public function filter_plugin_action_links_activate( $actions ) {
576
			unset( $actions['activate'] );
577
578
			return $actions;
579
		}
580
581
		/**
582
		 * Remove the 'Deactivate' link on the WP native plugins page if the plugin has been set to force activate.
583
		 *
584
		 * @since 2.5.0
585
		 *
586
		 * @param array $actions Action links.
587
		 * @return array
588
		 */
589
		public function filter_plugin_action_links_deactivate( $actions ) {
590
			unset( $actions['deactivate'] );
591
592
			return $actions;
593
		}
594
595
		/**
596
		 * Add a 'Requires update' link on the WP native plugins page if the plugin does not meet the
597
		 * minimum version requirements.
598
		 *
599
		 * @since 2.5.0
600
		 *
601
		 * @param array $actions Action links.
602
		 * @return array
603
		 */
604
		public function filter_plugin_action_links_update( $actions ) {
605
			$actions['update'] = sprintf(
606
				'<a href="%1$s" title="%2$s" class="edit">%3$s</a>',
607
				esc_url( $this->get_tgmpa_status_url( 'update' ) ),
608
				esc_attr__( 'This plugin needs to be updated to be compatible with your theme.', 'tgmpa' ),
609
				esc_html__( 'Update Required', 'tgmpa' )
610
			);
611
612
			return $actions;
613
		}
614
615
		/**
616
		 * Handles calls to show plugin information via links in the notices.
617
		 *
618
		 * We get the links in the admin notices to point to the TGMPA page, rather
619
		 * than the typical plugin-install.php file, so we can prepare everything
620
		 * beforehand.
621
		 *
622
		 * WP does not make it easy to show the plugin information in the thickbox -
623
		 * here we have to require a file that includes a function that does the
624
		 * main work of displaying it, enqueue some styles, set up some globals and
625
		 * finally call that function before exiting.
626
		 *
627
		 * Down right easy once you know how...
628
		 *
629
		 * Returns early if not the TGMPA page.
630
		 *
631
		 * @since 2.1.0
632
		 *
633
		 * @global string $tab Used as iframe div class names, helps with styling
634
		 * @global string $body_id Used as the iframe body ID, helps with styling
635
		 *
636
		 * @return null Returns early if not the TGMPA page.
637
		 */
638
		public function admin_init() {
639
			if ( ! $this->is_tgmpa_page() ) {
640
				return;
641
			}
642
643
			if ( isset( $_REQUEST['tab'] ) && 'plugin-information' === $_REQUEST['tab'] ) {
644
				// Needed for install_plugin_information().
645
				require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
646
647
				wp_enqueue_style( 'plugin-install' );
648
649
				global $tab, $body_id;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
650
				$body_id = 'plugin-information';
651
				// @codingStandardsIgnoreStart
652
				$tab     = 'plugin-information';
653
				// @codingStandardsIgnoreEnd
654
655
				install_plugin_information();
656
657
				exit;
658
			}
659
		}
660
661
		/**
662
		 * Enqueue thickbox scripts/styles for plugin info.
663
		 *
664
		 * Thickbox is not automatically included on all admin pages, so we must
665
		 * manually enqueue it for those pages.
666
		 *
667
		 * Thickbox is only loaded if the user has not dismissed the admin
668
		 * notice or if there are any plugins left to install and activate.
669
		 *
670
		 * @since 2.1.0
671
		 */
672
		public function thickbox() {
673
			if ( ! get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) ) {
674
				add_thickbox();
675
			}
676
		}
677
678
		/**
679
		 * Adds submenu page if there are plugin actions to take.
680
		 *
681
		 * This method adds the submenu page letting users know that a required
682
		 * plugin needs to be installed.
683
		 *
684
		 * This page disappears once the plugin has been installed and activated.
685
		 *
686
		 * @since 1.0.0
687
		 *
688
		 * @see TGM_Plugin_Activation::init()
689
		 * @see TGM_Plugin_Activation::install_plugins_page()
690
		 *
691
		 * @return null Return early if user lacks capability to install a plugin.
692
		 */
693
		public function admin_menu() {
694
			// Make sure privileges are correct to see the page.
695
			if ( ! current_user_can( 'install_plugins' ) ) {
696
				return;
697
			}
698
699
			$args = apply_filters(
700
				'tgmpa_admin_menu_args',
701
				array(
702
					'parent_slug' => $this->parent_slug,                     // Parent Menu slug.
703
					'page_title'  => $this->strings['page_title'],           // Page title.
704
					'menu_title'  => $this->strings['menu_title'],           // Menu title.
705
					'capability'  => $this->capability,                      // Capability.
706
					'menu_slug'   => $this->menu,                            // Menu slug.
707
					'function'    => array( $this, 'install_plugins_page' ), // Callback.
708
				)
709
			);
710
711
			$this->add_admin_menu( $args );
712
		}
713
714
		/**
715
		 * Add the menu item.
716
		 *
717
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
718
		 * generator on the website.}}
719
		 *
720
		 * @since 2.5.0
721
		 *
722
		 * @param array $args Menu item configuration.
723
		 */
724
		protected function add_admin_menu( array $args ) {
725
			if ( has_filter( 'tgmpa_admin_menu_use_add_theme_page' ) ) {
726
				_deprecated_function( 'The "tgmpa_admin_menu_use_add_theme_page" filter', '2.5.0', esc_html__( 'Set the parent_slug config variable instead.', 'tgmpa' ) );
727
			}
728
729
			if ( 'themes.php' === $this->parent_slug ) {
730
				$this->page_hook = call_user_func( 'add_theme_page', $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
731
			} else {
732
				$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'] );
733
			}
734
		}
735
736
		/**
737
		 * Echoes plugin installation form.
738
		 *
739
		 * This method is the callback for the admin_menu method function.
740
		 * This displays the admin page and form area where the user can select to install and activate the plugin.
741
		 * Aborts early if we're processing a plugin installation action.
742
		 *
743
		 * @since 1.0.0
744
		 *
745
		 * @return null Aborts early if we're processing a plugin installation action.
746
		 */
747
		public function install_plugins_page() {
748
			// Store new instance of plugin table in object.
749
			$plugin_table = new TGMPA_List_Table;
750
751
			// Return early if processing a plugin installation action.
752
			if ( ( ( 'tgmpa-bulk-install' === $plugin_table->current_action() || 'tgmpa-bulk-update' === $plugin_table->current_action() ) && $plugin_table->process_bulk_actions() ) || $this->do_plugin_install() ) {
753
				return;
754
			}
755
756
			// Force refresh of available plugin information so we'll know about manual updates/deletes.
757
			wp_clean_plugins_cache( false );
758
759
			?>
760
			<div class="tgmpa wrap">
761
				<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
762
				<?php $plugin_table->prepare_items(); ?>
763
764
				<?php
765
				if ( ! empty( $this->message ) && is_string( $this->message ) ) {
766
					echo wp_kses_post( $this->message );
767
				}
768
				?>
769
				<?php $plugin_table->views(); ?>
770
771
				<form id="tgmpa-plugins" action="" method="post">
772
					<input type="hidden" name="tgmpa-page" value="<?php echo esc_attr( $this->menu ); ?>" />
773
					<input type="hidden" name="plugin_status" value="<?php echo esc_attr( $plugin_table->view_context ); ?>" />
774
					<?php $plugin_table->display(); ?>
775
				</form>
776
			</div>
777
			<?php
778
		}
779
780
		/**
781
		 * Installs, updates or activates a plugin depending on the action link clicked by the user.
782
		 *
783
		 * Checks the $_GET variable to see which actions have been
784
		 * passed and responds with the appropriate method.
785
		 *
786
		 * Uses WP_Filesystem to process and handle the plugin installation
787
		 * method.
788
		 *
789
		 * @since 1.0.0
790
		 *
791
		 * @uses WP_Filesystem
792
		 * @uses WP_Error
793
		 * @uses WP_Upgrader
794
		 * @uses Plugin_Upgrader
795
		 * @uses Plugin_Installer_Skin
796
		 * @uses Plugin_Upgrader_Skin
797
		 *
798
		 * @return boolean True on success, false on failure.
799
		 */
800
		protected function do_plugin_install() {
801
			if ( empty( $_GET['plugin'] ) ) {
802
				return false;
803
			}
804
805
			// All plugin information will be stored in an array for processing.
806
			$slug = $this->sanitize_key( urldecode( $_GET['plugin'] ) );
807
808
			if ( ! isset( $this->plugins[ $slug ] ) ) {
809
				return false;
810
			}
811
812
			// Was an install or upgrade action link clicked?
813
			if ( ( isset( $_GET['tgmpa-install'] ) && 'install-plugin' === $_GET['tgmpa-install'] ) || ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) ) {
814
815
				$install_type = 'install';
816
				if ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) {
817
					$install_type = 'update';
818
				}
819
820
				check_admin_referer( 'tgmpa-' . $install_type, 'tgmpa-nonce' );
821
822
				// Pass necessary information via URL if WP_Filesystem is needed.
823
				$url = wp_nonce_url(
824
					add_query_arg(
825
						array(
826
							'plugin'                 => urlencode( $slug ),
827
							'tgmpa-' . $install_type => $install_type . '-plugin',
828
						),
829
						$this->get_tgmpa_url()
830
					),
831
					'tgmpa-' . $install_type,
832
					'tgmpa-nonce'
833
				);
834
835
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
836
837
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, array() ) ) ) {
838
					return true;
839
				}
840
841
				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...
842
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem.
843
					return true;
844
				}
845
846
				/* If we arrive here, we have the filesystem. */
847
848
				// Prep variables for Plugin_Installer_Skin class.
849
				$extra         = array();
850
				$extra['slug'] = $slug; // Needed for potentially renaming of directory name.
851
				$source        = $this->get_download_url( $slug );
852
				$api           = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null;
853
				$api           = ( false !== $api ) ? $api : null;
854
855
				$url = add_query_arg(
856
					array(
857
						'action' => $install_type . '-plugin',
858
						'plugin' => urlencode( $slug ),
859
					),
860
					'update.php'
861
				);
862
863
				if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
864
					require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
865
				}
866
867
				$title     = ( 'update' === $install_type ) ? $this->strings['updating'] : $this->strings['installing'];
868
				$skin_args = array(
869
					'type'   => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload',
870
					'title'  => sprintf( $title, $this->plugins[ $slug ]['name'] ),
871
					'url'    => esc_url_raw( $url ),
872
					'nonce'  => $install_type . '-plugin_' . $slug,
873
					'plugin' => '',
874
					'api'    => $api,
875
					'extra'  => $extra,
876
				);
877
				unset( $title );
878
879
				if ( 'update' === $install_type ) {
880
					$skin_args['plugin'] = $this->plugins[ $slug ]['file_path'];
881
					$skin                = new Plugin_Upgrader_Skin( $skin_args );
882
				} else {
883
					$skin = new Plugin_Installer_Skin( $skin_args );
884
				}
885
886
				// Create a new instance of Plugin_Upgrader.
887
				$upgrader = new Plugin_Upgrader( $skin );
888
889
				// Perform the action and install the plugin from the $source urldecode().
890
				add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
891
892
				if ( 'update' === $install_type ) {
893
					// Inject our info into the update transient.
894
					$to_inject                    = array( $slug => $this->plugins[ $slug ] );
895
					$to_inject[ $slug ]['source'] = $source;
896
					$this->inject_update_info( $to_inject );
897
898
					$upgrader->upgrade( $this->plugins[ $slug ]['file_path'] );
899
				} else {
900
					$upgrader->install( $source );
901
				}
902
903
				remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1 );
904
905
				// Make sure we have the correct file path now the plugin is installed/updated.
906
				$this->populate_file_path( $slug );
907
908
				// Only activate plugins if the config option is set to true and the plugin isn't
909
				// already active (upgrade).
910
				if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) {
911
					$plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method.
912
					if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) {
913
						return true; // Finish execution of the function early as we encountered an error.
914
					}
915
				}
916
917
				$this->show_tgmpa_version();
918
919
				// Display message based on if all plugins are now active or not.
920
				if ( $this->is_tgmpa_complete() ) {
921
					echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>' ), '</p>';
922
					echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
923
				} else {
924
					echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
925
				}
926
927
				return true;
928
			} elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) {
929
				// Activate action link was clicked.
930
				check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' );
931
932
				if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) {
933
					return true; // Finish execution of the function early as we encountered an error.
934
				}
935
			}
936
937
			return false;
938
		}
939
940
		/**
941
		 * Inject information into the 'update_plugins' site transient as WP checks that before running an update.
942
		 *
943
		 * @since 2.5.0
944
		 *
945
		 * @param array $plugins The plugin information for the plugins which are to be updated.
946
		 */
947
		public function inject_update_info( $plugins ) {
948
			$repo_updates = get_site_transient( 'update_plugins' );
949
950
			if ( ! is_object( $repo_updates ) ) {
951
				$repo_updates = new stdClass;
952
			}
953
954
			foreach ( $plugins as $slug => $plugin ) {
955
				$file_path = $plugin['file_path'];
956
957
				if ( empty( $repo_updates->response[ $file_path ] ) ) {
958
					$repo_updates->response[ $file_path ] = new stdClass;
959
				}
960
961
				// We only really need to set package, but let's do all we can in case WP changes something.
962
				$repo_updates->response[ $file_path ]->slug        = $slug;
963
				$repo_updates->response[ $file_path ]->plugin      = $file_path;
964
				$repo_updates->response[ $file_path ]->new_version = $plugin['version'];
965
				$repo_updates->response[ $file_path ]->package     = $plugin['source'];
966
				if ( empty( $repo_updates->response[ $file_path ]->url ) && ! empty( $plugin['external_url'] ) ) {
967
					$repo_updates->response[ $file_path ]->url = $plugin['external_url'];
968
				}
969
			}
970
971
			set_site_transient( 'update_plugins', $repo_updates );
972
		}
973
974
		/**
975
		 * Adjust the plugin directory name if necessary.
976
		 *
977
		 * The final destination directory of a plugin is based on the subdirectory name found in the
978
		 * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this
979
		 * subdirectory name is not the same as the expected slug and the plugin will not be recognized
980
		 * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to
981
		 * the expected plugin slug.
982
		 *
983
		 * @since 2.5.0
984
		 *
985
		 * @param string       $source        Path to upgrade/zip-file-name.tmp/subdirectory/.
986
		 * @param string       $remote_source Path to upgrade/zip-file-name.tmp.
987
		 * @param \WP_Upgrader $upgrader      Instance of the upgrader which installs the plugin.
988
		 * @return string $source
989
		 */
990
		public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
991
			if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) {
992
				return $source;
993
			}
994
995
			// Check for single file plugins.
996
			$source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) );
997
			if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) {
998
				return $source;
999
			}
1000
1001
			// Multi-file plugin, let's see if the directory is correctly named.
1002
			$desired_slug = '';
1003
1004
			// Figure out what the slug is supposed to be.
1005
			if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) {
1006
				$desired_slug = $upgrader->skin->options['extra']['slug'];
1007
			} else {
1008
				// Bulk installer contains less info, so fall back on the info registered here.
1009
				foreach ( $this->plugins as $slug => $plugin ) {
1010
					if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) {
1011
						$desired_slug = $slug;
1012
						break;
1013
					}
1014
				}
1015
				unset( $slug, $plugin );
1016
			}
1017
1018
			if ( ! empty( $desired_slug ) ) {
1019
				$subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
1020
1021
				if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
1022
					$from_path = untrailingslashit( $source );
1023
					$to_path   = trailingslashit( $remote_source ) . $desired_slug;
1024
1025
					if ( true === $GLOBALS['wp_filesystem']->move( $from_path, $to_path ) ) {
1026
						return trailingslashit( $to_path );
1027 View Code Duplication
					} else {
1028
						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 ) );
1029
					}
1030 View Code Duplication
				} elseif ( empty( $subdir_name ) ) {
1031
					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 ) );
1032
				}
1033
			}
1034
1035
			return $source;
1036
		}
1037
1038
		/**
1039
		 * Activate a single plugin and send feedback about the result to the screen.
1040
		 *
1041
		 * @since 2.5.0
1042
		 *
1043
		 * @param string $file_path Path within wp-plugins/ to main plugin file.
1044
		 * @param string $slug      Plugin slug.
1045
		 * @param bool   $automatic Whether this is an automatic activation after an install. Defaults to false.
1046
		 *                          This determines the styling of the output messages.
1047
		 * @return bool False if an error was encountered, true otherwise.
1048
		 */
1049
		protected function activate_single_plugin( $file_path, $slug, $automatic = false ) {
1050
			if ( $this->can_plugin_activate( $slug ) ) {
1051
				$activate = activate_plugin( $file_path );
1052
1053
				if ( is_wp_error( $activate ) ) {
1054
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>',
1055
						'<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
1056
1057
					return false; // End it here if there is an error with activation.
1058
				} else {
1059
					if ( ! $automatic ) {
1060
						// Make sure message doesn't display again if bulk activation is performed
1061
						// immediately after a single activation.
1062
						if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1063
							echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>';
1064
						}
1065
					} else {
1066
						// Simpler message layout for use on the plugin install page.
1067
						echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>';
1068
					}
1069
				}
1070 View Code Duplication
			} elseif ( $this->is_plugin_active( $slug ) ) {
1071
				// No simpler message format provided as this message should never be encountered
1072
				// on the plugin install page.
1073
				echo '<div id="message" class="error"><p>',
1074
					sprintf(
1075
						esc_html( $this->strings['plugin_already_active'] ),
1076
						'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1077
					),
1078
					'</p></div>';
1079
			} elseif ( $this->does_plugin_require_update( $slug ) ) {
1080
				if ( ! $automatic ) {
1081
					// Make sure message doesn't display again if bulk activation is performed
1082
					// immediately after a single activation.
1083 View Code Duplication
					if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1084
						echo '<div id="message" class="error"><p>',
1085
							sprintf(
1086
								esc_html( $this->strings['plugin_needs_higher_version'] ),
1087
								'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1088
							),
1089
							'</p></div>';
1090
					}
1091
				} else {
1092
					// Simpler message layout for use on the plugin install page.
1093
					echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>';
1094
				}
1095
			}
1096
1097
			return true;
1098
		}
1099
1100
		/**
1101
		 * Echoes required plugin notice.
1102
		 *
1103
		 * Outputs a message telling users that a specific plugin is required for
1104
		 * their theme. If appropriate, it includes a link to the form page where
1105
		 * users can install and activate the plugin.
1106
		 *
1107
		 * Returns early if we're on the Install page.
1108
		 *
1109
		 * @since 1.0.0
1110
		 *
1111
		 * @global object $current_screen
1112
		 *
1113
		 * @return null Returns early if we're on the Install page.
1114
		 */
1115
		public function notices() {
1116
			// Remove nag on the install page / Return early if the nag message has been dismissed or user < author.
1117
			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' ) ) ) {
1118
				return;
1119
			}
1120
1121
			// Store for the plugin slugs by message type.
1122
			$message = array();
1123
1124
			// Initialize counters used to determine plurality of action link texts.
1125
			$install_link_count          = 0;
1126
			$update_link_count           = 0;
1127
			$activate_link_count         = 0;
1128
			$total_required_action_count = 0;
1129
1130
			foreach ( $this->plugins as $slug => $plugin ) {
1131
				if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) {
1132
					continue;
1133
				}
1134
1135
				if ( ! $this->is_plugin_installed( $slug ) ) {
1136
					if ( current_user_can( 'install_plugins' ) ) {
1137
						$install_link_count++;
1138
1139
						if ( true === $plugin['required'] ) {
1140
							$message['notice_can_install_required'][] = $slug;
1141
						} else {
1142
							$message['notice_can_install_recommended'][] = $slug;
1143
						}
1144
					}
1145
					if ( true === $plugin['required'] ) {
1146
						$total_required_action_count++;
1147
					}
1148
				} else {
1149
					if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) {
1150
						if ( current_user_can( 'activate_plugins' ) ) {
1151
							$activate_link_count++;
1152
1153
							if ( true === $plugin['required'] ) {
1154
								$message['notice_can_activate_required'][] = $slug;
1155
							} else {
1156
								$message['notice_can_activate_recommended'][] = $slug;
1157
							}
1158
						}
1159
						if ( true === $plugin['required'] ) {
1160
							$total_required_action_count++;
1161
						}
1162
					}
1163
1164
					if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1165
1166
						if ( current_user_can( 'update_plugins' ) ) {
1167
							$update_link_count++;
1168
1169
							if ( $this->does_plugin_require_update( $slug ) ) {
1170
								$message['notice_ask_to_update'][] = $slug;
1171
							} elseif ( false !== $this->does_plugin_have_update( $slug ) ) {
1172
								$message['notice_ask_to_update_maybe'][] = $slug;
1173
							}
1174
						}
1175
						if ( true === $plugin['required'] ) {
1176
							$total_required_action_count++;
1177
						}
1178
					}
1179
				}
1180
			}
1181
			unset( $slug, $plugin );
1182
1183
			// If we have notices to display, we move forward.
1184
			if ( ! empty( $message ) || $total_required_action_count > 0 ) {
1185
				krsort( $message ); // Sort messages.
1186
				$rendered = '';
1187
1188
				// As add_settings_error() wraps the final message in a <p> and as the final message can't be
1189
				// filtered, using <p>'s in our html would render invalid html output.
1190
				$line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n";
1191
1192
				if ( ! current_user_can( 'activate_plugins' ) && ! current_user_can( 'install_plugins' ) && ! current_user_can( 'update_plugins' ) ) {
1193
					$rendered  = esc_html( $this->strings['notice_cannot_install_activate'] ) . ' ' . esc_html( $this->strings['contact_admin'] );
1194
					$rendered .= $this->create_user_action_links_for_notice( 0, 0, 0, $line_template );
1195
				} else {
1196
1197
					// If dismissable is false and a message is set, output it now.
1198
					if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) {
1199
						$rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) );
1200
					}
1201
1202
					// Render the individual message lines for the notice.
1203
					foreach ( $message as $type => $plugin_group ) {
1204
						$linked_plugins = array();
1205
1206
						// Get the external info link for a plugin if one is available.
1207
						foreach ( $plugin_group as $plugin_slug ) {
1208
							$linked_plugins[] = $this->get_info_link( $plugin_slug );
1209
						}
1210
						unset( $plugin_slug );
1211
1212
						$count          = count( $plugin_group );
1213
						$linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins );
1214
						$last_plugin    = array_pop( $linked_plugins ); // Pop off last name to prep for readability.
1215
						$imploded       = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
1216
1217
						$rendered .= sprintf(
1218
							$line_template,
1219
							sprintf(
1220
								translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ),
1221
								$imploded,
1222
								$count
1223
							)
1224
						);
1225
1226
					}
1227
					unset( $type, $plugin_group, $linked_plugins, $count, $last_plugin, $imploded );
1228
1229
					$rendered .= $this->create_user_action_links_for_notice( $install_link_count, $update_link_count, $activate_link_count, $line_template );
1230
				}
1231
1232
				// Register the nag messages and prepare them to be processed.
1233
				add_settings_error( 'tgmpa', 'tgmpa', $rendered, $this->get_admin_notice_class() );
1234
			}
1235
1236
			// Admin options pages already output settings_errors, so this is to avoid duplication.
1237
			if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) {
1238
				$this->display_settings_errors();
1239
			}
1240
		}
1241
1242
		/**
1243
		 * Generate the user action links for the admin notice.
1244
		 *
1245
		 * @since 2.6.0
1246
		 *
1247
		 * @param int $install_count  Number of plugins to install.
1248
		 * @param int $update_count   Number of plugins to update.
1249
		 * @param int $activate_count Number of plugins to activate.
1250
		 * @param int $line_template  Template for the HTML tag to output a line.
1251
		 * @return string Action links.
1252
		 */
1253
		protected function create_user_action_links_for_notice( $install_count, $update_count, $activate_count, $line_template ) {
1254
			// Setup action links.
1255
			$action_links = array(
1256
				'install'  => '',
1257
				'update'   => '',
1258
				'activate' => '',
1259
				'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>' : '',
1260
			);
1261
1262
			$link_template = '<a href="%2$s">%1$s</a>';
1263
1264
			if ( current_user_can( 'install_plugins' ) ) {
1265
				if ( $install_count > 0 ) {
1266
					$action_links['install'] = sprintf(
1267
						$link_template,
1268
						translate_nooped_plural( $this->strings['install_link'], $install_count, 'tgmpa' ),
1269
						esc_url( $this->get_tgmpa_status_url( 'install' ) )
1270
					);
1271
				}
1272
				if ( $update_count > 0 ) {
1273
					$action_links['update'] = sprintf(
1274
						$link_template,
1275
						translate_nooped_plural( $this->strings['update_link'], $update_count, 'tgmpa' ),
1276
						esc_url( $this->get_tgmpa_status_url( 'update' ) )
1277
					);
1278
				}
1279
			}
1280
1281
			if ( current_user_can( 'activate_plugins' ) && $activate_count > 0 ) {
0 ignored issues
show
This code seems to be duplicated across your project.

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

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

Loading history...
1282
				$action_links['activate'] = sprintf(
1283
					$link_template,
1284
					translate_nooped_plural( $this->strings['activate_link'], $activate_count, 'tgmpa' ),
1285
					esc_url( $this->get_tgmpa_status_url( 'activate' ) )
1286
				);
1287
			}
1288
1289
			$action_links = apply_filters( 'tgmpa_notice_action_links', $action_links );
1290
1291
			$action_links = array_filter( (array) $action_links ); // Remove any empty array items.
1292
1293
			if ( ! empty( $action_links ) ) {
1294
				$action_links = sprintf( $line_template, implode( ' | ', $action_links ) );
1295
				return apply_filters( 'tgmpa_notice_rendered_action_links', $action_links );
1296
			} else {
1297
				return '';
1298
			}
1299
		}
1300
1301
		/**
1302
		 * Get admin notice class.
1303
		 *
1304
		 * Work around all the changes to the various admin notice classes between WP 4.4 and 3.7
1305
		 * (lowest supported version by TGMPA).
1306
		 *
1307
		 * @since 2.6.0
1308
		 *
1309
		 * @return string
1310
		 */
1311
		protected function get_admin_notice_class() {
1312
			if ( ! empty( $this->strings['nag_type'] ) ) {
1313
				return sanitize_html_class( strtolower( $this->strings['nag_type'] ) );
1314
			} else {
1315
				if ( version_compare( $this->wp_version, '4.2', '>=' ) ) {
1316
					return 'notice-warning';
1317
				} elseif ( version_compare( $this->wp_version, '4.1', '>=' ) ) {
1318
					return 'notice';
1319
				} else {
1320
					return 'updated';
1321
				}
1322
			}
1323
		}
1324
1325
		/**
1326
		 * Display settings errors and remove those which have been displayed to avoid duplicate messages showing
1327
		 *
1328
		 * @since 2.5.0
1329
		 */
1330
		protected function display_settings_errors() {
1331
			global $wp_settings_errors;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

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