PluginProbe
Polylang / 2.6.2
Polylang v2.6.2
3.8.9 3.8.8 3.8.7 3.8.6 3.8.5 3.8.4 3.8.3 2.7 2.7.0.1 2.7.1 2.7.2 2.7.3 2.7.4 2.8 2.8.1 2.8.2 2.8.3 2.8.4 2.9 2.9.1 2.9.2 3.0 3.0.1 3.0.2 3.0.3 All 233 releases
polylang / install / plugin-updater.php

plugin-updater.php in Polylang 2.6.2, at install/plugin-updater.php

578 lines 17.6 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2
3 // Exit if accessed directly
4 if ( ! defined( 'ABSPATH' ) ) {
5 exit;
6 }
7
8 /**
9 * Allows plugins to use their own update API.
10 * Modified version with 'polylang' text domain and comments for translators
11 *
12 * @author Easy Digital Downloads
13 * @version 1.6.18
14 */
15 class PLL_Plugin_Updater {
16
17 private $api_url = '';
18 private $api_data = array();
19 private $name = '';
20 private $slug = '';
21 private $version = '';
22 private $wp_override = false;
23 private $cache_key = '';
24
25 private $health_check_timeout = 5;
26
27 /**
28 * Class constructor.
29 *
30 * @uses plugin_basename()
31 * @uses hook()
32 *
33 * @param string $_api_url The URL pointing to the custom API endpoint.
34 * @param string $_plugin_file Path to the plugin file.
35 * @param array $_api_data Optional data to send with API calls.
36 */
37 public function __construct( $_api_url, $_plugin_file, $_api_data = null ) {
38
39 global $edd_plugin_data;
40
41 $this->api_url = trailingslashit( $_api_url );
42 $this->api_data = $_api_data;
43 $this->name = plugin_basename( $_plugin_file );
44 $this->slug = basename( $_plugin_file, '.php' );
45 $this->version = $_api_data['version'];
46 $this->wp_override = isset( $_api_data['wp_override'] ) ? (bool) $_api_data['wp_override'] : false;
47 $this->beta = ! empty( $this->api_data['beta'] ) ? true : false;
48 $this->cache_key = 'edd_sl_' . md5( serialize( $this->slug . $this->api_data['license'] . $this->beta ) );
49
50 $edd_plugin_data[ $this->slug ] = $this->api_data;
51
52 /**
53 * Fires after the $edd_plugin_data is setup.
54 *
55 * @since x.x.x
56 *
57 * @param array $edd_plugin_data Array of EDD SL plugin data.
58 */
59 do_action( 'post_edd_sl_plugin_updater_setup', $edd_plugin_data );
60
61 // Set up hooks.
62 $this->init();
63
64 }
65
66 /**
67 * Set up WordPress filters to hook into WP's update process.
68 *
69 * @uses add_filter()
70 *
71 * @return void
72 */
73 public function init() {
74
75 add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_update' ) );
76 add_filter( 'plugins_api', array( $this, 'plugins_api_filter' ), 10, 3 );
77 remove_action( 'after_plugin_row_' . $this->name, 'wp_plugin_update_row', 10 );
78 add_action( 'after_plugin_row_' . $this->name, array( $this, 'show_update_notification' ), 10, 2 );
79 add_action( 'admin_init', array( $this, 'show_changelog' ) );
80
81 }
82
83 /**
84 * Check for Updates at the defined API endpoint and modify the update array.
85 *
86 * This function dives into the update API just when WordPress creates its update array,
87 * then adds a custom API call and injects the custom plugin data retrieved from the API.
88 * It is reassembled from parts of the native WordPress plugin update code.
89 * See wp-includes/update.php line 121 for the original wp_update_plugins() function.
90 *
91 * @uses api_request()
92 *
93 * @param array $_transient_data Update array build by WordPress.
94 * @return array Modified update array with custom plugin data.
95 */
96 public function check_update( $_transient_data ) {
97
98 global $pagenow;
99
100 if ( ! is_object( $_transient_data ) ) {
101 $_transient_data = new stdClass;
102 }
103
104 if ( 'plugins.php' == $pagenow && is_multisite() ) {
105 return $_transient_data;
106 }
107
108 if ( ! empty( $_transient_data->response ) && ! empty( $_transient_data->response[ $this->name ] ) && false === $this->wp_override ) {
109 return $_transient_data;
110 }
111
112 $version_info = $this->get_cached_version_info();
113
114 if ( false === $version_info ) {
115 $version_info = $this->api_request( 'plugin_latest_version', array( 'slug' => $this->slug, 'beta' => $this->beta ) );
116
117 $this->set_version_info_cache( $version_info );
118
119 }
120
121 if ( false !== $version_info && is_object( $version_info ) && isset( $version_info->new_version ) ) {
122
123 if ( version_compare( $this->version, $version_info->new_version, '<' ) ) {
124
125 $_transient_data->response[ $this->name ] = $version_info;
126
127 // Make sure the plugin property is set to the plugin's name/location. See issue 1463 on Software Licensing's GitHub repo.
128 $_transient_data->response[ $this->name ]->plugin = $this->name;
129
130 }
131
132 $_transient_data->last_checked = time();
133 $_transient_data->checked[ $this->name ] = $this->version;
134
135 }
136
137 return $_transient_data;
138 }
139
140 /**
141 * show update nofication row -- needed for multisite subsites, because WP won't tell you otherwise!
142 *
143 * @param string $file
144 * @param array $plugin
145 */
146 public function show_update_notification( $file, $plugin ) {
147
148 if ( is_network_admin() ) {
149 return;
150 }
151
152 if( ! current_user_can( 'update_plugins' ) ) {
153 return;
154 }
155
156 if( ! is_multisite() ) {
157 return;
158 }
159
160 if ( $this->name != $file ) {
161 return;
162 }
163
164 // Remove our filter on the site transient
165 remove_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_update' ), 10 );
166
167 $update_cache = get_site_transient( 'update_plugins' );
168
169 $update_cache = is_object( $update_cache ) ? $update_cache : new stdClass();
170
171 if ( empty( $update_cache->response ) || empty( $update_cache->response[ $this->name ] ) ) {
172
173 $version_info = $this->get_cached_version_info();
174
175 if ( false === $version_info ) {
176 $version_info = $this->api_request( 'plugin_latest_version', array( 'slug' => $this->slug, 'beta' => $this->beta ) );
177
178 // Since we disabled our filter for the transient, we aren't running our object conversion on banners, sections, or icons. Do this now:
179 if ( isset( $version_info->banners ) && ! is_array( $version_info->banners ) ) {
180 $version_info->banners = $this->convert_object_to_array( $version_info->banners );
181 }
182
183 if ( isset( $version_info->sections ) && ! is_array( $version_info->sections ) ) {
184 $version_info->sections = $this->convert_object_to_array( $version_info->sections );
185 }
186
187 if ( isset( $version_info->icons ) && ! is_array( $version_info->icons ) ) {
188 $version_info->icons = $this->convert_object_to_array( $version_info->icons );
189 }
190
191 $this->set_version_info_cache( $version_info );
192 }
193
194 if ( ! is_object( $version_info ) ) {
195 return;
196 }
197
198 if ( version_compare( $this->version, $version_info->new_version, '<' ) ) {
199
200 $update_cache->response[ $this->name ] = $version_info;
201
202 }
203
204 $update_cache->last_checked = time();
205 $update_cache->checked[ $this->name ] = $this->version;
206
207 set_site_transient( 'update_plugins', $update_cache );
208
209 } else {
210
211 $version_info = $update_cache->response[ $this->name ];
212
213 }
214
215 // Restore our filter
216 add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_update' ) );
217
218 if ( ! empty( $update_cache->response[ $this->name ] ) && version_compare( $this->version, $version_info->new_version, '<' ) ) {
219
220 // build a plugin list row, with update notification
221 $wp_list_table = _get_list_table( 'WP_Plugins_List_Table' );
222 # <tr class="plugin-update-tr"><td colspan="' . $wp_list_table->get_column_count() . '" class="plugin-update colspanchange">
223 echo '<tr class="plugin-update-tr" id="' . $this->slug . '-update" data-slug="' . $this->slug . '" data-plugin="' . $this->slug . '/' . $file . '">';
224 echo '<td colspan="3" class="plugin-update colspanchange">';
225 echo '<div class="update-message notice inline notice-warning notice-alt">';
226
227 $changelog_link = self_admin_url( 'index.php?edd_sl_action=view_plugin_changelog&plugin=' . $this->name . '&slug=' . $this->slug . '&TB_iframe=true&width=772&height=911' );
228
229 if ( empty( $version_info->download_link ) ) {
230 printf(
231 /* translators: %1$s plugin name, %3$s plugin version, %2$s is link start tag, %4$s is link end tag. */
232 __( 'There is a new version of %1$s available. %2$sView version %3$s details%4$s.', 'polylang' ),
233 esc_html( $version_info->name ),
234 '<a target="_blank" class="thickbox" href="' . esc_url( $changelog_link ) . '">',
235 esc_html( $version_info->new_version ),
236 '</a>'
237 );
238 } else {
239 printf(
240 /* translators: %1$s plugin name, %3$s plugin version, %2$s and %5$s are link start tags, %4$s and %6$s are link end tags. */
241 __( 'There is a new version of %1$s available. %2$sView version %3$s details%4$s or %5$supdate now%6$s.', 'polylang' ),
242 esc_html( $version_info->name ),
243 '<a target="_blank" class="thickbox" href="' . esc_url( $changelog_link ) . '">',
244 esc_html( $version_info->new_version ),
245 '</a>',
246 '<a href="' . esc_url( wp_nonce_url( self_admin_url( 'update.php?action=upgrade-plugin&plugin=' ) . $this->name, 'upgrade-plugin_' . $this->name ) ) .'">',
247 '</a>'
248 );
249 }
250
251 do_action( "in_plugin_update_message-{$file}", $plugin, $version_info );
252
253 echo '</div></td></tr>';
254 }
255 }
256
257 /**
258 * Updates information on the "View version x.x details" page with custom data.
259 *
260 * @uses api_request()
261 *
262 * @param mixed $_data
263 * @param string $_action
264 * @param object $_args
265 * @return object $_data
266 */
267 public function plugins_api_filter( $_data, $_action = '', $_args = null ) {
268
269 if ( $_action != 'plugin_information' ) {
270
271 return $_data;
272
273 }
274
275 if ( ! isset( $_args->slug ) || ( $_args->slug != $this->slug ) ) {
276
277 return $_data;
278
279 }
280
281 $to_send = array(
282 'slug' => $this->slug,
283 'is_ssl' => is_ssl(),
284 'fields' => array(
285 'banners' => array(),
286 'reviews' => false,
287 'icons' => array(),
288 )
289 );
290
291 $cache_key = 'edd_api_request_' . md5( serialize( $this->slug . $this->api_data['license'] . $this->beta ) );
292
293 // Get the transient where we store the api request for this plugin for 24 hours
294 $edd_api_request_transient = $this->get_cached_version_info( $cache_key );
295
296 //If we have no transient-saved value, run the API, set a fresh transient with the API value, and return that value too right now.
297 if ( empty( $edd_api_request_transient ) ) {
298
299 $api_response = $this->api_request( 'plugin_information', $to_send );
300
301 // Expires in 3 hours
302 $this->set_version_info_cache( $api_response, $cache_key );
303
304 if ( false !== $api_response ) {
305 $_data = $api_response;
306 }
307
308 } else {
309 $_data = $edd_api_request_transient;
310 }
311
312 // Convert sections into an associative array, since we're getting an object, but Core expects an array.
313 if ( isset( $_data->sections ) && ! is_array( $_data->sections ) ) {
314 $_data->sections = $this->convert_object_to_array( $_data->sections );
315 }
316
317 // Convert banners into an associative array, since we're getting an object, but Core expects an array.
318 if ( isset( $_data->banners ) && ! is_array( $_data->banners ) ) {
319 $_data->banners = $this->convert_object_to_array( $_data->banners );
320 }
321
322 // Convert icons into an associative array, since we're getting an object, but Core expects an array.
323 if ( isset( $_data->icons ) && ! is_array( $_data->icons ) ) {
324 $_data->icons = $this->convert_object_to_array( $_data->icons );
325 }
326
327 if( ! isset( $_data->plugin ) ) {
328 $_data->plugin = $this->name;
329 }
330
331 return $_data;
332 }
333
334 /**
335 * Convert some objects to arrays when injecting data into the update API
336 *
337 * Some data like sections, banners, and icons are expected to be an associative array, however due to the JSON
338 * decoding, they are objects. This method allows us to pass in the object and return an associative array.
339 *
340 * @since 3.6.5
341 *
342 * @param stdClass $data
343 *
344 * @return array
345 */
346 private function convert_object_to_array( $data ) {
347 $new_data = array();
348 foreach ( $data as $key => $value ) {
349 $new_data[ $key ] = $value;
350 }
351
352 return $new_data;
353 }
354
355 /**
356 * Disable SSL verification in order to prevent download update failures
357 *
358 * @param array $args
359 * @param string $url
360 * @return object $array
361 */
362 public function http_request_args( $args, $url ) {
363
364 $verify_ssl = $this->verify_ssl();
365 if ( strpos( $url, 'https://' ) !== false && strpos( $url, 'edd_action=package_download' ) ) {
366 $args['sslverify'] = $verify_ssl;
367 }
368 return $args;
369
370 }
371
372 /**
373 * Calls the API and, if successfull, returns the object delivered by the API.
374 *
375 * @uses get_bloginfo()
376 * @uses wp_remote_post()
377 * @uses is_wp_error()
378 *
379 * @param string $_action The requested action.
380 * @param array $_data Parameters for the API action.
381 * @return false|object
382 */
383 private function api_request( $_action, $_data ) {
384
385 global $wp_version, $edd_plugin_url_available;
386
387 $verify_ssl = $this->verify_ssl();
388
389 // Do a quick status check on this domain if we haven't already checked it.
390 $store_hash = md5( $this->api_url );
391 if ( ! is_array( $edd_plugin_url_available ) || ! isset( $edd_plugin_url_available[ $store_hash ] ) ) {
392 $test_url_parts = parse_url( $this->api_url );
393
394 $scheme = ! empty( $test_url_parts['scheme'] ) ? $test_url_parts['scheme'] : 'http';
395 $host = ! empty( $test_url_parts['host'] ) ? $test_url_parts['host'] : '';
396 $port = ! empty( $test_url_parts['port'] ) ? ':' . $test_url_parts['port'] : '';
397
398 if ( empty( $host ) ) {
399 $edd_plugin_url_available[ $store_hash ] = false;
400 } else {
401 $test_url = $scheme . '://' . $host . $port;
402 $response = wp_remote_get( $test_url, array( 'timeout' => $this->health_check_timeout, 'sslverify' => $verify_ssl ) );
403 $edd_plugin_url_available[ $store_hash ] = is_wp_error( $response ) ? false : true;
404 }
405 }
406
407 if ( false === $edd_plugin_url_available[ $store_hash ] ) {
408 return;
409 }
410
411 $data = array_merge( $this->api_data, $_data );
412
413 if ( $data['slug'] != $this->slug ) {
414 return;
415 }
416
417 if( $this->api_url == trailingslashit ( home_url() ) ) {
418 return false; // Don't allow a plugin to ping itself
419 }
420
421 $api_params = array(
422 'edd_action' => 'get_version',
423 'license' => ! empty( $data['license'] ) ? $data['license'] : '',
424 'item_name' => isset( $data['item_name'] ) ? $data['item_name'] : false,
425 'item_id' => isset( $data['item_id'] ) ? $data['item_id'] : false,
426 'version' => isset( $data['version'] ) ? $data['version'] : false,
427 'slug' => $data['slug'],
428 'author' => $data['author'],
429 'url' => home_url(),
430 'beta' => ! empty( $data['beta'] ),
431 );
432
433 $request = wp_remote_post( $this->api_url, array( 'timeout' => 15, 'sslverify' => $verify_ssl, 'body' => $api_params ) );
434
435 if ( ! is_wp_error( $request ) ) {
436 $request = json_decode( wp_remote_retrieve_body( $request ) );
437 }
438
439 if ( $request && isset( $request->sections ) ) {
440 $request->sections = maybe_unserialize( $request->sections );
441 } else {
442 $request = false;
443 }
444
445 if ( $request && isset( $request->banners ) ) {
446 $request->banners = maybe_unserialize( $request->banners );
447 }
448
449 if ( $request && isset( $request->icons ) ) {
450 $request->icons = maybe_unserialize( $request->icons );
451 }
452
453 if( ! empty( $request->sections ) ) {
454 foreach( $request->sections as $key => $section ) {
455 $request->$key = (array) $section;
456 }
457 }
458
459 return $request;
460 }
461
462 public function show_changelog() {
463
464 global $edd_plugin_data;
465
466 if( empty( $_REQUEST['edd_sl_action'] ) || 'view_plugin_changelog' != $_REQUEST['edd_sl_action'] ) {
467 return;
468 }
469
470 if( empty( $_REQUEST['plugin'] ) ) {
471 return;
472 }
473
474 if( empty( $_REQUEST['slug'] ) ) {
475 return;
476 }
477
478 if( ! current_user_can( 'update_plugins' ) ) {
479 wp_die( __( 'You do not have permission to install plugin updates', 'polylang' ), __( 'Error', 'polylang' ), array( 'response' => 403 ) );
480 }
481
482 $data = $edd_plugin_data[ $_REQUEST['slug'] ];
483 $beta = ! empty( $data['beta'] ) ? true : false;
484 $cache_key = md5( 'edd_plugin_' . sanitize_key( $_REQUEST['plugin'] ) . '_' . $beta . '_version_info' );
485 $version_info = $this->get_cached_version_info( $cache_key );
486
487 if( false === $version_info ) {
488
489 $api_params = array(
490 'edd_action' => 'get_version',
491 'item_name' => isset( $data['item_name'] ) ? $data['item_name'] : false,
492 'item_id' => isset( $data['item_id'] ) ? $data['item_id'] : false,
493 'slug' => $_REQUEST['slug'],
494 'author' => $data['author'],
495 'url' => home_url(),
496 'beta' => ! empty( $data['beta'] )
497 );
498
499 $verify_ssl = $this->verify_ssl();
500 $request = wp_remote_post( $this->api_url, array( 'timeout' => 15, 'sslverify' => $verify_ssl, 'body' => $api_params ) );
501
502 if ( ! is_wp_error( $request ) ) {
503 $version_info = json_decode( wp_remote_retrieve_body( $request ) );
504 }
505
506
507 if ( ! empty( $version_info ) && isset( $version_info->sections ) ) {
508 $version_info->sections = maybe_unserialize( $version_info->sections );
509 } else {
510 $version_info = false;
511 }
512
513 if( ! empty( $version_info ) ) {
514 foreach( $version_info->sections as $key => $section ) {
515 $version_info->$key = (array) $section;
516 }
517 }
518
519 $this->set_version_info_cache( $version_info, $cache_key );
520
521 }
522
523 if( ! empty( $version_info ) && isset( $version_info->sections['changelog'] ) ) {
524 echo '<div style="background:#fff;padding:10px;">' . $version_info->sections['changelog'] . '</div>';
525 }
526
527 exit;
528 }
529
530 public function get_cached_version_info( $cache_key = '' ) {
531
532 if( empty( $cache_key ) ) {
533 $cache_key = $this->cache_key;
534 }
535
536 $cache = get_option( $cache_key );
537
538 if( empty( $cache['timeout'] ) || time() > $cache['timeout'] ) {
539 return false; // Cache is expired
540 }
541
542 // We need to turn the icons into an array, thanks to WP Core forcing these into an object at some point.
543 $cache['value'] = json_decode( $cache['value'] );
544 if ( ! empty( $cache['value']->icons ) ) {
545 $cache['value']->icons = (array) $cache['value']->icons;
546 }
547
548 return $cache['value'];
549
550 }
551
552 public function set_version_info_cache( $value = '', $cache_key = '' ) {
553
554 if( empty( $cache_key ) ) {
555 $cache_key = $this->cache_key;
556 }
557
558 $data = array(
559 'timeout' => strtotime( '+3 hours', time() ),
560 'value' => json_encode( $value )
561 );
562
563 update_option( $cache_key, $data, 'no' );
564
565 }
566
567 /**
568 * Returns if the SSL of the store should be verified.
569 *
570 * @since 1.6.13
571 * @return bool
572 */
573 private function verify_ssl() {
574 return (bool) apply_filters( 'edd_sl_api_request_verify_ssl', true, $this );
575 }
576
577 }
578