Completed
Pull Request — develop (#788)
by
unknown
01:20
created

TGMPA_List_Table::row_actions()   A

Complexity

Conditions 4
Paths 4

Size

Total Lines 20

Duplication

Lines 0
Ratio 0 %

Importance

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