403 lines
11 KiB
PHP
403 lines
11 KiB
PHP
<?php
|
|
namespace ElementorPro\Core\Updater;
|
|
|
|
// Prevent loading this file directly and/or if the class is already defined
|
|
if ( ! defined( 'ABSPATH' ) || class_exists( 'Updater' ) )
|
|
return;
|
|
class Updater {
|
|
|
|
/**
|
|
* @var $config the config for the updater
|
|
* @access public
|
|
*/
|
|
var $config;
|
|
|
|
/**
|
|
* @var $missing_config any config that is missing from the initialization of this instance
|
|
* @access public
|
|
*/
|
|
var $missing_config;
|
|
|
|
/**
|
|
* @var $github_data temporiraly store the data fetched from GitHub, allows us to only load the data once per class instance
|
|
* @access private
|
|
*/
|
|
private $github_data;
|
|
|
|
|
|
/**
|
|
* Class Constructor
|
|
*
|
|
* @since 1.0
|
|
* @param array $config the configuration required for the updater to work
|
|
* @see has_minimum_config()
|
|
* @return void
|
|
*/
|
|
public function __construct( $config = array() ) {
|
|
|
|
$defaults = array(
|
|
'slug' => plugin_basename( __FILE__ ),
|
|
'plugin_basename' => plugin_basename( __FILE__ ),
|
|
'proper_folder_name' => dirname( plugin_basename( __FILE__ ) ),
|
|
'sslverify' => true,
|
|
'access_token' => '',
|
|
);
|
|
|
|
$this->config = wp_parse_args( $config, $defaults );
|
|
|
|
$this->set_defaults();
|
|
|
|
add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_update' ) , 100 );
|
|
|
|
// Hook into the plugin details screen
|
|
add_filter( 'plugins_api', array( $this, 'get_plugin_info' ), 10, 3 );
|
|
add_filter( 'upgrader_post_install', array( $this, 'upgrader_post_install' ), 10, 3 );
|
|
|
|
// set timeout
|
|
add_filter( 'http_request_timeout', array( $this, 'http_request_timeout' ) );
|
|
|
|
// set sslverify for zip download
|
|
add_filter( 'http_request_args', array( $this, 'http_request_sslverify' ), 10, 2 );
|
|
}
|
|
|
|
|
|
/**
|
|
* Check wether or not the transients need to be overruled and API needs to be called for every single page load
|
|
*
|
|
* @return bool overrule or not
|
|
*/
|
|
public function overrule_transients() {
|
|
global $pagenow;
|
|
if ( 'update-core.php' === $pagenow && isset( $_GET['force-check'] ) ) {
|
|
return true;
|
|
}
|
|
return ( defined( 'WP_GITHUB_FORCE_UPDATE' ) && WP_GITHUB_FORCE_UPDATE );
|
|
}
|
|
|
|
|
|
/**
|
|
* Set defaults
|
|
*
|
|
* @since 1.2
|
|
* @return void
|
|
*/
|
|
public function set_defaults() {
|
|
if ( !empty( $this->config['access_token'] ) ) {
|
|
|
|
extract( parse_url( $this->config['zip_url'] ) ); // $scheme, $host, $path
|
|
|
|
$zip_url = $scheme . '://api.github.com/repos' . $path;
|
|
$zip_url = add_query_arg( array( 'access_token' => $this->config['access_token'] ), $zip_url );
|
|
|
|
$this->config['zip_url'] = $zip_url;
|
|
}
|
|
|
|
|
|
if ( ! isset( $this->config['new_version'] ) )
|
|
$this->config['new_version'] = $this->get_new_version();
|
|
|
|
if ( ! isset( $this->config['last_updated'] ) )
|
|
$this->config['last_updated'] = $this->get_date();
|
|
|
|
if ( ! isset( $this->config['description'] ) )
|
|
$this->config['description'] = $this->get_description();
|
|
|
|
$plugin_data = $this->get_plugin_data();
|
|
if ( ! isset( $this->config['plugin_name'] ) )
|
|
$this->config['plugin_name'] = $plugin_data['Name'];
|
|
|
|
if ( ! isset( $this->config['version'] ) )
|
|
$this->config['version'] = $plugin_data['Version'];
|
|
|
|
if ( ! isset( $this->config['author'] ) )
|
|
$this->config['author'] = $plugin_data['Author'];
|
|
|
|
if ( ! isset( $this->config['homepage'] ) )
|
|
$this->config['homepage'] = $plugin_data['PluginURI'];
|
|
|
|
if ( ! isset( $this->config['readme'] ) )
|
|
$this->config['readme'] = 'README.md';
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Callback fn for the http_request_timeout filter
|
|
*
|
|
* @since 1.0
|
|
* @return int timeout value
|
|
*/
|
|
public function http_request_timeout() {
|
|
return 2;
|
|
}
|
|
|
|
/**
|
|
* Callback fn for the http_request_args filter
|
|
*
|
|
* @param unknown $args
|
|
* @param unknown $url
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function http_request_sslverify( $args, $url ) {
|
|
if ( $this->get_zip_url() == $url )
|
|
$args[ 'sslverify' ] = $this->config[ 'sslverify' ];
|
|
|
|
return $args;
|
|
}
|
|
|
|
private function get_zip_url() {
|
|
return $prev_icon_class = str_replace( '{release_version}', $this->config['new_version'], $this->config[ 'zip_url' ] );
|
|
}
|
|
|
|
/**
|
|
* Get New Version from GitHub
|
|
*
|
|
* @since 1.0
|
|
* @return int $version the version number
|
|
*/
|
|
public function get_new_version() {
|
|
$version = get_site_transient( md5($this->config['slug']).'_new_version' );
|
|
|
|
if ( $this->overrule_transients() || ( !isset( $version ) || !$version || '' == $version ) ) {
|
|
|
|
$raw_response = $this->remote_get( trailingslashit( $this->config['raw_url'] ) . basename( $this->config['slug'] ) );
|
|
|
|
if ( is_wp_error( $raw_response ) )
|
|
$version = false;
|
|
|
|
if (is_array($raw_response)) {
|
|
if (!empty($raw_response['body']))
|
|
preg_match( '/.*Version\:\s*(.*)$/mi', $raw_response['body'], $matches );
|
|
}
|
|
|
|
if ( empty( $matches[1] ) )
|
|
$version = false;
|
|
else
|
|
$version = $matches[1];
|
|
|
|
// back compat for older readme version handling
|
|
// only done when there is no version found in file name
|
|
if ( false === $version ) {
|
|
$raw_response = $this->remote_get( trailingslashit( $this->config['raw_url'] ) . $this->config['readme'] );
|
|
|
|
if ( is_wp_error( $raw_response ) )
|
|
return $version;
|
|
|
|
preg_match( '#^\s*`*~Current Version\:\s*([^~]*)~#im', $raw_response['body'], $__version );
|
|
|
|
if ( isset( $__version[1] ) ) {
|
|
$version_readme = $__version[1];
|
|
if ( -1 == version_compare( $version, $version_readme ) )
|
|
$version = $version_readme;
|
|
}
|
|
}
|
|
|
|
// refresh every 6 hours
|
|
if ( false !== $version )
|
|
set_site_transient( md5($this->config['slug']).'_new_version', $version, 60*60*6 );
|
|
}
|
|
|
|
return $version;
|
|
}
|
|
|
|
|
|
/**
|
|
* Interact with GitHub
|
|
*
|
|
* @param string $query
|
|
*
|
|
* @since 1.6
|
|
* @return mixed
|
|
*/
|
|
public function remote_get( $query ) {
|
|
if ( ! empty( $this->config['access_token'] ) )
|
|
$query = add_query_arg( array( 'access_token' => $this->config['access_token'] ), $query );
|
|
|
|
$raw_response = wp_remote_get( $query, array(
|
|
'sslverify' => $this->config['sslverify']
|
|
) );
|
|
|
|
return $raw_response;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get GitHub Data from the specified repository
|
|
*
|
|
* @since 1.0
|
|
* @return array $github_data the data
|
|
*/
|
|
public function get_github_data() {
|
|
if ( isset( $this->github_data ) && ! empty( $this->github_data ) ) {
|
|
$github_data = $this->github_data;
|
|
} else {
|
|
$github_data = get_site_transient( md5($this->config['slug']).'_github_data' );
|
|
|
|
if ( $this->overrule_transients() || ( ! isset( $github_data ) || ! $github_data || '' == $github_data ) ) {
|
|
$github_data = $this->remote_get( $this->config['api_url'] );
|
|
|
|
if ( is_wp_error( $github_data ) )
|
|
return false;
|
|
|
|
$github_data = json_decode( $github_data['body'] );
|
|
|
|
// refresh every 6 hours
|
|
set_site_transient( md5($this->config['slug']).'_github_data', $github_data, 60*60*6 );
|
|
}
|
|
|
|
// Store the data in this class instance for future calls
|
|
$this->github_data = $github_data;
|
|
}
|
|
|
|
return $github_data;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get update date
|
|
*
|
|
* @since 1.0
|
|
* @return string $date the date
|
|
*/
|
|
public function get_date() {
|
|
$_date = $this->get_github_data();
|
|
return ( !empty( $_date->updated_at ) ) ? date( 'Y-m-d', strtotime( $_date->updated_at ) ) : false;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get plugin description
|
|
*
|
|
* @since 1.0
|
|
* @return string $description the description
|
|
*/
|
|
public function get_description() {
|
|
$_description = $this->get_github_data();
|
|
return ( !empty( $_description->description ) ) ? $_description->description : false;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get Plugin data
|
|
*
|
|
* @since 1.0
|
|
* @return object $data the data
|
|
*/
|
|
public function get_plugin_data() {
|
|
if ( ! function_exists( 'get_plugin_data' ) ) {
|
|
require_once ABSPATH . 'wp-admin/includes/plugin.php';
|
|
}
|
|
$plugin_file = rtrim( WP_PLUGIN_DIR, '/' ) . '/' . $this->config['proper_folder_name'] . '/' . $this->config['slug'] ;
|
|
if ( ! is_file( $plugin_file ) ) {
|
|
return false;
|
|
}
|
|
$data = get_plugin_data( $plugin_file );
|
|
return $data;
|
|
}
|
|
|
|
|
|
/**
|
|
* Hook into the plugin update check and connect to GitHub
|
|
*
|
|
* @since 1.0
|
|
* @param object $transient the plugin data transient
|
|
* @return object $transient updated plugin data transient
|
|
*/
|
|
public function check_update( $transient ) {
|
|
|
|
// Check if the transient contains the 'checked' information
|
|
// If not, just return its value without hacking it
|
|
global $pagenow;
|
|
|
|
if ( ! is_object( $transient ) ) {
|
|
$transient = new \stdClass();
|
|
}
|
|
|
|
if ( 'plugins.php' === $pagenow && is_multisite() ) {
|
|
return $transient;
|
|
}
|
|
// check the version and decide if it's new
|
|
$update = version_compare( $this->config['new_version'], $this->config['version'] );
|
|
|
|
if ( 1 === $update ) {
|
|
if (! empty( $transient->checked ) ) {
|
|
$transient->last_checked = current_time( 'timestamp' );
|
|
$transient->checked[ $this->config['plugin_basename'] ] = $this->config['new_version'];
|
|
}
|
|
|
|
$response = new \stdClass();
|
|
$response->new_version = $this->config['new_version'];
|
|
$response->plugin = $this->config['plugin_basename'];
|
|
$response->slug = $this->config['proper_folder_name'];
|
|
$response->url = add_query_arg( array( 'access_token' => $this->config['access_token'] ), $this->config['github_url'] );
|
|
$response->package = $this->get_zip_url();
|
|
|
|
// If response is false, don't alter the transient
|
|
if ( false !== $response )
|
|
$transient->response[ $this->config['plugin_basename'] ] = $response;
|
|
}
|
|
|
|
return $transient;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get Plugin info
|
|
*
|
|
* @since 1.0
|
|
* @param bool $false always false
|
|
* @param string $action the API function being performed
|
|
* @param object $args plugin arguments
|
|
* @return object $response the plugin info
|
|
*/
|
|
public function get_plugin_info( $data, $action, $args ) {
|
|
|
|
// Check if this call API is for the right plugin
|
|
if ( !isset( $args->slug ) || $args->slug != $this->config['slug'] )
|
|
return $data;
|
|
|
|
$data->slug = $this->config['slug'];
|
|
$data->plugin_name = $this->config['plugin_name'];
|
|
$data->version = $this->config['new_version'];
|
|
$data->author = $this->config['author'];
|
|
$data->homepage = $this->config['homepage'];
|
|
$data->requires = $this->config['requires'];
|
|
$data->tested = $this->config['tested'];
|
|
$data->downloaded = 0;
|
|
$data->last_updated = $this->config['last_updated'];
|
|
$data->sections = array( 'description' => $this->config['description'] );
|
|
$data->download_link = $this->get_zip_url();
|
|
|
|
return $data;
|
|
}
|
|
|
|
|
|
/**
|
|
* Upgrader/Updater
|
|
* Move & activate the plugin, echo the update message
|
|
*
|
|
* @since 1.0
|
|
* @param boolean $true always true
|
|
* @param mixed $hook_extra not used
|
|
* @param array $result the result of the move
|
|
* @return array $result the result of the move
|
|
*/
|
|
public function upgrader_post_install( $true, $hook_extra, $result ) {
|
|
|
|
global $wp_filesystem;
|
|
|
|
// Move & Activate
|
|
$proper_destination = WP_PLUGIN_DIR.'/'.$this->config['proper_folder_name'];
|
|
$wp_filesystem->move( $result['destination'], $proper_destination );
|
|
$result['destination'] = $proper_destination;
|
|
$activate = activate_plugin( WP_PLUGIN_DIR.'/'.$this->config['slug'] );
|
|
|
|
// Output the update message
|
|
$fail = __( 'The plugin has been updated, but could not be reactivated. Please reactivate it manually.', 'elementor-pro' );
|
|
$success = __( 'Plugin reactivated successfully.', 'elementor-pro' );
|
|
echo is_wp_error( $activate ) ? $fail : $success;
|
|
return $result;
|
|
|
|
}
|
|
} |