Completed
Push — develop ( 13b3c8...9c97e4 )
by Gary
03:06
created

TGMPA_Bulk_Installer_Skin::add_strings()   B

Complexity

Conditions 3

Size

Total Lines 30

Duplication

Lines 0
Ratio 0 %

Importance

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

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

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

Loading history...
838
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem.
839
					return true;
840
				}
841
842
				/* If we arrive here, we have the filesystem. */
843
844
				// Prep variables for Plugin_Installer_Skin class.
845
				$extra         = array();
846
				$extra['slug'] = $slug; // Needed for potentially renaming of directory name.
847
				$source        = $this->get_download_url( $slug );
848
				$api           = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null;
849
				$api           = ( false !== $api ) ? $api : null;
850
851
				$url = add_query_arg(
852
					array(
853
						'action' => $install_type . '-plugin',
854
						'plugin' => urlencode( $slug ),
855
					),
856
					'update.php'
857
				);
858
859
				if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
860
					require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
861
				}
862
863
				$title     = ( 'update' === $install_type ) ? $this->strings['updating'] : $this->strings['installing'];
864
				$skin_args = array(
865
					'type'   => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload',
866
					'title'  => sprintf( $title, $this->plugins[ $slug ]['name'] ),
867
					'url'    => esc_url_raw( $url ),
868
					'nonce'  => $install_type . '-plugin_' . $slug,
869
					'plugin' => '',
870
					'api'    => $api,
871
					'extra'  => $extra,
872
				);
873
				unset( $title );
874
875
				if ( 'update' === $install_type ) {
876
					$skin_args['plugin'] = $this->plugins[ $slug ]['file_path'];
877
					$skin                = new Plugin_Upgrader_Skin( $skin_args );
878
				} else {
879
					$skin = new Plugin_Installer_Skin( $skin_args );
880
				}
881
882
				// Create a new instance of Plugin_Upgrader.
883
				$upgrader = new Plugin_Upgrader( $skin );
884
885
				// Perform the action and install the plugin from the $source urldecode().
886
				add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
887
888
				if ( 'update' === $install_type ) {
889
					// Inject our info into the update transient.
890
					$to_inject                    = array( $slug => $this->plugins[ $slug ] );
891
					$to_inject[ $slug ]['source'] = $source;
892
					$this->inject_update_info( $to_inject );
893
894
					$upgrader->upgrade( $this->plugins[ $slug ]['file_path'] );
895
				} else {
896
					$upgrader->install( $source );
897
				}
898
899
				remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1 );
900
901
				// Make sure we have the correct file path now the plugin is installed/updated.
902
				$this->populate_file_path( $slug );
903
904
				// Only activate plugins if the config option is set to true and the plugin isn't
905
				// already active (upgrade).
906
				if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) {
907
					$plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method.
908
					if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) {
909
						return true; // Finish execution of the function early as we encountered an error.
910
					}
911
				}
912
913
				$this->show_tgmpa_version();
914
915
				// Display message based on if all plugins are now active or not.
916
				if ( $this->is_tgmpa_complete() ) {
917
					echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>' ), '</p>';
918
					echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
919
				} else {
920
					echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
921
				}
922
923
				return true;
924
			} elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) {
925
				// Activate action link was clicked.
926
				check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' );
927
928
				if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) {
929
					return true; // Finish execution of the function early as we encountered an error.
930
				}
931
			}
932
933
			return false;
934
		}
935
936
		/**
937
		 * Inject information into the 'update_plugins' site transient as WP checks that before running an update.
938
		 *
939
		 * @since 2.5.0
940
		 *
941
		 * @param array $plugins The plugin information for the plugins which are to be updated.
942
		 */
943
		public function inject_update_info( $plugins ) {
944
			$repo_updates = get_site_transient( 'update_plugins' );
945
946
			if ( ! is_object( $repo_updates ) ) {
947
				$repo_updates = new stdClass;
948
			}
949
950
			foreach ( $plugins as $slug => $plugin ) {
951
				$file_path = $plugin['file_path'];
952
953
				if ( empty( $repo_updates->response[ $file_path ] ) ) {
954
					$repo_updates->response[ $file_path ] = new stdClass;
955
				}
956
957
				// We only really need to set package, but let's do all we can in case WP changes something.
958
				$repo_updates->response[ $file_path ]->slug        = $slug;
959
				$repo_updates->response[ $file_path ]->plugin      = $file_path;
960
				$repo_updates->response[ $file_path ]->new_version = $plugin['version'];
961
				$repo_updates->response[ $file_path ]->package     = $plugin['source'];
962
				if ( empty( $repo_updates->response[ $file_path ]->url ) && ! empty( $plugin['external_url'] ) ) {
963
					$repo_updates->response[ $file_path ]->url = $plugin['external_url'];
964
				}
965
			}
966
967
			set_site_transient( 'update_plugins', $repo_updates );
968
		}
969
970
		/**
971
		 * Adjust the plugin directory name if necessary.
972
		 *
973
		 * The final destination directory of a plugin is based on the subdirectory name found in the
974
		 * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this
975
		 * subdirectory name is not the same as the expected slug and the plugin will not be recognized
976
		 * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to
977
		 * the expected plugin slug.
978
		 *
979
		 * @since 2.5.0
980
		 *
981
		 * @param string       $source        Path to upgrade/zip-file-name.tmp/subdirectory/.
982
		 * @param string       $remote_source Path to upgrade/zip-file-name.tmp.
983
		 * @param \WP_Upgrader $upgrader      Instance of the upgrader which installs the plugin.
984
		 * @return string $source
985
		 */
986
		public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
987
			if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) {
988
				return $source;
989
			}
990
991
			// Check for single file plugins.
992
			$source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) );
993
			if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) {
994
				return $source;
995
			}
996
997
			// Multi-file plugin, let's see if the directory is correctly named.
998
			$desired_slug = '';
999
1000
			// Figure out what the slug is supposed to be.
1001
			if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) {
1002
				$desired_slug = $upgrader->skin->options['extra']['slug'];
1003
			} else {
1004
				// Bulk installer contains less info, so fall back on the info registered here.
1005
				foreach ( $this->plugins as $slug => $plugin ) {
1006
					if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) {
1007
						$desired_slug = $slug;
1008
						break;
1009
					}
1010
				}
1011
				unset( $slug, $plugin );
1012
			}
1013
1014
			if ( ! empty( $desired_slug ) ) {
1015
				$subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
1016
1017
				if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
1018
					$from = untrailingslashit( $source );
1019
					$to   = trailingslashit( $remote_source ) . $desired_slug;
1020
1021
					if ( true === $GLOBALS['wp_filesystem']->move( $from, $to ) ) {
1022
						return trailingslashit( $to );
1023 View Code Duplication
					} else {
1024
						return new WP_Error( 'rename_failed', esc_html__( 'The remote plugin package does not contain a folder with the desired slug and renaming did not work.', 'tgmpa' ) . ' ' . esc_html__( 'Please contact the plugin provider and ask them to package their plugin according to the WordPress guidelines.', 'tgmpa' ), array( 'found' => $subdir_name, 'expected' => $desired_slug ) );
1025
					}
1026 View Code Duplication
				} elseif ( empty( $subdir_name ) ) {
1027
					return new WP_Error( 'packaged_wrong', esc_html__( 'The remote plugin package consists of more than one file, but the files are not packaged in a folder.', 'tgmpa' ) . ' ' . esc_html__( 'Please contact the plugin provider and ask them to package their plugin according to the WordPress guidelines.', 'tgmpa' ), array( 'found' => $subdir_name, 'expected' => $desired_slug ) );
1028
				}
1029
			}
1030
1031
			return $source;
1032
		}
1033
1034
		/**
1035
		 * Activate a single plugin and send feedback about the result to the screen.
1036
		 *
1037
		 * @since 2.5.0
1038
		 *
1039
		 * @param string $file_path Path within wp-plugins/ to main plugin file.
1040
		 * @param string $slug      Plugin slug.
1041
		 * @param bool   $automatic Whether this is an automatic activation after an install. Defaults to false.
1042
		 *                          This determines the styling of the output messages.
1043
		 * @return bool False if an error was encountered, true otherwise.
1044
		 */
1045
		protected function activate_single_plugin( $file_path, $slug, $automatic = false ) {
1046
			if ( $this->can_plugin_activate( $slug ) ) {
1047
				$activate = activate_plugin( $file_path );
1048
1049
				if ( is_wp_error( $activate ) ) {
1050
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>',
1051
						'<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
1052
1053
					return false; // End it here if there is an error with activation.
1054
				} else {
1055
					if ( ! $automatic ) {
1056
						// Make sure message doesn't display again if bulk activation is performed
1057
						// immediately after a single activation.
1058
						if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1059
							echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>';
1060
						}
1061
					} else {
1062
						// Simpler message layout for use on the plugin install page.
1063
						echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>';
1064
					}
1065
				}
1066 View Code Duplication
			} elseif ( $this->is_plugin_active( $slug ) ) {
1067
				// No simpler message format provided as this message should never be encountered
1068
				// on the plugin install page.
1069
				echo '<div id="message" class="error"><p>',
1070
					sprintf(
1071
						esc_html( $this->strings['plugin_already_active'] ),
1072
						'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1073
					),
1074
					'</p></div>';
1075
			} elseif ( $this->does_plugin_require_update( $slug ) ) {
1076
				if ( ! $automatic ) {
1077
					// Make sure message doesn't display again if bulk activation is performed
1078
					// immediately after a single activation.
1079 View Code Duplication
					if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
1080
						echo '<div id="message" class="error"><p>',
1081
							sprintf(
1082
								esc_html( $this->strings['plugin_needs_higher_version'] ),
1083
								'<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
1084
							),
1085
							'</p></div>';
1086
					}
1087
				} else {
1088
					// Simpler message layout for use on the plugin install page.
1089
					echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>';
1090
				}
1091
			}
1092
1093
			return true;
1094
		}
1095
1096
		/**
1097
		 * Echoes required plugin notice.
1098
		 *
1099
		 * Outputs a message telling users that a specific plugin is required for
1100
		 * their theme. If appropriate, it includes a link to the form page where
1101
		 * users can install and activate the plugin.
1102
		 *
1103
		 * Returns early if we're on the Install page.
1104
		 *
1105
		 * @since 1.0.0
1106
		 *
1107
		 * @global object $current_screen
1108
		 *
1109
		 * @return null Returns early if we're on the Install page.
1110
		 */
1111
		public function notices() {
1112
			// Remove nag on the install page / Return early if the nag message has been dismissed or user < author.
1113
			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' ) ) ) {
1114
				return;
1115
			}
1116
1117
			// Store for the plugin slugs by message type.
1118
			$message = array();
1119
1120
			// Initialize counters used to determine plurality of action link texts.
1121
			$install_link_count          = 0;
1122
			$update_link_count           = 0;
1123
			$activate_link_count         = 0;
1124
			$total_required_action_count = 0;
0 ignored issues
show
Comprehensibility Naming introduced by
The variable name $total_required_action_count exceeds the maximum configured length of 25.

Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose.

Loading history...
1125
1126
			foreach ( $this->plugins as $slug => $plugin ) {
1127
				if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) {
1128
					continue;
1129
				}
1130
1131
				if ( ! $this->is_plugin_installed( $slug ) ) {
1132
					if ( current_user_can( 'install_plugins' ) ) {
1133
						$install_link_count++;
1134
1135
						if ( true === $plugin['required'] ) {
1136
							$message['notice_can_install_required'][] = $slug;
1137
						} else {
1138
							$message['notice_can_install_recommended'][] = $slug;
1139
						}
1140
					}
1141
					if ( true === $plugin['required'] ) {
1142
						$total_required_action_count++;
1143
					}
1144
				} else {
1145
					if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) {
1146
						if ( current_user_can( 'activate_plugins' ) ) {
1147
							$activate_link_count++;
1148
1149
							if ( true === $plugin['required'] ) {
1150
								$message['notice_can_activate_required'][] = $slug;
1151
							} else {
1152
								$message['notice_can_activate_recommended'][] = $slug;
1153
							}
1154
						}
1155
						if ( true === $plugin['required'] ) {
1156
							$total_required_action_count++;
1157
						}
1158
					}
1159
1160
					if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1161
1162
						if ( current_user_can( 'update_plugins' ) ) {
1163
							$update_link_count++;
1164
1165
							if ( $this->does_plugin_require_update( $slug ) ) {
1166
								$message['notice_ask_to_update'][] = $slug;
1167
							} elseif ( false !== $this->does_plugin_have_update( $slug ) ) {
1168
								$message['notice_ask_to_update_maybe'][] = $slug;
1169
							}
1170
						}
1171
						if ( true === $plugin['required'] ) {
1172
							$total_required_action_count++;
1173
						}
1174
					}
1175
				}
1176
			}
1177
			unset( $slug, $plugin );
1178
1179
			// If we have notices to display, we move forward.
1180
			if ( ! empty( $message ) || $total_required_action_count > 0 ) {
1181
				krsort( $message ); // Sort messages.
1182
				$rendered = '';
1183
1184
				// As add_settings_error() wraps the final message in a <p> and as the final message can't be
1185
				// filtered, using <p>'s in our html would render invalid html output.
1186
				$line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n";
1187
1188
				if ( ! current_user_can( 'activate_plugins' ) && ! current_user_can( 'install_plugins' ) && ! current_user_can( 'update_plugins' ) ) {
1189
					$rendered = esc_html__( $this->strings['notice_cannot_install_activate'] ) . ' ' . esc_html__( $this->strings['contact_admin'] );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
1190
					$rendered .= $this->create_user_action_links_for_notice( 0, 0, 0, $line_template );
1191
				} else {
1192
1193
					// If dismissable is false and a message is set, output it now.
1194
					if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) {
1195
						$rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) );
1196
					}
1197
1198
					// Render the individual message lines for the notice.
1199
					foreach ( $message as $type => $plugin_group ) {
1200
						$linked_plugins = array();
1201
1202
						// Get the external info link for a plugin if one is available.
1203
						foreach ( $plugin_group as $plugin_slug ) {
1204
							$linked_plugins[] = $this->get_info_link( $plugin_slug );
1205
						}
1206
						unset( $plugin_slug );
1207
1208
						$count          = count( $plugin_group );
1209
						$linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins );
1210
						$last_plugin    = array_pop( $linked_plugins ); // Pop off last name to prep for readability.
1211
						$imploded       = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
1212
1213
						$rendered .= sprintf(
1214
							$line_template,
1215
							sprintf(
1216
								translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ),
1217
								$imploded,
1218
								$count
1219
							)
1220
						);
1221
1222
					}
1223
					unset( $type, $plugin_group, $linked_plugins, $count, $last_plugin, $imploded );
1224
1225
					$rendered .= $this->create_user_action_links_for_notice( $install_link_count, $update_link_count, $activate_link_count, $line_template );
1226
				}
1227
1228
				// Register the nag messages and prepare them to be processed.
1229
				add_settings_error( 'tgmpa', 'tgmpa', $rendered, $this->get_admin_notice_class() );
1230
			}
1231
1232
			// Admin options pages already output settings_errors, so this is to avoid duplication.
1233
			if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) {
1234
				$this->display_settings_errors();
1235
			}
1236
		}
1237
1238
		/**
1239
		 * Generate the user action links for the admin notice.
1240
		 *
1241
		 * @since 2.x.x
1242
		 *
1243
		 * @param int $install_count  Number of plugins to install.
1244
		 * @param int $update_count   Number of plugins to update.
1245
		 * @param int $activate_count Number of plugins to activate.
1246
		 * @param int $line_template  Template for the HTML tag to output a line.
1247
		 * @return string Action links.
1248
		 */
1249
		protected function create_user_action_links_for_notice( $install_count, $update_count, $activate_count, $line_template ) {
1250
			// Setup action links.
1251
			$action_links = array(
1252
				'install'  => '',
1253
				'update'   => '',
1254
				'activate' => '',
1255
				'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>' : '',
1256
			);
1257
1258
			$link_template = '<a href="%2$s">%1$s</a>';
1259
1260
			if ( current_user_can( 'install_plugins' ) ) {
1261 View Code Duplication
				if ( $install_count > 0 ) {
1262
					$action_links['install'] = sprintf(
1263
						$link_template,
1264
						translate_nooped_plural( $this->strings['install_link'], $install_count, 'tgmpa' ),
1265
						esc_url( $this->get_tgmpa_status_url( 'install' ) )
1266
					);
1267
				}
1268 View Code Duplication
				if ( $update_count > 0 ) {
1269
					$action_links['update'] = sprintf(
1270
						$link_template,
1271
						translate_nooped_plural( $this->strings['update_link'], $update_count, 'tgmpa' ),
1272
						esc_url( $this->get_tgmpa_status_url( 'update' ) )
1273
					);
1274
				}
1275
			}
1276
1277 View Code Duplication
			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...
1278
				$action_links['activate'] = sprintf(
1279
					$link_template,
1280
					translate_nooped_plural( $this->strings['activate_link'], $activate_count, 'tgmpa' ),
1281
					esc_url( $this->get_tgmpa_status_url( 'activate' ) )
1282
				);
1283
			}
1284
1285
			$action_links = apply_filters( 'tgmpa_notice_action_links', $action_links );
1286
1287
			$action_links = array_filter( (array) $action_links ); // Remove any empty array items.
1288
1289
			if ( ! empty( $action_links ) ) {
1290
				$action_links = sprintf( $line_template, implode( ' | ', $action_links ) );
1291
				return apply_filters( 'tgmpa_notice_rendered_action_links', $action_links );
1292
			} else {
1293
				return '';
1294
			}
1295
		}
1296
1297
		/**
1298
		 * Get admin notice class.
1299
		 *
1300
		 * Work around all the changes to the various admin notice classes between WP 4.4 and 3.7
1301
		 * (lowest supported version by TGMPA).
1302
		 *
1303
		 * @since 2.x.x
1304
		 *
1305
		 * @return string
1306
		 */
1307
		protected function get_admin_notice_class() {
1308
			if ( ! empty( $this->strings['nag_type'] ) ) {
1309
				return sanitize_html_class( strtolower( $this->strings['nag_type'] ) );
1310
			} else {
1311
				if ( version_compare( $this->wp_version, '4.2', '>=' ) ) {
1312
					return 'notice-warning';
1313
				} elseif ( version_compare( $this->wp_version, '4.1', '>=' ) ) {
1314
					return 'notice';
1315
				} else {
1316
					return 'updated';
1317
				}
1318
			}
1319
		}
1320
1321
		/**
1322
		 * Display settings errors and remove those which have been displayed to avoid duplicate messages showing
1323
		 *
1324
		 * @since 2.5.0
1325
		 */
1326
		protected function display_settings_errors() {
1327
			global $wp_settings_errors;
1328
1329
			settings_errors( 'tgmpa' );
1330
1331
			foreach ( (array) $wp_settings_errors as $key => $details ) {
1332
				if ( 'tgmpa' === $details['setting'] ) {
1333
					unset( $wp_settings_errors[ $key ] );
1334
					break;
1335
				}
1336
			}
1337
		}
1338
1339
		/**
1340
		 * Register dismissal of admin notices.
1341
		 *
1342
		 * Acts on the dismiss link in the admin nag messages.
1343
		 * If clicked, the admin notice disappears and will no longer be visible to this user.
1344
		 *
1345
		 * @since 2.1.0
1346
		 */
1347
		public function dismiss() {
1348
			if ( isset( $_GET['tgmpa-dismiss'] ) && check_admin_referer( 'tgmpa-dismiss-' . get_current_user_id() ) ) {
1349
				update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
1350
			}
1351
		}
1352
1353
		/**
1354
		 * Add individual plugin to our collection of plugins.
1355
		 *
1356
		 * If the required keys are not set or the plugin has already
1357
		 * been registered, the plugin is not added.
1358
		 *
1359
		 * @since 2.0.0
1360
		 *
1361
		 * @param array|null $plugin Array of plugin arguments or null if invalid argument.
1362
		 * @return null Return early if incorrect argument.
1363
		 */
1364
		public function register( $plugin ) {
1365
			if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
1366
				return;
1367
			}
1368
1369
			if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
1370
				return;
1371
			}
1372
1373
			$defaults = array(
1374
				'name'               => '',      // String
1375
				'slug'               => '',      // String
1376
				'source'             => 'repo',  // String
1377
				'required'           => false,   // Boolean
1378
				'version'            => '',      // String
1379
				'force_activation'   => false,   // Boolean
1380
				'force_deactivation' => false,   // Boolean
1381
				'external_url'       => '',      // String
1382
				'is_callable'        => '',      // String|Array.
1383
			);
1384
1385
			// Prepare the received data.
1386
			$plugin = wp_parse_args( $plugin, $defaults );
1387
1388
			// Standardize the received slug.
1389
			$plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
1390
1391
			// Forgive users for using string versions of booleans or floats for version number.
1392
			$plugin['version']            = (string) $plugin['version'];
1393
			$plugin['source']             = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
1394
			$plugin['required']           = TGMPA_Utils::validate_bool( $plugin['required'] );
1395
			$plugin['force_activation']   = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
1396
			$plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
1397
1398
			// Enrich the received data.
1399
			$plugin['file_path']   = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
1400
			$plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
1401
1402
			// Set the class properties.
1403
			$this->plugins[ $plugin['slug'] ]    = $plugin;
1404
			$this->sort_order[ $plugin['slug'] ] = $plugin['name'];
1405
1406
			// Should we add the force activation hook ?
1407
			if ( true === $plugin['force_activation'] ) {
1408
				$this->has_forced_activation = true;
1409
			}
1410
1411
			// Should we add the force deactivation hook ?
1412
			if ( true === $plugin['force_deactivation'] ) {
1413
				$this->has_forced_deactivation = true;
1414
			}
1415
		}
1416
1417
		/**
1418
		 * Determine what type of source the plugin comes from.
1419
		 *
1420
		 * @since 2.5.0
1421
		 *
1422
		 * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
1423
		 *                       (= bundled) or an external URL.
1424
		 * @return string 'repo', 'external', or 'bundled'
1425
		 */
1426
		protected function get_plugin_source_type( $source ) {
1427
			if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
1428
				return 'repo';
1429
			} elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
1430
				return 'external';
1431
			} else {
1432
				return 'bundled';
1433
			}
1434
		}
1435
1436
		/**
1437
		 * Sanitizes a string key.
1438
		 *
1439
		 * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
1440
		 * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
1441
		 * characters in the plugin directory path/slug. Silly them.
1442
		 *
1443
		 * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
1444
		 *
1445
		 * @since 2.5.0
1446
		 *
1447
		 * @param string $key String key.
1448
		 * @return string Sanitized key
1449
		 */
1450
		public function sanitize_key( $key ) {
1451
			$raw_key = $key;
1452
			$key     = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
1453
1454
			/**
1455
			* Filter a sanitized key string.
1456
			*
1457
			* @since 2.5.0
1458
			*
1459
			* @param string $key     Sanitized key.
1460
			* @param string $raw_key The key prior to sanitization.
1461
			*/
1462
			return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
1463
		}
1464
1465
		/**
1466
		 * Amend default configuration settings.
1467
		 *
1468
		 * @since 2.0.0
1469
		 *
1470
		 * @param array $config Array of config options to pass as class properties.
1471
		 */
1472
		public function config( $config ) {
1473
			$keys = array(
1474
				'id',
1475
				'default_path',
1476
				'has_notices',
1477
				'dismissable',
1478
				'dismiss_msg',
1479
				'menu',
1480
				'parent_slug',
1481
				'capability',
1482
				'is_automatic',
1483
				'message',
1484
				'strings',
1485
			);
1486
1487
			foreach ( $keys as $key ) {
1488
				if ( isset( $config[ $key ] ) ) {
1489
					if ( is_array( $config[ $key ] ) ) {
1490
						$this->$key = array_merge( $this->$key, $config[ $key ] );
1491
					} else {
1492
						$this->$key = $config[ $key ];
1493
					}
1494
				}
1495
			}
1496
		}
1497
1498
		/**
1499
		 * Amend action link after plugin installation.
1500
		 *
1501
		 * @since 2.0.0
1502
		 *
1503
		 * @param array $install_actions Existing array of actions.
1504
		 * @return array Amended array of actions.
1505
		 */
1506
		public function actions( $install_actions ) {
1507
			// Remove action links on the TGMPA install page.
1508
			if ( $this->is_tgmpa_page() ) {
1509
				return false;
1510
			}
1511
1512
			return $install_actions;
1513
		}
1514
1515
		/**
1516
		 * Flushes the plugins cache on theme switch to prevent stale entries
1517
		 * from remaining in the plugin table.
1518
		 *
1519
		 * @since 2.4.0
1520
		 *
1521
		 * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
1522
		 *                                 Parameter added in v2.5.0.
1523
		 */
1524
		public function flush_plugins_cache( $clear_update_cache = true ) {
1525
			wp_clean_plugins_cache( $clear_update_cache );
1526
		}
1527
1528
		/**
1529
		 * Set file_path key for each installed plugin.
1530
		 *
1531
		 * @since 2.1.0
1532
		 *
1533
		 * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
1534
		 *                            Parameter added in v2.5.0.
1535
		 */
1536
		public function populate_file_path( $plugin_slug = '' ) {
1537
			if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
1538
				$this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
1539
			} else {
1540
				// Add file_path key for all plugins.
1541
				foreach ( $this->plugins as $slug => $values ) {
1542
					$this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
1543
				}
1544
			}
1545
		}
1546
1547
		/**
1548
		 * Helper function to extract the file path of the plugin file from the
1549
		 * plugin slug, if the plugin is installed.
1550
		 *
1551
		 * @since 2.0.0
1552
		 *
1553
		 * @param string $slug Plugin slug (typically folder name) as provided by the developer.
1554
		 * @return string Either file path for plugin if installed, or just the plugin slug.
1555
		 */
1556
		protected function _get_plugin_basename_from_slug( $slug ) {
1557
			$keys = array_keys( $this->get_plugins() );
1558
1559
			foreach ( $keys as $key ) {
1560
				if ( preg_match( '|^' . $slug . '/|', $key ) ) {
1561
					return $key;
1562
				}
1563
			}
1564
1565
			return $slug;
1566
		}
1567
1568
		/**
1569
		 * Retrieve plugin data, given the plugin name.
1570
		 *
1571
		 * Loops through the registered plugins looking for $name. If it finds it,
1572
		 * it returns the $data from that plugin. Otherwise, returns false.
1573
		 *
1574
		 * @since 2.1.0
1575
		 *
1576
		 * @param string $name Name of the plugin, as it was registered.
1577
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
1578
		 * @return string|boolean Plugin slug if found, false otherwise.
1579
		 */
1580
		public function _get_plugin_data_from_name( $name, $data = 'slug' ) {
1581
			foreach ( $this->plugins as $values ) {
1582
				if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
1583
					return $values[ $data ];
1584
				}
1585
			}
1586
1587
			return false;
1588
		}
1589
1590
		/**
1591
		 * Retrieve the download URL for a package.
1592
		 *
1593
		 * @since 2.5.0
1594
		 *
1595
		 * @param string $slug Plugin slug.
1596
		 * @return string Plugin download URL or path to local file or empty string if undetermined.
1597
		 */
1598
		public function get_download_url( $slug ) {
1599
			$dl_source = '';
1600
1601
			switch ( $this->plugins[ $slug ]['source_type'] ) {
1602
				case 'repo':
1603
					return $this->get_wp_repo_download_url( $slug );
1604
				case 'external':
1605
					return $this->plugins[ $slug ]['source'];
1606
				case 'bundled':
1607
					return $this->default_path . $this->plugins[ $slug ]['source'];
1608
			}
1609
1610
			return $dl_source; // Should never happen.
1611
		}
1612
1613
		/**
1614
		 * Retrieve the download URL for a WP repo package.
1615
		 *
1616
		 * @since 2.5.0
1617
		 *
1618
		 * @param string $slug Plugin slug.
1619
		 * @return string Plugin download URL.
1620
		 */
1621
		protected function get_wp_repo_download_url( $slug ) {
1622
			$source = '';
1623
			$api    = $this->get_plugins_api( $slug );
1624
1625
			if ( false !== $api && isset( $api->download_link ) ) {
1626
				$source = $api->download_link;
1627
			}
1628
1629
			return $source;
1630
		}
1631
1632
		/**
1633
		 * Try to grab information from WordPress API.
1634
		 *
1635
		 * @since 2.5.0
1636
		 *
1637
		 * @param string $slug Plugin slug.
1638
		 * @return object Plugins_api response object on success, WP_Error on failure.
1639
		 */
1640
		protected function get_plugins_api( $slug ) {
1641
			static $api = array(); // Cache received responses.
1642
1643
			if ( ! isset( $api[ $slug ] ) ) {
1644
				if ( ! function_exists( 'plugins_api' ) ) {
1645
					require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
1646
				}
1647
1648
				$response = plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false ) ) );
1649
1650
				$api[ $slug ] = false;
1651
1652
				if ( is_wp_error( $response ) ) {
1653
					wp_die( esc_html( $this->strings['oops'] ) );
1654
				} else {
1655
					$api[ $slug ] = $response;
1656
				}
1657
			}
1658
1659
			return $api[ $slug ];
1660
		}
1661
1662
		/**
1663
		 * Retrieve a link to a plugin information page.
1664
		 *
1665
		 * @since 2.5.0
1666
		 *
1667
		 * @param string $slug Plugin slug.
1668
		 * @return string Fully formed html link to a plugin information page if available
1669
		 *                or the plugin name if not.
1670
		 */
1671
		public function get_info_link( $slug ) {
1672
			if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
1673
				$link = sprintf(
1674
					'<a href="%1$s" target="_blank">%2$s</a>',
1675
					esc_url( $this->plugins[ $slug ]['external_url'] ),
1676
					esc_html( $this->plugins[ $slug ]['name'] )
1677
				);
1678
			} elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
1679
				$url = add_query_arg(
1680
					array(
1681
						'tab'       => 'plugin-information',
1682
						'plugin'    => urlencode( $slug ),
1683
						'TB_iframe' => 'true',
1684
						'width'     => '640',
1685
						'height'    => '500',
1686
					),
1687
					self_admin_url( 'plugin-install.php' )
1688
				);
1689
1690
				$link = sprintf(
1691
					'<a href="%1$s" class="thickbox">%2$s</a>',
1692
					esc_url( $url ),
1693
					esc_html( $this->plugins[ $slug ]['name'] )
1694
				);
1695
			} else {
1696
				$link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
1697
			}
1698
1699
			return $link;
1700
		}
1701
1702
		/**
1703
		 * Determine if we're on the TGMPA Install page.
1704
		 *
1705
		 * @since 2.1.0
1706
		 *
1707
		 * @return boolean True when on the TGMPA page, false otherwise.
1708
		 */
1709
		protected function is_tgmpa_page() {
1710
			return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
1711
		}
1712
1713
		/**
1714
		 * Determine if we're on a WP Core installation/upgrade page.
1715
		 *
1716
		 * @since 2.x.x
1717
		 *
1718
		 * @return boolean True when on a WP Core installation/upgrade page, false otherwise.
1719
		 */
1720
		protected function is_core_update_page() {
1721
			// Current screen is not always available, most notably on the customizer screen.
1722
			if ( ! function_exists( 'get_current_screen' ) ) {
1723
				return false;
1724
			}
1725
1726
			$screen = get_current_screen();
1727
1728
			if ( 'update-core' === $screen->base ) {
1729
				// Core update screen.
1730
				return true;
1731
			} elseif ( 'plugins' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
1732
				// Plugins bulk update screen.
1733
				return true;
1734
			} elseif ( 'update' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
1735
				// Individual updates (ajax call).
1736
				return true;
1737
			}
1738
1739
			return false;
1740
		}
1741
1742
		/**
1743
		 * Retrieve the URL to the TGMPA Install page.
1744
		 *
1745
		 * I.e. depending on the config settings passed something along the lines of:
1746
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
1747
		 *
1748
		 * @since 2.5.0
1749
		 *
1750
		 * @return string Properly encoded URL (not escaped).
1751
		 */
1752
		public function get_tgmpa_url() {
1753
			static $url;
1754
1755
			if ( ! isset( $url ) ) {
1756
				$parent = $this->parent_slug;
1757
				if ( false === strpos( $parent, '.php' ) ) {
1758
					$parent = 'admin.php';
1759
				}
1760
				$url = add_query_arg(
1761
					array(
1762
						'page' => urlencode( $this->menu ),
1763
					),
1764
					self_admin_url( $parent )
1765
				);
1766
			}
1767
1768
			return $url;
1769
		}
1770
1771
		/**
1772
		 * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
1773
		 *
1774
		 * I.e. depending on the config settings passed something along the lines of:
1775
		 * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install
1776
		 *
1777
		 * @since 2.5.0
1778
		 *
1779
		 * @param string $status Plugin status - either 'install', 'update' or 'activate'.
1780
		 * @return string Properly encoded URL (not escaped).
1781
		 */
1782
		public function get_tgmpa_status_url( $status ) {
1783
			return add_query_arg(
1784
				array(
1785
					'plugin_status' => urlencode( $status ),
1786
				),
1787
				$this->get_tgmpa_url()
1788
			);
1789
		}
1790
1791
		/**
1792
		 * Determine whether there are open actions for plugins registered with TGMPA.
1793
		 *
1794
		 * @since 2.5.0
1795
		 *
1796
		 * @return bool True if complete, i.e. no outstanding actions. False otherwise.
1797
		 */
1798
		public function is_tgmpa_complete() {
1799
			$complete = true;
1800
			foreach ( $this->plugins as $slug => $plugin ) {
1801
				if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
1802
					$complete = false;
1803
					break;
1804
				}
1805
			}
1806
1807
			return $complete;
1808
		}
1809
1810
		/**
1811
		 * Check if a plugin is installed. Does not take must-use plugins into account.
1812
		 *
1813
		 * @since 2.5.0
1814
		 *
1815
		 * @param string $slug Plugin slug.
1816
		 * @return bool True if installed, false otherwise.
1817
		 */
1818
		public function is_plugin_installed( $slug ) {
1819
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1820
1821
			return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
1822
		}
1823
1824
		/**
1825
		 * Check if a plugin is active.
1826
		 *
1827
		 * @since 2.5.0
1828
		 *
1829
		 * @param string $slug Plugin slug.
1830
		 * @return bool True if active, false otherwise.
1831
		 */
1832
		public function is_plugin_active( $slug ) {
1833
			return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) ) || is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
1834
		}
1835
1836
		/**
1837
		 * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
1838
		 * available, check whether the current install meets them.
1839
		 *
1840
		 * @since 2.5.0
1841
		 *
1842
		 * @param string $slug Plugin slug.
1843
		 * @return bool True if OK to update, false otherwise.
1844
		 */
1845
		public function can_plugin_update( $slug ) {
1846
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1847
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1848
				return true;
1849
			}
1850
1851
			$api = $this->get_plugins_api( $slug );
1852
1853
			if ( false !== $api && isset( $api->requires ) ) {
1854
				return version_compare( $this->wp_version, $api->requires, '>=' );
1855
			}
1856
1857
			// No usable info received from the plugins API, presume we can update.
1858
			return true;
1859
		}
1860
1861
		/**
1862
		 * Check to see if the plugin is 'updatetable', i.e. installed, with an update available
1863
		 * and no WP version requirements blocking it.
1864
		 *
1865
		 * @since 2.x.x
1866
		 *
1867
		 * @param string $slug Plugin slug.
1868
		 * @return bool True if OK to proceed with update, false otherwise.
1869
		 */
1870
		public function is_plugin_updatetable( $slug ) {
1871
			if ( ! $this->is_plugin_installed( $slug ) ) {
1872
				return false;
1873
			} else {
1874
				return ( $this->does_plugin_have_update( $slug ) && $this->can_plugin_update( $slug ) );
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->does_plugin_have_update($slug) of type false|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
1875
			}
1876
		}
1877
1878
		/**
1879
		 * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
1880
		 * plugin version requirements set in TGMPA (if any).
1881
		 *
1882
		 * @since 2.5.0
1883
		 *
1884
		 * @param string $slug Plugin slug.
1885
		 * @return bool True if OK to activate, false otherwise.
1886
		 */
1887
		public function can_plugin_activate( $slug ) {
1888
			return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
1889
		}
1890
1891
		/**
1892
		 * Retrieve the version number of an installed plugin.
1893
		 *
1894
		 * @since 2.5.0
1895
		 *
1896
		 * @param string $slug Plugin slug.
1897
		 * @return string Version number as string or an empty string if the plugin is not installed
1898
		 *                or version unknown (plugins which don't comply with the plugin header standard).
1899
		 */
1900
		public function get_installed_version( $slug ) {
1901
			$installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
1902
1903
			if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
1904
				return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
1905
			}
1906
1907
			return '';
1908
		}
1909
1910
		/**
1911
		 * Check whether a plugin complies with the minimum version requirements.
1912
		 *
1913
		 * @since 2.5.0
1914
		 *
1915
		 * @param string $slug Plugin slug.
1916
		 * @return bool True when a plugin needs to be updated, otherwise false.
1917
		 */
1918
		public function does_plugin_require_update( $slug ) {
1919
			$installed_version = $this->get_installed_version( $slug );
1920
			$minimum_version   = $this->plugins[ $slug ]['version'];
1921
1922
			return version_compare( $minimum_version, $installed_version, '>' );
1923
		}
1924
1925
		/**
1926
		 * Check whether there is an update available for a plugin.
1927
		 *
1928
		 * @since 2.5.0
1929
		 *
1930
		 * @param string $slug Plugin slug.
1931
		 * @return false|string Version number string of the available update or false if no update available.
1932
		 */
1933
		public function does_plugin_have_update( $slug ) {
1934
			// Presume bundled and external plugins will point to a package which meets the minimum required version.
1935
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1936
				if ( $this->does_plugin_require_update( $slug ) ) {
1937
					return $this->plugins[ $slug ]['version'];
1938
				}
1939
1940
				return false;
1941
			}
1942
1943
			$repo_updates = get_site_transient( 'update_plugins' );
1944
1945 View Code Duplication
			if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
1946
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
1947
			}
1948
1949
			return false;
1950
		}
1951
1952
		/**
1953
		 * Retrieve potential upgrade notice for a plugin.
1954
		 *
1955
		 * @since 2.5.0
1956
		 *
1957
		 * @param string $slug Plugin slug.
1958
		 * @return string The upgrade notice or an empty string if no message was available or provided.
1959
		 */
1960
		public function get_upgrade_notice( $slug ) {
1961
			// We currently can't get reliable info on non-WP-repo plugins - issue #380.
1962
			if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
1963
				return '';
1964
			}
1965
1966
			$repo_updates = get_site_transient( 'update_plugins' );
1967
1968 View Code Duplication
			if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
1969
				return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
1970
			}
1971
1972
			return '';
1973
		}
1974
1975
		/**
1976
		 * Wrapper around the core WP get_plugins function, making sure it's actually available.
1977
		 *
1978
		 * @since 2.5.0
1979
		 *
1980
		 * @param string $plugin_folder Optional. Relative path to single plugin folder.
1981
		 * @return array Array of installed plugins with plugin information.
1982
		 */
1983
		public function get_plugins( $plugin_folder = '' ) {
1984
			if ( ! function_exists( 'get_plugins' ) ) {
1985
				require_once ABSPATH . 'wp-admin/includes/plugin.php';
1986
			}
1987
1988
			return get_plugins( $plugin_folder );
1989
		}
1990
1991
		/**
1992
		 * Delete dismissable nag option when theme is switched.
1993
		 *
1994
		 * This ensures that the user(s) is/are again reminded via nag of required
1995
		 * and/or recommended plugins if they re-activate the theme.
1996
		 *
1997
		 * @since 2.1.1
1998
		 */
1999
		public function update_dismiss() {
2000
			delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
2001
		}
2002
2003
		/**
2004
		 * Forces plugin activation if the parameter 'force_activation' is
2005
		 * set to true.
2006
		 *
2007
		 * This allows theme authors to specify certain plugins that must be
2008
		 * active at all times while using the current theme.
2009
		 *
2010
		 * Please take special care when using this parameter as it has the
2011
		 * potential to be harmful if not used correctly. Setting this parameter
2012
		 * to true will not allow the specified plugin to be deactivated unless
2013
		 * the user switches themes.
2014
		 *
2015
		 * @since 2.2.0
2016
		 */
2017
		public function force_activation() {
2018
			foreach ( $this->plugins as $slug => $plugin ) {
2019
				if ( true === $plugin['force_activation'] ) {
2020
					if ( ! $this->is_plugin_installed( $slug ) ) {
2021
						// Oops, plugin isn't there so iterate to next condition.
2022
						continue;
2023
					} elseif ( $this->can_plugin_activate( $slug ) ) {
2024
						// There we go, activate the plugin.
2025
						activate_plugin( $plugin['file_path'] );
2026
					}
2027
				}
2028
			}
2029
		}
2030
2031
		/**
2032
		 * Forces plugin deactivation if the parameter 'force_deactivation'
2033
		 * is set to true.
2034
		 *
2035
		 * This allows theme authors to specify certain plugins that must be
2036
		 * deactivated upon switching from the current theme to another.
2037
		 *
2038
		 * Please take special care when using this parameter as it has the
2039
		 * potential to be harmful if not used correctly.
2040
		 *
2041
		 * @since 2.2.0
2042
		 */
2043
		public function force_deactivation() {
2044
			foreach ( $this->plugins as $slug => $plugin ) {
2045
				// Only proceed forward if the parameter is set to true and plugin is active.
2046
				if ( true === $plugin['force_deactivation'] && $this->is_plugin_active( $slug ) ) {
2047
					deactivate_plugins( $plugin['file_path'] );
2048
				}
2049
			}
2050
		}
2051
2052
		/**
2053
		 * Echo the current TGMPA version number to the page.
2054
		 */
2055
		public function show_tgmpa_version() {
2056
			echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
2057
				esc_html(
2058
					sprintf(
2059
						/* translators: %s: version number */
2060
						__( 'TGMPA v%s', 'tgmpa' ),
2061
						self::TGMPA_VERSION
2062
					)
2063
				),
2064
				'</small></strong></p>';
2065
		}
2066
2067
		/**
2068
		 * Returns the singleton instance of the class.
2069
		 *
2070
		 * @since 2.4.0
2071
		 *
2072
		 * @return object The TGM_Plugin_Activation object.
2073
		 */
2074
		public static function get_instance() {
2075
			if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
2076
				self::$instance = new self();
2077
			}
2078
2079
			return self::$instance;
2080
		}
2081
	}
2082
2083
	if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
2084
		/**
2085
		 * Ensure only one instance of the class is ever invoked.
2086
		 */
2087
		function load_tgm_plugin_activation() {
2088
			$GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
2089
		}
2090
	}
2091
2092
	if ( did_action( 'plugins_loaded' ) ) {
2093
		load_tgm_plugin_activation();
2094
	} else {
2095
		add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
2096
	}
2097
}
2098
2099
if ( ! function_exists( 'tgmpa' ) ) {
2100
	/**
2101
	 * Helper function to register a collection of required plugins.
2102
	 *
2103
	 * @since 2.0.0
2104
	 * @api
2105
	 *
2106
	 * @param array $plugins An array of plugin arrays.
2107
	 * @param array $config  Optional. An array of configuration values.
2108
	 */
2109
	function tgmpa( $plugins, $config = array() ) {
2110
		$instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2111
2112
		foreach ( $plugins as $plugin ) {
2113
			call_user_func( array( $instance, 'register' ), $plugin );
2114
		}
2115
2116
		if ( ! empty( $config ) && is_array( $config ) ) {
2117
			// Send out notices for deprecated arguments passed.
2118
			if ( isset( $config['notices'] ) ) {
2119
				_deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
2120
				if ( ! isset( $config['has_notices'] ) ) {
2121
					$config['has_notices'] = $config['notices'];
2122
				}
2123
			}
2124
2125
			if ( isset( $config['parent_menu_slug'] ) ) {
2126
				_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.' );
2127
			}
2128
			if ( isset( $config['parent_url_slug'] ) ) {
2129
				_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.' );
2130
			}
2131
2132
			call_user_func( array( $instance, 'config' ), $config );
2133
		}
2134
	}
2135
}
2136
2137
/**
2138
 * WP_List_Table isn't always available. If it isn't available,
2139
 * we load it here.
2140
 *
2141
 * @since 2.2.0
2142
 */
2143
if ( ! class_exists( 'WP_List_Table' ) ) {
2144
	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
2145
}
2146
2147
if ( ! class_exists( 'TGMPA_List_Table' ) ) {
2148
2149
	/**
2150
	 * List table class for handling plugins.
2151
	 *
2152
	 * Extends the WP_List_Table class to provide a future-compatible
2153
	 * way of listing out all required/recommended plugins.
2154
	 *
2155
	 * Gives users an interface similar to the Plugin Administration
2156
	 * area with similar (albeit stripped down) capabilities.
2157
	 *
2158
	 * This class also allows for the bulk install of plugins.
2159
	 *
2160
	 * @since 2.2.0
2161
	 *
2162
	 * @package TGM-Plugin-Activation
2163
	 * @author  Thomas Griffin
2164
	 * @author  Gary Jones
2165
	 */
2166
	class TGMPA_List_Table extends WP_List_Table {
2167
		/**
2168
		 * TGMPA instance.
2169
		 *
2170
		 * @since 2.5.0
2171
		 *
2172
		 * @var object
2173
		 */
2174
		protected $tgmpa;
2175
2176
		/**
2177
		 * The currently chosen view.
2178
		 *
2179
		 * @since 2.5.0
2180
		 *
2181
		 * @var string One of: 'all', 'install', 'update', 'activate'
2182
		 */
2183
		public $view_context = 'all';
2184
2185
		/**
2186
		 * The plugin counts for the various views.
2187
		 *
2188
		 * @since 2.5.0
2189
		 *
2190
		 * @var array
2191
		 */
2192
		protected $view_totals = array(
2193
			'all'      => 0,
2194
			'install'  => 0,
2195
			'update'   => 0,
2196
			'activate' => 0,
2197
		);
2198
2199
		/**
2200
		 * References parent constructor and sets defaults for class.
2201
		 *
2202
		 * @since 2.2.0
2203
		 */
2204
		public function __construct() {
2205
			$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
2206
2207
			parent::__construct(
2208
				array(
2209
					'singular' => 'plugin',
2210
					'plural'   => 'plugins',
2211
					'ajax'     => false,
2212
				)
2213
			);
2214
2215
			if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
2216
				$this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
2217
			}
2218
2219
			add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
2220
		}
2221
2222
		/**
2223
		 * Get a list of CSS classes for the <table> tag.
2224
		 *
2225
		 * Overruled to prevent the 'plural' argument from being added.
2226
		 *
2227
		 * @since 2.5.0
2228
		 *
2229
		 * @return array CSS classnames.
2230
		 */
2231
		public function get_table_classes() {
2232
			return array( 'widefat', 'fixed' );
2233
		}
2234
2235
		/**
2236
		 * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
2237
		 *
2238
		 * @since 2.2.0
2239
		 *
2240
		 * @return array $table_data Information for use in table.
2241
		 */
2242
		protected function _gather_plugin_data() {
2243
			// Load thickbox for plugin links.
2244
			$this->tgmpa->admin_init();
2245
			$this->tgmpa->thickbox();
2246
2247
			// Categorize the plugins which have open actions.
2248
			$plugins = $this->categorize_plugins_to_views();
2249
2250
			// Set the counts for the view links.
2251
			$this->set_view_totals( $plugins );
2252
2253
			// Prep variables for use and grab list of all installed plugins.
2254
			$table_data = array();
2255
			$i          = 0;
2256
2257
			// Redirect to the 'all' view if no plugins were found for the selected view context.
2258
			if ( empty( $plugins[ $this->view_context ] ) ) {
2259
				$this->view_context = 'all';
2260
			}
2261
2262
			foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
2263
				$table_data[ $i ]['sanitized_plugin']  = $plugin['name'];
2264
				$table_data[ $i ]['slug']              = $slug;
2265
				$table_data[ $i ]['plugin']            = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
2266
				$table_data[ $i ]['source']            = $this->get_plugin_source_type_text( $plugin['source_type'] );
2267
				$table_data[ $i ]['type']              = $this->get_plugin_advise_type_text( $plugin['required'] );
2268
				$table_data[ $i ]['status']            = $this->get_plugin_status_text( $slug );
2269
				$table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
2270
				$table_data[ $i ]['minimum_version']   = $plugin['version'];
2271
				$table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
2272
2273
				// Prep the upgrade notice info.
2274
				$upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
2275
				if ( ! empty( $upgrade_notice ) ) {
2276
					$table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
2277
2278
					add_action( "tgmpa_after_plugin_row_$slug", array( $this, 'wp_plugin_update_row' ), 10, 2 );
2279
				}
2280
2281
				$table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
2282
2283
				$i++;
2284
			}
2285
2286
			return $table_data;
2287
		}
2288
2289
		/**
2290
		 * Categorize the plugins which have open actions into views for the TGMPA page.
2291
		 *
2292
		 * @since 2.5.0
2293
		 */
2294
		protected function categorize_plugins_to_views() {
2295
			$plugins = array(
2296
				'all'      => array(), // Meaning: all plugins which still have open actions.
2297
				'install'  => array(),
2298
				'update'   => array(),
2299
				'activate' => array(),
2300
			);
2301
2302
			foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
2303
				if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2304
					// No need to display plugins if they are installed, up-to-date and active.
2305
					continue;
2306
				} else {
2307
					$plugins['all'][ $slug ] = $plugin;
2308
2309
					if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2310
						$plugins['install'][ $slug ] = $plugin;
2311
					} else {
2312
						if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2313
							$plugins['update'][ $slug ] = $plugin;
2314
						}
2315
2316
						if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
2317
							$plugins['activate'][ $slug ] = $plugin;
2318
						}
2319
					}
2320
				}
2321
			}
2322
2323
			return $plugins;
2324
		}
2325
2326
		/**
2327
		 * Set the counts for the view links.
2328
		 *
2329
		 * @since 2.5.0
2330
		 *
2331
		 * @param array $plugins Plugins order by view.
2332
		 */
2333
		protected function set_view_totals( $plugins ) {
2334
			foreach ( $plugins as $type => $list ) {
2335
				$this->view_totals[ $type ] = count( $list );
2336
			}
2337
		}
2338
2339
		/**
2340
		 * Get the plugin required/recommended text string.
2341
		 *
2342
		 * @since 2.5.0
2343
		 *
2344
		 * @param string $required Plugin required setting.
2345
		 * @return string
2346
		 */
2347
		protected function get_plugin_advise_type_text( $required ) {
2348
			if ( true === $required ) {
2349
				return __( 'Required', 'tgmpa' );
2350
			}
2351
2352
			return __( 'Recommended', 'tgmpa' );
2353
		}
2354
2355
		/**
2356
		 * Get the plugin source type text string.
2357
		 *
2358
		 * @since 2.5.0
2359
		 *
2360
		 * @param string $type Plugin type.
2361
		 * @return string
2362
		 */
2363
		protected function get_plugin_source_type_text( $type ) {
2364
			$string = '';
2365
2366
			switch ( $type ) {
2367
				case 'repo':
2368
					$string = __( 'WordPress Repository', 'tgmpa' );
2369
					break;
2370
				case 'external':
2371
					$string = __( 'External Source', 'tgmpa' );
2372
					break;
2373
				case 'bundled':
2374
					$string = __( 'Pre-Packaged', 'tgmpa' );
2375
					break;
2376
			}
2377
2378
			return $string;
2379
		}
2380
2381
		/**
2382
		 * Determine the plugin status message.
2383
		 *
2384
		 * @since 2.5.0
2385
		 *
2386
		 * @param string $slug Plugin slug.
2387
		 * @return string
2388
		 */
2389
		protected function get_plugin_status_text( $slug ) {
2390
			if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
2391
				return __( 'Not Installed', 'tgmpa' );
2392
			}
2393
2394
			if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
2395
				$install_status = __( 'Installed But Not Activated', 'tgmpa' );
2396
			} else {
2397
				$install_status = __( 'Active', 'tgmpa' );
2398
			}
2399
2400
			$update_status = '';
2401
2402
			if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
2403
				$update_status = __( 'Required Update not Available', 'tgmpa' );
2404
2405
			} elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
2406
				$update_status = __( 'Requires Update', 'tgmpa' );
2407
2408
			} elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
2409
				$update_status = __( 'Update recommended', 'tgmpa' );
2410
			}
2411
2412
			if ( '' === $update_status ) {
2413
				return $install_status;
2414
			}
2415
2416
			return sprintf(
2417
				/* translators: 1: install status, 2: update status */
2418
				_x( '%1$s, %2$s', 'Install/Update Status', 'tgmpa' ),
2419
				$install_status,
2420
				$update_status
2421
			);
2422
		}
2423
2424
		/**
2425
		 * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
2426
		 *
2427
		 * @since 2.5.0
2428
		 *
2429
		 * @param array $items Prepared table items.
2430
		 * @return array Sorted table items.
2431
		 */
2432
		public function sort_table_items( $items ) {
2433
			$type = array();
2434
			$name = array();
2435
2436
			foreach ( $items as $i => $plugin ) {
2437
				$type[ $i ] = $plugin['type']; // Required / recommended.
2438
				$name[ $i ] = $plugin['sanitized_plugin'];
2439
			}
2440
2441
			array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
2442
2443
			return $items;
2444
		}
2445
2446
		/**
2447
		 * Get an associative array ( id => link ) of the views available on this table.
2448
		 *
2449
		 * @since 2.5.0
2450
		 *
2451
		 * @return array
2452
		 */
2453
		public function get_views() {
2454
			$status_links = array();
2455
2456
			foreach ( $this->view_totals as $type => $count ) {
2457
				if ( $count < 1 ) {
2458
					continue;
2459
				}
2460
2461
				switch ( $type ) {
2462
					case 'all':
2463
						/* translators: 1: number of plugins. */
2464
						$text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
2465
						break;
2466
					case 'install':
2467
						/* translators: 1: number of plugins. */
2468
						$text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
2469
						break;
2470
					case 'update':
2471
						/* translators: 1: number of plugins. */
2472
						$text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
2473
						break;
2474
					case 'activate':
2475
						/* translators: 1: number of plugins. */
2476
						$text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
2477
						break;
2478
					default:
2479
						$text = '';
2480
						break;
2481
				}
2482
2483
				if ( ! empty( $text ) ) {
2484
2485
					$status_links[ $type ] = sprintf(
2486
						'<a href="%s"%s>%s</a>',
2487
						esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
2488
						( $type === $this->view_context ) ? ' class="current"' : '',
2489
						sprintf( $text, number_format_i18n( $count ) )
2490
					);
2491
				}
2492
			}
2493
2494
			return $status_links;
2495
		}
2496
2497
		/**
2498
		 * Create default columns to display important plugin information
2499
		 * like type, action and status.
2500
		 *
2501
		 * @since 2.2.0
2502
		 *
2503
		 * @param array  $item        Array of item data.
2504
		 * @param string $column_name The name of the column.
2505
		 * @return string
2506
		 */
2507
		public function column_default( $item, $column_name ) {
2508
			return $item[ $column_name ];
2509
		}
2510
2511
		/**
2512
		 * Required for bulk installing.
2513
		 *
2514
		 * Adds a checkbox for each plugin.
2515
		 *
2516
		 * @since 2.2.0
2517
		 *
2518
		 * @param array $item Array of item data.
2519
		 * @return string The input checkbox with all necessary info.
2520
		 */
2521
		public function column_cb( $item ) {
2522
			return sprintf(
2523
				'<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
2524
				esc_attr( $this->_args['singular'] ),
2525
				esc_attr( $item['slug'] ),
2526
				esc_attr( $item['sanitized_plugin'] )
2527
			);
2528
		}
2529
2530
		/**
2531
		 * Create default title column along with the action links.
2532
		 *
2533
		 * @since 2.2.0
2534
		 *
2535
		 * @param array $item Array of item data.
2536
		 * @return string The plugin name and action links.
2537
		 */
2538
		public function column_plugin( $item ) {
2539
			return sprintf(
2540
				'%1$s %2$s',
2541
				$item['plugin'],
2542
				$this->row_actions( $this->get_row_actions( $item ), true )
2543
			);
2544
		}
2545
2546
		/**
2547
		 * Create version information column.
2548
		 *
2549
		 * @since 2.5.0
2550
		 *
2551
		 * @param array $item Array of item data.
2552
		 * @return string HTML-formatted version information.
2553
		 */
2554
		public function column_version( $item ) {
2555
			$output = array();
2556
2557
			if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2558
				$installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
2559
2560
				$color = '';
2561
				if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
2562
					$color = ' color: #ff0000; font-weight: bold;';
2563
				}
2564
2565
				$output[] = sprintf(
2566
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
2567
					$color,
2568
					$installed
2569
				);
2570
			}
2571
2572
			if ( ! empty( $item['minimum_version'] ) ) {
2573
				$output[] = sprintf(
2574
					'<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
2575
					$item['minimum_version']
2576
				);
2577
			}
2578
2579
			if ( ! empty( $item['available_version'] ) ) {
2580
				$color = '';
2581
				if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
2582
					$color = ' color: #71C671; font-weight: bold;';
2583
				}
2584
2585
				$output[] = sprintf(
2586
					'<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
2587
					$color,
2588
					$item['available_version']
2589
				);
2590
			}
2591
2592
			if ( empty( $output ) ) {
2593
				return '&nbsp;'; // Let's not break the table layout.
2594
			} else {
2595
				return implode( "\n", $output );
2596
			}
2597
		}
2598
2599
		/**
2600
		 * Sets default message within the plugins table if no plugins
2601
		 * are left for interaction.
2602
		 *
2603
		 * Hides the menu item to prevent the user from clicking and
2604
		 * getting a permissions error.
2605
		 *
2606
		 * @since 2.2.0
2607
		 */
2608
		public function no_items() {
2609
			echo esc_html__( 'No plugins to install, update or activate.', 'tgmpa' ) . ' <a href="' . esc_url( self_admin_url() ) . '"> ' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>';
2610
			echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
2611
		}
2612
2613
		/**
2614
		 * Output all the column information within the table.
2615
		 *
2616
		 * @since 2.2.0
2617
		 *
2618
		 * @return array $columns The column names.
2619
		 */
2620
		public function get_columns() {
2621
			$columns = array(
2622
				'cb'     => '<input type="checkbox" />',
2623
				'plugin' => __( 'Plugin', 'tgmpa' ),
2624
				'source' => __( 'Source', 'tgmpa' ),
2625
				'type'   => __( 'Type', 'tgmpa' ),
2626
			);
2627
2628
			if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
2629
				$columns['version'] = __( 'Version', 'tgmpa' );
2630
				$columns['status']  = __( 'Status', 'tgmpa' );
2631
			}
2632
2633
			return apply_filters( 'tgmpa_table_columns', $columns );
2634
		}
2635
2636
		/**
2637
		 * Get name of default primary column
2638
		 *
2639
		 * @since 2.5.0 / WP 4.3+ compatibility
2640
		 * @access protected
2641
		 *
2642
		 * @return string
2643
		 */
2644
		protected function get_default_primary_column_name() {
2645
			return 'plugin';
2646
		}
2647
2648
		/**
2649
		 * Get the name of the primary column.
2650
		 *
2651
		 * @since 2.5.0 / WP 4.3+ compatibility
2652
		 * @access protected
2653
		 *
2654
		 * @return string The name of the primary column.
2655
		 */
2656
		protected function get_primary_column_name() {
2657
			if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
2658
				return parent::get_primary_column_name();
2659
			} else {
2660
				return $this->get_default_primary_column_name();
2661
			}
2662
		}
2663
2664
		/**
2665
		 * Get the actions which are relevant for a specific plugin row.
2666
		 *
2667
		 * @since 2.5.0
2668
		 *
2669
		 * @param array $item Array of item data.
2670
		 * @return array Array with relevant action links.
2671
		 */
2672
		protected function get_row_actions( $item ) {
2673
			$actions      = array();
2674
			$action_links = array();
2675
2676
			// Display the 'Install' action link if the plugin is not yet available.
2677
			if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
2678
				/* translators: %s: plugin name in screen reader markup */
2679
				$actions['install'] = __( 'Install %s', 'tgmpa' );
2680
			} else {
2681
				// Display the 'Update' action link if an update is available and WP complies with plugin minimum.
2682
				if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
2683
					/* translators: %s: plugin name in screen reader markup */
2684
					$actions['update'] = __( 'Update %s', 'tgmpa' );
2685
				}
2686
2687
				// Display the 'Activate' action link, but only if the plugin meets the minimum version.
2688
				if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
2689
					/* translators: %s: plugin name in screen reader markup */
2690
					$actions['activate'] = __( 'Activate %s', 'tgmpa' );
2691
				}
2692
			}
2693
2694
			// Create the actual links.
2695
			foreach ( $actions as $action => $text ) {
2696
				$nonce_url = wp_nonce_url(
2697
					add_query_arg(
2698
						array(
2699
							'plugin'           => urlencode( $item['slug'] ),
2700
							'tgmpa-' . $action => $action . '-plugin',
2701
						),
2702
						$this->tgmpa->get_tgmpa_url()
2703
					),
2704
					'tgmpa-' . $action,
2705
					'tgmpa-nonce'
2706
				);
2707
2708
				$action_links[ $action ] = sprintf(
2709
					'<a href="%1$s">' . esc_html( $text ) . '</a>',
2710
					esc_url( $nonce_url ),
2711
					'<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
2712
				);
2713
			}
2714
2715
			$prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
2716
			return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
2717
		}
2718
2719
		/**
2720
		 * Generates content for a single row of the table.
2721
		 *
2722
		 * @since 2.5.0
2723
		 *
2724
		 * @param object $item The current item.
2725
		 */
2726
		public function single_row( $item ) {
2727
			parent::single_row( $item );
2728
2729
			/**
2730
			 * Fires after each specific row in the TGMPA Plugins list table.
2731
			 *
2732
			 * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
2733
			 * for the plugin.
2734
			 *
2735
			 * @since 2.5.0
2736
			 */
2737
			do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
2738
		}
2739
2740
		/**
2741
		 * Show the upgrade notice below a plugin row if there is one.
2742
		 *
2743
		 * @since 2.5.0
2744
		 *
2745
		 * @see /wp-admin/includes/update.php
2746
		 *
2747
		 * @param string $slug Plugin slug.
2748
		 * @param array  $item The information available in this table row.
2749
		 * @return null Return early if upgrade notice is empty.
2750
		 */
2751
		public function wp_plugin_update_row( $slug, $item ) {
2752
			if ( empty( $item['upgrade_notice'] ) ) {
2753
				return;
2754
			}
2755
2756
			echo '
2757
				<tr class="plugin-update-tr">
2758
					<td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
2759
						<div class="update-message">',
2760
							esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
2761
							' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
2762
						</div>
2763
					</td>
2764
				</tr>';
2765
		}
2766
2767
		/**
2768
		 * Extra controls to be displayed between bulk actions and pagination.
2769
		 *
2770
		 * @since 2.5.0
2771
		 *
2772
		 * @param string $which 'top' or 'bottom' table navigation.
2773
		 */
2774
		public function extra_tablenav( $which ) {
2775
			if ( 'bottom' === $which ) {
2776
				$this->tgmpa->show_tgmpa_version();
2777
			}
2778
		}
2779
2780
		/**
2781
		 * Defines the bulk actions for handling registered plugins.
2782
		 *
2783
		 * @since 2.2.0
2784
		 *
2785
		 * @return array $actions The bulk actions for the plugin install table.
2786
		 */
2787
		public function get_bulk_actions() {
2788
2789
			$actions = array();
2790
2791
			if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
2792
				if ( current_user_can( 'install_plugins' ) ) {
2793
					$actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
2794
				}
2795
			}
2796
2797
			if ( 'install' !== $this->view_context ) {
2798
				if ( current_user_can( 'update_plugins' ) ) {
2799
					$actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
2800
				}
2801
				if ( current_user_can( 'activate_plugins' ) ) {
2802
					$actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
2803
				}
2804
			}
2805
2806
			return $actions;
2807
		}
2808
2809
		/**
2810
		 * Processes bulk installation and activation actions.
2811
		 *
2812
		 * The bulk installation process looks for the $_POST information and passes that
2813
		 * through if a user has to use WP_Filesystem to enter their credentials.
2814
		 *
2815
		 * @since 2.2.0
2816
		 */
2817
		public function process_bulk_actions() {
2818
			// Bulk installation process.
2819
			if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
2820
2821
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2822
2823
				$install_type = 'install';
2824
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2825
					$install_type = 'update';
2826
				}
2827
2828
				$plugins_to_install = array();
2829
2830
				// Did user actually select any plugins to install/update ?
2831 View Code Duplication
				if ( empty( $_POST['plugin'] ) ) {
2832
					if ( 'install' === $install_type ) {
2833
						$message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
2834
					} else {
2835
						$message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
2836
					}
2837
2838
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2839
2840
					return false;
2841
				}
2842
2843
				if ( is_array( $_POST['plugin'] ) ) {
2844
					$plugins_to_install = (array) $_POST['plugin'];
2845
				} elseif ( is_string( $_POST['plugin'] ) ) {
2846
					// Received via Filesystem page - un-flatten array (WP bug #19643).
2847
					$plugins_to_install = explode( ',', $_POST['plugin'] );
2848
				}
2849
2850
				// Sanitize the received input.
2851
				$plugins_to_install = array_map( 'urldecode', $plugins_to_install );
2852
				$plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
2853
2854
				// Validate the received input.
2855
				foreach ( $plugins_to_install as $key => $slug ) {
2856
					// Check if the plugin was registered with TGMPA and remove if not.
2857
					if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
2858
						unset( $plugins_to_install[ $key ] );
2859
						continue;
2860
					}
2861
2862
					// For install: make sure this is a plugin we *can* install and not one already installed.
2863
					if ( 'install' === $install_type && true === $this->tgmpa->is_plugin_installed( $slug ) ) {
2864
						unset( $plugins_to_install[ $key ] );
2865
					}
2866
2867
					// For updates: make sure this is a plugin we *can* update (update available and WP version ok).
2868
					if ( 'update' === $install_type && false === $this->tgmpa->is_plugin_updatetable( $slug ) ) {
2869
						unset( $plugins_to_install[ $key ] );
2870
					}
2871
				}
2872
2873
				// No need to proceed further if we have no plugins to handle.
2874 View Code Duplication
				if ( empty( $plugins_to_install ) ) {
2875
					if ( 'install' === $install_type ) {
2876
						$message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
2877
					} else {
2878
						$message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
2879
					}
2880
2881
					echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
2882
2883
					return false;
2884
				}
2885
2886
				// Pass all necessary information if WP_Filesystem is needed.
2887
				$url = wp_nonce_url(
2888
					$this->tgmpa->get_tgmpa_url(),
2889
					'bulk-' . $this->_args['plural']
2890
				);
2891
2892
				// Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
2893
				$_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
2894
2895
				$method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
2896
				$fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
2897
2898 View Code Duplication
				if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields ) ) ) {
2899
					return true; // Stop the normal page form from displaying, credential request form will be shown.
2900
				}
2901
2902
				// Now we have some credentials, setup WP_Filesystem.
2903 View Code Duplication
				if ( ! WP_Filesystem( $creds ) ) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

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

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

Loading history...
2904
					// Our credentials were no good, ask the user for them again.
2905
					request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
2906
2907
					return true;
2908
				}
2909
2910
				/* If we arrive here, we have the filesystem */
2911
2912
				// Store all information in arrays since we are processing a bulk installation.
2913
				$names      = array();
2914
				$sources    = array(); // Needed for installs.
2915
				$file_paths = array(); // Needed for upgrades.
2916
				$to_inject  = array(); // Information to inject into the update_plugins transient.
2917
2918
				// Prepare the data for validated plugins for the install/upgrade.
2919
				foreach ( $plugins_to_install as $slug ) {
2920
					$name   = $this->tgmpa->plugins[ $slug ]['name'];
2921
					$source = $this->tgmpa->get_download_url( $slug );
2922
2923
					if ( ! empty( $name ) && ! empty( $source ) ) {
2924
						$names[] = $name;
2925
2926
						switch ( $install_type ) {
2927
2928
							case 'install':
2929
								$sources[] = $source;
2930
								break;
2931
2932
							case 'update':
2933
								$file_paths[]                 = $this->tgmpa->plugins[ $slug ]['file_path'];
2934
								$to_inject[ $slug ]           = $this->tgmpa->plugins[ $slug ];
2935
								$to_inject[ $slug ]['source'] = $source;
2936
								break;
2937
						}
2938
					}
2939
				}
2940
				unset( $slug, $name, $source );
2941
2942
				// Create a new instance of TGMPA_Bulk_Installer.
2943
				$installer = new TGMPA_Bulk_Installer(
2944
					new TGMPA_Bulk_Installer_Skin(
2945
						array(
2946
							'url'          => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
2947
							'nonce'        => 'bulk-' . $this->_args['plural'],
2948
							'names'        => $names,
2949
							'install_type' => $install_type,
2950
						)
2951
					)
2952
				);
2953
2954
				// Wrap the install process with the appropriate HTML.
2955
				echo '<div class="tgmpa">',
2956
					'<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>
2957
					<div class="update-php" style="width: 100%; height: 98%; min-height: 850px; padding-top: 1px;">';
2958
2959
				// Process the bulk installation submissions.
2960
				add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
2961
2962
				if ( 'tgmpa-bulk-update' === $this->current_action() ) {
2963
					// Inject our info into the update transient.
2964
					$this->tgmpa->inject_update_info( $to_inject );
2965
2966
					$installer->bulk_upgrade( $file_paths );
2967
				} else {
2968
					$installer->bulk_install( $sources );
2969
				}
2970
2971
				remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1 );
2972
2973
				echo '</div></div>';
2974
2975
				return true;
2976
			}
2977
2978
			// Bulk activation process.
2979
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
2980
				check_admin_referer( 'bulk-' . $this->_args['plural'] );
2981
2982
				// Did user actually select any plugins to activate ?
2983
				if ( empty( $_POST['plugin'] ) ) {
2984
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
2985
2986
					return false;
2987
				}
2988
2989
				// Grab plugin data from $_POST.
2990
				$plugins = array();
2991
				if ( isset( $_POST['plugin'] ) ) {
2992
					$plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
2993
					$plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
2994
				}
2995
2996
				$plugins_to_activate = array();
2997
				$plugin_names        = array();
2998
2999
				// Grab the file paths for the selected & inactive plugins from the registration array.
3000
				foreach ( $plugins as $slug ) {
3001
					if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
3002
						$plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
3003
						$plugin_names[]        = $this->tgmpa->plugins[ $slug ]['name'];
3004
					}
3005
				}
3006
				unset( $slug );
3007
3008
				// Return early if there are no plugins to activate.
3009
				if ( empty( $plugins_to_activate ) ) {
3010
					echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
3011
3012
					return false;
3013
				}
3014
3015
				// Now we are good to go - let's start activating plugins.
3016
				$activate = activate_plugins( $plugins_to_activate );
3017
3018
				if ( is_wp_error( $activate ) ) {
3019
					echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
3020
				} else {
3021
					$count        = count( $plugin_names ); // Count so we can use _n function.
3022
					$plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
3023
					$last_plugin  = array_pop( $plugin_names ); // Pop off last name to prep for readability.
3024
					$imploded     = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
3025
3026
					printf( // WPCS: xss ok.
3027
						'<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
3028
						esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
3029
						$imploded
3030
					);
3031
3032
					// Update recently activated plugins option.
3033
					$recent = (array) get_option( 'recently_activated' );
3034
					foreach ( $plugins_to_activate as $plugin => $time ) {
3035
						if ( isset( $recent[ $plugin ] ) ) {
3036
							unset( $recent[ $plugin ] );
3037
						}
3038
					}
3039
					update_option( 'recently_activated', $recent );
3040
				}
3041
3042
				unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
3043
3044
				return true;
3045
			}
3046
3047
			return false;
3048
		}
3049
3050
		/**
3051
		 * Prepares all of our information to be outputted into a usable table.
3052
		 *
3053
		 * @since 2.2.0
3054
		 */
3055
		public function prepare_items() {
3056
			$columns               = $this->get_columns(); // Get all necessary column information.
3057
			$hidden                = array(); // No columns to hide, but we must set as an array.
3058
			$sortable              = array(); // No reason to make sortable columns.
3059
			$primary               = $this->get_primary_column_name(); // Column which has the row actions.
3060
			$this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
3061
3062
			// Process our bulk activations here.
3063
			if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
3064
				$this->process_bulk_actions();
3065
			}
3066
3067
			// Store all of our plugin data into $items array so WP_List_Table can use it.
3068
			$this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
3069
		}
3070
3071
		/* *********** DEPRECATED METHODS *********** */
3072
3073
		/**
3074
		 * Retrieve plugin data, given the plugin name.
3075
		 *
3076
		 * @since      2.2.0
3077
		 * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
3078
		 * @see        TGM_Plugin_Activation::_get_plugin_data_from_name()
3079
		 *
3080
		 * @param string $name Name of the plugin, as it was registered.
3081
		 * @param string $data Optional. Array key of plugin data to return. Default is slug.
3082
		 * @return string|boolean Plugin slug if found, false otherwise.
3083
		 */
3084
		protected function _get_plugin_data_from_name( $name, $data = 'slug' ) {
3085
			_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
3086
3087
			return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
3088
		}
3089
	}
3090
}
3091
3092
3093
if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
3094
3095
	/**
3096
	 * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
3097
	 */
3098
	class TGM_Bulk_Installer {
3099
	}
3100
}
3101
if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
3102
3103
	/**
3104
	 * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
3105
	 */
3106
	class TGM_Bulk_Installer_Skin {
3107
	}
3108
}
3109
3110
/**
3111
 * The WP_Upgrader file isn't always available. If it isn't available,
3112
 * we load it here.
3113
 *
3114
 * We check to make sure no action or activation keys are set so that WordPress
3115
 * does not try to re-include the class when processing upgrades or installs outside
3116
 * of the class.
3117
 *
3118
 * @since 2.2.0
3119
 */
3120
add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
3121
if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
3122
	/**
3123
	 * Load bulk installer
3124
	 */
3125
	function tgmpa_load_bulk_installer() {
3126
		// Silently fail if 2.5+ is loaded *after* an older version.
3127
		if ( ! isset( $GLOBALS['tgmpa'] ) ) {
3128
			return;
3129
		}
3130
3131
		// Get TGMPA class instance.
3132
		$tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3133
3134
		if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
3135
			if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
3136
				require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
3137
			}
3138
3139
			if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
3140
3141
				/**
3142
				 * Installer class to handle bulk plugin installations.
3143
				 *
3144
				 * Extends WP_Upgrader and customizes to suit the installation of multiple
3145
				 * plugins.
3146
				 *
3147
				 * @since 2.2.0
3148
				 *
3149
				 * {@internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader.}}
3150
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
3151
				 *            This was done to prevent backward compatibility issues with v2.3.6.}}
3152
				 *
3153
				 * @package TGM-Plugin-Activation
3154
				 * @author  Thomas Griffin
3155
				 * @author  Gary Jones
3156
				 */
3157
				class TGMPA_Bulk_Installer extends Plugin_Upgrader {
3158
					/**
3159
					 * Holds result of bulk plugin installation.
3160
					 *
3161
					 * @since 2.2.0
3162
					 *
3163
					 * @var string
3164
					 */
3165
					public $result;
3166
3167
					/**
3168
					 * Flag to check if bulk installation is occurring or not.
3169
					 *
3170
					 * @since 2.2.0
3171
					 *
3172
					 * @var boolean
3173
					 */
3174
					public $bulk = false;
3175
3176
					/**
3177
					 * TGMPA instance
3178
					 *
3179
					 * @since 2.5.0
3180
					 *
3181
					 * @var object
3182
					 */
3183
					protected $tgmpa;
3184
3185
					/**
3186
					 * Whether or not the destination directory needs to be cleared ( = on update).
3187
					 *
3188
					 * @since 2.5.0
3189
					 *
3190
					 * @var bool
3191
					 */
3192
					protected $clear_destination = false;
3193
3194
					/**
3195
					 * References parent constructor and sets defaults for class.
3196
					 *
3197
					 * @since 2.2.0
3198
					 *
3199
					 * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
3200
					 */
3201
					public function __construct( $skin = null ) {
3202
						// Get TGMPA class instance.
3203
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3204
3205
						parent::__construct( $skin );
3206
3207
						if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
3208
							$this->clear_destination = true;
3209
						}
3210
3211
						if ( $this->tgmpa->is_automatic ) {
3212
							$this->activate_strings();
3213
						}
3214
3215
						add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
3216
					}
3217
3218
					/**
3219
					 * Sets the correct activation strings for the installer skin to use.
3220
					 *
3221
					 * @since 2.2.0
3222
					 */
3223
					public function activate_strings() {
3224
						$this->strings['activation_failed']  = __( 'Plugin activation failed.', 'tgmpa' );
3225
						$this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
3226
					}
3227
3228
					/**
3229
					 * Performs the actual installation of each plugin.
3230
					 *
3231
					 * @since 2.2.0
3232
					 *
3233
					 * @see WP_Upgrader::run()
3234
					 *
3235
					 * @param array $options The installation config options.
3236
					 * @return null|array Return early if error, array of installation data on success.
3237
					 */
3238
					public function run( $options ) {
3239
						$result = parent::run( $options );
3240
3241
						// Reset the strings in case we changed one during automatic activation.
3242
						if ( $this->tgmpa->is_automatic ) {
3243
							if ( 'update' === $this->skin->options['install_type'] ) {
3244
								$this->upgrade_strings();
3245
							} else {
3246
								$this->install_strings();
3247
							}
3248
						}
3249
3250
						return $result;
3251
					}
3252
3253
					/**
3254
					 * Processes the bulk installation of plugins.
3255
					 *
3256
					 * @since 2.2.0
3257
					 *
3258
					 * {@internal This is basically a near identical copy of the WP Core
3259
					 * Plugin_Upgrader::bulk_upgrade() method, with minor adjustments to deal with
3260
					 * new installs instead of upgrades.
3261
					 * For ease of future synchronizations, the adjustments are clearly commented, but no other
3262
					 * comments are added. Code style has been made to comply.}}
3263
					 *
3264
					 * @see Plugin_Upgrader::bulk_upgrade()
3265
					 * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
3266
					 * (@internal Last synced: Dec 31st 2015 against https://core.trac.wordpress.org/browser/trunk?rev=36134}}
3267
					 *
3268
					 * @param array $plugins The plugin sources needed for installation.
3269
					 * @param array $args    Arbitrary passed extra arguments.
3270
					 * @return string|bool Install confirmation messages on success, false on failure.
3271
					 */
3272
					public function bulk_install( $plugins, $args = array() ) {
3273
						// [TGMPA + ] Hook auto-activation in.
3274
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3275
3276
						$defaults    = array(
3277
							'clear_update_cache' => true,
3278
						);
3279
						$parsed_args = wp_parse_args( $args, $defaults );
3280
3281
						$this->init();
3282
						$this->bulk = true;
3283
3284
						$this->install_strings(); // [TGMPA + ] adjusted.
3285
3286
						/* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
3287
3288
						/* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
3289
3290
						$this->skin->header();
3291
3292
						// Connect to the Filesystem first.
3293
						$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
3294
						if ( ! $res ) {
3295
							$this->skin->footer();
3296
							return false;
3297
						}
3298
3299
						$this->skin->bulk_header();
3300
3301
						/*
3302
						 * Only start maintenance mode if:
3303
						 * - running Multisite and there are one or more plugins specified, OR
3304
						 * - a plugin with an update available is currently active.
3305
						 * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
3306
						 */
3307
						$maintenance = ( is_multisite() && ! empty( $plugins ) );
3308
3309
						/*
3310
						[TGMPA - ]
3311
						foreach ( $plugins as $plugin )
3312
							$maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
3313
						*/
3314
						if ( $maintenance ) {
3315
							$this->maintenance_mode( true );
3316
						}
3317
3318
						$results = array();
3319
3320
						$this->update_count   = count( $plugins );
3321
						$this->update_current = 0;
3322
						foreach ( $plugins as $plugin ) {
3323
							$this->update_current++;
3324
3325
							/*
3326
							[TGMPA - ]
3327
							$this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
3328
3329
							if ( !isset( $current->response[ $plugin ] ) ) {
3330
								$this->skin->set_result('up_to_date');
3331
								$this->skin->before();
3332
								$this->skin->feedback('up_to_date');
3333
								$this->skin->after();
3334
								$results[$plugin] = true;
3335
								continue;
3336
							}
3337
3338
							// Get the URL to the zip file.
3339
							$r = $current->response[ $plugin ];
3340
3341
							$this->skin->plugin_active = is_plugin_active($plugin);
3342
							*/
3343
3344
							$result = $this->run(
3345
								array(
3346
									'package'           => $plugin, // [TGMPA + ] adjusted.
3347
									'destination'       => WP_PLUGIN_DIR,
3348
									'clear_destination' => false, // [TGMPA + ] adjusted.
3349
									'clear_working'     => true,
3350
									'is_multi'          => true,
3351
									'hook_extra'        => array(
3352
										'plugin' => $plugin,
3353
									),
3354
								)
3355
							);
3356
3357
							$results[ $plugin ] = $this->result;
3358
3359
							// Prevent credentials auth screen from displaying multiple times.
3360
							if ( false === $result ) {
3361
								break;
3362
							}
3363
						} //end foreach $plugins
3364
3365
						$this->maintenance_mode( false );
3366
3367
						/**
3368
						 * Fires when the bulk upgrader process is complete.
3369
						 *
3370
						 * @since WP 3.6.0 / TGMPA 2.5.0
3371
						 *
3372
						 * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
3373
						 *                              be a Theme_Upgrader or Core_Upgrade instance.
3374
						 * @param array           $data {
3375
						 *     Array of bulk item update data.
3376
						 *
3377
						 *     @type string $action   Type of action. Default 'update'.
3378
						 *     @type string $type     Type of update process. Accepts 'plugin', 'theme', or 'core'.
3379
						 *     @type bool   $bulk     Whether the update process is a bulk update. Default true.
3380
						 *     @type array  $packages Array of plugin, theme, or core packages to update.
3381
						 * }
3382
						 */
3383
						do_action( 'upgrader_process_complete', $this, array(
3384
							'action'  => 'install', // [TGMPA + ] adjusted.
3385
							'type'    => 'plugin',
3386
							'bulk'    => true,
3387
							'plugins' => $plugins,
3388
						) );
3389
3390
						$this->skin->bulk_footer();
3391
3392
						$this->skin->footer();
3393
3394
						// Cleanup our hooks, in case something else does a upgrade on this connection.
3395
						/* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
3396
3397
						// [TGMPA + ] Remove our auto-activation hook.
3398
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3399
3400
						// Force refresh of plugin update information.
3401
						wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
3402
3403
						return $results;
3404
					}
3405
3406
					/**
3407
					 * Handle a bulk upgrade request.
3408
					 *
3409
					 * @since 2.5.0
3410
					 *
3411
					 * @see Plugin_Upgrader::bulk_upgrade()
3412
					 *
3413
					 * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
3414
					 * @param array $args    Arbitrary passed extra arguments.
3415
					 * @return string|bool Install confirmation messages on success, false on failure.
3416
					 */
3417
					public function bulk_upgrade( $plugins, $args = array() ) {
3418
3419
						add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3420
3421
						$result = parent::bulk_upgrade( $plugins, $args );
3422
3423
						remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
3424
3425
						return $result;
3426
					}
3427
3428
					/**
3429
					 * Abuse a filter to auto-activate plugins after installation.
3430
					 *
3431
					 * Hooked into the 'upgrader_post_install' filter hook.
3432
					 *
3433
					 * @since 2.5.0
3434
					 *
3435
					 * @param bool $bool The value we need to give back (true).
3436
					 * @return bool
3437
					 */
3438
					public function auto_activate( $bool ) {
3439
						// Only process the activation of installed plugins if the automatic flag is set to true.
3440
						if ( $this->tgmpa->is_automatic ) {
3441
							// Flush plugins cache so the headers of the newly installed plugins will be read correctly.
3442
							wp_clean_plugins_cache();
3443
3444
							// Get the installed plugin file.
3445
							$plugin_info = $this->plugin_info();
3446
3447
							// Don't try to activate on upgrade of active plugin as WP will do this already.
3448
							if ( ! is_plugin_active( $plugin_info ) ) {
3449
								$activate = activate_plugin( $plugin_info );
3450
3451
								// Adjust the success string based on the activation result.
3452
								$this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
3453
3454
								if ( is_wp_error( $activate ) ) {
3455
									$this->skin->error( $activate );
3456
									$this->strings['process_success'] .= $this->strings['activation_failed'];
3457
								} else {
3458
									$this->strings['process_success'] .= $this->strings['activation_success'];
3459
								}
3460
							}
3461
						}
3462
3463
						return $bool;
3464
					}
3465
				}
3466
			}
3467
3468
			if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
3469
3470
				/**
3471
				 * Installer skin to set strings for the bulk plugin installations..
3472
				 *
3473
				 * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
3474
				 * plugins.
3475
				 *
3476
				 * @since 2.2.0
3477
				 *
3478
				 * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
3479
				 *           TGMPA_Bulk_Installer_Skin.
3480
				 *           This was done to prevent backward compatibility issues with v2.3.6.}}
3481
				 *
3482
				 * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
3483
				 *
3484
				 * @package TGM-Plugin-Activation
3485
				 * @author  Thomas Griffin
3486
				 * @author  Gary Jones
3487
				 */
3488
				class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
3489
					/**
3490
					 * Holds plugin info for each individual plugin installation.
3491
					 *
3492
					 * @since 2.2.0
3493
					 *
3494
					 * @var array
3495
					 */
3496
					public $plugin_info = array();
3497
3498
					/**
3499
					 * Holds names of plugins that are undergoing bulk installations.
3500
					 *
3501
					 * @since 2.2.0
3502
					 *
3503
					 * @var array
3504
					 */
3505
					public $plugin_names = array();
3506
3507
					/**
3508
					 * Integer to use for iteration through each plugin installation.
3509
					 *
3510
					 * @since 2.2.0
3511
					 *
3512
					 * @var integer
3513
					 */
3514
					public $i = 0;
3515
3516
					/**
3517
					 * TGMPA instance
3518
					 *
3519
					 * @since 2.5.0
3520
					 *
3521
					 * @var object
3522
					 */
3523
					protected $tgmpa;
3524
3525
					/**
3526
					 * Constructor. Parses default args with new ones and extracts them for use.
3527
					 *
3528
					 * @since 2.2.0
3529
					 *
3530
					 * @param array $args Arguments to pass for use within the class.
3531
					 */
3532
					public function __construct( $args = array() ) {
3533
						// Get TGMPA class instance.
3534
						$this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
3535
3536
						// Parse default and new args.
3537
						$defaults = array(
3538
							'url'          => '',
3539
							'nonce'        => '',
3540
							'names'        => array(),
3541
							'install_type' => 'install',
3542
						);
3543
						$args     = wp_parse_args( $args, $defaults );
3544
3545
						// Set plugin names to $this->plugin_names property.
3546
						$this->plugin_names = $args['names'];
3547
3548
						// Extract the new args.
3549
						parent::__construct( $args );
3550
					}
3551
3552
					/**
3553
					 * Sets install skin strings for each individual plugin.
3554
					 *
3555
					 * Checks to see if the automatic activation flag is set and uses the
3556
					 * the proper strings accordingly.
3557
					 *
3558
					 * @since 2.2.0
3559
					 */
3560
					public function add_strings() {
3561
						if ( 'update' === $this->options['install_type'] ) {
3562
							parent::add_strings();
3563
							/* translators: 1: plugin name, 2: action number 3: total number of actions. */
3564
							$this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3565
						} else {
3566
							/* translators: 1: plugin name, 2: error message. */
3567
							$this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
3568
							/* translators: 1: plugin name. */
3569
							$this->upgrader->strings['skin_update_failed']       = __( 'The installation of %1$s failed.', 'tgmpa' );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 7 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
3570
3571
							if ( $this->tgmpa->is_automatic ) {
3572
								// Automatic activation strings.
3573
								$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' );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 8 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
3574
								/* translators: 1: plugin name. */
3575
								$this->upgrader->strings['skin_update_successful']    = __( '%1$s installed and activated successfully.', 'tgmpa' ) . ' <a href="#" class="hide-if-no-js" onclick="%2$s"><span>' . esc_html__( 'Show Details', 'tgmpa' ) . '</span><span class="hidden">' . esc_html__( 'Hide Details', 'tgmpa' ) . '</span>.</a>';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 1 space but found 4 spaces

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
3576
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations and activations have been completed.', 'tgmpa' );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 7 spaces but found 10 spaces

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
3577
								/* translators: 1: plugin name, 2: action number 3: total number of of actions. */
3578
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3579
							} else {
3580
								// Default installation strings.
3581
								$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' );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 8 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
3582
								/* translators: 1: plugin name. */
3583
								$this->upgrader->strings['skin_update_successful']    = esc_html__( '%1$s installed successfully.', 'tgmpa' ) . ' <a href="#" class="hide-if-no-js" onclick="%2$s"><span>' . esc_html__( 'Show Details', 'tgmpa' ) . '</span><span class="hidden">' . esc_html__( 'Hide Details', 'tgmpa' ) . '</span>.</a>';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 1 space but found 4 spaces

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
3584
								$this->upgrader->strings['skin_upgrade_end']          = __( 'All installations have been completed.', 'tgmpa' );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 7 spaces but found 10 spaces

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
3585
								/* translators: 1: plugin name, 2: action number 3: total number of of actions. */
3586
								$this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
3587
							}
3588
						}
3589
					}
3590
3591
					/**
3592
					 * Outputs the header strings and necessary JS before each plugin installation.
3593
					 *
3594
					 * @since 2.2.0
3595
					 *
3596
					 * @param string $title Unused in this implementation.
3597
					 */
3598
					public function before( $title = '' ) {
3599
						if ( empty( $title ) ) {
3600
							$title = esc_html( $this->plugin_names[ $this->i ] );
3601
						}
3602
						parent::before( $title );
3603
					}
3604
3605
					/**
3606
					 * Outputs the footer strings and necessary JS after each plugin installation.
3607
					 *
3608
					 * Checks for any errors and outputs them if they exist, else output
3609
					 * success strings.
3610
					 *
3611
					 * @since 2.2.0
3612
					 *
3613
					 * @param string $title Unused in this implementation.
3614
					 */
3615
					public function after( $title = '' ) {
3616
						if ( empty( $title ) ) {
3617
							$title = esc_html( $this->plugin_names[ $this->i ] );
3618
						}
3619
						parent::after( $title );
3620
3621
						$this->i++;
3622
					}
3623
3624
					/**
3625
					 * Outputs links after bulk plugin installation is complete.
3626
					 *
3627
					 * @since 2.2.0
3628
					 */
3629
					public function bulk_footer() {
3630
						// Serve up the string to say installations (and possibly activations) are complete.
3631
						parent::bulk_footer();
3632
3633
						// Flush plugins cache so we can make sure that the installed plugins list is always up to date.
3634
						wp_clean_plugins_cache();
3635
3636
						$this->tgmpa->show_tgmpa_version();
3637
3638
						// Display message based on if all plugins are now active or not.
3639
						$update_actions = array();
3640
3641
						if ( $this->tgmpa->is_tgmpa_complete() ) {
3642
							// All plugins are active, so we display the complete string and hide the menu to protect users.
3643
							echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
3644
							$update_actions['dashboard'] = sprintf(
3645
								esc_html( $this->tgmpa->strings['complete'] ),
3646
								'<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>'
3647
							);
3648
						} else {
3649
							$update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
3650
						}
3651
3652
						/**
3653
						 * Filter the list of action links available following bulk plugin installs/updates.
3654
						 *
3655
						 * @since 2.5.0
3656
						 *
3657
						 * @param array $update_actions Array of plugin action links.
3658
						 * @param array $plugin_info    Array of information for the last-handled plugin.
3659
						 */
3660
						$update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
3661
3662
						if ( ! empty( $update_actions ) ) {
3663
							$this->feedback( implode( ' | ', (array) $update_actions ) );
3664
						}
3665
					}
3666
3667
					/* *********** DEPRECATED METHODS *********** */
3668
3669
					/**
3670
					 * Flush header output buffer.
3671
					 *
3672
					 * @since      2.2.0
3673
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3674
					 * @see        Bulk_Upgrader_Skin::flush_output()
3675
					 */
3676
					public function before_flush_output() {
3677
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3678
						$this->flush_output();
3679
					}
3680
3681
					/**
3682
					 * Flush footer output buffer and iterate $this->i to make sure the
3683
					 * installation strings reference the correct plugin.
3684
					 *
3685
					 * @since      2.2.0
3686
					 * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
3687
					 * @see        Bulk_Upgrader_Skin::flush_output()
3688
					 */
3689
					public function after_flush_output() {
3690
						_deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
3691
						$this->flush_output();
3692
						$this->i++;
3693
					}
3694
				}
3695
			}
3696
		}
3697
	}
3698
}
3699
3700
if ( ! class_exists( 'TGMPA_Utils' ) ) {
3701
3702
	/**
3703
	 * Generic utilities for TGMPA.
3704
	 *
3705
	 * All methods are static, poor-dev name-spacing class wrapper.
3706
	 *
3707
	 * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
3708
	 *
3709
	 * @since 2.5.0
3710
	 *
3711
	 * @package TGM-Plugin-Activation
3712
	 * @author  Juliette Reinders Folmer
3713
	 */
3714
	class TGMPA_Utils {
3715
		/**
3716
		 * Whether the PHP filter extension is enabled.
3717
		 *
3718
		 * @see http://php.net/book.filter
3719
		 *
3720
		 * @since 2.5.0
3721
		 *
3722
		 * @static
3723
		 *
3724
		 * @var bool $has_filters True is the extension is enabled.
3725
		 */
3726
		public static $has_filters;
3727
3728
		/**
3729
		 * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
3730
		 *
3731
		 * @since 2.5.0
3732
		 *
3733
		 * @static
3734
		 *
3735
		 * @param string $string Text to be wrapped.
3736
		 * @return string
3737
		 */
3738
		public static function wrap_in_em( $string ) {
3739
			return '<em>' . wp_kses_post( $string ) . '</em>';
3740
		}
3741
3742
		/**
3743
		 * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
3744
		 *
3745
		 * @since 2.5.0
3746
		 *
3747
		 * @static
3748
		 *
3749
		 * @param string $string Text to be wrapped.
3750
		 * @return string
3751
		 */
3752
		public static function wrap_in_strong( $string ) {
3753
			return '<strong>' . wp_kses_post( $string ) . '</strong>';
3754
		}
3755
3756
		/**
3757
		 * Helper function: Validate a value as boolean
3758
		 *
3759
		 * @since 2.5.0
3760
		 *
3761
		 * @static
3762
		 *
3763
		 * @param mixed $value Arbitrary value.
3764
		 * @return bool
3765
		 */
3766
		public static function validate_bool( $value ) {
3767
			if ( ! isset( self::$has_filters ) ) {
3768
				self::$has_filters = extension_loaded( 'filter' );
3769
			}
3770
3771
			if ( self::$has_filters ) {
3772
				return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
3773
			} else {
3774
				return self::emulate_filter_bool( $value );
3775
			}
3776
		}
3777
3778
		/**
3779
		 * Helper function: Cast a value to bool
3780
		 *
3781
		 * @since 2.5.0
3782
		 *
3783
		 * @static
3784
		 *
3785
		 * @param mixed $value Value to cast.
3786
		 * @return bool
3787
		 */
3788
		protected static function emulate_filter_bool( $value ) {
3789
			// @codingStandardsIgnoreStart
3790
			static $true  = array(
3791
				'1',
3792
				'true', 'True', 'TRUE',
3793
				'y', 'Y',
3794
				'yes', 'Yes', 'YES',
3795
				'on', 'On', 'ON',
3796
			);
3797
			static $false = array(
3798
				'0',
3799
				'false', 'False', 'FALSE',
3800
				'n', 'N',
3801
				'no', 'No', 'NO',
3802
				'off', 'Off', 'OFF',
3803
			);
3804
			// @codingStandardsIgnoreEnd
3805
3806
			if ( is_bool( $value ) ) {
3807
				return $value;
3808
			} else if ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
3809
				return (bool) $value;
3810
			} else if ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
3811
				return (bool) $value;
3812
			} else if ( is_string( $value ) ) {
3813
				$value = trim( $value );
3814
				if ( in_array( $value, $true, true ) ) {
3815
					return true;
3816
				} else if ( in_array( $value, $false, true ) ) {
3817
					return false;
3818
				} else {
3819
					return false;
3820
				}
3821
			}
3822
3823
			return false;
3824
		}
3825
	} // End of class TGMPA_Utils
3826
} // End of class_exists wrapper
3827