Completed
Push — develop ( ec6a3f...13c68e )
by Gary
10s
created

TGMPA_List_Table   D

Complexity

Total Complexity 119

Size/Duplication

Total Lines 927
Duplicated Lines 2.37 %

Coupling/Cohesion

Components 1
Dependencies 2

Importance

Changes 0
Metric Value
wmc 119
lcom 1
cbo 2
dl 22
loc 927
rs 4.4444
c 0
b 0
f 0

26 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 17 3
A get_table_classes() 0 3 1
B _gather_plugin_data() 0 46 4
C categorize_plugins_to_views() 0 31 7
A set_view_totals() 0 5 2
A get_plugin_advise_type_text() 0 7 2
A get_plugin_source_type_text() 0 17 4
C get_plugin_status_text() 0 34 8
A sort_table_items() 0 13 2
D get_views() 0 43 9
A column_default() 0 3 1
A column_cb() 0 8 1
A column_plugin() 0 7 1
D column_version() 0 44 10
A no_items() 0 4 1
A get_columns() 0 15 3
A get_default_primary_column_name() 0 3 1
A get_primary_column_name() 0 7 2
C get_row_actions() 0 46 8
A single_row() 0 15 1
A wp_plugin_update_row() 0 15 2
A extra_tablenav() 0 5 2
B get_bulk_actions() 0 21 7
F process_bulk_actions() 22 233 34
A prepare_items() 0 15 2
A _get_plugin_data_from_name() 0 5 1

How to fix   Duplicated Code    Complexity   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

Complex Class

 Tip:   Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like TGMPA_List_Table often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use TGMPA_List_Table, and based on these observations, apply Extract Interface, too.

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

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1. Pass all data via parameters

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

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

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

    public function myFunction() {
        // Do something
    }
}
Loading history...
1354
1355
			settings_errors( 'tgmpa' );
1356
1357
			foreach ( (array) $wp_settings_errors as $key => $details ) {
1358
				if ( 'tgmpa' === $details['setting'] ) {
1359
					unset( $wp_settings_errors[ $key ] );
1360
					break;
1361
				}
1362
			}
1363
		}
1364
1365
		/**
1366
		 * Register dismissal of admin notices.
1367
		 *
1368
		 * Acts on the dismiss link in the admin nag messages.
1369
		 * If clicked, the admin notice disappears and will no longer be visible to this user.
1370
		 *
1371
		 * @since 2.1.0
1372
		 */
1373
		public function dismiss() {
1374
			if ( isset( $_GET['tgmpa-dismiss'] ) && check_admin_referer( 'tgmpa-dismiss-' . get_current_user_id() ) ) {
1375
				update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
1376
			}
1377
		}
1378
1379
		/**
1380
		 * Add individual plugin to our collection of plugins.
1381
		 *
1382
		 * If the required keys are not set or the plugin has already
1383
		 * been registered, the plugin is not added.
1384
		 *
1385
		 * @since 2.0.0
1386
		 *
1387
		 * @param array|null $plugin Array of plugin arguments or null if invalid argument.
1388
		 * @return null Return early if incorrect argument.
1389
		 */
1390
		public function register( $plugin ) {
1391
			if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
1392
				return;
1393
			}
1394
1395
			if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
1396
				return;
1397
			}
1398
1399
			$defaults = array(
1400
				'name'               => '',      // String
1401
				'slug'               => '',      // String
1402
				'source'             => 'repo',  // String
1403
				'required'           => false,   // Boolean
1404
				'version'            => '',      // String
1405
				'force_activation'   => false,   // Boolean
1406
				'force_deactivation' => false,   // Boolean
1407
				'external_url'       => '',      // String
1408
				'is_callable'        => '',      // String|Array.
1409
			);
1410
1411
			// Prepare the received data.
1412
			$plugin = wp_parse_args( $plugin, $defaults );
1413
1414
			// Standardize the received slug.
1415
			$plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
1416
1417
			// Forgive users for using string versions of booleans or floats for version number.
1418
			$plugin['version']            = (string) $plugin['version'];
1419
			$plugin['source']             = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
1420
			$plugin['required']           = TGMPA_Utils::validate_bool( $plugin['required'] );
1421
			$plugin['force_activation']   = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
1422
			$plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
1423
1424
			// Enrich the received data.
1425
			$plugin['file_path']   = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
1426
			$plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
1427
1428
			// Set the class properties.
1429
			$this->plugins[ $plugin['slug'] ]    = $plugin;
1430
			$this->sort_order[ $plugin['slug'] ] = $plugin['name'];
1431
1432
			// Should we add the force activation hook ?
1433
			if ( true === $plugin['force_activation'] ) {
1434
				$this->has_forced_activation = true;
1435
			}
1436
1437
			// Should we add the force deactivation hook ?
1438
			if ( true === $plugin['force_deactivation'] ) {
1439
				$this->has_forced_deactivation = true;
1440
			}
1441
		}
1442
1443
		/**
1444
		 * Determine what type of source the plugin comes from.
1445
		 *
1446
		 * @since 2.5.0
1447
		 *
1448
		 * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
1449
		 *                       (= bundled) or an external URL.
1450
		 * @return string 'repo', 'external', or 'bundled'
1451
		 */
1452
		protected function get_plugin_source_type( $source ) {
1453
			if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
1454
				return 'repo';
1455
			} elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
1456
				return 'external';
1457
			} else {
1458
				return 'bundled';
1459
			}
1460
		}
1461
1462
		/**
1463
		 * Sanitizes a string key.
1464
		 *
1465
		 * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
1466
		 * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
1467
		 * characters in the plugin directory path/slug. Silly them.
1468
		 *
1469
		 * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
1470
		 *
1471
		 * @since 2.5.0
1472
		 *
1473
		 * @param string $key String key.
1474
		 * @return string Sanitized key
1475
		 */
1476
		public function sanitize_key( $key ) {
1477
			$raw_key = $key;
1478
			$key     = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
1479
1480
			/**
1481
			 * Filter a sanitized key string.
1482
			 *
1483
			 * @since 2.5.0
1484
			 *
1485
			 * @param string $key     Sanitized key.
1486
			 * @param string $raw_key The key prior to sanitization.
1487
			 */
1488
			return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
1489
		}
1490
1491
		/**
1492
		 * Amend default configuration settings.
1493
		 *
1494
		 * @since 2.0.0
1495
		 *
1496
		 * @param array $config Array of config options to pass as class properties.
1497
		 */
1498
		public function config( $config ) {
1499
			$keys = array(
1500
				'id',
1501
				'default_path',
1502
				'has_notices',
1503
				'dismissable',
1504
				'dismiss_msg',
1505
				'menu',
1506
				'parent_slug',
1507
				'capability',
1508
				'is_automatic',
1509
				'message',
1510
				'strings',
1511
			);
1512
1513
			foreach ( $keys as $key ) {
1514
				if ( isset( $config[ $key ] ) ) {
1515
					if ( is_array( $config[ $key ] ) ) {
1516
						$this->$key = array_merge( $this->$key, $config[ $key ] );
1517
					} else {
1518
						$this->$key = $config[ $key ];
1519
					}
1520
				}
1521
			}
1522
		}
1523
1524
		/**
1525
		 * Amend action link after plugin installation.
1526
		 *
1527
		 * @since 2.0.0
1528
		 *
1529
		 * @param array $install_actions Existing array of actions.
1530
		 * @return false|array Amended array of actions.
1531
		 */
1532
		public function actions( $install_actions ) {
1533
			// Remove action links on the TGMPA install page.
1534
			if ( $this->is_tgmpa_page() ) {
1535
				return false;
1536
			}
1537
1538
			return $install_actions;
1539
		}
1540
1541
		/**
1542
		 * Flushes the plugins cache on theme switch to prevent stale entries
1543
		 * from remaining in the plugin table.
1544
		 *
1545
		 * @since 2.4.0
1546
		 *
1547
		 * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
1548
		 *                                 Parameter added in v2.5.0.
1549
		 */
1550
		public function flush_plugins_cache( $clear_update_cache = true ) {
1551
			wp_clean_plugins_cache( $clear_update_cache );
1552
		}
1553
1554
		/**
1555
		 * Set file_path key for each installed plugin.
1556
		 *
1557
		 * @since 2.1.0
1558
		 *
1559
		 * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
1560
		 *                            Parameter added in v2.5.0.
1561
		 */
1562
		public function populate_file_path( $plugin_slug = '' ) {
1563
			if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
1564
				$this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
1565
			} else {
1566
				// Add file_path key for all plugins.
1567
				foreach ( $this->plugins as $slug => $values ) {
1568
					$this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
1569
				}
1570
			}
1571
		}
1572
1573
		/**
1574
		 * Helper function to extract the file path of the plugin file from the
1575
		 * plugin slug, if the plugin is installed.
1576
		 *
1577
		 * @since 2.0.0
1578
		 *
1579
		 * @param string $slug Plugin slug (typically folder name) as provided by the developer.
1580
		 * @return string Either file path for plugin if installed, or just the plugin slug.
1581
		 */
1582
		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...
1583
			$keys = array_keys( $this->get_plugins() );
1584
1585
			foreach ( $keys as $key ) {
1586
				if ( preg_match( '|^' . $slug . '/|', $key ) ) {
1587
					return $key;
1588
				}
1589
			}
1590
1591
			return $slug;
1592
		}
1593
1594
		/**
1595
		 * Retrieve plugin data, given the plugin name.
1596
		 *
1597
		 * Loops through the registered plugins looking for $name. If it finds it,
1598
		 * it returns the $data from that plugin. Otherwise, returns false.
1599
		 *
1600
		 * @since 2.1.0
1601
		 *
1602
		 * @param string $name Name of the plugin, as it was registered.
1603
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
1604
		 * @return string|boolean Plugin slug if found, false otherwise.
1605
		 */
1606
		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...
1607
			foreach ( $this->plugins as $values ) {
1608
				if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
1609
					return $values[ $data ];
1610
				}
1611
			}
1612
1613
			return false;
1614
		}
1615
1616
		/**
1617
		 * Retrieve the download URL for a package.
1618
		 *
1619
		 * @since 2.5.0
1620
		 *
1621
		 * @param string $slug Plugin slug.
1622
		 * @return string Plugin download URL or path to local file or empty string if undetermined.
1623
		 */
1624
		public function get_download_url( $slug ) {
1625
			$dl_source = '';
1626
1627
			switch ( $this->plugins[ $slug ]['source_type'] ) {
1628
				case 'repo':
1629
					return $this->get_wp_repo_download_url( $slug );
1630
				case 'external':
1631
					return $this->plugins[ $slug ]['source'];
1632
				case 'bundled':
1633
					return $this->default_path . $this->plugins[ $slug ]['source'];
1634
			}
1635
1636
			return $dl_source; // Should never happen.
1637
		}
1638
1639
		/**
1640
		 * Retrieve the download URL for a WP repo package.
1641
		 *
1642
		 * @since 2.5.0
1643
		 *
1644
		 * @param string $slug Plugin slug.
1645
		 * @return string Plugin download URL.
1646
		 */
1647
		protected function get_wp_repo_download_url( $slug ) {
1648
			$source = '';
1649
			$api    = $this->get_plugins_api( $slug );
1650
1651
			if ( false !== $api && isset( $api->download_link ) ) {
1652
				$source = $api->download_link;
1653
			}
1654
1655
			return $source;
1656
		}
1657
1658
		/**
1659
		 * Try to grab information from WordPress API.
1660
		 *
1661
		 * @since 2.5.0
1662
		 *
1663
		 * @param string $slug Plugin slug.
1664
		 * @return object Plugins_api response object on success, WP_Error on failure.
1665
		 */
1666
		protected function get_plugins_api( $slug ) {
1667
			static $api = array(); // Cache received responses.
1668
1669
			if ( ! isset( $api[ $slug ] ) ) {
1670
				if ( ! function_exists( 'plugins_api' ) ) {
1671
					require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
1672
				}
1673
1674
				$response = plugins_api(
1675
					'plugin_information',
1676
					array(
1677
						'slug'   => $slug,
1678
						'fields' => array(
1679
							'sections' => false,
1680
						),
1681
					)
1682
				);
1683
1684
				$api[ $slug ] = false;
1685
1686
				if ( is_wp_error( $response ) ) {
1687
					wp_die( esc_html( $this->strings['oops'] ) );
1688
				} else {
1689
					$api[ $slug ] = $response;
1690
				}
1691
			}
1692
1693
			return $api[ $slug ];
1694
		}
1695
1696
		/**
1697
		 * Retrieve a link to a plugin information page.
1698
		 *
1699
		 * @since 2.5.0
1700
		 *
1701
		 * @param string $slug Plugin slug.
1702
		 * @return string Fully formed html link to a plugin information page if available
1703
		 *                or the plugin name if not.
1704
		 */
1705
		public function get_info_link( $slug ) {
1706
			if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
1707
				$link = sprintf(
1708
					'<a href="%1$s" target="_blank">%2$s</a>',
1709
					esc_url( $this->plugins[ $slug ]['external_url'] ),
1710
					esc_html( $this->plugins[ $slug ]['name'] )
1711
				);
1712
			} elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
1713
				$url = add_query_arg(
1714
					array(
1715
						'tab'       => 'plugin-information',
1716
						'plugin'    => urlencode( $slug ),
1717
						'TB_iframe' => 'true',
1718
						'width'     => '640',
1719
						'height'    => '500',
1720
					),
1721
					self_admin_url( 'plugin-install.php' )
1722
				);
1723
1724
				$link = sprintf(
1725
					'<a href="%1$s" class="thickbox">%2$s</a>',
1726
					esc_url( $url ),
1727
					esc_html( $this->plugins[ $slug ]['name'] )
1728
				);
1729
			} else {
1730
				$link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
1731
			}
1732
1733
			return $link;
1734
		}
1735
1736
		/**
1737
		 * Determine if we're on the TGMPA Install page.
1738
		 *
1739
		 * @since 2.1.0
1740
		 *
1741
		 * @return boolean True when on the TGMPA page, false otherwise.
1742
		 */
1743
		protected function is_tgmpa_page() {
1744
			return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
1745
		}
1746
1747
		/**
1748
		 * Determine if we're on a WP Core installation/upgrade page.
1749
		 *
1750
		 * @since 2.6.0
1751
		 *
1752
		 * @return boolean True when on a WP Core installation/upgrade page, false otherwise.
1753
		 */
1754
		protected function is_core_update_page() {
1755
			// Current screen is not always available, most notably on the customizer screen.
1756
			if ( ! function_exists( 'get_current_screen' ) ) {
1757
				return false;
1758
			}
1759
1760
			$screen = get_current_screen();
1761
1762
			if ( 'update-core' === $screen->base ) {
1763
				// Core update screen.
1764
				return true;
1765
			} elseif ( 'plugins' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
1766
				// Plugins bulk update screen.
1767
				return true;
1768
			} elseif ( 'update' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
1769
				// Individual updates (ajax call).
1770
				return true;
1771
			}
1772
1773
			return false;
1774
		}
1775
1776
		/**
1777
		 * Retrieve the URL to the TGMPA Install page.
1778
		 *
1779
		 * I.e. depending on the config settings passed something along the lines of:
1780
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
1781
		 *
1782
		 * @since 2.5.0
1783
		 *
1784
		 * @return string Properly encoded URL (not escaped).
1785
		 */
1786
		public function get_tgmpa_url() {
1787
			static $url;
1788
1789
			if ( ! isset( $url ) ) {
1790
				$parent = $this->parent_slug;
1791
				if ( false === strpos( $parent, '.php' ) ) {
1792
					$parent = 'admin.php';
1793
				}
1794
				$url = add_query_arg(
1795
					array(
1796
						'page' => urlencode( $this->menu ),
1797
					),
1798
					self_admin_url( $parent )
1799
				);
1800
			}
1801
1802
			return $url;
1803
		}
1804
1805
		/**
1806
		 * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
1807
		 *
1808
		 * I.e. depending on the config settings passed something along the lines of:
1809
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install
1810
		 *
1811
		 * @since 2.5.0
1812
		 *
1813
		 * @param string $status Plugin status - either 'install', 'update' or 'activate'.
1814
		 * @return string Properly encoded URL (not escaped).
1815
		 */
1816
		public function get_tgmpa_status_url( $status ) {
1817
			return add_query_arg(
1818
				array(
1819
					'plugin_status' => urlencode( $status ),
1820
				),
1821
				$this->get_tgmpa_url()
1822
			);
1823
		}
1824
1825
		/**
1826
		 * Determine whether there are open actions for plugins registered with TGMPA.
1827
		 *
1828
		 * @since 2.5.0
1829
		 *
1830
		 * @return bool True if complete, i.e. no outstanding actions. False otherwise.
1831
		 */
1832
		public function is_tgmpa_complete() {
1833
			$complete = true;
1834
			foreach ( $this->plugins as $slug => $plugin ) {
1835
				if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1836
					$complete = false;
1837
					break;
1838
				}
1839
			}
1840
1841
			return $complete;
1842
		}
1843
1844
		/**
1845
		 * Check if a plugin is installed. Does not take must-use plugins into account.
1846
		 *
1847
		 * @since 2.5.0
1848
		 *
1849
		 * @param string $slug Plugin slug.
1850
		 * @return bool True if installed, false otherwise.
1851
		 */
1852
		public function is_plugin_installed( $slug ) {
1853
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1854
1855
			return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
1856
		}
1857
1858
		/**
1859
		 * Check if a plugin is active.
1860
		 *
1861
		 * @since 2.5.0
1862
		 *
1863
		 * @param string $slug Plugin slug.
1864
		 * @return bool True if active, false otherwise.
1865
		 */
1866
		public function is_plugin_active( $slug ) {
1867
			return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) ) || is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
1868
		}
1869
1870
		/**
1871
		 * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
1872
		 * available, check whether the current install meets them.
1873
		 *
1874
		 * @since 2.5.0
1875
		 *
1876
		 * @param string $slug Plugin slug.
1877
		 * @return bool True if OK to update, false otherwise.
1878
		 */
1879
		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...
1880
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1881
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1882
				return true;
1883
			}
1884
1885
			$api = $this->get_plugins_api( $slug );
1886
1887
			if ( false !== $api && isset( $api->requires ) ) {
1888
				return version_compare( $this->wp_version, $api->requires, '>=' );
1889
			}
1890
1891
			// No usable info received from the plugins API, presume we can update.
1892
			return true;
1893
		}
1894
1895
		/**
1896
		 * Check to see if the plugin is 'updatetable', i.e. installed, with an update available
1897
		 * and no WP version requirements blocking it.
1898
		 *
1899
		 * @since 2.6.0
1900
		 *
1901
		 * @param string $slug Plugin slug.
1902
		 * @return bool True if OK to proceed with update, false otherwise.
1903
		 */
1904
		public function is_plugin_updatetable( $slug ) {
1905
			if ( ! $this->is_plugin_installed( $slug ) ) {
1906
				return false;
1907
			} else {
1908
				return ( false !== $this->does_plugin_have_update( $slug ) && $this->can_plugin_update( $slug ) );
1909
			}
1910
		}
1911
1912
		/**
1913
		 * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
1914
		 * plugin version requirements set in TGMPA (if any).
1915
		 *
1916
		 * @since 2.5.0
1917
		 *
1918
		 * @param string $slug Plugin slug.
1919
		 * @return bool True if OK to activate, false otherwise.
1920
		 */
1921
		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...
1922
			return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
1923
		}
1924
1925
		/**
1926
		 * Retrieve the version number of an installed plugin.
1927
		 *
1928
		 * @since 2.5.0
1929
		 *
1930
		 * @param string $slug Plugin slug.
1931
		 * @return string Version number as string or an empty string if the plugin is not installed
1932
		 *                or version unknown (plugins which don't comply with the plugin header standard).
1933
		 */
1934
		public function get_installed_version( $slug ) {
1935
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1936
1937
			if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
1938
				return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
1939
			}
1940
1941
			return '';
1942
		}
1943
1944
		/**
1945
		 * Check whether a plugin complies with the minimum version requirements.
1946
		 *
1947
		 * @since 2.5.0
1948
		 *
1949
		 * @param string $slug Plugin slug.
1950
		 * @return bool True when a plugin needs to be updated, otherwise false.
1951
		 */
1952
		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...
1953
			$installed_version = $this->get_installed_version( $slug );
1954
			$minimum_version   = $this->plugins[ $slug ]['version'];
1955
1956
			return version_compare( $minimum_version, $installed_version, '>' );
1957
		}
1958
1959
		/**
1960
		 * Check whether there is an update available for a plugin.
1961
		 *
1962
		 * @since 2.5.0
1963
		 *
1964
		 * @param string $slug Plugin slug.
1965
		 * @return false|string Version number string of the available update or false if no update available.
1966
		 */
1967
		public function does_plugin_have_update( $slug ) {
1968
			// Presume bundled and external plugins will point to a package which meets the minimum required version.
1969
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1970
				if ( $this->does_plugin_require_update( $slug ) ) {
1971
					return $this->plugins[ $slug ]['version'];
1972
				}
1973
1974
				return false;
1975
			}
1976
1977
			$repo_updates = get_site_transient( 'update_plugins' );
1978
1979 View Code Duplication
			if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
1980
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
1981
			}
1982
1983
			return false;
1984
		}
1985
1986
		/**
1987
		 * Retrieve potential upgrade notice for a plugin.
1988
		 *
1989
		 * @since 2.5.0
1990
		 *
1991
		 * @param string $slug Plugin slug.
1992
		 * @return string The upgrade notice or an empty string if no message was available or provided.
1993
		 */
1994
		public function get_upgrade_notice( $slug ) {
1995
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1996
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1997
				return '';
1998
			}
1999
2000
			$repo_updates = get_site_transient( 'update_plugins' );
2001
2002 View Code Duplication
			if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
2003
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
2004
			}
2005
2006
			return '';
2007
		}
2008
2009
		/**
2010
		 * Wrapper around the core WP get_plugins function, making sure it's actually available.
2011
		 *
2012
		 * @since 2.5.0
2013
		 *
2014
		 * @param string $plugin_folder Optional. Relative path to single plugin folder.
2015
		 * @return array Array of installed plugins with plugin information.
2016
		 */
2017
		public function get_plugins( $plugin_folder = '' ) {
2018
			if ( ! function_exists( 'get_plugins' ) ) {
2019
				require_once ABSPATH . 'wp-admin/includes/plugin.php';
2020
			}
2021
2022
			return get_plugins( $plugin_folder );
2023
		}
2024
2025
		/**
2026
		 * Delete dismissable nag option when theme is switched.
2027
		 *
2028
		 * This ensures that the user(s) is/are again reminded via nag of required
2029
		 * and/or recommended plugins if they re-activate the theme.
2030
		 *
2031
		 * @since 2.1.1
2032
		 */
2033
		public function update_dismiss() {
2034
			delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
2035
		}
2036
2037
		/**
2038
		 * Forces plugin activation if the parameter 'force_activation' is
2039
		 * set to true.
2040
		 *
2041
		 * This allows theme authors to specify certain plugins that must be
2042
		 * active at all times while using the current theme.
2043
		 *
2044
		 * Please take special care when using this parameter as it has the
2045
		 * potential to be harmful if not used correctly. Setting this parameter
2046
		 * to true will not allow the specified plugin to be deactivated unless
2047
		 * the user switches themes.
2048
		 *
2049
		 * @since 2.2.0
2050
		 */
2051
		public function force_activation() {
2052
			foreach ( $this->plugins as $slug => $plugin ) {
2053
				if ( true === $plugin['force_activation'] ) {
2054
					if ( ! $this->is_plugin_installed( $slug ) ) {
2055
						// Oops, plugin isn't there so iterate to next condition.
2056
						continue;
2057
					} elseif ( $this->can_plugin_activate( $slug ) ) {
2058
						// There we go, activate the plugin.
2059
						activate_plugin( $plugin['file_path'] );
2060
					}
2061
				}
2062
			}
2063
		}
2064
2065
		/**
2066
		 * Forces plugin deactivation if the parameter 'force_deactivation'
2067
		 * is set to true and adds the plugin to the 'recently active' plugins list.
2068
		 *
2069
		 * This allows theme authors to specify certain plugins that must be
2070
		 * deactivated upon switching from the current theme to another.
2071
		 *
2072
		 * Please take special care when using this parameter as it has the
2073
		 * potential to be harmful if not used correctly.
2074
		 *
2075
		 * @since 2.2.0
2076
		 */
2077
		public function force_deactivation() {
2078
			$deactivated = array();
2079
2080
			foreach ( $this->plugins as $slug => $plugin ) {
2081
				/*
2082
				 * Only proceed forward if the parameter is set to true and plugin is active
2083
				 * as a 'normal' (not must-use) plugin.
2084
				 */
2085
				if ( true === $plugin['force_deactivation'] && is_plugin_active( $plugin['file_path'] ) ) {
2086
					deactivate_plugins( $plugin['file_path'] );
2087
					$deactivated[ $plugin['file_path'] ] = time();
2088
				}
2089
			}
2090
2091
			if ( ! empty( $deactivated ) ) {
2092
				update_option( 'recently_activated', $deactivated + (array) get_option( 'recently_activated' ) );
2093
			}
2094
		}
2095
2096
		/**
2097
		 * Echo the current TGMPA version number to the page.
2098
		 *
2099
		 * @since 2.5.0
2100
		 */
2101
		public function show_tgmpa_version() {
2102
			echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
2103
				esc_html(
2104
					sprintf(
2105
						/* translators: %s: version number */
2106
						__( 'TGMPA v%s', 'tgmpa' ),
2107
						self::TGMPA_VERSION
2108
					)
2109
				),
2110
				'</small></strong></p>';
2111
		}
2112
2113
		/**
2114
		 * Adds CSS to admin head.
2115
		 *
2116
		 * @since 2.6.2
2117
		 */
2118
		public function admin_css() {
2119
			if ( ! $this->is_tgmpa_page() ) {
2120
				return;
2121
			}
2122
2123
			echo '
2124
			<style>
2125
			#tgmpa-plugins .tgmpa-type-required > th {
2126
				border-left: 3px solid #dc3232;
2127
			}
2128
			</style>';
2129
		}
2130
2131
		/**
2132
		 * Returns the singleton instance of the class.
2133
		 *
2134
		 * @since 2.4.0
2135
		 *
2136
		 * @return \TGM_Plugin_Activation The TGM_Plugin_Activation object.
2137
		 */
2138
		public static function get_instance() {
2139
			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
2140
				self::$instance = new self();
2141
			}
2142
2143
			return self::$instance;
2144
		}
2145
	}
2146
2147
	if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
2148
		/**
2149
		 * Ensure only one instance of the class is ever invoked.
2150
		 *
2151
		 * @since 2.5.0
2152
		 */
2153
		function load_tgm_plugin_activation() {
2154
			$GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
2155
		}
2156
	}
2157
2158
	if ( did_action( 'plugins_loaded' ) ) {
2159
		load_tgm_plugin_activation();
2160
	} else {
2161
		add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
2162
	}
2163
}
2164
2165
if ( ! function_exists( 'tgmpa' ) ) {
2166
	/**
2167
	 * Helper function to register a collection of required plugins.
2168
	 *
2169
	 * @since 2.0.0
2170
	 * @api
2171
	 *
2172
	 * @param array $plugins An array of plugin arrays.
2173
	 * @param array $config  Optional. An array of configuration values.
2174
	 */
2175
	function tgmpa( $plugins, $config = array() ) {
2176
		$instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2177
2178
		foreach ( $plugins as $plugin ) {
2179
			call_user_func( array( $instance, 'register' ), $plugin );
2180
		}
2181
2182
		if ( ! empty( $config ) && is_array( $config ) ) {
2183
			// Send out notices for deprecated arguments passed.
2184
			if ( isset( $config['notices'] ) ) {
2185
				_deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
2186
				if ( ! isset( $config['has_notices'] ) ) {
2187
					$config['has_notices'] = $config['notices'];
2188
				}
2189
			}
2190
2191
			if ( isset( $config['parent_menu_slug'] ) ) {
2192
				_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.' );
2193
			}
2194
			if ( isset( $config['parent_url_slug'] ) ) {
2195
				_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.' );
2196
			}
2197
2198
			call_user_func( array( $instance, 'config' ), $config );
2199
		}
2200
	}
2201
}
2202
2203
/**
2204
 * WP_List_Table isn't always available. If it isn't available,
2205
 * we load it here.
2206
 *
2207
 * @since 2.2.0
2208
 */
2209
if ( ! class_exists( 'WP_List_Table' ) ) {
2210
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
2211
}
2212
2213
if ( ! class_exists( 'TGMPA_List_Table' ) ) {
2214
2215
	/**
2216
	 * List table class for handling plugins.
2217
	 *
2218
	 * Extends the WP_List_Table class to provide a future-compatible
2219
	 * way of listing out all required/recommended plugins.
2220
	 *
2221
	 * Gives users an interface similar to the Plugin Administration
2222
	 * area with similar (albeit stripped down) capabilities.
2223
	 *
2224
	 * This class also allows for the bulk install of plugins.
2225
	 *
2226
	 * @since 2.2.0
2227
	 *
2228
	 * @package TGM-Plugin-Activation
2229
	 * @author  Thomas Griffin
2230
	 * @author  Gary Jones
2231
	 */
2232
	class TGMPA_List_Table extends WP_List_Table {
2233
		/**
2234
		 * TGMPA instance.
2235
		 *
2236
		 * @since 2.5.0
2237
		 *
2238
		 * @var object
2239
		 */
2240
		protected $tgmpa;
2241
2242
		/**
2243
		 * The currently chosen view.
2244
		 *
2245
		 * @since 2.5.0
2246
		 *
2247
		 * @var string One of: 'all', 'install', 'update', 'activate'
2248
		 */
2249
		public $view_context = 'all';
2250
2251
		/**
2252
		 * The plugin counts for the various views.
2253
		 *
2254
		 * @since 2.5.0
2255
		 *
2256
		 * @var array
2257
		 */
2258
		protected $view_totals = array(
2259
			'all'      => 0,
2260
			'install'  => 0,
2261
			'update'   => 0,
2262
			'activate' => 0,
2263
		);
2264
2265
		/**
2266
		 * References parent constructor and sets defaults for class.
2267
		 *
2268
		 * @since 2.2.0
2269
		 */
2270
		public function __construct() {
2271
			$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2272
2273
			parent::__construct(
2274
				array(
2275
					'singular' => 'plugin',
2276
					'plural'   => 'plugins',
2277
					'ajax'     => false,
2278
				)
2279
			);
2280
2281
			if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
2282
				$this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
2283
			}
2284
2285
			add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
2286
		}
2287
2288
		/**
2289
		 * Get a list of CSS classes for the <table> tag.
2290
		 *
2291
		 * Overruled to prevent the 'plural' argument from being added.
2292
		 *
2293
		 * @since 2.5.0
2294
		 *
2295
		 * @return array CSS classnames.
2296
		 */
2297
		public function get_table_classes() {
2298
			return array( 'widefat', 'fixed' );
2299
		}
2300
2301
		/**
2302
		 * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
2303
		 *
2304
		 * @since 2.2.0
2305
		 *
2306
		 * @return array $table_data Information for use in table.
2307
		 */
2308
		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...
2309
			// Load thickbox for plugin links.
2310
			$this->tgmpa->admin_init();
2311
			$this->tgmpa->thickbox();
2312
2313
			// Categorize the plugins which have open actions.
2314
			$plugins = $this->categorize_plugins_to_views();
2315
2316
			// Set the counts for the view links.
2317
			$this->set_view_totals( $plugins );
2318
2319
			// Prep variables for use and grab list of all installed plugins.
2320
			$table_data = array();
2321
			$i          = 0;
2322
2323
			// Redirect to the 'all' view if no plugins were found for the selected view context.
2324
			if ( empty( $plugins[ $this->view_context ] ) ) {
2325
				$this->view_context = 'all';
2326
			}
2327
2328
			foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
2329
				$table_data[ $i ]['sanitized_plugin']  = $plugin['name'];
2330
				$table_data[ $i ]['slug']              = $slug;
2331
				$table_data[ $i ]['plugin']            = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
2332
				$table_data[ $i ]['source']            = $this->get_plugin_source_type_text( $plugin['source_type'] );
2333
				$table_data[ $i ]['type']              = $this->get_plugin_advise_type_text( $plugin['required'] );
2334
				$table_data[ $i ]['status']            = $this->get_plugin_status_text( $slug );
2335
				$table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
2336
				$table_data[ $i ]['minimum_version']   = $plugin['version'];
2337
				$table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
2338
2339
				// Prep the upgrade notice info.
2340
				$upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
2341
				if ( ! empty( $upgrade_notice ) ) {
2342
					$table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
2343
2344
					add_action( "tgmpa_after_plugin_row_{$slug}", array( $this, 'wp_plugin_update_row' ), 10, 2 );
2345
				}
2346
2347
				$table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
2348
2349
				$i++;
2350
			}
2351
2352
			return $table_data;
2353
		}
2354
2355
		/**
2356
		 * Categorize the plugins which have open actions into views for the TGMPA page.
2357
		 *
2358
		 * @since 2.5.0
2359
		 */
2360
		protected function categorize_plugins_to_views() {
2361
			$plugins = array(
2362
				'all'      => array(), // Meaning: all plugins which still have open actions.
2363
				'install'  => array(),
2364
				'update'   => array(),
2365
				'activate' => array(),
2366
			);
2367
2368
			foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
2369
				if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2370
					// No need to display plugins if they are installed, up-to-date and active.
2371
					continue;
2372
				} else {
2373
					$plugins['all'][ $slug ] = $plugin;
2374
2375
					if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2376
						$plugins['install'][ $slug ] = $plugin;
2377
					} else {
2378
						if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2379
							$plugins['update'][ $slug ] = $plugin;
2380
						}
2381
2382
						if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2383
							$plugins['activate'][ $slug ] = $plugin;
2384
						}
2385
					}
2386
				}
2387
			}
2388
2389
			return $plugins;
2390
		}
2391
2392
		/**
2393
		 * Set the counts for the view links.
2394
		 *
2395
		 * @since 2.5.0
2396
		 *
2397
		 * @param array $plugins Plugins order by view.
2398
		 */
2399
		protected function set_view_totals( $plugins ) {
2400
			foreach ( $plugins as $type => $list ) {
2401
				$this->view_totals[ $type ] = count( $list );
2402
			}
2403
		}
2404
2405
		/**
2406
		 * Get the plugin required/recommended text string.
2407
		 *
2408
		 * @since 2.5.0
2409
		 *
2410
		 * @param string $required Plugin required setting.
2411
		 * @return string
2412
		 */
2413
		protected function get_plugin_advise_type_text( $required ) {
2414
			if ( true === $required ) {
2415
				return __( 'Required', 'tgmpa' );
2416
			}
2417
2418
			return __( 'Recommended', 'tgmpa' );
2419
		}
2420
2421
		/**
2422
		 * Get the plugin source type text string.
2423
		 *
2424
		 * @since 2.5.0
2425
		 *
2426
		 * @param string $type Plugin type.
2427
		 * @return string
2428
		 */
2429
		protected function get_plugin_source_type_text( $type ) {
2430
			$string = '';
2431
2432
			switch ( $type ) {
2433
				case 'repo':
2434
					$string = __( 'WordPress Repository', 'tgmpa' );
2435
					break;
2436
				case 'external':
2437
					$string = __( 'External Source', 'tgmpa' );
2438
					break;
2439
				case 'bundled':
2440
					$string = __( 'Pre-Packaged', 'tgmpa' );
2441
					break;
2442
			}
2443
2444
			return $string;
2445
		}
2446
2447
		/**
2448
		 * Determine the plugin status message.
2449
		 *
2450
		 * @since 2.5.0
2451
		 *
2452
		 * @param string $slug Plugin slug.
2453
		 * @return string
2454
		 */
2455
		protected function get_plugin_status_text( $slug ) {
2456
			if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2457
				return __( 'Not Installed', 'tgmpa' );
2458
			}
2459
2460
			if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
2461
				$install_status = __( 'Installed But Not Activated', 'tgmpa' );
2462
			} else {
2463
				$install_status = __( 'Active', 'tgmpa' );
2464
			}
2465
2466
			$update_status = '';
2467
2468
			if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2469
				$update_status = __( 'Required Update not Available', 'tgmpa' );
2470
2471
			} elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
2472
				$update_status = __( 'Requires Update', 'tgmpa' );
2473
2474
			} elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2475
				$update_status = __( 'Update recommended', 'tgmpa' );
2476
			}
2477
2478
			if ( '' === $update_status ) {
2479
				return $install_status;
2480
			}
2481
2482
			return sprintf(
2483
				/* translators: 1: install status, 2: update status */
2484
				_x( '%1$s, %2$s', 'Install/Update Status', 'tgmpa' ),
2485
				$install_status,
2486
				$update_status
2487
			);
2488
		}
2489
2490
		/**
2491
		 * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
2492
		 *
2493
		 * @since 2.5.0
2494
		 *
2495
		 * @param array $items Prepared table items.
2496
		 * @return array Sorted table items.
2497
		 */
2498
		public function sort_table_items( $items ) {
2499
			$type = array();
2500
			$name = array();
2501
2502
			foreach ( $items as $i => $plugin ) {
2503
				$type[ $i ] = $plugin['type']; // Required / recommended.
2504
				$name[ $i ] = $plugin['sanitized_plugin'];
2505
			}
2506
2507
			array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
2508
2509
			return $items;
2510
		}
2511
2512
		/**
2513
		 * Get an associative array ( id => link ) of the views available on this table.
2514
		 *
2515
		 * @since 2.5.0
2516
		 *
2517
		 * @return array
2518
		 */
2519
		public function get_views() {
2520
			$status_links = array();
2521
2522
			foreach ( $this->view_totals as $type => $count ) {
2523
				if ( $count < 1 ) {
2524
					continue;
2525
				}
2526
2527
				switch ( $type ) {
2528
					case 'all':
2529
						/* translators: 1: number of plugins. */
2530
						$text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
2531
						break;
2532
					case 'install':
2533
						/* translators: 1: number of plugins. */
2534
						$text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
2535
						break;
2536
					case 'update':
2537
						/* translators: 1: number of plugins. */
2538
						$text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
2539
						break;
2540
					case 'activate':
2541
						/* translators: 1: number of plugins. */
2542
						$text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
2543
						break;
2544
					default:
2545
						$text = '';
2546
						break;
2547
				}
2548
2549
				if ( ! empty( $text ) ) {
2550
2551
					$status_links[ $type ] = sprintf(
2552
						'<a href="%s"%s>%s</a>',
2553
						esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
2554
						( $type === $this->view_context ) ? ' class="current"' : '',
2555
						sprintf( $text, number_format_i18n( $count ) )
2556
					);
2557
				}
2558
			}
2559
2560
			return $status_links;
2561
		}
2562
2563
		/**
2564
		 * Create default columns to display important plugin information
2565
		 * like type, action and status.
2566
		 *
2567
		 * @since 2.2.0
2568
		 *
2569
		 * @param array  $item        Array of item data.
2570
		 * @param string $column_name The name of the column.
2571
		 * @return string
2572
		 */
2573
		public function column_default( $item, $column_name ) {
2574
			return $item[ $column_name ];
2575
		}
2576
2577
		/**
2578
		 * Required for bulk installing.
2579
		 *
2580
		 * Adds a checkbox for each plugin.
2581
		 *
2582
		 * @since 2.2.0
2583
		 *
2584
		 * @param array $item Array of item data.
2585
		 * @return string The input checkbox with all necessary info.
2586
		 */
2587
		public function column_cb( $item ) {
2588
			return sprintf(
2589
				'<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
2590
				esc_attr( $this->_args['singular'] ),
2591
				esc_attr( $item['slug'] ),
2592
				esc_attr( $item['sanitized_plugin'] )
2593
			);
2594
		}
2595
2596
		/**
2597
		 * Create default title column along with the action links.
2598
		 *
2599
		 * @since 2.2.0
2600
		 *
2601
		 * @param array $item Array of item data.
2602
		 * @return string The plugin name and action links.
2603
		 */
2604
		public function column_plugin( $item ) {
2605
			return sprintf(
2606
				'%1$s %2$s',
2607
				$item['plugin'],
2608
				$this->row_actions( $this->get_row_actions( $item ), true )
2609
			);
2610
		}
2611
2612
		/**
2613
		 * Create version information column.
2614
		 *
2615
		 * @since 2.5.0
2616
		 *
2617
		 * @param array $item Array of item data.
2618
		 * @return string HTML-formatted version information.
2619
		 */
2620
		public function column_version( $item ) {
2621
			$output = array();
2622
2623
			if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2624
				$installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
2625
2626
				$color = '';
2627
				if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
2628
					$color = ' color: #ff0000; font-weight: bold;';
2629
				}
2630
2631
				$output[] = sprintf(
2632
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
2633
					$color,
2634
					$installed
2635
				);
2636
			}
2637
2638
			if ( ! empty( $item['minimum_version'] ) ) {
2639
				$output[] = sprintf(
2640
					'<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
2641
					$item['minimum_version']
2642
				);
2643
			}
2644
2645
			if ( ! empty( $item['available_version'] ) ) {
2646
				$color = '';
2647
				if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
2648
					$color = ' color: #71C671; font-weight: bold;';
2649
				}
2650
2651
				$output[] = sprintf(
2652
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
2653
					$color,
2654
					$item['available_version']
2655
				);
2656
			}
2657
2658
			if ( empty( $output ) ) {
2659
				return '&nbsp;'; // Let's not break the table layout.
2660
			} else {
2661
				return implode( "\n", $output );
2662
			}
2663
		}
2664
2665
		/**
2666
		 * Sets default message within the plugins table if no plugins
2667
		 * are left for interaction.
2668
		 *
2669
		 * Hides the menu item to prevent the user from clicking and
2670
		 * getting a permissions error.
2671
		 *
2672
		 * @since 2.2.0
2673
		 */
2674
		public function no_items() {
2675
			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>';
2676
			echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
2677
		}
2678
2679
		/**
2680
		 * Output all the column information within the table.
2681
		 *
2682
		 * @since 2.2.0
2683
		 *
2684
		 * @return array $columns The column names.
2685
		 */
2686
		public function get_columns() {
2687
			$columns = array(
2688
				'cb'     => '<input type="checkbox" />',
2689
				'plugin' => __( 'Plugin', 'tgmpa' ),
2690
				'source' => __( 'Source', 'tgmpa' ),
2691
				'type'   => __( 'Type', 'tgmpa' ),
2692
			);
2693
2694
			if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
2695
				$columns['version'] = __( 'Version', 'tgmpa' );
2696
				$columns['status']  = __( 'Status', 'tgmpa' );
2697
			}
2698
2699
			return apply_filters( 'tgmpa_table_columns', $columns );
2700
		}
2701
2702
		/**
2703
		 * Get name of default primary column
2704
		 *
2705
		 * @since 2.5.0 / WP 4.3+ compatibility
2706
		 * @access protected
2707
		 *
2708
		 * @return string
2709
		 */
2710
		protected function get_default_primary_column_name() {
2711
			return 'plugin';
2712
		}
2713
2714
		/**
2715
		 * Get the name of the primary column.
2716
		 *
2717
		 * @since 2.5.0 / WP 4.3+ compatibility
2718
		 * @access protected
2719
		 *
2720
		 * @return string The name of the primary column.
2721
		 */
2722
		protected function get_primary_column_name() {
2723
			if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
2724
				return parent::get_primary_column_name();
2725
			} else {
2726
				return $this->get_default_primary_column_name();
2727
			}
2728
		}
2729
2730
		/**
2731
		 * Get the actions which are relevant for a specific plugin row.
2732
		 *
2733
		 * @since 2.5.0
2734
		 *
2735
		 * @param array $item Array of item data.
2736
		 * @return array Array with relevant action links.
2737
		 */
2738
		protected function get_row_actions( $item ) {
2739
			$actions      = array();
2740
			$action_links = array();
2741
2742
			// Display the 'Install' action link if the plugin is not yet available.
2743
			if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2744
				/* translators: %2$s: plugin name in screen reader markup */
2745
				$actions['install'] = __( 'Install %2$s', 'tgmpa' );
2746
			} else {
2747
				// Display the 'Update' action link if an update is available and WP complies with plugin minimum.
2748
				if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
2749
					/* translators: %2$s: plugin name in screen reader markup */
2750
					$actions['update'] = __( 'Update %2$s', 'tgmpa' );
2751
				}
2752
2753
				// Display the 'Activate' action link, but only if the plugin meets the minimum version.
2754
				if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
2755
					/* translators: %2$s: plugin name in screen reader markup */
2756
					$actions['activate'] = __( 'Activate %2$s', 'tgmpa' );
2757
				}
2758
			}
2759
2760
			// Create the actual links.
2761
			foreach ( $actions as $action => $text ) {
2762
				$nonce_url = wp_nonce_url(
2763
					add_query_arg(
2764
						array(
2765
							'plugin'           => urlencode( $item['slug'] ),
2766
							'tgmpa-' . $action => $action . '-plugin',
2767
						),
2768
						$this->tgmpa->get_tgmpa_url()
2769
					),
2770
					'tgmpa-' . $action,
2771
					'tgmpa-nonce'
2772
				);
2773
2774
				$action_links[ $action ] = sprintf(
2775
					'<a href="%1$s">' . esc_html( $text ) . '</a>', // $text contains the second placeholder.
2776
					esc_url( $nonce_url ),
2777
					'<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
2778
				);
2779
			}
2780
2781
			$prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
2782
			return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
2783
		}
2784
2785
		/**
2786
		 * Generates content for a single row of the table.
2787
		 *
2788
		 * @since 2.5.0
2789
		 *
2790
		 * @param object $item The current item.
2791
		 */
2792
		public function single_row( $item ) {
2793
			echo '<tr class="' . esc_attr( 'tgmpa-type-' . strtolower( $item['type'] ) ) . '">';
2794
			$this->single_row_columns( $item );
2795
			echo '</tr>';
2796
2797
			/**
2798
			 * Fires after each specific row in the TGMPA Plugins list table.
2799
			 *
2800
			 * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
2801
			 * for the plugin.
2802
			 *
2803
			 * @since 2.5.0
2804
			 */
2805
			do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
2806
		}
2807
2808
		/**
2809
		 * Show the upgrade notice below a plugin row if there is one.
2810
		 *
2811
		 * @since 2.5.0
2812
		 *
2813
		 * @see /wp-admin/includes/update.php
2814
		 *
2815
		 * @param string $slug Plugin slug.
2816
		 * @param array  $item The information available in this table row.
2817
		 * @return null Return early if upgrade notice is empty.
2818
		 */
2819
		public function wp_plugin_update_row( $slug, $item ) {
2820
			if ( empty( $item['upgrade_notice'] ) ) {
2821
				return;
2822
			}
2823
2824
			echo '
2825
				<tr class="plugin-update-tr">
2826
					<td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
2827
						<div class="update-message">',
2828
							esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
2829
							' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
2830
						</div>
2831
					</td>
2832
				</tr>';
2833
		}
2834
2835
		/**
2836
		 * Extra controls to be displayed between bulk actions and pagination.
2837
		 *
2838
		 * @since 2.5.0
2839
		 *
2840
		 * @param string $which 'top' or 'bottom' table navigation.
2841
		 */
2842
		public function extra_tablenav( $which ) {
2843
			if ( 'bottom' === $which ) {
2844
				$this->tgmpa->show_tgmpa_version();
2845
			}
2846
		}
2847
2848
		/**
2849
		 * Defines the bulk actions for handling registered plugins.
2850
		 *
2851
		 * @since 2.2.0
2852
		 *
2853
		 * @return array $actions The bulk actions for the plugin install table.
2854
		 */
2855
		public function get_bulk_actions() {
2856
2857
			$actions = array();
2858
2859
			if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
2860
				if ( current_user_can( 'install_plugins' ) ) {
2861
					$actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
2862
				}
2863
			}
2864
2865
			if ( 'install' !== $this->view_context ) {
2866
				if ( current_user_can( 'update_plugins' ) ) {
2867
					$actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
2868
				}
2869
				if ( current_user_can( 'activate_plugins' ) ) {
2870
					$actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
2871
				}
2872
			}
2873
2874
			return $actions;
2875
		}
2876
2877
		/**
2878
		 * Processes bulk installation and activation actions.
2879
		 *
2880
		 * The bulk installation process looks for the $_POST information and passes that
2881
		 * through if a user has to use WP_Filesystem to enter their credentials.
2882
		 *
2883
		 * @since 2.2.0
2884
		 */
2885
		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...
2886
			// Bulk installation process.
2887
			if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
2888
2889
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2890
2891
				$install_type = 'install';
2892
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2893
					$install_type = 'update';
2894
				}
2895
2896
				$plugins_to_install = array();
2897
2898
				// Did user actually select any plugins to install/update ?
2899 View Code Duplication
				if ( empty( $_POST['plugin'] ) ) {
2900
					if ( 'install' === $install_type ) {
2901
						$message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
2902
					} else {
2903
						$message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
2904
					}
2905
2906
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2907
2908
					return false;
2909
				}
2910
2911
				if ( is_array( $_POST['plugin'] ) ) {
2912
					$plugins_to_install = (array) $_POST['plugin'];
2913
				} elseif ( is_string( $_POST['plugin'] ) ) {
2914
					// Received via Filesystem page - un-flatten array (WP bug #19643).
2915
					$plugins_to_install = explode( ',', $_POST['plugin'] );
2916
				}
2917
2918
				// Sanitize the received input.
2919
				$plugins_to_install = array_map( 'urldecode', $plugins_to_install );
2920
				$plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
2921
2922
				// Validate the received input.
2923
				foreach ( $plugins_to_install as $key => $slug ) {
2924
					// Check if the plugin was registered with TGMPA and remove if not.
2925
					if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
2926
						unset( $plugins_to_install[ $key ] );
2927
						continue;
2928
					}
2929
2930
					// For install: make sure this is a plugin we *can* install and not one already installed.
2931
					if ( 'install' === $install_type && true === $this->tgmpa->is_plugin_installed( $slug ) ) {
2932
						unset( $plugins_to_install[ $key ] );
2933
					}
2934
2935
					// For updates: make sure this is a plugin we *can* update (update available and WP version ok).
2936
					if ( 'update' === $install_type && false === $this->tgmpa->is_plugin_updatetable( $slug ) ) {
2937
						unset( $plugins_to_install[ $key ] );
2938
					}
2939
				}
2940
2941
				// No need to proceed further if we have no plugins to handle.
2942 View Code Duplication
				if ( empty( $plugins_to_install ) ) {
2943
					if ( 'install' === $install_type ) {
2944
						$message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
2945
					} else {
2946
						$message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
2947
					}
2948
2949
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2950
2951
					return false;
2952
				}
2953
2954
				// Pass all necessary information if WP_Filesystem is needed.
2955
				$url = wp_nonce_url(
2956
					$this->tgmpa->get_tgmpa_url(),
2957
					'bulk-' . $this->_args['plural']
2958
				);
2959
2960
				// Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
2961
				$_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
2962
2963
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
2964
				$fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
2965
2966
				$creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields );
2967
				if ( false === $creds ) {
2968
					return true; // Stop the normal page form from displaying, credential request form will be shown.
2969
				}
2970
2971
				// Now we have some credentials, setup WP_Filesystem.
2972
				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...
2973
					// Our credentials were no good, ask the user for them again.
2974
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
2975
2976
					return true;
2977
				}
2978
2979
				/* If we arrive here, we have the filesystem */
2980
2981
				// Store all information in arrays since we are processing a bulk installation.
2982
				$names      = array();
2983
				$sources    = array(); // Needed for installs.
2984
				$file_paths = array(); // Needed for upgrades.
2985
				$to_inject  = array(); // Information to inject into the update_plugins transient.
2986
2987
				// Prepare the data for validated plugins for the install/upgrade.
2988
				foreach ( $plugins_to_install as $slug ) {
2989
					$name   = $this->tgmpa->plugins[ $slug ]['name'];
2990
					$source = $this->tgmpa->get_download_url( $slug );
2991
2992
					if ( ! empty( $name ) && ! empty( $source ) ) {
2993
						$names[] = $name;
2994
2995
						switch ( $install_type ) {
2996
2997
							case 'install':
2998
								$sources[] = $source;
2999
								break;
3000
3001
							case 'update':
3002
								$file_paths[]                 = $this->tgmpa->plugins[ $slug ]['file_path'];
3003
								$to_inject[ $slug ]           = $this->tgmpa->plugins[ $slug ];
3004
								$to_inject[ $slug ]['source'] = $source;
3005
								break;
3006
						}
3007
					}
3008
				}
3009
				unset( $slug, $name, $source );
3010
3011
				// Create a new instance of TGMPA_Bulk_Installer.
3012
				$installer = new TGMPA_Bulk_Installer(
3013
					new TGMPA_Bulk_Installer_Skin(
3014
						array(
3015
							'url'          => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
3016
							'nonce'        => 'bulk-' . $this->_args['plural'],
3017
							'names'        => $names,
3018
							'install_type' => $install_type,
3019
						)
3020
					)
3021
				);
3022
3023
				// Wrap the install process with the appropriate HTML.
3024
				echo '<div class="tgmpa">',
3025
					'<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>
3026
					<div class="update-php" style="width: 100%; height: 98%; min-height: 850px; padding-top: 1px;">';
3027
3028
				// Process the bulk installation submissions.
3029
				add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
3030
3031
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
3032
					// Inject our info into the update transient.
3033
					$this->tgmpa->inject_update_info( $to_inject );
3034
3035
					$installer->bulk_upgrade( $file_paths );
3036
				} else {
3037
					$installer->bulk_install( $sources );
3038
				}
3039
3040
				remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1 );
3041
3042
				echo '</div></div>';
3043
3044
				return true;
3045
			}
3046
3047
			// Bulk activation process.
3048
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3049
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
3050
3051
				// Did user actually select any plugins to activate ?
3052
				if ( empty( $_POST['plugin'] ) ) {
3053
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
3054
3055
					return false;
3056
				}
3057
3058
				// Grab plugin data from $_POST.
3059
				$plugins = array();
3060
				if ( isset( $_POST['plugin'] ) ) {
3061
					$plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
3062
					$plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
3063
				}
3064
3065
				$plugins_to_activate = array();
3066
				$plugin_names        = array();
3067
3068
				// Grab the file paths for the selected & inactive plugins from the registration array.
3069
				foreach ( $plugins as $slug ) {
3070
					if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
3071
						$plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
3072
						$plugin_names[]        = $this->tgmpa->plugins[ $slug ]['name'];
3073
					}
3074
				}
3075
				unset( $slug );
3076
3077
				// Return early if there are no plugins to activate.
3078
				if ( empty( $plugins_to_activate ) ) {
3079
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
3080
3081
					return false;
3082
				}
3083
3084
				// Now we are good to go - let's start activating plugins.
3085
				$activate = activate_plugins( $plugins_to_activate );
3086
3087
				if ( is_wp_error( $activate ) ) {
3088
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
3089
				} else {
3090
					$count        = count( $plugin_names ); // Count so we can use _n function.
3091
					$plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
3092
					$last_plugin  = array_pop( $plugin_names ); // Pop off last name to prep for readability.
3093
					$imploded     = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
3094
3095
					printf( // WPCS: xss ok.
3096
						'<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
3097
						esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
3098
						$imploded
3099
					);
3100
3101
					// Update recently activated plugins option.
3102
					$recent = (array) get_option( 'recently_activated' );
3103
					foreach ( $plugins_to_activate as $plugin => $time ) {
3104
						if ( isset( $recent[ $plugin ] ) ) {
3105
							unset( $recent[ $plugin ] );
3106
						}
3107
					}
3108
					update_option( 'recently_activated', $recent );
3109
				}
3110
3111
				unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
3112
3113
				return true;
3114
			}
3115
3116
			return false;
3117
		}
3118
3119
		/**
3120
		 * Prepares all of our information to be outputted into a usable table.
3121
		 *
3122
		 * @since 2.2.0
3123
		 */
3124
		public function prepare_items() {
3125
			$columns               = $this->get_columns(); // Get all necessary column information.
3126
			$hidden                = array(); // No columns to hide, but we must set as an array.
3127
			$sortable              = array(); // No reason to make sortable columns.
3128
			$primary               = $this->get_primary_column_name(); // Column which has the row actions.
3129
			$this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
3130
3131
			// Process our bulk activations here.
3132
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3133
				$this->process_bulk_actions();
3134
			}
3135
3136
			// Store all of our plugin data into $items array so WP_List_Table can use it.
3137
			$this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
3138
		}
3139
3140
		/* *********** DEPRECATED METHODS *********** */
3141
3142
		/**
3143
		 * Retrieve plugin data, given the plugin name.
3144
		 *
3145
		 * @since      2.2.0
3146
		 * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
3147
		 * @see        TGM_Plugin_Activation::_get_plugin_data_from_name()
3148
		 *
3149
		 * @param string $name Name of the plugin, as it was registered.
3150
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
3151
		 * @return string|boolean Plugin slug if found, false otherwise.
3152
		 */
3153
		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...
3154
			_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
3155
3156
			return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
3157
		}
3158
	}
3159
}
3160
3161
3162
if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
3163
3164
	/**
3165
	 * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
3166
	 *
3167
	 * @since 2.5.2
3168
	 *
3169
	 * {@internal The TGMPA_Bulk_Installer class was originally called TGM_Bulk_Installer.
3170
	 *            For more information, see that class.}}
3171
	 */
3172
	class TGM_Bulk_Installer {
3173
	}
3174
}
3175
if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
3176
3177
	/**
3178
	 * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
3179
	 *
3180
	 * @since 2.5.2
3181
	 *
3182
	 * {@internal The TGMPA_Bulk_Installer_Skin class was originally called TGM_Bulk_Installer_Skin.
3183
	 *            For more information, see that class.}}
3184
	 */
3185
	class TGM_Bulk_Installer_Skin {
3186
	}
3187
}
3188
3189
/**
3190
 * The WP_Upgrader file isn't always available. If it isn't available,
3191
 * we load it here.
3192
 *
3193
 * We check to make sure no action or activation keys are set so that WordPress
3194
 * does not try to re-include the class when processing upgrades or installs outside
3195
 * of the class.
3196
 *
3197
 * @since 2.2.0
3198
 */
3199
add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
3200
if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
3201
	/**
3202
	 * Load bulk installer
3203
	 */
3204
	function tgmpa_load_bulk_installer() {
3205
		// Silently fail if 2.5+ is loaded *after* an older version.
3206
		if ( ! isset( $GLOBALS['tgmpa'] ) ) {
3207
			return;
3208
		}
3209
3210
		// Get TGMPA class instance.
3211
		$tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3212
3213
		if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
3214
			if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
3215
				require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
3216
			}
3217
3218
			if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
3219
3220
				/**
3221
				 * Installer class to handle bulk plugin installations.
3222
				 *
3223
				 * Extends WP_Upgrader and customizes to suit the installation of multiple
3224
				 * plugins.
3225
				 *
3226
				 * @since 2.2.0
3227
				 *
3228
				 * {@internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader.}}
3229
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
3230
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3231
				 *
3232
				 * @package TGM-Plugin-Activation
3233
				 * @author  Thomas Griffin
3234
				 * @author  Gary Jones
3235
				 */
3236
				class TGMPA_Bulk_Installer extends Plugin_Upgrader {
3237
					/**
3238
					 * Holds result of bulk plugin installation.
3239
					 *
3240
					 * @since 2.2.0
3241
					 *
3242
					 * @var string
3243
					 */
3244
					public $result;
3245
3246
					/**
3247
					 * Flag to check if bulk installation is occurring or not.
3248
					 *
3249
					 * @since 2.2.0
3250
					 *
3251
					 * @var boolean
3252
					 */
3253
					public $bulk = false;
3254
3255
					/**
3256
					 * TGMPA instance
3257
					 *
3258
					 * @since 2.5.0
3259
					 *
3260
					 * @var object
3261
					 */
3262
					protected $tgmpa;
3263
3264
					/**
3265
					 * Whether or not the destination directory needs to be cleared ( = on update).
3266
					 *
3267
					 * @since 2.5.0
3268
					 *
3269
					 * @var bool
3270
					 */
3271
					protected $clear_destination = false;
3272
3273
					/**
3274
					 * References parent constructor and sets defaults for class.
3275
					 *
3276
					 * @since 2.2.0
3277
					 *
3278
					 * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
3279
					 */
3280
					public function __construct( $skin = null ) {
3281
						// Get TGMPA class instance.
3282
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3283
3284
						parent::__construct( $skin );
3285
3286
						if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
3287
							$this->clear_destination = true;
3288
						}
3289
3290
						if ( $this->tgmpa->is_automatic ) {
3291
							$this->activate_strings();
3292
						}
3293
3294
						add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
3295
					}
3296
3297
					/**
3298
					 * Sets the correct activation strings for the installer skin to use.
3299
					 *
3300
					 * @since 2.2.0
3301
					 */
3302
					public function activate_strings() {
3303
						$this->strings['activation_failed']  = __( 'Plugin activation failed.', 'tgmpa' );
3304
						$this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
3305
					}
3306
3307
					/**
3308
					 * Performs the actual installation of each plugin.
3309
					 *
3310
					 * @since 2.2.0
3311
					 *
3312
					 * @see WP_Upgrader::run()
3313
					 *
3314
					 * @param array $options The installation config options.
3315
					 * @return null|array Return early if error, array of installation data on success.
3316
					 */
3317
					public function run( $options ) {
3318
						$result = parent::run( $options );
3319
3320
						// Reset the strings in case we changed one during automatic activation.
3321
						if ( $this->tgmpa->is_automatic ) {
3322
							if ( 'update' === $this->skin->options['install_type'] ) {
3323
								$this->upgrade_strings();
3324
							} else {
3325
								$this->install_strings();
3326
							}
3327
						}
3328
3329
						return $result;
3330
					}
3331
3332
					/**
3333
					 * Processes the bulk installation of plugins.
3334
					 *
3335
					 * @since 2.2.0
3336
					 *
3337
					 * {@internal This is basically a near identical copy of the WP Core
3338
					 * Plugin_Upgrader::bulk_upgrade() method, with minor adjustments to deal with
3339
					 * new installs instead of upgrades.
3340
					 * For ease of future synchronizations, the adjustments are clearly commented, but no other
3341
					 * comments are added. Code style has been made to comply.}}
3342
					 *
3343
					 * @see Plugin_Upgrader::bulk_upgrade()
3344
					 * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
3345
					 * (@internal Last synced: Dec 31st 2015 against https://core.trac.wordpress.org/browser/trunk?rev=36134}}
3346
					 *
3347
					 * @param array $plugins The plugin sources needed for installation.
3348
					 * @param array $args    Arbitrary passed extra arguments.
3349
					 * @return array|false   Install confirmation messages on success, false on failure.
3350
					 */
3351
					public function bulk_install( $plugins, $args = array() ) {
3352
						// [TGMPA + ] Hook auto-activation in.
3353
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3354
3355
						$defaults    = array(
3356
							'clear_update_cache' => true,
3357
						);
3358
						$parsed_args = wp_parse_args( $args, $defaults );
3359
3360
						$this->init();
3361
						$this->bulk = true;
3362
3363
						$this->install_strings(); // [TGMPA + ] adjusted.
3364
3365
						/* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
3366
3367
						/* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
3368
3369
						$this->skin->header();
3370
3371
						// Connect to the Filesystem first.
3372
						$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
3373
						if ( ! $res ) {
3374
							$this->skin->footer();
3375
							return false;
3376
						}
3377
3378
						$this->skin->bulk_header();
3379
3380
						/*
3381
						 * Only start maintenance mode if:
3382
						 * - running Multisite and there are one or more plugins specified, OR
3383
						 * - a plugin with an update available is currently active.
3384
						 * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
3385
						 */
3386
						$maintenance = ( is_multisite() && ! empty( $plugins ) );
3387
3388
						/*
3389
						[TGMPA - ]
3390
						foreach ( $plugins as $plugin )
3391
							$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
3392
						*/
3393
						if ( $maintenance ) {
3394
							$this->maintenance_mode( true );
3395
						}
3396
3397
						$results = array();
3398
3399
						$this->update_count   = count( $plugins );
3400
						$this->update_current = 0;
3401
						foreach ( $plugins as $plugin ) {
3402
							$this->update_current++;
3403
3404
							/*
3405
							[TGMPA - ]
3406
							$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
3407
3408
							if ( !isset( $current->response[ $plugin ] ) ) {
3409
								$this->skin->set_result('up_to_date');
3410
								$this->skin->before();
3411
								$this->skin->feedback('up_to_date');
3412
								$this->skin->after();
3413
								$results[$plugin] = true;
3414
								continue;
3415
							}
3416
3417
							// Get the URL to the zip file.
3418
							$r = $current->response[ $plugin ];
3419
3420
							$this->skin->plugin_active = is_plugin_active($plugin);
3421
							*/
3422
3423
							$result = $this->run(
3424
								array(
3425
									'package'           => $plugin, // [TGMPA + ] adjusted.
3426
									'destination'       => WP_PLUGIN_DIR,
3427
									'clear_destination' => false, // [TGMPA + ] adjusted.
3428
									'clear_working'     => true,
3429
									'is_multi'          => true,
3430
									'hook_extra'        => array(
3431
										'plugin' => $plugin,
3432
									),
3433
								)
3434
							);
3435
3436
							$results[ $plugin ] = $this->result;
3437
3438
							// Prevent credentials auth screen from displaying multiple times.
3439
							if ( false === $result ) {
3440
								break;
3441
							}
3442
						}
3443
3444
						$this->maintenance_mode( false );
3445
3446
						/**
3447
						 * Fires when the bulk upgrader process is complete.
3448
						 *
3449
						 * @since WP 3.6.0 / TGMPA 2.5.0
3450
						 *
3451
						 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
3452
						 *                              be a Theme_Upgrader or Core_Upgrade instance.
3453
						 * @param array           $data {
3454
						 *     Array of bulk item update data.
3455
						 *
3456
						 *     @type string $action   Type of action. Default 'update'.
3457
						 *     @type string $type     Type of update process. Accepts 'plugin', 'theme', or 'core'.
3458
						 *     @type bool   $bulk     Whether the update process is a bulk update. Default true.
3459
						 *     @type array  $packages Array of plugin, theme, or core packages to update.
3460
						 * }
3461
						 */
3462
						do_action( // WPCS: prefix OK.
3463
							'upgrader_process_complete',
3464
							$this,
3465
							array(
3466
								'action'  => 'install', // [TGMPA + ] adjusted.
3467
								'type'    => 'plugin',
3468
								'bulk'    => true,
3469
								'plugins' => $plugins,
3470
							)
3471
						);
3472
3473
						$this->skin->bulk_footer();
3474
3475
						$this->skin->footer();
3476
3477
						// Cleanup our hooks, in case something else does a upgrade on this connection.
3478
						/* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
3479
3480
						// [TGMPA + ] Remove our auto-activation hook.
3481
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3482
3483
						// Force refresh of plugin update information.
3484
						wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
3485
3486
						return $results;
3487
					}
3488
3489
					/**
3490
					 * Handle a bulk upgrade request.
3491
					 *
3492
					 * @since 2.5.0
3493
					 *
3494
					 * @see Plugin_Upgrader::bulk_upgrade()
3495
					 *
3496
					 * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
3497
					 * @param array $args    Arbitrary passed extra arguments.
3498
					 * @return string|bool Install confirmation messages on success, false on failure.
3499
					 */
3500
					public function bulk_upgrade( $plugins, $args = array() ) {
3501
3502
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3503
3504
						$result = parent::bulk_upgrade( $plugins, $args );
3505
3506
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3507
3508
						return $result;
3509
					}
3510
3511
					/**
3512
					 * Abuse a filter to auto-activate plugins after installation.
3513
					 *
3514
					 * Hooked into the 'upgrader_post_install' filter hook.
3515
					 *
3516
					 * @since 2.5.0
3517
					 *
3518
					 * @param bool $bool The value we need to give back (true).
3519
					 * @return bool
3520
					 */
3521
					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...
3522
						// Only process the activation of installed plugins if the automatic flag is set to true.
3523
						if ( $this->tgmpa->is_automatic ) {
3524
							// Flush plugins cache so the headers of the newly installed plugins will be read correctly.
3525
							wp_clean_plugins_cache();
3526
3527
							// Get the installed plugin file.
3528
							$plugin_info = $this->plugin_info();
3529
3530
							// Don't try to activate on upgrade of active plugin as WP will do this already.
3531
							if ( ! is_plugin_active( $plugin_info ) ) {
3532
								$activate = activate_plugin( $plugin_info );
3533
3534
								// Adjust the success string based on the activation result.
3535
								$this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
3536
3537
								if ( is_wp_error( $activate ) ) {
3538
									$this->skin->error( $activate );
3539
									$this->strings['process_success'] .= $this->strings['activation_failed'];
3540
								} else {
3541
									$this->strings['process_success'] .= $this->strings['activation_success'];
3542
								}
3543
							}
3544
						}
3545
3546
						return $bool;
3547
					}
3548
				}
3549
			}
3550
3551
			if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
3552
3553
				/**
3554
				 * Installer skin to set strings for the bulk plugin installations..
3555
				 *
3556
				 * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
3557
				 * plugins.
3558
				 *
3559
				 * @since 2.2.0
3560
				 *
3561
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
3562
				 *            TGMPA_Bulk_Installer_Skin.
3563
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3564
				 *
3565
				 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
3566
				 *
3567
				 * @package TGM-Plugin-Activation
3568
				 * @author  Thomas Griffin
3569
				 * @author  Gary Jones
3570
				 */
3571
				class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
3572
					/**
3573
					 * Holds plugin info for each individual plugin installation.
3574
					 *
3575
					 * @since 2.2.0
3576
					 *
3577
					 * @var array
3578
					 */
3579
					public $plugin_info = array();
3580
3581
					/**
3582
					 * Holds names of plugins that are undergoing bulk installations.
3583
					 *
3584
					 * @since 2.2.0
3585
					 *
3586
					 * @var array
3587
					 */
3588
					public $plugin_names = array();
3589
3590
					/**
3591
					 * Integer to use for iteration through each plugin installation.
3592
					 *
3593
					 * @since 2.2.0
3594
					 *
3595
					 * @var integer
3596
					 */
3597
					public $i = 0;
3598
3599
					/**
3600
					 * TGMPA instance
3601
					 *
3602
					 * @since 2.5.0
3603
					 *
3604
					 * @var object
3605
					 */
3606
					protected $tgmpa;
3607
3608
					/**
3609
					 * Constructor. Parses default args with new ones and extracts them for use.
3610
					 *
3611
					 * @since 2.2.0
3612
					 *
3613
					 * @param array $args Arguments to pass for use within the class.
3614
					 */
3615
					public function __construct( $args = array() ) {
3616
						// Get TGMPA class instance.
3617
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3618
3619
						// Parse default and new args.
3620
						$defaults = array(
3621
							'url'          => '',
3622
							'nonce'        => '',
3623
							'names'        => array(),
3624
							'install_type' => 'install',
3625
						);
3626
						$args     = wp_parse_args( $args, $defaults );
3627
3628
						// Set plugin names to $this->plugin_names property.
3629
						$this->plugin_names = $args['names'];
3630
3631
						// Extract the new args.
3632
						parent::__construct( $args );
3633
					}
3634
3635
					/**
3636
					 * Sets install skin strings for each individual plugin.
3637
					 *
3638
					 * Checks to see if the automatic activation flag is set and uses the
3639
					 * the proper strings accordingly.
3640
					 *
3641
					 * @since 2.2.0
3642
					 */
3643
					public function add_strings() {
3644
						if ( 'update' === $this->options['install_type'] ) {
3645
							parent::add_strings();
3646
							/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3647
							$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3648
						} else {
3649
							/* translators: 1: plugin name, 2: error message. */
3650
							$this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
3651
							/* translators: 1: plugin name. */
3652
							$this->upgrader->strings['skin_update_failed'] = __( 'The installation of %1$s failed.', 'tgmpa' );
3653
3654
							if ( $this->tgmpa->is_automatic ) {
3655
								// Automatic activation strings.
3656
								$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' );
3657
								/* translators: 1: plugin name. */
3658
								$this->upgrader->strings['skin_update_successful'] = __( '%1$s installed and activated successfully.', 'tgmpa' );
3659
								$this->upgrader->strings['skin_upgrade_end']       = __( 'All installations and activations have been completed.', 'tgmpa' );
3660
								/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3661
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3662
							} else {
3663
								// Default installation strings.
3664
								$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' );
3665
								/* translators: 1: plugin name. */
3666
								$this->upgrader->strings['skin_update_successful'] = __( '%1$s installed successfully.', 'tgmpa' );
3667
								$this->upgrader->strings['skin_upgrade_end']       = __( 'All installations have been completed.', 'tgmpa' );
3668
								/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3669
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3670
							}
3671
3672
							// Add "read more" link only for WP < 4.8.
3673
							if ( version_compare( $this->tgmpa->wp_version, '4.8', '<' ) ) {
3674
								$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>';
3675
							}
3676
						}
3677
					}
3678
3679
					/**
3680
					 * Outputs the header strings and necessary JS before each plugin installation.
3681
					 *
3682
					 * @since 2.2.0
3683
					 *
3684
					 * @param string $title Unused in this implementation.
3685
					 */
3686
					public function before( $title = '' ) {
3687
						if ( empty( $title ) ) {
3688
							$title = esc_html( $this->plugin_names[ $this->i ] );
3689
						}
3690
						parent::before( $title );
3691
					}
3692
3693
					/**
3694
					 * Outputs the footer strings and necessary JS after each plugin installation.
3695
					 *
3696
					 * Checks for any errors and outputs them if they exist, else output
3697
					 * success strings.
3698
					 *
3699
					 * @since 2.2.0
3700
					 *
3701
					 * @param string $title Unused in this implementation.
3702
					 */
3703
					public function after( $title = '' ) {
3704
						if ( empty( $title ) ) {
3705
							$title = esc_html( $this->plugin_names[ $this->i ] );
3706
						}
3707
						parent::after( $title );
3708
3709
						$this->i++;
3710
					}
3711
3712
					/**
3713
					 * Outputs links after bulk plugin installation is complete.
3714
					 *
3715
					 * @since 2.2.0
3716
					 */
3717
					public function bulk_footer() {
3718
						// Serve up the string to say installations (and possibly activations) are complete.
3719
						parent::bulk_footer();
3720
3721
						// Flush plugins cache so we can make sure that the installed plugins list is always up to date.
3722
						wp_clean_plugins_cache();
3723
3724
						$this->tgmpa->show_tgmpa_version();
3725
3726
						// Display message based on if all plugins are now active or not.
3727
						$update_actions = array();
3728
3729
						if ( $this->tgmpa->is_tgmpa_complete() ) {
3730
							// All plugins are active, so we display the complete string and hide the menu to protect users.
3731
							echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
3732
							$update_actions['dashboard'] = sprintf(
3733
								esc_html( $this->tgmpa->strings['complete'] ),
3734
								'<a href="' . esc_url( self_admin_url() ) . '">' . esc_html( $this->tgmpa->strings['dashboard'] ) . '</a>'
3735
							);
3736
						} else {
3737
							$update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
3738
						}
3739
3740
						/**
3741
						 * Filter the list of action links available following bulk plugin installs/updates.
3742
						 *
3743
						 * @since 2.5.0
3744
						 *
3745
						 * @param array $update_actions Array of plugin action links.
3746
						 * @param array $plugin_info    Array of information for the last-handled plugin.
3747
						 */
3748
						$update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
3749
3750
						if ( ! empty( $update_actions ) ) {
3751
							$this->feedback( implode( ' | ', (array) $update_actions ) );
3752
						}
3753
					}
3754
3755
					/* *********** DEPRECATED METHODS *********** */
3756
3757
					/**
3758
					 * Flush header output buffer.
3759
					 *
3760
					 * @since      2.2.0
3761
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3762
					 * @see        Bulk_Upgrader_Skin::flush_output()
3763
					 */
3764
					public function before_flush_output() {
3765
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3766
						$this->flush_output();
3767
					}
3768
3769
					/**
3770
					 * Flush footer output buffer and iterate $this->i to make sure the
3771
					 * installation strings reference the correct plugin.
3772
					 *
3773
					 * @since      2.2.0
3774
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3775
					 * @see        Bulk_Upgrader_Skin::flush_output()
3776
					 */
3777
					public function after_flush_output() {
3778
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3779
						$this->flush_output();
3780
						$this->i++;
3781
					}
3782
				}
3783
			}
3784
		}
3785
	}
3786
}
3787
3788
if ( ! class_exists( 'TGMPA_Utils' ) ) {
3789
3790
	/**
3791
	 * Generic utilities for TGMPA.
3792
	 *
3793
	 * All methods are static, poor-dev name-spacing class wrapper.
3794
	 *
3795
	 * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
3796
	 *
3797
	 * @since 2.5.0
3798
	 *
3799
	 * @package TGM-Plugin-Activation
3800
	 * @author  Juliette Reinders Folmer
3801
	 */
3802
	class TGMPA_Utils {
3803
		/**
3804
		 * Whether the PHP filter extension is enabled.
3805
		 *
3806
		 * @see http://php.net/book.filter
3807
		 *
3808
		 * @since 2.5.0
3809
		 *
3810
		 * @static
3811
		 *
3812
		 * @var bool $has_filters True is the extension is enabled.
3813
		 */
3814
		public static $has_filters;
3815
3816
		/**
3817
		 * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
3818
		 *
3819
		 * @since 2.5.0
3820
		 *
3821
		 * @static
3822
		 *
3823
		 * @param string $string Text to be wrapped.
3824
		 * @return string
3825
		 */
3826
		public static function wrap_in_em( $string ) {
3827
			return '<em>' . wp_kses_post( $string ) . '</em>';
3828
		}
3829
3830
		/**
3831
		 * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
3832
		 *
3833
		 * @since 2.5.0
3834
		 *
3835
		 * @static
3836
		 *
3837
		 * @param string $string Text to be wrapped.
3838
		 * @return string
3839
		 */
3840
		public static function wrap_in_strong( $string ) {
3841
			return '<strong>' . wp_kses_post( $string ) . '</strong>';
3842
		}
3843
3844
		/**
3845
		 * Helper function: Validate a value as boolean
3846
		 *
3847
		 * @since 2.5.0
3848
		 *
3849
		 * @static
3850
		 *
3851
		 * @param mixed $value Arbitrary value.
3852
		 * @return bool
3853
		 */
3854
		public static function validate_bool( $value ) {
3855
			if ( ! isset( self::$has_filters ) ) {
3856
				self::$has_filters = extension_loaded( 'filter' );
3857
			}
3858
3859
			if ( self::$has_filters ) {
3860
				return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
3861
			} else {
3862
				return self::emulate_filter_bool( $value );
3863
			}
3864
		}
3865
3866
		/**
3867
		 * Helper function: Cast a value to bool
3868
		 *
3869
		 * @since 2.5.0
3870
		 *
3871
		 * @static
3872
		 *
3873
		 * @param mixed $value Value to cast.
3874
		 * @return bool
3875
		 */
3876
		protected static function emulate_filter_bool( $value ) {
3877
			// @codingStandardsIgnoreStart
3878
			static $true  = array(
3879
				'1',
3880
				'true', 'True', 'TRUE',
3881
				'y', 'Y',
3882
				'yes', 'Yes', 'YES',
3883
				'on', 'On', 'ON',
3884
			);
3885
			static $false = array(
3886
				'0',
3887
				'false', 'False', 'FALSE',
3888
				'n', 'N',
3889
				'no', 'No', 'NO',
3890
				'off', 'Off', 'OFF',
3891
			);
3892
			// @codingStandardsIgnoreEnd
3893
3894
			if ( is_bool( $value ) ) {
3895
				return $value;
3896
			} elseif ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
3897
				return (bool) $value;
3898
			} elseif ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
3899
				return (bool) $value;
3900
			} elseif ( is_string( $value ) ) {
3901
				$value = trim( $value );
3902
				if ( in_array( $value, $true, true ) ) {
3903
					return true;
3904
				} elseif ( in_array( $value, $false, true ) ) {
3905
					return false;
3906
				} else {
3907
					return false;
3908
				}
3909
			}
3910
3911
			return false;
3912
		}
3913
	} // End of class TGMPA_Utils
3914
}
3915