Completed
Pull Request — develop (#514)
by Juliette
02:23
created

TGMPA_Bulk_Installer_Skin::__construct()   A

Complexity

Conditions 1

Size

Total Lines 19

Duplication

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