Completed
Pull Request — develop (#522)
by Juliette
06:25 queued 03:44
created

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

Upgrade to new PHP Analysis Engine

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

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