Completed
Push — develop ( edd294...4ed182 )
by Gary
14:59 queued 06:38
created

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

Upgrade to new PHP Analysis Engine

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

1
<?php
2
/**
3
 * Plugin installation and activation for WordPress themes.
4
 *
5
 * Please note that this is a drop-in library for a theme or plugin.
6
 * The authors of this library (Thomas, Gary and Juliette) are NOT responsible
7
 * for the support of your plugin or theme. Please contact the plugin
8
 * or theme author for support.
9
 *
10
 * @package   TGM-Plugin-Activation
11
 * @version   2.5.2
12
 * @link      http://tgmpluginactivation.com/
13
 * @author    Thomas Griffin, Gary Jones, Juliette Reinders Folmer
14
 * @copyright Copyright (c) 2011, Thomas Griffin
15
 * @license   GPL-2.0+
16
 */
17
18
/*
19
	Copyright 2011 Thomas Griffin (thomasgriffinmedia.com)
20
21
	This program is free software; you can redistribute it and/or modify
22
	it under the terms of the GNU General Public License, version 2, as
23
	published by the Free Software Foundation.
24
25
	This program is distributed in the hope that it will be useful,
26
	but WITHOUT ANY WARRANTY; without even the implied warranty of
27
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28
	GNU General Public License for more details.
29
30
	You should have received a copy of the GNU General Public License
31
	along with this program; if not, write to the Free Software
32
	Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
33
*/
34
35
if ( ! class_exists( 'TGM_Plugin_Activation' ) ) {
36
37
	/**
38
	 * Automatic plugin installation and activation library.
39
	 *
40
	 * Creates a way to automatically install and activate plugins from within themes.
41
	 * The plugins can be either bundled, downloaded from the WordPress
42
	 * Plugin Repository or downloaded from another external source.
43
	 *
44
	 * @since 1.0.0
45
	 *
46
	 * @package TGM-Plugin-Activation
47
	 * @author  Thomas Griffin
48
	 * @author  Gary Jones
49
	 */
50
	class TGM_Plugin_Activation {
51
		/**
52
		 * TGMPA version number.
53
		 *
54
		 * @since 2.5.0
55
		 *
56
		 * @const string Version number.
57
		 */
58
		const TGMPA_VERSION = '2.5.2';
59
60
		/**
61
		 * Regular expression to test if a URL is a WP plugin repo URL.
62
		 *
63
		 * @const string Regex.
64
		 *
65
		 * @since 2.5.0
66
		 */
67
		const WP_REPO_REGEX = '|^http[s]?://wordpress\.org/(?:extend/)?plugins/|';
68
69
		/**
70
		 * Arbitrary regular expression to test if a string starts with a URL.
71
		 *
72
		 * @const string Regex.
73
		 *
74
		 * @since 2.5.0
75
		 */
76
		const IS_URL_REGEX = '|^http[s]?://|';
77
78
		/**
79
		 * Holds a copy of itself, so it can be referenced by the class name.
80
		 *
81
		 * @since 1.0.0
82
		 *
83
		 * @var TGM_Plugin_Activation
84
		 */
85
		public static $instance;
86
87
		/**
88
		 * Holds arrays of plugin details.
89
		 *
90
		 * @since 1.0.0
91
		 *
92
		 * @since 2.5.0 the array has the plugin slug as an associative key.
93
		 *
94
		 * @var array
95
		 */
96
		public $plugins = array();
97
98
		/**
99
		 * Holds arrays of plugin names to use to sort the plugins array.
100
		 *
101
		 * @since 2.5.0
102
		 *
103
		 * @var array
104
		 */
105
		protected $sort_order = array();
106
107
		/**
108
		 * Whether any plugins have the 'force_activation' setting set to true.
109
		 *
110
		 * @since 2.5.0
111
		 *
112
		 * @var bool
113
		 */
114
		protected $has_forced_activation = false;
115
116
		/**
117
		 * Whether any plugins have the 'force_deactivation' setting set to true.
118
		 *
119
		 * @since 2.5.0
120
		 *
121
		 * @var bool
122
		 */
123
		protected $has_forced_deactivation = false;
124
125
		/**
126
		 * Name of the unique ID to hash notices.
127
		 *
128
		 * @since 2.4.0
129
		 *
130
		 * @var string
131
		 */
132
		public $id = 'tgmpa';
133
134
		/**
135
		 * Name of the query-string argument for the admin page.
136
		 *
137
		 * @since 1.0.0
138
		 *
139
		 * @var string
140
		 */
141
		protected $menu = 'tgmpa-install-plugins';
142
143
		/**
144
		 * Parent menu file slug.
145
		 *
146
		 * @since 2.5.0
147
		 *
148
		 * @var string
149
		 */
150
		public $parent_slug = 'themes.php';
151
152
		/**
153
		 * Capability needed to view the plugin installation menu item.
154
		 *
155
		 * @since 2.5.0
156
		 *
157
		 * @var string
158
		 */
159
		public $capability = 'edit_theme_options';
160
161
		/**
162
		 * Default absolute path to folder containing bundled plugin zip files.
163
		 *
164
		 * @since 2.0.0
165
		 *
166
		 * @var string Absolute path prefix to zip file location for bundled plugins. Default is empty string.
167
		 */
168
		public $default_path = '';
169
170
		/**
171
		 * Flag to show admin notices or not.
172
		 *
173
		 * @since 2.1.0
174
		 *
175
		 * @var boolean
176
		 */
177
		public $has_notices = true;
178
179
		/**
180
		 * Flag to determine if the user can dismiss the notice nag.
181
		 *
182
		 * @since 2.4.0
183
		 *
184
		 * @var boolean
185
		 */
186
		public $dismissable = true;
187
188
		/**
189
		 * Message to be output above nag notice if dismissable is false.
190
		 *
191
		 * @since 2.4.0
192
		 *
193
		 * @var string
194
		 */
195
		public $dismiss_msg = '';
196
197
		/**
198
		 * Flag to set automatic activation of plugins. Off by default.
199
		 *
200
		 * @since 2.2.0
201
		 *
202
		 * @var boolean
203
		 */
204
		public $is_automatic = false;
205
206
		/**
207
		 * Optional message to display before the plugins table.
208
		 *
209
		 * @since 2.2.0
210
		 *
211
		 * @var string Message filtered by wp_kses_post(). Default is empty string.
212
		 */
213
		public $message = '';
214
215
		/**
216
		 * Holds configurable array of strings.
217
		 *
218
		 * Default values are added in the constructor.
219
		 *
220
		 * @since 2.0.0
221
		 *
222
		 * @var array
223
		 */
224
		public $strings = array();
225
226
		/**
227
		 * Holds the version of WordPress.
228
		 *
229
		 * @since 2.4.0
230
		 *
231
		 * @var int
232
		 */
233
		public $wp_version;
234
235
		/**
236
		 * Holds the hook name for the admin page.
237
		 *
238
		 * @since 2.5.0
239
		 *
240
		 * @var string
241
		 */
242
		public $page_hook;
243
244
		/**
245
		 * Adds a reference of this object to $instance, populates default strings,
246
		 * does the tgmpa_init action hook, and hooks in the interactions to init.
247
		 *
248
		 * @internal This method should be `protected`, but as too many TGMPA implementations
249
		 * haven't upgraded beyond v2.3.6 yet, this gives backward compatibility issues.
250
		 * Reverted back to public for the time being.
251
		 *
252
		 * @since 1.0.0
253
		 *
254
		 * @see TGM_Plugin_Activation::init()
255
		 */
256
		public function __construct() {
257
			// Set the current WordPress version.
258
			$this->wp_version = $GLOBALS['wp_version'];
259
260
			// Announce that the class is ready, and pass the object (for advanced use).
261
			do_action_ref_array( 'tgmpa_init', array( $this ) );
262
263
			// 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
				'oops'                            => __( 'Something went wrong with the plugin API.', 'tgmpa' ),
326
				'notice_can_install_required'     => _n_noop(
327
					'This theme requires the following plugin: %1$s.',
328
					'This theme requires the following plugins: %1$s.',
329
					'tgmpa'
330
				),
331
				'notice_can_install_recommended'  => _n_noop(
332
					'This theme recommends the following plugin: %1$s.',
333
					'This theme recommends the following plugins: %1$s.',
334
					'tgmpa'
335
				),
336
				'notice_cannot_install'           => _n_noop(
337
					'Sorry, but you do not have the correct permissions to install the %1$s plugin.',
338
					'Sorry, but you do not have the correct permissions to install the %1$s plugins.',
339
					'tgmpa'
340
				),
341
				'notice_ask_to_update'            => _n_noop(
342
					'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.',
343
					'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.',
344
					'tgmpa'
345
				),
346
				'notice_ask_to_update_maybe'      => _n_noop(
347
					'There is an update available for: %1$s.',
348
					'There are updates available for the following plugins: %1$s.',
349
					'tgmpa'
350
				),
351
				'notice_cannot_update'            => _n_noop(
352
					'Sorry, but you do not have the correct permissions to update the %1$s plugin.',
353
					'Sorry, but you do not have the correct permissions to update the %1$s plugins.',
354
					'tgmpa'
355
				),
356
				'notice_can_activate_required'    => _n_noop(
357
					'The following required plugin is currently inactive: %1$s.',
358
					'The following required plugins are currently inactive: %1$s.',
359
					'tgmpa'
360
				),
361
				'notice_can_activate_recommended' => _n_noop(
362
					'The following recommended plugin is currently inactive: %1$s.',
363
					'The following recommended plugins are currently inactive: %1$s.',
364
					'tgmpa'
365
				),
366
				'notice_cannot_activate'          => _n_noop(
367
					'Sorry, but you do not have the correct permissions to activate the %1$s plugin.',
368
					'Sorry, but you do not have the correct permissions to activate the %1$s plugins.',
369
					'tgmpa'
370
				),
371
				'install_link'                    => _n_noop(
372
					'Begin installing plugin',
373
					'Begin installing plugins',
374
					'tgmpa'
375
				),
376
				'update_link'                     => _n_noop(
377
					'Begin updating plugin',
378
					'Begin updating plugins',
379
					'tgmpa'
380
				),
381
				'activate_link'                   => _n_noop(
382
					'Begin activating plugin',
383
					'Begin activating plugins',
384
					'tgmpa'
385
				),
386
				'return'                          => __( 'Return to Required Plugins Installer', 'tgmpa' ),
387
				'dashboard'                       => __( 'Return to the dashboard', 'tgmpa' ),
388
				'plugin_activated'                => __( 'Plugin activated successfully.', 'tgmpa' ),
389
				'activated_successfully'          => __( 'The following plugin was activated successfully:', 'tgmpa' ),
390
				'plugin_already_active'           => __( 'No action taken. Plugin %1$s was already active.', 'tgmpa' ),
391
				'plugin_needs_higher_version'     => __( 'Plugin not activated. A higher version of %s is needed for this theme. Please update the plugin.', 'tgmpa' ),
392
				'complete'                        => __( 'All plugins installed and activated successfully. %1$s', 'tgmpa' ),
393
				'dismiss'                         => __( 'Dismiss this notice', 'tgmpa' ),
394
				'contact_admin'                   => __( 'Please contact the administrator of this site for help.', 'tgmpa' ),
395
			);
396
397
			do_action( 'tgmpa_register' );
398
399
			/* After this point, the plugins should be registered and the configuration set. */
400
401
			// Proceed only if we have plugins to handle.
402
			if ( empty( $this->plugins ) || ! is_array( $this->plugins ) ) {
403
				return;
404
			}
405
406
			// Set up the menu and notices if we still have outstanding actions.
407
			if ( true !== $this->is_tgmpa_complete() ) {
408
				// Sort the plugins.
409
				array_multisort( $this->sort_order, SORT_ASC, $this->plugins );
410
411
				add_action( 'admin_menu', array( $this, 'admin_menu' ) );
412
				add_action( 'admin_head', array( $this, 'dismiss' ) );
413
414
				// Prevent the normal links from showing underneath a single install/update page.
415
				add_filter( 'install_plugin_complete_actions', array( $this, 'actions' ) );
416
				add_filter( 'update_plugin_complete_actions', array( $this, 'actions' ) );
417
418
				if ( $this->has_notices ) {
419
					add_action( 'admin_notices', array( $this, 'notices' ) );
420
					add_action( 'admin_init', array( $this, 'admin_init' ), 1 );
421
					add_action( 'admin_enqueue_scripts', array( $this, 'thickbox' ) );
422
				}
423
			}
424
425
			// If needed, filter plugin action links.
426
			add_action( 'load-plugins.php', array( $this, 'add_plugin_action_link_filters' ), 1 );
427
428
			// Make sure things get reset on switch theme.
429
			add_action( 'switch_theme', array( $this, 'flush_plugins_cache' ) );
430
431
			if ( $this->has_notices ) {
432
				add_action( 'switch_theme', array( $this, 'update_dismiss' ) );
433
			}
434
435
			// Setup the force activation hook.
436
			if ( true === $this->has_forced_activation ) {
437
				add_action( 'admin_init', array( $this, 'force_activation' ) );
438
			}
439
440
			// Setup the force deactivation hook.
441
			if ( true === $this->has_forced_deactivation ) {
442
				add_action( 'switch_theme', array( $this, 'force_deactivation' ) );
443
			}
444
		}
445
446
		/**
447
		 * Hook in plugin action link filters for the WP native plugins page.
448
		 *
449
		 * - Prevent activation of plugins which don't meet the minimum version requirements.
450
		 * - Prevent deactivation of force-activated plugins.
451
		 * - Add update notice if update available.
452
		 *
453
		 * @since 2.5.0
454
		 */
455
		public function add_plugin_action_link_filters() {
456
			foreach ( $this->plugins as $slug => $plugin ) {
457
				if ( false === $this->can_plugin_activate( $slug ) ) {
458
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_activate' ), 20 );
459
				}
460
461
				if ( true === $plugin['force_activation'] ) {
462
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_deactivate' ), 20 );
463
				}
464
465
				if ( false !== $this->does_plugin_require_update( $slug ) ) {
466
					add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_update' ), 20 );
467
				}
468
			}
469
		}
470
471
		/**
472
		 * Remove the 'Activate' link on the WP native plugins page if the plugin does not meet the
473
		 * minimum version requirements.
474
		 *
475
		 * @since 2.5.0
476
		 *
477
		 * @param array $actions Action links.
478
		 * @return array
479
		 */
480
		public function filter_plugin_action_links_activate( $actions ) {
481
			unset( $actions['activate'] );
482
483
			return $actions;
484
		}
485
486
		/**
487
		 * Remove the 'Deactivate' link on the WP native plugins page if the plugin has been set to force activate.
488
		 *
489
		 * @since 2.5.0
490
		 *
491
		 * @param array $actions Action links.
492
		 * @return array
493
		 */
494
		public function filter_plugin_action_links_deactivate( $actions ) {
495
			unset( $actions['deactivate'] );
496
497
			return $actions;
498
		}
499
500
		/**
501
		 * Add a 'Requires update' link on the WP native plugins page if the plugin does not meet the
502
		 * minimum version requirements.
503
		 *
504
		 * @since 2.5.0
505
		 *
506
		 * @param array $actions Action links.
507
		 * @return array
508
		 */
509
		public function filter_plugin_action_links_update( $actions ) {
510
			$actions['update'] = sprintf(
511
				'<a href="%1$s" title="%2$s" class="edit">%3$s</a>',
512
				esc_url( $this->get_tgmpa_status_url( 'update' ) ),
513
				esc_attr__( 'This plugin needs to be updated to be compatible with your theme.', 'tgmpa' ),
514
				esc_html__( 'Update Required', 'tgmpa' )
515
			);
516
517
			return $actions;
518
		}
519
520
		/**
521
		 * Handles calls to show plugin information via links in the notices.
522
		 *
523
		 * We get the links in the admin notices to point to the TGMPA page, rather
524
		 * than the typical plugin-install.php file, so we can prepare everything
525
		 * beforehand.
526
		 *
527
		 * WP does not make it easy to show the plugin information in the thickbox -
528
		 * here we have to require a file that includes a function that does the
529
		 * main work of displaying it, enqueue some styles, set up some globals and
530
		 * finally call that function before exiting.
531
		 *
532
		 * Down right easy once you know how...
533
		 *
534
		 * Returns early if not the TGMPA page.
535
		 *
536
		 * @since 2.1.0
537
		 *
538
		 * @global string $tab Used as iframe div class names, helps with styling
539
		 * @global string $body_id Used as the iframe body ID, helps with styling
540
		 *
541
		 * @return null Returns early if not the TGMPA page.
542
		 */
543
		public function admin_init() {
544
			if ( ! $this->is_tgmpa_page() ) {
545
				return;
546
			}
547
548
			if ( isset( $_REQUEST['tab'] ) && 'plugin-information' === $_REQUEST['tab'] ) {
549
				// Needed for install_plugin_information().
550
				require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
551
552
				wp_enqueue_style( 'plugin-install' );
553
554
				global $tab, $body_id;
555
				$body_id = 'plugin-information';
556
				// @codingStandardsIgnoreStart
557
				$tab     = 'plugin-information';
558
				// @codingStandardsIgnoreEnd
559
560
				install_plugin_information();
561
562
				exit;
563
			}
564
		}
565
566
		/**
567
		 * Enqueue thickbox scripts/styles for plugin info.
568
		 *
569
		 * Thickbox is not automatically included on all admin pages, so we must
570
		 * manually enqueue it for those pages.
571
		 *
572
		 * Thickbox is only loaded if the user has not dismissed the admin
573
		 * notice or if there are any plugins left to install and activate.
574
		 *
575
		 * @since 2.1.0
576
		 */
577
		public function thickbox() {
578
			if ( ! get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) ) {
579
				add_thickbox();
580
			}
581
		}
582
583
		/**
584
		 * Adds submenu page if there are plugin actions to take.
585
		 *
586
		 * This method adds the submenu page letting users know that a required
587
		 * plugin needs to be installed.
588
		 *
589
		 * This page disappears once the plugin has been installed and activated.
590
		 *
591
		 * @since 1.0.0
592
		 *
593
		 * @see TGM_Plugin_Activation::init()
594
		 * @see TGM_Plugin_Activation::install_plugins_page()
595
		 *
596
		 * @return null Return early if user lacks capability to install a plugin.
597
		 */
598
		public function admin_menu() {
599
			// Make sure privileges are correct to see the page.
600
			if ( ! current_user_can( 'install_plugins' ) ) {
601
				return;
602
			}
603
604
			$args = apply_filters(
605
				'tgmpa_admin_menu_args',
606
				array(
607
					'parent_slug' => $this->parent_slug,                     // Parent Menu slug.
608
					'page_title'  => $this->strings['page_title'],           // Page title.
609
					'menu_title'  => $this->strings['menu_title'],           // Menu title.
610
					'capability'  => $this->capability,                      // Capability.
611
					'menu_slug'   => $this->menu,                            // Menu slug.
612
					'function'    => array( $this, 'install_plugins_page' ), // Callback.
613
				)
614
			);
615
616
			$this->add_admin_menu( $args );
617
		}
618
619
		/**
620
		 * Add the menu item.
621
		 *
622
		 * @since 2.5.0
623
		 *
624
		 * @param array $args Menu item configuration.
625
		 */
626
		protected function add_admin_menu( array $args ) {
627
			if ( has_filter( 'tgmpa_admin_menu_use_add_theme_page' ) ) {
628
				_deprecated_function( 'The "tgmpa_admin_menu_use_add_theme_page" filter', '2.5.0', esc_html__( 'Set the parent_slug config variable instead.', 'tgmpa' ) );
629
			}
630
631
			if ( 'themes.php' === $this->parent_slug ) {
632
				$this->page_hook = call_user_func( 'add_theme_page', $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
633
			} else {
634
				$type = 'submenu';
635
				$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'] );
636
			}
637
		}
638
639
		/**
640
		 * Echoes plugin installation form.
641
		 *
642
		 * This method is the callback for the admin_menu method function.
643
		 * This displays the admin page and form area where the user can select to install and activate the plugin.
644
		 * Aborts early if we're processing a plugin installation action.
645
		 *
646
		 * @since 1.0.0
647
		 *
648
		 * @return null Aborts early if we're processing a plugin installation action.
649
		 */
650
		public function install_plugins_page() {
651
			// Store new instance of plugin table in object.
652
			$plugin_table = new TGMPA_List_Table;
653
654
			// Return early if processing a plugin installation action.
655
			if ( ( ( 'tgmpa-bulk-install' === $plugin_table->current_action() || 'tgmpa-bulk-update' === $plugin_table->current_action() ) && $plugin_table->process_bulk_actions() ) || $this->do_plugin_install() ) {
656
				return;
657
			}
658
659
			// Force refresh of available plugin information so we'll know about manual updates/deletes.
660
			wp_clean_plugins_cache( false );
661
662
			?>
663
			<div class="tgmpa wrap">
664
				<h2><?php echo esc_html( get_admin_page_title() ); ?></h2>
665
				<?php $plugin_table->prepare_items(); ?>
666
667
				<?php
668
				if ( ! empty( $this->message ) && is_string( $this->message ) ) {
669
					echo wp_kses_post( $this->message );
670
				}
671
				?>
672
				<?php $plugin_table->views(); ?>
673
674
				<form id="tgmpa-plugins" action="" method="post">
675
					<input type="hidden" name="tgmpa-page" value="<?php echo esc_attr( $this->menu ); ?>" />
676
					<input type="hidden" name="plugin_status" value="<?php echo esc_attr( $plugin_table->view_context ); ?>" />
677
					<?php $plugin_table->display(); ?>
678
				</form>
679
			</div>
680
			<?php
681
		}
682
683
		/**
684
		 * Installs, updates or activates a plugin depending on the action link clicked by the user.
685
		 *
686
		 * Checks the $_GET variable to see which actions have been
687
		 * passed and responds with the appropriate method.
688
		 *
689
		 * Uses WP_Filesystem to process and handle the plugin installation
690
		 * method.
691
		 *
692
		 * @since 1.0.0
693
		 *
694
		 * @uses WP_Filesystem
695
		 * @uses WP_Error
696
		 * @uses WP_Upgrader
697
		 * @uses Plugin_Upgrader
698
		 * @uses Plugin_Installer_Skin
699
		 * @uses Plugin_Upgrader_Skin
700
		 *
701
		 * @return boolean True on success, false on failure.
702
		 */
703
		protected function do_plugin_install() {
704
			if ( empty( $_GET['plugin'] ) ) {
705
				return false;
706
			}
707
708
			// All plugin information will be stored in an array for processing.
709
			$slug = $this->sanitize_key( urldecode( $_GET['plugin'] ) );
710
711
			if ( ! isset( $this->plugins[ $slug ] ) ) {
712
				return false;
713
			}
714
715
			// Was an install or upgrade action link clicked?
716
			if ( ( isset( $_GET['tgmpa-install'] ) && 'install-plugin' === $_GET['tgmpa-install'] ) || ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) ) {
717
718
				$install_type = 'install';
719
				if ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) {
720
					$install_type = 'update';
721
				}
722
723
				check_admin_referer( 'tgmpa-' . $install_type, 'tgmpa-nonce' );
724
725
				// Pass necessary information via URL if WP_Filesystem is needed.
726
				$url = wp_nonce_url(
727
					add_query_arg(
728
						array(
729
							'plugin'                 => urlencode( $slug ),
730
							'tgmpa-' . $install_type => $install_type . '-plugin',
731
						),
732
						$this->get_tgmpa_url()
733
					),
734
					'tgmpa-' . $install_type,
735
					'tgmpa-nonce'
736
				);
737
738
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
739
740
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, array() ) ) ) {
741
					return true;
742
				}
743
744 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
745
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem.
746
					return true;
747
				}
748
749
				/* If we arrive here, we have the filesystem. */
750
751
				// Prep variables for Plugin_Installer_Skin class.
752
				$extra         = array();
753
				$extra['slug'] = $slug; // Needed for potentially renaming of directory name.
754
				$source        = $this->get_download_url( $slug );
755
				$api           = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null;
756
				$api           = ( false !== $api ) ? $api : null;
757
758
				$url = add_query_arg(
759
					array(
760
						'action' => $install_type . '-plugin',
761
						'plugin' => urlencode( $slug ),
762
					),
763
					'update.php'
764
				);
765
766
				if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
767
					require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
768
				}
769
770
				$skin_args = array(
771
					'type'   => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload',
772
					'title'  => sprintf( $this->strings['installing'], $this->plugins[ $slug ]['name'] ),
773
					'url'    => esc_url_raw( $url ),
774
					'nonce'  => $install_type . '-plugin_' . $slug,
775
					'plugin' => '',
776
					'api'    => $api,
777
					'extra'  => $extra,
778
				);
779
780
				if ( 'update' === $install_type ) {
781
					$skin_args['plugin'] = $this->plugins[ $slug ]['file_path'];
782
					$skin                = new Plugin_Upgrader_Skin( $skin_args );
783
				} else {
784
					$skin = new Plugin_Installer_Skin( $skin_args );
785
				}
786
787
				// Create a new instance of Plugin_Upgrader.
788
				$upgrader = new Plugin_Upgrader( $skin );
789
790
				// Perform the action and install the plugin from the $source urldecode().
791
				add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
792
793
				if ( 'update' === $install_type ) {
794
					// Inject our info into the update transient.
795
					$to_inject                    = array( $slug => $this->plugins[ $slug ] );
796
					$to_inject[ $slug ]['source'] = $source;
797
					$this->inject_update_info( $to_inject );
798
799
					$upgrader->upgrade( $this->plugins[ $slug ]['file_path'] );
800
				} else {
801
					$upgrader->install( $source );
802
				}
803
804
				remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
805
806
				// Make sure we have the correct file path now the plugin is installed/updated.
807
				$this->populate_file_path( $slug );
808
809
				// Only activate plugins if the config option is set to true and the plugin isn't
810
				// already active (upgrade).
811
				if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) {
812
					$plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method.
813
					if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) {
814
						return true; // Finish execution of the function early as we encountered an error.
815
					}
816
				}
817
818
				$this->show_tgmpa_version();
819
820
				// Display message based on if all plugins are now active or not.
821
				if ( $this->is_tgmpa_complete() ) {
822
					echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>' ), '</p>';
823
					echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
824
				} else {
825
					echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
826
				}
827
828
				return true;
829
			} elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) {
830
				// Activate action link was clicked.
831
				check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' );
832
833
				if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) {
834
					return true; // Finish execution of the function early as we encountered an error.
835
				}
836
			}
837
838
			return false;
839
		}
840
841
		/**
842
		 * Inject information into the 'update_plugins' site transient as WP checks that before running an update.
843
		 *
844
		 * @since 2.5.0
845
		 *
846
		 * @param array $plugins The plugin information for the plugins which are to be updated.
847
		 */
848
		public function inject_update_info( $plugins ) {
849
			$repo_updates = get_site_transient( 'update_plugins' );
850
851
			if ( ! is_object( $repo_updates ) ) {
852
				$repo_updates = new stdClass;
853
			}
854
855
			foreach ( $plugins as $slug => $plugin ) {
856
				$file_path = $plugin['file_path'];
857
858
				if ( empty( $repo_updates->response[ $file_path ] ) ) {
859
					$repo_updates->response[ $file_path ] = new stdClass;
860
				}
861
862
				// We only really need to set package, but let's do all we can in case WP changes something.
863
				$repo_updates->response[ $file_path ]->slug        = $slug;
864
				$repo_updates->response[ $file_path ]->plugin      = $file_path;
865
				$repo_updates->response[ $file_path ]->new_version = $plugin['version'];
866
				$repo_updates->response[ $file_path ]->package     = $plugin['source'];
867
				if ( empty( $repo_updates->response[ $file_path ]->url ) && ! empty( $plugin['external_url'] ) ) {
868
					$repo_updates->response[ $file_path ]->url = $plugin['external_url'];
869
				}
870
			}
871
872
			set_site_transient( 'update_plugins', $repo_updates );
873
		}
874
875
		/**
876
		 * Adjust the plugin directory name if necessary.
877
		 *
878
		 * The final destination directory of a plugin is based on the subdirectory name found in the
879
		 * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this
880
		 * subdirectory name is not the same as the expected slug and the plugin will not be recognized
881
		 * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to
882
		 * the expected plugin slug.
883
		 *
884
		 * @since 2.5.0
885
		 *
886
		 * @param string       $source        Path to upgrade/zip-file-name.tmp/subdirectory/.
887
		 * @param string       $remote_source Path to upgrade/zip-file-name.tmp.
888
		 * @param \WP_Upgrader $upgrader      Instance of the upgrader which installs the plugin.
889
		 * @return string $source
890
		 */
891
		public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
892
			if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) {
893
				return $source;
894
			}
895
896
			// Check for single file plugins.
897
			$source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) );
898
			if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) {
899
				return $source;
900
			}
901
902
			// Multi-file plugin, let's see if the directory is correctly named.
903
			$desired_slug = '';
904
905
			// Figure out what the slug is supposed to be.
906
			if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) {
907
				$desired_slug = $upgrader->skin->options['extra']['slug'];
908
			} else {
909
				// Bulk installer contains less info, so fall back on the info registered here.
910
				foreach ( $this->plugins as $slug => $plugin ) {
911
					if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) {
912
						$desired_slug = $slug;
913
						break;
914
					}
915
				}
916
				unset( $slug, $plugin );
917
			}
918
919
			if ( ! empty( $desired_slug ) ) {
920
				$subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
921
922
				if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
923
					$from = untrailingslashit( $source );
924
					$to   = trailingslashit( $remote_source ) . $desired_slug;
925
926
					if ( true === $GLOBALS['wp_filesystem']->move( $from, $to ) ) {
927
						return trailingslashit( $to );
928 View Code Duplication
					} else {
929
						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 ) );
930
					}
931 View Code Duplication
				} elseif ( empty( $subdir_name ) ) {
932
					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 ) );
933
				}
934
			}
935
936
			return $source;
937
		}
938
939
		/**
940
		 * Activate a single plugin and send feedback about the result to the screen.
941
		 *
942
		 * @since 2.5.0
943
		 *
944
		 * @param string $file_path Path within wp-plugins/ to main plugin file.
945
		 * @param string $slug      Plugin slug.
946
		 * @param bool   $automatic Whether this is an automatic activation after an install. Defaults to false.
947
		 *                          This determines the styling of the output messages.
948
		 * @return bool False if an error was encountered, true otherwise.
949
		 */
950
		protected function activate_single_plugin( $file_path, $slug, $automatic = false ) {
951
			if ( $this->can_plugin_activate( $slug ) ) {
952
				$activate = activate_plugin( $file_path );
953
954
				if ( is_wp_error( $activate ) ) {
955
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>',
956
						'<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
957
958
					return false; // End it here if there is an error with activation.
959
				} else {
960
					if ( ! $automatic ) {
961
						// Make sure message doesn't display again if bulk activation is performed
962
						// immediately after a single activation.
963
						if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
964
							echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>';
965
						}
966
					} else {
967
						// Simpler message layout for use on the plugin install page.
968
						echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>';
969
					}
970
				}
971 View Code Duplication
			} elseif ( $this->is_plugin_active( $slug ) ) {
972
				// No simpler message format provided as this message should never be encountered
973
				// on the plugin install page.
974
				echo '<div id="message" class="error"><p>',
975
					sprintf(
976
						esc_html( $this->strings['plugin_already_active'] ),
977
						'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
978
					),
979
					'</p></div>';
980
			} elseif ( $this->does_plugin_require_update( $slug ) ) {
981
				if ( ! $automatic ) {
982
					// Make sure message doesn't display again if bulk activation is performed
983
					// immediately after a single activation.
984 View Code Duplication
					if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
985
						echo '<div id="message" class="error"><p>',
986
							sprintf(
987
								esc_html( $this->strings['plugin_needs_higher_version'] ),
988
								'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
989
							),
990
							'</p></div>';
991
					}
992
				} else {
993
					// Simpler message layout for use on the plugin install page.
994
					echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>';
995
				}
996
			}
997
998
			return true;
999
		}
1000
1001
		/**
1002
		 * Echoes required plugin notice.
1003
		 *
1004
		 * Outputs a message telling users that a specific plugin is required for
1005
		 * their theme. If appropriate, it includes a link to the form page where
1006
		 * users can install and activate the plugin.
1007
		 *
1008
		 * Returns early if we're on the Install page.
1009
		 *
1010
		 * @since 1.0.0
1011
		 *
1012
		 * @global object $current_screen
1013
		 *
1014
		 * @return null Returns early if we're on the Install page.
1015
		 */
1016
		public function notices() {
1017
			// Remove nag on the install page / Return early if the nag message has been dismissed.
1018
			if ( $this->is_tgmpa_page() || get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) ) {
1019
				return;
1020
			}
1021
1022
			// Store for the plugin slugs by message type.
1023
			$message = array();
1024
1025
			// Initialize counters used to determine plurality of action link texts.
1026
			$install_link_count  = 0;
1027
			$update_link_count   = 0;
1028
			$activate_link_count = 0;
1029
1030
			foreach ( $this->plugins as $slug => $plugin ) {
1031
				if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) {
1032
					continue;
1033
				}
1034
1035
				if ( ! $this->is_plugin_installed( $slug ) ) {
1036
					if ( current_user_can( 'install_plugins' ) ) {
1037
						$install_link_count++;
1038
1039
						if ( true === $plugin['required'] ) {
1040
							$message['notice_can_install_required'][] = $slug;
1041
						} else {
1042
							$message['notice_can_install_recommended'][] = $slug;
1043
						}
1044
					} else {
1045
						// Need higher privileges to install the plugin.
1046
						$message['notice_cannot_install'][] = $slug;
1047
					}
1048
				} else {
1049
					if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) {
1050
						if ( current_user_can( 'activate_plugins' ) ) {
1051
							$activate_link_count++;
1052
1053
							if ( true === $plugin['required'] ) {
1054
								$message['notice_can_activate_required'][] = $slug;
1055
							} else {
1056
								$message['notice_can_activate_recommended'][] = $slug;
1057
							}
1058
						} else {
1059
							// Need higher privileges to activate the plugin.
1060
							$message['notice_cannot_activate'][] = $slug;
1061
						}
1062
					}
1063
1064
					if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1065
1066
						if ( current_user_can( 'install_plugins' ) ) {
1067
							$update_link_count++;
1068
1069
							if ( $this->does_plugin_require_update( $slug ) ) {
1070
								$message['notice_ask_to_update'][] = $slug;
1071
							} elseif ( false !== $this->does_plugin_have_update( $slug ) ) {
1072
								$message['notice_ask_to_update_maybe'][] = $slug;
1073
							}
1074
						} else {
1075
							// Need higher privileges to update the plugin.
1076
							$message['notice_cannot_update'][] = $slug;
1077
						}
1078
					}
1079
				}
1080
			}
1081
			unset( $slug, $plugin );
1082
1083
			// If we have notices to display, we move forward.
1084
			if ( ! empty( $message ) ) {
1085
				krsort( $message ); // Sort messages.
1086
				$rendered = '';
1087
1088
				// As add_settings_error() wraps the final message in a <p> and as the final message can't be
1089
				// filtered, using <p>'s in our html would render invalid html output.
1090
				$line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n";
1091
1092
				// If dismissable is false and a message is set, output it now.
1093
				if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) {
1094
					$rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) );
1095
				}
1096
1097
				// Render the individual message lines for the notice.
1098
				foreach ( $message as $type => $plugin_group ) {
1099
					$linked_plugins = array();
1100
1101
					// Get the external info link for a plugin if one is available.
1102
					foreach ( $plugin_group as $plugin_slug ) {
1103
						$linked_plugins[] = $this->get_info_link( $plugin_slug );
1104
					}
1105
					unset( $plugin_slug );
1106
1107
					$count          = count( $plugin_group );
1108
					$linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins );
1109
					$last_plugin    = array_pop( $linked_plugins ); // Pop off last name to prep for readability.
1110
					$imploded       = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
1111
1112
					$rendered .= sprintf(
1113
						$line_template,
1114
						sprintf(
1115
							translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ),
1116
							$imploded,
1117
							$count
1118
						)
1119
					);
1120
1121
					if ( 0 === strpos( $type, 'notice_cannot' ) ) {
1122
						$rendered .= $this->strings['contact_admin'];
1123
					}
1124
				}
1125
				unset( $type, $plugin_group, $linked_plugins, $count, $last_plugin, $imploded );
1126
1127
				// Setup action links.
1128
				$action_links = array(
1129
					'install'  => '',
1130
					'update'   => '',
1131
					'activate' => '',
1132
					'dismiss'  => $this->dismissable ? '<a href="' . esc_url( add_query_arg( 'tgmpa-dismiss', 'dismiss_admin_notices' ) ) . '" class="dismiss-notice" target="_parent">' . esc_html( $this->strings['dismiss'] ) . '</a>' : '',
1133
				);
1134
1135
				$link_template = '<a href="%2$s">%1$s</a>';
1136
1137
				if ( current_user_can( 'install_plugins' ) ) {
1138 View Code Duplication
					if ( $install_link_count > 0 ) {
1139
						$action_links['install'] = sprintf(
1140
							$link_template,
1141
							translate_nooped_plural( $this->strings['install_link'], $install_link_count, 'tgmpa' ),
1142
							esc_url( $this->get_tgmpa_status_url( 'install' ) )
1143
						);
1144
					}
1145 View Code Duplication
					if ( $update_link_count > 0 ) {
1146
						$action_links['update'] = sprintf(
1147
							$link_template,
1148
							translate_nooped_plural( $this->strings['update_link'], $update_link_count, 'tgmpa' ),
1149
							esc_url( $this->get_tgmpa_status_url( 'update' ) )
1150
						);
1151
					}
1152
				}
1153
1154 View Code Duplication
				if ( current_user_can( 'activate_plugins' ) && $activate_link_count > 0 ) {
1155
					$action_links['activate'] = sprintf(
1156
						$link_template,
1157
						translate_nooped_plural( $this->strings['activate_link'], $activate_link_count, 'tgmpa' ),
1158
						esc_url( $this->get_tgmpa_status_url( 'activate' ) )
1159
					);
1160
				}
1161
1162
				$action_links = apply_filters( 'tgmpa_notice_action_links', $action_links );
1163
1164
				$action_links = array_filter( (array) $action_links ); // Remove any empty array items.
1165
1166
				if ( ! empty( $action_links ) && is_array( $action_links ) ) {
1167
					$action_links = sprintf( $line_template, implode( ' | ', $action_links ) );
1168
					$rendered    .= apply_filters( 'tgmpa_notice_rendered_action_links', $action_links );
1169
				}
1170
1171
				// Register the nag messages and prepare them to be processed.
1172
				if ( ! empty( $this->strings['nag_type'] ) ) {
1173
					add_settings_error( 'tgmpa', 'tgmpa', $rendered, sanitize_html_class( strtolower( $this->strings['nag_type'] ) ) );
1174
				} else {
1175
					$nag_class = version_compare( $this->wp_version, '3.8', '<' ) ? 'updated' : 'update-nag';
1176
					add_settings_error( 'tgmpa', 'tgmpa', $rendered, $nag_class );
1177
				}
1178
			}
1179
1180
			// Admin options pages already output settings_errors, so this is to avoid duplication.
1181
			if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) {
1182
				$this->display_settings_errors();
1183
			}
1184
		}
1185
1186
		/**
1187
		 * Display settings errors and remove those which have been displayed to avoid duplicate messages showing
1188
		 *
1189
		 * @since 2.5.0
1190
		 */
1191
		protected function display_settings_errors() {
1192
			global $wp_settings_errors;
1193
1194
			settings_errors( 'tgmpa' );
1195
1196
			foreach ( (array) $wp_settings_errors as $key => $details ) {
1197
				if ( 'tgmpa' === $details['setting'] ) {
1198
					unset( $wp_settings_errors[ $key ] );
1199
					break;
1200
				}
1201
			}
1202
		}
1203
1204
		/**
1205
		 * Add dismissable admin notices.
1206
		 *
1207
		 * Appends a link to the admin nag messages. If clicked, the admin notice disappears and no longer is visible to users.
1208
		 *
1209
		 * @since 2.1.0
1210
		 */
1211
		public function dismiss() {
1212
			if ( isset( $_GET['tgmpa-dismiss'] ) ) {
1213
				update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
1214
			}
1215
		}
1216
1217
		/**
1218
		 * Add individual plugin to our collection of plugins.
1219
		 *
1220
		 * If the required keys are not set or the plugin has already
1221
		 * been registered, the plugin is not added.
1222
		 *
1223
		 * @since 2.0.0
1224
		 *
1225
		 * @param array|null $plugin Array of plugin arguments or null if invalid argument.
1226
		 * @return null Return early if incorrect argument.
1227
		 */
1228
		public function register( $plugin ) {
1229
			if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
1230
				return;
1231
			}
1232
1233
			if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
1234
				return;
1235
			}
1236
1237
			$defaults = array(
1238
				'name'               => '',      // String
1239
				'slug'               => '',      // String
1240
				'source'             => 'repo',  // String
1241
				'required'           => false,   // Boolean
1242
				'version'            => '',      // String
1243
				'force_activation'   => false,   // Boolean
1244
				'force_deactivation' => false,   // Boolean
1245
				'external_url'       => '',      // String
1246
				'is_callable'        => '',      // String|Array.
1247
			);
1248
1249
			// Prepare the received data.
1250
			$plugin = wp_parse_args( $plugin, $defaults );
1251
1252
			// Standardize the received slug.
1253
			$plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
1254
1255
			// Forgive users for using string versions of booleans or floats for version number.
1256
			$plugin['version']            = (string) $plugin['version'];
1257
			$plugin['source']             = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
1258
			$plugin['required']           = TGMPA_Utils::validate_bool( $plugin['required'] );
1259
			$plugin['force_activation']   = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
1260
			$plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
1261
1262
			// Enrich the received data.
1263
			$plugin['file_path']   = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
1264
			$plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
1265
1266
			// Set the class properties.
1267
			$this->plugins[ $plugin['slug'] ]    = $plugin;
1268
			$this->sort_order[ $plugin['slug'] ] = $plugin['name'];
1269
1270
			// Should we add the force activation hook ?
1271
			if ( true === $plugin['force_activation'] ) {
1272
				$this->has_forced_activation = true;
1273
			}
1274
1275
			// Should we add the force deactivation hook ?
1276
			if ( true === $plugin['force_deactivation'] ) {
1277
				$this->has_forced_deactivation = true;
1278
			}
1279
		}
1280
1281
		/**
1282
		 * Determine what type of source the plugin comes from.
1283
		 *
1284
		 * @since 2.5.0
1285
		 *
1286
		 * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
1287
		 *                       (= bundled) or an external URL.
1288
		 * @return string 'repo', 'external', or 'bundled'
1289
		 */
1290
		protected function get_plugin_source_type( $source ) {
1291
			if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
1292
				return 'repo';
1293
			} elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
1294
				return 'external';
1295
			} else {
1296
				return 'bundled';
1297
			}
1298
		}
1299
1300
		/**
1301
		 * Sanitizes a string key.
1302
		 *
1303
		 * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
1304
		 * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
1305
		 * characters in the plugin directory path/slug. Silly them.
1306
		 *
1307
		 * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
1308
		 *
1309
		 * @since 2.5.0
1310
		 *
1311
		 * @param string $key String key.
1312
		 * @return string Sanitized key
1313
		 */
1314
		public function sanitize_key( $key ) {
1315
			$raw_key = $key;
1316
			$key     = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
1317
1318
			/**
1319
			* Filter a sanitized key string.
1320
			*
1321
			* @since 3.0.0
1322
			*
1323
			* @param string $key     Sanitized key.
1324
			* @param string $raw_key The key prior to sanitization.
1325
			*/
1326
			return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
1327
		}
1328
1329
		/**
1330
		 * Amend default configuration settings.
1331
		 *
1332
		 * @since 2.0.0
1333
		 *
1334
		 * @param array $config Array of config options to pass as class properties.
1335
		 */
1336
		public function config( $config ) {
1337
			$keys = array(
1338
				'id',
1339
				'default_path',
1340
				'has_notices',
1341
				'dismissable',
1342
				'dismiss_msg',
1343
				'menu',
1344
				'parent_slug',
1345
				'capability',
1346
				'is_automatic',
1347
				'message',
1348
				'strings',
1349
			);
1350
1351
			foreach ( $keys as $key ) {
1352
				if ( isset( $config[ $key ] ) ) {
1353
					if ( is_array( $config[ $key ] ) ) {
1354
						$this->$key = array_merge( $this->$key, $config[ $key ] );
1355
					} else {
1356
						$this->$key = $config[ $key ];
1357
					}
1358
				}
1359
			}
1360
		}
1361
1362
		/**
1363
		 * Amend action link after plugin installation.
1364
		 *
1365
		 * @since 2.0.0
1366
		 *
1367
		 * @param array $install_actions Existing array of actions.
1368
		 * @return array Amended array of actions.
1369
		 */
1370
		public function actions( $install_actions ) {
1371
			// Remove action links on the TGMPA install page.
1372
			if ( $this->is_tgmpa_page() ) {
1373
				return false;
1374
			}
1375
1376
			return $install_actions;
1377
		}
1378
1379
		/**
1380
		 * Flushes the plugins cache on theme switch to prevent stale entries
1381
		 * from remaining in the plugin table.
1382
		 *
1383
		 * @since 2.4.0
1384
		 *
1385
		 * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
1386
		 *                                 Parameter added in v2.5.0.
1387
		 */
1388
		public function flush_plugins_cache( $clear_update_cache = true ) {
1389
			wp_clean_plugins_cache( $clear_update_cache );
1390
		}
1391
1392
		/**
1393
		 * Set file_path key for each installed plugin.
1394
		 *
1395
		 * @since 2.1.0
1396
		 *
1397
		 * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
1398
		 *                            Parameter added in v2.5.0.
1399
		 */
1400
		public function populate_file_path( $plugin_slug = '' ) {
1401
			if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
1402
				$this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
1403
			} else {
1404
				// Add file_path key for all plugins.
1405
				foreach ( $this->plugins as $slug => $values ) {
1406
					$this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
1407
				}
1408
			}
1409
		}
1410
1411
		/**
1412
		 * Helper function to extract the file path of the plugin file from the
1413
		 * plugin slug, if the plugin is installed.
1414
		 *
1415
		 * @since 2.0.0
1416
		 *
1417
		 * @param string $slug Plugin slug (typically folder name) as provided by the developer.
1418
		 * @return string Either file path for plugin if installed, or just the plugin slug.
1419
		 */
1420
		protected function _get_plugin_basename_from_slug( $slug ) {
1421
			$keys = array_keys( $this->get_plugins() );
1422
1423
			foreach ( $keys as $key ) {
1424
				if ( preg_match( '|^' . $slug . '/|', $key ) ) {
1425
					return $key;
1426
				}
1427
			}
1428
1429
			return $slug;
1430
		}
1431
1432
		/**
1433
		 * Retrieve plugin data, given the plugin name.
1434
		 *
1435
		 * Loops through the registered plugins looking for $name. If it finds it,
1436
		 * it returns the $data from that plugin. Otherwise, returns false.
1437
		 *
1438
		 * @since 2.1.0
1439
		 *
1440
		 * @param string $name Name of the plugin, as it was registered.
1441
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
1442
		 * @return string|boolean Plugin slug if found, false otherwise.
1443
		 */
1444
		public function _get_plugin_data_from_name( $name, $data = 'slug' ) {
1445
			foreach ( $this->plugins as $values ) {
1446
				if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
1447
					return $values[ $data ];
1448
				}
1449
			}
1450
1451
			return false;
1452
		}
1453
1454
		/**
1455
		 * Retrieve the download URL for a package.
1456
		 *
1457
		 * @since 2.5.0
1458
		 *
1459
		 * @param string $slug Plugin slug.
1460
		 * @return string Plugin download URL or path to local file or empty string if undetermined.
1461
		 */
1462
		public function get_download_url( $slug ) {
1463
			$dl_source = '';
1464
1465
			switch ( $this->plugins[ $slug ]['source_type'] ) {
1466
				case 'repo':
1467
					return $this->get_wp_repo_download_url( $slug );
1468
				case 'external':
1469
					return $this->plugins[ $slug ]['source'];
1470
				case 'bundled':
1471
					return $this->default_path . $this->plugins[ $slug ]['source'];
1472
			}
1473
1474
			return $dl_source; // Should never happen.
1475
		}
1476
1477
		/**
1478
		 * Retrieve the download URL for a WP repo package.
1479
		 *
1480
		 * @since 2.5.0
1481
		 *
1482
		 * @param string $slug Plugin slug.
1483
		 * @return string Plugin download URL.
1484
		 */
1485
		protected function get_wp_repo_download_url( $slug ) {
1486
			$source = '';
1487
			$api    = $this->get_plugins_api( $slug );
1488
1489
			if ( false !== $api && isset( $api->download_link ) ) {
1490
				$source = $api->download_link;
1491
			}
1492
1493
			return $source;
1494
		}
1495
1496
		/**
1497
		 * Try to grab information from WordPress API.
1498
		 *
1499
		 * @since 2.5.0
1500
		 *
1501
		 * @param string $slug Plugin slug.
1502
		 * @return object Plugins_api response object on success, WP_Error on failure.
1503
		 */
1504
		protected function get_plugins_api( $slug ) {
1505
			static $api = array(); // Cache received responses.
1506
1507
			if ( ! isset( $api[ $slug ] ) ) {
1508
				if ( ! function_exists( 'plugins_api' ) ) {
1509
					require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
1510
				}
1511
1512
				$response = plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false ) ) );
1513
1514
				$api[ $slug ] = false;
1515
1516
				if ( is_wp_error( $response ) ) {
1517
					wp_die( esc_html( $this->strings['oops'] ) );
1518
				} else {
1519
					$api[ $slug ] = $response;
1520
				}
1521
			}
1522
1523
			return $api[ $slug ];
1524
		}
1525
1526
		/**
1527
		 * Retrieve a link to a plugin information page.
1528
		 *
1529
		 * @since 2.5.0
1530
		 *
1531
		 * @param string $slug Plugin slug.
1532
		 * @return string Fully formed html link to a plugin information page if available
1533
		 *                or the plugin name if not.
1534
		 */
1535
		public function get_info_link( $slug ) {
1536
			if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
1537
				$link = sprintf(
1538
					'<a href="%1$s" target="_blank">%2$s</a>',
1539
					esc_url( $this->plugins[ $slug ]['external_url'] ),
1540
					esc_html( $this->plugins[ $slug ]['name'] )
1541
				);
1542
			} elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
1543
				$url = add_query_arg(
1544
					array(
1545
						'tab'       => 'plugin-information',
1546
						'plugin'    => urlencode( $slug ),
1547
						'TB_iframe' => 'true',
1548
						'width'     => '640',
1549
						'height'    => '500',
1550
					),
1551
					self_admin_url( 'plugin-install.php' )
1552
				);
1553
1554
				$link = sprintf(
1555
					'<a href="%1$s" class="thickbox">%2$s</a>',
1556
					esc_url( $url ),
1557
					esc_html( $this->plugins[ $slug ]['name'] )
1558
				);
1559
			} else {
1560
				$link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
1561
			}
1562
1563
			return $link;
1564
		}
1565
1566
		/**
1567
		 * Determine if we're on the TGMPA Install page.
1568
		 *
1569
		 * @since 2.1.0
1570
		 *
1571
		 * @return boolean True when on the TGMPA page, false otherwise.
1572
		 */
1573
		protected function is_tgmpa_page() {
1574
			return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
1575
		}
1576
1577
		/**
1578
		 * Retrieve the URL to the TGMPA Install page.
1579
		 *
1580
		 * I.e. depending on the config settings passed something along the lines of:
1581
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
1582
		 *
1583
		 * @since 2.5.0
1584
		 *
1585
		 * @return string Properly encoded URL (not escaped).
1586
		 */
1587
		public function get_tgmpa_url() {
1588
			static $url;
1589
1590
			if ( ! isset( $url ) ) {
1591
				$parent = $this->parent_slug;
1592
				if ( false === strpos( $parent, '.php' ) ) {
1593
					$parent = 'admin.php';
1594
				}
1595
				$url = add_query_arg(
1596
					array(
1597
						'page' => urlencode( $this->menu ),
1598
					),
1599
					self_admin_url( $parent )
1600
				);
1601
			}
1602
1603
			return $url;
1604
		}
1605
1606
		/**
1607
		 * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
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&plugin_status=install
1611
		 *
1612
		 * @since 2.5.0
1613
		 *
1614
		 * @param string $status Plugin status - either 'install', 'update' or 'activate'.
1615
		 * @return string Properly encoded URL (not escaped).
1616
		 */
1617
		public function get_tgmpa_status_url( $status ) {
1618
			return add_query_arg(
1619
				array(
1620
					'plugin_status' => urlencode( $status ),
1621
				),
1622
				$this->get_tgmpa_url()
1623
			);
1624
		}
1625
1626
		/**
1627
		 * Determine whether there are open actions for plugins registered with TGMPA.
1628
		 *
1629
		 * @since 2.5.0
1630
		 *
1631
		 * @return bool True if complete, i.e. no outstanding actions. False otherwise.
1632
		 */
1633
		public function is_tgmpa_complete() {
1634
			$complete = true;
1635
			foreach ( $this->plugins as $slug => $plugin ) {
1636
				if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1637
					$complete = false;
1638
					break;
1639
				}
1640
			}
1641
1642
			return $complete;
1643
		}
1644
1645
		/**
1646
		 * Check if a plugin is installed. Does not take must-use plugins into account.
1647
		 *
1648
		 * @since 2.5.0
1649
		 *
1650
		 * @param string $slug Plugin slug.
1651
		 * @return bool True if installed, false otherwise.
1652
		 */
1653
		public function is_plugin_installed( $slug ) {
1654
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1655
1656
			return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
1657
		}
1658
1659
		/**
1660
		 * Check if a plugin is active.
1661
		 *
1662
		 * @since 2.5.0
1663
		 *
1664
		 * @param string $slug Plugin slug.
1665
		 * @return bool True if active, false otherwise.
1666
		 */
1667
		public function is_plugin_active( $slug ) {
1668
			return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) ) || is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
1669
		}
1670
1671
		/**
1672
		 * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
1673
		 * available, check whether the current install meets them.
1674
		 *
1675
		 * @since 2.5.0
1676
		 *
1677
		 * @param string $slug Plugin slug.
1678
		 * @return bool True if OK to update, false otherwise.
1679
		 */
1680
		public function can_plugin_update( $slug ) {
1681
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1682
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1683
				return true;
1684
			}
1685
1686
			$api = $this->get_plugins_api( $slug );
1687
1688
			if ( false !== $api && isset( $api->requires ) ) {
1689
				return version_compare( $GLOBALS['wp_version'], $api->requires, '>=' );
1690
			}
1691
1692
			// No usable info received from the plugins API, presume we can update.
1693
			return true;
1694
		}
1695
1696
		/**
1697
		 * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
1698
		 * plugin version requirements set in TGMPA (if any).
1699
		 *
1700
		 * @since 2.5.0
1701
		 *
1702
		 * @param string $slug Plugin slug.
1703
		 * @return bool True if OK to activate, false otherwise.
1704
		 */
1705
		public function can_plugin_activate( $slug ) {
1706
			return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
1707
		}
1708
1709
		/**
1710
		 * Retrieve the version number of an installed plugin.
1711
		 *
1712
		 * @since 2.5.0
1713
		 *
1714
		 * @param string $slug Plugin slug.
1715
		 * @return string Version number as string or an empty string if the plugin is not installed
1716
		 *                or version unknown (plugins which don't comply with the plugin header standard).
1717
		 */
1718
		public function get_installed_version( $slug ) {
1719
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1720
1721
			if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
1722
				return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
1723
			}
1724
1725
			return '';
1726
		}
1727
1728
		/**
1729
		 * Check whether a plugin complies with the minimum version requirements.
1730
		 *
1731
		 * @since 2.5.0
1732
		 *
1733
		 * @param string $slug Plugin slug.
1734
		 * @return bool True when a plugin needs to be updated, otherwise false.
1735
		 */
1736
		public function does_plugin_require_update( $slug ) {
1737
			$installed_version = $this->get_installed_version( $slug );
1738
			$minimum_version   = $this->plugins[ $slug ]['version'];
1739
1740
			return version_compare( $minimum_version, $installed_version, '>' );
1741
		}
1742
1743
		/**
1744
		 * Check whether there is an update available for a plugin.
1745
		 *
1746
		 * @since 2.5.0
1747
		 *
1748
		 * @param string $slug Plugin slug.
1749
		 * @return false|string Version number string of the available update or false if no update available.
1750
		 */
1751
		public function does_plugin_have_update( $slug ) {
1752
			// Presume bundled and external plugins will point to a package which meets the minimum required version.
1753
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1754
				if ( $this->does_plugin_require_update( $slug ) ) {
1755
					return $this->plugins[ $slug ]['version'];
1756
				}
1757
1758
				return false;
1759
			}
1760
1761
			$repo_updates = get_site_transient( 'update_plugins' );
1762
1763 View Code Duplication
			if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
1764
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
1765
			}
1766
1767
			return false;
1768
		}
1769
1770
		/**
1771
		 * Retrieve potential upgrade notice for a plugin.
1772
		 *
1773
		 * @since 2.5.0
1774
		 *
1775
		 * @param string $slug Plugin slug.
1776
		 * @return string The upgrade notice or an empty string if no message was available or provided.
1777
		 */
1778
		public function get_upgrade_notice( $slug ) {
1779
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1780
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1781
				return '';
1782
			}
1783
1784
			$repo_updates = get_site_transient( 'update_plugins' );
1785
1786 View Code Duplication
			if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
1787
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
1788
			}
1789
1790
			return '';
1791
		}
1792
1793
		/**
1794
		 * Wrapper around the core WP get_plugins function, making sure it's actually available.
1795
		 *
1796
		 * @since 2.5.0
1797
		 *
1798
		 * @param string $plugin_folder Optional. Relative path to single plugin folder.
1799
		 * @return array Array of installed plugins with plugin information.
1800
		 */
1801
		public function get_plugins( $plugin_folder = '' ) {
1802
			if ( ! function_exists( 'get_plugins' ) ) {
1803
				require_once ABSPATH . 'wp-admin/includes/plugin.php';
1804
			}
1805
1806
			return get_plugins( $plugin_folder );
1807
		}
1808
1809
		/**
1810
		 * Delete dismissable nag option when theme is switched.
1811
		 *
1812
		 * This ensures that the user(s) is/are again reminded via nag of required
1813
		 * and/or recommended plugins if they re-activate the theme.
1814
		 *
1815
		 * @since 2.1.1
1816
		 */
1817
		public function update_dismiss() {
1818
			delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
1819
		}
1820
1821
		/**
1822
		 * Forces plugin activation if the parameter 'force_activation' is
1823
		 * set to true.
1824
		 *
1825
		 * This allows theme authors to specify certain plugins that must be
1826
		 * active at all times while using the current theme.
1827
		 *
1828
		 * Please take special care when using this parameter as it has the
1829
		 * potential to be harmful if not used correctly. Setting this parameter
1830
		 * to true will not allow the specified plugin to be deactivated unless
1831
		 * the user switches themes.
1832
		 *
1833
		 * @since 2.2.0
1834
		 */
1835
		public function force_activation() {
1836
			foreach ( $this->plugins as $slug => $plugin ) {
1837
				if ( true === $plugin['force_activation'] ) {
1838
					if ( ! $this->is_plugin_installed( $slug ) ) {
1839
						// Oops, plugin isn't there so iterate to next condition.
1840
						continue;
1841
					} elseif ( $this->can_plugin_activate( $slug ) ) {
1842
						// There we go, activate the plugin.
1843
						activate_plugin( $plugin['file_path'] );
1844
					}
1845
				}
1846
			}
1847
		}
1848
1849
		/**
1850
		 * Forces plugin deactivation if the parameter 'force_deactivation'
1851
		 * is set to true.
1852
		 *
1853
		 * This allows theme authors to specify certain plugins that must be
1854
		 * deactivated upon switching from the current theme to another.
1855
		 *
1856
		 * Please take special care when using this parameter as it has the
1857
		 * potential to be harmful if not used correctly.
1858
		 *
1859
		 * @since 2.2.0
1860
		 */
1861
		public function force_deactivation() {
1862
			foreach ( $this->plugins as $slug => $plugin ) {
1863
				// Only proceed forward if the parameter is set to true and plugin is active.
1864
				if ( true === $plugin['force_deactivation'] && $this->is_plugin_active( $slug ) ) {
1865
					deactivate_plugins( $plugin['file_path'] );
1866
				}
1867
			}
1868
		}
1869
1870
		/**
1871
		 * Echo the current TGMPA version number to the page.
1872
		 */
1873
		public function show_tgmpa_version() {
1874
			echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
1875
				esc_html( sprintf( _x( 'TGMPA v%s', '%s = version number', 'tgmpa' ), self::TGMPA_VERSION ) ),
1876
				'</small></strong></p>';
1877
		}
1878
1879
		/**
1880
		 * Returns the singleton instance of the class.
1881
		 *
1882
		 * @since 2.4.0
1883
		 *
1884
		 * @return object The TGM_Plugin_Activation object.
1885
		 */
1886
		public static function get_instance() {
1887
			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
1888
				self::$instance = new self();
1889
			}
1890
1891
			return self::$instance;
1892
		}
1893
	}
1894
1895
	if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
1896
		/**
1897
		 * Ensure only one instance of the class is ever invoked.
1898
		 */
1899
		function load_tgm_plugin_activation() {
1900
			$GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
1901
		}
1902
	}
1903
1904
	if ( did_action( 'plugins_loaded' ) ) {
1905
		load_tgm_plugin_activation();
1906
	} else {
1907
		add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
1908
	}
1909
}
1910
1911
if ( ! function_exists( 'tgmpa' ) ) {
1912
	/**
1913
	 * Helper function to register a collection of required plugins.
1914
	 *
1915
	 * @since 2.0.0
1916
	 * @api
1917
	 *
1918
	 * @param array $plugins An array of plugin arrays.
1919
	 * @param array $config  Optional. An array of configuration values.
1920
	 */
1921
	function tgmpa( $plugins, $config = array() ) {
1922
		$instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
1923
1924
		foreach ( $plugins as $plugin ) {
1925
			call_user_func( array( $instance, 'register' ), $plugin );
1926
		}
1927
1928
		if ( ! empty( $config ) && is_array( $config ) ) {
1929
			// Send out notices for deprecated arguments passed.
1930
			if ( isset( $config['notices'] ) ) {
1931
				_deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
1932
				if ( ! isset( $config['has_notices'] ) ) {
1933
					$config['has_notices'] = $config['notices'];
1934
				}
1935
			}
1936
1937
			if ( isset( $config['parent_menu_slug'] ) ) {
1938
				_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.' );
1939
			}
1940
			if ( isset( $config['parent_url_slug'] ) ) {
1941
				_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.' );
1942
			}
1943
1944
			call_user_func( array( $instance, 'config' ), $config );
1945
		}
1946
	}
1947
}
1948
1949
/**
1950
 * WP_List_Table isn't always available. If it isn't available,
1951
 * we load it here.
1952
 *
1953
 * @since 2.2.0
1954
 */
1955
if ( ! class_exists( 'WP_List_Table' ) ) {
1956
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
1957
}
1958
1959
if ( ! class_exists( 'TGMPA_List_Table' ) ) {
1960
1961
	/**
1962
	 * List table class for handling plugins.
1963
	 *
1964
	 * Extends the WP_List_Table class to provide a future-compatible
1965
	 * way of listing out all required/recommended plugins.
1966
	 *
1967
	 * Gives users an interface similar to the Plugin Administration
1968
	 * area with similar (albeit stripped down) capabilities.
1969
	 *
1970
	 * This class also allows for the bulk install of plugins.
1971
	 *
1972
	 * @since 2.2.0
1973
	 *
1974
	 * @package TGM-Plugin-Activation
1975
	 * @author  Thomas Griffin
1976
	 * @author  Gary Jones
1977
	 */
1978
	class TGMPA_List_Table extends WP_List_Table {
1979
		/**
1980
		 * TGMPA instance.
1981
		 *
1982
		 * @since 2.5.0
1983
		 *
1984
		 * @var object
1985
		 */
1986
		protected $tgmpa;
1987
1988
		/**
1989
		 * The currently chosen view.
1990
		 *
1991
		 * @since 2.5.0
1992
		 *
1993
		 * @var string One of: 'all', 'install', 'update', 'activate'
1994
		 */
1995
		public $view_context = 'all';
1996
1997
		/**
1998
		 * The plugin counts for the various views.
1999
		 *
2000
		 * @since 2.5.0
2001
		 *
2002
		 * @var array
2003
		 */
2004
		protected $view_totals = array(
2005
			'all'      => 0,
2006
			'install'  => 0,
2007
			'update'   => 0,
2008
			'activate' => 0,
2009
		);
2010
2011
		/**
2012
		 * References parent constructor and sets defaults for class.
2013
		 *
2014
		 * @since 2.2.0
2015
		 */
2016
		public function __construct() {
2017
			$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2018
2019
			parent::__construct(
2020
				array(
2021
					'singular' => 'plugin',
2022
					'plural'   => 'plugins',
2023
					'ajax'     => false,
2024
				)
2025
			);
2026
2027
			if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
2028
				$this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
2029
			}
2030
2031
			add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
2032
		}
2033
2034
		/**
2035
		 * Get a list of CSS classes for the <table> tag.
2036
		 *
2037
		 * Overruled to prevent the 'plural' argument from being added.
2038
		 *
2039
		 * @since 2.5.0
2040
		 *
2041
		 * @return array CSS classnames.
2042
		 */
2043
		public function get_table_classes() {
2044
			return array( 'widefat', 'fixed' );
2045
		}
2046
2047
		/**
2048
		 * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
2049
		 *
2050
		 * @since 2.2.0
2051
		 *
2052
		 * @return array $table_data Information for use in table.
2053
		 */
2054
		protected function _gather_plugin_data() {
2055
			// Load thickbox for plugin links.
2056
			$this->tgmpa->admin_init();
2057
			$this->tgmpa->thickbox();
2058
2059
			// Categorize the plugins which have open actions.
2060
			$plugins = $this->categorize_plugins_to_views();
2061
2062
			// Set the counts for the view links.
2063
			$this->set_view_totals( $plugins );
2064
2065
			// Prep variables for use and grab list of all installed plugins.
2066
			$table_data = array();
2067
			$i          = 0;
2068
2069
			// Redirect to the 'all' view if no plugins were found for the selected view context.
2070
			if ( empty( $plugins[ $this->view_context ] ) ) {
2071
				$this->view_context = 'all';
2072
			}
2073
2074
			foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
2075
				$table_data[ $i ]['sanitized_plugin']  = $plugin['name'];
2076
				$table_data[ $i ]['slug']              = $slug;
2077
				$table_data[ $i ]['plugin']            = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
2078
				$table_data[ $i ]['source']            = $this->get_plugin_source_type_text( $plugin['source_type'] );
2079
				$table_data[ $i ]['type']              = $this->get_plugin_advise_type_text( $plugin['required'] );
2080
				$table_data[ $i ]['status']            = $this->get_plugin_status_text( $slug );
2081
				$table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
2082
				$table_data[ $i ]['minimum_version']   = $plugin['version'];
2083
				$table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
2084
2085
				// Prep the upgrade notice info.
2086
				$upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
2087
				if ( ! empty( $upgrade_notice ) ) {
2088
					$table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
2089
2090
					add_action( "tgmpa_after_plugin_row_$slug", array( $this, 'wp_plugin_update_row' ), 10, 2 );
2091
				}
2092
2093
				$table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
2094
2095
				$i++;
2096
			}
2097
2098
			return $table_data;
2099
		}
2100
2101
		/**
2102
		 * Categorize the plugins which have open actions into views for the TGMPA page.
2103
		 *
2104
		 * @since 2.5.0
2105
		 */
2106
		protected function categorize_plugins_to_views() {
2107
			$plugins = array(
2108
				'all'      => array(), // Meaning: all plugins which still have open actions.
2109
				'install'  => array(),
2110
				'update'   => array(),
2111
				'activate' => array(),
2112
			);
2113
2114
			foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
2115
				if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2116
					// No need to display plugins if they are installed, up-to-date and active.
2117
					continue;
2118
				} else {
2119
					$plugins['all'][ $slug ] = $plugin;
2120
2121
					if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2122
						$plugins['install'][ $slug ] = $plugin;
2123
					} else {
2124
						if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2125
							$plugins['update'][ $slug ] = $plugin;
2126
						}
2127
2128
						if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2129
							$plugins['activate'][ $slug ] = $plugin;
2130
						}
2131
					}
2132
				}
2133
			}
2134
2135
			return $plugins;
2136
		}
2137
2138
		/**
2139
		 * Set the counts for the view links.
2140
		 *
2141
		 * @since 2.5.0
2142
		 *
2143
		 * @param array $plugins Plugins order by view.
2144
		 */
2145
		protected function set_view_totals( $plugins ) {
2146
			foreach ( $plugins as $type => $list ) {
2147
				$this->view_totals[ $type ] = count( $list );
2148
			}
2149
		}
2150
2151
		/**
2152
		 * Get the plugin required/recommended text string.
2153
		 *
2154
		 * @since 2.5.0
2155
		 *
2156
		 * @param string $required Plugin required setting.
2157
		 * @return string
2158
		 */
2159
		protected function get_plugin_advise_type_text( $required ) {
2160
			if ( true === $required ) {
2161
				return __( 'Required', 'tgmpa' );
2162
			}
2163
2164
			return __( 'Recommended', 'tgmpa' );
2165
		}
2166
2167
		/**
2168
		 * Get the plugin source type text string.
2169
		 *
2170
		 * @since 2.5.0
2171
		 *
2172
		 * @param string $type Plugin type.
2173
		 * @return string
2174
		 */
2175
		protected function get_plugin_source_type_text( $type ) {
2176
			$string = '';
2177
2178
			switch ( $type ) {
2179
				case 'repo':
2180
					$string = __( 'WordPress Repository', 'tgmpa' );
2181
					break;
2182
				case 'external':
2183
					$string = __( 'External Source', 'tgmpa' );
2184
					break;
2185
				case 'bundled':
2186
					$string = __( 'Pre-Packaged', 'tgmpa' );
2187
					break;
2188
			}
2189
2190
			return $string;
2191
		}
2192
2193
		/**
2194
		 * Determine the plugin status message.
2195
		 *
2196
		 * @since 2.5.0
2197
		 *
2198
		 * @param string $slug Plugin slug.
2199
		 * @return string
2200
		 */
2201
		protected function get_plugin_status_text( $slug ) {
2202
			if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2203
				return __( 'Not Installed', 'tgmpa' );
2204
			}
2205
2206
			if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
2207
				$install_status = __( 'Installed But Not Activated', 'tgmpa' );
2208
			} else {
2209
				$install_status = __( 'Active', 'tgmpa' );
2210
			}
2211
2212
			$update_status = '';
2213
2214
			if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2215
				$update_status = __( 'Required Update not Available', 'tgmpa' );
2216
2217
			} elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
2218
				$update_status = __( 'Requires Update', 'tgmpa' );
2219
2220
			} elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2221
				$update_status = __( 'Update recommended', 'tgmpa' );
2222
			}
2223
2224
			if ( '' === $update_status ) {
2225
				return $install_status;
2226
			}
2227
2228
			return sprintf(
2229
				_x( '%1$s, %2$s', '%1$s = install status, %2$s = update status', 'tgmpa' ),
2230
				$install_status,
2231
				$update_status
2232
			);
2233
		}
2234
2235
		/**
2236
		 * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
2237
		 *
2238
		 * @since 2.5.0
2239
		 *
2240
		 * @param array $items Prepared table items.
2241
		 * @return array Sorted table items.
2242
		 */
2243
		public function sort_table_items( $items ) {
2244
			$type = array();
2245
			$name = array();
2246
2247
			foreach ( $items as $i => $plugin ) {
2248
				$type[ $i ] = $plugin['type']; // Required / recommended.
2249
				$name[ $i ] = $plugin['sanitized_plugin'];
2250
			}
2251
2252
			array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
2253
2254
			return $items;
2255
		}
2256
2257
		/**
2258
		 * Get an associative array ( id => link ) of the views available on this table.
2259
		 *
2260
		 * @since 2.5.0
2261
		 *
2262
		 * @return array
2263
		 */
2264
		public function get_views() {
2265
			$status_links = array();
2266
2267
			foreach ( $this->view_totals as $type => $count ) {
2268
				if ( $count < 1 ) {
2269
					continue;
2270
				}
2271
2272
				switch ( $type ) {
2273
					case 'all':
2274
						$text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
2275
						break;
2276
					case 'install':
2277
						$text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
2278
						break;
2279
					case 'update':
2280
						$text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
2281
						break;
2282
					case 'activate':
2283
						$text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
2284
						break;
2285
					default:
2286
						$text = '';
2287
						break;
2288
				}
2289
2290
				if ( ! empty( $text ) ) {
2291
2292
					$status_links[ $type ] = sprintf(
2293
						'<a href="%s"%s>%s</a>',
2294
						esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
2295
						( $type === $this->view_context ) ? ' class="current"' : '',
2296
						sprintf( $text, number_format_i18n( $count ) )
2297
					);
2298
				}
2299
			}
2300
2301
			return $status_links;
2302
		}
2303
2304
		/**
2305
		 * Create default columns to display important plugin information
2306
		 * like type, action and status.
2307
		 *
2308
		 * @since 2.2.0
2309
		 *
2310
		 * @param array  $item        Array of item data.
2311
		 * @param string $column_name The name of the column.
2312
		 * @return string
2313
		 */
2314
		public function column_default( $item, $column_name ) {
2315
			return $item[ $column_name ];
2316
		}
2317
2318
		/**
2319
		 * Required for bulk installing.
2320
		 *
2321
		 * Adds a checkbox for each plugin.
2322
		 *
2323
		 * @since 2.2.0
2324
		 *
2325
		 * @param array $item Array of item data.
2326
		 * @return string The input checkbox with all necessary info.
2327
		 */
2328
		public function column_cb( $item ) {
2329
			return sprintf(
2330
				'<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
2331
				esc_attr( $this->_args['singular'] ),
2332
				esc_attr( $item['slug'] ),
2333
				esc_attr( $item['sanitized_plugin'] )
2334
			);
2335
		}
2336
2337
		/**
2338
		 * Create default title column along with the action links.
2339
		 *
2340
		 * @since 2.2.0
2341
		 *
2342
		 * @param array $item Array of item data.
2343
		 * @return string The plugin name and action links.
2344
		 */
2345
		public function column_plugin( $item ) {
2346
			return sprintf(
2347
				'%1$s %2$s',
2348
				$item['plugin'],
2349
				$this->row_actions( $this->get_row_actions( $item ), true )
2350
			);
2351
		}
2352
2353
		/**
2354
		 * Create version information column.
2355
		 *
2356
		 * @since 2.5.0
2357
		 *
2358
		 * @param array $item Array of item data.
2359
		 * @return string HTML-formatted version information.
2360
		 */
2361
		public function column_version( $item ) {
2362
			$output = array();
2363
2364
			if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2365
				$installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
2366
2367
				$color = '';
2368
				if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
2369
					$color = ' color: #ff0000; font-weight: bold;';
2370
				}
2371
2372
				$output[] = sprintf(
2373
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
2374
					$color,
2375
					$installed
2376
				);
2377
			}
2378
2379
			if ( ! empty( $item['minimum_version'] ) ) {
2380
				$output[] = sprintf(
2381
					'<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
2382
					$item['minimum_version']
2383
				);
2384
			}
2385
2386
			if ( ! empty( $item['available_version'] ) ) {
2387
				$color = '';
2388
				if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
2389
					$color = ' color: #71C671; font-weight: bold;';
2390
				}
2391
2392
				$output[] = sprintf(
2393
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
2394
					$color,
2395
					$item['available_version']
2396
				);
2397
			}
2398
2399
			if ( empty( $output ) ) {
2400
				return '&nbsp;'; // Let's not break the table layout.
2401
			} else {
2402
				return implode( "\n", $output );
2403
			}
2404
		}
2405
2406
		/**
2407
		 * Sets default message within the plugins table if no plugins
2408
		 * are left for interaction.
2409
		 *
2410
		 * Hides the menu item to prevent the user from clicking and
2411
		 * getting a permissions error.
2412
		 *
2413
		 * @since 2.2.0
2414
		 */
2415
		public function no_items() {
2416
			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() ) );
2417
			echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
2418
		}
2419
2420
		/**
2421
		 * Output all the column information within the table.
2422
		 *
2423
		 * @since 2.2.0
2424
		 *
2425
		 * @return array $columns The column names.
2426
		 */
2427
		public function get_columns() {
2428
			$columns = array(
2429
				'cb'     => '<input type="checkbox" />',
2430
				'plugin' => __( 'Plugin', 'tgmpa' ),
2431
				'source' => __( 'Source', 'tgmpa' ),
2432
				'type'   => __( 'Type', 'tgmpa' ),
2433
			);
2434
2435
			if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
2436
				$columns['version'] = __( 'Version', 'tgmpa' );
2437
				$columns['status']  = __( 'Status', 'tgmpa' );
2438
			}
2439
2440
			return apply_filters( 'tgmpa_table_columns', $columns );
2441
		}
2442
2443
		/**
2444
		 * Get name of default primary column
2445
		 *
2446
		 * @since 2.5.0 / WP 4.3+ compatibility
2447
		 * @access protected
2448
		 *
2449
		 * @return string
2450
		 */
2451
		protected function get_default_primary_column_name() {
2452
			return 'plugin';
2453
		}
2454
2455
		/**
2456
		 * Get the name of the primary column.
2457
		 *
2458
		 * @since 2.5.0 / WP 4.3+ compatibility
2459
		 * @access protected
2460
		 *
2461
		 * @return string The name of the primary column.
2462
		 */
2463
		protected function get_primary_column_name() {
2464
			if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
2465
				return parent::get_primary_column_name();
2466
			} else {
2467
				return $this->get_default_primary_column_name();
2468
			}
2469
		}
2470
2471
		/**
2472
		 * Get the actions which are relevant for a specific plugin row.
2473
		 *
2474
		 * @since 2.5.0
2475
		 *
2476
		 * @param array $item Array of item data.
2477
		 * @return array Array with relevant action links.
2478
		 */
2479
		protected function get_row_actions( $item ) {
2480
			$actions      = array();
2481
			$action_links = array();
2482
2483
			// Display the 'Install' action link if the plugin is not yet available.
2484
			if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2485
				$actions['install'] = _x( 'Install %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2486
			} else {
2487
				// Display the 'Update' action link if an update is available and WP complies with plugin minimum.
2488
				if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
2489
					$actions['update'] = _x( 'Update %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2490
				}
2491
2492
				// Display the 'Activate' action link, but only if the plugin meets the minimum version.
2493
				if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
2494
					$actions['activate'] = _x( 'Activate %2$s', '%2$s = plugin name in screen reader markup', 'tgmpa' );
2495
				}
2496
			}
2497
2498
			// Create the actual links.
2499
			foreach ( $actions as $action => $text ) {
2500
				$nonce_url = wp_nonce_url(
2501
					add_query_arg(
2502
						array(
2503
							'plugin'           => urlencode( $item['slug'] ),
2504
							'tgmpa-' . $action => $action . '-plugin',
2505
						),
2506
						$this->tgmpa->get_tgmpa_url()
2507
					),
2508
					'tgmpa-' . $action,
2509
					'tgmpa-nonce'
2510
				);
2511
2512
				$action_links[ $action ] = sprintf(
2513
					'<a href="%1$s">' . esc_html( $text ) . '</a>',
2514
					esc_url( $nonce_url ),
2515
					'<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
2516
				);
2517
			}
2518
2519
			$prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
2520
			return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
2521
		}
2522
2523
		/**
2524
		 * Generates content for a single row of the table.
2525
		 *
2526
		 * @since 2.5.0
2527
		 *
2528
		 * @param object $item The current item.
2529
		 */
2530
		public function single_row( $item ) {
2531
			parent::single_row( $item );
2532
2533
			/**
2534
			 * Fires after each specific row in the TGMPA Plugins list table.
2535
			 *
2536
			 * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
2537
			 * for the plugin.
2538
			 *
2539
			 * @since 2.5.0
2540
			 */
2541
			do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
2542
		}
2543
2544
		/**
2545
		 * Show the upgrade notice below a plugin row if there is one.
2546
		 *
2547
		 * @since 2.5.0
2548
		 *
2549
		 * @see /wp-admin/includes/update.php
2550
		 *
2551
		 * @param string $slug Plugin slug.
2552
		 * @param array  $item The information available in this table row.
2553
		 * @return null Return early if upgrade notice is empty.
2554
		 */
2555
		public function wp_plugin_update_row( $slug, $item ) {
2556
			if ( empty( $item['upgrade_notice'] ) ) {
2557
				return;
2558
			}
2559
2560
			echo '
2561
				<tr class="plugin-update-tr">
2562
					<td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
2563
						<div class="update-message">',
2564
							esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
2565
							' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
2566
						</div>
2567
					</td>
2568
				</tr>';
2569
		}
2570
2571
		/**
2572
		 * Extra controls to be displayed between bulk actions and pagination.
2573
		 *
2574
		 * @since 2.5.0
2575
		 *
2576
		 * @param string $which 'top' or 'bottom' table navigation.
2577
		 */
2578
		public function extra_tablenav( $which ) {
2579
			if ( 'bottom' === $which ) {
2580
				$this->tgmpa->show_tgmpa_version();
2581
			}
2582
		}
2583
2584
		/**
2585
		 * Defines the bulk actions for handling registered plugins.
2586
		 *
2587
		 * @since 2.2.0
2588
		 *
2589
		 * @return array $actions The bulk actions for the plugin install table.
2590
		 */
2591
		public function get_bulk_actions() {
2592
2593
			$actions = array();
2594
2595
			if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
2596
				if ( current_user_can( 'install_plugins' ) ) {
2597
					$actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
2598
				}
2599
			}
2600
2601
			if ( 'install' !== $this->view_context ) {
2602
				if ( current_user_can( 'update_plugins' ) ) {
2603
					$actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
2604
				}
2605
				if ( current_user_can( 'activate_plugins' ) ) {
2606
					$actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
2607
				}
2608
			}
2609
2610
			return $actions;
2611
		}
2612
2613
		/**
2614
		 * Processes bulk installation and activation actions.
2615
		 *
2616
		 * The bulk installation process looks for the $_POST information and passes that
2617
		 * through if a user has to use WP_Filesystem to enter their credentials.
2618
		 *
2619
		 * @since 2.2.0
2620
		 */
2621
		public function process_bulk_actions() {
2622
			// Bulk installation process.
2623
			if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
2624
2625
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2626
2627
				$install_type = 'install';
2628
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2629
					$install_type = 'update';
2630
				}
2631
2632
				$plugins_to_install = array();
2633
2634
				// Did user actually select any plugins to install/update ?
2635 View Code Duplication
				if ( empty( $_POST['plugin'] ) ) {
2636
					if ( 'install' === $install_type ) {
2637
						$message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
2638
					} else {
2639
						$message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
2640
					}
2641
2642
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2643
2644
					return false;
2645
				}
2646
2647
				if ( is_array( $_POST['plugin'] ) ) {
2648
					$plugins_to_install = (array) $_POST['plugin'];
2649
				} elseif ( is_string( $_POST['plugin'] ) ) {
2650
					// Received via Filesystem page - un-flatten array (WP bug #19643).
2651
					$plugins_to_install = explode( ',', $_POST['plugin'] );
2652
				}
2653
2654
				// Sanitize the received input.
2655
				$plugins_to_install = array_map( 'urldecode', $plugins_to_install );
2656
				$plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
2657
2658
				// Validate the received input.
2659
				foreach ( $plugins_to_install as $key => $slug ) {
2660
					// Check if the plugin was registered with TGMPA and remove if not.
2661
					if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
2662
						unset( $plugins_to_install[ $key ] );
2663
						continue;
2664
					}
2665
2666
					// For updates: make sure this is a plugin we *can* update (update available and WP version ok).
2667
					if ( 'update' === $install_type && ( $this->tgmpa->is_plugin_installed( $slug ) && ( false === $this->tgmpa->does_plugin_have_update( $slug ) || ! $this->tgmpa->can_plugin_update( $slug ) ) ) ) {
2668
						unset( $plugins_to_install[ $key ] );
2669
					}
2670
				}
2671
2672
				// No need to proceed further if we have no plugins to handle.
2673 View Code Duplication
				if ( empty( $plugins_to_install ) ) {
2674
					if ( 'install' === $install_type ) {
2675
						$message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
2676
					} else {
2677
						$message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
2678
					}
2679
2680
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2681
2682
					return false;
2683
				}
2684
2685
				// Pass all necessary information if WP_Filesystem is needed.
2686
				$url = wp_nonce_url(
2687
					$this->tgmpa->get_tgmpa_url(),
2688
					'bulk-' . $this->_args['plural']
2689
				);
2690
2691
				// Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
2692
				$_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
2693
2694
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
2695
				$fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
2696
2697 View Code Duplication
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields ) ) ) {
2698
					return true; // Stop the normal page form from displaying, credential request form will be shown.
2699
				}
2700
2701
				// Now we have some credentials, setup WP_Filesystem.
2702 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
0 ignored issues
show
This code seems to be duplicated across your project.

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

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

Loading history...
2703
					// Our credentials were no good, ask the user for them again.
2704
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
2705
2706
					return true;
2707
				}
2708
2709
				/* If we arrive here, we have the filesystem */
2710
2711
				// Store all information in arrays since we are processing a bulk installation.
2712
				$names      = array();
2713
				$sources    = array(); // Needed for installs.
2714
				$file_paths = array(); // Needed for upgrades.
2715
				$to_inject  = array(); // Information to inject into the update_plugins transient.
2716
2717
				// Prepare the data for validated plugins for the install/upgrade.
2718
				foreach ( $plugins_to_install as $slug ) {
2719
					$name   = $this->tgmpa->plugins[ $slug ]['name'];
2720
					$source = $this->tgmpa->get_download_url( $slug );
2721
2722
					if ( ! empty( $name ) && ! empty( $source ) ) {
2723
						$names[] = $name;
2724
2725
						switch ( $install_type ) {
2726
2727
							case 'install':
2728
								$sources[] = $source;
2729
								break;
2730
2731
							case 'update':
2732
								$file_paths[]                 = $this->tgmpa->plugins[ $slug ]['file_path'];
2733
								$to_inject[ $slug ]           = $this->tgmpa->plugins[ $slug ];
2734
								$to_inject[ $slug ]['source'] = $source;
2735
								break;
2736
						}
2737
					}
2738
				}
2739
				unset( $slug, $name, $source );
2740
2741
				// Create a new instance of TGMPA_Bulk_Installer.
2742
				$installer = new TGMPA_Bulk_Installer(
2743
					new TGMPA_Bulk_Installer_Skin(
2744
						array(
2745
							'url'          => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
2746
							'nonce'        => 'bulk-' . $this->_args['plural'],
2747
							'names'        => $names,
2748
							'install_type' => $install_type,
2749
						)
2750
					)
2751
				);
2752
2753
				// Wrap the install process with the appropriate HTML.
2754
				echo '<div class="tgmpa wrap">',
2755
					'<h2>', esc_html( get_admin_page_title() ), '</h2>';
2756
2757
				// Process the bulk installation submissions.
2758
				add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
2759
2760
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2761
					// Inject our info into the update transient.
2762
					$this->tgmpa->inject_update_info( $to_inject );
2763
2764
					$installer->bulk_upgrade( $file_paths );
2765
				} else {
2766
					$installer->bulk_install( $sources );
2767
				}
2768
2769
				remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
2770
2771
				echo '</div>';
2772
2773
				return true;
2774
			}
2775
2776
			// Bulk activation process.
2777
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
2778
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2779
2780
				// Did user actually select any plugins to activate ?
2781
				if ( empty( $_POST['plugin'] ) ) {
2782
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
2783
2784
					return false;
2785
				}
2786
2787
				// Grab plugin data from $_POST.
2788
				$plugins = array();
2789
				if ( isset( $_POST['plugin'] ) ) {
2790
					$plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
2791
					$plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
2792
				}
2793
2794
				$plugins_to_activate = array();
2795
				$plugin_names        = array();
2796
2797
				// Grab the file paths for the selected & inactive plugins from the registration array.
2798
				foreach ( $plugins as $slug ) {
2799
					if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2800
						$plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
2801
						$plugin_names[]        = $this->tgmpa->plugins[ $slug ]['name'];
2802
					}
2803
				}
2804
				unset( $slug );
2805
2806
				// Return early if there are no plugins to activate.
2807
				if ( empty( $plugins_to_activate ) ) {
2808
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
2809
2810
					return false;
2811
				}
2812
2813
				// Now we are good to go - let's start activating plugins.
2814
				$activate = activate_plugins( $plugins_to_activate );
2815
2816
				if ( is_wp_error( $activate ) ) {
2817
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
2818
				} else {
2819
					$count        = count( $plugin_names ); // Count so we can use _n function.
2820
					$plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
2821
					$last_plugin  = array_pop( $plugin_names ); // Pop off last name to prep for readability.
2822
					$imploded     = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
2823
2824
					printf( // WPCS: xss ok.
2825
						'<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
2826
						esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
2827
						$imploded
2828
					);
2829
2830
					// Update recently activated plugins option.
2831
					$recent = (array) get_option( 'recently_activated' );
2832
					foreach ( $plugins_to_activate as $plugin => $time ) {
2833
						if ( isset( $recent[ $plugin ] ) ) {
2834
							unset( $recent[ $plugin ] );
2835
						}
2836
					}
2837
					update_option( 'recently_activated', $recent );
2838
				}
2839
2840
				unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
2841
2842
				return true;
2843
			}
2844
2845
			return false;
2846
		}
2847
2848
		/**
2849
		 * Prepares all of our information to be outputted into a usable table.
2850
		 *
2851
		 * @since 2.2.0
2852
		 */
2853
		public function prepare_items() {
2854
			$columns               = $this->get_columns(); // Get all necessary column information.
2855
			$hidden                = array(); // No columns to hide, but we must set as an array.
2856
			$sortable              = array(); // No reason to make sortable columns.
2857
			$primary               = $this->get_primary_column_name(); // Column which has the row actions.
2858
			$this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
2859
2860
			// Process our bulk activations here.
2861
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
2862
				$this->process_bulk_actions();
2863
			}
2864
2865
			// Store all of our plugin data into $items array so WP_List_Table can use it.
2866
			$this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
2867
		}
2868
2869
		/* *********** DEPRECATED METHODS *********** */
2870
2871
		/**
2872
		 * Retrieve plugin data, given the plugin name.
2873
		 *
2874
		 * @since      2.2.0
2875
		 * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
2876
		 * @see        TGM_Plugin_Activation::_get_plugin_data_from_name()
2877
		 *
2878
		 * @param string $name Name of the plugin, as it was registered.
2879
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
2880
		 * @return string|boolean Plugin slug if found, false otherwise.
2881
		 */
2882
		protected function _get_plugin_data_from_name( $name, $data = 'slug' ) {
2883
			_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
2884
2885
			return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
2886
		}
2887
	}
2888
}
2889
2890
2891
if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
2892
2893
	/**
2894
	 * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
2895
	 */
2896
	class TGM_Bulk_Installer {
2897
	}
2898
}
2899
if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
2900
2901
	/**
2902
	 * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
2903
	 */
2904
	class TGM_Bulk_Installer_Skin {
2905
	}
2906
}
2907
2908
/**
2909
 * The WP_Upgrader file isn't always available. If it isn't available,
2910
 * we load it here.
2911
 *
2912
 * We check to make sure no action or activation keys are set so that WordPress
2913
 * does not try to re-include the class when processing upgrades or installs outside
2914
 * of the class.
2915
 *
2916
 * @since 2.2.0
2917
 */
2918
add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
2919
if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
2920
	/**
2921
	 * Load bulk installer
2922
	 */
2923
	function tgmpa_load_bulk_installer() {
2924
		// Silently fail if 2.5+ is loaded *after* an older version.
2925
		if ( ! isset( $GLOBALS['tgmpa'] ) ) {
2926
			return;
2927
		}
2928
2929
		// Get TGMPA class instance.
2930
		$tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2931
2932
		if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
2933
			if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
2934
				require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
2935
			}
2936
2937
			if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
2938
2939
				/**
2940
				 * Installer class to handle bulk plugin installations.
2941
				 *
2942
				 * Extends WP_Upgrader and customizes to suit the installation of multiple
2943
				 * plugins.
2944
				 *
2945
				 * @since 2.2.0
2946
				 *
2947
				 * @internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader
2948
				 * @internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
2949
				 *           This was done to prevent backward compatibility issues with v2.3.6.
2950
				 *
2951
				 * @package TGM-Plugin-Activation
2952
				 * @author  Thomas Griffin
2953
				 * @author  Gary Jones
2954
				 */
2955
				class TGMPA_Bulk_Installer extends Plugin_Upgrader {
2956
					/**
2957
					 * Holds result of bulk plugin installation.
2958
					 *
2959
					 * @since 2.2.0
2960
					 *
2961
					 * @var string
2962
					 */
2963
					public $result;
2964
2965
					/**
2966
					 * Flag to check if bulk installation is occurring or not.
2967
					 *
2968
					 * @since 2.2.0
2969
					 *
2970
					 * @var boolean
2971
					 */
2972
					public $bulk = false;
2973
2974
					/**
2975
					 * TGMPA instance
2976
					 *
2977
					 * @since 2.5.0
2978
					 *
2979
					 * @var object
2980
					 */
2981
					protected $tgmpa;
2982
2983
					/**
2984
					 * Whether or not the destination directory needs to be cleared ( = on update).
2985
					 *
2986
					 * @since 2.5.0
2987
					 *
2988
					 * @var bool
2989
					 */
2990
					protected $clear_destination = false;
2991
2992
					/**
2993
					 * References parent constructor and sets defaults for class.
2994
					 *
2995
					 * @since 2.2.0
2996
					 *
2997
					 * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
2998
					 */
2999
					public function __construct( $skin = null ) {
3000
						// Get TGMPA class instance.
3001
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3002
3003
						parent::__construct( $skin );
3004
3005
						if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
3006
							$this->clear_destination = true;
3007
						}
3008
3009
						if ( $this->tgmpa->is_automatic ) {
3010
							$this->activate_strings();
3011
						}
3012
3013
						add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
3014
					}
3015
3016
					/**
3017
					 * Sets the correct activation strings for the installer skin to use.
3018
					 *
3019
					 * @since 2.2.0
3020
					 */
3021
					public function activate_strings() {
3022
						$this->strings['activation_failed']  = __( 'Plugin activation failed.', 'tgmpa' );
3023
						$this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
3024
					}
3025
3026
					/**
3027
					 * Performs the actual installation of each plugin.
3028
					 *
3029
					 * @since 2.2.0
3030
					 *
3031
					 * @see WP_Upgrader::run()
3032
					 *
3033
					 * @param array $options The installation config options.
3034
					 * @return null|array Return early if error, array of installation data on success.
3035
					 */
3036
					public function run( $options ) {
3037
						$result = parent::run( $options );
3038
3039
						// Reset the strings in case we changed one during automatic activation.
3040
						if ( $this->tgmpa->is_automatic ) {
3041
							if ( 'update' === $this->skin->options['install_type'] ) {
3042
								$this->upgrade_strings();
3043
							} else {
3044
								$this->install_strings();
3045
							}
3046
						}
3047
3048
						return $result;
3049
					}
3050
3051
					/**
3052
					 * Processes the bulk installation of plugins.
3053
					 *
3054
					 * @since 2.2.0
3055
					 *
3056
					 * @internal This is basically a near identical copy of the WP Core Plugin_Upgrader::bulk_upgrade()
3057
					 * method, with minor adjustments to deal with new installs instead of upgrades.
3058
					 * For ease of future synchronizations, the adjustments are clearly commented, but no other
3059
					 * comments are added. Code style has been made to comply.
3060
					 *
3061
					 * @see Plugin_Upgrader::bulk_upgrade()
3062
					 * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
3063
					 *
3064
					 * @param array $plugins The plugin sources needed for installation.
3065
					 * @param array $args    Arbitrary passed extra arguments.
3066
					 * @return string|bool Install confirmation messages on success, false on failure.
3067
					 */
3068
					public function bulk_install( $plugins, $args = array() ) {
3069
						// [TGMPA + ] Hook auto-activation in.
3070
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3071
3072
						$defaults    = array(
3073
							'clear_update_cache' => true,
3074
						);
3075
						$parsed_args = wp_parse_args( $args, $defaults );
3076
3077
						$this->init();
3078
						$this->bulk = true;
3079
3080
						$this->install_strings(); // [TGMPA + ] adjusted.
3081
3082
						/* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
3083
3084
						/* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
3085
3086
						$this->skin->header();
3087
3088
						// Connect to the Filesystem first.
3089
						$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
3090
						if ( ! $res ) {
3091
							$this->skin->footer();
3092
3093
							return false;
3094
						}
3095
3096
						$this->skin->bulk_header();
3097
3098
						// Only start maintenance mode if:
3099
						// - running Multisite and there are one or more plugins specified, OR
3100
						// - a plugin with an update available is currently active.
3101
						// @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
3102
						$maintenance = ( is_multisite() && ! empty( $plugins ) );
3103
3104
						/*
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...
3105
						[TGMPA - ]
3106
						foreach ( $plugins as $plugin )
3107
							$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
3108
						*/
3109
						if ( $maintenance ) {
3110
							$this->maintenance_mode( true );
3111
						}
3112
3113
						$results = array();
3114
3115
						$this->update_count   = count( $plugins );
3116
						$this->update_current = 0;
3117
						foreach ( $plugins as $plugin ) {
3118
							$this->update_current++;
3119
3120
							/*
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...
3121
							[TGMPA - ]
3122
							$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
3123
3124
							if ( !isset( $current->response[ $plugin ] ) ) {
3125
								$this->skin->set_result('up_to_date');
3126
								$this->skin->before();
3127
								$this->skin->feedback('up_to_date');
3128
								$this->skin->after();
3129
								$results[$plugin] = true;
3130
								continue;
3131
							}
3132
3133
							// Get the URL to the zip file
3134
							$r = $current->response[ $plugin ];
3135
3136
							$this->skin->plugin_active = is_plugin_active($plugin);
3137
							*/
3138
3139
							$result = $this->run(
3140
								array(
3141
									'package'           => $plugin, // [TGMPA + ] adjusted.
3142
									'destination'       => WP_PLUGIN_DIR,
3143
									'clear_destination' => false, // [TGMPA + ] adjusted.
3144
									'clear_working'     => true,
3145
									'is_multi'          => true,
3146
									'hook_extra'        => array(
3147
										'plugin' => $plugin,
3148
									),
3149
								)
3150
							);
3151
3152
							$results[ $plugin ] = $this->result;
3153
3154
							// Prevent credentials auth screen from displaying multiple times.
3155
							if ( false === $result ) {
3156
								break;
3157
							}
3158
						} //end foreach $plugins
3159
3160
						$this->maintenance_mode( false );
3161
3162
						/**
3163
						 * Fires when the bulk upgrader process is complete.
3164
						 *
3165
						 * @since WP 3.6.0 / TGMPA 2.5.0
3166
						 *
3167
						 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
3168
						 *                              be a Theme_Upgrader or Core_Upgrade instance.
3169
						 * @param array           $data {
3170
						 *     Array of bulk item update data.
3171
						 *
3172
						 *     @type string $action   Type of action. Default 'update'.
3173
						 *     @type string $type     Type of update process. Accepts 'plugin', 'theme', or 'core'.
3174
						 *     @type bool   $bulk     Whether the update process is a bulk update. Default true.
3175
						 *     @type array  $packages Array of plugin, theme, or core packages to update.
3176
						 * }
3177
						 */
3178
						do_action( 'upgrader_process_complete', $this, array(
3179
							'action'  => 'install', // [TGMPA + ] adjusted.
3180
							'type'    => 'plugin',
3181
							'bulk'    => true,
3182
							'plugins' => $plugins,
3183
						) );
3184
3185
						$this->skin->bulk_footer();
3186
3187
						$this->skin->footer();
3188
3189
						// Cleanup our hooks, in case something else does a upgrade on this connection.
3190
						/* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
3191
3192
						// [TGMPA + ] Remove our auto-activation hook.
3193
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3194
3195
						// Force refresh of plugin update information.
3196
						wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
3197
3198
						return $results;
3199
					}
3200
3201
					/**
3202
					 * Handle a bulk upgrade request.
3203
					 *
3204
					 * @since 2.5.0
3205
					 *
3206
					 * @see Plugin_Upgrader::bulk_upgrade()
3207
					 *
3208
					 * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
3209
					 * @param array $args    Arbitrary passed extra arguments.
3210
					 * @return string|bool Install confirmation messages on success, false on failure.
3211
					 */
3212
					public function bulk_upgrade( $plugins, $args = array() ) {
3213
3214
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3215
3216
						$result = parent::bulk_upgrade( $plugins, $args );
3217
3218
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3219
3220
						return $result;
3221
					}
3222
3223
					/**
3224
					 * Abuse a filter to auto-activate plugins after installation.
3225
					 *
3226
					 * Hooked into the 'upgrader_post_install' filter hook.
3227
					 *
3228
					 * @since 2.5.0
3229
					 *
3230
					 * @param bool $bool The value we need to give back (true).
3231
					 * @return bool
3232
					 */
3233
					public function auto_activate( $bool ) {
3234
						// Only process the activation of installed plugins if the automatic flag is set to true.
3235
						if ( $this->tgmpa->is_automatic ) {
3236
							// Flush plugins cache so the headers of the newly installed plugins will be read correctly.
3237
							wp_clean_plugins_cache();
3238
3239
							// Get the installed plugin file.
3240
							$plugin_info = $this->plugin_info();
3241
3242
							// Don't try to activate on upgrade of active plugin as WP will do this already.
3243
							if ( ! is_plugin_active( $plugin_info ) ) {
3244
								$activate = activate_plugin( $plugin_info );
3245
3246
								// Adjust the success string based on the activation result.
3247
								$this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
3248
3249
								if ( is_wp_error( $activate ) ) {
3250
									$this->skin->error( $activate );
3251
									$this->strings['process_success'] .= $this->strings['activation_failed'];
3252
								} else {
3253
									$this->strings['process_success'] .= $this->strings['activation_success'];
3254
								}
3255
							}
3256
						}
3257
3258
						return $bool;
3259
					}
3260
				}
3261
			}
3262
3263
			if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
3264
3265
				/**
3266
				 * Installer skin to set strings for the bulk plugin installations..
3267
				 *
3268
				 * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
3269
				 * plugins.
3270
				 *
3271
				 * @since 2.2.0
3272
				 *
3273
				 * @internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
3274
				 *           TGMPA_Bulk_Installer_Skin.
3275
				 *           This was done to prevent backward compatibility issues with v2.3.6.
3276
				 *
3277
				 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
3278
				 *
3279
				 * @package TGM-Plugin-Activation
3280
				 * @author  Thomas Griffin
3281
				 * @author  Gary Jones
3282
				 */
3283
				class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
3284
					/**
3285
					 * Holds plugin info for each individual plugin installation.
3286
					 *
3287
					 * @since 2.2.0
3288
					 *
3289
					 * @var array
3290
					 */
3291
					public $plugin_info = array();
3292
3293
					/**
3294
					 * Holds names of plugins that are undergoing bulk installations.
3295
					 *
3296
					 * @since 2.2.0
3297
					 *
3298
					 * @var array
3299
					 */
3300
					public $plugin_names = array();
3301
3302
					/**
3303
					 * Integer to use for iteration through each plugin installation.
3304
					 *
3305
					 * @since 2.2.0
3306
					 *
3307
					 * @var integer
3308
					 */
3309
					public $i = 0;
3310
3311
					/**
3312
					 * TGMPA instance
3313
					 *
3314
					 * @since 2.5.0
3315
					 *
3316
					 * @var object
3317
					 */
3318
					protected $tgmpa;
3319
3320
					/**
3321
					 * Constructor. Parses default args with new ones and extracts them for use.
3322
					 *
3323
					 * @since 2.2.0
3324
					 *
3325
					 * @param array $args Arguments to pass for use within the class.
3326
					 */
3327
					public function __construct( $args = array() ) {
3328
						// Get TGMPA class instance.
3329
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3330
3331
						// Parse default and new args.
3332
						$defaults = array(
3333
							'url'          => '',
3334
							'nonce'        => '',
3335
							'names'        => array(),
3336
							'install_type' => 'install',
3337
						);
3338
						$args     = wp_parse_args( $args, $defaults );
3339
3340
						// Set plugin names to $this->plugin_names property.
3341
						$this->plugin_names = $args['names'];
3342
3343
						// Extract the new args.
3344
						parent::__construct( $args );
3345
					}
3346
3347
					/**
3348
					 * Sets install skin strings for each individual plugin.
3349
					 *
3350
					 * Checks to see if the automatic activation flag is set and uses the
3351
					 * the proper strings accordingly.
3352
					 *
3353
					 * @since 2.2.0
3354
					 */
3355
					public function add_strings() {
3356
						if ( 'update' === $this->options['install_type'] ) {
3357
							parent::add_strings();
3358
							$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3359
						} else {
3360
							$this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
3361
							$this->upgrader->strings['skin_update_failed']       = __( 'The installation of %1$s failed.', 'tgmpa' );
3362
3363
							if ( $this->tgmpa->is_automatic ) {
3364
								// Automatic activation strings.
3365
								$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' );
3366
								$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>';
3367
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations and activations have been completed.', 'tgmpa' );
3368
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3369
							} else {
3370
								// Default installation strings.
3371
								$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' );
3372
								$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>';
3373
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations have been completed.', 'tgmpa' );
3374
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3375
							}
3376
						}
3377
					}
3378
3379
					/**
3380
					 * Outputs the header strings and necessary JS before each plugin installation.
3381
					 *
3382
					 * @since 2.2.0
3383
					 *
3384
					 * @param string $title Unused in this implementation.
3385
					 */
3386
					public function before( $title = '' ) {
3387
						if ( empty( $title ) ) {
3388
							$title = esc_html( $this->plugin_names[ $this->i ] );
3389
						}
3390
						parent::before( $title );
3391
					}
3392
3393
					/**
3394
					 * Outputs the footer strings and necessary JS after each plugin installation.
3395
					 *
3396
					 * Checks for any errors and outputs them if they exist, else output
3397
					 * success strings.
3398
					 *
3399
					 * @since 2.2.0
3400
					 *
3401
					 * @param string $title Unused in this implementation.
3402
					 */
3403
					public function after( $title = '' ) {
3404
						if ( empty( $title ) ) {
3405
							$title = esc_html( $this->plugin_names[ $this->i ] );
3406
						}
3407
						parent::after( $title );
3408
3409
						$this->i++;
3410
					}
3411
3412
					/**
3413
					 * Outputs links after bulk plugin installation is complete.
3414
					 *
3415
					 * @since 2.2.0
3416
					 */
3417
					public function bulk_footer() {
3418
						// Serve up the string to say installations (and possibly activations) are complete.
3419
						parent::bulk_footer();
3420
3421
						// Flush plugins cache so we can make sure that the installed plugins list is always up to date.
3422
						wp_clean_plugins_cache();
3423
3424
						$this->tgmpa->show_tgmpa_version();
3425
3426
						// Display message based on if all plugins are now active or not.
3427
						$update_actions = array();
3428
3429
						if ( $this->tgmpa->is_tgmpa_complete() ) {
3430
							// All plugins are active, so we display the complete string and hide the menu to protect users.
3431
							echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
3432
							$update_actions['dashboard'] = sprintf(
3433
								esc_html( $this->tgmpa->strings['complete'] ),
3434
								'<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>'
3435
							);
3436
						} else {
3437
							$update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
3438
						}
3439
3440
						/**
3441
						 * Filter the list of action links available following bulk plugin installs/updates.
3442
						 *
3443
						 * @since 2.5.0
3444
						 *
3445
						 * @param array $update_actions Array of plugin action links.
3446
						 * @param array $plugin_info    Array of information for the last-handled plugin.
3447
						 */
3448
						$update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
3449
3450
						if ( ! empty( $update_actions ) ) {
3451
							$this->feedback( implode( ' | ', (array) $update_actions ) );
3452
						}
3453
					}
3454
3455
					/* *********** DEPRECATED METHODS *********** */
3456
3457
					/**
3458
					 * Flush header output buffer.
3459
					 *
3460
					 * @since      2.2.0
3461
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3462
					 * @see        Bulk_Upgrader_Skin::flush_output()
3463
					 */
3464
					public function before_flush_output() {
3465
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3466
						$this->flush_output();
3467
					}
3468
3469
					/**
3470
					 * Flush footer output buffer and iterate $this->i to make sure the
3471
					 * installation strings reference the correct plugin.
3472
					 *
3473
					 * @since      2.2.0
3474
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3475
					 * @see        Bulk_Upgrader_Skin::flush_output()
3476
					 */
3477
					public function after_flush_output() {
3478
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3479
						$this->flush_output();
3480
						$this->i++;
3481
					}
3482
				}
3483
			}
3484
		}
3485
	}
3486
}
3487
3488
if ( ! class_exists( 'TGMPA_Utils' ) ) {
3489
3490
	/**
3491
	 * Generic utilities for TGMPA.
3492
	 *
3493
	 * All methods are static, poor-dev name-spacing class wrapper.
3494
	 *
3495
	 * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
3496
	 *
3497
	 * @since 2.5.0
3498
	 *
3499
	 * @package TGM-Plugin-Activation
3500
	 * @author  Juliette Reinders Folmer
3501
	 */
3502
	class TGMPA_Utils {
3503
		/**
3504
		 * Whether the PHP filter extension is enabled.
3505
		 *
3506
		 * @see http://php.net/book.filter
3507
		 *
3508
		 * @since 2.5.0
3509
		 *
3510
		 * @static
3511
		 *
3512
		 * @var bool $has_filters True is the extension is enabled.
3513
		 */
3514
		public static $has_filters;
3515
3516
		/**
3517
		 * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
3518
		 *
3519
		 * @since 2.5.0
3520
		 *
3521
		 * @static
3522
		 *
3523
		 * @param string $string Text to be wrapped.
3524
		 * @return string
3525
		 */
3526
		public static function wrap_in_em( $string ) {
3527
			return '<em>' . wp_kses_post( $string ) . '</em>';
3528
		}
3529
3530
		/**
3531
		 * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
3532
		 *
3533
		 * @since 2.5.0
3534
		 *
3535
		 * @static
3536
		 *
3537
		 * @param string $string Text to be wrapped.
3538
		 * @return string
3539
		 */
3540
		public static function wrap_in_strong( $string ) {
3541
			return '<strong>' . wp_kses_post( $string ) . '</strong>';
3542
		}
3543
3544
		/**
3545
		 * Helper function: Validate a value as boolean
3546
		 *
3547
		 * @since 2.5.0
3548
		 *
3549
		 * @static
3550
		 *
3551
		 * @param mixed $value Arbitrary value.
3552
		 * @return bool
3553
		 */
3554
		public static function validate_bool( $value ) {
3555
			if ( ! isset( self::$has_filters ) ) {
3556
				self::$has_filters = extension_loaded( 'filter' );
3557
			}
3558
3559
			if ( self::$has_filters ) {
3560
				return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
3561
			} else {
3562
				return self::emulate_filter_bool( $value );
3563
			}
3564
		}
3565
3566
		/**
3567
		 * Helper function: Cast a value to bool
3568
		 *
3569
		 * @since 2.5.0
3570
		 *
3571
		 * @static
3572
		 *
3573
		 * @param mixed $value Value to cast.
3574
		 * @return bool
3575
		 */
3576
		protected static function emulate_filter_bool( $value ) {
3577
			// @codingStandardsIgnoreStart
3578
			static $true  = array(
3579
				'1',
3580
				'true', 'True', 'TRUE',
3581
				'y', 'Y',
3582
				'yes', 'Yes', 'YES',
3583
				'on', 'On', 'ON',
3584
			);
3585
			static $false = array(
3586
				'0',
3587
				'false', 'False', 'FALSE',
3588
				'n', 'N',
3589
				'no', 'No', 'NO',
3590
				'off', 'Off', 'OFF',
3591
			);
3592
			// @codingStandardsIgnoreEnd
3593
3594
			if ( is_bool( $value ) ) {
3595
				return $value;
3596
			} else if ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
3597
				return (bool) $value;
3598
			} else if ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
3599
				return (bool) $value;
3600
			} else if ( is_string( $value ) ) {
3601
				$value = trim( $value );
3602
				if ( in_array( $value, $true, true ) ) {
3603
					return true;
3604
				} else if ( in_array( $value, $false, true ) ) {
3605
					return false;
3606
				} else {
3607
					return false;
3608
				}
3609
			}
3610
3611
			return false;
3612
		}
3613
	} // End of class TGMPA_Utils
3614
} // End of class_exists wrapper
3615