Completed
Pull Request — develop (#754)
by
unknown
10:52
created

does_plugin_require_update()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

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

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
657
				$body_id = 'plugin-information'; // WPCS: override ok, prefix ok.
658
				$tab     = 'plugin-information'; // WPCS: override ok.
659
660
				install_plugin_information();
661
662
				exit;
663
			}
664
		}
665
666
		/**
667
		 * Enqueue thickbox scripts/styles for plugin info.
668
		 *
669
		 * Thickbox is not automatically included on all admin pages, so we must
670
		 * manually enqueue it for those pages.
671
		 *
672
		 * Thickbox is only loaded if the user has not dismissed the admin
673
		 * notice or if there are any plugins left to install and activate.
674
		 *
675
		 * @since 2.1.0
676
		 */
677
		public function thickbox() {
678
			if ( ! get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) ) {
679
				add_thickbox();
680
			}
681
		}
682
683
		/**
684
		 * Adds submenu page if there are plugin actions to take.
685
		 *
686
		 * This method adds the submenu page letting users know that a required
687
		 * plugin needs to be installed.
688
		 *
689
		 * This page disappears once the plugin has been installed and activated.
690
		 *
691
		 * @since 1.0.0
692
		 *
693
		 * @see TGM_Plugin_Activation::init()
694
		 * @see TGM_Plugin_Activation::install_plugins_page()
695
		 *
696
		 * @return null Return early if user lacks capability to install a plugin.
697
		 */
698
		public function admin_menu() {
699
			// Make sure privileges are correct to see the page.
700
			if ( ! current_user_can( 'install_plugins' ) ) {
701
				return;
702
			}
703
704
			$args = apply_filters(
705
				'tgmpa_admin_menu_args',
706
				array(
707
					'parent_slug' => $this->parent_slug,                     // Parent Menu slug.
708
					'page_title'  => $this->strings['page_title'],           // Page title.
709
					'menu_title'  => $this->strings['menu_title'],           // Menu title.
710
					'capability'  => $this->capability,                      // Capability.
711
					'menu_slug'   => $this->menu,                            // Menu slug.
712
					'function'    => array( $this, 'install_plugins_page' ), // Callback.
713
				)
714
			);
715
716
			$this->add_admin_menu( $args );
717
		}
718
719
		/**
720
		 * Add the menu item.
721
		 *
722
		 * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
723
		 * generator on the website.}}
724
		 *
725
		 * @since 2.5.0
726
		 *
727
		 * @param array $args Menu item configuration.
728
		 */
729
		protected function add_admin_menu( array $args ) {
730
			if ( has_filter( 'tgmpa_admin_menu_use_add_theme_page' ) ) {
731
				_deprecated_function( 'The "tgmpa_admin_menu_use_add_theme_page" filter', '2.5.0', esc_html__( 'Set the parent_slug config variable instead.', 'tgmpa' ) );
732
			}
733
734
			if ( 'themes.php' === $this->parent_slug ) {
735
				$this->page_hook = call_user_func( 'add_theme_page', $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
736
			} else {
737
				$this->page_hook = call_user_func( 'add_submenu_page', $args['parent_slug'], $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
738
			}
739
		}
740
741
		/**
742
		 * Echoes plugin installation form.
743
		 *
744
		 * This method is the callback for the admin_menu method function.
745
		 * This displays the admin page and form area where the user can select to install and activate the plugin.
746
		 * Aborts early if we're processing a plugin installation action.
747
		 *
748
		 * @since 1.0.0
749
		 *
750
		 * @return null Aborts early if we're processing a plugin installation action.
751
		 */
752
		public function install_plugins_page() {
753
			// Store new instance of plugin table in object.
754
			$plugin_table = new TGMPA_List_Table();
755
756
			// Return early if processing a plugin installation action.
757
			if ( ( ( 'tgmpa-bulk-install' === $plugin_table->current_action() || 'tgmpa-bulk-update' === $plugin_table->current_action() ) && $plugin_table->process_bulk_actions() ) || $this->do_plugin_install() ) {
758
				return;
759
			}
760
761
			// Force refresh of available plugin information so we'll know about manual updates/deletes.
762
			wp_clean_plugins_cache( false );
763
764
			?>
765
			<div class="tgmpa wrap">
766
				<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
767
				<?php $plugin_table->prepare_items(); ?>
768
769
				<?php
770
				if ( ! empty( $this->message ) && is_string( $this->message ) ) {
771
					echo wp_kses_post( $this->message );
772
				}
773
				?>
774
				<?php $plugin_table->views(); ?>
775
776
				<form id="tgmpa-plugins" action="" method="post">
777
					<input type="hidden" name="tgmpa-page" value="<?php echo esc_attr( $this->menu ); ?>" />
778
					<input type="hidden" name="plugin_status" value="<?php echo esc_attr( $plugin_table->view_context ); ?>" />
779
					<?php $plugin_table->display(); ?>
780
				</form>
781
			</div>
782
			<?php
783
		}
784
785
		/**
786
		 * Installs, updates or activates a plugin depending on the action link clicked by the user.
787
		 *
788
		 * Checks the $_GET variable to see which actions have been
789
		 * passed and responds with the appropriate method.
790
		 *
791
		 * Uses WP_Filesystem to process and handle the plugin installation
792
		 * method.
793
		 *
794
		 * @since 1.0.0
795
		 *
796
		 * @uses WP_Filesystem
797
		 * @uses WP_Error
798
		 * @uses WP_Upgrader
799
		 * @uses Plugin_Upgrader
800
		 * @uses Plugin_Installer_Skin
801
		 * @uses Plugin_Upgrader_Skin
802
		 *
803
		 * @return boolean True on success, false on failure.
804
		 */
805
		protected function do_plugin_install() {
0 ignored issues
show
Coding Style introduced by
function do_plugin_install() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
806
			if ( empty( $_GET['plugin'] ) ) {
807
				return false;
808
			}
809
810
			// All plugin information will be stored in an array for processing.
811
			$slug = $this->sanitize_key( urldecode( $_GET['plugin'] ) );
812
813
			if ( ! isset( $this->plugins[ $slug ] ) ) {
814
				return false;
815
			}
816
817
			// Was an install or upgrade action link clicked?
818
			if ( ( isset( $_GET['tgmpa-install'] ) && 'install-plugin' === $_GET['tgmpa-install'] ) || ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) ) {
819
820
				$install_type = 'install';
821
				if ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) {
822
					$install_type = 'update';
823
				}
824
825
				check_admin_referer( 'tgmpa-' . $install_type, 'tgmpa-nonce' );
826
827
				// Pass necessary information via URL if WP_Filesystem is needed.
828
				$url = wp_nonce_url(
829
					add_query_arg(
830
						array(
831
							'plugin'                 => urlencode( $slug ),
832
							'tgmpa-' . $install_type => $install_type . '-plugin',
833
						),
834
						$this->get_tgmpa_url()
835
					),
836
					'tgmpa-' . $install_type,
837
					'tgmpa-nonce'
838
				);
839
840
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
841
842
				$creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, array() );
843
				if ( false === $creds ) {
844
					return true;
845
				}
846
847 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

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

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

Loading history...
848
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem.
849
					return true;
850
				}
851
852
				/* If we arrive here, we have the filesystem. */
853
854
				// Prep variables for Plugin_Installer_Skin class.
855
				$extra         = array();
856
				$extra['slug'] = $slug; // Needed for potentially renaming of directory name.
857
				$source        = $this->get_download_url( $slug );
858
				$api           = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null;
859
				$api           = ( false !== $api ) ? $api : null;
860
861
				$url = add_query_arg(
862
					array(
863
						'action' => $install_type . '-plugin',
864
						'plugin' => urlencode( $slug ),
865
					),
866
					'update.php'
867
				);
868
869
				if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
870
					require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
871
				}
872
873
				$title     = ( 'update' === $install_type ) ? $this->strings['updating'] : $this->strings['installing'];
874
				$skin_args = array(
875
					'type'   => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload',
876
					'title'  => sprintf( $title, $this->plugins[ $slug ]['name'] ),
877
					'url'    => esc_url_raw( $url ),
878
					'nonce'  => $install_type . '-plugin_' . $slug,
879
					'plugin' => '',
880
					'api'    => $api,
881
					'extra'  => $extra,
882
				);
883
				unset( $title );
884
885
				if ( 'update' === $install_type ) {
886
					$skin_args['plugin'] = $this->plugins[ $slug ]['file_path'];
887
					$skin                = new Plugin_Upgrader_Skin( $skin_args );
888
				} else {
889
					$skin = new Plugin_Installer_Skin( $skin_args );
890
				}
891
892
				// Create a new instance of Plugin_Upgrader.
893
				$upgrader = new Plugin_Upgrader( $skin );
894
895
				// Perform the action and install the plugin from the $source urldecode().
896
				add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
897
898
				if ( 'update' === $install_type ) {
899
					// Inject our info into the update transient.
900
					$to_inject                    = array(
901
						$slug => $this->plugins[ $slug ],
902
					);
903
					$to_inject[ $slug ]['source'] = $source;
904
					$this->inject_update_info( $to_inject );
905
906
					$upgrader->upgrade( $this->plugins[ $slug ]['file_path'] );
907
				} else {
908
					$upgrader->install( $source );
909
				}
910
911
				remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1 );
912
913
				// Make sure we have the correct file path now the plugin is installed/updated.
914
				$this->populate_file_path( $slug );
915
916
				// Only activate plugins if the config option is set to true and the plugin isn't
917
				// already active (upgrade).
918
				if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) {
919
					$plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method.
920
					if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) {
921
						return true; // Finish execution of the function early as we encountered an error.
922
					}
923
				}
924
925
				$this->show_tgmpa_version();
926
927
				// Display message based on if all plugins are now active or not.
928
				if ( $this->is_tgmpa_complete() ) {
929
					echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html( $this->strings['dashboard'] ) . '</a>' ), '</p>';
930
					echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
931
				} else {
932
					echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
933
				}
934
935
				return true;
936
			} elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) {
937
				// Activate action link was clicked.
938
				check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' );
939
940
				if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) {
941
					return true; // Finish execution of the function early as we encountered an error.
942
				}
943
			}
944
945
			return false;
946
		}
947
948
		/**
949
		 * Inject information into the 'update_plugins' site transient as WP checks that before running an update.
950
		 *
951
		 * @since 2.5.0
952
		 *
953
		 * @param array $plugins The plugin information for the plugins which are to be updated.
954
		 */
955
		public function inject_update_info( $plugins ) {
956
			$repo_updates = get_site_transient( 'update_plugins' );
957
958
			if ( ! is_object( $repo_updates ) ) {
959
				$repo_updates = new stdClass();
960
			}
961
962
			foreach ( $plugins as $slug => $plugin ) {
963
				$file_path = $plugin['file_path'];
964
965
				if ( empty( $repo_updates->response[ $file_path ] ) ) {
966
					$repo_updates->response[ $file_path ] = new stdClass();
967
				}
968
969
				// We only really need to set package, but let's do all we can in case WP changes something.
970
				$repo_updates->response[ $file_path ]->slug        = $slug;
971
				$repo_updates->response[ $file_path ]->plugin      = $file_path;
972
				$repo_updates->response[ $file_path ]->new_version = $plugin['version'];
973
				$repo_updates->response[ $file_path ]->package     = $plugin['source'];
974
				if ( empty( $repo_updates->response[ $file_path ]->url ) && ! empty( $plugin['external_url'] ) ) {
975
					$repo_updates->response[ $file_path ]->url = $plugin['external_url'];
976
				}
977
			}
978
979
			set_site_transient( 'update_plugins', $repo_updates );
980
		}
981
982
		/**
983
		 * Adjust the plugin directory name if necessary.
984
		 *
985
		 * The final destination directory of a plugin is based on the subdirectory name found in the
986
		 * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this
987
		 * subdirectory name is not the same as the expected slug and the plugin will not be recognized
988
		 * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to
989
		 * the expected plugin slug.
990
		 *
991
		 * @since 2.5.0
992
		 *
993
		 * @param string       $source        Path to upgrade/zip-file-name.tmp/subdirectory/.
994
		 * @param string       $remote_source Path to upgrade/zip-file-name.tmp.
995
		 * @param \WP_Upgrader $upgrader      Instance of the upgrader which installs the plugin.
996
		 * @return string $source
997
		 */
998
		public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
999
			if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) {
1000
				return $source;
1001
			}
1002
1003
			// Check for single file plugins.
1004
			$source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) );
1005
			if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) {
1006
				return $source;
1007
			}
1008
1009
			// Multi-file plugin, let's see if the directory is correctly named.
1010
			$desired_slug = '';
1011
1012
			// Figure out what the slug is supposed to be.
1013
			if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) {
1014
				$desired_slug = $upgrader->skin->options['extra']['slug'];
1015
			} else {
1016
				// Bulk installer contains less info, so fall back on the info registered here.
1017
				foreach ( $this->plugins as $slug => $plugin ) {
1018
					if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) {
1019
						$desired_slug = $slug;
1020
						break;
1021
					}
1022
				}
1023
				unset( $slug, $plugin );
1024
			}
1025
1026
			if ( ! empty( $desired_slug ) ) {
1027
				$subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
1028
1029
				if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
1030
					$from_path = untrailingslashit( $source );
1031
					$to_path   = trailingslashit( $remote_source ) . $desired_slug;
1032
1033
					if ( true === $GLOBALS['wp_filesystem']->move( $from_path, $to_path ) ) {
1034
						return trailingslashit( $to_path );
1035 View Code Duplication
					} else {
1036
						return new WP_Error(
1037
							'rename_failed',
1038
							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' ),
1039
							array(
1040
								'found'    => $subdir_name,
1041
								'expected' => $desired_slug,
1042
							)
1043
						);
1044
					}
1045 View Code Duplication
				} elseif ( empty( $subdir_name ) ) {
1046
					return new WP_Error(
1047
						'packaged_wrong',
1048
						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' ),
1049
						array(
1050
							'found'    => $subdir_name,
1051
							'expected' => $desired_slug,
1052
						)
1053
					);
1054
				}
1055
			}
1056
1057
			return $source;
1058
		}
1059
1060
		/**
1061
		 * Activate a single plugin and send feedback about the result to the screen.
1062
		 *
1063
		 * @since 2.5.0
1064
		 *
1065
		 * @param string $file_path Path within wp-plugins/ to main plugin file.
1066
		 * @param string $slug      Plugin slug.
1067
		 * @param bool   $automatic Whether this is an automatic activation after an install. Defaults to false.
1068
		 *                          This determines the styling of the output messages.
1069
		 * @return bool False if an error was encountered, true otherwise.
1070
		 */
1071
		protected function activate_single_plugin( $file_path, $slug, $automatic = false ) {
0 ignored issues
show
Coding Style introduced by
function activate_single_plugin() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
1072
			if ( $this->can_plugin_activate( $slug ) ) {
1073
				$activate = activate_plugin( $file_path );
1074
1075
				if ( is_wp_error( $activate ) ) {
1076
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>',
1077
						'<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
1078
1079
					return false; // End it here if there is an error with activation.
1080
				} else {
1081
					if ( ! $automatic ) {
1082
						// Make sure message doesn't display again if bulk activation is performed
1083
						// immediately after a single activation.
1084
						if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1085
							echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>';
1086
						}
1087
					} else {
1088
						// Simpler message layout for use on the plugin install page.
1089
						echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>';
1090
					}
1091
				}
1092 View Code Duplication
			} elseif ( $this->is_plugin_active( $slug ) ) {
1093
				// No simpler message format provided as this message should never be encountered
1094
				// on the plugin install page.
1095
				echo '<div id="message" class="error"><p>',
1096
					sprintf(
1097
						esc_html( $this->strings['plugin_already_active'] ),
1098
						'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1099
					),
1100
					'</p></div>';
1101
			} elseif ( $this->does_plugin_require_update( $slug ) ) {
1102
				if ( ! $automatic ) {
1103
					// Make sure message doesn't display again if bulk activation is performed
1104
					// immediately after a single activation.
1105 View Code Duplication
					if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1106
						echo '<div id="message" class="error"><p>',
1107
							sprintf(
1108
								esc_html( $this->strings['plugin_needs_higher_version'] ),
1109
								'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1110
							),
1111
							'</p></div>';
1112
					}
1113
				} else {
1114
					// Simpler message layout for use on the plugin install page.
1115
					echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>';
1116
				}
1117
			}
1118
1119
			return true;
1120
		}
1121
1122
		/**
1123
		 * Echoes required plugin notice.
1124
		 *
1125
		 * Outputs a message telling users that a specific plugin is required for
1126
		 * their theme. If appropriate, it includes a link to the form page where
1127
		 * users can install and activate the plugin.
1128
		 *
1129
		 * Returns early if we're on the Install page.
1130
		 *
1131
		 * @since 1.0.0
1132
		 *
1133
		 * @global object $current_screen
1134
		 *
1135
		 * @return null Returns early if we're on the Install page.
1136
		 */
1137
		public function notices() {
1138
			// Remove nag on the install page / Return early if the nag message has been dismissed or user < author.
1139
			if ( ( $this->is_tgmpa_page() || $this->is_core_update_page() ) || get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) || ! current_user_can( apply_filters( 'tgmpa_show_admin_notice_capability', 'publish_posts' ) ) ) {
1140
				return;
1141
			}
1142
1143
			// Store for the plugin slugs by message type.
1144
			$message = array();
1145
1146
			// Initialize counters used to determine plurality of action link texts.
1147
			$install_link_count          = 0;
1148
			$update_link_count           = 0;
1149
			$activate_link_count         = 0;
1150
			$total_required_action_count = 0;
1151
1152
			foreach ( $this->plugins as $slug => $plugin ) {
1153
				if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) {
1154
					continue;
1155
				}
1156
1157
				if ( ! $this->is_plugin_installed( $slug ) ) {
1158
					if ( current_user_can( 'install_plugins' ) ) {
1159
						$install_link_count++;
1160
1161
						if ( true === $plugin['required'] ) {
1162
							$message['notice_can_install_required'][] = $slug;
1163
						} else {
1164
							$message['notice_can_install_recommended'][] = $slug;
1165
						}
1166
					}
1167
					if ( true === $plugin['required'] ) {
1168
						$total_required_action_count++;
1169
					}
1170
				} else {
1171
					if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) {
1172
						if ( current_user_can( 'activate_plugins' ) ) {
1173
							$activate_link_count++;
1174
1175
							if ( true === $plugin['required'] ) {
1176
								$message['notice_can_activate_required'][] = $slug;
1177
							} else {
1178
								$message['notice_can_activate_recommended'][] = $slug;
1179
							}
1180
						}
1181
						if ( true === $plugin['required'] ) {
1182
							$total_required_action_count++;
1183
						}
1184
					}
1185
1186
					if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1187
1188
						if ( current_user_can( 'update_plugins' ) ) {
1189
							$update_link_count++;
1190
1191
							if ( $this->does_plugin_require_update( $slug ) ) {
1192
								$message['notice_ask_to_update'][] = $slug;
1193
							} elseif ( false !== $this->does_plugin_have_update( $slug ) ) {
1194
								$message['notice_ask_to_update_maybe'][] = $slug;
1195
							}
1196
						}
1197
						if ( true === $plugin['required'] ) {
1198
							$total_required_action_count++;
1199
						}
1200
					}
1201
				}
1202
			}
1203
			unset( $slug, $plugin );
1204
1205
			// If we have notices to display, we move forward.
1206
			if ( ! empty( $message ) || $total_required_action_count > 0 ) {
1207
				krsort( $message ); // Sort messages.
1208
				$rendered = '';
1209
1210
				// As add_settings_error() wraps the final message in a <p> and as the final message can't be
1211
				// filtered, using <p>'s in our html would render invalid html output.
1212
				$line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n";
1213
1214
				if ( ! current_user_can( 'activate_plugins' ) && ! current_user_can( 'install_plugins' ) && ! current_user_can( 'update_plugins' ) ) {
1215
					$rendered  = esc_html( $this->strings['notice_cannot_install_activate'] ) . ' ' . esc_html( $this->strings['contact_admin'] );
1216
					$rendered .= $this->create_user_action_links_for_notice( 0, 0, 0, $line_template );
1217
				} else {
1218
1219
					// If dismissable is false and a message is set, output it now.
1220
					if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) {
1221
						$rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) );
1222
					}
1223
1224
					// Render the individual message lines for the notice.
1225
					foreach ( $message as $type => $plugin_group ) {
1226
						$linked_plugins = array();
1227
1228
						// Get the external info link for a plugin if one is available.
1229
						foreach ( $plugin_group as $plugin_slug ) {
1230
							$linked_plugins[] = $this->get_info_link( $plugin_slug );
1231
						}
1232
						unset( $plugin_slug );
1233
1234
						$count          = count( $plugin_group );
1235
						$linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins );
1236
						$last_plugin    = array_pop( $linked_plugins ); // Pop off last name to prep for readability.
1237
						$imploded       = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
1238
1239
						$rendered .= sprintf(
1240
							$line_template,
1241
							sprintf(
1242
								translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ),
1243
								$imploded,
1244
								$count
1245
							)
1246
						);
1247
1248
					}
1249
					unset( $type, $plugin_group, $linked_plugins, $count, $last_plugin, $imploded );
1250
1251
					$rendered .= $this->create_user_action_links_for_notice( $install_link_count, $update_link_count, $activate_link_count, $line_template );
1252
				}
1253
1254
				// Register the nag messages and prepare them to be processed.
1255
				add_settings_error( 'tgmpa', 'tgmpa', $rendered, $this->get_admin_notice_class() );
1256
			}
1257
1258
			// Admin options pages already output settings_errors, so this is to avoid duplication.
1259
			if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) {
1260
				$this->display_settings_errors();
1261
			}
1262
		}
1263
1264
		/**
1265
		 * Generate the user action links for the admin notice.
1266
		 *
1267
		 * @since 2.6.0
1268
		 *
1269
		 * @param int $install_count  Number of plugins to install.
1270
		 * @param int $update_count   Number of plugins to update.
1271
		 * @param int $activate_count Number of plugins to activate.
1272
		 * @param int $line_template  Template for the HTML tag to output a line.
1273
		 * @return string Action links.
1274
		 */
1275
		protected function create_user_action_links_for_notice( $install_count, $update_count, $activate_count, $line_template ) {
1276
			// Setup action links.
1277
			$action_links = array(
1278
				'install'  => '',
1279
				'update'   => '',
1280
				'activate' => '',
1281
				'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>' : '',
1282
			);
1283
1284
			$link_template = '<a href="%2$s">%1$s</a>';
1285
1286
			if ( current_user_can( 'install_plugins' ) ) {
1287
				if ( $install_count > 0 ) {
1288
					$action_links['install'] = sprintf(
1289
						$link_template,
1290
						translate_nooped_plural( $this->strings['install_link'], $install_count, 'tgmpa' ),
1291
						esc_url( $this->get_tgmpa_status_url( 'install' ) )
1292
					);
1293
				}
1294
				if ( $update_count > 0 ) {
1295
					$action_links['update'] = sprintf(
1296
						$link_template,
1297
						translate_nooped_plural( $this->strings['update_link'], $update_count, 'tgmpa' ),
1298
						esc_url( $this->get_tgmpa_status_url( 'update' ) )
1299
					);
1300
				}
1301
			}
1302
1303
			if ( current_user_can( 'activate_plugins' ) && $activate_count > 0 ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

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

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

Loading history...
1304
				$action_links['activate'] = sprintf(
1305
					$link_template,
1306
					translate_nooped_plural( $this->strings['activate_link'], $activate_count, 'tgmpa' ),
1307
					esc_url( $this->get_tgmpa_status_url( 'activate' ) )
1308
				);
1309
			}
1310
1311
			$action_links = apply_filters( 'tgmpa_notice_action_links', $action_links );
1312
1313
			$action_links = array_filter( (array) $action_links ); // Remove any empty array items.
1314
1315
			if ( ! empty( $action_links ) ) {
1316
				$action_links = sprintf( $line_template, implode( ' | ', $action_links ) );
1317
				return apply_filters( 'tgmpa_notice_rendered_action_links', $action_links );
1318
			} else {
1319
				return '';
1320
			}
1321
		}
1322
1323
		/**
1324
		 * Get admin notice class.
1325
		 *
1326
		 * Work around all the changes to the various admin notice classes between WP 4.4 and 3.7
1327
		 * (lowest supported version by TGMPA).
1328
		 *
1329
		 * @since 2.6.0
1330
		 *
1331
		 * @return string
1332
		 */
1333
		protected function get_admin_notice_class() {
1334
			if ( ! empty( $this->strings['nag_type'] ) ) {
1335
				return sanitize_html_class( strtolower( $this->strings['nag_type'] ) );
1336
			} else {
1337
				if ( version_compare( $this->wp_version, '4.2', '>=' ) ) {
1338
					return 'notice-warning';
1339
				} elseif ( version_compare( $this->wp_version, '4.1', '>=' ) ) {
1340
					return 'notice';
1341
				} else {
1342
					return 'updated';
1343
				}
1344
			}
1345
		}
1346
1347
		/**
1348
		 * Display settings errors and remove those which have been displayed to avoid duplicate messages showing
1349
		 *
1350
		 * @since 2.5.0
1351
		 */
1352
		protected function display_settings_errors() {
1353
			global $wp_settings_errors;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
1354
1355
			settings_errors( 'tgmpa' );
1356
1357
			foreach ( (array) $wp_settings_errors as $key => $details ) {
1358
				if ( 'tgmpa' === $details['setting'] ) {
1359
					unset( $wp_settings_errors[ $key ] );
1360
					break;
1361
				}
1362
			}
1363
		}
1364
1365
		/**
1366
		 * Register dismissal of admin notices.
1367
		 *
1368
		 * Acts on the dismiss link in the admin nag messages.
1369
		 * If clicked, the admin notice disappears and will no longer be visible to this user.
1370
		 *
1371
		 * @since 2.1.0
1372
		 */
1373
		public function dismiss() {
1374
			if ( isset( $_GET['tgmpa-dismiss'] ) && check_admin_referer( 'tgmpa-dismiss-' . get_current_user_id() ) ) {
1375
				update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
1376
			}
1377
		}
1378
1379
		/**
1380
		 * Add individual plugin to our collection of plugins.
1381
		 *
1382
		 * If the required keys are not set or the plugin has already
1383
		 * been registered, the plugin is not added.
1384
		 *
1385
		 * @since 2.0.0
1386
		 *
1387
		 * @param array|null $plugin Array of plugin arguments or null if invalid argument.
1388
		 * @return null Return early if incorrect argument.
1389
		 */
1390
		public function register( $plugin ) {
1391
			if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
1392
				return;
1393
			}
1394
1395
			if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
1396
				return;
1397
			}
1398
1399
			$defaults = array(
1400
				'name'               => '',      // String.
1401
				'slug'               => '',      // String.
1402
				'source'             => 'repo',  // String.
1403
				'required'           => false,   // Boolean.
1404
				'version'            => '',      // String.
1405
				'force_activation'   => false,   // Boolean.
1406
				'force_deactivation' => false,   // Boolean.
1407
				'external_url'       => '',      // String.
1408
				'is_callable'        => '',      // String|Array.
1409
				'class_exists'       => '',      // String.
1410
				'is_defined'         => '',      // String.
1411
			);
1412
1413
			// Prepare the received data.
1414
			$plugin = wp_parse_args( $plugin, $defaults );
1415
1416
			// Standardize the received slug.
1417
			$plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
1418
1419
			// Forgive users for using string versions of booleans or floats for version number.
1420
			$plugin['version']            = (string) $plugin['version'];
1421
			$plugin['source']             = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
1422
			$plugin['required']           = TGMPA_Utils::validate_bool( $plugin['required'] );
1423
			$plugin['force_activation']   = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
1424
			$plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
1425
1426
			// Enrich the received data.
1427
			$plugin['file_path']   = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
1428
			$plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
1429
1430
			// Set the class properties.
1431
			$this->plugins[ $plugin['slug'] ]    = $plugin;
1432
			$this->sort_order[ $plugin['slug'] ] = $plugin['name'];
1433
1434
			// Should we add the force activation hook ?
1435
			if ( true === $plugin['force_activation'] ) {
1436
				$this->has_forced_activation = true;
1437
			}
1438
1439
			// Should we add the force deactivation hook ?
1440
			if ( true === $plugin['force_deactivation'] ) {
1441
				$this->has_forced_deactivation = true;
1442
			}
1443
		}
1444
1445
		/**
1446
		 * Determine what type of source the plugin comes from.
1447
		 *
1448
		 * @since 2.5.0
1449
		 *
1450
		 * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
1451
		 *                       (= bundled) or an external URL.
1452
		 * @return string 'repo', 'external', or 'bundled'
1453
		 */
1454
		protected function get_plugin_source_type( $source ) {
1455
			if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
1456
				return 'repo';
1457
			} elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
1458
				return 'external';
1459
			} else {
1460
				return 'bundled';
1461
			}
1462
		}
1463
1464
		/**
1465
		 * Sanitizes a string key.
1466
		 *
1467
		 * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
1468
		 * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
1469
		 * characters in the plugin directory path/slug. Silly them.
1470
		 *
1471
		 * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
1472
		 *
1473
		 * @since 2.5.0
1474
		 *
1475
		 * @param string $key String key.
1476
		 * @return string Sanitized key
1477
		 */
1478
		public function sanitize_key( $key ) {
1479
			$raw_key = $key;
1480
			$key     = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
1481
1482
			/**
1483
			 * Filter a sanitized key string.
1484
			 *
1485
			 * @since 2.5.0
1486
			 *
1487
			 * @param string $key     Sanitized key.
1488
			 * @param string $raw_key The key prior to sanitization.
1489
			 */
1490
			return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
1491
		}
1492
1493
		/**
1494
		 * Amend default configuration settings.
1495
		 *
1496
		 * @since 2.0.0
1497
		 *
1498
		 * @param array $config Array of config options to pass as class properties.
1499
		 */
1500
		public function config( $config ) {
1501
			$keys = array(
1502
				'id',
1503
				'default_path',
1504
				'has_notices',
1505
				'dismissable',
1506
				'dismiss_msg',
1507
				'menu',
1508
				'parent_slug',
1509
				'capability',
1510
				'is_automatic',
1511
				'message',
1512
				'strings',
1513
			);
1514
1515
			foreach ( $keys as $key ) {
1516
				if ( isset( $config[ $key ] ) ) {
1517
					if ( is_array( $config[ $key ] ) ) {
1518
						$this->$key = array_merge( $this->$key, $config[ $key ] );
1519
					} else {
1520
						$this->$key = $config[ $key ];
1521
					}
1522
				}
1523
			}
1524
		}
1525
1526
		/**
1527
		 * Amend action link after plugin installation.
1528
		 *
1529
		 * @since 2.0.0
1530
		 *
1531
		 * @param array $install_actions Existing array of actions.
1532
		 * @return false|array Amended array of actions.
1533
		 */
1534
		public function actions( $install_actions ) {
1535
			// Remove action links on the TGMPA install page.
1536
			if ( $this->is_tgmpa_page() ) {
1537
				return false;
1538
			}
1539
1540
			return $install_actions;
1541
		}
1542
1543
		/**
1544
		 * Flushes the plugins cache on theme switch to prevent stale entries
1545
		 * from remaining in the plugin table.
1546
		 *
1547
		 * @since 2.4.0
1548
		 *
1549
		 * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
1550
		 *                                 Parameter added in v2.5.0.
1551
		 */
1552
		public function flush_plugins_cache( $clear_update_cache = true ) {
1553
			wp_clean_plugins_cache( $clear_update_cache );
1554
		}
1555
1556
		/**
1557
		 * Set file_path key for each installed plugin.
1558
		 *
1559
		 * @since 2.1.0
1560
		 *
1561
		 * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
1562
		 *                            Parameter added in v2.5.0.
1563
		 */
1564
		public function populate_file_path( $plugin_slug = '' ) {
1565
			if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
1566
				$this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
1567
			} else {
1568
				// Add file_path key for all plugins.
1569
				foreach ( $this->plugins as $slug => $values ) {
1570
					$this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
1571
				}
1572
			}
1573
		}
1574
1575
		/**
1576
		 * Helper function to extract the file path of the plugin file from the
1577
		 * plugin slug, if the plugin is installed.
1578
		 *
1579
		 * @since 2.0.0
1580
		 *
1581
		 * @param string $slug Plugin slug (typically folder name) as provided by the developer.
1582
		 * @return string Either file path for plugin if installed, or just the plugin slug.
1583
		 */
1584
		protected function _get_plugin_basename_from_slug( $slug ) {
0 ignored issues
show
Coding Style introduced by
function _get_plugin_basename_from_slug() does not seem to conform to the naming convention (^(?:[a-z]|__)[a-z_0-9]*$).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
1585
			$keys = array_keys( $this->get_plugins() );
1586
1587
			foreach ( $keys as $key ) {
1588
				if ( preg_match( '|^' . $slug . '/|', $key ) ) {
1589
					return $key;
1590
				}
1591
			}
1592
1593
			return $slug;
1594
		}
1595
1596
		/**
1597
		 * Retrieve plugin data, given the plugin name.
1598
		 *
1599
		 * Loops through the registered plugins looking for $name. If it finds it,
1600
		 * it returns the $data from that plugin. Otherwise, returns false.
1601
		 *
1602
		 * @since 2.1.0
1603
		 *
1604
		 * @param string $name Name of the plugin, as it was registered.
1605
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
1606
		 * @return string|boolean Plugin slug if found, false otherwise.
1607
		 */
1608
		public function _get_plugin_data_from_name( $name, $data = 'slug' ) {
0 ignored issues
show
Coding Style introduced by
function _get_plugin_data_from_name() does not seem to conform to the naming convention (^(?:[a-z]|__)[a-z_0-9]*$).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
1609
			foreach ( $this->plugins as $values ) {
1610
				if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
1611
					return $values[ $data ];
1612
				}
1613
			}
1614
1615
			return false;
1616
		}
1617
1618
		/**
1619
		 * Retrieve the download URL for a package.
1620
		 *
1621
		 * @since 2.5.0
1622
		 *
1623
		 * @param string $slug Plugin slug.
1624
		 * @return string Plugin download URL or path to local file or empty string if undetermined.
1625
		 */
1626
		public function get_download_url( $slug ) {
1627
			$dl_source = '';
1628
1629
			switch ( $this->plugins[ $slug ]['source_type'] ) {
1630
				case 'repo':
1631
					return $this->get_wp_repo_download_url( $slug );
1632
				case 'external':
1633
					return $this->plugins[ $slug ]['source'];
1634
				case 'bundled':
1635
					return $this->default_path . $this->plugins[ $slug ]['source'];
1636
			}
1637
1638
			return $dl_source; // Should never happen.
1639
		}
1640
1641
		/**
1642
		 * Retrieve the download URL for a WP repo package.
1643
		 *
1644
		 * @since 2.5.0
1645
		 *
1646
		 * @param string $slug Plugin slug.
1647
		 * @return string Plugin download URL.
1648
		 */
1649
		protected function get_wp_repo_download_url( $slug ) {
1650
			$source = '';
1651
			$api    = $this->get_plugins_api( $slug );
1652
1653
			if ( false !== $api && isset( $api->download_link ) ) {
1654
				$source = $api->download_link;
1655
			}
1656
1657
			return $source;
1658
		}
1659
1660
		/**
1661
		 * Try to grab information from WordPress API.
1662
		 *
1663
		 * @since 2.5.0
1664
		 *
1665
		 * @param string $slug Plugin slug.
1666
		 * @return object Plugins_api response object on success, WP_Error on failure.
1667
		 */
1668
		protected function get_plugins_api( $slug ) {
1669
			static $api = array(); // Cache received responses.
1670
1671
			if ( ! isset( $api[ $slug ] ) ) {
1672
				if ( ! function_exists( 'plugins_api' ) ) {
1673
					require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
1674
				}
1675
1676
				$response = plugins_api(
1677
					'plugin_information',
1678
					array(
1679
						'slug'   => $slug,
1680
						'fields' => array(
1681
							'sections' => false,
1682
						),
1683
					)
1684
				);
1685
1686
				$api[ $slug ] = false;
1687
1688
				if ( is_wp_error( $response ) ) {
1689
					wp_die( esc_html( $this->strings['oops'] ) );
1690
				} else {
1691
					$api[ $slug ] = $response;
1692
				}
1693
			}
1694
1695
			return $api[ $slug ];
1696
		}
1697
1698
		/**
1699
		 * Retrieve a link to a plugin information page.
1700
		 *
1701
		 * @since 2.5.0
1702
		 *
1703
		 * @param string $slug Plugin slug.
1704
		 * @return string Fully formed html link to a plugin information page if available
1705
		 *                or the plugin name if not.
1706
		 */
1707
		public function get_info_link( $slug ) {
1708
			if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
1709
				$link = sprintf(
1710
					'<a href="%1$s" target="_blank">%2$s</a>',
1711
					esc_url( $this->plugins[ $slug ]['external_url'] ),
1712
					esc_html( $this->plugins[ $slug ]['name'] )
1713
				);
1714
			} elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
1715
				$url = add_query_arg(
1716
					array(
1717
						'tab'       => 'plugin-information',
1718
						'plugin'    => urlencode( $slug ),
1719
						'TB_iframe' => 'true',
1720
						'width'     => '640',
1721
						'height'    => '500',
1722
					),
1723
					self_admin_url( 'plugin-install.php' )
1724
				);
1725
1726
				$link = sprintf(
1727
					'<a href="%1$s" class="thickbox">%2$s</a>',
1728
					esc_url( $url ),
1729
					esc_html( $this->plugins[ $slug ]['name'] )
1730
				);
1731
			} else {
1732
				$link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
1733
			}
1734
1735
			return $link;
1736
		}
1737
1738
		/**
1739
		 * Determine if we're on the TGMPA Install page.
1740
		 *
1741
		 * @since 2.1.0
1742
		 *
1743
		 * @return boolean True when on the TGMPA page, false otherwise.
1744
		 */
1745
		protected function is_tgmpa_page() {
1746
			return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
1747
		}
1748
1749
		/**
1750
		 * Determine if we're on a WP Core installation/upgrade page.
1751
		 *
1752
		 * @since 2.6.0
1753
		 *
1754
		 * @return boolean True when on a WP Core installation/upgrade page, false otherwise.
1755
		 */
1756
		protected function is_core_update_page() {
1757
			// Current screen is not always available, most notably on the customizer screen.
1758
			if ( ! function_exists( 'get_current_screen' ) ) {
1759
				return false;
1760
			}
1761
1762
			$screen = get_current_screen();
1763
1764
			if ( 'update-core' === $screen->base ) {
1765
				// Core update screen.
1766
				return true;
1767
			} elseif ( 'plugins' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
1768
				// Plugins bulk update screen.
1769
				return true;
1770
			} elseif ( 'update' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
1771
				// Individual updates (ajax call).
1772
				return true;
1773
			}
1774
1775
			return false;
1776
		}
1777
1778
		/**
1779
		 * Retrieve the URL to the TGMPA Install page.
1780
		 *
1781
		 * I.e. depending on the config settings passed something along the lines of:
1782
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
1783
		 *
1784
		 * @since 2.5.0
1785
		 *
1786
		 * @return string Properly encoded URL (not escaped).
1787
		 */
1788
		public function get_tgmpa_url() {
1789
			static $url;
1790
1791
			if ( ! isset( $url ) ) {
1792
				$parent = $this->parent_slug;
1793
				if ( false === strpos( $parent, '.php' ) ) {
1794
					$parent = 'admin.php';
1795
				}
1796
				$url = add_query_arg(
1797
					array(
1798
						'page' => urlencode( $this->menu ),
1799
					),
1800
					self_admin_url( $parent )
1801
				);
1802
			}
1803
1804
			return $url;
1805
		}
1806
1807
		/**
1808
		 * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
1809
		 *
1810
		 * I.e. depending on the config settings passed something along the lines of:
1811
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install
1812
		 *
1813
		 * @since 2.5.0
1814
		 *
1815
		 * @param string $status Plugin status - either 'install', 'update' or 'activate'.
1816
		 * @return string Properly encoded URL (not escaped).
1817
		 */
1818
		public function get_tgmpa_status_url( $status ) {
1819
			return add_query_arg(
1820
				array(
1821
					'plugin_status' => urlencode( $status ),
1822
				),
1823
				$this->get_tgmpa_url()
1824
			);
1825
		}
1826
1827
		/**
1828
		 * Determine whether there are open actions for plugins registered with TGMPA.
1829
		 *
1830
		 * @since 2.5.0
1831
		 *
1832
		 * @return bool True if complete, i.e. no outstanding actions. False otherwise.
1833
		 */
1834
		public function is_tgmpa_complete() {
1835
			$complete = true;
1836
			foreach ( $this->plugins as $slug => $plugin ) {
1837
				if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1838
					$complete = false;
1839
					break;
1840
				}
1841
			}
1842
1843
			return $complete;
1844
		}
1845
1846
		/**
1847
		 * Check if a plugin is installed. Does not take must-use plugins into account.
1848
		 *
1849
		 * @since 2.5.0
1850
		 *
1851
		 * @param string $slug Plugin slug.
1852
		 * @return bool True if installed, false otherwise.
1853
		 */
1854
		public function is_plugin_installed( $slug ) {
1855
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1856
1857
			return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
1858
		}
1859
1860
		/**
1861
		 * Check if a plugin is active.
1862
		 *
1863
		 * @since 2.5.0
1864
		 *
1865
		 * @param string $slug Plugin slug.
1866
		 * @return bool True if active, false otherwise.
1867
		 */
1868
		public function is_plugin_active( $slug ) {
1869
			return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) )
1870
				|| ( ! empty( $this->plugins[ $slug ]['class_exists'] ) && class_exists( $this->plugins[ $slug ]['class_exists'] ) )
1871
				|| ( ! empty( $this->plugins[ $slug ]['is_defined'] ) && defined( $this->plugins[ $slug ]['is_defined'] ) )
1872
				|| is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
1873
		}
1874
1875
		/**
1876
		 * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
1877
		 * available, check whether the current install meets them.
1878
		 *
1879
		 * @since 2.5.0
1880
		 *
1881
		 * @param string $slug Plugin slug.
1882
		 * @return bool True if OK to update, false otherwise.
1883
		 */
1884
		public function can_plugin_update( $slug ) {
0 ignored issues
show
Coding Style introduced by
function can_plugin_update() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
1885
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1886
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1887
				return true;
1888
			}
1889
1890
			$api = $this->get_plugins_api( $slug );
1891
1892
			if ( false !== $api && isset( $api->requires ) ) {
1893
				return version_compare( $this->wp_version, $api->requires, '>=' );
1894
			}
1895
1896
			// No usable info received from the plugins API, presume we can update.
1897
			return true;
1898
		}
1899
1900
		/**
1901
		 * Check to see if the plugin is 'updatetable', i.e. installed, with an update available
1902
		 * and no WP version requirements blocking it.
1903
		 *
1904
		 * @since 2.6.0
1905
		 *
1906
		 * @param string $slug Plugin slug.
1907
		 * @return bool True if OK to proceed with update, false otherwise.
1908
		 */
1909
		public function is_plugin_updatetable( $slug ) {
1910
			if ( ! $this->is_plugin_installed( $slug ) ) {
1911
				return false;
1912
			} else {
1913
				return ( false !== $this->does_plugin_have_update( $slug ) && $this->can_plugin_update( $slug ) );
1914
			}
1915
		}
1916
1917
		/**
1918
		 * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
1919
		 * plugin version requirements set in TGMPA (if any).
1920
		 *
1921
		 * @since 2.5.0
1922
		 *
1923
		 * @param string $slug Plugin slug.
1924
		 * @return bool True if OK to activate, false otherwise.
1925
		 */
1926
		public function can_plugin_activate( $slug ) {
0 ignored issues
show
Coding Style introduced by
function can_plugin_activate() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
1927
			return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
1928
		}
1929
1930
		/**
1931
		 * Retrieve the version number of an installed plugin.
1932
		 *
1933
		 * @since 2.5.0
1934
		 *
1935
		 * @param string $slug Plugin slug.
1936
		 * @return string Version number as string or an empty string if the plugin is not installed
1937
		 *                or version unknown (plugins which don't comply with the plugin header standard).
1938
		 */
1939
		public function get_installed_version( $slug ) {
1940
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1941
1942
			if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
1943
				return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
1944
			}
1945
1946
			return '';
1947
		}
1948
1949
		/**
1950
		 * Check whether a plugin complies with the minimum version requirements.
1951
		 *
1952
		 * @since 2.5.0
1953
		 *
1954
		 * @param string $slug Plugin slug.
1955
		 * @return bool True when a plugin needs to be updated, otherwise false.
1956
		 */
1957
		public function does_plugin_require_update( $slug ) {
0 ignored issues
show
Coding Style introduced by
function does_plugin_require_update() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
1958
			$installed_version = $this->get_installed_version( $slug );
1959
			$minimum_version   = $this->plugins[ $slug ]['version'];
1960
1961
			return version_compare( $minimum_version, $installed_version, '>' );
1962
		}
1963
1964
		/**
1965
		 * Check whether there is an update available for a plugin.
1966
		 *
1967
		 * @since 2.5.0
1968
		 *
1969
		 * @param string $slug Plugin slug.
1970
		 * @return false|string Version number string of the available update or false if no update available.
1971
		 */
1972
		public function does_plugin_have_update( $slug ) {
1973
			// Presume bundled and external plugins will point to a package which meets the minimum required version.
1974
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1975
				if ( $this->does_plugin_require_update( $slug ) ) {
1976
					return $this->plugins[ $slug ]['version'];
1977
				}
1978
1979
				return false;
1980
			}
1981
1982
			$repo_updates = get_site_transient( 'update_plugins' );
1983
1984 View Code Duplication
			if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
1985
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
1986
			}
1987
1988
			return false;
1989
		}
1990
1991
		/**
1992
		 * Retrieve potential upgrade notice for a plugin.
1993
		 *
1994
		 * @since 2.5.0
1995
		 *
1996
		 * @param string $slug Plugin slug.
1997
		 * @return string The upgrade notice or an empty string if no message was available or provided.
1998
		 */
1999
		public function get_upgrade_notice( $slug ) {
2000
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
2001
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
2002
				return '';
2003
			}
2004
2005
			$repo_updates = get_site_transient( 'update_plugins' );
2006
2007 View Code Duplication
			if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
2008
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
2009
			}
2010
2011
			return '';
2012
		}
2013
2014
		/**
2015
		 * Wrapper around the core WP get_plugins function, making sure it's actually available.
2016
		 *
2017
		 * @since 2.5.0
2018
		 *
2019
		 * @param string $plugin_folder Optional. Relative path to single plugin folder.
2020
		 * @return array Array of installed plugins with plugin information.
2021
		 */
2022
		public function get_plugins( $plugin_folder = '' ) {
2023
			if ( ! function_exists( 'get_plugins' ) ) {
2024
				require_once ABSPATH . 'wp-admin/includes/plugin.php';
2025
			}
2026
2027
			return get_plugins( $plugin_folder );
2028
		}
2029
2030
		/**
2031
		 * Delete dismissable nag option when theme is switched.
2032
		 *
2033
		 * This ensures that the user(s) is/are again reminded via nag of required
2034
		 * and/or recommended plugins if they re-activate the theme.
2035
		 *
2036
		 * @since 2.1.1
2037
		 */
2038
		public function update_dismiss() {
2039
			delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
2040
		}
2041
2042
		/**
2043
		 * Forces plugin activation if the parameter 'force_activation' is
2044
		 * set to true.
2045
		 *
2046
		 * This allows theme authors to specify certain plugins that must be
2047
		 * active at all times while using the current theme.
2048
		 *
2049
		 * Please take special care when using this parameter as it has the
2050
		 * potential to be harmful if not used correctly. Setting this parameter
2051
		 * to true will not allow the specified plugin to be deactivated unless
2052
		 * the user switches themes.
2053
		 *
2054
		 * @since 2.2.0
2055
		 */
2056
		public function force_activation() {
2057
			foreach ( $this->plugins as $slug => $plugin ) {
2058
				if ( true === $plugin['force_activation'] ) {
2059
					if ( ! $this->is_plugin_installed( $slug ) ) {
2060
						// Oops, plugin isn't there so iterate to next condition.
2061
						continue;
2062
					} elseif ( $this->can_plugin_activate( $slug ) ) {
2063
						// There we go, activate the plugin.
2064
						activate_plugin( $plugin['file_path'] );
2065
					}
2066
				}
2067
			}
2068
		}
2069
2070
		/**
2071
		 * Forces plugin deactivation if the parameter 'force_deactivation'
2072
		 * is set to true and adds the plugin to the 'recently active' plugins list.
2073
		 *
2074
		 * This allows theme authors to specify certain plugins that must be
2075
		 * deactivated upon switching from the current theme to another.
2076
		 *
2077
		 * Please take special care when using this parameter as it has the
2078
		 * potential to be harmful if not used correctly.
2079
		 *
2080
		 * @since 2.2.0
2081
		 */
2082
		public function force_deactivation() {
2083
			$deactivated = array();
2084
2085
			foreach ( $this->plugins as $slug => $plugin ) {
2086
				/*
2087
				 * Only proceed forward if the parameter is set to true and plugin is active
2088
				 * as a 'normal' (not must-use) plugin.
2089
				 */
2090
				if ( true === $plugin['force_deactivation'] && is_plugin_active( $plugin['file_path'] ) ) {
2091
					deactivate_plugins( $plugin['file_path'] );
2092
					$deactivated[ $plugin['file_path'] ] = time();
2093
				}
2094
			}
2095
2096
			if ( ! empty( $deactivated ) ) {
2097
				update_option( 'recently_activated', $deactivated + (array) get_option( 'recently_activated' ) );
2098
			}
2099
		}
2100
2101
		/**
2102
		 * Echo the current TGMPA version number to the page.
2103
		 *
2104
		 * @since 2.5.0
2105
		 */
2106
		public function show_tgmpa_version() {
2107
			echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
2108
				esc_html(
2109
					sprintf(
2110
						/* translators: %s: version number */
2111
						__( 'TGMPA v%s', 'tgmpa' ),
2112
						self::TGMPA_VERSION
2113
					)
2114
				),
2115
				'</small></strong></p>';
2116
		}
2117
2118
		/**
2119
		 * Adds CSS to admin head.
2120
		 *
2121
		 * @since 2.6.2
2122
		 */
2123
		public function admin_css() {
2124
			if ( ! $this->is_tgmpa_page() ) {
2125
				return;
2126
			}
2127
2128
			echo '
2129
			<style>
2130
			#tgmpa-plugins .tgmpa-type-required > th {
2131
				border-left: 3px solid #dc3232;
2132
			}
2133
			</style>';
2134
		}
2135
2136
		/**
2137
		 * Returns the singleton instance of the class.
2138
		 *
2139
		 * @since 2.4.0
2140
		 *
2141
		 * @return \TGM_Plugin_Activation The TGM_Plugin_Activation object.
2142
		 */
2143
		public static function get_instance() {
2144
			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
2145
				self::$instance = new self();
2146
			}
2147
2148
			return self::$instance;
2149
		}
2150
	}
2151
2152
	if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
2153
		/**
2154
		 * Ensure only one instance of the class is ever invoked.
2155
		 *
2156
		 * @since 2.5.0
2157
		 */
2158
		function load_tgm_plugin_activation() {
2159
			$GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
2160
		}
2161
	}
2162
2163
	if ( did_action( 'plugins_loaded' ) ) {
2164
		load_tgm_plugin_activation();
2165
	} else {
2166
		add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
2167
	}
2168
}
2169
2170
if ( ! function_exists( 'tgmpa' ) ) {
2171
	/**
2172
	 * Helper function to register a collection of required plugins.
2173
	 *
2174
	 * @since 2.0.0
2175
	 * @api
2176
	 *
2177
	 * @param array $plugins An array of plugin arrays.
2178
	 * @param array $config  Optional. An array of configuration values.
2179
	 */
2180
	function tgmpa( $plugins, $config = array() ) {
2181
		$instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2182
2183
		foreach ( $plugins as $plugin ) {
2184
			call_user_func( array( $instance, 'register' ), $plugin );
2185
		}
2186
2187
		if ( ! empty( $config ) && is_array( $config ) ) {
2188
			// Send out notices for deprecated arguments passed.
2189
			if ( isset( $config['notices'] ) ) {
2190
				_deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
2191
				if ( ! isset( $config['has_notices'] ) ) {
2192
					$config['has_notices'] = $config['notices'];
2193
				}
2194
			}
2195
2196
			if ( isset( $config['parent_menu_slug'] ) ) {
2197
				_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.' );
2198
			}
2199
			if ( isset( $config['parent_url_slug'] ) ) {
2200
				_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.' );
2201
			}
2202
2203
			call_user_func( array( $instance, 'config' ), $config );
2204
		}
2205
	}
2206
}
2207
2208
/**
2209
 * WP_List_Table isn't always available. If it isn't available,
2210
 * we load it here.
2211
 *
2212
 * @since 2.2.0
2213
 */
2214
if ( ! class_exists( 'WP_List_Table' ) ) {
2215
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
2216
}
2217
2218
if ( ! class_exists( 'TGMPA_List_Table' ) ) {
2219
2220
	/**
2221
	 * List table class for handling plugins.
2222
	 *
2223
	 * Extends the WP_List_Table class to provide a future-compatible
2224
	 * way of listing out all required/recommended plugins.
2225
	 *
2226
	 * Gives users an interface similar to the Plugin Administration
2227
	 * area with similar (albeit stripped down) capabilities.
2228
	 *
2229
	 * This class also allows for the bulk install of plugins.
2230
	 *
2231
	 * @since 2.2.0
2232
	 *
2233
	 * @package TGM-Plugin-Activation
2234
	 * @author  Thomas Griffin
2235
	 * @author  Gary Jones
2236
	 */
2237
	class TGMPA_List_Table extends WP_List_Table {
2238
		/**
2239
		 * TGMPA instance.
2240
		 *
2241
		 * @since 2.5.0
2242
		 *
2243
		 * @var object
2244
		 */
2245
		protected $tgmpa;
2246
2247
		/**
2248
		 * The currently chosen view.
2249
		 *
2250
		 * @since 2.5.0
2251
		 *
2252
		 * @var string One of: 'all', 'install', 'update', 'activate'
2253
		 */
2254
		public $view_context = 'all';
2255
2256
		/**
2257
		 * The plugin counts for the various views.
2258
		 *
2259
		 * @since 2.5.0
2260
		 *
2261
		 * @var array
2262
		 */
2263
		protected $view_totals = array(
2264
			'all'      => 0,
2265
			'install'  => 0,
2266
			'update'   => 0,
2267
			'activate' => 0,
2268
		);
2269
2270
		/**
2271
		 * References parent constructor and sets defaults for class.
2272
		 *
2273
		 * @since 2.2.0
2274
		 */
2275
		public function __construct() {
2276
			$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2277
2278
			parent::__construct(
2279
				array(
2280
					'singular' => 'plugin',
2281
					'plural'   => 'plugins',
2282
					'ajax'     => false,
2283
				)
2284
			);
2285
2286
			if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
2287
				$this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
2288
			}
2289
2290
			add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
2291
		}
2292
2293
		/**
2294
		 * Get a list of CSS classes for the <table> tag.
2295
		 *
2296
		 * Overruled to prevent the 'plural' argument from being added.
2297
		 *
2298
		 * @since 2.5.0
2299
		 *
2300
		 * @return array CSS classnames.
2301
		 */
2302
		public function get_table_classes() {
2303
			return array( 'widefat', 'fixed' );
2304
		}
2305
2306
		/**
2307
		 * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
2308
		 *
2309
		 * @since 2.2.0
2310
		 *
2311
		 * @return array $table_data Information for use in table.
2312
		 */
2313
		protected function _gather_plugin_data() {
0 ignored issues
show
Coding Style introduced by
function _gather_plugin_data() does not seem to conform to the naming convention (^(?:[a-z]|__)[a-z_0-9]*$).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
2314
			// Load thickbox for plugin links.
2315
			$this->tgmpa->admin_init();
2316
			$this->tgmpa->thickbox();
2317
2318
			// Categorize the plugins which have open actions.
2319
			$plugins = $this->categorize_plugins_to_views();
2320
2321
			// Set the counts for the view links.
2322
			$this->set_view_totals( $plugins );
2323
2324
			// Prep variables for use and grab list of all installed plugins.
2325
			$table_data = array();
2326
			$i          = 0;
2327
2328
			// Redirect to the 'all' view if no plugins were found for the selected view context.
2329
			if ( empty( $plugins[ $this->view_context ] ) ) {
2330
				$this->view_context = 'all';
2331
			}
2332
2333
			foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
2334
				$table_data[ $i ]['sanitized_plugin']  = $plugin['name'];
2335
				$table_data[ $i ]['slug']              = $slug;
2336
				$table_data[ $i ]['plugin']            = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
2337
				$table_data[ $i ]['source']            = $this->get_plugin_source_type_text( $plugin['source_type'] );
2338
				$table_data[ $i ]['type']              = $this->get_plugin_advise_type_text( $plugin['required'] );
2339
				$table_data[ $i ]['status']            = $this->get_plugin_status_text( $slug );
2340
				$table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
2341
				$table_data[ $i ]['minimum_version']   = $plugin['version'];
2342
				$table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
2343
2344
				// Prep the upgrade notice info.
2345
				$upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
2346
				if ( ! empty( $upgrade_notice ) ) {
2347
					$table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
2348
2349
					add_action( "tgmpa_after_plugin_row_{$slug}", array( $this, 'wp_plugin_update_row' ), 10, 2 );
2350
				}
2351
2352
				$table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
2353
2354
				$i++;
2355
			}
2356
2357
			return $table_data;
2358
		}
2359
2360
		/**
2361
		 * Categorize the plugins which have open actions into views for the TGMPA page.
2362
		 *
2363
		 * @since 2.5.0
2364
		 */
2365
		protected function categorize_plugins_to_views() {
2366
			$plugins = array(
2367
				'all'      => array(), // Meaning: all plugins which still have open actions.
2368
				'install'  => array(),
2369
				'update'   => array(),
2370
				'activate' => array(),
2371
			);
2372
2373
			foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
2374
				if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2375
					// No need to display plugins if they are installed, up-to-date and active.
2376
					continue;
2377
				} else {
2378
					$plugins['all'][ $slug ] = $plugin;
2379
2380
					if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2381
						$plugins['install'][ $slug ] = $plugin;
2382
					} else {
2383
						if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2384
							$plugins['update'][ $slug ] = $plugin;
2385
						}
2386
2387
						if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2388
							$plugins['activate'][ $slug ] = $plugin;
2389
						}
2390
					}
2391
				}
2392
			}
2393
2394
			return $plugins;
2395
		}
2396
2397
		/**
2398
		 * Set the counts for the view links.
2399
		 *
2400
		 * @since 2.5.0
2401
		 *
2402
		 * @param array $plugins Plugins order by view.
2403
		 */
2404
		protected function set_view_totals( $plugins ) {
2405
			foreach ( $plugins as $type => $list ) {
2406
				$this->view_totals[ $type ] = count( $list );
2407
			}
2408
		}
2409
2410
		/**
2411
		 * Get the plugin required/recommended text string.
2412
		 *
2413
		 * @since 2.5.0
2414
		 *
2415
		 * @param string $required Plugin required setting.
2416
		 * @return string
2417
		 */
2418
		protected function get_plugin_advise_type_text( $required ) {
2419
			if ( true === $required ) {
2420
				return __( 'Required', 'tgmpa' );
2421
			}
2422
2423
			return __( 'Recommended', 'tgmpa' );
2424
		}
2425
2426
		/**
2427
		 * Get the plugin source type text string.
2428
		 *
2429
		 * @since 2.5.0
2430
		 *
2431
		 * @param string $type Plugin type.
2432
		 * @return string
2433
		 */
2434
		protected function get_plugin_source_type_text( $type ) {
2435
			$string = '';
2436
2437
			switch ( $type ) {
2438
				case 'repo':
2439
					$string = __( 'WordPress Repository', 'tgmpa' );
2440
					break;
2441
				case 'external':
2442
					$string = __( 'External Source', 'tgmpa' );
2443
					break;
2444
				case 'bundled':
2445
					$string = __( 'Pre-Packaged', 'tgmpa' );
2446
					break;
2447
			}
2448
2449
			return $string;
2450
		}
2451
2452
		/**
2453
		 * Determine the plugin status message.
2454
		 *
2455
		 * @since 2.5.0
2456
		 *
2457
		 * @param string $slug Plugin slug.
2458
		 * @return string
2459
		 */
2460
		protected function get_plugin_status_text( $slug ) {
2461
			if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2462
				return __( 'Not Installed', 'tgmpa' );
2463
			}
2464
2465
			if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
2466
				$install_status = __( 'Installed But Not Activated', 'tgmpa' );
2467
			} else {
2468
				$install_status = __( 'Active', 'tgmpa' );
2469
			}
2470
2471
			$update_status = '';
2472
2473
			if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2474
				$update_status = __( 'Required Update not Available', 'tgmpa' );
2475
2476
			} elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
2477
				$update_status = __( 'Requires Update', 'tgmpa' );
2478
2479
			} elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2480
				$update_status = __( 'Update recommended', 'tgmpa' );
2481
			}
2482
2483
			if ( '' === $update_status ) {
2484
				return $install_status;
2485
			}
2486
2487
			return sprintf(
2488
				/* translators: 1: install status, 2: update status */
2489
				_x( '%1$s, %2$s', 'Install/Update Status', 'tgmpa' ),
2490
				$install_status,
2491
				$update_status
2492
			);
2493
		}
2494
2495
		/**
2496
		 * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
2497
		 *
2498
		 * @since 2.5.0
2499
		 *
2500
		 * @param array $items Prepared table items.
2501
		 * @return array Sorted table items.
2502
		 */
2503
		public function sort_table_items( $items ) {
2504
			$type = array();
2505
			$name = array();
2506
2507
			foreach ( $items as $i => $plugin ) {
2508
				$type[ $i ] = $plugin['type']; // Required / recommended.
2509
				$name[ $i ] = $plugin['sanitized_plugin'];
2510
			}
2511
2512
			array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
2513
2514
			return $items;
2515
		}
2516
2517
		/**
2518
		 * Get an associative array ( id => link ) of the views available on this table.
2519
		 *
2520
		 * @since 2.5.0
2521
		 *
2522
		 * @return array
2523
		 */
2524
		public function get_views() {
2525
			$status_links = array();
2526
2527
			foreach ( $this->view_totals as $type => $count ) {
2528
				if ( $count < 1 ) {
2529
					continue;
2530
				}
2531
2532
				switch ( $type ) {
2533
					case 'all':
2534
						/* translators: 1: number of plugins. */
2535
						$text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
2536
						break;
2537
					case 'install':
2538
						/* translators: 1: number of plugins. */
2539
						$text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
2540
						break;
2541
					case 'update':
2542
						/* translators: 1: number of plugins. */
2543
						$text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
2544
						break;
2545
					case 'activate':
2546
						/* translators: 1: number of plugins. */
2547
						$text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
2548
						break;
2549
					default:
2550
						$text = '';
2551
						break;
2552
				}
2553
2554
				if ( ! empty( $text ) ) {
2555
2556
					$status_links[ $type ] = sprintf(
2557
						'<a href="%s"%s>%s</a>',
2558
						esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
2559
						( $type === $this->view_context ) ? ' class="current"' : '',
2560
						sprintf( $text, number_format_i18n( $count ) )
2561
					);
2562
				}
2563
			}
2564
2565
			return $status_links;
2566
		}
2567
2568
		/**
2569
		 * Create default columns to display important plugin information
2570
		 * like type, action and status.
2571
		 *
2572
		 * @since 2.2.0
2573
		 *
2574
		 * @param array  $item        Array of item data.
2575
		 * @param string $column_name The name of the column.
2576
		 * @return string
2577
		 */
2578
		public function column_default( $item, $column_name ) {
2579
			return $item[ $column_name ];
2580
		}
2581
2582
		/**
2583
		 * Required for bulk installing.
2584
		 *
2585
		 * Adds a checkbox for each plugin.
2586
		 *
2587
		 * @since 2.2.0
2588
		 *
2589
		 * @param array $item Array of item data.
2590
		 * @return string The input checkbox with all necessary info.
2591
		 */
2592
		public function column_cb( $item ) {
2593
			return sprintf(
2594
				'<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
2595
				esc_attr( $this->_args['singular'] ),
2596
				esc_attr( $item['slug'] ),
2597
				esc_attr( $item['sanitized_plugin'] )
2598
			);
2599
		}
2600
2601
		/**
2602
		 * Create default title column along with the action links.
2603
		 *
2604
		 * @since 2.2.0
2605
		 *
2606
		 * @param array $item Array of item data.
2607
		 * @return string The plugin name and action links.
2608
		 */
2609
		public function column_plugin( $item ) {
2610
			return sprintf(
2611
				'%1$s %2$s',
2612
				$item['plugin'],
2613
				$this->row_actions( $this->get_row_actions( $item ), true )
2614
			);
2615
		}
2616
2617
		/**
2618
		 * Create version information column.
2619
		 *
2620
		 * @since 2.5.0
2621
		 *
2622
		 * @param array $item Array of item data.
2623
		 * @return string HTML-formatted version information.
2624
		 */
2625
		public function column_version( $item ) {
2626
			$output = array();
2627
2628
			if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2629
				$installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
2630
2631
				$color = '';
2632
				if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
2633
					$color = ' color: #ff0000; font-weight: bold;';
2634
				}
2635
2636
				$output[] = sprintf(
2637
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
2638
					$color,
2639
					$installed
2640
				);
2641
			}
2642
2643
			if ( ! empty( $item['minimum_version'] ) ) {
2644
				$output[] = sprintf(
2645
					'<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
2646
					$item['minimum_version']
2647
				);
2648
			}
2649
2650
			if ( ! empty( $item['available_version'] ) ) {
2651
				$color = '';
2652
				if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
2653
					$color = ' color: #71C671; font-weight: bold;';
2654
				}
2655
2656
				$output[] = sprintf(
2657
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
2658
					$color,
2659
					$item['available_version']
2660
				);
2661
			}
2662
2663
			if ( empty( $output ) ) {
2664
				return '&nbsp;'; // Let's not break the table layout.
2665
			} else {
2666
				return implode( "\n", $output );
2667
			}
2668
		}
2669
2670
		/**
2671
		 * Sets default message within the plugins table if no plugins
2672
		 * are left for interaction.
2673
		 *
2674
		 * Hides the menu item to prevent the user from clicking and
2675
		 * getting a permissions error.
2676
		 *
2677
		 * @since 2.2.0
2678
		 */
2679
		public function no_items() {
2680
			echo esc_html__( 'No plugins to install, update or activate.', 'tgmpa' ) . ' <a href="' . esc_url( self_admin_url() ) . '"> ' . esc_html( $this->tgmpa->strings['dashboard'] ) . '</a>';
2681
			echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
2682
		}
2683
2684
		/**
2685
		 * Output all the column information within the table.
2686
		 *
2687
		 * @since 2.2.0
2688
		 *
2689
		 * @return array $columns The column names.
2690
		 */
2691
		public function get_columns() {
2692
			$columns = array(
2693
				'cb'     => '<input type="checkbox" />',
2694
				'plugin' => __( 'Plugin', 'tgmpa' ),
2695
				'source' => __( 'Source', 'tgmpa' ),
2696
				'type'   => __( 'Type', 'tgmpa' ),
2697
			);
2698
2699
			if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
2700
				$columns['version'] = __( 'Version', 'tgmpa' );
2701
				$columns['status']  = __( 'Status', 'tgmpa' );
2702
			}
2703
2704
			return apply_filters( 'tgmpa_table_columns', $columns );
2705
		}
2706
2707
		/**
2708
		 * Get name of default primary column
2709
		 *
2710
		 * @since 2.5.0 / WP 4.3+ compatibility
2711
		 * @access protected
2712
		 *
2713
		 * @return string
2714
		 */
2715
		protected function get_default_primary_column_name() {
2716
			return 'plugin';
2717
		}
2718
2719
		/**
2720
		 * Get the name of the primary column.
2721
		 *
2722
		 * @since 2.5.0 / WP 4.3+ compatibility
2723
		 * @access protected
2724
		 *
2725
		 * @return string The name of the primary column.
2726
		 */
2727
		protected function get_primary_column_name() {
2728
			if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
2729
				return parent::get_primary_column_name();
2730
			} else {
2731
				return $this->get_default_primary_column_name();
2732
			}
2733
		}
2734
2735
		/**
2736
		 * Get the actions which are relevant for a specific plugin row.
2737
		 *
2738
		 * @since 2.5.0
2739
		 *
2740
		 * @param array $item Array of item data.
2741
		 * @return array Array with relevant action links.
2742
		 */
2743
		protected function get_row_actions( $item ) {
2744
			$actions      = array();
2745
			$action_links = array();
2746
2747
			// Display the 'Install' action link if the plugin is not yet available.
2748
			if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2749
				/* translators: %2$s: plugin name in screen reader markup */
2750
				$actions['install'] = __( 'Install %2$s', 'tgmpa' );
2751
			} else {
2752
				// Display the 'Update' action link if an update is available and WP complies with plugin minimum.
2753
				if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
2754
					/* translators: %2$s: plugin name in screen reader markup */
2755
					$actions['update'] = __( 'Update %2$s', 'tgmpa' );
2756
				}
2757
2758
				// Display the 'Activate' action link, but only if the plugin meets the minimum version.
2759
				if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
2760
					/* translators: %2$s: plugin name in screen reader markup */
2761
					$actions['activate'] = __( 'Activate %2$s', 'tgmpa' );
2762
				}
2763
			}
2764
2765
			// Create the actual links.
2766
			foreach ( $actions as $action => $text ) {
2767
				$nonce_url = wp_nonce_url(
2768
					add_query_arg(
2769
						array(
2770
							'plugin'           => urlencode( $item['slug'] ),
2771
							'tgmpa-' . $action => $action . '-plugin',
2772
						),
2773
						$this->tgmpa->get_tgmpa_url()
2774
					),
2775
					'tgmpa-' . $action,
2776
					'tgmpa-nonce'
2777
				);
2778
2779
				$action_links[ $action ] = sprintf(
2780
					'<a href="%1$s">' . esc_html( $text ) . '</a>', // $text contains the second placeholder.
2781
					esc_url( $nonce_url ),
2782
					'<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
2783
				);
2784
			}
2785
2786
			$prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
2787
			return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
2788
		}
2789
2790
		/**
2791
		 * Generates content for a single row of the table.
2792
		 *
2793
		 * @since 2.5.0
2794
		 *
2795
		 * @param object $item The current item.
2796
		 */
2797
		public function single_row( $item ) {
2798
			echo '<tr class="' . esc_attr( 'tgmpa-type-' . strtolower( $item['type'] ) ) . '">';
2799
			$this->single_row_columns( $item );
2800
			echo '</tr>';
2801
2802
			/**
2803
			 * Fires after each specific row in the TGMPA Plugins list table.
2804
			 *
2805
			 * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
2806
			 * for the plugin.
2807
			 *
2808
			 * @since 2.5.0
2809
			 */
2810
			do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
2811
		}
2812
2813
		/**
2814
		 * Show the upgrade notice below a plugin row if there is one.
2815
		 *
2816
		 * @since 2.5.0
2817
		 *
2818
		 * @see /wp-admin/includes/update.php
2819
		 *
2820
		 * @param string $slug Plugin slug.
2821
		 * @param array  $item The information available in this table row.
2822
		 * @return null Return early if upgrade notice is empty.
2823
		 */
2824
		public function wp_plugin_update_row( $slug, $item ) {
2825
			if ( empty( $item['upgrade_notice'] ) ) {
2826
				return;
2827
			}
2828
2829
			echo '
2830
				<tr class="plugin-update-tr">
2831
					<td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
2832
						<div class="update-message">',
2833
							esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
2834
							' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
2835
						</div>
2836
					</td>
2837
				</tr>';
2838
		}
2839
2840
		/**
2841
		 * Extra controls to be displayed between bulk actions and pagination.
2842
		 *
2843
		 * @since 2.5.0
2844
		 *
2845
		 * @param string $which Either 'top' or 'bottom' table navigation.
2846
		 */
2847
		public function extra_tablenav( $which ) {
2848
			if ( 'bottom' === $which ) {
2849
				$this->tgmpa->show_tgmpa_version();
2850
			}
2851
		}
2852
2853
		/**
2854
		 * Defines the bulk actions for handling registered plugins.
2855
		 *
2856
		 * @since 2.2.0
2857
		 *
2858
		 * @return array $actions The bulk actions for the plugin install table.
2859
		 */
2860
		public function get_bulk_actions() {
2861
2862
			$actions = array();
2863
2864
			if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
2865
				if ( current_user_can( 'install_plugins' ) ) {
2866
					$actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
2867
				}
2868
			}
2869
2870
			if ( 'install' !== $this->view_context ) {
2871
				if ( current_user_can( 'update_plugins' ) ) {
2872
					$actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
2873
				}
2874
				if ( current_user_can( 'activate_plugins' ) ) {
2875
					$actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
2876
				}
2877
			}
2878
2879
			return $actions;
2880
		}
2881
2882
		/**
2883
		 * Processes bulk installation and activation actions.
2884
		 *
2885
		 * The bulk installation process looks for the $_POST information and passes that
2886
		 * through if a user has to use WP_Filesystem to enter their credentials.
2887
		 *
2888
		 * @since 2.2.0
2889
		 */
2890
		public function process_bulk_actions() {
0 ignored issues
show
Coding Style introduced by
function process_bulk_actions() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
2891
			// Bulk installation process.
2892
			if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
2893
2894
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2895
2896
				$install_type = 'install';
2897
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2898
					$install_type = 'update';
2899
				}
2900
2901
				$plugins_to_install = array();
2902
2903
				// Did user actually select any plugins to install/update ?
2904 View Code Duplication
				if ( empty( $_POST['plugin'] ) ) {
2905
					if ( 'install' === $install_type ) {
2906
						$message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
2907
					} else {
2908
						$message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
2909
					}
2910
2911
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2912
2913
					return false;
2914
				}
2915
2916
				if ( is_array( $_POST['plugin'] ) ) {
2917
					$plugins_to_install = (array) $_POST['plugin'];
2918
				} elseif ( is_string( $_POST['plugin'] ) ) {
2919
					// Received via Filesystem page - un-flatten array (WP bug #19643).
2920
					$plugins_to_install = explode( ',', $_POST['plugin'] );
2921
				}
2922
2923
				// Sanitize the received input.
2924
				$plugins_to_install = array_map( 'urldecode', $plugins_to_install );
2925
				$plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
2926
2927
				// Validate the received input.
2928
				foreach ( $plugins_to_install as $key => $slug ) {
2929
					// Check if the plugin was registered with TGMPA and remove if not.
2930
					if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
2931
						unset( $plugins_to_install[ $key ] );
2932
						continue;
2933
					}
2934
2935
					// For install: make sure this is a plugin we *can* install and not one already installed.
2936
					if ( 'install' === $install_type && true === $this->tgmpa->is_plugin_installed( $slug ) ) {
2937
						unset( $plugins_to_install[ $key ] );
2938
					}
2939
2940
					// For updates: make sure this is a plugin we *can* update (update available and WP version ok).
2941
					if ( 'update' === $install_type && false === $this->tgmpa->is_plugin_updatetable( $slug ) ) {
2942
						unset( $plugins_to_install[ $key ] );
2943
					}
2944
				}
2945
2946
				// No need to proceed further if we have no plugins to handle.
2947 View Code Duplication
				if ( empty( $plugins_to_install ) ) {
2948
					if ( 'install' === $install_type ) {
2949
						$message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
2950
					} else {
2951
						$message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
2952
					}
2953
2954
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2955
2956
					return false;
2957
				}
2958
2959
				// Pass all necessary information if WP_Filesystem is needed.
2960
				$url = wp_nonce_url(
2961
					$this->tgmpa->get_tgmpa_url(),
2962
					'bulk-' . $this->_args['plural']
2963
				);
2964
2965
				// Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
2966
				$_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
2967
2968
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
2969
				$fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
2970
2971
				$creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields );
2972
				if ( false === $creds ) {
2973
					return true; // Stop the normal page form from displaying, credential request form will be shown.
2974
				}
2975
2976
				// Now we have some credentials, setup WP_Filesystem.
2977 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
2978
					// Our credentials were no good, ask the user for them again.
2979
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
2980
2981
					return true;
2982
				}
2983
2984
				/* If we arrive here, we have the filesystem */
2985
2986
				// Store all information in arrays since we are processing a bulk installation.
2987
				$names      = array();
2988
				$sources    = array(); // Needed for installs.
2989
				$file_paths = array(); // Needed for upgrades.
2990
				$to_inject  = array(); // Information to inject into the update_plugins transient.
2991
2992
				// Prepare the data for validated plugins for the install/upgrade.
2993
				foreach ( $plugins_to_install as $slug ) {
2994
					$name   = $this->tgmpa->plugins[ $slug ]['name'];
2995
					$source = $this->tgmpa->get_download_url( $slug );
2996
2997
					if ( ! empty( $name ) && ! empty( $source ) ) {
2998
						$names[] = $name;
2999
3000
						switch ( $install_type ) {
3001
3002
							case 'install':
3003
								$sources[] = $source;
3004
								break;
3005
3006
							case 'update':
3007
								$file_paths[]                 = $this->tgmpa->plugins[ $slug ]['file_path'];
3008
								$to_inject[ $slug ]           = $this->tgmpa->plugins[ $slug ];
3009
								$to_inject[ $slug ]['source'] = $source;
3010
								break;
3011
						}
3012
					}
3013
				}
3014
				unset( $slug, $name, $source );
3015
3016
				// Create a new instance of TGMPA_Bulk_Installer.
3017
				$installer = new TGMPA_Bulk_Installer(
3018
					new TGMPA_Bulk_Installer_Skin(
3019
						array(
3020
							'url'          => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
3021
							'nonce'        => 'bulk-' . $this->_args['plural'],
3022
							'names'        => $names,
3023
							'install_type' => $install_type,
3024
						)
3025
					)
3026
				);
3027
3028
				// Wrap the install process with the appropriate HTML.
3029
				echo '<div class="tgmpa">',
3030
					'<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>
3031
					<div class="update-php" style="width: 100%; height: 98%; min-height: 850px; padding-top: 1px;">';
3032
3033
				// Process the bulk installation submissions.
3034
				add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
3035
3036
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
3037
					// Inject our info into the update transient.
3038
					$this->tgmpa->inject_update_info( $to_inject );
3039
3040
					$installer->bulk_upgrade( $file_paths );
3041
				} else {
3042
					$installer->bulk_install( $sources );
3043
				}
3044
3045
				remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1 );
3046
3047
				echo '</div></div>';
3048
3049
				return true;
3050
			}
3051
3052
			// Bulk activation process.
3053
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3054
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
3055
3056
				// Did user actually select any plugins to activate ?
3057
				if ( empty( $_POST['plugin'] ) ) {
3058
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
3059
3060
					return false;
3061
				}
3062
3063
				// Grab plugin data from $_POST.
3064
				$plugins = array();
3065
				if ( isset( $_POST['plugin'] ) ) {
3066
					$plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
3067
					$plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
3068
				}
3069
3070
				$plugins_to_activate = array();
3071
				$plugin_names        = array();
3072
3073
				// Grab the file paths for the selected & inactive plugins from the registration array.
3074
				foreach ( $plugins as $slug ) {
3075
					if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
3076
						$plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
3077
						$plugin_names[]        = $this->tgmpa->plugins[ $slug ]['name'];
3078
					}
3079
				}
3080
				unset( $slug );
3081
3082
				// Return early if there are no plugins to activate.
3083
				if ( empty( $plugins_to_activate ) ) {
3084
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
3085
3086
					return false;
3087
				}
3088
3089
				// Now we are good to go - let's start activating plugins.
3090
				$activate = activate_plugins( $plugins_to_activate );
3091
3092
				if ( is_wp_error( $activate ) ) {
3093
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
3094
				} else {
3095
					$count        = count( $plugin_names ); // Count so we can use _n function.
3096
					$plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
3097
					$last_plugin  = array_pop( $plugin_names ); // Pop off last name to prep for readability.
3098
					$imploded     = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
3099
3100
					printf( // WPCS: xss ok.
3101
						'<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
3102
						esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
3103
						$imploded
3104
					);
3105
3106
					// Update recently activated plugins option.
3107
					$recent = (array) get_option( 'recently_activated' );
3108
					foreach ( $plugins_to_activate as $plugin => $time ) {
3109
						if ( isset( $recent[ $plugin ] ) ) {
3110
							unset( $recent[ $plugin ] );
3111
						}
3112
					}
3113
					update_option( 'recently_activated', $recent );
3114
				}
3115
3116
				unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
3117
3118
				return true;
3119
			}
3120
3121
			return false;
3122
		}
3123
3124
		/**
3125
		 * Prepares all of our information to be outputted into a usable table.
3126
		 *
3127
		 * @since 2.2.0
3128
		 */
3129
		public function prepare_items() {
3130
			$columns               = $this->get_columns(); // Get all necessary column information.
3131
			$hidden                = array(); // No columns to hide, but we must set as an array.
3132
			$sortable              = array(); // No reason to make sortable columns.
3133
			$primary               = $this->get_primary_column_name(); // Column which has the row actions.
3134
			$this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
3135
3136
			// Process our bulk activations here.
3137
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3138
				$this->process_bulk_actions();
3139
			}
3140
3141
			// Store all of our plugin data into $items array so WP_List_Table can use it.
3142
			$this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
3143
		}
3144
3145
		/* *********** DEPRECATED METHODS *********** */
3146
3147
		/**
3148
		 * Retrieve plugin data, given the plugin name.
3149
		 *
3150
		 * @since      2.2.0
3151
		 * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
3152
		 * @see        TGM_Plugin_Activation::_get_plugin_data_from_name()
3153
		 *
3154
		 * @param string $name Name of the plugin, as it was registered.
3155
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
3156
		 * @return string|boolean Plugin slug if found, false otherwise.
3157
		 */
3158
		protected function _get_plugin_data_from_name( $name, $data = 'slug' ) {
0 ignored issues
show
Coding Style introduced by
function _get_plugin_data_from_name() does not seem to conform to the naming convention (^(?:[a-z]|__)[a-z_0-9]*$).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
3159
			_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
3160
3161
			return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
3162
		}
3163
	}
3164
}
3165
3166
3167
if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
3168
3169
	/**
3170
	 * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
3171
	 *
3172
	 * @since 2.5.2
3173
	 *
3174
	 * {@internal The TGMPA_Bulk_Installer class was originally called TGM_Bulk_Installer.
3175
	 *            For more information, see that class.}}
3176
	 */
3177
	class TGM_Bulk_Installer {
3178
	}
3179
}
3180
if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
3181
3182
	/**
3183
	 * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
3184
	 *
3185
	 * @since 2.5.2
3186
	 *
3187
	 * {@internal The TGMPA_Bulk_Installer_Skin class was originally called TGM_Bulk_Installer_Skin.
3188
	 *            For more information, see that class.}}
3189
	 */
3190
	class TGM_Bulk_Installer_Skin {
3191
	}
3192
}
3193
3194
/**
3195
 * The WP_Upgrader file isn't always available. If it isn't available,
3196
 * we load it here.
3197
 *
3198
 * We check to make sure no action or activation keys are set so that WordPress
3199
 * does not try to re-include the class when processing upgrades or installs outside
3200
 * of the class.
3201
 *
3202
 * @since 2.2.0
3203
 */
3204
add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
3205
if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
3206
	/**
3207
	 * Load bulk installer
3208
	 */
3209
	function tgmpa_load_bulk_installer() {
3210
		// Silently fail if 2.5+ is loaded *after* an older version.
3211
		if ( ! isset( $GLOBALS['tgmpa'] ) ) {
3212
			return;
3213
		}
3214
3215
		// Get TGMPA class instance.
3216
		$tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3217
3218
		if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
3219
			if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
3220
				require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
3221
			}
3222
3223
			if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
3224
3225
				/**
3226
				 * Installer class to handle bulk plugin installations.
3227
				 *
3228
				 * Extends WP_Upgrader and customizes to suit the installation of multiple
3229
				 * plugins.
3230
				 *
3231
				 * @since 2.2.0
3232
				 *
3233
				 * {@internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader.}}
3234
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
3235
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3236
				 *
3237
				 * @package TGM-Plugin-Activation
3238
				 * @author  Thomas Griffin
3239
				 * @author  Gary Jones
3240
				 */
3241
				class TGMPA_Bulk_Installer extends Plugin_Upgrader {
3242
					/**
3243
					 * Holds result of bulk plugin installation.
3244
					 *
3245
					 * @since 2.2.0
3246
					 *
3247
					 * @var string
3248
					 */
3249
					public $result;
3250
3251
					/**
3252
					 * Flag to check if bulk installation is occurring or not.
3253
					 *
3254
					 * @since 2.2.0
3255
					 *
3256
					 * @var boolean
3257
					 */
3258
					public $bulk = false;
3259
3260
					/**
3261
					 * TGMPA instance
3262
					 *
3263
					 * @since 2.5.0
3264
					 *
3265
					 * @var object
3266
					 */
3267
					protected $tgmpa;
3268
3269
					/**
3270
					 * Whether or not the destination directory needs to be cleared ( = on update).
3271
					 *
3272
					 * @since 2.5.0
3273
					 *
3274
					 * @var bool
3275
					 */
3276
					protected $clear_destination = false;
3277
3278
					/**
3279
					 * References parent constructor and sets defaults for class.
3280
					 *
3281
					 * @since 2.2.0
3282
					 *
3283
					 * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
3284
					 */
3285
					public function __construct( $skin = null ) {
3286
						// Get TGMPA class instance.
3287
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3288
3289
						parent::__construct( $skin );
3290
3291
						if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
3292
							$this->clear_destination = true;
3293
						}
3294
3295
						if ( $this->tgmpa->is_automatic ) {
3296
							$this->activate_strings();
3297
						}
3298
3299
						add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
3300
					}
3301
3302
					/**
3303
					 * Sets the correct activation strings for the installer skin to use.
3304
					 *
3305
					 * @since 2.2.0
3306
					 */
3307
					public function activate_strings() {
3308
						$this->strings['activation_failed']  = __( 'Plugin activation failed.', 'tgmpa' );
3309
						$this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
3310
					}
3311
3312
					/**
3313
					 * Performs the actual installation of each plugin.
3314
					 *
3315
					 * @since 2.2.0
3316
					 *
3317
					 * @see WP_Upgrader::run()
3318
					 *
3319
					 * @param array $options The installation config options.
3320
					 * @return null|array Return early if error, array of installation data on success.
3321
					 */
3322
					public function run( $options ) {
3323
						$result = parent::run( $options );
3324
3325
						// Reset the strings in case we changed one during automatic activation.
3326
						if ( $this->tgmpa->is_automatic ) {
3327
							if ( 'update' === $this->skin->options['install_type'] ) {
3328
								$this->upgrade_strings();
3329
							} else {
3330
								$this->install_strings();
3331
							}
3332
						}
3333
3334
						return $result;
3335
					}
3336
3337
					/**
3338
					 * Processes the bulk installation of plugins.
3339
					 *
3340
					 * @since 2.2.0
3341
					 *
3342
					 * {@internal This is basically a near identical copy of the WP Core
3343
					 * Plugin_Upgrader::bulk_upgrade() method, with minor adjustments to deal with
3344
					 * new installs instead of upgrades.
3345
					 * For ease of future synchronizations, the adjustments are clearly commented, but no other
3346
					 * comments are added. Code style has been made to comply.}}
3347
					 *
3348
					 * @see Plugin_Upgrader::bulk_upgrade()
3349
					 * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
3350
					 * (@internal Last synced: Dec 31st 2015 against https://core.trac.wordpress.org/browser/trunk?rev=36134}}
3351
					 *
3352
					 * @param array $plugins The plugin sources needed for installation.
3353
					 * @param array $args    Arbitrary passed extra arguments.
3354
					 * @return array|false   Install confirmation messages on success, false on failure.
3355
					 */
3356
					public function bulk_install( $plugins, $args = array() ) {
3357
						// [TGMPA + ] Hook auto-activation in.
3358
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3359
3360
						$defaults    = array(
3361
							'clear_update_cache' => true,
3362
						);
3363
						$parsed_args = wp_parse_args( $args, $defaults );
3364
3365
						$this->init();
3366
						$this->bulk = true;
3367
3368
						$this->install_strings(); // [TGMPA + ] adjusted.
3369
3370
						/* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
3371
3372
						/* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
3373
3374
						$this->skin->header();
3375
3376
						// Connect to the Filesystem first.
3377
						$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
3378
						if ( ! $res ) {
3379
							$this->skin->footer();
3380
							return false;
3381
						}
3382
3383
						$this->skin->bulk_header();
3384
3385
						/*
3386
						 * Only start maintenance mode if:
3387
						 * - running Multisite and there are one or more plugins specified, OR
3388
						 * - a plugin with an update available is currently active.
3389
						 * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
3390
						 */
3391
						$maintenance = ( is_multisite() && ! empty( $plugins ) );
3392
3393
						/*
3394
						[TGMPA - ]
3395
						foreach ( $plugins as $plugin )
3396
							$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
3397
						*/
3398
						if ( $maintenance ) {
3399
							$this->maintenance_mode( true );
3400
						}
3401
3402
						$results = array();
3403
3404
						$this->update_count   = count( $plugins );
3405
						$this->update_current = 0;
3406
						foreach ( $plugins as $plugin ) {
3407
							$this->update_current++;
3408
3409
							/*
3410
							[TGMPA - ]
3411
							$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
3412
3413
							if ( !isset( $current->response[ $plugin ] ) ) {
3414
								$this->skin->set_result('up_to_date');
3415
								$this->skin->before();
3416
								$this->skin->feedback('up_to_date');
3417
								$this->skin->after();
3418
								$results[$plugin] = true;
3419
								continue;
3420
							}
3421
3422
							// Get the URL to the zip file.
3423
							$r = $current->response[ $plugin ];
3424
3425
							$this->skin->plugin_active = is_plugin_active($plugin);
3426
							*/
3427
3428
							$result = $this->run(
3429
								array(
3430
									'package'           => $plugin, // [TGMPA + ] adjusted.
3431
									'destination'       => WP_PLUGIN_DIR,
3432
									'clear_destination' => false, // [TGMPA + ] adjusted.
3433
									'clear_working'     => true,
3434
									'is_multi'          => true,
3435
									'hook_extra'        => array(
3436
										'plugin' => $plugin,
3437
									),
3438
								)
3439
							);
3440
3441
							$results[ $plugin ] = $this->result;
3442
3443
							// Prevent credentials auth screen from displaying multiple times.
3444
							if ( false === $result ) {
3445
								break;
3446
							}
3447
						}
3448
3449
						$this->maintenance_mode( false );
3450
3451
						/**
3452
						 * Fires when the bulk upgrader process is complete.
3453
						 *
3454
						 * @since WP 3.6.0 / TGMPA 2.5.0
3455
						 *
3456
						 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
3457
						 *                              be a Theme_Upgrader or Core_Upgrade instance.
3458
						 * @param array           $data {
3459
						 *     Array of bulk item update data.
3460
						 *
3461
						 *     @type string $action   Type of action. Default 'update'.
3462
						 *     @type string $type     Type of update process. Accepts 'plugin', 'theme', or 'core'.
3463
						 *     @type bool   $bulk     Whether the update process is a bulk update. Default true.
3464
						 *     @type array  $packages Array of plugin, theme, or core packages to update.
3465
						 * }
3466
						 */
3467
						do_action( // WPCS: prefix OK.
3468
							'upgrader_process_complete',
3469
							$this,
3470
							array(
3471
								'action'  => 'install', // [TGMPA + ] adjusted.
3472
								'type'    => 'plugin',
3473
								'bulk'    => true,
3474
								'plugins' => $plugins,
3475
							)
3476
						);
3477
3478
						$this->skin->bulk_footer();
3479
3480
						$this->skin->footer();
3481
3482
						// Cleanup our hooks, in case something else does a upgrade on this connection.
3483
						/* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
3484
3485
						// [TGMPA + ] Remove our auto-activation hook.
3486
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3487
3488
						// Force refresh of plugin update information.
3489
						wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
3490
3491
						return $results;
3492
					}
3493
3494
					/**
3495
					 * Handle a bulk upgrade request.
3496
					 *
3497
					 * @since 2.5.0
3498
					 *
3499
					 * @see Plugin_Upgrader::bulk_upgrade()
3500
					 *
3501
					 * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
3502
					 * @param array $args    Arbitrary passed extra arguments.
3503
					 * @return string|bool Install confirmation messages on success, false on failure.
3504
					 */
3505
					public function bulk_upgrade( $plugins, $args = array() ) {
3506
3507
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3508
3509
						$result = parent::bulk_upgrade( $plugins, $args );
3510
3511
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3512
3513
						return $result;
3514
					}
3515
3516
					/**
3517
					 * Abuse a filter to auto-activate plugins after installation.
3518
					 *
3519
					 * Hooked into the 'upgrader_post_install' filter hook.
3520
					 *
3521
					 * @since 2.5.0
3522
					 *
3523
					 * @param bool $bool The value we need to give back (true).
3524
					 * @return bool
3525
					 */
3526
					public function auto_activate( $bool ) {
0 ignored issues
show
Coding Style introduced by
function auto_activate() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

This check examines a number of code elements and verifies that they conform to the given naming conventions.

You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.

Loading history...
3527
						// Only process the activation of installed plugins if the automatic flag is set to true.
3528
						if ( $this->tgmpa->is_automatic ) {
3529
							// Flush plugins cache so the headers of the newly installed plugins will be read correctly.
3530
							wp_clean_plugins_cache();
3531
3532
							// Get the installed plugin file.
3533
							$plugin_info = $this->plugin_info();
3534
3535
							// Don't try to activate on upgrade of active plugin as WP will do this already.
3536
							if ( ! is_plugin_active( $plugin_info ) ) {
3537
								$activate = activate_plugin( $plugin_info );
3538
3539
								// Adjust the success string based on the activation result.
3540
								$this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
3541
3542
								if ( is_wp_error( $activate ) ) {
3543
									$this->skin->error( $activate );
3544
									$this->strings['process_success'] .= $this->strings['activation_failed'];
3545
								} else {
3546
									$this->strings['process_success'] .= $this->strings['activation_success'];
3547
								}
3548
							}
3549
						}
3550
3551
						return $bool;
3552
					}
3553
				}
3554
			}
3555
3556
			if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
3557
3558
				/**
3559
				 * Installer skin to set strings for the bulk plugin installations..
3560
				 *
3561
				 * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
3562
				 * plugins.
3563
				 *
3564
				 * @since 2.2.0
3565
				 *
3566
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
3567
				 *            TGMPA_Bulk_Installer_Skin.
3568
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3569
				 *
3570
				 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
3571
				 *
3572
				 * @package TGM-Plugin-Activation
3573
				 * @author  Thomas Griffin
3574
				 * @author  Gary Jones
3575
				 */
3576
				class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
3577
					/**
3578
					 * Holds plugin info for each individual plugin installation.
3579
					 *
3580
					 * @since 2.2.0
3581
					 *
3582
					 * @var array
3583
					 */
3584
					public $plugin_info = array();
3585
3586
					/**
3587
					 * Holds names of plugins that are undergoing bulk installations.
3588
					 *
3589
					 * @since 2.2.0
3590
					 *
3591
					 * @var array
3592
					 */
3593
					public $plugin_names = array();
3594
3595
					/**
3596
					 * Integer to use for iteration through each plugin installation.
3597
					 *
3598
					 * @since 2.2.0
3599
					 *
3600
					 * @var integer
3601
					 */
3602
					public $i = 0;
3603
3604
					/**
3605
					 * TGMPA instance
3606
					 *
3607
					 * @since 2.5.0
3608
					 *
3609
					 * @var object
3610
					 */
3611
					protected $tgmpa;
3612
3613
					/**
3614
					 * Constructor. Parses default args with new ones and extracts them for use.
3615
					 *
3616
					 * @since 2.2.0
3617
					 *
3618
					 * @param array $args Arguments to pass for use within the class.
3619
					 */
3620
					public function __construct( $args = array() ) {
3621
						// Get TGMPA class instance.
3622
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3623
3624
						// Parse default and new args.
3625
						$defaults = array(
3626
							'url'          => '',
3627
							'nonce'        => '',
3628
							'names'        => array(),
3629
							'install_type' => 'install',
3630
						);
3631
						$args     = wp_parse_args( $args, $defaults );
3632
3633
						// Set plugin names to $this->plugin_names property.
3634
						$this->plugin_names = $args['names'];
3635
3636
						// Extract the new args.
3637
						parent::__construct( $args );
3638
					}
3639
3640
					/**
3641
					 * Sets install skin strings for each individual plugin.
3642
					 *
3643
					 * Checks to see if the automatic activation flag is set and uses the
3644
					 * the proper strings accordingly.
3645
					 *
3646
					 * @since 2.2.0
3647
					 */
3648
					public function add_strings() {
3649
						if ( 'update' === $this->options['install_type'] ) {
3650
							parent::add_strings();
3651
							/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3652
							$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3653
						} else {
3654
							/* translators: 1: plugin name, 2: error message. */
3655
							$this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
3656
							/* translators: 1: plugin name. */
3657
							$this->upgrader->strings['skin_update_failed'] = __( 'The installation of %1$s failed.', 'tgmpa' );
3658
3659
							if ( $this->tgmpa->is_automatic ) {
3660
								// Automatic activation strings.
3661
								$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' );
3662
								/* translators: 1: plugin name. */
3663
								$this->upgrader->strings['skin_update_successful'] = __( '%1$s installed and activated successfully.', 'tgmpa' );
3664
								$this->upgrader->strings['skin_upgrade_end']       = __( 'All installations and activations have been completed.', 'tgmpa' );
3665
								/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3666
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3667
							} else {
3668
								// Default installation strings.
3669
								$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' );
3670
								/* translators: 1: plugin name. */
3671
								$this->upgrader->strings['skin_update_successful'] = __( '%1$s installed successfully.', 'tgmpa' );
3672
								$this->upgrader->strings['skin_upgrade_end']       = __( 'All installations have been completed.', 'tgmpa' );
3673
								/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3674
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3675
							}
3676
3677
							// Add "read more" link only for WP < 4.8.
3678
							if ( version_compare( $this->tgmpa->wp_version, '4.8', '<' ) ) {
3679
								$this->upgrader->strings['skin_update_successful'] .= ' <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>';
3680
							}
3681
						}
3682
					}
3683
3684
					/**
3685
					 * Outputs the header strings and necessary JS before each plugin installation.
3686
					 *
3687
					 * @since 2.2.0
3688
					 *
3689
					 * @param string $title Unused in this implementation.
3690
					 */
3691
					public function before( $title = '' ) {
3692
						if ( empty( $title ) ) {
3693
							$title = esc_html( $this->plugin_names[ $this->i ] );
3694
						}
3695
						parent::before( $title );
3696
					}
3697
3698
					/**
3699
					 * Outputs the footer strings and necessary JS after each plugin installation.
3700
					 *
3701
					 * Checks for any errors and outputs them if they exist, else output
3702
					 * success strings.
3703
					 *
3704
					 * @since 2.2.0
3705
					 *
3706
					 * @param string $title Unused in this implementation.
3707
					 */
3708
					public function after( $title = '' ) {
3709
						if ( empty( $title ) ) {
3710
							$title = esc_html( $this->plugin_names[ $this->i ] );
3711
						}
3712
						parent::after( $title );
3713
3714
						$this->i++;
3715
					}
3716
3717
					/**
3718
					 * Outputs links after bulk plugin installation is complete.
3719
					 *
3720
					 * @since 2.2.0
3721
					 */
3722
					public function bulk_footer() {
3723
						// Serve up the string to say installations (and possibly activations) are complete.
3724
						parent::bulk_footer();
3725
3726
						// Flush plugins cache so we can make sure that the installed plugins list is always up to date.
3727
						wp_clean_plugins_cache();
3728
3729
						$this->tgmpa->show_tgmpa_version();
3730
3731
						// Display message based on if all plugins are now active or not.
3732
						$update_actions = array();
3733
3734
						if ( $this->tgmpa->is_tgmpa_complete() ) {
3735
							// All plugins are active, so we display the complete string and hide the menu to protect users.
3736
							echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
3737
							$update_actions['dashboard'] = sprintf(
3738
								esc_html( $this->tgmpa->strings['complete'] ),
3739
								'<a href="' . esc_url( self_admin_url() ) . '">' . esc_html( $this->tgmpa->strings['dashboard'] ) . '</a>'
3740
							);
3741
						} else {
3742
							$update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
3743
						}
3744
3745
						/**
3746
						 * Filter the list of action links available following bulk plugin installs/updates.
3747
						 *
3748
						 * @since 2.5.0
3749
						 *
3750
						 * @param array $update_actions Array of plugin action links.
3751
						 * @param array $plugin_info    Array of information for the last-handled plugin.
3752
						 */
3753
						$update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
3754
3755
						if ( ! empty( $update_actions ) ) {
3756
							$this->feedback( implode( ' | ', (array) $update_actions ) );
3757
						}
3758
					}
3759
3760
					/* *********** DEPRECATED METHODS *********** */
3761
3762
					/**
3763
					 * Flush header output buffer.
3764
					 *
3765
					 * @since      2.2.0
3766
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3767
					 * @see        Bulk_Upgrader_Skin::flush_output()
3768
					 */
3769
					public function before_flush_output() {
3770
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3771
						$this->flush_output();
3772
					}
3773
3774
					/**
3775
					 * Flush footer output buffer and iterate $this->i to make sure the
3776
					 * installation strings reference the correct plugin.
3777
					 *
3778
					 * @since      2.2.0
3779
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3780
					 * @see        Bulk_Upgrader_Skin::flush_output()
3781
					 */
3782
					public function after_flush_output() {
3783
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3784
						$this->flush_output();
3785
						$this->i++;
3786
					}
3787
				}
3788
			}
3789
		}
3790
	}
3791
}
3792
3793
if ( ! class_exists( 'TGMPA_Utils' ) ) {
3794
3795
	/**
3796
	 * Generic utilities for TGMPA.
3797
	 *
3798
	 * All methods are static, poor-dev name-spacing class wrapper.
3799
	 *
3800
	 * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
3801
	 *
3802
	 * @since 2.5.0
3803
	 *
3804
	 * @package TGM-Plugin-Activation
3805
	 * @author  Juliette Reinders Folmer
3806
	 */
3807
	class TGMPA_Utils {
3808
		/**
3809
		 * Whether the PHP filter extension is enabled.
3810
		 *
3811
		 * @see http://php.net/book.filter
3812
		 *
3813
		 * @since 2.5.0
3814
		 *
3815
		 * @static
3816
		 *
3817
		 * @var bool $has_filters True is the extension is enabled.
3818
		 */
3819
		public static $has_filters;
3820
3821
		/**
3822
		 * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
3823
		 *
3824
		 * @since 2.5.0
3825
		 *
3826
		 * @static
3827
		 *
3828
		 * @param string $string Text to be wrapped.
3829
		 * @return string
3830
		 */
3831
		public static function wrap_in_em( $string ) {
3832
			return '<em>' . wp_kses_post( $string ) . '</em>';
3833
		}
3834
3835
		/**
3836
		 * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
3837
		 *
3838
		 * @since 2.5.0
3839
		 *
3840
		 * @static
3841
		 *
3842
		 * @param string $string Text to be wrapped.
3843
		 * @return string
3844
		 */
3845
		public static function wrap_in_strong( $string ) {
3846
			return '<strong>' . wp_kses_post( $string ) . '</strong>';
3847
		}
3848
3849
		/**
3850
		 * Helper function: Validate a value as boolean
3851
		 *
3852
		 * @since 2.5.0
3853
		 *
3854
		 * @static
3855
		 *
3856
		 * @param mixed $value Arbitrary value.
3857
		 * @return bool
3858
		 */
3859
		public static function validate_bool( $value ) {
3860
			if ( ! isset( self::$has_filters ) ) {
3861
				self::$has_filters = extension_loaded( 'filter' );
3862
			}
3863
3864
			if ( self::$has_filters ) {
3865
				return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
3866
			} else {
3867
				return self::emulate_filter_bool( $value );
3868
			}
3869
		}
3870
3871
		/**
3872
		 * Helper function: Cast a value to bool
3873
		 *
3874
		 * @since 2.5.0
3875
		 *
3876
		 * @static
3877
		 *
3878
		 * @param mixed $value Value to cast.
3879
		 * @return bool
3880
		 */
3881
		protected static function emulate_filter_bool( $value ) {
3882
			// @codingStandardsIgnoreStart
3883
			static $true  = array(
3884
				'1',
3885
				'true', 'True', 'TRUE',
3886
				'y', 'Y',
3887
				'yes', 'Yes', 'YES',
3888
				'on', 'On', 'ON',
3889
			);
3890
			static $false = array(
3891
				'0',
3892
				'false', 'False', 'FALSE',
3893
				'n', 'N',
3894
				'no', 'No', 'NO',
3895
				'off', 'Off', 'OFF',
3896
			);
3897
			// @codingStandardsIgnoreEnd
3898
3899
			if ( is_bool( $value ) ) {
3900
				return $value;
3901
			} elseif ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
3902
				return (bool) $value;
3903
			} elseif ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
3904
				return (bool) $value;
3905
			} elseif ( is_string( $value ) ) {
3906
				$value = trim( $value );
3907
				if ( in_array( $value, $true, true ) ) {
3908
					return true;
3909
				} elseif ( in_array( $value, $false, true ) ) {
3910
					return false;
3911
				} else {
3912
					return false;
3913
				}
3914
			}
3915
3916
			return false;
3917
		}
3918
	} // End of class TGMPA_Utils
3919
}
3920