Completed
Pull Request — develop (#521)
by Juliette
04:05 queued 01:41
created

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

Upgrade to new PHP Analysis Engine

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

1
<?php
2
/**
3
 * Plugin installation and activation for WordPress themes.
4
 *
5
 * Please note that this is a drop-in library for a theme or plugin.
6
 * The authors of this library (Thomas, Gary and Juliette) are NOT responsible
7
 * for the support of your plugin or theme. Please contact the plugin
8
 * or theme author for support.
9
 *
10
 * @package   TGM-Plugin-Activation
11
 * @version   2.5.2
12
 * @link      http://tgmpluginactivation.com/
13
 * @author    Thomas Griffin, Gary Jones, Juliette Reinders Folmer
14
 * @copyright Copyright (c) 2011, Thomas Griffin
15
 * @license   GPL-2.0+
16
 */
17
18
/*
19
	Copyright 2011 Thomas Griffin (thomasgriffinmedia.com)
20
21
	This program is free software; you can redistribute it and/or modify
22
	it under the terms of the GNU General Public License, version 2, as
23
	published by the Free Software Foundation.
24
25
	This program is distributed in the hope that it will be useful,
26
	but WITHOUT ANY WARRANTY; without even the implied warranty of
27
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28
	GNU General Public License for more details.
29
30
	You should have received a copy of the GNU General Public License
31
	along with this program; if not, write to the Free Software
32
	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
33
*/
34
35
if ( ! class_exists( 'TGM_Plugin_Activation' ) ) {
36
37
	/**
38
	 * Automatic plugin installation and activation library.
39
	 *
40
	 * Creates a way to automatically install and activate plugins from within themes.
41
	 * The plugins can be either bundled, downloaded from the WordPress
42
	 * Plugin Repository or downloaded from another external source.
43
	 *
44
	 * @since 1.0.0
45
	 *
46
	 * @package TGM-Plugin-Activation
47
	 * @author  Thomas Griffin
48
	 * @author  Gary Jones
49
	 */
50
	class TGM_Plugin_Activation {
51
		/**
52
		 * TGMPA version number.
53
		 *
54
		 * @since 2.5.0
55
		 *
56
		 * @const string Version number.
57
		 */
58
		const TGMPA_VERSION = '2.5.2';
59
60
		/**
61
		 * Regular expression to test if a URL is a WP plugin repo URL.
62
		 *
63
		 * @const string Regex.
64
		 *
65
		 * @since 2.5.0
66
		 */
67
		const WP_REPO_REGEX = '|^http[s]?://wordpress\.org/(?:extend/)?plugins/|';
68
69
		/**
70
		 * Arbitrary regular expression to test if a string starts with a URL.
71
		 *
72
		 * @const string Regex.
73
		 *
74
		 * @since 2.5.0
75
		 */
76
		const IS_URL_REGEX = '|^http[s]?://|';
77
78
		/**
79
		 * Holds a copy of itself, so it can be referenced by the class name.
80
		 *
81
		 * @since 1.0.0
82
		 *
83
		 * @var TGM_Plugin_Activation
84
		 */
85
		public static $instance;
86
87
		/**
88
		 * Holds arrays of plugin details.
89
		 *
90
		 * @since 1.0.0
91
		 *
92
		 * @since 2.5.0 the array has the plugin slug as an associative key.
93
		 *
94
		 * @var array
95
		 */
96
		public $plugins = array();
97
98
		/**
99
		 * Holds arrays of plugin names to use to sort the plugins array.
100
		 *
101
		 * @since 2.5.0
102
		 *
103
		 * @var array
104
		 */
105
		protected $sort_order = array();
106
107
		/**
108
		 * Whether any plugins have the 'force_activation' setting set to true.
109
		 *
110
		 * @since 2.5.0
111
		 *
112
		 * @var bool
113
		 */
114
		protected $has_forced_activation = false;
115
116
		/**
117
		 * Whether any plugins have the 'force_deactivation' setting set to true.
118
		 *
119
		 * @since 2.5.0
120
		 *
121
		 * @var bool
122
		 */
123
		protected $has_forced_deactivation = false;
124
125
		/**
126
		 * Name of the unique ID to hash notices.
127
		 *
128
		 * @since 2.4.0
129
		 *
130
		 * @var string
131
		 */
132
		public $id = 'tgmpa';
133
134
		/**
135
		 * Name of the query-string argument for the admin page.
136
		 *
137
		 * @since 1.0.0
138
		 *
139
		 * @var string
140
		 */
141
		protected $menu = 'tgmpa-install-plugins';
142
143
		/**
144
		 * Parent menu file slug.
145
		 *
146
		 * @since 2.5.0
147
		 *
148
		 * @var string
149
		 */
150
		public $parent_slug = 'themes.php';
151
152
		/**
153
		 * Capability needed to view the plugin installation menu item.
154
		 *
155
		 * @since 2.5.0
156
		 *
157
		 * @var string
158
		 */
159
		public $capability = 'edit_theme_options';
160
161
		/**
162
		 * Default absolute path to folder containing bundled plugin zip files.
163
		 *
164
		 * @since 2.0.0
165
		 *
166
		 * @var string Absolute path prefix to zip file location for bundled plugins. Default is empty string.
167
		 */
168
		public $default_path = '';
169
170
		/**
171
		 * Flag to show admin notices or not.
172
		 *
173
		 * @since 2.1.0
174
		 *
175
		 * @var boolean
176
		 */
177
		public $has_notices = true;
178
179
		/**
180
		 * Flag to determine if the user can dismiss the notice nag.
181
		 *
182
		 * @since 2.4.0
183
		 *
184
		 * @var boolean
185
		 */
186
		public $dismissable = true;
187
188
		/**
189
		 * Message to be output above nag notice if dismissable is false.
190
		 *
191
		 * @since 2.4.0
192
		 *
193
		 * @var string
194
		 */
195
		public $dismiss_msg = '';
196
197
		/**
198
		 * Flag to set automatic activation of plugins. Off by default.
199
		 *
200
		 * @since 2.2.0
201
		 *
202
		 * @var boolean
203
		 */
204
		public $is_automatic = false;
205
206
		/**
207
		 * Optional message to display before the plugins table.
208
		 *
209
		 * @since 2.2.0
210
		 *
211
		 * @var string Message filtered by wp_kses_post(). Default is empty string.
212
		 */
213
		public $message = '';
214
215
		/**
216
		 * Holds configurable array of strings.
217
		 *
218
		 * Default values are added in the constructor.
219
		 *
220
		 * @since 2.0.0
221
		 *
222
		 * @var array
223
		 */
224
		public $strings = array();
225
226
		/**
227
		 * Holds the version of WordPress.
228
		 *
229
		 * @since 2.4.0
230
		 *
231
		 * @var int
232
		 */
233
		public $wp_version;
234
235
		/**
236
		 * Holds the hook name for the admin page.
237
		 *
238
		 * @since 2.5.0
239
		 *
240
		 * @var string
241
		 */
242
		public $page_hook;
243
244
		/**
245
		 * Adds a reference of this object to $instance, populates default strings,
246
		 * does the tgmpa_init action hook, and hooks in the interactions to init.
247
		 *
248
		 * {@internal This method should be `protected`, but as too many TGMPA implementations
249
		 * haven't upgraded beyond v2.3.6 yet, this gives backward compatibility issues.
250
		 * Reverted back to public for the time being.}}
251
		 *
252
		 * @since 1.0.0
253
		 *
254
		 * @see TGM_Plugin_Activation::init()
255
		 */
256
		public function __construct() {
257
			// Set the current WordPress version.
258
			$this->wp_version = $GLOBALS['wp_version'];
259
260
			// Announce that the class is ready, and pass the object (for advanced use).
261
			do_action_ref_array( 'tgmpa_init', array( $this ) );
262
263
			/*
264
			 * Load our text domain and allow for overloading the fall-back file.
265
			 *
266
			 * {@internal IMPORTANT! If this code changes, review the regex in the custom TGMPA
267
			 * generator on the website.}}
268
			 */
269
			add_action( 'init', array( $this, 'load_textdomain' ), 5 );
270
			add_filter( 'load_textdomain_mofile', array( $this, 'overload_textdomain_mofile' ), 10, 2 );
271
272
			// When the rest of WP has loaded, kick-start the rest of the class.
273
			add_action( 'init', array( $this, 'init' ) );
274
		}
275
276
		/**
277
		 * Magic method to (not) set protected properties from outside of this class.
278
		 *
279
		 * {@internal hackedihack... There is a serious bug in v2.3.2 - 2.3.6  where the `menu` property
280
		 * is being assigned rather than tested in a conditional, effectively rendering it useless.
281
		 * This 'hack' prevents this from happening.}}
282
		 *
283
		 * @see https://github.com/TGMPA/TGM-Plugin-Activation/blob/2.3.6/tgm-plugin-activation/class-tgm-plugin-activation.php#L1593
284
		 *
285
		 * @param string $name  Name of an inaccessible property.
286
		 * @param mixed  $value Value to assign to the property.
287
		 * @return void  Silently fail to set the property when this is tried from outside of this class context.
288
		 *               (Inside this class context, the __set() method if not used as there is direct access.)
289
		 */
290
		public function __set( $name, $value ) {
291
			return;
292
		}
293
294
		/**
295
		 * Magic method to get the value of a protected property outside of this class context.
296
		 *
297
		 * @param string $name Name of an inaccessible property.
298
		 * @return mixed The property value.
299
		 */
300
		public function __get( $name ) {
301
			return $this->{$name};
302
		}
303
304
		/**
305
		 * Initialise the interactions between this class and WordPress.
306
		 *
307
		 * Hooks in three new methods for the class: admin_menu, notices and styles.
308
		 *
309
		 * @since 2.0.0
310
		 *
311
		 * @see TGM_Plugin_Activation::admin_menu()
312
		 * @see TGM_Plugin_Activation::notices()
313
		 * @see TGM_Plugin_Activation::styles()
314
		 */
315
		public function init() {
316
			/**
317
			 * By default TGMPA only loads on the WP back-end and not in an Ajax call. Using this filter
318
			 * you can overrule that behaviour.
319
			 *
320
			 * @since 2.5.0
321
			 *
322
			 * @param bool $load Whether or not TGMPA should load.
323
			 *                   Defaults to the return of `is_admin() && ! defined( 'DOING_AJAX' )`.
324
			 */
325
			if ( true !== apply_filters( 'tgmpa_load', ( is_admin() && ! defined( 'DOING_AJAX' ) ) ) ) {
326
				return;
327
			}
328
329
			// Load class strings.
330
			$this->strings = array(
331
				'page_title'                      => __( 'Install Required Plugins', 'tgmpa' ),
332
				'menu_title'                      => __( 'Install Plugins', 'tgmpa' ),
333
				'installing'                      => __( 'Installing Plugin: %s', 'tgmpa' ),
334
				'updating'                        => __( 'Updating Plugin: %s', 'tgmpa' ),
335
				'oops'                            => __( 'Something went wrong with the plugin API.', 'tgmpa' ),
336
				'notice_can_install_required'     => _n_noop(
337
					'This theme requires the following plugin: %1$s.',
338
					'This theme requires the following plugins: %1$s.',
339
					'tgmpa'
340
				),
341
				'notice_can_install_recommended'  => _n_noop(
342
					'This theme recommends the following plugin: %1$s.',
343
					'This theme recommends the following plugins: %1$s.',
344
					'tgmpa'
345
				),
346
				'notice_ask_to_update'            => _n_noop(
347
					'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.',
348
					'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.',
349
					'tgmpa'
350
				),
351
				'notice_ask_to_update_maybe'      => _n_noop(
352
					'There is an update available for: %1$s.',
353
					'There are updates available for the following plugins: %1$s.',
354
					'tgmpa'
355
				),
356
				'notice_can_activate_required'    => _n_noop(
357
					'The following required plugin is currently inactive: %1$s.',
358
					'The following required plugins are currently inactive: %1$s.',
359
					'tgmpa'
360
				),
361
				'notice_can_activate_recommended' => _n_noop(
362
					'The following recommended plugin is currently inactive: %1$s.',
363
					'The following recommended plugins are currently inactive: %1$s.',
364
					'tgmpa'
365
				),
366
				'install_link'                    => _n_noop(
367
					'Begin installing plugin',
368
					'Begin installing plugins',
369
					'tgmpa'
370
				),
371
				'update_link'                     => _n_noop(
372
					'Begin updating plugin',
373
					'Begin updating plugins',
374
					'tgmpa'
375
				),
376
				'activate_link'                   => _n_noop(
377
					'Begin activating plugin',
378
					'Begin activating plugins',
379
					'tgmpa'
380
				),
381
				'return'                          => __( 'Return to Required Plugins Installer', 'tgmpa' ),
382
				'dashboard'                       => __( 'Return to the dashboard', 'tgmpa' ),
383
				'plugin_activated'                => __( 'Plugin activated successfully.', 'tgmpa' ),
384
				'activated_successfully'          => __( 'The following plugin was activated successfully:', 'tgmpa' ),
385
				'plugin_already_active'           => __( 'No action taken. Plugin %1$s was already active.', 'tgmpa' ),
386
				'plugin_needs_higher_version'     => __( 'Plugin not activated. A higher version of %s is needed for this theme. Please update the plugin.', 'tgmpa' ),
387
				'complete'                        => __( 'All plugins installed and activated successfully. %1$s', 'tgmpa' ),
388
				'dismiss'                         => __( 'Dismiss this notice', 'tgmpa' ),
389
				'notice_cannot_install_activate'  => __( 'There are one or more required or recommended plugins to install, update or activate.', 'tgmpa' ),
390
				'contact_admin'                   => __( 'Please contact the administrator of this site for help.', 'tgmpa' ),
391
			);
392
393
			do_action( 'tgmpa_register' );
394
395
			/* After this point, the plugins should be registered and the configuration set. */
396
397
			// Proceed only if we have plugins to handle.
398
			if ( empty( $this->plugins ) || ! is_array( $this->plugins ) ) {
399
				return;
400
			}
401
402
			// Set up the menu and notices if we still have outstanding actions.
403
			if ( true !== $this->is_tgmpa_complete() ) {
404
				// Sort the plugins.
405
				array_multisort( $this->sort_order, SORT_ASC, $this->plugins );
406
407
				add_action( 'admin_menu', array( $this, 'admin_menu' ) );
408
				add_action( 'admin_head', array( $this, 'dismiss' ) );
409
410
				// Prevent the normal links from showing underneath a single install/update page.
411
				add_filter( 'install_plugin_complete_actions', array( $this, 'actions' ) );
412
				add_filter( 'update_plugin_complete_actions', array( $this, 'actions' ) );
413
414
				if ( $this->has_notices ) {
415
					add_action( 'admin_notices', array( $this, 'notices' ) );
416
					add_action( 'admin_init', array( $this, 'admin_init' ), 1 );
417
					add_action( 'admin_enqueue_scripts', array( $this, 'thickbox' ) );
418
				}
419
			}
420
421
			// If needed, filter plugin action links.
422
			add_action( 'load-plugins.php', array( $this, 'add_plugin_action_link_filters' ), 1 );
423
424
			// Make sure things get reset on switch theme.
425
			add_action( 'switch_theme', array( $this, 'flush_plugins_cache' ) );
426
427
			if ( $this->has_notices ) {
428
				add_action( 'switch_theme', array( $this, 'update_dismiss' ) );
429
			}
430
431
			// Setup the force activation hook.
432
			if ( true === $this->has_forced_activation ) {
433
				add_action( 'admin_init', array( $this, 'force_activation' ) );
434
			}
435
436
			// Setup the force deactivation hook.
437
			if ( true === $this->has_forced_deactivation ) {
438
				add_action( 'switch_theme', array( $this, 'force_deactivation' ) );
439
			}
440
		}
441
442
		/**
443
		 * Load translations.
444
		 *
445
		 * @since 2.x.x
446
		 *
447
		 * @internal Uses `load_theme_textdomain()` rather than `load_plugin_textdomain()` to
448
		 * get round the different ways of handling the path and deprecated notices being thrown
449
		 * and such. For plugins, the actual file name will be corrected by a filter.
450
		 *
451
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
452
		 * generator on the website.}}
453
		 */
454
		public function load_textdomain() {
455
			if ( false !== strpos( __FILE__, WP_PLUGIN_DIR ) || false !== strpos( __FILE__, WPMU_PLUGIN_DIR ) ) {
456
				// Plugin, we'll need to adjust the file name.
457
				add_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10, 2 );
458
				load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
459
				remove_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10 );
460
			} else {
461
				load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
462
			}
463
		}
464
465
		/**
466
		 * Correct the .mo file name for (must-use) plugins.
467
		 *
468
		 * Themese use `/path/{locale}.mo` while plugins use `/path/{text-domain}-{locale}.mo`.
469
		 *
470
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
471
		 * generator on the website.}}
472
		 *
473
		 * @since 2.x.x
474
		 *
475
		 * @param string $mofile Full path to the target mofile.
476
		 * @param string $domain The domain for which a language file is being loaded.
477
		 * @return string $mofile
478
		 */
479
		public function correct_plugin_mofile( $mofile, $domain ) {
480
			// Exit early if not our domain (just in case).
481
			if ( 'tgmpa' !== $domain ) {
482
				return $mofile;
483
			}
484
			return preg_replace( '`/([a-z]{2}_[A-Z]{2}.mo)$`', '/tgmpa-$1', $mofile );
485
		}
486
487
		/**
488
		 * Potentially overload the fall-back translation file for the current language.
489
		 *
490
		 * WP, by default since WP 3.7, will load a local translation first and if none
491
		 * can be found, will try and find a translation in the /wp-content/languages/ directory.
492
		 * As this library is theme/plugin agnostic, translation files for TGMPA can exist both
493
		 * in the WP_LANG_DIR /plugins/ subdirectory as well as in the /themes/ subdirectory.
494
		 *
495
		 * This method makes sure both directories are checked.
496
		 *
497
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
498
		 * generator on the website.}}
499
		 *
500
		 * @since 2.x.x
501
		 *
502
		 * @param string $mofile Full path to the target mofile.
503
		 * @param string $domain The domain for which a language file is being loaded.
504
		 * @return string $mofile
505
		 */
506
		public function overload_textdomain_mofile( $mofile, $domain ) {
507
			// Exit early if not our domain, not a WP_LANG_DIR load or if the file exists and is readable.
508
			if ( 'tgmpa' !== $domain || false === strpos( $mofile, WP_LANG_DIR ) || is_readable( $mofile ) ) {
509
				return $mofile;
510
			}
511
512
			// Current fallback file is not valid, let's try the alternative option.
513
			if ( strpos( $mofile, '/themes/' ) !== false ) {
514
				return str_replace( '/themes/', '/plugins/', $mofile );
515
			} elseif ( strpos( $mofile, '/plugins/' ) !== false ) {
516
				return str_replace( '/plugins/', '/themes/', $mofile );
517
			} else {
518
				return $mofile;
519
			}
520
		}
521
522
		/**
523
		 * Hook in plugin action link filters for the WP native plugins page.
524
		 *
525
		 * - Prevent activation of plugins which don't meet the minimum version requirements.
526
		 * - Prevent deactivation of force-activated plugins.
527
		 * - Add update notice if update available.
528
		 *
529
		 * @since 2.5.0
530
		 */
531
		public function add_plugin_action_link_filters() {
532
			foreach ( $this->plugins as $slug => $plugin ) {
533
				if ( false === $this->can_plugin_activate( $slug ) ) {
534
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_activate' ), 20 );
535
				}
536
537
				if ( true === $plugin['force_activation'] ) {
538
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_deactivate' ), 20 );
539
				}
540
541
				if ( false !== $this->does_plugin_require_update( $slug ) ) {
542
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_update' ), 20 );
543
				}
544
			}
545
		}
546
547
		/**
548
		 * Remove the 'Activate' link on the WP native plugins page if the plugin does not meet the
549
		 * minimum version requirements.
550
		 *
551
		 * @since 2.5.0
552
		 *
553
		 * @param array $actions Action links.
554
		 * @return array
555
		 */
556
		public function filter_plugin_action_links_activate( $actions ) {
557
			unset( $actions['activate'] );
558
559
			return $actions;
560
		}
561
562
		/**
563
		 * Remove the 'Deactivate' link on the WP native plugins page if the plugin has been set to force activate.
564
		 *
565
		 * @since 2.5.0
566
		 *
567
		 * @param array $actions Action links.
568
		 * @return array
569
		 */
570
		public function filter_plugin_action_links_deactivate( $actions ) {
571
			unset( $actions['deactivate'] );
572
573
			return $actions;
574
		}
575
576
		/**
577
		 * Add a 'Requires update' link on the WP native plugins page if the plugin does not meet the
578
		 * minimum version requirements.
579
		 *
580
		 * @since 2.5.0
581
		 *
582
		 * @param array $actions Action links.
583
		 * @return array
584
		 */
585
		public function filter_plugin_action_links_update( $actions ) {
586
			$actions['update'] = sprintf(
587
				'<a href="%1$s" title="%2$s" class="edit">%3$s</a>',
588
				esc_url( $this->get_tgmpa_status_url( 'update' ) ),
589
				esc_attr__( 'This plugin needs to be updated to be compatible with your theme.', 'tgmpa' ),
590
				esc_html__( 'Update Required', 'tgmpa' )
591
			);
592
593
			return $actions;
594
		}
595
596
		/**
597
		 * Handles calls to show plugin information via links in the notices.
598
		 *
599
		 * We get the links in the admin notices to point to the TGMPA page, rather
600
		 * than the typical plugin-install.php file, so we can prepare everything
601
		 * beforehand.
602
		 *
603
		 * WP does not make it easy to show the plugin information in the thickbox -
604
		 * here we have to require a file that includes a function that does the
605
		 * main work of displaying it, enqueue some styles, set up some globals and
606
		 * finally call that function before exiting.
607
		 *
608
		 * Down right easy once you know how...
609
		 *
610
		 * Returns early if not the TGMPA page.
611
		 *
612
		 * @since 2.1.0
613
		 *
614
		 * @global string $tab Used as iframe div class names, helps with styling
615
		 * @global string $body_id Used as the iframe body ID, helps with styling
616
		 *
617
		 * @return null Returns early if not the TGMPA page.
618
		 */
619
		public function admin_init() {
620
			if ( ! $this->is_tgmpa_page() ) {
621
				return;
622
			}
623
624
			if ( isset( $_REQUEST['tab'] ) && 'plugin-information' === $_REQUEST['tab'] ) {
625
				// Needed for install_plugin_information().
626
				require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
627
628
				wp_enqueue_style( 'plugin-install' );
629
630
				global $tab, $body_id;
631
				$body_id = 'plugin-information';
632
				// @codingStandardsIgnoreStart
633
				$tab     = 'plugin-information';
634
				// @codingStandardsIgnoreEnd
635
636
				install_plugin_information();
637
638
				exit;
639
			}
640
		}
641
642
		/**
643
		 * Enqueue thickbox scripts/styles for plugin info.
644
		 *
645
		 * Thickbox is not automatically included on all admin pages, so we must
646
		 * manually enqueue it for those pages.
647
		 *
648
		 * Thickbox is only loaded if the user has not dismissed the admin
649
		 * notice or if there are any plugins left to install and activate.
650
		 *
651
		 * @since 2.1.0
652
		 */
653
		public function thickbox() {
654
			if ( ! get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) ) {
655
				add_thickbox();
656
			}
657
		}
658
659
		/**
660
		 * Adds submenu page if there are plugin actions to take.
661
		 *
662
		 * This method adds the submenu page letting users know that a required
663
		 * plugin needs to be installed.
664
		 *
665
		 * This page disappears once the plugin has been installed and activated.
666
		 *
667
		 * @since 1.0.0
668
		 *
669
		 * @see TGM_Plugin_Activation::init()
670
		 * @see TGM_Plugin_Activation::install_plugins_page()
671
		 *
672
		 * @return null Return early if user lacks capability to install a plugin.
673
		 */
674
		public function admin_menu() {
675
			// Make sure privileges are correct to see the page.
676
			if ( ! current_user_can( 'install_plugins' ) ) {
677
				return;
678
			}
679
680
			$args = apply_filters(
681
				'tgmpa_admin_menu_args',
682
				array(
683
					'parent_slug' => $this->parent_slug,                     // Parent Menu slug.
684
					'page_title'  => $this->strings['page_title'],           // Page title.
685
					'menu_title'  => $this->strings['menu_title'],           // Menu title.
686
					'capability'  => $this->capability,                      // Capability.
687
					'menu_slug'   => $this->menu,                            // Menu slug.
688
					'function'    => array( $this, 'install_plugins_page' ), // Callback.
689
				)
690
			);
691
692
			$this->add_admin_menu( $args );
693
		}
694
695
		/**
696
		 * Add the menu item.
697
		 *
698
		 * @since 2.5.0
699
		 *
700
		 * @param array $args Menu item configuration.
701
		 */
702
		protected function add_admin_menu( array $args ) {
703
			if ( has_filter( 'tgmpa_admin_menu_use_add_theme_page' ) ) {
704
				_deprecated_function( 'The "tgmpa_admin_menu_use_add_theme_page" filter', '2.5.0', esc_html__( 'Set the parent_slug config variable instead.', 'tgmpa' ) );
705
			}
706
707
			if ( 'themes.php' === $this->parent_slug ) {
708
				$this->page_hook = call_user_func( 'add_theme_page', $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
709
			} else {
710
				$type = 'submenu';
711
				$this->page_hook = call_user_func( "add_{$type}_page", $args['parent_slug'], $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
712
			}
713
		}
714
715
		/**
716
		 * Echoes plugin installation form.
717
		 *
718
		 * This method is the callback for the admin_menu method function.
719
		 * This displays the admin page and form area where the user can select to install and activate the plugin.
720
		 * Aborts early if we're processing a plugin installation action.
721
		 *
722
		 * @since 1.0.0
723
		 *
724
		 * @return null Aborts early if we're processing a plugin installation action.
725
		 */
726
		public function install_plugins_page() {
727
			// Store new instance of plugin table in object.
728
			$plugin_table = new TGMPA_List_Table;
729
730
			// Return early if processing a plugin installation action.
731
			if ( ( ( 'tgmpa-bulk-install' === $plugin_table->current_action() || 'tgmpa-bulk-update' === $plugin_table->current_action() ) && $plugin_table->process_bulk_actions() ) || $this->do_plugin_install() ) {
732
				return;
733
			}
734
735
			// Force refresh of available plugin information so we'll know about manual updates/deletes.
736
			wp_clean_plugins_cache( false );
737
738
			?>
739
			<div class="tgmpa wrap">
740
				<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
741
				<?php $plugin_table->prepare_items(); ?>
742
743
				<?php
744
				if ( ! empty( $this->message ) && is_string( $this->message ) ) {
745
					echo wp_kses_post( $this->message );
746
				}
747
				?>
748
				<?php $plugin_table->views(); ?>
749
750
				<form id="tgmpa-plugins" action="" method="post">
751
					<input type="hidden" name="tgmpa-page" value="<?php echo esc_attr( $this->menu ); ?>" />
752
					<input type="hidden" name="plugin_status" value="<?php echo esc_attr( $plugin_table->view_context ); ?>" />
753
					<?php $plugin_table->display(); ?>
754
				</form>
755
			</div>
756
			<?php
757
		}
758
759
		/**
760
		 * Installs, updates or activates a plugin depending on the action link clicked by the user.
761
		 *
762
		 * Checks the $_GET variable to see which actions have been
763
		 * passed and responds with the appropriate method.
764
		 *
765
		 * Uses WP_Filesystem to process and handle the plugin installation
766
		 * method.
767
		 *
768
		 * @since 1.0.0
769
		 *
770
		 * @uses WP_Filesystem
771
		 * @uses WP_Error
772
		 * @uses WP_Upgrader
773
		 * @uses Plugin_Upgrader
774
		 * @uses Plugin_Installer_Skin
775
		 * @uses Plugin_Upgrader_Skin
776
		 *
777
		 * @return boolean True on success, false on failure.
778
		 */
779
		protected function do_plugin_install() {
780
			if ( empty( $_GET['plugin'] ) ) {
781
				return false;
782
			}
783
784
			// All plugin information will be stored in an array for processing.
785
			$slug = $this->sanitize_key( urldecode( $_GET['plugin'] ) );
786
787
			if ( ! isset( $this->plugins[ $slug ] ) ) {
788
				return false;
789
			}
790
791
			// Was an install or upgrade action link clicked?
792
			if ( ( isset( $_GET['tgmpa-install'] ) && 'install-plugin' === $_GET['tgmpa-install'] ) || ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) ) {
793
794
				$install_type = 'install';
795
				if ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) {
796
					$install_type = 'update';
797
				}
798
799
				check_admin_referer( 'tgmpa-' . $install_type, 'tgmpa-nonce' );
800
801
				// Pass necessary information via URL if WP_Filesystem is needed.
802
				$url = wp_nonce_url(
803
					add_query_arg(
804
						array(
805
							'plugin'                 => urlencode( $slug ),
806
							'tgmpa-' . $install_type => $install_type . '-plugin',
807
						),
808
						$this->get_tgmpa_url()
809
					),
810
					'tgmpa-' . $install_type,
811
					'tgmpa-nonce'
812
				);
813
814
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
815
816
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, array() ) ) ) {
817
					return true;
818
				}
819
820 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
0 ignored issues
show
This code seems to be duplicated across your project.

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

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

Loading history...
821
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem.
822
					return true;
823
				}
824
825
				/* If we arrive here, we have the filesystem. */
826
827
				// Prep variables for Plugin_Installer_Skin class.
828
				$extra         = array();
829
				$extra['slug'] = $slug; // Needed for potentially renaming of directory name.
830
				$source        = $this->get_download_url( $slug );
831
				$api           = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null;
832
				$api           = ( false !== $api ) ? $api : null;
833
834
				$url = add_query_arg(
835
					array(
836
						'action' => $install_type . '-plugin',
837
						'plugin' => urlencode( $slug ),
838
					),
839
					'update.php'
840
				);
841
842
				if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
843
					require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
844
				}
845
846
				$title     = ( 'update' === $install_type ) ? $this->strings['updating'] : $this->strings['installing'];
847
				$skin_args = array(
848
					'type'   => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload',
849
					'title'  => sprintf( $title, $this->plugins[ $slug ]['name'] ),
850
					'url'    => esc_url_raw( $url ),
851
					'nonce'  => $install_type . '-plugin_' . $slug,
852
					'plugin' => '',
853
					'api'    => $api,
854
					'extra'  => $extra,
855
				);
856
				unset( $title );
857
858
				if ( 'update' === $install_type ) {
859
					$skin_args['plugin'] = $this->plugins[ $slug ]['file_path'];
860
					$skin                = new Plugin_Upgrader_Skin( $skin_args );
861
				} else {
862
					$skin = new Plugin_Installer_Skin( $skin_args );
863
				}
864
865
				// Create a new instance of Plugin_Upgrader.
866
				$upgrader = new Plugin_Upgrader( $skin );
867
868
				// Perform the action and install the plugin from the $source urldecode().
869
				add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
870
871
				if ( 'update' === $install_type ) {
872
					// Inject our info into the update transient.
873
					$to_inject                    = array( $slug => $this->plugins[ $slug ] );
874
					$to_inject[ $slug ]['source'] = $source;
875
					$this->inject_update_info( $to_inject );
876
877
					$upgrader->upgrade( $this->plugins[ $slug ]['file_path'] );
878
				} else {
879
					$upgrader->install( $source );
880
				}
881
882
				remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
883
884
				// Make sure we have the correct file path now the plugin is installed/updated.
885
				$this->populate_file_path( $slug );
886
887
				// Only activate plugins if the config option is set to true and the plugin isn't
888
				// already active (upgrade).
889
				if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) {
890
					$plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method.
891
					if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) {
892
						return true; // Finish execution of the function early as we encountered an error.
893
					}
894
				}
895
896
				$this->show_tgmpa_version();
897
898
				// Display message based on if all plugins are now active or not.
899
				if ( $this->is_tgmpa_complete() ) {
900
					echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>' ), '</p>';
901
					echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
902
				} else {
903
					echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
904
				}
905
906
				return true;
907
			} elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) {
908
				// Activate action link was clicked.
909
				check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' );
910
911
				if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) {
912
					return true; // Finish execution of the function early as we encountered an error.
913
				}
914
			}
915
916
			return false;
917
		}
918
919
		/**
920
		 * Inject information into the 'update_plugins' site transient as WP checks that before running an update.
921
		 *
922
		 * @since 2.5.0
923
		 *
924
		 * @param array $plugins The plugin information for the plugins which are to be updated.
925
		 */
926
		public function inject_update_info( $plugins ) {
927
			$repo_updates = get_site_transient( 'update_plugins' );
928
929
			if ( ! is_object( $repo_updates ) ) {
930
				$repo_updates = new stdClass;
931
			}
932
933
			foreach ( $plugins as $slug => $plugin ) {
934
				$file_path = $plugin['file_path'];
935
936
				if ( empty( $repo_updates->response[ $file_path ] ) ) {
937
					$repo_updates->response[ $file_path ] = new stdClass;
938
				}
939
940
				// We only really need to set package, but let's do all we can in case WP changes something.
941
				$repo_updates->response[ $file_path ]->slug        = $slug;
942
				$repo_updates->response[ $file_path ]->plugin      = $file_path;
943
				$repo_updates->response[ $file_path ]->new_version = $plugin['version'];
944
				$repo_updates->response[ $file_path ]->package     = $plugin['source'];
945
				if ( empty( $repo_updates->response[ $file_path ]->url ) && ! empty( $plugin['external_url'] ) ) {
946
					$repo_updates->response[ $file_path ]->url = $plugin['external_url'];
947
				}
948
			}
949
950
			set_site_transient( 'update_plugins', $repo_updates );
951
		}
952
953
		/**
954
		 * Adjust the plugin directory name if necessary.
955
		 *
956
		 * The final destination directory of a plugin is based on the subdirectory name found in the
957
		 * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this
958
		 * subdirectory name is not the same as the expected slug and the plugin will not be recognized
959
		 * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to
960
		 * the expected plugin slug.
961
		 *
962
		 * @since 2.5.0
963
		 *
964
		 * @param string       $source        Path to upgrade/zip-file-name.tmp/subdirectory/.
965
		 * @param string       $remote_source Path to upgrade/zip-file-name.tmp.
966
		 * @param \WP_Upgrader $upgrader      Instance of the upgrader which installs the plugin.
967
		 * @return string $source
968
		 */
969
		public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
970
			if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) {
971
				return $source;
972
			}
973
974
			// Check for single file plugins.
975
			$source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) );
976
			if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) {
977
				return $source;
978
			}
979
980
			// Multi-file plugin, let's see if the directory is correctly named.
981
			$desired_slug = '';
982
983
			// Figure out what the slug is supposed to be.
984
			if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) {
985
				$desired_slug = $upgrader->skin->options['extra']['slug'];
986
			} else {
987
				// Bulk installer contains less info, so fall back on the info registered here.
988
				foreach ( $this->plugins as $slug => $plugin ) {
989
					if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) {
990
						$desired_slug = $slug;
991
						break;
992
					}
993
				}
994
				unset( $slug, $plugin );
995
			}
996
997
			if ( ! empty( $desired_slug ) ) {
998
				$subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
999
1000
				if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
1001
					$from = untrailingslashit( $source );
1002
					$to   = trailingslashit( $remote_source ) . $desired_slug;
1003
1004
					if ( true === $GLOBALS['wp_filesystem']->move( $from, $to ) ) {
1005
						return trailingslashit( $to );
1006 View Code Duplication
					} else {
1007
						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 ) );
1008
					}
1009 View Code Duplication
				} elseif ( empty( $subdir_name ) ) {
1010
					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 ) );
1011
				}
1012
			}
1013
1014
			return $source;
1015
		}
1016
1017
		/**
1018
		 * Activate a single plugin and send feedback about the result to the screen.
1019
		 *
1020
		 * @since 2.5.0
1021
		 *
1022
		 * @param string $file_path Path within wp-plugins/ to main plugin file.
1023
		 * @param string $slug      Plugin slug.
1024
		 * @param bool   $automatic Whether this is an automatic activation after an install. Defaults to false.
1025
		 *                          This determines the styling of the output messages.
1026
		 * @return bool False if an error was encountered, true otherwise.
1027
		 */
1028
		protected function activate_single_plugin( $file_path, $slug, $automatic = false ) {
1029
			if ( $this->can_plugin_activate( $slug ) ) {
1030
				$activate = activate_plugin( $file_path );
1031
1032
				if ( is_wp_error( $activate ) ) {
1033
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>',
1034
						'<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
1035
1036
					return false; // End it here if there is an error with activation.
1037
				} else {
1038
					if ( ! $automatic ) {
1039
						// Make sure message doesn't display again if bulk activation is performed
1040
						// immediately after a single activation.
1041
						if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1042
							echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>';
1043
						}
1044
					} else {
1045
						// Simpler message layout for use on the plugin install page.
1046
						echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>';
1047
					}
1048
				}
1049 View Code Duplication
			} elseif ( $this->is_plugin_active( $slug ) ) {
1050
				// No simpler message format provided as this message should never be encountered
1051
				// on the plugin install page.
1052
				echo '<div id="message" class="error"><p>',
1053
					sprintf(
1054
						esc_html( $this->strings['plugin_already_active'] ),
1055
						'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1056
					),
1057
					'</p></div>';
1058
			} elseif ( $this->does_plugin_require_update( $slug ) ) {
1059
				if ( ! $automatic ) {
1060
					// Make sure message doesn't display again if bulk activation is performed
1061
					// immediately after a single activation.
1062 View Code Duplication
					if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1063
						echo '<div id="message" class="error"><p>',
1064
							sprintf(
1065
								esc_html( $this->strings['plugin_needs_higher_version'] ),
1066
								'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1067
							),
1068
							'</p></div>';
1069
					}
1070
				} else {
1071
					// Simpler message layout for use on the plugin install page.
1072
					echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>';
1073
				}
1074
			}
1075
1076
			return true;
1077
		}
1078
1079
		/**
1080
		 * Echoes required plugin notice.
1081
		 *
1082
		 * Outputs a message telling users that a specific plugin is required for
1083
		 * their theme. If appropriate, it includes a link to the form page where
1084
		 * users can install and activate the plugin.
1085
		 *
1086
		 * Returns early if we're on the Install page.
1087
		 *
1088
		 * @since 1.0.0
1089
		 *
1090
		 * @global object $current_screen
1091
		 *
1092
		 * @return null Returns early if we're on the Install page.
1093
		 */
1094
		public function notices() {
1095
			// Remove nag on the install page / Return early if the nag message has been dismissed or user < author.
1096
			if ( $this->is_tgmpa_page() || get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) || ! current_user_can( apply_filters( 'tgmpa_show_admin_notice_capability', 'publish_posts' ) ) ) {
1097
				return;
1098
			}
1099
1100
			// Store for the plugin slugs by message type.
1101
			$message = array();
1102
1103
			// Initialize counters used to determine plurality of action link texts.
1104
			$install_link_count          = 0;
1105
			$update_link_count           = 0;
1106
			$activate_link_count         = 0;
1107
			$total_required_action_count = 0;
0 ignored issues
show
Comprehensibility Naming introduced by
The variable name $total_required_action_count exceeds the maximum configured length of 25.

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

Loading history...
1108
1109
			foreach ( $this->plugins as $slug => $plugin ) {
1110
				if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) {
1111
					continue;
1112
				}
1113
1114
				if ( ! $this->is_plugin_installed( $slug ) ) {
1115
					if ( current_user_can( 'install_plugins' ) ) {
1116
						$install_link_count++;
1117
1118
						if ( true === $plugin['required'] ) {
1119
							$message['notice_can_install_required'][] = $slug;
1120
						} else {
1121
							$message['notice_can_install_recommended'][] = $slug;
1122
						}
1123
					}
1124
					if ( true === $plugin['required'] ) {
1125
						$total_required_action_count++;
1126
					}
1127
				} else {
1128
					if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) {
1129
						if ( current_user_can( 'activate_plugins' ) ) {
1130
							$activate_link_count++;
1131
1132
							if ( true === $plugin['required'] ) {
1133
								$message['notice_can_activate_required'][] = $slug;
1134
							} else {
1135
								$message['notice_can_activate_recommended'][] = $slug;
1136
							}
1137
						}
1138
						if ( true === $plugin['required'] ) {
1139
							$total_required_action_count++;
1140
						}
1141
					}
1142
1143
					if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1144
1145
						if ( current_user_can( 'update_plugins' ) ) {
1146
							$update_link_count++;
1147
1148
							if ( $this->does_plugin_require_update( $slug ) ) {
1149
								$message['notice_ask_to_update'][] = $slug;
1150
							} elseif ( false !== $this->does_plugin_have_update( $slug ) ) {
1151
								$message['notice_ask_to_update_maybe'][] = $slug;
1152
							}
1153
						}
1154
						if ( true === $plugin['required'] ) {
1155
							$total_required_action_count++;
1156
						}
1157
					}
1158
				}
1159
			}
1160
			unset( $slug, $plugin );
1161
1162
			// If we have notices to display, we move forward.
1163
			if ( ! empty( $message ) || $total_required_action_count > 0 ) {
1164
				krsort( $message ); // Sort messages.
1165
				$rendered = '';
1166
1167
				// As add_settings_error() wraps the final message in a <p> and as the final message can't be
1168
				// filtered, using <p>'s in our html would render invalid html output.
1169
				$line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n";
1170
1171
				if ( ! current_user_can( 'activate_plugins' ) && ! current_user_can( 'install_plugins' ) && ! current_user_can( 'update_plugins' ) ) {
1172
					$rendered = esc_html__( $this->strings['notice_cannot_install_activate'] ) . ' ' . esc_html__( $this->strings['contact_admin'] );
0 ignored issues
show
Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
1173
					$rendered .= $this->create_user_action_links_for_notice( 0, 0, 0, $line_template );
1174
				} else {
1175
1176
					// If dismissable is false and a message is set, output it now.
1177
					if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) {
1178
						$rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) );
1179
					}
1180
1181
					// Render the individual message lines for the notice.
1182
					foreach ( $message as $type => $plugin_group ) {
1183
						$linked_plugins = array();
1184
1185
						// Get the external info link for a plugin if one is available.
1186
						foreach ( $plugin_group as $plugin_slug ) {
1187
							$linked_plugins[] = $this->get_info_link( $plugin_slug );
1188
						}
1189
						unset( $plugin_slug );
1190
1191
						$count          = count( $plugin_group );
1192
						$linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins );
1193
						$last_plugin    = array_pop( $linked_plugins ); // Pop off last name to prep for readability.
1194
						$imploded       = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
1195
1196
						$rendered .= sprintf(
1197
							$line_template,
1198
							sprintf(
1199
								translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ),
1200
								$imploded,
1201
								$count
1202
							)
1203
						);
1204
1205
					}
1206
					unset( $type, $plugin_group, $linked_plugins, $count, $last_plugin, $imploded );
1207
1208
					$rendered .= $this->create_user_action_links_for_notice( $install_link_count, $update_link_count, $activate_link_count, $line_template );
1209
				}
1210
1211
				// Register the nag messages and prepare them to be processed.
1212
				add_settings_error( 'tgmpa', 'tgmpa', $rendered, $this->get_admin_notice_class() );
1213
			}
1214
1215
			// Admin options pages already output settings_errors, so this is to avoid duplication.
1216
			if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) {
1217
				$this->display_settings_errors();
1218
			}
1219
		}
1220
1221
		/**
1222
		 * Generate the user action links for the admin notice.
1223
		 *
1224
		 * @since 2.x.x
1225
		 *
1226
		 * @param int $install_count  Number of plugins to install.
1227
		 * @param int $update_count   Number of plugins to update.
1228
		 * @param int $activate_count Number of plugins to activate.
1229
		 * @param int $line_template  Template for the HTML tag to output a line.
1230
		 * @return string Action links.
1231
		 */
1232
		protected function create_user_action_links_for_notice( $install_count, $update_count, $activate_count, $line_template ) {
1233
			// Setup action links.
1234
			$action_links = array(
1235
				'install'  => '',
1236
				'update'   => '',
1237
				'activate' => '',
1238
				'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>' : '',
1239
			);
1240
1241
			$link_template = '<a href="%2$s">%1$s</a>';
1242
1243
			if ( current_user_can( 'install_plugins' ) ) {
1244 View Code Duplication
				if ( $install_count > 0 ) {
1245
					$action_links['install'] = sprintf(
1246
						$link_template,
1247
						translate_nooped_plural( $this->strings['install_link'], $install_count, 'tgmpa' ),
1248
						esc_url( $this->get_tgmpa_status_url( 'install' ) )
1249
					);
1250
				}
1251 View Code Duplication
				if ( $update_count > 0 ) {
1252
					$action_links['update'] = sprintf(
1253
						$link_template,
1254
						translate_nooped_plural( $this->strings['update_link'], $update_count, 'tgmpa' ),
1255
						esc_url( $this->get_tgmpa_status_url( 'update' ) )
1256
					);
1257
				}
1258
			}
1259
1260 View Code Duplication
			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...
1261
				$action_links['activate'] = sprintf(
1262
					$link_template,
1263
					translate_nooped_plural( $this->strings['activate_link'], $activate_count, 'tgmpa' ),
1264
					esc_url( $this->get_tgmpa_status_url( 'activate' ) )
1265
				);
1266
			}
1267
1268
			$action_links = apply_filters( 'tgmpa_notice_action_links', $action_links );
1269
1270
			$action_links = array_filter( (array) $action_links ); // Remove any empty array items.
1271
1272
			if ( ! empty( $action_links ) ) {
1273
				$action_links = sprintf( $line_template, implode( ' | ', $action_links ) );
1274
				return apply_filters( 'tgmpa_notice_rendered_action_links', $action_links );
1275
			} else {
1276
				return '';
1277
			}
1278
		}
1279
1280
		/**
1281
		 * Get admin notice class.
1282
		 *
1283
		 * Work around all the changes to the various admin notice classes between WP 4.4 and 3.7
1284
		 * (lowest supported version by TGMPA).
1285
		 *
1286
		 * @since 2.x.x
1287
		 *
1288
		 * @return string
1289
		 */
1290
		protected function get_admin_notice_class() {
1291
			if ( ! empty( $this->strings['nag_type'] ) ) {
1292
				return sanitize_html_class( strtolower( $this->strings['nag_type'] ) );
1293
			} else {
1294
				if ( version_compare( $this->wp_version, '4.2', '>=' ) ) {
1295
					return 'notice-warning';
1296
				} elseif ( version_compare( $this->wp_version, '4.1', '>=' ) ) {
1297
					return 'notice';
1298
				} else {
1299
					return 'updated';
1300
				}
1301
			}
1302
		}
1303
1304
		/**
1305
		 * Display settings errors and remove those which have been displayed to avoid duplicate messages showing
1306
		 *
1307
		 * @since 2.5.0
1308
		 */
1309
		protected function display_settings_errors() {
1310
			global $wp_settings_errors;
1311
1312
			settings_errors( 'tgmpa' );
1313
1314
			foreach ( (array) $wp_settings_errors as $key => $details ) {
1315
				if ( 'tgmpa' === $details['setting'] ) {
1316
					unset( $wp_settings_errors[ $key ] );
1317
					break;
1318
				}
1319
			}
1320
		}
1321
1322
		/**
1323
		 * Add dismissable admin notices.
1324
		 *
1325
		 * Appends a link to the admin nag messages. If clicked, the admin notice disappears and no longer is visible to users.
1326
		 *
1327
		 * @since 2.1.0
1328
		 */
1329
		public function dismiss() {
1330
			if ( isset( $_GET['tgmpa-dismiss'] ) && check_admin_referer( 'tgmpa-dismis-' . get_current_user_id() ) ) {
1331
				update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
1332
			}
1333
		}
1334
1335
		/**
1336
		 * Add individual plugin to our collection of plugins.
1337
		 *
1338
		 * If the required keys are not set or the plugin has already
1339
		 * been registered, the plugin is not added.
1340
		 *
1341
		 * @since 2.0.0
1342
		 *
1343
		 * @param array|null $plugin Array of plugin arguments or null if invalid argument.
1344
		 * @return null Return early if incorrect argument.
1345
		 */
1346
		public function register( $plugin ) {
1347
			if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
1348
				return;
1349
			}
1350
1351
			if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
1352
				return;
1353
			}
1354
1355
			$defaults = array(
1356
				'name'               => '',      // String
1357
				'slug'               => '',      // String
1358
				'source'             => 'repo',  // String
1359
				'required'           => false,   // Boolean
1360
				'version'            => '',      // String
1361
				'force_activation'   => false,   // Boolean
1362
				'force_deactivation' => false,   // Boolean
1363
				'external_url'       => '',      // String
1364
				'is_callable'        => '',      // String|Array.
1365
			);
1366
1367
			// Prepare the received data.
1368
			$plugin = wp_parse_args( $plugin, $defaults );
1369
1370
			// Standardize the received slug.
1371
			$plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
1372
1373
			// Forgive users for using string versions of booleans or floats for version number.
1374
			$plugin['version']            = (string) $plugin['version'];
1375
			$plugin['source']             = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
1376
			$plugin['required']           = TGMPA_Utils::validate_bool( $plugin['required'] );
1377
			$plugin['force_activation']   = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
1378
			$plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
1379
1380
			// Enrich the received data.
1381
			$plugin['file_path']   = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
1382
			$plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
1383
1384
			// Set the class properties.
1385
			$this->plugins[ $plugin['slug'] ]    = $plugin;
1386
			$this->sort_order[ $plugin['slug'] ] = $plugin['name'];
1387
1388
			// Should we add the force activation hook ?
1389
			if ( true === $plugin['force_activation'] ) {
1390
				$this->has_forced_activation = true;
1391
			}
1392
1393
			// Should we add the force deactivation hook ?
1394
			if ( true === $plugin['force_deactivation'] ) {
1395
				$this->has_forced_deactivation = true;
1396
			}
1397
		}
1398
1399
		/**
1400
		 * Determine what type of source the plugin comes from.
1401
		 *
1402
		 * @since 2.5.0
1403
		 *
1404
		 * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
1405
		 *                       (= bundled) or an external URL.
1406
		 * @return string 'repo', 'external', or 'bundled'
1407
		 */
1408
		protected function get_plugin_source_type( $source ) {
1409
			if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
1410
				return 'repo';
1411
			} elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
1412
				return 'external';
1413
			} else {
1414
				return 'bundled';
1415
			}
1416
		}
1417
1418
		/**
1419
		 * Sanitizes a string key.
1420
		 *
1421
		 * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
1422
		 * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
1423
		 * characters in the plugin directory path/slug. Silly them.
1424
		 *
1425
		 * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
1426
		 *
1427
		 * @since 2.5.0
1428
		 *
1429
		 * @param string $key String key.
1430
		 * @return string Sanitized key
1431
		 */
1432
		public function sanitize_key( $key ) {
1433
			$raw_key = $key;
1434
			$key     = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
1435
1436
			/**
1437
			* Filter a sanitized key string.
1438
			*
1439
			* @since 3.0.0
1440
			*
1441
			* @param string $key     Sanitized key.
1442
			* @param string $raw_key The key prior to sanitization.
1443
			*/
1444
			return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
1445
		}
1446
1447
		/**
1448
		 * Amend default configuration settings.
1449
		 *
1450
		 * @since 2.0.0
1451
		 *
1452
		 * @param array $config Array of config options to pass as class properties.
1453
		 */
1454
		public function config( $config ) {
1455
			$keys = array(
1456
				'id',
1457
				'default_path',
1458
				'has_notices',
1459
				'dismissable',
1460
				'dismiss_msg',
1461
				'menu',
1462
				'parent_slug',
1463
				'capability',
1464
				'is_automatic',
1465
				'message',
1466
				'strings',
1467
			);
1468
1469
			foreach ( $keys as $key ) {
1470
				if ( isset( $config[ $key ] ) ) {
1471
					if ( is_array( $config[ $key ] ) ) {
1472
						$this->$key = array_merge( $this->$key, $config[ $key ] );
1473
					} else {
1474
						$this->$key = $config[ $key ];
1475
					}
1476
				}
1477
			}
1478
		}
1479
1480
		/**
1481
		 * Amend action link after plugin installation.
1482
		 *
1483
		 * @since 2.0.0
1484
		 *
1485
		 * @param array $install_actions Existing array of actions.
1486
		 * @return array Amended array of actions.
1487
		 */
1488
		public function actions( $install_actions ) {
1489
			// Remove action links on the TGMPA install page.
1490
			if ( $this->is_tgmpa_page() ) {
1491
				return false;
1492
			}
1493
1494
			return $install_actions;
1495
		}
1496
1497
		/**
1498
		 * Flushes the plugins cache on theme switch to prevent stale entries
1499
		 * from remaining in the plugin table.
1500
		 *
1501
		 * @since 2.4.0
1502
		 *
1503
		 * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
1504
		 *                                 Parameter added in v2.5.0.
1505
		 */
1506
		public function flush_plugins_cache( $clear_update_cache = true ) {
1507
			wp_clean_plugins_cache( $clear_update_cache );
1508
		}
1509
1510
		/**
1511
		 * Set file_path key for each installed plugin.
1512
		 *
1513
		 * @since 2.1.0
1514
		 *
1515
		 * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
1516
		 *                            Parameter added in v2.5.0.
1517
		 */
1518
		public function populate_file_path( $plugin_slug = '' ) {
1519
			if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
1520
				$this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
1521
			} else {
1522
				// Add file_path key for all plugins.
1523
				foreach ( $this->plugins as $slug => $values ) {
1524
					$this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
1525
				}
1526
			}
1527
		}
1528
1529
		/**
1530
		 * Helper function to extract the file path of the plugin file from the
1531
		 * plugin slug, if the plugin is installed.
1532
		 *
1533
		 * @since 2.0.0
1534
		 *
1535
		 * @param string $slug Plugin slug (typically folder name) as provided by the developer.
1536
		 * @return string Either file path for plugin if installed, or just the plugin slug.
1537
		 */
1538
		protected function _get_plugin_basename_from_slug( $slug ) {
1539
			$keys = array_keys( $this->get_plugins() );
1540
1541
			foreach ( $keys as $key ) {
1542
				if ( preg_match( '|^' . $slug . '/|', $key ) ) {
1543
					return $key;
1544
				}
1545
			}
1546
1547
			return $slug;
1548
		}
1549
1550
		/**
1551
		 * Retrieve plugin data, given the plugin name.
1552
		 *
1553
		 * Loops through the registered plugins looking for $name. If it finds it,
1554
		 * it returns the $data from that plugin. Otherwise, returns false.
1555
		 *
1556
		 * @since 2.1.0
1557
		 *
1558
		 * @param string $name Name of the plugin, as it was registered.
1559
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
1560
		 * @return string|boolean Plugin slug if found, false otherwise.
1561
		 */
1562
		public function _get_plugin_data_from_name( $name, $data = 'slug' ) {
1563
			foreach ( $this->plugins as $values ) {
1564
				if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
1565
					return $values[ $data ];
1566
				}
1567
			}
1568
1569
			return false;
1570
		}
1571
1572
		/**
1573
		 * Retrieve the download URL for a package.
1574
		 *
1575
		 * @since 2.5.0
1576
		 *
1577
		 * @param string $slug Plugin slug.
1578
		 * @return string Plugin download URL or path to local file or empty string if undetermined.
1579
		 */
1580
		public function get_download_url( $slug ) {
1581
			$dl_source = '';
1582
1583
			switch ( $this->plugins[ $slug ]['source_type'] ) {
1584
				case 'repo':
1585
					return $this->get_wp_repo_download_url( $slug );
1586
				case 'external':
1587
					return $this->plugins[ $slug ]['source'];
1588
				case 'bundled':
1589
					return $this->default_path . $this->plugins[ $slug ]['source'];
1590
			}
1591
1592
			return $dl_source; // Should never happen.
1593
		}
1594
1595
		/**
1596
		 * Retrieve the download URL for a WP repo package.
1597
		 *
1598
		 * @since 2.5.0
1599
		 *
1600
		 * @param string $slug Plugin slug.
1601
		 * @return string Plugin download URL.
1602
		 */
1603
		protected function get_wp_repo_download_url( $slug ) {
1604
			$source = '';
1605
			$api    = $this->get_plugins_api( $slug );
1606
1607
			if ( false !== $api && isset( $api->download_link ) ) {
1608
				$source = $api->download_link;
1609
			}
1610
1611
			return $source;
1612
		}
1613
1614
		/**
1615
		 * Try to grab information from WordPress API.
1616
		 *
1617
		 * @since 2.5.0
1618
		 *
1619
		 * @param string $slug Plugin slug.
1620
		 * @return object Plugins_api response object on success, WP_Error on failure.
1621
		 */
1622
		protected function get_plugins_api( $slug ) {
1623
			static $api = array(); // Cache received responses.
1624
1625
			if ( ! isset( $api[ $slug ] ) ) {
1626
				if ( ! function_exists( 'plugins_api' ) ) {
1627
					require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
1628
				}
1629
1630
				$response = plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false ) ) );
1631
1632
				$api[ $slug ] = false;
1633
1634
				if ( is_wp_error( $response ) ) {
1635
					wp_die( esc_html( $this->strings['oops'] ) );
1636
				} else {
1637
					$api[ $slug ] = $response;
1638
				}
1639
			}
1640
1641
			return $api[ $slug ];
1642
		}
1643
1644
		/**
1645
		 * Retrieve a link to a plugin information page.
1646
		 *
1647
		 * @since 2.5.0
1648
		 *
1649
		 * @param string $slug Plugin slug.
1650
		 * @return string Fully formed html link to a plugin information page if available
1651
		 *                or the plugin name if not.
1652
		 */
1653
		public function get_info_link( $slug ) {
1654
			if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
1655
				$link = sprintf(
1656
					'<a href="%1$s" target="_blank">%2$s</a>',
1657
					esc_url( $this->plugins[ $slug ]['external_url'] ),
1658
					esc_html( $this->plugins[ $slug ]['name'] )
1659
				);
1660
			} elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
1661
				$url = add_query_arg(
1662
					array(
1663
						'tab'       => 'plugin-information',
1664
						'plugin'    => urlencode( $slug ),
1665
						'TB_iframe' => 'true',
1666
						'width'     => '640',
1667
						'height'    => '500',
1668
					),
1669
					self_admin_url( 'plugin-install.php' )
1670
				);
1671
1672
				$link = sprintf(
1673
					'<a href="%1$s" class="thickbox">%2$s</a>',
1674
					esc_url( $url ),
1675
					esc_html( $this->plugins[ $slug ]['name'] )
1676
				);
1677
			} else {
1678
				$link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
1679
			}
1680
1681
			return $link;
1682
		}
1683
1684
		/**
1685
		 * Determine if we're on the TGMPA Install page.
1686
		 *
1687
		 * @since 2.1.0
1688
		 *
1689
		 * @return boolean True when on the TGMPA page, false otherwise.
1690
		 */
1691
		protected function is_tgmpa_page() {
1692
			return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
1693
		}
1694
1695
		/**
1696
		 * Retrieve the URL to the TGMPA Install page.
1697
		 *
1698
		 * I.e. depending on the config settings passed something along the lines of:
1699
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
1700
		 *
1701
		 * @since 2.5.0
1702
		 *
1703
		 * @return string Properly encoded URL (not escaped).
1704
		 */
1705
		public function get_tgmpa_url() {
1706
			static $url;
1707
1708
			if ( ! isset( $url ) ) {
1709
				$parent = $this->parent_slug;
1710
				if ( false === strpos( $parent, '.php' ) ) {
1711
					$parent = 'admin.php';
1712
				}
1713
				$url = add_query_arg(
1714
					array(
1715
						'page' => urlencode( $this->menu ),
1716
					),
1717
					self_admin_url( $parent )
1718
				);
1719
			}
1720
1721
			return $url;
1722
		}
1723
1724
		/**
1725
		 * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
1726
		 *
1727
		 * I.e. depending on the config settings passed something along the lines of:
1728
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install
1729
		 *
1730
		 * @since 2.5.0
1731
		 *
1732
		 * @param string $status Plugin status - either 'install', 'update' or 'activate'.
1733
		 * @return string Properly encoded URL (not escaped).
1734
		 */
1735
		public function get_tgmpa_status_url( $status ) {
1736
			return add_query_arg(
1737
				array(
1738
					'plugin_status' => urlencode( $status ),
1739
				),
1740
				$this->get_tgmpa_url()
1741
			);
1742
		}
1743
1744
		/**
1745
		 * Determine whether there are open actions for plugins registered with TGMPA.
1746
		 *
1747
		 * @since 2.5.0
1748
		 *
1749
		 * @return bool True if complete, i.e. no outstanding actions. False otherwise.
1750
		 */
1751
		public function is_tgmpa_complete() {
1752
			$complete = true;
1753
			foreach ( $this->plugins as $slug => $plugin ) {
1754
				if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1755
					$complete = false;
1756
					break;
1757
				}
1758
			}
1759
1760
			return $complete;
1761
		}
1762
1763
		/**
1764
		 * Check if a plugin is installed. Does not take must-use plugins into account.
1765
		 *
1766
		 * @since 2.5.0
1767
		 *
1768
		 * @param string $slug Plugin slug.
1769
		 * @return bool True if installed, false otherwise.
1770
		 */
1771
		public function is_plugin_installed( $slug ) {
1772
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1773
1774
			return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
1775
		}
1776
1777
		/**
1778
		 * Check if a plugin is active.
1779
		 *
1780
		 * @since 2.5.0
1781
		 *
1782
		 * @param string $slug Plugin slug.
1783
		 * @return bool True if active, false otherwise.
1784
		 */
1785
		public function is_plugin_active( $slug ) {
1786
			return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) ) || is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
1787
		}
1788
1789
		/**
1790
		 * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
1791
		 * available, check whether the current install meets them.
1792
		 *
1793
		 * @since 2.5.0
1794
		 *
1795
		 * @param string $slug Plugin slug.
1796
		 * @return bool True if OK to update, false otherwise.
1797
		 */
1798
		public function can_plugin_update( $slug ) {
1799
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1800
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1801
				return true;
1802
			}
1803
1804
			$api = $this->get_plugins_api( $slug );
1805
1806
			if ( false !== $api && isset( $api->requires ) ) {
1807
				return version_compare( $this->wp_version, $api->requires, '>=' );
1808
			}
1809
1810
			// No usable info received from the plugins API, presume we can update.
1811
			return true;
1812
		}
1813
1814
		/**
1815
		 * Check to see if the plugin is 'updatetable', i.e. installed, with an update available
1816
		 * and no WP version requirements blocking it.
1817
		 *
1818
		 * @since 2.x.x
1819
		 *
1820
		 * @param string $slug Plugin slug.
1821
		 * @return bool True if OK to proceed with update, false otherwise.
1822
		 */
1823
		public function is_plugin_updatetable( $slug ) {
1824
			if ( ! $this->is_plugin_installed( $slug ) ) {
1825
				return false;
1826
			} else {
1827
				return ( $this->does_plugin_have_update( $slug ) && $this->can_plugin_update( $slug ) );
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->does_plugin_have_update($slug) of type false|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
1828
			}
1829
		}
1830
1831
		/**
1832
		 * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
1833
		 * plugin version requirements set in TGMPA (if any).
1834
		 *
1835
		 * @since 2.5.0
1836
		 *
1837
		 * @param string $slug Plugin slug.
1838
		 * @return bool True if OK to activate, false otherwise.
1839
		 */
1840
		public function can_plugin_activate( $slug ) {
1841
			return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
1842
		}
1843
1844
		/**
1845
		 * Retrieve the version number of an installed plugin.
1846
		 *
1847
		 * @since 2.5.0
1848
		 *
1849
		 * @param string $slug Plugin slug.
1850
		 * @return string Version number as string or an empty string if the plugin is not installed
1851
		 *                or version unknown (plugins which don't comply with the plugin header standard).
1852
		 */
1853
		public function get_installed_version( $slug ) {
1854
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1855
1856
			if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
1857
				return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
1858
			}
1859
1860
			return '';
1861
		}
1862
1863
		/**
1864
		 * Check whether a plugin complies with the minimum version requirements.
1865
		 *
1866
		 * @since 2.5.0
1867
		 *
1868
		 * @param string $slug Plugin slug.
1869
		 * @return bool True when a plugin needs to be updated, otherwise false.
1870
		 */
1871
		public function does_plugin_require_update( $slug ) {
1872
			$installed_version = $this->get_installed_version( $slug );
1873
			$minimum_version   = $this->plugins[ $slug ]['version'];
1874
1875
			return version_compare( $minimum_version, $installed_version, '>' );
1876
		}
1877
1878
		/**
1879
		 * Check whether there is an update available for a plugin.
1880
		 *
1881
		 * @since 2.5.0
1882
		 *
1883
		 * @param string $slug Plugin slug.
1884
		 * @return false|string Version number string of the available update or false if no update available.
1885
		 */
1886
		public function does_plugin_have_update( $slug ) {
1887
			// Presume bundled and external plugins will point to a package which meets the minimum required version.
1888
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1889
				if ( $this->does_plugin_require_update( $slug ) ) {
1890
					return $this->plugins[ $slug ]['version'];
1891
				}
1892
1893
				return false;
1894
			}
1895
1896
			$repo_updates = get_site_transient( 'update_plugins' );
1897
1898 View Code Duplication
			if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
1899
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
1900
			}
1901
1902
			return false;
1903
		}
1904
1905
		/**
1906
		 * Retrieve potential upgrade notice for a plugin.
1907
		 *
1908
		 * @since 2.5.0
1909
		 *
1910
		 * @param string $slug Plugin slug.
1911
		 * @return string The upgrade notice or an empty string if no message was available or provided.
1912
		 */
1913
		public function get_upgrade_notice( $slug ) {
1914
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1915
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1916
				return '';
1917
			}
1918
1919
			$repo_updates = get_site_transient( 'update_plugins' );
1920
1921 View Code Duplication
			if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
1922
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
1923
			}
1924
1925
			return '';
1926
		}
1927
1928
		/**
1929
		 * Wrapper around the core WP get_plugins function, making sure it's actually available.
1930
		 *
1931
		 * @since 2.5.0
1932
		 *
1933
		 * @param string $plugin_folder Optional. Relative path to single plugin folder.
1934
		 * @return array Array of installed plugins with plugin information.
1935
		 */
1936
		public function get_plugins( $plugin_folder = '' ) {
1937
			if ( ! function_exists( 'get_plugins' ) ) {
1938
				require_once ABSPATH . 'wp-admin/includes/plugin.php';
1939
			}
1940
1941
			return get_plugins( $plugin_folder );
1942
		}
1943
1944
		/**
1945
		 * Delete dismissable nag option when theme is switched.
1946
		 *
1947
		 * This ensures that the user(s) is/are again reminded via nag of required
1948
		 * and/or recommended plugins if they re-activate the theme.
1949
		 *
1950
		 * @since 2.1.1
1951
		 */
1952
		public function update_dismiss() {
1953
			delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
1954
		}
1955
1956
		/**
1957
		 * Forces plugin activation if the parameter 'force_activation' is
1958
		 * set to true.
1959
		 *
1960
		 * This allows theme authors to specify certain plugins that must be
1961
		 * active at all times while using the current theme.
1962
		 *
1963
		 * Please take special care when using this parameter as it has the
1964
		 * potential to be harmful if not used correctly. Setting this parameter
1965
		 * to true will not allow the specified plugin to be deactivated unless
1966
		 * the user switches themes.
1967
		 *
1968
		 * @since 2.2.0
1969
		 */
1970
		public function force_activation() {
1971
			foreach ( $this->plugins as $slug => $plugin ) {
1972
				if ( true === $plugin['force_activation'] ) {
1973
					if ( ! $this->is_plugin_installed( $slug ) ) {
1974
						// Oops, plugin isn't there so iterate to next condition.
1975
						continue;
1976
					} elseif ( $this->can_plugin_activate( $slug ) ) {
1977
						// There we go, activate the plugin.
1978
						activate_plugin( $plugin['file_path'] );
1979
					}
1980
				}
1981
			}
1982
		}
1983
1984
		/**
1985
		 * Forces plugin deactivation if the parameter 'force_deactivation'
1986
		 * is set to true.
1987
		 *
1988
		 * This allows theme authors to specify certain plugins that must be
1989
		 * deactivated upon switching from the current theme to another.
1990
		 *
1991
		 * Please take special care when using this parameter as it has the
1992
		 * potential to be harmful if not used correctly.
1993
		 *
1994
		 * @since 2.2.0
1995
		 */
1996
		public function force_deactivation() {
1997
			foreach ( $this->plugins as $slug => $plugin ) {
1998
				// Only proceed forward if the parameter is set to true and plugin is active.
1999
				if ( true === $plugin['force_deactivation'] && $this->is_plugin_active( $slug ) ) {
2000
					deactivate_plugins( $plugin['file_path'] );
2001
				}
2002
			}
2003
		}
2004
2005
		/**
2006
		 * Echo the current TGMPA version number to the page.
2007
		 */
2008
		public function show_tgmpa_version() {
2009
			echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
2010
				esc_html( sprintf( _x( 'TGMPA v%s', '%s = version number', 'tgmpa' ), self::TGMPA_VERSION ) ),
2011
				'</small></strong></p>';
2012
		}
2013
2014
		/**
2015
		 * Returns the singleton instance of the class.
2016
		 *
2017
		 * @since 2.4.0
2018
		 *
2019
		 * @return object The TGM_Plugin_Activation object.
2020
		 */
2021
		public static function get_instance() {
2022
			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
2023
				self::$instance = new self();
2024
			}
2025
2026
			return self::$instance;
2027
		}
2028
	}
2029
2030
	if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
2031
		/**
2032
		 * Ensure only one instance of the class is ever invoked.
2033
		 */
2034
		function load_tgm_plugin_activation() {
2035
			$GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
2036
		}
2037
	}
2038
2039
	if ( did_action( 'plugins_loaded' ) ) {
2040
		load_tgm_plugin_activation();
2041
	} else {
2042
		add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
2043
	}
2044
}
2045
2046
if ( ! function_exists( 'tgmpa' ) ) {
2047
	/**
2048
	 * Helper function to register a collection of required plugins.
2049
	 *
2050
	 * @since 2.0.0
2051
	 * @api
2052
	 *
2053
	 * @param array $plugins An array of plugin arrays.
2054
	 * @param array $config  Optional. An array of configuration values.
2055
	 */
2056
	function tgmpa( $plugins, $config = array() ) {
2057
		$instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2058
2059
		foreach ( $plugins as $plugin ) {
2060
			call_user_func( array( $instance, 'register' ), $plugin );
2061
		}
2062
2063
		if ( ! empty( $config ) && is_array( $config ) ) {
2064
			// Send out notices for deprecated arguments passed.
2065
			if ( isset( $config['notices'] ) ) {
2066
				_deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
2067
				if ( ! isset( $config['has_notices'] ) ) {
2068
					$config['has_notices'] = $config['notices'];
2069
				}
2070
			}
2071
2072
			if ( isset( $config['parent_menu_slug'] ) ) {
2073
				_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.' );
2074
			}
2075
			if ( isset( $config['parent_url_slug'] ) ) {
2076
				_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.' );
2077
			}
2078
2079
			call_user_func( array( $instance, 'config' ), $config );
2080
		}
2081
	}
2082
}
2083
2084
/**
2085
 * WP_List_Table isn't always available. If it isn't available,
2086
 * we load it here.
2087
 *
2088
 * @since 2.2.0
2089
 */
2090
if ( ! class_exists( 'WP_List_Table' ) ) {
2091
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
2092
}
2093
2094
if ( ! class_exists( 'TGMPA_List_Table' ) ) {
2095
2096
	/**
2097
	 * List table class for handling plugins.
2098
	 *
2099
	 * Extends the WP_List_Table class to provide a future-compatible
2100
	 * way of listing out all required/recommended plugins.
2101
	 *
2102
	 * Gives users an interface similar to the Plugin Administration
2103
	 * area with similar (albeit stripped down) capabilities.
2104
	 *
2105
	 * This class also allows for the bulk install of plugins.
2106
	 *
2107
	 * @since 2.2.0
2108
	 *
2109
	 * @package TGM-Plugin-Activation
2110
	 * @author  Thomas Griffin
2111
	 * @author  Gary Jones
2112
	 */
2113
	class TGMPA_List_Table extends WP_List_Table {
2114
		/**
2115
		 * TGMPA instance.
2116
		 *
2117
		 * @since 2.5.0
2118
		 *
2119
		 * @var object
2120
		 */
2121
		protected $tgmpa;
2122
2123
		/**
2124
		 * The currently chosen view.
2125
		 *
2126
		 * @since 2.5.0
2127
		 *
2128
		 * @var string One of: 'all', 'install', 'update', 'activate'
2129
		 */
2130
		public $view_context = 'all';
2131
2132
		/**
2133
		 * The plugin counts for the various views.
2134
		 *
2135
		 * @since 2.5.0
2136
		 *
2137
		 * @var array
2138
		 */
2139
		protected $view_totals = array(
2140
			'all'      => 0,
2141
			'install'  => 0,
2142
			'update'   => 0,
2143
			'activate' => 0,
2144
		);
2145
2146
		/**
2147
		 * References parent constructor and sets defaults for class.
2148
		 *
2149
		 * @since 2.2.0
2150
		 */
2151
		public function __construct() {
2152
			$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2153
2154
			parent::__construct(
2155
				array(
2156
					'singular' => 'plugin',
2157
					'plural'   => 'plugins',
2158
					'ajax'     => false,
2159
				)
2160
			);
2161
2162
			if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
2163
				$this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
2164
			}
2165
2166
			add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
2167
		}
2168
2169
		/**
2170
		 * Get a list of CSS classes for the <table> tag.
2171
		 *
2172
		 * Overruled to prevent the 'plural' argument from being added.
2173
		 *
2174
		 * @since 2.5.0
2175
		 *
2176
		 * @return array CSS classnames.
2177
		 */
2178
		public function get_table_classes() {
2179
			return array( 'widefat', 'fixed' );
2180
		}
2181
2182
		/**
2183
		 * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
2184
		 *
2185
		 * @since 2.2.0
2186
		 *
2187
		 * @return array $table_data Information for use in table.
2188
		 */
2189
		protected function _gather_plugin_data() {
2190
			// Load thickbox for plugin links.
2191
			$this->tgmpa->admin_init();
2192
			$this->tgmpa->thickbox();
2193
2194
			// Categorize the plugins which have open actions.
2195
			$plugins = $this->categorize_plugins_to_views();
2196
2197
			// Set the counts for the view links.
2198
			$this->set_view_totals( $plugins );
2199
2200
			// Prep variables for use and grab list of all installed plugins.
2201
			$table_data = array();
2202
			$i          = 0;
2203
2204
			// Redirect to the 'all' view if no plugins were found for the selected view context.
2205
			if ( empty( $plugins[ $this->view_context ] ) ) {
2206
				$this->view_context = 'all';
2207
			}
2208
2209
			foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
2210
				$table_data[ $i ]['sanitized_plugin']  = $plugin['name'];
2211
				$table_data[ $i ]['slug']              = $slug;
2212
				$table_data[ $i ]['plugin']            = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
2213
				$table_data[ $i ]['source']            = $this->get_plugin_source_type_text( $plugin['source_type'] );
2214
				$table_data[ $i ]['type']              = $this->get_plugin_advise_type_text( $plugin['required'] );
2215
				$table_data[ $i ]['status']            = $this->get_plugin_status_text( $slug );
2216
				$table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
2217
				$table_data[ $i ]['minimum_version']   = $plugin['version'];
2218
				$table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
2219
2220
				// Prep the upgrade notice info.
2221
				$upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
2222
				if ( ! empty( $upgrade_notice ) ) {
2223
					$table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
2224
2225
					add_action( "tgmpa_after_plugin_row_$slug", array( $this, 'wp_plugin_update_row' ), 10, 2 );
2226
				}
2227
2228
				$table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
2229
2230
				$i++;
2231
			}
2232
2233
			return $table_data;
2234
		}
2235
2236
		/**
2237
		 * Categorize the plugins which have open actions into views for the TGMPA page.
2238
		 *
2239
		 * @since 2.5.0
2240
		 */
2241
		protected function categorize_plugins_to_views() {
2242
			$plugins = array(
2243
				'all'      => array(), // Meaning: all plugins which still have open actions.
2244
				'install'  => array(),
2245
				'update'   => array(),
2246
				'activate' => array(),
2247
			);
2248
2249
			foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
2250
				if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2251
					// No need to display plugins if they are installed, up-to-date and active.
2252
					continue;
2253
				} else {
2254
					$plugins['all'][ $slug ] = $plugin;
2255
2256
					if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2257
						$plugins['install'][ $slug ] = $plugin;
2258
					} else {
2259
						if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2260
							$plugins['update'][ $slug ] = $plugin;
2261
						}
2262
2263
						if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2264
							$plugins['activate'][ $slug ] = $plugin;
2265
						}
2266
					}
2267
				}
2268
			}
2269
2270
			return $plugins;
2271
		}
2272
2273
		/**
2274
		 * Set the counts for the view links.
2275
		 *
2276
		 * @since 2.5.0
2277
		 *
2278
		 * @param array $plugins Plugins order by view.
2279
		 */
2280
		protected function set_view_totals( $plugins ) {
2281
			foreach ( $plugins as $type => $list ) {
2282
				$this->view_totals[ $type ] = count( $list );
2283
			}
2284
		}
2285
2286
		/**
2287
		 * Get the plugin required/recommended text string.
2288
		 *
2289
		 * @since 2.5.0
2290
		 *
2291
		 * @param string $required Plugin required setting.
2292
		 * @return string
2293
		 */
2294
		protected function get_plugin_advise_type_text( $required ) {
2295
			if ( true === $required ) {
2296
				return __( 'Required', 'tgmpa' );
2297
			}
2298
2299
			return __( 'Recommended', 'tgmpa' );
2300
		}
2301
2302
		/**
2303
		 * Get the plugin source type text string.
2304
		 *
2305
		 * @since 2.5.0
2306
		 *
2307
		 * @param string $type Plugin type.
2308
		 * @return string
2309
		 */
2310
		protected function get_plugin_source_type_text( $type ) {
2311
			$string = '';
2312
2313
			switch ( $type ) {
2314
				case 'repo':
2315
					$string = __( 'WordPress Repository', 'tgmpa' );
2316
					break;
2317
				case 'external':
2318
					$string = __( 'External Source', 'tgmpa' );
2319
					break;
2320
				case 'bundled':
2321
					$string = __( 'Pre-Packaged', 'tgmpa' );
2322
					break;
2323
			}
2324
2325
			return $string;
2326
		}
2327
2328
		/**
2329
		 * Determine the plugin status message.
2330
		 *
2331
		 * @since 2.5.0
2332
		 *
2333
		 * @param string $slug Plugin slug.
2334
		 * @return string
2335
		 */
2336
		protected function get_plugin_status_text( $slug ) {
2337
			if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2338
				return __( 'Not Installed', 'tgmpa' );
2339
			}
2340
2341
			if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
2342
				$install_status = __( 'Installed But Not Activated', 'tgmpa' );
2343
			} else {
2344
				$install_status = __( 'Active', 'tgmpa' );
2345
			}
2346
2347
			$update_status = '';
2348
2349
			if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2350
				$update_status = __( 'Required Update not Available', 'tgmpa' );
2351
2352
			} elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
2353
				$update_status = __( 'Requires Update', 'tgmpa' );
2354
2355
			} elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2356
				$update_status = __( 'Update recommended', 'tgmpa' );
2357
			}
2358
2359
			if ( '' === $update_status ) {
2360
				return $install_status;
2361
			}
2362
2363
			return sprintf(
2364
				_x( '%1$s, %2$s', '%1$s = install status, %2$s = update status', 'tgmpa' ),
2365
				$install_status,
2366
				$update_status
2367
			);
2368
		}
2369
2370
		/**
2371
		 * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
2372
		 *
2373
		 * @since 2.5.0
2374
		 *
2375
		 * @param array $items Prepared table items.
2376
		 * @return array Sorted table items.
2377
		 */
2378
		public function sort_table_items( $items ) {
2379
			$type = array();
2380
			$name = array();
2381
2382
			foreach ( $items as $i => $plugin ) {
2383
				$type[ $i ] = $plugin['type']; // Required / recommended.
2384
				$name[ $i ] = $plugin['sanitized_plugin'];
2385
			}
2386
2387
			array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
2388
2389
			return $items;
2390
		}
2391
2392
		/**
2393
		 * Get an associative array ( id => link ) of the views available on this table.
2394
		 *
2395
		 * @since 2.5.0
2396
		 *
2397
		 * @return array
2398
		 */
2399
		public function get_views() {
2400
			$status_links = array();
2401
2402
			foreach ( $this->view_totals as $type => $count ) {
2403
				if ( $count < 1 ) {
2404
					continue;
2405
				}
2406
2407
				switch ( $type ) {
2408
					case 'all':
2409
						$text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
2410
						break;
2411
					case 'install':
2412
						$text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
2413
						break;
2414
					case 'update':
2415
						$text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
2416
						break;
2417
					case 'activate':
2418
						$text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
2419
						break;
2420
					default:
2421
						$text = '';
2422
						break;
2423
				}
2424
2425
				if ( ! empty( $text ) ) {
2426
2427
					$status_links[ $type ] = sprintf(
2428
						'<a href="%s"%s>%s</a>',
2429
						esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
2430
						( $type === $this->view_context ) ? ' class="current"' : '',
2431
						sprintf( $text, number_format_i18n( $count ) )
2432
					);
2433
				}
2434
			}
2435
2436
			return $status_links;
2437
		}
2438
2439
		/**
2440
		 * Create default columns to display important plugin information
2441
		 * like type, action and status.
2442
		 *
2443
		 * @since 2.2.0
2444
		 *
2445
		 * @param array  $item        Array of item data.
2446
		 * @param string $column_name The name of the column.
2447
		 * @return string
2448
		 */
2449
		public function column_default( $item, $column_name ) {
2450
			return $item[ $column_name ];
2451
		}
2452
2453
		/**
2454
		 * Required for bulk installing.
2455
		 *
2456
		 * Adds a checkbox for each plugin.
2457
		 *
2458
		 * @since 2.2.0
2459
		 *
2460
		 * @param array $item Array of item data.
2461
		 * @return string The input checkbox with all necessary info.
2462
		 */
2463
		public function column_cb( $item ) {
2464
			return sprintf(
2465
				'<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
2466
				esc_attr( $this->_args['singular'] ),
2467
				esc_attr( $item['slug'] ),
2468
				esc_attr( $item['sanitized_plugin'] )
2469
			);
2470
		}
2471
2472
		/**
2473
		 * Create default title column along with the action links.
2474
		 *
2475
		 * @since 2.2.0
2476
		 *
2477
		 * @param array $item Array of item data.
2478
		 * @return string The plugin name and action links.
2479
		 */
2480
		public function column_plugin( $item ) {
2481
			return sprintf(
2482
				'%1$s %2$s',
2483
				$item['plugin'],
2484
				$this->row_actions( $this->get_row_actions( $item ), true )
2485
			);
2486
		}
2487
2488
		/**
2489
		 * Create version information column.
2490
		 *
2491
		 * @since 2.5.0
2492
		 *
2493
		 * @param array $item Array of item data.
2494
		 * @return string HTML-formatted version information.
2495
		 */
2496
		public function column_version( $item ) {
2497
			$output = array();
2498
2499
			if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2500
				$installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
2501
2502
				$color = '';
2503
				if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
2504
					$color = ' color: #ff0000; font-weight: bold;';
2505
				}
2506
2507
				$output[] = sprintf(
2508
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
2509
					$color,
2510
					$installed
2511
				);
2512
			}
2513
2514
			if ( ! empty( $item['minimum_version'] ) ) {
2515
				$output[] = sprintf(
2516
					'<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
2517
					$item['minimum_version']
2518
				);
2519
			}
2520
2521
			if ( ! empty( $item['available_version'] ) ) {
2522
				$color = '';
2523
				if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
2524
					$color = ' color: #71C671; font-weight: bold;';
2525
				}
2526
2527
				$output[] = sprintf(
2528
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
2529
					$color,
2530
					$item['available_version']
2531
				);
2532
			}
2533
2534
			if ( empty( $output ) ) {
2535
				return '&nbsp;'; // Let's not break the table layout.
2536
			} else {
2537
				return implode( "\n", $output );
2538
			}
2539
		}
2540
2541
		/**
2542
		 * Sets default message within the plugins table if no plugins
2543
		 * are left for interaction.
2544
		 *
2545
		 * Hides the menu item to prevent the user from clicking and
2546
		 * getting a permissions error.
2547
		 *
2548
		 * @since 2.2.0
2549
		 */
2550
		public function no_items() {
2551
			printf( wp_kses_post( __( 'No plugins to install, update or activate. <a href="%1$s">Return to the Dashboard</a>', 'tgmpa' ) ), esc_url( self_admin_url() ) );
2552
			echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
2553
		}
2554
2555
		/**
2556
		 * Output all the column information within the table.
2557
		 *
2558
		 * @since 2.2.0
2559
		 *
2560
		 * @return array $columns The column names.
2561
		 */
2562
		public function get_columns() {
2563
			$columns = array(
2564
				'cb'     => '<input type="checkbox" />',
2565
				'plugin' => __( 'Plugin', 'tgmpa' ),
2566
				'source' => __( 'Source', 'tgmpa' ),
2567
				'type'   => __( 'Type', 'tgmpa' ),
2568
			);
2569
2570
			if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
2571
				$columns['version'] = __( 'Version', 'tgmpa' );
2572
				$columns['status']  = __( 'Status', 'tgmpa' );
2573
			}
2574
2575
			return apply_filters( 'tgmpa_table_columns', $columns );
2576
		}
2577
2578
		/**
2579
		 * Get name of default primary column
2580
		 *
2581
		 * @since 2.5.0 / WP 4.3+ compatibility
2582
		 * @access protected
2583
		 *
2584
		 * @return string
2585
		 */
2586
		protected function get_default_primary_column_name() {
2587
			return 'plugin';
2588
		}
2589
2590
		/**
2591
		 * Get the name of the primary column.
2592
		 *
2593
		 * @since 2.5.0 / WP 4.3+ compatibility
2594
		 * @access protected
2595
		 *
2596
		 * @return string The name of the primary column.
2597
		 */
2598
		protected function get_primary_column_name() {
2599
			if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
2600
				return parent::get_primary_column_name();
2601
			} else {
2602
				return $this->get_default_primary_column_name();
2603
			}
2604
		}
2605
2606
		/**
2607
		 * Get the actions which are relevant for a specific plugin row.
2608
		 *
2609
		 * @since 2.5.0
2610
		 *
2611
		 * @param array $item Array of item data.
2612
		 * @return array Array with relevant action links.
2613
		 */
2614
		protected function get_row_actions( $item ) {
2615
			$actions      = array();
2616
			$action_links = array();
2617
2618
			// Display the 'Install' action link if the plugin is not yet available.
2619
			if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2620
				$actions['install'] = _x( 'Install %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2621
			} else {
2622
				// Display the 'Update' action link if an update is available and WP complies with plugin minimum.
2623
				if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
2624
					$actions['update'] = _x( 'Update %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2625
				}
2626
2627
				// Display the 'Activate' action link, but only if the plugin meets the minimum version.
2628
				if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
2629
					$actions['activate'] = _x( 'Activate %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2630
				}
2631
			}
2632
2633
			// Create the actual links.
2634
			foreach ( $actions as $action => $text ) {
2635
				$nonce_url = wp_nonce_url(
2636
					add_query_arg(
2637
						array(
2638
							'plugin'           => urlencode( $item['slug'] ),
2639
							'tgmpa-' . $action => $action . '-plugin',
2640
						),
2641
						$this->tgmpa->get_tgmpa_url()
2642
					),
2643
					'tgmpa-' . $action,
2644
					'tgmpa-nonce'
2645
				);
2646
2647
				$action_links[ $action ] = sprintf(
2648
					'<a href="%1$s">' . esc_html( $text ) . '</a>',
2649
					esc_url( $nonce_url ),
2650
					'<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
2651
				);
2652
			}
2653
2654
			$prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
2655
			return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
2656
		}
2657
2658
		/**
2659
		 * Generates content for a single row of the table.
2660
		 *
2661
		 * @since 2.5.0
2662
		 *
2663
		 * @param object $item The current item.
2664
		 */
2665
		public function single_row( $item ) {
2666
			parent::single_row( $item );
2667
2668
			/**
2669
			 * Fires after each specific row in the TGMPA Plugins list table.
2670
			 *
2671
			 * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
2672
			 * for the plugin.
2673
			 *
2674
			 * @since 2.5.0
2675
			 */
2676
			do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
2677
		}
2678
2679
		/**
2680
		 * Show the upgrade notice below a plugin row if there is one.
2681
		 *
2682
		 * @since 2.5.0
2683
		 *
2684
		 * @see /wp-admin/includes/update.php
2685
		 *
2686
		 * @param string $slug Plugin slug.
2687
		 * @param array  $item The information available in this table row.
2688
		 * @return null Return early if upgrade notice is empty.
2689
		 */
2690
		public function wp_plugin_update_row( $slug, $item ) {
2691
			if ( empty( $item['upgrade_notice'] ) ) {
2692
				return;
2693
			}
2694
2695
			echo '
2696
				<tr class="plugin-update-tr">
2697
					<td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
2698
						<div class="update-message">',
2699
							esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
2700
							' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
2701
						</div>
2702
					</td>
2703
				</tr>';
2704
		}
2705
2706
		/**
2707
		 * Extra controls to be displayed between bulk actions and pagination.
2708
		 *
2709
		 * @since 2.5.0
2710
		 *
2711
		 * @param string $which 'top' or 'bottom' table navigation.
2712
		 */
2713
		public function extra_tablenav( $which ) {
2714
			if ( 'bottom' === $which ) {
2715
				$this->tgmpa->show_tgmpa_version();
2716
			}
2717
		}
2718
2719
		/**
2720
		 * Defines the bulk actions for handling registered plugins.
2721
		 *
2722
		 * @since 2.2.0
2723
		 *
2724
		 * @return array $actions The bulk actions for the plugin install table.
2725
		 */
2726
		public function get_bulk_actions() {
2727
2728
			$actions = array();
2729
2730
			if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
2731
				if ( current_user_can( 'install_plugins' ) ) {
2732
					$actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
2733
				}
2734
			}
2735
2736
			if ( 'install' !== $this->view_context ) {
2737
				if ( current_user_can( 'update_plugins' ) ) {
2738
					$actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
2739
				}
2740
				if ( current_user_can( 'activate_plugins' ) ) {
2741
					$actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
2742
				}
2743
			}
2744
2745
			return $actions;
2746
		}
2747
2748
		/**
2749
		 * Processes bulk installation and activation actions.
2750
		 *
2751
		 * The bulk installation process looks for the $_POST information and passes that
2752
		 * through if a user has to use WP_Filesystem to enter their credentials.
2753
		 *
2754
		 * @since 2.2.0
2755
		 */
2756
		public function process_bulk_actions() {
2757
			// Bulk installation process.
2758
			if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
2759
2760
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2761
2762
				$install_type = 'install';
2763
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2764
					$install_type = 'update';
2765
				}
2766
2767
				$plugins_to_install = array();
2768
2769
				// Did user actually select any plugins to install/update ?
2770 View Code Duplication
				if ( empty( $_POST['plugin'] ) ) {
2771
					if ( 'install' === $install_type ) {
2772
						$message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
2773
					} else {
2774
						$message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
2775
					}
2776
2777
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2778
2779
					return false;
2780
				}
2781
2782
				if ( is_array( $_POST['plugin'] ) ) {
2783
					$plugins_to_install = (array) $_POST['plugin'];
2784
				} elseif ( is_string( $_POST['plugin'] ) ) {
2785
					// Received via Filesystem page - un-flatten array (WP bug #19643).
2786
					$plugins_to_install = explode( ',', $_POST['plugin'] );
2787
				}
2788
2789
				// Sanitize the received input.
2790
				$plugins_to_install = array_map( 'urldecode', $plugins_to_install );
2791
				$plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
2792
2793
				// Validate the received input.
2794
				foreach ( $plugins_to_install as $key => $slug ) {
2795
					// Check if the plugin was registered with TGMPA and remove if not.
2796
					if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
2797
						unset( $plugins_to_install[ $key ] );
2798
						continue;
2799
					}
2800
2801
					// For install: make sure this is a plugin we *can* install and not one already installed.
2802
					if ( 'install' === $install_type && true === $this->tgmpa->is_plugin_installed( $slug ) ) {
2803
						unset( $plugins_to_install[ $key ] );
2804
					}
2805
2806
					// For updates: make sure this is a plugin we *can* update (update available and WP version ok).
2807
					if ( 'update' === $install_type && false === $this->tgmpa->is_plugin_updatetable( $slug ) ) {
2808
						unset( $plugins_to_install[ $key ] );
2809
					}
2810
				}
2811
2812
				// No need to proceed further if we have no plugins to handle.
2813 View Code Duplication
				if ( empty( $plugins_to_install ) ) {
2814
					if ( 'install' === $install_type ) {
2815
						$message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
2816
					} else {
2817
						$message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
2818
					}
2819
2820
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2821
2822
					return false;
2823
				}
2824
2825
				// Pass all necessary information if WP_Filesystem is needed.
2826
				$url = wp_nonce_url(
2827
					$this->tgmpa->get_tgmpa_url(),
2828
					'bulk-' . $this->_args['plural']
2829
				);
2830
2831
				// Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
2832
				$_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
2833
2834
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
2835
				$fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
2836
2837 View Code Duplication
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields ) ) ) {
2838
					return true; // Stop the normal page form from displaying, credential request form will be shown.
2839
				}
2840
2841
				// Now we have some credentials, setup WP_Filesystem.
2842 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
0 ignored issues
show
This code seems to be duplicated across your project.

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

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

Loading history...
2843
					// Our credentials were no good, ask the user for them again.
2844
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
2845
2846
					return true;
2847
				}
2848
2849
				/* If we arrive here, we have the filesystem */
2850
2851
				// Store all information in arrays since we are processing a bulk installation.
2852
				$names      = array();
2853
				$sources    = array(); // Needed for installs.
2854
				$file_paths = array(); // Needed for upgrades.
2855
				$to_inject  = array(); // Information to inject into the update_plugins transient.
2856
2857
				// Prepare the data for validated plugins for the install/upgrade.
2858
				foreach ( $plugins_to_install as $slug ) {
2859
					$name   = $this->tgmpa->plugins[ $slug ]['name'];
2860
					$source = $this->tgmpa->get_download_url( $slug );
2861
2862
					if ( ! empty( $name ) && ! empty( $source ) ) {
2863
						$names[] = $name;
2864
2865
						switch ( $install_type ) {
2866
2867
							case 'install':
2868
								$sources[] = $source;
2869
								break;
2870
2871
							case 'update':
2872
								$file_paths[]                 = $this->tgmpa->plugins[ $slug ]['file_path'];
2873
								$to_inject[ $slug ]           = $this->tgmpa->plugins[ $slug ];
2874
								$to_inject[ $slug ]['source'] = $source;
2875
								break;
2876
						}
2877
					}
2878
				}
2879
				unset( $slug, $name, $source );
2880
2881
				// Create a new instance of TGMPA_Bulk_Installer.
2882
				$installer = new TGMPA_Bulk_Installer(
2883
					new TGMPA_Bulk_Installer_Skin(
2884
						array(
2885
							'url'          => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
2886
							'nonce'        => 'bulk-' . $this->_args['plural'],
2887
							'names'        => $names,
2888
							'install_type' => $install_type,
2889
						)
2890
					)
2891
				);
2892
2893
				// Wrap the install process with the appropriate HTML.
2894
				echo '<div class="tgmpa">',
2895
					'<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>
2896
					<div class="update-php" style="width: 100%; height: 98%; min-height: 850px; padding-top: 1px;">';
2897
2898
				// Process the bulk installation submissions.
2899
				add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
2900
2901
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2902
					// Inject our info into the update transient.
2903
					$this->tgmpa->inject_update_info( $to_inject );
2904
2905
					$installer->bulk_upgrade( $file_paths );
2906
				} else {
2907
					$installer->bulk_install( $sources );
2908
				}
2909
2910
				remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
2911
2912
				echo '</div></div>';
2913
2914
				return true;
2915
			}
2916
2917
			// Bulk activation process.
2918
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
2919
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2920
2921
				// Did user actually select any plugins to activate ?
2922
				if ( empty( $_POST['plugin'] ) ) {
2923
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
2924
2925
					return false;
2926
				}
2927
2928
				// Grab plugin data from $_POST.
2929
				$plugins = array();
2930
				if ( isset( $_POST['plugin'] ) ) {
2931
					$plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
2932
					$plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
2933
				}
2934
2935
				$plugins_to_activate = array();
2936
				$plugin_names        = array();
2937
2938
				// Grab the file paths for the selected & inactive plugins from the registration array.
2939
				foreach ( $plugins as $slug ) {
2940
					if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2941
						$plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
2942
						$plugin_names[]        = $this->tgmpa->plugins[ $slug ]['name'];
2943
					}
2944
				}
2945
				unset( $slug );
2946
2947
				// Return early if there are no plugins to activate.
2948
				if ( empty( $plugins_to_activate ) ) {
2949
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
2950
2951
					return false;
2952
				}
2953
2954
				// Now we are good to go - let's start activating plugins.
2955
				$activate = activate_plugins( $plugins_to_activate );
2956
2957
				if ( is_wp_error( $activate ) ) {
2958
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
2959
				} else {
2960
					$count        = count( $plugin_names ); // Count so we can use _n function.
2961
					$plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
2962
					$last_plugin  = array_pop( $plugin_names ); // Pop off last name to prep for readability.
2963
					$imploded     = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
2964
2965
					printf( // WPCS: xss ok.
2966
						'<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
2967
						esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
2968
						$imploded
2969
					);
2970
2971
					// Update recently activated plugins option.
2972
					$recent = (array) get_option( 'recently_activated' );
2973
					foreach ( $plugins_to_activate as $plugin => $time ) {
2974
						if ( isset( $recent[ $plugin ] ) ) {
2975
							unset( $recent[ $plugin ] );
2976
						}
2977
					}
2978
					update_option( 'recently_activated', $recent );
2979
				}
2980
2981
				unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
2982
2983
				return true;
2984
			}
2985
2986
			return false;
2987
		}
2988
2989
		/**
2990
		 * Prepares all of our information to be outputted into a usable table.
2991
		 *
2992
		 * @since 2.2.0
2993
		 */
2994
		public function prepare_items() {
2995
			$columns               = $this->get_columns(); // Get all necessary column information.
2996
			$hidden                = array(); // No columns to hide, but we must set as an array.
2997
			$sortable              = array(); // No reason to make sortable columns.
2998
			$primary               = $this->get_primary_column_name(); // Column which has the row actions.
2999
			$this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
3000
3001
			// Process our bulk activations here.
3002
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3003
				$this->process_bulk_actions();
3004
			}
3005
3006
			// Store all of our plugin data into $items array so WP_List_Table can use it.
3007
			$this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
3008
		}
3009
3010
		/* *********** DEPRECATED METHODS *********** */
3011
3012
		/**
3013
		 * Retrieve plugin data, given the plugin name.
3014
		 *
3015
		 * @since      2.2.0
3016
		 * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
3017
		 * @see        TGM_Plugin_Activation::_get_plugin_data_from_name()
3018
		 *
3019
		 * @param string $name Name of the plugin, as it was registered.
3020
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
3021
		 * @return string|boolean Plugin slug if found, false otherwise.
3022
		 */
3023
		protected function _get_plugin_data_from_name( $name, $data = 'slug' ) {
3024
			_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
3025
3026
			return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
3027
		}
3028
	}
3029
}
3030
3031
3032
if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
3033
3034
	/**
3035
	 * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
3036
	 */
3037
	class TGM_Bulk_Installer {
3038
	}
3039
}
3040
if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
3041
3042
	/**
3043
	 * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
3044
	 */
3045
	class TGM_Bulk_Installer_Skin {
3046
	}
3047
}
3048
3049
/**
3050
 * The WP_Upgrader file isn't always available. If it isn't available,
3051
 * we load it here.
3052
 *
3053
 * We check to make sure no action or activation keys are set so that WordPress
3054
 * does not try to re-include the class when processing upgrades or installs outside
3055
 * of the class.
3056
 *
3057
 * @since 2.2.0
3058
 */
3059
add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
3060
if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
3061
	/**
3062
	 * Load bulk installer
3063
	 */
3064
	function tgmpa_load_bulk_installer() {
3065
		// Silently fail if 2.5+ is loaded *after* an older version.
3066
		if ( ! isset( $GLOBALS['tgmpa'] ) ) {
3067
			return;
3068
		}
3069
3070
		// Get TGMPA class instance.
3071
		$tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3072
3073
		if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
3074
			if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
3075
				require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
3076
			}
3077
3078
			if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
3079
3080
				/**
3081
				 * Installer class to handle bulk plugin installations.
3082
				 *
3083
				 * Extends WP_Upgrader and customizes to suit the installation of multiple
3084
				 * plugins.
3085
				 *
3086
				 * @since 2.2.0
3087
				 *
3088
				 * {@internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader.}}
3089
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
3090
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3091
				 *
3092
				 * @package TGM-Plugin-Activation
3093
				 * @author  Thomas Griffin
3094
				 * @author  Gary Jones
3095
				 */
3096
				class TGMPA_Bulk_Installer extends Plugin_Upgrader {
3097
					/**
3098
					 * Holds result of bulk plugin installation.
3099
					 *
3100
					 * @since 2.2.0
3101
					 *
3102
					 * @var string
3103
					 */
3104
					public $result;
3105
3106
					/**
3107
					 * Flag to check if bulk installation is occurring or not.
3108
					 *
3109
					 * @since 2.2.0
3110
					 *
3111
					 * @var boolean
3112
					 */
3113
					public $bulk = false;
3114
3115
					/**
3116
					 * TGMPA instance
3117
					 *
3118
					 * @since 2.5.0
3119
					 *
3120
					 * @var object
3121
					 */
3122
					protected $tgmpa;
3123
3124
					/**
3125
					 * Whether or not the destination directory needs to be cleared ( = on update).
3126
					 *
3127
					 * @since 2.5.0
3128
					 *
3129
					 * @var bool
3130
					 */
3131
					protected $clear_destination = false;
3132
3133
					/**
3134
					 * References parent constructor and sets defaults for class.
3135
					 *
3136
					 * @since 2.2.0
3137
					 *
3138
					 * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
3139
					 */
3140
					public function __construct( $skin = null ) {
3141
						// Get TGMPA class instance.
3142
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3143
3144
						parent::__construct( $skin );
3145
3146
						if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
3147
							$this->clear_destination = true;
3148
						}
3149
3150
						if ( $this->tgmpa->is_automatic ) {
3151
							$this->activate_strings();
3152
						}
3153
3154
						add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
3155
					}
3156
3157
					/**
3158
					 * Sets the correct activation strings for the installer skin to use.
3159
					 *
3160
					 * @since 2.2.0
3161
					 */
3162
					public function activate_strings() {
3163
						$this->strings['activation_failed']  = __( 'Plugin activation failed.', 'tgmpa' );
3164
						$this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
3165
					}
3166
3167
					/**
3168
					 * Performs the actual installation of each plugin.
3169
					 *
3170
					 * @since 2.2.0
3171
					 *
3172
					 * @see WP_Upgrader::run()
3173
					 *
3174
					 * @param array $options The installation config options.
3175
					 * @return null|array Return early if error, array of installation data on success.
3176
					 */
3177
					public function run( $options ) {
3178
						$result = parent::run( $options );
3179
3180
						// Reset the strings in case we changed one during automatic activation.
3181
						if ( $this->tgmpa->is_automatic ) {
3182
							if ( 'update' === $this->skin->options['install_type'] ) {
3183
								$this->upgrade_strings();
3184
							} else {
3185
								$this->install_strings();
3186
							}
3187
						}
3188
3189
						return $result;
3190
					}
3191
3192
					/**
3193
					 * Processes the bulk installation of plugins.
3194
					 *
3195
					 * @since 2.2.0
3196
					 *
3197
					 * {@internal This is basically a near identical copy of the WP Core
3198
					 * Plugin_Upgrader::bulk_upgrade() method, with minor adjustments to deal with
3199
					 * new installs instead of upgrades.
3200
					 * For ease of future synchronizations, the adjustments are clearly commented, but no other
3201
					 * comments are added. Code style has been made to comply.}}
3202
					 *
3203
					 * @see Plugin_Upgrader::bulk_upgrade()
3204
					 * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
3205
					 * (@internal Last synced: Dec 31st 2015 against https://core.trac.wordpress.org/browser/trunk?rev=36134}}
3206
					 *
3207
					 * @param array $plugins The plugin sources needed for installation.
3208
					 * @param array $args    Arbitrary passed extra arguments.
3209
					 * @return string|bool Install confirmation messages on success, false on failure.
3210
					 */
3211
					public function bulk_install( $plugins, $args = array() ) {
3212
						// [TGMPA + ] Hook auto-activation in.
3213
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3214
3215
						$defaults    = array(
3216
							'clear_update_cache' => true,
3217
						);
3218
						$parsed_args = wp_parse_args( $args, $defaults );
3219
3220
						$this->init();
3221
						$this->bulk = true;
3222
3223
						$this->install_strings(); // [TGMPA + ] adjusted.
3224
3225
						/* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
3226
3227
						/* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
3228
3229
						$this->skin->header();
3230
3231
						// Connect to the Filesystem first.
3232
						$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
3233
						if ( ! $res ) {
3234
							$this->skin->footer();
3235
							return false;
3236
						}
3237
3238
						$this->skin->bulk_header();
3239
3240
						/*
3241
						 * Only start maintenance mode if:
3242
						 * - running Multisite and there are one or more plugins specified, OR
3243
						 * - a plugin with an update available is currently active.
3244
						 * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
3245
						 */
3246
						$maintenance = ( is_multisite() && ! empty( $plugins ) );
3247
3248
						/*
1 ignored issue
show
Unused Code Comprehensibility introduced by
49% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
3249
						[TGMPA - ]
3250
						foreach ( $plugins as $plugin )
3251
							$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
3252
						*/
3253
						if ( $maintenance ) {
3254
							$this->maintenance_mode( true );
3255
						}
3256
3257
						$results = array();
3258
3259
						$this->update_count   = count( $plugins );
3260
						$this->update_current = 0;
3261
						foreach ( $plugins as $plugin ) {
3262
							$this->update_current++;
3263
3264
							/*
1 ignored issue
show
Unused Code Comprehensibility introduced by
48% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
3265
							[TGMPA - ]
3266
							$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
3267
3268
							if ( !isset( $current->response[ $plugin ] ) ) {
3269
								$this->skin->set_result('up_to_date');
3270
								$this->skin->before();
3271
								$this->skin->feedback('up_to_date');
3272
								$this->skin->after();
3273
								$results[$plugin] = true;
3274
								continue;
3275
							}
3276
3277
							// Get the URL to the zip file.
3278
							$r = $current->response[ $plugin ];
3279
3280
							$this->skin->plugin_active = is_plugin_active($plugin);
3281
							*/
3282
3283
							$result = $this->run(
3284
								array(
3285
									'package'           => $plugin, // [TGMPA + ] adjusted.
3286
									'destination'       => WP_PLUGIN_DIR,
3287
									'clear_destination' => false, // [TGMPA + ] adjusted.
3288
									'clear_working'     => true,
3289
									'is_multi'          => true,
3290
									'hook_extra'        => array(
3291
										'plugin' => $plugin,
3292
									),
3293
								)
3294
							);
3295
3296
							$results[ $plugin ] = $this->result;
3297
3298
							// Prevent credentials auth screen from displaying multiple times.
3299
							if ( false === $result ) {
3300
								break;
3301
							}
3302
						} //end foreach $plugins
3303
3304
						$this->maintenance_mode( false );
3305
3306
						/**
3307
						 * Fires when the bulk upgrader process is complete.
3308
						 *
3309
						 * @since WP 3.6.0 / TGMPA 2.5.0
3310
						 *
3311
						 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
3312
						 *                              be a Theme_Upgrader or Core_Upgrade instance.
3313
						 * @param array           $data {
3314
						 *     Array of bulk item update data.
3315
						 *
3316
						 *     @type string $action   Type of action. Default 'update'.
3317
						 *     @type string $type     Type of update process. Accepts 'plugin', 'theme', or 'core'.
3318
						 *     @type bool   $bulk     Whether the update process is a bulk update. Default true.
3319
						 *     @type array  $packages Array of plugin, theme, or core packages to update.
3320
						 * }
3321
						 */
3322
						do_action( 'upgrader_process_complete', $this, array(
3323
							'action'  => 'install', // [TGMPA + ] adjusted.
3324
							'type'    => 'plugin',
3325
							'bulk'    => true,
3326
							'plugins' => $plugins,
3327
						) );
3328
3329
						$this->skin->bulk_footer();
3330
3331
						$this->skin->footer();
3332
3333
						// Cleanup our hooks, in case something else does a upgrade on this connection.
3334
						/* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
3335
3336
						// [TGMPA + ] Remove our auto-activation hook.
3337
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3338
3339
						// Force refresh of plugin update information.
3340
						wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
3341
3342
						return $results;
3343
					}
3344
3345
					/**
3346
					 * Handle a bulk upgrade request.
3347
					 *
3348
					 * @since 2.5.0
3349
					 *
3350
					 * @see Plugin_Upgrader::bulk_upgrade()
3351
					 *
3352
					 * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
3353
					 * @param array $args    Arbitrary passed extra arguments.
3354
					 * @return string|bool Install confirmation messages on success, false on failure.
3355
					 */
3356
					public function bulk_upgrade( $plugins, $args = array() ) {
3357
3358
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3359
3360
						$result = parent::bulk_upgrade( $plugins, $args );
3361
3362
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3363
3364
						return $result;
3365
					}
3366
3367
					/**
3368
					 * Abuse a filter to auto-activate plugins after installation.
3369
					 *
3370
					 * Hooked into the 'upgrader_post_install' filter hook.
3371
					 *
3372
					 * @since 2.5.0
3373
					 *
3374
					 * @param bool $bool The value we need to give back (true).
3375
					 * @return bool
3376
					 */
3377
					public function auto_activate( $bool ) {
3378
						// Only process the activation of installed plugins if the automatic flag is set to true.
3379
						if ( $this->tgmpa->is_automatic ) {
3380
							// Flush plugins cache so the headers of the newly installed plugins will be read correctly.
3381
							wp_clean_plugins_cache();
3382
3383
							// Get the installed plugin file.
3384
							$plugin_info = $this->plugin_info();
3385
3386
							// Don't try to activate on upgrade of active plugin as WP will do this already.
3387
							if ( ! is_plugin_active( $plugin_info ) ) {
3388
								$activate = activate_plugin( $plugin_info );
3389
3390
								// Adjust the success string based on the activation result.
3391
								$this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
3392
3393
								if ( is_wp_error( $activate ) ) {
3394
									$this->skin->error( $activate );
3395
									$this->strings['process_success'] .= $this->strings['activation_failed'];
3396
								} else {
3397
									$this->strings['process_success'] .= $this->strings['activation_success'];
3398
								}
3399
							}
3400
						}
3401
3402
						return $bool;
3403
					}
3404
				}
3405
			}
3406
3407
			if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
3408
3409
				/**
3410
				 * Installer skin to set strings for the bulk plugin installations..
3411
				 *
3412
				 * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
3413
				 * plugins.
3414
				 *
3415
				 * @since 2.2.0
3416
				 *
3417
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
3418
				 *           TGMPA_Bulk_Installer_Skin.
3419
				 *           This was done to prevent backward compatibility issues with v2.3.6.}}
3420
				 *
3421
				 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
3422
				 *
3423
				 * @package TGM-Plugin-Activation
3424
				 * @author  Thomas Griffin
3425
				 * @author  Gary Jones
3426
				 */
3427
				class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
3428
					/**
3429
					 * Holds plugin info for each individual plugin installation.
3430
					 *
3431
					 * @since 2.2.0
3432
					 *
3433
					 * @var array
3434
					 */
3435
					public $plugin_info = array();
3436
3437
					/**
3438
					 * Holds names of plugins that are undergoing bulk installations.
3439
					 *
3440
					 * @since 2.2.0
3441
					 *
3442
					 * @var array
3443
					 */
3444
					public $plugin_names = array();
3445
3446
					/**
3447
					 * Integer to use for iteration through each plugin installation.
3448
					 *
3449
					 * @since 2.2.0
3450
					 *
3451
					 * @var integer
3452
					 */
3453
					public $i = 0;
3454
3455
					/**
3456
					 * TGMPA instance
3457
					 *
3458
					 * @since 2.5.0
3459
					 *
3460
					 * @var object
3461
					 */
3462
					protected $tgmpa;
3463
3464
					/**
3465
					 * Constructor. Parses default args with new ones and extracts them for use.
3466
					 *
3467
					 * @since 2.2.0
3468
					 *
3469
					 * @param array $args Arguments to pass for use within the class.
3470
					 */
3471
					public function __construct( $args = array() ) {
3472
						// Get TGMPA class instance.
3473
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3474
3475
						// Parse default and new args.
3476
						$defaults = array(
3477
							'url'          => '',
3478
							'nonce'        => '',
3479
							'names'        => array(),
3480
							'install_type' => 'install',
3481
						);
3482
						$args     = wp_parse_args( $args, $defaults );
3483
3484
						// Set plugin names to $this->plugin_names property.
3485
						$this->plugin_names = $args['names'];
3486
3487
						// Extract the new args.
3488
						parent::__construct( $args );
3489
					}
3490
3491
					/**
3492
					 * Sets install skin strings for each individual plugin.
3493
					 *
3494
					 * Checks to see if the automatic activation flag is set and uses the
3495
					 * the proper strings accordingly.
3496
					 *
3497
					 * @since 2.2.0
3498
					 */
3499
					public function add_strings() {
3500
						if ( 'update' === $this->options['install_type'] ) {
3501
							parent::add_strings();
3502
							$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3503
						} else {
3504
							$this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
3505
							$this->upgrader->strings['skin_update_failed']       = __( 'The installation of %1$s failed.', 'tgmpa' );
3506
3507
							if ( $this->tgmpa->is_automatic ) {
3508
								// Automatic activation strings.
3509
								$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' );
3510
								$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>';
3511
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations and activations have been completed.', 'tgmpa' );
3512
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3513
							} else {
3514
								// Default installation strings.
3515
								$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' );
3516
								$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>';
3517
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations have been completed.', 'tgmpa' );
3518
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3519
							}
3520
						}
3521
					}
3522
3523
					/**
3524
					 * Outputs the header strings and necessary JS before each plugin installation.
3525
					 *
3526
					 * @since 2.2.0
3527
					 *
3528
					 * @param string $title Unused in this implementation.
3529
					 */
3530
					public function before( $title = '' ) {
3531
						if ( empty( $title ) ) {
3532
							$title = esc_html( $this->plugin_names[ $this->i ] );
3533
						}
3534
						parent::before( $title );
3535
					}
3536
3537
					/**
3538
					 * Outputs the footer strings and necessary JS after each plugin installation.
3539
					 *
3540
					 * Checks for any errors and outputs them if they exist, else output
3541
					 * success strings.
3542
					 *
3543
					 * @since 2.2.0
3544
					 *
3545
					 * @param string $title Unused in this implementation.
3546
					 */
3547
					public function after( $title = '' ) {
3548
						if ( empty( $title ) ) {
3549
							$title = esc_html( $this->plugin_names[ $this->i ] );
3550
						}
3551
						parent::after( $title );
3552
3553
						$this->i++;
3554
					}
3555
3556
					/**
3557
					 * Outputs links after bulk plugin installation is complete.
3558
					 *
3559
					 * @since 2.2.0
3560
					 */
3561
					public function bulk_footer() {
3562
						// Serve up the string to say installations (and possibly activations) are complete.
3563
						parent::bulk_footer();
3564
3565
						// Flush plugins cache so we can make sure that the installed plugins list is always up to date.
3566
						wp_clean_plugins_cache();
3567
3568
						$this->tgmpa->show_tgmpa_version();
3569
3570
						// Display message based on if all plugins are now active or not.
3571
						$update_actions = array();
3572
3573
						if ( $this->tgmpa->is_tgmpa_complete() ) {
3574
							// All plugins are active, so we display the complete string and hide the menu to protect users.
3575
							echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
3576
							$update_actions['dashboard'] = sprintf(
3577
								esc_html( $this->tgmpa->strings['complete'] ),
3578
								'<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>'
3579
							);
3580
						} else {
3581
							$update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
3582
						}
3583
3584
						/**
3585
						 * Filter the list of action links available following bulk plugin installs/updates.
3586
						 *
3587
						 * @since 2.5.0
3588
						 *
3589
						 * @param array $update_actions Array of plugin action links.
3590
						 * @param array $plugin_info    Array of information for the last-handled plugin.
3591
						 */
3592
						$update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
3593
3594
						if ( ! empty( $update_actions ) ) {
3595
							$this->feedback( implode( ' | ', (array) $update_actions ) );
3596
						}
3597
					}
3598
3599
					/* *********** DEPRECATED METHODS *********** */
3600
3601
					/**
3602
					 * Flush header output buffer.
3603
					 *
3604
					 * @since      2.2.0
3605
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3606
					 * @see        Bulk_Upgrader_Skin::flush_output()
3607
					 */
3608
					public function before_flush_output() {
3609
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3610
						$this->flush_output();
3611
					}
3612
3613
					/**
3614
					 * Flush footer output buffer and iterate $this->i to make sure the
3615
					 * installation strings reference the correct plugin.
3616
					 *
3617
					 * @since      2.2.0
3618
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3619
					 * @see        Bulk_Upgrader_Skin::flush_output()
3620
					 */
3621
					public function after_flush_output() {
3622
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3623
						$this->flush_output();
3624
						$this->i++;
3625
					}
3626
				}
3627
			}
3628
		}
3629
	}
3630
}
3631
3632
if ( ! class_exists( 'TGMPA_Utils' ) ) {
3633
3634
	/**
3635
	 * Generic utilities for TGMPA.
3636
	 *
3637
	 * All methods are static, poor-dev name-spacing class wrapper.
3638
	 *
3639
	 * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
3640
	 *
3641
	 * @since 2.5.0
3642
	 *
3643
	 * @package TGM-Plugin-Activation
3644
	 * @author  Juliette Reinders Folmer
3645
	 */
3646
	class TGMPA_Utils {
3647
		/**
3648
		 * Whether the PHP filter extension is enabled.
3649
		 *
3650
		 * @see http://php.net/book.filter
3651
		 *
3652
		 * @since 2.5.0
3653
		 *
3654
		 * @static
3655
		 *
3656
		 * @var bool $has_filters True is the extension is enabled.
3657
		 */
3658
		public static $has_filters;
3659
3660
		/**
3661
		 * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
3662
		 *
3663
		 * @since 2.5.0
3664
		 *
3665
		 * @static
3666
		 *
3667
		 * @param string $string Text to be wrapped.
3668
		 * @return string
3669
		 */
3670
		public static function wrap_in_em( $string ) {
3671
			return '<em>' . wp_kses_post( $string ) . '</em>';
3672
		}
3673
3674
		/**
3675
		 * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
3676
		 *
3677
		 * @since 2.5.0
3678
		 *
3679
		 * @static
3680
		 *
3681
		 * @param string $string Text to be wrapped.
3682
		 * @return string
3683
		 */
3684
		public static function wrap_in_strong( $string ) {
3685
			return '<strong>' . wp_kses_post( $string ) . '</strong>';
3686
		}
3687
3688
		/**
3689
		 * Helper function: Validate a value as boolean
3690
		 *
3691
		 * @since 2.5.0
3692
		 *
3693
		 * @static
3694
		 *
3695
		 * @param mixed $value Arbitrary value.
3696
		 * @return bool
3697
		 */
3698
		public static function validate_bool( $value ) {
3699
			if ( ! isset( self::$has_filters ) ) {
3700
				self::$has_filters = extension_loaded( 'filter' );
3701
			}
3702
3703
			if ( self::$has_filters ) {
3704
				return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
3705
			} else {
3706
				return self::emulate_filter_bool( $value );
3707
			}
3708
		}
3709
3710
		/**
3711
		 * Helper function: Cast a value to bool
3712
		 *
3713
		 * @since 2.5.0
3714
		 *
3715
		 * @static
3716
		 *
3717
		 * @param mixed $value Value to cast.
3718
		 * @return bool
3719
		 */
3720
		protected static function emulate_filter_bool( $value ) {
3721
			// @codingStandardsIgnoreStart
3722
			static $true  = array(
3723
				'1',
3724
				'true', 'True', 'TRUE',
3725
				'y', 'Y',
3726
				'yes', 'Yes', 'YES',
3727
				'on', 'On', 'ON',
3728
			);
3729
			static $false = array(
3730
				'0',
3731
				'false', 'False', 'FALSE',
3732
				'n', 'N',
3733
				'no', 'No', 'NO',
3734
				'off', 'Off', 'OFF',
3735
			);
3736
			// @codingStandardsIgnoreEnd
3737
3738
			if ( is_bool( $value ) ) {
3739
				return $value;
3740
			} else if ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
3741
				return (bool) $value;
3742
			} else if ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
3743
				return (bool) $value;
3744
			} else if ( is_string( $value ) ) {
3745
				$value = trim( $value );
3746
				if ( in_array( $value, $true, true ) ) {
3747
					return true;
3748
				} else if ( in_array( $value, $false, true ) ) {
3749
					return false;
3750
				} else {
3751
					return false;
3752
				}
3753
			}
3754
3755
			return false;
3756
		}
3757
	} // End of class TGMPA_Utils
3758
} // End of class_exists wrapper
3759