PluginProbe
StreamCast – bring live radio to your site with a sleek player / 2.3.3
StreamCast – bring live radio to your site with a sleek player v2.3.3
2.4.5 2.4.4 trunk 1.0 1.1 2.0.0 2.1.10 2.1.2 2.1.4 2.1.5 2.1.8 2.2.1 2.2.3 2.2.4 2.2.5 2.3.0 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8 2.3.9 All 29 releases
streamcast / freemius / includes / class-fs-plugin-updater.php

class-fs-plugin-updater.php in StreamCast – bring live radio to your site with a sleek player 2.3.3, at freemius/includes/class-fs-plugin-updater.php

1,608 lines 63.6 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * @package Freemius
4 * @copyright Copyright (c) 2015, Freemius, Inc.
5 * @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
6 * @since 1.0.4
7 *
8 * @link https://github.com/easydigitaldownloads/EDD-License-handler/blob/master/EDD_SL_Plugin_Updater.php
9 */
10
11 if ( ! defined( 'ABSPATH' ) ) {
12 exit;
13 }
14
15 class FS_Plugin_Updater {
16
17 /**
18 * @var Freemius
19 * @since 1.0.4
20 */
21 private $_fs;
22 /**
23 * @var FS_Logger
24 * @since 1.0.4
25 */
26 private $_logger;
27 /**
28 * @var object
29 * @since 1.1.8.1
30 */
31 private $_update_details;
32 /**
33 * @var array
34 * @since 2.1.2
35 */
36 private $_translation_updates;
37
38 private static $_upgrade_basename = null;
39
40 const UPDATES_CHECK_CACHE_EXPIRATION = ( WP_FS__TIME_24_HOURS_IN_SEC / 24 );
41
42 #--------------------------------------------------------------------------------
43 #region Singleton
44 #--------------------------------------------------------------------------------
45
46 /**
47 * @var FS_Plugin_Updater[]
48 * @since 2.0.0
49 */
50 private static $_INSTANCES = array();
51
52 /**
53 * @param Freemius $freemius
54 *
55 * @return FS_Plugin_Updater
56 */
57 static function instance( Freemius $freemius ) {
58 $key = $freemius->get_id();
59
60 if ( ! isset( self::$_INSTANCES[ $key ] ) ) {
61 self::$_INSTANCES[ $key ] = new self( $freemius );
62 }
63
64 return self::$_INSTANCES[ $key ];
65 }
66
67 #endregion
68
69 private function __construct( Freemius $freemius ) {
70 $this->_fs = $freemius;
71
72 $this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $freemius->get_slug() . '_updater', WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
73
74 $this->filters();
75 }
76
77 /**
78 * Initiate required filters.
79 *
80 * @author Vova Feldman (@svovaf)
81 * @since 1.0.4
82 */
83 private function filters() {
84 // Override request for plugin information
85 add_filter( 'plugins_api', array( &$this, 'plugins_api_filter' ), 10, 3 );
86
87 $this->add_transient_filters();
88
89 /**
90 * If user has the premium plugin's code but do NOT have an active license,
91 * encourage him to upgrade by showing that there's a new release, but instead
92 * of showing an update link, show upgrade link to the pricing page.
93 *
94 * @since 1.1.6
95 *
96 */
97 // WP 2.9+
98 add_action( "after_plugin_row_{$this->_fs->get_plugin_basename()}", array(
99 &$this,
100 'catch_plugin_update_row'
101 ), 9 );
102 add_action( "after_plugin_row_{$this->_fs->get_plugin_basename()}", array(
103 &$this,
104 'edit_and_echo_plugin_update_row'
105 ), 11, 2 );
106
107 if ( ! $this->_fs->has_any_active_valid_license() ) {
108 add_action( 'admin_head', array( &$this, 'catch_plugin_information_dialog_contents' ) );
109 } else {
110 add_action( 'admin_footer', array( &$this, '_add_fs_allow_updater_and_dialog_request_param' ) );
111 }
112
113 if ( ! WP_FS__IS_PRODUCTION_MODE ) {
114 add_filter( 'http_request_host_is_external', array(
115 $this,
116 'http_request_host_is_external_filter'
117 ), 10, 3 );
118 }
119
120 if ( $this->_fs->is_premium() ) {
121 if ( ! $this->is_correct_folder_name() ) {
122 add_filter( 'upgrader_post_install', array( &$this, '_maybe_update_folder_name' ), 10, 3 );
123 }
124
125 add_filter( 'upgrader_pre_install', array( 'FS_Plugin_Updater', '_store_basename_for_source_adjustment' ), 1, 2 );
126 add_filter( 'upgrader_source_selection', array( 'FS_Plugin_Updater', '_maybe_adjust_source_dir' ), 1, 3 );
127
128 if ( ! $this->_fs->has_any_active_valid_license() ) {
129 add_filter( 'wp_prepare_themes_for_js', array( &$this, 'change_theme_update_info_html' ), 10, 1 );
130 }
131 }
132 }
133
134 /**
135 * @author Leo Fajardo (@leorw)
136 * @since 2.7.4
137 */
138 function _add_fs_allow_updater_and_dialog_request_param() {
139 if ( ! $this->is_plugin_information_dialog_for_plugin() ) {
140 return;
141 }
142 ?>
143 <script type="text/javascript">
144 if ( typeof jQuery !== 'undefined' ) {
145 jQuery( document ).on( 'wp-plugin-updating', function( event, args ) {
146 if ( typeof args === 'object' && args.slug && typeof args.slug === 'string' ) {
147 if ( <?php echo json_encode( $this->_fs->get_slug() ) ?> === args.slug ) {
148 args.fs_allow_updater_and_dialog = true;
149 }
150 }
151 } );
152 }
153 </script>
154 <?php
155 }
156
157 /**
158 * @author Leo Fajardo (@leorw)
159 * @since 2.7.4
160 *
161 * @return bool
162 */
163 private function is_plugin_information_dialog_for_plugin() {
164 return (
165 'plugin-information' === fs_request_get( 'tab', false ) &&
166 $this->_fs->get_slug() === fs_request_get_raw( 'plugin', false )
167 );
168 }
169
170 /**
171 * @author Leo Fajardo (@leorw)
172 * @since 2.1.4
173 */
174 function catch_plugin_information_dialog_contents() {
175 if ( ! $this->is_plugin_information_dialog_for_plugin() ) {
176 return;
177 }
178
179 add_action( 'admin_footer', array( &$this, 'edit_and_echo_plugin_information_dialog_contents' ), 0, 1 );
180
181 ob_start();
182 }
183
184 /**
185 * @author Leo Fajardo (@leorw)
186 * @since 2.1.4
187 *
188 * @param string $hook_suffix
189 */
190 function edit_and_echo_plugin_information_dialog_contents( $hook_suffix ) {
191 if (
192 'plugin-information' !== fs_request_get( 'tab', false ) ||
193 $this->_fs->get_slug() !== fs_request_get_raw( 'plugin', false )
194 ) {
195 return;
196 }
197
198 $license = $this->_fs->_get_license();
199
200 $subscription = ( is_object( $license ) && ! $license->is_lifetime() ) ?
201 $this->_fs->_get_subscription( $license->id ) :
202 null;
203
204 $contents = ob_get_clean();
205
206 $install_or_update_button_id_attribute_pos = strpos( $contents, 'id="plugin_install_from_iframe"' );
207
208 if ( false === $install_or_update_button_id_attribute_pos ) {
209 $install_or_update_button_id_attribute_pos = strpos( $contents, 'id="plugin_update_from_iframe"' );
210 }
211
212 if ( false !== $install_or_update_button_id_attribute_pos ) {
213 $install_or_update_button_start_pos = strrpos(
214 substr( $contents, 0, $install_or_update_button_id_attribute_pos ),
215 '<a'
216 );
217
218 $install_or_update_button_end_pos = ( strpos( $contents, '</a>', $install_or_update_button_id_attribute_pos ) + strlen( '</a>' ) );
219
220 /**
221 * The part of the contents without the update button.
222 *
223 * @author Leo Fajardo (@leorw)
224 * @since 2.2.5
225 */
226 $modified_contents = substr( $contents, 0, $install_or_update_button_start_pos );
227
228 $install_or_update_button = substr( $contents, $install_or_update_button_start_pos, ( $install_or_update_button_end_pos - $install_or_update_button_start_pos ) );
229
230 /**
231 * Replace the plugin information dialog's "Install Update Now" button's text and URL. If there's a license,
232 * the text will be "Renew license" and will link to the checkout page with the license's billing cycle
233 * and quota. If there's no license, the text will be "Buy license" and will link to the pricing page.
234 */
235 $install_or_update_button = preg_replace(
236 '/(\<a.+)(id="plugin_(install|update)_from_iframe")(.+href=")([^\s]+)(".*\>)(.+)(\<\/a>)/is',
237 is_object( $license ) ?
238 sprintf(
239 '$1$4%s$6%s$8',
240 $this->_fs->checkout_url(
241 is_object( $subscription ) ?
242 ( 1 == $subscription->billing_cycle ? WP_FS__PERIOD_MONTHLY : WP_FS__PERIOD_ANNUALLY ) :
243 WP_FS__PERIOD_LIFETIME,
244 false,
245 array( 'licenses' => $license->quota )
246 ),
247 fs_text_inline( 'Renew license', 'renew-license', $this->_fs->get_slug() )
248 ) :
249 sprintf(
250 '$1$4%s$6%s$8',
251 $this->_fs->pricing_url(),
252 fs_text_inline( 'Buy license', 'buy-license', $this->_fs->get_slug() )
253 ),
254 $install_or_update_button
255 );
256
257 /**
258 * Append the modified button.
259 *
260 * @author Leo Fajardo (@leorw)
261 * @since 2.2.5
262 */
263 $modified_contents .= $install_or_update_button;
264
265 /**
266 * Append the remaining part of the contents after the update button.
267 *
268 * @author Leo Fajardo (@leorw)
269 * @since 2.2.5
270 */
271 $modified_contents .= substr( $contents, $install_or_update_button_end_pos );
272
273 $contents = $modified_contents;
274 }
275
276 echo $contents;
277 }
278
279 /**
280 * @author Vova Feldman (@svovaf)
281 * @since 2.0.0
282 */
283 private function add_transient_filters() {
284 if (
285 $this->_fs->is_premium() &&
286 $this->_fs->is_registered() &&
287 ! FS_Permission_Manager::instance( $this->_fs )->is_essentials_tracking_allowed()
288 ) {
289 $this->_logger->log( 'Opted out sites cannot receive automatic software updates.' );
290
291 return;
292 }
293
294 add_filter( 'pre_set_site_transient_update_plugins', array(
295 &$this,
296 'pre_set_site_transient_update_plugins_filter'
297 ) );
298
299 add_filter( 'pre_set_site_transient_update_themes', array(
300 &$this,
301 'pre_set_site_transient_update_plugins_filter'
302 ) );
303 }
304
305 /**
306 * @author Vova Feldman (@svovaf)
307 * @since 2.0.0
308 */
309 private function remove_transient_filters() {
310 remove_filter( 'pre_set_site_transient_update_plugins', array(
311 &$this,
312 'pre_set_site_transient_update_plugins_filter'
313 ) );
314
315 remove_filter( 'pre_set_site_transient_update_themes', array(
316 &$this,
317 'pre_set_site_transient_update_plugins_filter'
318 ) );
319 }
320
321 /**
322 * Capture plugin update row by turning output buffering.
323 *
324 * @author Vova Feldman (@svovaf)
325 * @since 1.1.6
326 */
327 function catch_plugin_update_row() {
328 ob_start();
329 }
330
331 /**
332 * Overrides default update message format with "renew your license" message.
333 *
334 * @author Vova Feldman (@svovaf)
335 * @since 1.1.6
336 *
337 * @param string $file
338 * @param array $plugin_data
339 */
340 function edit_and_echo_plugin_update_row( $file, $plugin_data ) {
341 $plugin_update_row = ob_get_clean();
342
343 $current = get_site_transient( 'update_plugins' );
344 if ( ! isset( $current->response[ $file ] ) ) {
345 echo $plugin_update_row;
346
347 return;
348 }
349
350 $r = $current->response[ $file ];
351
352 $has_beta_update = $this->_fs->has_beta_update();
353
354 if ( $this->_fs->has_any_active_valid_license() ) {
355 if ( $has_beta_update ) {
356 /**
357 * Turn the "new version" text into "new Beta version".
358 *
359 * Sample input:
360 * There is a new version of Awesome Plugin available. <a href="...>View version x.y.z details</a> or <a href="...>update now</a>.
361 * Output:
362 * There is a new Beta version of Awesome Plugin available. <a href="...>View version x.y.z details</a> or <a href="...>update now</a>.
363 *
364 * @author Leo Fajardo (@leorw)
365 * @since 2.3.0
366 */
367 $plugin_update_row = preg_replace(
368 '/(\<div.+>)(.+)(\<a.+href="([^\s]+)"([^\<]+)\>.+\<a.+)(\<\/div\>)/is',
369 (
370 '$1' .
371 sprintf(
372 fs_text_inline( 'There is a %s of %s available.', 'new-version-available', $this->_fs->get_slug() ),
373 $has_beta_update ?
374 fs_text_inline( 'new Beta version', 'new-beta-version', $this->_fs->get_slug() ) :
375 fs_text_inline( 'new version', 'new-version', $this->_fs->get_slug() ),
376 $this->_fs->get_plugin_title()
377 ) .
378 ' ' .
379 '$3' .
380 '$6'
381 ),
382 $plugin_update_row
383 );
384 }
385 } else {
386 /**
387 * Turn the "new version" text into a link that opens the plugin information dialog when clicked and
388 * make the "View version x details" text link to the checkout page instead of opening the plugin
389 * information dialog when clicked.
390 *
391 * Sample input:
392 * There is a new version of Awesome Plugin available. <a href="...>View version x.y.z details</a> or <a href="...>update now</a>.
393 * Output:
394 * There is a <a href="...>new version</a> of Awesome Plugin available. <a href="...>Buy a license now</a> to access version x.y.z security & feature updates, and support.
395 * OR
396 * There is a <a href="...>new Beta version</a> of Awesome Plugin available. <a href="...>Buy a license now</a> to access version x.y.z security & feature updates, and support.
397 *
398 * @author Leo Fajardo (@leorw)
399 */
400 $plugin_update_row = preg_replace(
401 '/(\<div.+>)(.+)(\<a.+href="([^\s]+)"([^\<]+)\>.+\<a.+)(\<\/div\>)/is',
402 (
403 '$1' .
404 sprintf(
405 fs_text_inline( 'There is a %s of %s available.', 'new-version-available', $this->_fs->get_slug() ),
406 sprintf(
407 '<a href="$4"%s>%s</a>',
408 '$5',
409 $has_beta_update ?
410 fs_text_inline( 'new Beta version', 'new-beta-version', $this->_fs->get_slug() ) :
411 fs_text_inline( 'new version', 'new-version', $this->_fs->get_slug() )
412 ),
413 $this->_fs->get_plugin_title()
414 ) .
415 ' ' .
416 $this->_fs->version_upgrade_checkout_link( $r->new_version ) .
417 '$6'
418 ),
419 $plugin_update_row
420 );
421 }
422
423 if (
424 $this->_fs->is_plugin() &&
425 isset( $r->upgrade_notice ) &&
426 strlen( trim( $r->upgrade_notice ) ) > 0
427 ) {
428 $slug = $this->_fs->get_slug();
429
430 $upgrade_notice_html = sprintf(
431 '<p class="notice fs-upgrade-notice fs-slug-%1$s fs-type-%2$s" data-slug="%1$s" data-type="%2$s"><strong>%3$s</strong> %4$s</p>',
432 $slug,
433 $this->_fs->get_module_type(),
434 fs_text_inline( 'Important Upgrade Notice:', 'upgrade_notice', $slug ),
435 esc_html( $r->upgrade_notice )
436 );
437
438 $plugin_update_row = str_replace( '</div>', '</div>' . $upgrade_notice_html, $plugin_update_row );
439 }
440
441 echo $plugin_update_row;
442 }
443
444 /**
445 * @author Leo Fajardo (@leorw)
446 * @since 2.0.2
447 *
448 * @param array $prepared_themes
449 *
450 * @return array
451 */
452 function change_theme_update_info_html( $prepared_themes ) {
453 $theme_basename = $this->_fs->get_plugin_basename();
454
455 if ( ! isset( $prepared_themes[ $theme_basename ] ) ) {
456 return $prepared_themes;
457 }
458
459 $themes_update = get_site_transient( 'update_themes' );
460 if ( ! isset( $themes_update->response[ $theme_basename ] ) ||
461 empty( $themes_update->response[ $theme_basename ]['package'] )
462 ) {
463 return $prepared_themes;
464 }
465
466 $prepared_themes[ $theme_basename ]['update'] = preg_replace(
467 '/(\<p.+>)(.+)(\<a.+\<a.+)\.(.+\<\/p\>)/is',
468 '$1 $2 ' . $this->_fs->version_upgrade_checkout_link( $themes_update->response[ $theme_basename ]['new_version'] ) .
469 '$4',
470 $prepared_themes[ $theme_basename ]['update']
471 );
472
473 // Set to false to prevent the "Update now" link for the context theme from being shown on the "Themes" page.
474 $prepared_themes[ $theme_basename ]['hasPackage'] = false;
475
476 return $prepared_themes;
477 }
478
479 /**
480 * Since WP version 3.6, a new security feature was added that denies access to repository with a local ip.
481 * During development mode we want to be able updating plugin versions via our localhost repository. This
482 * filter white-list all domains including "api.freemius".
483 *
484 * @link http://www.emanueletessore.com/wordpress-download-failed-valid-url-provided/
485 *
486 * @author Vova Feldman (@svovaf)
487 * @since 1.0.4
488 *
489 * @param bool $allow
490 * @param string $host
491 * @param string $url
492 *
493 * @return bool
494 */
495 function http_request_host_is_external_filter( $allow, $host, $url ) {
496 return ( false !== strpos( $host, 'freemius' ) ) ? true : $allow;
497 }
498
499 /**
500 * Check for Updates at the defined API endpoint and modify the update array.
501 *
502 * This function dives into the update api just when WordPress creates its update array,
503 * then adds a custom API call and injects the custom plugin data retrieved from the API.
504 * It is reassembled from parts of the native WordPress plugin update code.
505 * See wp-includes/update.php line 121 for the original wp_update_plugins() function.
506 *
507 * @author Vova Feldman (@svovaf)
508 * @since 1.0.4
509 *
510 * @uses FS_Api
511 *
512 * @param object $transient_data Update array build by WordPress.
513 *
514 * @return object Modified update array with custom plugin data.
515 */
516 function pre_set_site_transient_update_plugins_filter( $transient_data ) {
517 $this->_logger->entrance();
518
519 /**
520 * "plugins" or "themes".
521 *
522 * @author Leo Fajardo (@leorw)
523 * @since 1.2.2
524 */
525 $module_type = $this->_fs->get_module_type() . 's';
526
527 /**
528 * Ensure that we don't mix plugins update info with themes update info.
529 *
530 * @author Leo Fajardo (@leorw)
531 * @since 1.2.2
532 */
533 if ( "pre_set_site_transient_update_{$module_type}" !== current_filter() ) {
534 return $transient_data;
535 }
536
537 if ( empty( $transient_data ) ||
538 defined( 'WP_FS__UNINSTALL_MODE' )
539 ) {
540 return $transient_data;
541 }
542
543 global $wp_current_filter;
544
545 if ( ! empty( $wp_current_filter ) && in_array( 'upgrader_process_complete', $wp_current_filter ) ) {
546 return $transient_data;
547 }
548
549 if ( ! isset( $this->_update_details ) ) {
550 // Get plugin's newest update.
551 $new_version = $this->_fs->get_update( false, fs_request_get_bool( 'force-check' ) );
552
553 $this->_update_details = false;
554
555 if ( is_object( $new_version ) && $this->is_new_version_premium( $new_version ) ) {
556 $this->_logger->log( 'Found newer plugin version ' . $new_version->version );
557
558 /**
559 * Cache plugin details locally since set_site_transient( 'update_plugins' )
560 * called multiple times and the non wp.org plugins are filtered after the
561 * call to .org.
562 *
563 * @since 1.1.8.1
564 */
565 $this->_update_details = $this->get_update_details( $new_version );
566 }
567 }
568
569 // Alias.
570 $basename = $this->_fs->premium_plugin_basename();
571
572 if ( is_object( $this->_update_details ) ) {
573 if ( isset( $transient_data->no_update ) ) {
574 unset( $transient_data->no_update[ $basename ] );
575 }
576
577 if ( ! isset( $transient_data->response ) ) {
578 $transient_data->response = array();
579 }
580
581 // Add plugin to transient data.
582 $transient_data->response[ $basename ] = $this->_fs->is_plugin() ?
583 $this->_update_details :
584 (array) $this->_update_details;
585 } else {
586 if ( isset( $transient_data->response ) ) {
587 /**
588 * Ensure that there's no update data for the plugin to prevent upgrading the premium version to the latest free version.
589 *
590 * @author Leo Fajardo (@leorw)
591 * @since 2.3.0
592 */
593 unset( $transient_data->response[ $basename ] );
594 }
595
596 if ( ! isset( $transient_data->no_update ) ) {
597 $transient_data->no_update = array();
598 }
599
600 /**
601 * Add product to no_update transient data to properly integrate with WP 5.5 auto-updates UI.
602 *
603 * @since 2.4.1
604 * @link https://make.wordpress.org/core/2020/07/30/recommended-usage-of-the-updates-api-to-support-the-auto-updates-ui-for-plugins-and-themes-in-wordpress-5-5/
605 */
606 $transient_data->no_update[ $basename ] = $this->_fs->is_plugin() ?
607 (object) array(
608 'id' => $basename,
609 'slug' => $this->_fs->get_slug(),
610 'plugin' => $basename,
611 'new_version' => $this->_fs->get_plugin_version(),
612 'url' => '',
613 'package' => '',
614 'icons' => array(),
615 'banners' => array(),
616 'banners_rtl' => array(),
617 'tested' => '',
618 'requires_php' => '',
619 'compatibility' => new stdClass(),
620 ) :
621 array(
622 'theme' => $basename,
623 'new_version' => $this->_fs->get_plugin_version(),
624 'url' => '',
625 'package' => '',
626 'requires' => '',
627 'requires_php' => '',
628 );
629 }
630
631 $slug = $this->_fs->get_slug();
632
633 if ( $this->can_fetch_data_from_wp_org() ) {
634 if ( ! isset( $this->_translation_updates ) ) {
635 $this->_translation_updates = array();
636
637 $translation_updates = $this->fetch_wp_org_module_translation_updates( $module_type, $slug );
638 if ( ! empty( $translation_updates ) ) {
639 $this->_translation_updates = $translation_updates;
640 }
641 }
642
643 if ( ! empty( $this->_translation_updates ) ) {
644 $all_translation_updates = ( isset( $transient_data->translations ) && is_array( $transient_data->translations ) ) ?
645 $transient_data->translations :
646 array();
647
648 $current_plugin_translation_updates_map = array();
649 foreach ( $all_translation_updates as $key => $translation_update ) {
650 if ( $module_type === ( $translation_update['type'] . 's' ) && $slug === $translation_update['slug'] ) {
651 $current_plugin_translation_updates_map[ $translation_update['language'] ] = $translation_update;
652 unset( $all_translation_updates[ $key ] );
653 }
654 }
655
656 foreach ( $this->_translation_updates as $translation_update ) {
657 $lang = $translation_update['language'];
658 if ( ! isset( $current_plugin_translation_updates_map[ $lang ] ) ||
659 version_compare( $translation_update['version'], $current_plugin_translation_updates_map[ $lang ]['version'], '>' )
660 ) {
661 $current_plugin_translation_updates_map[ $lang ] = $translation_update;
662 }
663 }
664
665 $transient_data->translations = array_merge( $all_translation_updates, array_values( $current_plugin_translation_updates_map ) );
666 }
667 }
668
669 return $transient_data;
670 }
671
672 /**
673 * Get module's required data for the updates' mechanism.
674 *
675 * @author Vova Feldman (@svovaf)
676 * @since 2.0.0
677 *
678 * @param \FS_Plugin_Tag $new_version
679 *
680 * @return object
681 */
682 function get_update_details( FS_Plugin_Tag $new_version ) {
683 $update = new stdClass();
684 $update->slug = $this->_fs->get_slug();
685 $update->new_version = $new_version->version;
686 $update->url = WP_FS__ADDRESS;
687 $update->package = $new_version->url;
688 $update->tested = self::get_tested_wp_version( $new_version->tested_up_to_version );
689 $update->requires = $new_version->requires_platform_version;
690 $update->requires_php = $new_version->requires_programming_language_version;
691
692 $icon = $this->_fs->get_local_icon_url();
693
694 if ( ! empty( $icon ) ) {
695 $update->icons = array(
696 // '1x' => $icon,
697 // '2x' => $icon,
698 'default' => $icon,
699 );
700 }
701
702 if ( $this->_fs->is_premium() && ! empty( $new_version->upgrade_notice ) ) {
703 $update->upgrade_notice = $new_version->upgrade_notice;
704 }
705
706 $update->{$this->_fs->get_module_type()} = $this->_fs->get_plugin_basename();
707
708 return $update;
709 }
710
711 /**
712 * @author Leo Fajardo (@leorw)
713 * @since 2.3.0
714 *
715 * @param FS_Plugin_Tag $new_version
716 *
717 * @return bool
718 */
719 private function is_new_version_premium( FS_Plugin_Tag $new_version ) {
720 $params = fs_parse_url_params( $new_version->url );
721
722 return ( isset( $params['is_premium'] ) && 'true' == $params['is_premium'] );
723 }
724
725 /**
726 * Update the updates transient with the module's update information.
727 *
728 * This method is required for multisite environment.
729 * If a module is site activated (not network) and not on the main site,
730 * the module will NOT be executed on the network level, therefore, the
731 * custom updates logic will not be executed as well, so unless we force
732 * the injection of the update into the updates transient, premium updates
733 * will not work.
734 *
735 * @author Vova Feldman (@svovaf)
736 * @since 2.0.0
737 *
738 * @param \FS_Plugin_Tag $new_version
739 */
740 function set_update_data( FS_Plugin_Tag $new_version ) {
741 $this->_logger->entrance();
742
743 if ( ! $this->is_new_version_premium( $new_version ) ) {
744 return;
745 }
746
747 $transient_key = "update_{$this->_fs->get_module_type()}s";
748
749 $transient_data = get_site_transient( $transient_key );
750
751 $transient_data = is_object( $transient_data ) ?
752 $transient_data :
753 new stdClass();
754
755 // Alias.
756 $basename = $this->_fs->get_plugin_basename();
757 $is_plugin = $this->_fs->is_plugin();
758
759 if ( ! isset( $transient_data->response ) ||
760 ! is_array( $transient_data->response )
761 ) {
762 $transient_data->response = array();
763 } else if ( ! empty( $transient_data->response[ $basename ] ) ) {
764 $version = $is_plugin ?
765 ( ! empty( $transient_data->response[ $basename ]->new_version ) ?
766 $transient_data->response[ $basename ]->new_version :
767 null
768 ) : ( ! empty( $transient_data->response[ $basename ]['new_version'] ) ?
769 $transient_data->response[ $basename ]['new_version'] :
770 null
771 );
772
773 if ( $version == $new_version->version ) {
774 // The update data is already set.
775 return;
776 }
777 }
778
779 // Remove the added filters.
780 $this->remove_transient_filters();
781
782 $this->_update_details = $this->get_update_details( $new_version );
783
784 // Set update data in transient.
785 $transient_data->response[ $basename ] = $is_plugin ?
786 $this->_update_details :
787 (array) $this->_update_details;
788
789 if ( ! isset( $transient_data->checked ) ||
790 ! is_array( $transient_data->checked )
791 ) {
792 $transient_data->checked = array();
793 }
794
795 // Flag the module as if it was already checked.
796 $transient_data->checked[ $basename ] = $this->_fs->get_plugin_version();
797 $transient_data->last_checked = time();
798
799 set_site_transient( $transient_key, $transient_data );
800
801 $this->add_transient_filters();
802 }
803
804 /**
805 * @author Leo Fajardo (@leorw)
806 * @since 2.0.2
807 */
808 function delete_update_data() {
809 $this->_logger->entrance();
810
811 $transient_key = "update_{$this->_fs->get_module_type()}s";
812
813 $transient_data = get_site_transient( $transient_key );
814
815 // Alias
816 $basename = $this->_fs->get_plugin_basename();
817
818 if ( ! is_object( $transient_data ) ||
819 ! isset( $transient_data->response ) ||
820 ! is_array( $transient_data->response ) ||
821 empty( $transient_data->response[ $basename ] )
822 ) {
823 return;
824 }
825
826 unset( $transient_data->response[ $basename ] );
827
828 // Remove the added filters.
829 $this->remove_transient_filters();
830
831 set_site_transient( $transient_key, $transient_data );
832
833 $this->add_transient_filters();
834 }
835
836 /**
837 * Try to fetch plugin's info from .org repository.
838 *
839 * @author Vova Feldman (@svovaf)
840 * @since 1.0.5
841 *
842 * @param string $action
843 * @param object $args
844 *
845 * @return bool|mixed
846 */
847 static function _fetch_plugin_info_from_repository( $action, $args ) {
848 $url = $http_url = 'http://api.wordpress.org/plugins/info/1.2/';
849 $url = add_query_arg(
850 array(
851 'action' => $action,
852 'request' => $args,
853 ),
854 $url
855 );
856
857 if ( wp_http_supports( array( 'ssl' ) ) ) {
858 $url = set_url_scheme( $url, 'https' );
859 }
860
861 // The new endpoint version serves only GET requests.
862 $request = wp_remote_get( $url, array( 'timeout' => 15 ) );
863
864 if ( is_wp_error( $request ) ) {
865 return false;
866 }
867
868 $res = json_decode( wp_remote_retrieve_body( $request ), true );
869
870 if ( is_array( $res ) ) {
871 // Object casting is required in order to match the info/1.0 format. We are not decoding directly into an object as we need some fields to remain an array (e.g., $res->sections).
872 $res = (object) $res;
873 }
874
875 if ( ! is_object( $res ) || isset( $res->error ) ) {
876 return false;
877 }
878
879 return $res;
880 }
881
882 /**
883 * Returns true if the product can fetch data from WordPress.org.
884 *
885 * @author Leo Fajardo (@leorw)
886 * @since 2.7.4
887 */
888 private function can_fetch_data_from_wp_org() {
889 return ( $this->_fs->is_org_repo_compliant() && $this->_fs->is_freemium() );
890 }
891
892 /**
893 * Fetches module translation updates from wordpress.org.
894 *
895 * @author Leo Fajardo (@leorw)
896 * @since 2.1.2
897 *
898 * @param string $module_type
899 * @param string $slug
900 *
901 * @return array|null
902 */
903 private function fetch_wp_org_module_translation_updates( $module_type, $slug ) {
904 $plugin_data = $this->_fs->get_plugin_data();
905
906 $locales = array_values( get_available_languages() );
907 $locales = apply_filters( "{$module_type}_update_check_locales", $locales );
908 $locales = array_unique( $locales );
909
910 $plugin_basename = $this->_fs->get_plugin_basename();
911 if ( 'themes' === $module_type ) {
912 $plugin_basename = $slug;
913 }
914
915 global $wp_version;
916
917 $request_args = array(
918 'timeout' => 15,
919 'body' => array(
920 "{$module_type}" => json_encode(
921 array(
922 "{$module_type}" => array(
923 $plugin_basename => array(
924 'Name' => trim( str_replace( $this->_fs->get_plugin()->premium_suffix, '', $plugin_data['Name'] ) ),
925 'Author' => $plugin_data['Author'],
926 )
927 )
928 )
929 ),
930 'translations' => json_encode( $this->get_installed_translations( $module_type, $slug ) ),
931 'locale' => json_encode( $locales )
932 ),
933 'user-agent' => ( 'WordPress/' . $wp_version . '; ' . home_url( '/' ) )
934 );
935
936 $url = "http://api.wordpress.org/{$module_type}/update-check/1.1/";
937 if ( $ssl = wp_http_supports( array( 'ssl' ) ) ) {
938 $url = set_url_scheme( $url, 'https' );
939 }
940
941 $raw_response = Freemius::safe_remote_post(
942 $url,
943 $request_args,
944 WP_FS__TIME_24_HOURS_IN_SEC,
945 WP_FS__TIME_12_HOURS_IN_SEC,
946 false
947 );
948
949 if ( is_wp_error( $raw_response ) ) {
950 return null;
951 }
952
953 $response = json_decode( wp_remote_retrieve_body( $raw_response ), true );
954
955 if ( ! is_array( $response ) ) {
956 return null;
957 }
958
959 if ( ! isset( $response['translations'] ) || empty( $response['translations'] ) ) {
960 return null;
961 }
962
963 return $response['translations'];
964 }
965
966 /**
967 * @author Leo Fajardo (@leorw)
968 * @since 2.1.2
969 *
970 * @param string $module_type
971 * @param string $slug
972 *
973 * @return array
974 */
975 private function get_installed_translations( $module_type, $slug ) {
976 if ( function_exists( 'wp_get_installed_translations' ) ) {
977 return wp_get_installed_translations( $module_type );
978 }
979
980 $dir = "/{$module_type}";
981
982 if ( ! is_dir( WP_LANG_DIR . $dir ) )
983 return array();
984
985 $files = scandir( WP_LANG_DIR . $dir );
986 if ( ! $files )
987 return array();
988
989 $language_data = array();
990
991 foreach ( $files as $file ) {
992 if ( 0 !== strpos( $file, $slug ) ) {
993 continue;
994 }
995
996 if ( '.' === $file[0] || is_dir( WP_LANG_DIR . "{$dir}/{$file}" ) ) {
997 continue;
998 }
999
1000 if ( substr( $file, -3 ) !== '.po' ) {
1001 continue;
1002 }
1003
1004 if ( ! preg_match( '/(?:(.+)-)?([a-z]{2,3}(?:_[A-Z]{2})?(?:_[a-z0-9]+)?).po/', $file, $match ) ) {
1005 continue;
1006 }
1007
1008 if ( ! in_array( substr( $file, 0, -3 ) . '.mo', $files ) ) {
1009 continue;
1010 }
1011
1012 list( , $textdomain, $language ) = $match;
1013
1014 if ( '' === $textdomain ) {
1015 $textdomain = 'default';
1016 }
1017
1018 $language_data[ $textdomain ][ $language ] = wp_get_pomo_file_data( WP_LANG_DIR . "{$dir}/{$file}" );
1019 }
1020
1021 return $language_data;
1022 }
1023
1024 /**
1025 * Updates information on the "View version x.x details" page with custom data.
1026 *
1027 * @author Vova Feldman (@svovaf)
1028 * @since 1.0.4
1029 *
1030 * @uses FS_Api
1031 *
1032 * @param object $data
1033 * @param string $action
1034 * @param mixed $args
1035 *
1036 * @return object
1037 */
1038 function plugins_api_filter( $data, $action = '', $args = null ) {
1039 $this->_logger->entrance();
1040
1041 if ( ( 'plugin_information' !== $action ) ||
1042 ! isset( $args->slug )
1043 ) {
1044 return $data;
1045 }
1046
1047 $addon = false;
1048 $is_addon = false;
1049 $addon_version = false;
1050
1051 if ( $this->_fs->get_slug() !== $args->slug ) {
1052 $addon = $this->_fs->get_addon_by_slug( $args->slug );
1053
1054 if ( ! is_object( $addon ) ) {
1055 return $data;
1056 }
1057
1058 if ( $this->_fs->is_addon_activated( $addon->id ) ) {
1059 $addon_version = $this->_fs->get_addon_instance( $addon->id )->get_plugin_version();
1060 } else if ( $this->_fs->is_addon_installed( $addon->id ) ) {
1061 $addon_plugin_data = get_plugin_data(
1062 ( WP_PLUGIN_DIR . '/' . $this->_fs->get_addon_basename( $addon->id ) ),
1063 false,
1064 false
1065 );
1066
1067 if ( ! empty( $addon_plugin_data ) ) {
1068 $addon_version = $addon_plugin_data['Version'];
1069 }
1070 }
1071
1072 $is_addon = true;
1073 }
1074
1075 $plugin_in_repo = false;
1076 if ( ! $is_addon && $this->can_fetch_data_from_wp_org() ) {
1077 // Try to fetch info from .org repository.
1078 $data = self::_fetch_plugin_info_from_repository( $action, $args );
1079
1080 $plugin_in_repo = ( false !== $data );
1081 }
1082
1083 if ( ! $plugin_in_repo ) {
1084 $data = $args;
1085
1086 // Fetch as much as possible info from local files.
1087 $plugin_local_data = $this->_fs->get_plugin_data();
1088 $data->name = $plugin_local_data['Name'];
1089 $data->author = $plugin_local_data['Author'];
1090 $data->sections = array(
1091 'description' => 'Upgrade ' . $plugin_local_data['Name'] . ' to latest.',
1092 );
1093
1094 // @todo Store extra plugin info on Freemius or parse readme.txt markup.
1095 /*$info = $this->_fs->get_api_site_scope()->call('/information.json');
1096
1097 if ( !isset($info->error) ) {
1098 $data = $info;
1099 }*/
1100 }
1101
1102 $plugin_version = $is_addon ?
1103 $addon_version :
1104 $this->_fs->get_plugin_version();
1105
1106 // Get plugin's newest update.
1107 $new_version = $this->get_latest_download_details( $is_addon ? $addon->id : false, $plugin_version );
1108
1109 if ( ! is_object( $new_version ) || empty( $new_version->version ) ) {
1110 $data->version = $plugin_version;
1111 } else {
1112 if ( $is_addon ) {
1113 $data->name = $addon->title . ' ' . $this->_fs->get_text_inline( 'Add-On', 'addon' );
1114 $data->slug = $addon->slug;
1115 $data->url = WP_FS__ADDRESS;
1116 $data->package = $new_version->url;
1117 }
1118
1119 if ( ! $plugin_in_repo ) {
1120 $data->last_updated = ! is_null( $new_version->updated ) ? $new_version->updated : $new_version->created;
1121 $data->requires = $new_version->requires_platform_version;
1122 $data->requires_php = $new_version->requires_programming_language_version;
1123 $data->tested = $new_version->tested_up_to_version;
1124 }
1125
1126 $data->version = $new_version->version;
1127 $data->download_link = $new_version->url;
1128
1129 if ( isset( $new_version->readme ) && is_object( $new_version->readme ) ) {
1130 $new_version_readme_data = $new_version->readme;
1131 if ( isset( $new_version_readme_data->sections ) ) {
1132 $new_version_readme_data->sections = (array) $new_version_readme_data->sections;
1133 } else {
1134 $new_version_readme_data->sections = array();
1135 }
1136
1137 if ( isset( $data->sections ) ) {
1138 if ( isset( $data->sections['screenshots'] ) ) {
1139 $new_version_readme_data->sections['screenshots'] = $data->sections['screenshots'];
1140 }
1141
1142 if ( isset( $data->sections['reviews'] ) ) {
1143 $new_version_readme_data->sections['reviews'] = $data->sections['reviews'];
1144 }
1145 }
1146
1147 if ( isset( $new_version_readme_data->banners ) ) {
1148 $new_version_readme_data->banners = (array) $new_version_readme_data->banners;
1149 } else if ( isset( $data->banners ) ) {
1150 $new_version_readme_data->banners = $data->banners;
1151 }
1152
1153 $wp_org_sections = array(
1154 'author',
1155 'author_profile',
1156 'rating',
1157 'ratings',
1158 'num_ratings',
1159 'support_threads',
1160 'support_threads_resolved',
1161 'active_installs',
1162 'added',
1163 'homepage'
1164 );
1165
1166 foreach ( $wp_org_sections as $wp_org_section ) {
1167 if ( isset( $data->{$wp_org_section} ) ) {
1168 $new_version_readme_data->{$wp_org_section} = $data->{$wp_org_section};
1169 }
1170 }
1171
1172 $data = $new_version_readme_data;
1173 }
1174 }
1175
1176 if ( ! empty( $data->tested ) ) {
1177 $data->tested = self::get_tested_wp_version( $data->tested );
1178 }
1179
1180 return $data;
1181 }
1182
1183 /**
1184 * @since 2.5.3 If the current WordPress version is a patch of the tested version (e.g., 6.1.2 is a patch of 6.1), then override the tested version with the patch so developers won't need to release a new version just to bump the latest supported WP version.
1185 *
1186 * @param string|null $tested_up_to
1187 *
1188 * @return string|null
1189 */
1190 private static function get_tested_wp_version( $tested_up_to ) {
1191 $current_wp_version = get_bloginfo( 'version' );
1192
1193 return ( ! empty($tested_up_to) && fs_starts_with( $current_wp_version, $tested_up_to . '.' ) ) ?
1194 $current_wp_version :
1195 $tested_up_to;
1196 }
1197
1198 /**
1199 * @author Vova Feldman (@svovaf)
1200 * @since 1.2.1.7
1201 *
1202 * @param number|bool $addon_id
1203 * @param bool|string $newer_than Since 2.2.1
1204 * @param bool|string $fetch_readme Since 2.2.1
1205 *
1206 * @return object
1207 */
1208 private function get_latest_download_details( $addon_id = false, $newer_than = false, $fetch_readme = true ) {
1209 return $this->_fs->_fetch_latest_version( $addon_id, true, FS_Plugin_Updater::UPDATES_CHECK_CACHE_EXPIRATION, $newer_than, $fetch_readme );
1210 }
1211
1212 /**
1213 * Checks if a given basename has a matching folder name
1214 * with the current context plugin.
1215 *
1216 * @author Vova Feldman (@svovaf)
1217 * @since 1.2.1.6
1218 *
1219 * @return bool
1220 */
1221 private function is_correct_folder_name() {
1222 return ( $this->_fs->get_target_folder_name() == trim( dirname( $this->_fs->get_plugin_basename() ), '/\\' ) );
1223 }
1224
1225 /**
1226 * This is a special after upgrade handler for migrating modules
1227 * that didn't use the '-premium' suffix folder structure before
1228 * the migration.
1229 *
1230 * @author Vova Feldman (@svovaf)
1231 * @since 1.2.1.6
1232 *
1233 * @param bool $response Install response.
1234 * @param array $hook_extra Extra arguments passed to hooked filters.
1235 * @param array $result Installation result data.
1236 *
1237 * @return bool
1238 */
1239 function _maybe_update_folder_name( $response, $hook_extra, $result ) {
1240 $basename = $this->_fs->get_plugin_basename();
1241
1242 if ( true !== $response ||
1243 empty( $hook_extra ) ||
1244 empty( $hook_extra['plugin'] ) ||
1245 $basename !== $hook_extra['plugin']
1246 ) {
1247 return $response;
1248 }
1249
1250 $active_plugins_basenames = get_option( 'active_plugins' );
1251
1252 foreach ( $active_plugins_basenames as $key => $active_plugin_basename ) {
1253 if ( $basename === $active_plugin_basename ) {
1254 // Get filename including extension.
1255 $filename = basename( $basename );
1256
1257 $new_basename = plugin_basename(
1258 trailingslashit( $this->_fs->is_premium() ? $this->_fs->get_premium_slug() : $this->_fs->get_slug() ) .
1259 $filename
1260 );
1261
1262 // Verify that the expected correct path exists.
1263 if ( file_exists( fs_normalize_path( WP_PLUGIN_DIR . '/' . $new_basename ) ) ) {
1264 // Override active plugin name.
1265 $active_plugins_basenames[ $key ] = $new_basename;
1266 update_option( 'active_plugins', $active_plugins_basenames );
1267 }
1268
1269 break;
1270 }
1271 }
1272
1273 return $response;
1274 }
1275
1276 #----------------------------------------------------------------------------------
1277 #region Auto Activation
1278 #----------------------------------------------------------------------------------
1279
1280 /**
1281 * Installs and active a plugin when explicitly requested that from a 3rd party service.
1282 *
1283 * This logic was inspired by the TGMPA GPL licensed library by Thomas Griffin.
1284 *
1285 * @link http://tgmpluginactivation.com/
1286 *
1287 * @author Vova Feldman
1288 * @since 1.2.1.7
1289 *
1290 * @link https://make.wordpress.org/plugins/2017/03/16/clarification-of-guideline-8-executable-code-and-installs/
1291 *
1292 * @uses WP_Filesystem
1293 * @uses WP_Error
1294 * @uses WP_Upgrader
1295 * @uses Plugin_Upgrader
1296 * @uses Plugin_Installer_Skin
1297 * @uses Plugin_Upgrader_Skin
1298 *
1299 * @param number|bool $plugin_id
1300 *
1301 * @return array
1302 */
1303 function install_and_activate_plugin( $plugin_id = false ) {
1304 if ( ! empty( $plugin_id ) && ! FS_Plugin::is_valid_id( $plugin_id ) ) {
1305 // Invalid plugin ID.
1306 return array(
1307 'message' => $this->_fs->get_text_inline( 'Invalid module ID.', 'auto-install-error-invalid-id' ),
1308 'code' => 'invalid_module_id',
1309 );
1310 }
1311
1312 $is_addon = false;
1313 if ( FS_Plugin::is_valid_id( $plugin_id ) &&
1314 $plugin_id != $this->_fs->get_id()
1315 ) {
1316 $addon = $this->_fs->get_addon( $plugin_id );
1317
1318 if ( ! is_object( $addon ) ) {
1319 // Invalid add-on ID.
1320 return array(
1321 'message' => $this->_fs->get_text_inline( 'Invalid module ID.', 'auto-install-error-invalid-id' ),
1322 'code' => 'invalid_module_id',
1323 );
1324 }
1325
1326 $slug = $addon->slug;
1327 $premium_slug = $addon->premium_slug;
1328 $title = $addon->title . ' ' . $this->_fs->get_text_inline( 'Add-On', 'addon' );
1329
1330 $is_addon = true;
1331 } else {
1332 $slug = $this->_fs->get_slug();
1333 $premium_slug = $this->_fs->get_premium_slug();
1334 $title = $this->_fs->get_plugin_title() .
1335 ( $this->_fs->is_addon() ? ' ' . $this->_fs->get_text_inline( 'Add-On', 'addon' ) : '' );
1336 }
1337
1338 if ( $this->is_premium_plugin_active( $plugin_id ) ) {
1339 // Premium version already activated.
1340 return array(
1341 'message' => $is_addon ?
1342 $this->_fs->get_text_inline( 'Premium add-on version already installed.', 'auto-install-error-premium-addon-activated' ) :
1343 $this->_fs->get_text_inline( 'Premium version already active.', 'auto-install-error-premium-activated' ),
1344 'code' => 'premium_installed',
1345 );
1346 }
1347
1348 $latest_version = $this->get_latest_download_details( $plugin_id, false, false );
1349 $target_folder = $premium_slug;
1350
1351 // Prep variables for Plugin_Installer_Skin class.
1352 $extra = array();
1353 $extra['slug'] = $target_folder;
1354 $source = $latest_version->url;
1355 $api = null;
1356
1357 $install_url = add_query_arg(
1358 array(
1359 'action' => 'install-plugin',
1360 'plugin' => urlencode( $slug ),
1361 ),
1362 'update.php'
1363 );
1364
1365 if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
1366 // Include required resources for the installation.
1367 require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
1368 }
1369
1370 $skin_args = array(
1371 'type' => 'web',
1372 'title' => sprintf( $this->_fs->get_text_inline( 'Installing plugin: %s', 'installing-plugin-x' ), $title ),
1373 'url' => esc_url_raw( $install_url ),
1374 'nonce' => 'install-plugin_' . $slug,
1375 'plugin' => '',
1376 'api' => $api,
1377 'extra' => $extra,
1378 );
1379
1380 // $skin = new Automatic_Upgrader_Skin( $skin_args );
1381 // $skin = new Plugin_Installer_Skin( $skin_args );
1382 $skin = new WP_Ajax_Upgrader_Skin( $skin_args );
1383
1384 // Create a new instance of Plugin_Upgrader.
1385 $upgrader = new Plugin_Upgrader( $skin );
1386
1387 // Perform the action and install the plugin from the $source urldecode().
1388 add_filter( 'upgrader_source_selection', array( 'FS_Plugin_Updater', '_maybe_adjust_source_dir' ), 1, 3 );
1389
1390 $install_result = $upgrader->install( $source );
1391
1392 remove_filter( 'upgrader_source_selection', array( 'FS_Plugin_Updater', '_maybe_adjust_source_dir' ), 1 );
1393
1394 if ( is_wp_error( $install_result ) ) {
1395 return array(
1396 'message' => $install_result->get_error_message(),
1397 'code' => $install_result->get_error_code(),
1398 );
1399 } elseif ( is_wp_error( $skin->result ) ) {
1400 return array(
1401 'message' => $skin->result->get_error_message(),
1402 'code' => $skin->result->get_error_code(),
1403 );
1404 } elseif ( $skin->get_errors()->get_error_code() ) {
1405 return array(
1406 'message' => $skin->get_error_messages(),
1407 'code' => 'unknown',
1408 );
1409 } elseif ( is_null( $install_result ) ) {
1410 global $wp_filesystem;
1411
1412 $error_code = 'unable_to_connect_to_filesystem';
1413 $error_message = $this->_fs->get_text_inline( 'Unable to connect to the filesystem. Please confirm your credentials.' );
1414
1415 // Pass through the error from WP_Filesystem if one was raised.
1416 if ( $wp_filesystem instanceof WP_Filesystem_Base &&
1417 is_wp_error( $wp_filesystem->errors ) &&
1418 $wp_filesystem->errors->get_error_code()
1419 ) {
1420 $error_message = $wp_filesystem->errors->get_error_message();
1421 }
1422
1423 return array(
1424 'message' => $error_message,
1425 'code' => $error_code,
1426 );
1427 }
1428
1429 // Grab the full path to the main plugin's file.
1430 $plugin_activate = $upgrader->plugin_info();
1431
1432 // Try to activate the plugin.
1433 $activation_result = $this->try_activate_plugin( $plugin_activate );
1434
1435 if ( is_wp_error( $activation_result ) ) {
1436 return array(
1437 'message' => $activation_result->get_error_message(),
1438 'code' => $activation_result->get_error_code(),
1439 );
1440 }
1441
1442 return $skin->get_upgrade_messages();
1443 }
1444
1445 /**
1446 * Tries to activate a plugin. If fails, returns the error.
1447 *
1448 * @author Vova Feldman
1449 * @since 1.2.1.7
1450 *
1451 * @param string $file_path Path within wp-plugins/ to main plugin file.
1452 * This determines the styling of the output messages.
1453 *
1454 * @return bool|WP_Error
1455 */
1456 protected function try_activate_plugin( $file_path ) {
1457 $activate = activate_plugin( $file_path, '', $this->_fs->is_network_active() );
1458
1459 return is_wp_error( $activate ) ?
1460 $activate :
1461 true;
1462 }
1463
1464 /**
1465 * Check if a premium module version is already active.
1466 *
1467 * @author Vova Feldman
1468 * @since 1.2.1.7
1469 *
1470 * @param number|bool $plugin_id
1471 *
1472 * @return bool
1473 */
1474 private function is_premium_plugin_active( $plugin_id = false ) {
1475 if ( $plugin_id != $this->_fs->get_id() ) {
1476 return $this->_fs->is_addon_activated( $plugin_id, true );
1477 }
1478
1479 return is_plugin_active( $this->_fs->premium_plugin_basename() );
1480 }
1481
1482 /**
1483 * Store the basename since it's not always available in the `_maybe_adjust_source_dir` method below.
1484 *
1485 * @author Leo Fajardo (@leorw)
1486 * @since 2.2.1
1487 *
1488 * @param bool|WP_Error $response Response.
1489 * @param array $hook_extra Extra arguments passed to hooked filters.
1490 *
1491 * @return bool|WP_Error
1492 */
1493 static function _store_basename_for_source_adjustment( $response, $hook_extra ) {
1494 if ( isset( $hook_extra['plugin'] ) ) {
1495 self::$_upgrade_basename = $hook_extra['plugin'];
1496 } else if ( isset( $hook_extra['theme'] ) ) {
1497 self::$_upgrade_basename = $hook_extra['theme'];
1498 } else {
1499 self::$_upgrade_basename = null;
1500 }
1501
1502 return $response;
1503 }
1504
1505 /**
1506 * Adjust the plugin directory name if necessary.
1507 * Assumes plugin has a folder (not a single file plugin).
1508 *
1509 * The final destination directory of a plugin is based on the subdirectory name found in the
1510 * (un)zipped source. In some cases this subdirectory name is not the same as the expected
1511 * slug and the plugin will not be recognized as installed. This is fixed by adjusting
1512 * the temporary unzipped source subdirectory name to the expected plugin slug.
1513 *
1514 * @author Vova Feldman
1515 * @since 1.2.1.7
1516 * @since 2.2.1 The method was converted to static since when the admin update bulk products via the Updates section, the logic applies the `upgrader_source_selection` filter for every product that is being updated.
1517 *
1518 * @param string $source Path to upgrade/zip-file-name.tmp/subdirectory/.
1519 * @param string $remote_source Path to upgrade/zip-file-name.tmp.
1520 * @param \WP_Upgrader $upgrader Instance of the upgrader which installs the plugin.
1521 *
1522 * @return string|WP_Error
1523 */
1524 static function _maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
1525 if ( ! is_object( $GLOBALS['wp_filesystem'] ) ) {
1526 return $source;
1527 }
1528
1529 $basename = self::$_upgrade_basename;
1530 $is_theme = false;
1531
1532 // Figure out what the slug is supposed to be.
1533 if ( isset( $upgrader->skin->options['extra'] ) ) {
1534 // Set by the auto-install logic.
1535 $desired_slug = $upgrader->skin->options['extra']['slug'];
1536 } else if ( ! empty( $basename ) ) {
1537 /**
1538 * If it doesn't end with ".php", it's a theme.
1539 *
1540 * @author Leo Fajardo (@leorw)
1541 * @since 2.2.1
1542 */
1543 $is_theme = ( ! fs_ends_with( $basename, '.php' ) );
1544
1545 $desired_slug = ( ! $is_theme ) ?
1546 dirname( $basename ) :
1547 // Theme slug
1548 $basename;
1549 } else {
1550 // Can't figure out the desired slug, stop the execution.
1551 return $source;
1552 }
1553
1554 if ( is_multisite() ) {
1555 /**
1556 * If we are running in a multisite environment and the product is not network activated,
1557 * the instance will not exist anyway. Therefore, try to update the source if necessary
1558 * regardless if the Freemius instance of the product exists or not.
1559 *
1560 * @author Vova Feldman
1561 */
1562 } else if ( ! empty( $basename ) ) {
1563 $fs = Freemius::get_instance_by_file(
1564 $basename,
1565 $is_theme ?
1566 WP_FS__MODULE_TYPE_THEME :
1567 WP_FS__MODULE_TYPE_PLUGIN
1568 );
1569
1570 if ( ! is_object( $fs ) ) {
1571 /**
1572 * If the Freemius instance does not exist on a non-multisite network environment, it means that:
1573 * 1. The product is not powered by Freemius; OR
1574 * 2. The product is not activated, therefore, we don't mind if after the update the folder name will change.
1575 *
1576 * @author Leo Fajardo (@leorw)
1577 * @since 2.2.1
1578 */
1579 return $source;
1580 }
1581 }
1582
1583 $subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
1584
1585 if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
1586 $from_path = untrailingslashit( $source );
1587 $to_path = trailingslashit( $remote_source ) . $desired_slug;
1588
1589 if ( true === $GLOBALS['wp_filesystem']->move( $from_path, $to_path ) ) {
1590 return trailingslashit( $to_path );
1591 }
1592
1593 return new WP_Error(
1594 'rename_failed',
1595 fs_text_inline( 'The remote plugin package does not contain a folder with the desired slug and renaming did not work.', 'module-package-rename-failure' ),
1596 array(
1597 'found' => $subdir_name,
1598 'expected' => $desired_slug
1599 )
1600 );
1601 }
1602
1603 return $source;
1604 }
1605
1606 #endregion
1607 }
1608