diff --git a/Puc/v4/Autoloader.php b/Puc/v4/Autoloader.php
new file mode 100644
index 00000000..8376537b
--- /dev/null
+++ b/Puc/v4/Autoloader.php
@@ -0,0 +1,45 @@
+rootDir = dirname(__FILE__) . '/';
+ $nameParts = explode('_', __CLASS__, 3);
+ $this->prefix = $nameParts[0] . '_' . $nameParts[1] . '_';
+
+ $this->libraryDir = realpath($this->rootDir . '../..') . '/';
+ $this->staticMap = array(
+ 'PucReadmeParser' => 'vendor/readme-parser.php',
+ 'Parsedown' => 'vendor/ParsedownLegacy.php',
+ );
+ if ( version_compare(PHP_VERSION, '5.3.0', '>=') ) {
+ $this->staticMap['Parsedown'] = 'vendor/Parsedown.php';
+ }
+
+ spl_autoload_register(array($this, 'autoload'));
+ }
+
+ public function autoload($className) {
+ if ( isset($this->staticMap[$className]) && file_exists($this->libraryDir . $this->staticMap[$className]) ) {
+ /** @noinspection PhpIncludeInspection */
+ include ($this->libraryDir . $this->staticMap[$className]);
+ return;
+ }
+
+ if (strpos($className, $this->prefix) === 0) {
+ $path = substr($className, strlen($this->prefix));
+ $path = str_replace('_', '/', $path);
+ $path = $this->rootDir . $path . '.php';
+
+ if (file_exists($path)) {
+ /** @noinspection PhpIncludeInspection */
+ include $path;
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/Puc/v4/DebugBar/Extension.php b/Puc/v4/DebugBar/Extension.php
new file mode 100644
index 00000000..60a4c30c
--- /dev/null
+++ b/Puc/v4/DebugBar/Extension.php
@@ -0,0 +1,117 @@
+updateChecker = $updateChecker;
+ if ( isset($panelClass) ) {
+ $this->panelClass = $panelClass;
+ }
+
+ add_filter('debug_bar_panels', array($this, 'addDebugBarPanel'));
+ add_action('debug_bar_enqueue_scripts', array($this, 'enqueuePanelDependencies'));
+
+ add_action('wp_ajax_puc_v4_debug_check_now', array($this, 'ajaxCheckNow'));
+ }
+
+ /**
+ * Register the PUC Debug Bar panel.
+ *
+ * @param array $panels
+ * @return array
+ */
+ public function addDebugBarPanel($panels) {
+ if ( $this->updateChecker->userCanInstallUpdates() ) {
+ $panels[] = new $this->panelClass($this->updateChecker);
+ }
+ return $panels;
+ }
+
+ /**
+ * Enqueue our Debug Bar scripts and styles.
+ */
+ public function enqueuePanelDependencies() {
+ wp_enqueue_style(
+ 'puc-debug-bar-style-v4',
+ $this->getLibraryUrl("/css/puc-debug-bar.css"),
+ array('debug-bar'),
+ '20161217'
+ );
+
+ wp_enqueue_script(
+ 'puc-debug-bar-js-v4',
+ $this->getLibraryUrl("/js/debug-bar.js"),
+ array('jquery'),
+ '20161219'
+ );
+ }
+
+ /**
+ * Run an update check and output the result. Useful for making sure that
+ * the update checking process works as expected.
+ */
+ public function ajaxCheckNow() {
+ if ( $_POST['uid'] !== $this->updateChecker->getUniqueName('uid') ) {
+ return;
+ }
+ $this->preAjaxReqest();
+ $update = $this->updateChecker->checkForUpdates();
+ if ( $update !== null ) {
+ echo "An update is available:";
+ echo '', htmlentities(print_r($update, true)), '
';
+ } else {
+ echo 'No updates found.';
+ }
+ exit;
+ }
+
+ /**
+ * Check access permissions and enable error display (for debugging).
+ */
+ protected function preAjaxReqest() {
+ if ( !$this->updateChecker->userCanInstallUpdates() ) {
+ die('Access denied');
+ }
+ check_ajax_referer('puc-ajax');
+
+ error_reporting(E_ALL);
+ @ini_set('display_errors','On');
+ }
+
+ /**
+ * @param string $filePath
+ * @return string
+ */
+ private function getLibraryUrl($filePath) {
+ $absolutePath = realpath(dirname(__FILE__) . '/../../../' . ltrim($filePath, '/'));
+
+ //Where is the library located inside the WordPress directory structure?
+ $absolutePath = wp_normalize_path($absolutePath);
+
+ $pluginDir = wp_normalize_path(WP_PLUGIN_DIR);
+ $muPluginDir = wp_normalize_path(WPMU_PLUGIN_DIR);
+ $themeDir = wp_normalize_path(get_theme_root());
+
+ if ( (strpos($absolutePath, $pluginDir) === 0) || (strpos($absolutePath, $muPluginDir) === 0) ) {
+ //It's part of a plugin.
+ return plugins_url(basename($absolutePath), $absolutePath);
+ } else if ( strpos($absolutePath, $themeDir) === 0 ) {
+ //It's part of a theme.
+ $relativePath = substr($absolutePath, strlen($themeDir) + 1);
+ $template = substr($relativePath, 0, strpos($relativePath, '/'));
+ $baseUrl = get_theme_root_uri($template);
+
+ if ( !empty($baseUrl) && $relativePath ) {
+ return $baseUrl . '/' . $relativePath;
+ }
+ }
+
+ return '';
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/DebugBar/Panel.php b/Puc/v4/DebugBar/Panel.php
new file mode 100644
index 00000000..944f7b37
--- /dev/null
+++ b/Puc/v4/DebugBar/Panel.php
@@ -0,0 +1,165 @@
+';
+
+ public function __construct($updateChecker) {
+ $this->updateChecker = $updateChecker;
+ $title = sprintf(
+ '',
+ esc_attr($this->updateChecker->getUniqueName('uid')),
+ $this->updateChecker->slug
+ );
+ parent::__construct($title);
+ }
+
+ public function render() {
+ printf(
+ '',
+ esc_attr($this->updateChecker->getUniqueName('debug-bar-panel')),
+ esc_attr($this->updateChecker->slug),
+ esc_attr($this->updateChecker->getUniqueName('uid')),
+ esc_attr(wp_create_nonce('puc-ajax'))
+ );
+
+ $this->displayConfiguration();
+ $this->displayStatus();
+ $this->displayCurrentUpdate();
+
+ echo '
';
+ }
+
+ private function displayConfiguration() {
+ echo 'Configuration
';
+ echo '';
+ $this->displayConfigHeader();
+ $this->row('Slug', htmlentities($this->updateChecker->slug));
+ $this->row('DB option', htmlentities($this->updateChecker->optionName));
+
+ $requestInfoButton = $this->getMetadataButton();
+ $this->row('Metadata URL', htmlentities($this->updateChecker->metadataUrl) . ' ' . $requestInfoButton . $this->responseBox);
+
+ $scheduler = $this->updateChecker->scheduler;
+ if ( $scheduler->checkPeriod > 0 ) {
+ $this->row('Automatic checks', 'Every ' . $scheduler->checkPeriod . ' hours');
+ } else {
+ $this->row('Automatic checks', 'Disabled');
+ }
+
+ if ( isset($scheduler->throttleRedundantChecks) ) {
+ if ( $scheduler->throttleRedundantChecks && ($scheduler->checkPeriod > 0) ) {
+ $this->row(
+ 'Throttling',
+ sprintf(
+ 'Enabled. If an update is already available, check for updates every %1$d hours instead of every %2$d hours.',
+ $scheduler->throttledCheckPeriod,
+ $scheduler->checkPeriod
+ )
+ );
+ } else {
+ $this->row('Throttling', 'Disabled');
+ }
+ }
+
+ $this->updateChecker->onDisplayConfiguration($this);
+
+ echo '
';
+ }
+
+ protected function displayConfigHeader() {
+ //Do nothing. This should be implemented in subclasses.
+ }
+
+ protected function getMetadataButton() {
+ return '';
+ }
+
+ private function displayStatus() {
+ echo 'Status
';
+ echo '';
+ $state = $this->updateChecker->getUpdateState();
+ $checkNowButton = '';
+ if ( function_exists('get_submit_button') ) {
+ $checkNowButton = get_submit_button(
+ 'Check Now',
+ 'secondary',
+ 'puc-check-now-button',
+ false,
+ array('id' => $this->updateChecker->getUniqueName('check-now-button'))
+ );
+ }
+
+ if ( $state->getLastCheck() > 0 ) {
+ $this->row('Last check', $this->formatTimeWithDelta($state->getLastCheck()) . ' ' . $checkNowButton . $this->responseBox);
+ } else {
+ $this->row('Last check', 'Never');
+ }
+
+ $nextCheck = wp_next_scheduled($this->updateChecker->scheduler->getCronHookName());
+ $this->row('Next automatic check', $this->formatTimeWithDelta($nextCheck));
+
+ if ( $state->getCheckedVersion() !== '' ) {
+ $this->row('Checked version', htmlentities($state->getCheckedVersion()));
+ $this->row('Cached update', $state->getUpdate());
+ }
+ $this->row('Update checker class', htmlentities(get_class($this->updateChecker)));
+ echo '
';
+ }
+
+ private function displayCurrentUpdate() {
+ $update = $this->updateChecker->getUpdate();
+ if ( $update !== null ) {
+ echo 'An Update Is Available
';
+ echo '';
+ $fields = $this->getUpdateFields();
+ foreach($fields as $field) {
+ if ( property_exists($update, $field) ) {
+ $this->row(ucwords(str_replace('_', ' ', $field)), htmlentities($update->$field));
+ }
+ }
+ echo '
';
+ } else {
+ echo 'No updates currently available
';
+ }
+ }
+
+ protected function getUpdateFields() {
+ return array('version', 'download_url', 'slug',);
+ }
+
+ private function formatTimeWithDelta($unixTime) {
+ if ( empty($unixTime) ) {
+ return 'Never';
+ }
+
+ $delta = time() - $unixTime;
+ $result = human_time_diff(time(), $unixTime);
+ if ( $delta < 0 ) {
+ $result = 'after ' . $result;
+ } else {
+ $result = $result . ' ago';
+ }
+ $result .= ' (' . $this->formatTimestamp($unixTime) . ')';
+ return $result;
+ }
+
+ private function formatTimestamp($unixTime) {
+ return gmdate('Y-m-d H:i:s', $unixTime + (get_option('gmt_offset') * 3600));
+ }
+
+ public function row($name, $value) {
+ if ( is_object($value) || is_array($value) ) {
+ $value = '' . htmlentities(print_r($value, true)) . '
';
+ } else if ($value === null) {
+ $value = 'null';
+ }
+ printf('| %1$s | %2$s |
|---|
', $name, $value);
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/DebugBar/PluginExtension.php b/Puc/v4/DebugBar/PluginExtension.php
new file mode 100644
index 00000000..c33eef7c
--- /dev/null
+++ b/Puc/v4/DebugBar/PluginExtension.php
@@ -0,0 +1,33 @@
+updateChecker->getUniqueName('uid') ) {
+ return;
+ }
+ $this->preAjaxReqest();
+ $info = $this->updateChecker->requestInfo();
+ if ( $info !== null ) {
+ echo 'Successfully retrieved plugin info from the metadata URL:';
+ echo '', htmlentities(print_r($info, true)), '
';
+ } else {
+ echo 'Failed to retrieve plugin info from the metadata URL.';
+ }
+ exit;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/DebugBar/PluginPanel.php b/Puc/v4/DebugBar/PluginPanel.php
new file mode 100644
index 00000000..5017dba0
--- /dev/null
+++ b/Puc/v4/DebugBar/PluginPanel.php
@@ -0,0 +1,38 @@
+row('Plugin file', htmlentities($this->updateChecker->pluginFile));
+ parent::displayConfigHeader();
+ }
+
+ protected function getMetadataButton() {
+ $requestInfoButton = '';
+ if ( function_exists('get_submit_button') ) {
+ $requestInfoButton = get_submit_button(
+ 'Request Info',
+ 'secondary',
+ 'puc-request-info-button',
+ false,
+ array('id' => $this->updateChecker->getUniqueName('request-info-button'))
+ );
+ }
+ return $requestInfoButton;
+ }
+
+ protected function getUpdateFields() {
+ return array_merge(
+ parent::getUpdateFields(),
+ array('homepage', 'upgrade_notice', 'tested',)
+ );
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/DebugBar/ThemePanel.php b/Puc/v4/DebugBar/ThemePanel.php
new file mode 100644
index 00000000..eefec569
--- /dev/null
+++ b/Puc/v4/DebugBar/ThemePanel.php
@@ -0,0 +1,21 @@
+row('Theme directory', htmlentities($this->updateChecker->directoryName));
+ parent::displayConfigHeader();
+ }
+
+ protected function getUpdateFields() {
+ return array_merge(parent::getUpdateFields(), array('details_url'));
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Factory.php b/Puc/v4/Factory.php
new file mode 100644
index 00000000..86e2526d
--- /dev/null
+++ b/Puc/v4/Factory.php
@@ -0,0 +1,232 @@
+ "foo".
+ $themeRoot = wp_normalize_path(get_theme_root());
+ $pathComponents = explode('/', substr($fullPath, strlen($themeRoot) + 1));
+ $id = $pathComponents[0];
+ }
+
+ //Which hosting service does the URL point to?
+ $service = self::getVcsService($metadataUrl);
+
+ $apiClass = null;
+ if ( empty($service) ) {
+ //The default is to get update information from a remote JSON file.
+ $checkerClass = $type . '_UpdateChecker';
+ } else {
+ //You can also use a VCS repository like GitHub.
+ $checkerClass = 'Vcs_' . $type . 'UpdateChecker';
+ $apiClass = $service . 'Api';
+ }
+
+ $checkerClass = self::getCompatibleClassVersion($checkerClass);
+ if ( $checkerClass === null ) {
+ trigger_error(
+ sprintf(
+ 'PUC %s does not support updates for %ss %s',
+ htmlentities(self::$latestCompatibleVersion),
+ strtolower($type),
+ $service ? ('hosted on ' . htmlentities($service)) : 'using JSON metadata'
+ ),
+ E_USER_ERROR
+ );
+ return null;
+ }
+
+ if ( !isset($apiClass) ) {
+ //Plain old update checker.
+ return new $checkerClass($metadataUrl, $id, $slug, $checkPeriod, $optionName, $muPluginFile);
+ } else {
+ //VCS checker + an API client.
+ $apiClass = self::getCompatibleClassVersion($apiClass);
+ if ( $apiClass === null ) {
+ trigger_error(sprintf(
+ 'PUC %s does not support %s',
+ htmlentities(self::$latestCompatibleVersion),
+ htmlentities($service)
+ ), E_USER_ERROR);
+ return null;
+ }
+
+ return new $checkerClass(
+ new $apiClass($metadataUrl),
+ $id,
+ $slug,
+ $checkPeriod,
+ $optionName,
+ $muPluginFile
+ );
+ }
+ }
+
+ /**
+ * Check if the path points to something inside the "plugins" or "mu-plugins" directories.
+ *
+ * @param string $absolutePath
+ * @return bool
+ */
+ protected static function isPluginFile($absolutePath) {
+ $pluginDir = wp_normalize_path(WP_PLUGIN_DIR);
+ $muPluginDir = wp_normalize_path(WPMU_PLUGIN_DIR);
+ $absolutePath = wp_normalize_path($absolutePath);
+
+ return (strpos($absolutePath, $pluginDir) === 0) || (strpos($absolutePath, $muPluginDir) === 0);
+ }
+
+ /**
+ * Get the name of the hosting service that the URL points to.
+ *
+ * @param string $metadataUrl
+ * @return string|null
+ */
+ private static function getVcsService($metadataUrl) {
+ $service = null;
+
+ //Which hosting service does the URL point to?
+ $host = @parse_url($metadataUrl, PHP_URL_HOST);
+ $path = @parse_url($metadataUrl, PHP_URL_PATH);
+ //Check if the path looks like "/user-name/repository".
+ $usernameRepoRegex = '@^/?([^/]+?)/([^/#?&]+?)/?$@';
+ if ( preg_match($usernameRepoRegex, $path) ) {
+ $knownServices = array(
+ 'github.com' => 'GitHub',
+ 'bitbucket.org' => 'BitBucket',
+ 'gitlab.com' => 'GitLab',
+ );
+ if ( isset($knownServices[$host]) ) {
+ $service = $knownServices[$host];
+ }
+ }
+
+ return $service;
+ }
+
+ /**
+ * Get the latest version of the specified class that has the same major version number
+ * as this factory class.
+ *
+ * @param string $class Partial class name.
+ * @return string|null Full class name.
+ */
+ protected static function getCompatibleClassVersion($class) {
+ if ( isset(self::$classVersions[$class][self::$latestCompatibleVersion]) ) {
+ return self::$classVersions[$class][self::$latestCompatibleVersion];
+ }
+ return null;
+ }
+
+ /**
+ * Get the specific class name for the latest available version of a class.
+ *
+ * @param string $class
+ * @return null|string
+ */
+ public static function getLatestClassVersion($class) {
+ if ( !self::$sorted ) {
+ self::sortVersions();
+ }
+
+ if ( isset(self::$classVersions[$class]) ) {
+ return reset(self::$classVersions[$class]);
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Sort available class versions in descending order (i.e. newest first).
+ */
+ protected static function sortVersions() {
+ foreach ( self::$classVersions as $class => $versions ) {
+ uksort($versions, array(__CLASS__, 'compareVersions'));
+ self::$classVersions[$class] = $versions;
+ }
+ self::$sorted = true;
+ }
+
+ protected static function compareVersions($a, $b) {
+ return -version_compare($a, $b);
+ }
+
+ /**
+ * Register a version of a class.
+ *
+ * @access private This method is only for internal use by the library.
+ *
+ * @param string $generalClass Class name without version numbers, e.g. 'PluginUpdateChecker'.
+ * @param string $versionedClass Actual class name, e.g. 'PluginUpdateChecker_1_2'.
+ * @param string $version Version number, e.g. '1.2'.
+ */
+ public static function addVersion($generalClass, $versionedClass, $version) {
+ if ( empty(self::$myMajorVersion) ) {
+ $nameParts = explode('_', __CLASS__, 3);
+ self::$myMajorVersion = substr(ltrim($nameParts[1], 'v'), 0, 1);
+ }
+
+ //Store the greatest version number that matches our major version.
+ $components = explode('.', $version);
+ if ( $components[0] === self::$myMajorVersion ) {
+
+ if (
+ empty(self::$latestCompatibleVersion)
+ || version_compare($version, self::$latestCompatibleVersion, '>')
+ ) {
+ self::$latestCompatibleVersion = $version;
+ }
+
+ }
+
+ if ( !isset(self::$classVersions[$generalClass]) ) {
+ self::$classVersions[$generalClass] = array();
+ }
+ self::$classVersions[$generalClass][$version] = $versionedClass;
+ self::$sorted = false;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Metadata.php b/Puc/v4/Metadata.php
new file mode 100644
index 00000000..7bb5082b
--- /dev/null
+++ b/Puc/v4/Metadata.php
@@ -0,0 +1,132 @@
+validateMetadata($apiResponse);
+ if ( is_wp_error($valid) ){
+ trigger_error($valid->get_error_message(), E_USER_NOTICE);
+ return false;
+ }
+
+ foreach(get_object_vars($apiResponse) as $key => $value){
+ $target->$key = $value;
+ }
+
+ return true;
+ }
+
+ /**
+ * No validation by default! Subclasses should check that the required fields are present.
+ *
+ * @param StdClass $apiResponse
+ * @return bool|WP_Error
+ */
+ protected function validateMetadata(/** @noinspection PhpUnusedParameterInspection */ $apiResponse) {
+ return true;
+ }
+
+ /**
+ * Create a new instance by copying the necessary fields from another object.
+ *
+ * @abstract
+ * @param StdClass|self $object The source object.
+ * @return self The new copy.
+ */
+ public static function fromObject(/** @noinspection PhpUnusedParameterInspection */ $object) {
+ throw new LogicException('The ' . __METHOD__ . ' method must be implemented by subclasses');
+ }
+
+ /**
+ * Create an instance of StdClass that can later be converted back to an
+ * update or info container. Useful for serialization and caching, as it
+ * avoids the "incomplete object" problem if the cached value is loaded
+ * before this class.
+ *
+ * @return StdClass
+ */
+ public function toStdClass() {
+ $object = new stdClass();
+ $this->copyFields($this, $object);
+ return $object;
+ }
+
+ /**
+ * Transform the metadata into the format used by WordPress core.
+ *
+ * @return object
+ */
+ abstract public function toWpFormat();
+
+ /**
+ * Copy known fields from one object to another.
+ *
+ * @param StdClass|self $from
+ * @param StdClass|self $to
+ */
+ protected function copyFields($from, $to) {
+ $fields = $this->getFieldNames();
+
+ if ( property_exists($from, 'slug') && !empty($from->slug) ) {
+ //Let plugins add extra fields without having to create subclasses.
+ $fields = apply_filters($this->getPrefixedFilter('retain_fields') . '-' . $from->slug, $fields);
+ }
+
+ foreach ($fields as $field) {
+ if ( property_exists($from, $field) ) {
+ $to->$field = $from->$field;
+ }
+ }
+ }
+
+ /**
+ * @return string[]
+ */
+ protected function getFieldNames() {
+ return array();
+ }
+
+ /**
+ * @param string $tag
+ * @return string
+ */
+ protected function getPrefixedFilter($tag) {
+ return 'puc_' . $tag;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/OAuthSignature.php b/Puc/v4/OAuthSignature.php
new file mode 100644
index 00000000..f9242c4a
--- /dev/null
+++ b/Puc/v4/OAuthSignature.php
@@ -0,0 +1,87 @@
+consumerKey = $consumerKey;
+ $this->consumerSecret = $consumerSecret;
+ }
+
+ /**
+ * Sign a URL using OAuth 1.0.
+ *
+ * @param string $url The URL to be signed. It may contain query parameters.
+ * @param string $method HTTP method such as "GET", "POST" and so on.
+ * @return string The signed URL.
+ */
+ public function sign($url, $method = 'GET') {
+ $parameters = array();
+
+ //Parse query parameters.
+ $query = @parse_url($url, PHP_URL_QUERY);
+ if ( !empty($query) ) {
+ parse_str($query, $parsedParams);
+ if ( is_array($parameters) ) {
+ $parameters = $parsedParams;
+ }
+ //Remove the query string from the URL. We'll replace it later.
+ $url = substr($url, 0, strpos($url, '?'));
+ }
+
+ $parameters = array_merge(
+ $parameters,
+ array(
+ 'oauth_consumer_key' => $this->consumerKey,
+ 'oauth_nonce' => $this->nonce(),
+ 'oauth_signature_method' => 'HMAC-SHA1',
+ 'oauth_timestamp' => time(),
+ 'oauth_version' => '1.0',
+ )
+ );
+
+ //Parameters must be sorted alphabetically before signing.
+ ksort($parameters);
+
+ //The most complicated part of the request - generating the signature.
+ //The string to sign contains the HTTP method, the URL path, and all of
+ //our query parameters. Everything is URL encoded. Then we concatenate
+ //them with ampersands into a single string to hash.
+ $encodedVerb = urlencode($method);
+ $encodedUrl = urlencode($url);
+ $encodedParams = urlencode(http_build_query($parameters, '', '&'));
+
+ $stringToSign = $encodedVerb . '&' . $encodedUrl . '&' . $encodedParams;
+
+ //Since we only have one OAuth token (the consumer secret) we only have
+ //to use it as our HMAC key. However, we still have to append an & to it
+ //as if we were using it with additional tokens.
+ $secret = urlencode($this->consumerSecret) . '&';
+
+ //The signature is a hash of the consumer key and the base string. Note
+ //that we have to get the raw output from hash_hmac and base64 encode
+ //the binary data result.
+ $parameters['oauth_signature'] = base64_encode(hash_hmac('sha1', $stringToSign, $secret, true));
+
+ return ($url . '?' . http_build_query($parameters));
+ }
+
+ /**
+ * Generate a random nonce.
+ *
+ * @return string
+ */
+ private function nonce() {
+ $mt = microtime();
+ $rand = mt_rand();
+ return md5($mt . '_' . $rand);
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Plugin/Info.php b/Puc/v4/Plugin/Info.php
new file mode 100644
index 00000000..3fe44322
--- /dev/null
+++ b/Puc/v4/Plugin/Info.php
@@ -0,0 +1,127 @@
+sections = (array)$instance->sections;
+
+ return $instance;
+ }
+
+ /**
+ * Very, very basic validation.
+ *
+ * @param StdClass $apiResponse
+ * @return bool|WP_Error
+ */
+ protected function validateMetadata($apiResponse) {
+ if (
+ !isset($apiResponse->name, $apiResponse->version)
+ || empty($apiResponse->name)
+ || empty($apiResponse->version)
+ ) {
+ return new WP_Error(
+ 'puc-invalid-metadata',
+ "The plugin metadata file does not contain the required 'name' and/or 'version' keys."
+ );
+ }
+ return true;
+ }
+
+
+ /**
+ * Transform plugin info into the format used by the native WordPress.org API
+ *
+ * @return object
+ */
+ public function toWpFormat(){
+ $info = new stdClass;
+
+ //The custom update API is built so that many fields have the same name and format
+ //as those returned by the native WordPress.org API. These can be assigned directly.
+ $sameFormat = array(
+ 'name', 'slug', 'version', 'requires', 'tested', 'rating', 'upgrade_notice',
+ 'num_ratings', 'downloaded', 'active_installs', 'homepage', 'last_updated',
+ );
+ foreach($sameFormat as $field){
+ if ( isset($this->$field) ) {
+ $info->$field = $this->$field;
+ } else {
+ $info->$field = null;
+ }
+ }
+
+ //Other fields need to be renamed and/or transformed.
+ $info->download_link = $this->download_url;
+ $info->author = $this->getFormattedAuthor();
+ $info->sections = array_merge(array('description' => ''), $this->sections);
+
+ if ( !empty($this->banners) ) {
+ //WP expects an array with two keys: "high" and "low". Both are optional.
+ //Docs: https://wordpress.org/plugins/about/faq/#banners
+ $info->banners = is_object($this->banners) ? get_object_vars($this->banners) : $this->banners;
+ $info->banners = array_intersect_key($info->banners, array('high' => true, 'low' => true));
+ }
+
+ return $info;
+ }
+
+ protected function getFormattedAuthor() {
+ if ( !empty($this->author_homepage) ){
+ /** @noinspection HtmlUnknownTarget */
+ return sprintf('%s', $this->author_homepage, $this->author);
+ }
+ return $this->author;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Plugin/Update.php b/Puc/v4/Plugin/Update.php
new file mode 100644
index 00000000..89b37e01
--- /dev/null
+++ b/Puc/v4/Plugin/Update.php
@@ -0,0 +1,92 @@
+copyFields($object, $update);
+ return $update;
+ }
+
+ /**
+ * @return string[]
+ */
+ protected function getFieldNames() {
+ return array_merge(parent::getFieldNames(), self::$extraFields);
+ }
+
+ /**
+ * Transform the update into the format used by WordPress native plugin API.
+ *
+ * @return object
+ */
+ public function toWpFormat(){
+ $update = parent::toWpFormat();
+
+ $update->id = $this->id;
+ $update->url = $this->homepage;
+ $update->tested = $this->tested;
+ $update->plugin = $this->filename;
+
+ if ( !empty($this->upgrade_notice) ){
+ $update->upgrade_notice = $this->upgrade_notice;
+ }
+
+ return $update;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Plugin/UpdateChecker.php b/Puc/v4/Plugin/UpdateChecker.php
new file mode 100644
index 00000000..ca0604df
--- /dev/null
+++ b/Puc/v4/Plugin/UpdateChecker.php
@@ -0,0 +1,531 @@
+pluginAbsolutePath = $pluginFile;
+ $this->pluginFile = plugin_basename($this->pluginAbsolutePath);
+ $this->muPluginFile = $muPluginFile;
+
+ //If no slug is specified, use the name of the main plugin file as the slug.
+ //For example, 'my-cool-plugin/cool-plugin.php' becomes 'cool-plugin'.
+ if ( empty($slug) ){
+ $slug = basename($this->pluginFile, '.php');
+ }
+
+ //Plugin slugs must be unique.
+ $slugCheckFilter = 'puc_is_slug_in_use-' . $this->slug;
+ $slugUsedBy = apply_filters($slugCheckFilter, false);
+ if ( $slugUsedBy ) {
+ $this->triggerError(sprintf(
+ 'Plugin slug "%s" is already in use by %s. Slugs must be unique.',
+ htmlentities($this->slug),
+ htmlentities($slugUsedBy)
+ ), E_USER_ERROR);
+ }
+ add_filter($slugCheckFilter, array($this, 'getAbsolutePath'));
+
+ //Backwards compatibility: If the plugin is a mu-plugin but no $muPluginFile is specified, assume
+ //it's the same as $pluginFile given that it's not in a subdirectory (WP only looks in the base dir).
+ if ( (strpbrk($this->pluginFile, '/\\') === false) && $this->isUnknownMuPlugin() ) {
+ $this->muPluginFile = $this->pluginFile;
+ }
+
+ parent::__construct($metadataUrl, dirname($this->pluginFile), $slug, $checkPeriod, $optionName);
+ }
+
+ /**
+ * Create an instance of the scheduler.
+ *
+ * @param int $checkPeriod
+ * @return Puc_v4_Scheduler
+ */
+ protected function createScheduler($checkPeriod) {
+ $scheduler = new Puc_v4_Scheduler($this, $checkPeriod, array('load-plugins.php'));
+ register_deactivation_hook($this->pluginFile, array($scheduler, 'removeUpdaterCron'));
+ return $scheduler;
+ }
+
+ /**
+ * Install the hooks required to run periodic update checks and inject update info
+ * into WP data structures.
+ *
+ * @return void
+ */
+ protected function installHooks(){
+ //Override requests for plugin information
+ add_filter('plugins_api', array($this, 'injectInfo'), 20, 3);
+
+ add_filter('plugin_row_meta', array($this, 'addCheckForUpdatesLink'), 10, 2);
+ add_action('admin_init', array($this, 'handleManualCheck'));
+ add_action('all_admin_notices', array($this, 'displayManualCheckResult'));
+
+ //Clear the version number cache when something - anything - is upgraded or WP clears the update cache.
+ add_filter('upgrader_post_install', array($this, 'clearCachedVersion'));
+ add_action('delete_site_transient_update_plugins', array($this, 'clearCachedVersion'));
+
+ parent::installHooks();
+ }
+
+ /**
+ * Retrieve plugin info from the configured API endpoint.
+ *
+ * @uses wp_remote_get()
+ *
+ * @param array $queryArgs Additional query arguments to append to the request. Optional.
+ * @return Puc_v4_Plugin_Info
+ */
+ public function requestInfo($queryArgs = array()) {
+ list($pluginInfo, $result) = $this->requestMetadata('Puc_v4_Plugin_Info', 'request_info', $queryArgs);
+
+ if ( $pluginInfo !== null ) {
+ /** @var Puc_v4_Plugin_Info $pluginInfo */
+ $pluginInfo->filename = $this->pluginFile;
+ $pluginInfo->slug = $this->slug;
+ }
+
+ $pluginInfo = apply_filters($this->getUniqueName('request_info_result'), $pluginInfo, $result);
+ return $pluginInfo;
+ }
+
+ /**
+ * Retrieve the latest update (if any) from the configured API endpoint.
+ *
+ * @uses PluginUpdateChecker::requestInfo()
+ *
+ * @return Puc_v4_Update|null An instance of Plugin_Update, or NULL when no updates are available.
+ */
+ public function requestUpdate() {
+ //For the sake of simplicity, this function just calls requestInfo()
+ //and transforms the result accordingly.
+ $pluginInfo = $this->requestInfo(array('checking_for_updates' => '1'));
+ if ( $pluginInfo == null ){
+ return null;
+ }
+ $update = Puc_v4_Plugin_Update::fromPluginInfo($pluginInfo);
+
+ $update = $this->filterUpdateResult($update);
+
+ return $update;
+ }
+
+ /**
+ * Get the currently installed version of the plugin.
+ *
+ * @return string Version number.
+ */
+ public function getInstalledVersion(){
+ if ( isset($this->cachedInstalledVersion) ) {
+ return $this->cachedInstalledVersion;
+ }
+
+ $pluginHeader = $this->getPluginHeader();
+ if ( isset($pluginHeader['Version']) ) {
+ $this->cachedInstalledVersion = $pluginHeader['Version'];
+ return $pluginHeader['Version'];
+ } else {
+ //This can happen if the filename points to something that is not a plugin.
+ $this->triggerError(
+ sprintf(
+ "Can't to read the Version header for '%s'. The filename is incorrect or is not a plugin.",
+ $this->pluginFile
+ ),
+ E_USER_WARNING
+ );
+ return null;
+ }
+ }
+
+ /**
+ * Get plugin's metadata from its file header.
+ *
+ * @return array
+ */
+ protected function getPluginHeader() {
+ if ( !is_file($this->pluginAbsolutePath) ) {
+ //This can happen if the plugin filename is wrong.
+ $this->triggerError(
+ sprintf(
+ "Can't to read the plugin header for '%s'. The file does not exist.",
+ $this->pluginFile
+ ),
+ E_USER_WARNING
+ );
+ return array();
+ }
+
+ if ( !function_exists('get_plugin_data') ){
+ /** @noinspection PhpIncludeInspection */
+ require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
+ }
+ return get_plugin_data($this->pluginAbsolutePath, false, false);
+ }
+
+ /**
+ * @return array
+ */
+ protected function getHeaderNames() {
+ return array(
+ 'Name' => 'Plugin Name',
+ 'PluginURI' => 'Plugin URI',
+ 'Version' => 'Version',
+ 'Description' => 'Description',
+ 'Author' => 'Author',
+ 'AuthorURI' => 'Author URI',
+ 'TextDomain' => 'Text Domain',
+ 'DomainPath' => 'Domain Path',
+ 'Network' => 'Network',
+
+ //The newest WordPress version that this plugin requires or has been tested with.
+ //We support several different formats for compatibility with other libraries.
+ 'Tested WP' => 'Tested WP',
+ 'Requires WP' => 'Requires WP',
+ 'Tested up to' => 'Tested up to',
+ 'Requires at least' => 'Requires at least',
+ );
+ }
+
+
+ /**
+ * Intercept plugins_api() calls that request information about our plugin and
+ * use the configured API endpoint to satisfy them.
+ *
+ * @see plugins_api()
+ *
+ * @param mixed $result
+ * @param string $action
+ * @param array|object $args
+ * @return mixed
+ */
+ public function injectInfo($result, $action = null, $args = null){
+ $relevant = ($action == 'plugin_information') && isset($args->slug) && (
+ ($args->slug == $this->slug) || ($args->slug == dirname($this->pluginFile))
+ );
+ if ( !$relevant ) {
+ return $result;
+ }
+
+ $pluginInfo = $this->requestInfo();
+ $pluginInfo = apply_filters($this->getUniqueName('pre_inject_info'), $pluginInfo);
+ if ( $pluginInfo ) {
+ return $pluginInfo->toWpFormat();
+ }
+
+ return $result;
+ }
+
+ protected function shouldShowUpdates() {
+ //No update notifications for mu-plugins unless explicitly enabled. The MU plugin file
+ //is usually different from the main plugin file so the update wouldn't show up properly anyway.
+ return !$this->isUnknownMuPlugin();
+ }
+
+ /**
+ * @param stdClass|null $updates
+ * @param stdClass $updateToAdd
+ * @return stdClass
+ */
+ protected function addUpdateToList($updates, $updateToAdd) {
+ if ( $this->isMuPlugin() ) {
+ //WP does not support automatic update installation for mu-plugins, but we can
+ //still display a notice.
+ $updateToAdd->package = null;
+ }
+ return parent::addUpdateToList($updates, $updateToAdd);
+ }
+
+ /**
+ * @param stdClass|null $updates
+ * @return stdClass|null
+ */
+ protected function removeUpdateFromList($updates) {
+ $updates = parent::removeUpdateFromList($updates);
+ if ( !empty($this->muPluginFile) && isset($updates, $updates->response) ) {
+ unset($updates->response[$this->muPluginFile]);
+ }
+ return $updates;
+ }
+
+ /**
+ * For plugins, the update array is indexed by the plugin filename relative to the "plugins"
+ * directory. Example: "plugin-name/plugin.php".
+ *
+ * @return string
+ */
+ protected function getUpdateListKey() {
+ if ( $this->isMuPlugin() ) {
+ return $this->muPluginFile;
+ }
+ return $this->pluginFile;
+ }
+
+ /**
+ * Alias for isBeingUpgraded().
+ *
+ * @deprecated
+ * @param WP_Upgrader|null $upgrader The upgrader that's performing the current update.
+ * @return bool
+ */
+ public function isPluginBeingUpgraded($upgrader = null) {
+ return $this->isBeingUpgraded($upgrader);
+ }
+
+ /**
+ * Is there an update being installed for this plugin, right now?
+ *
+ * @param WP_Upgrader|null $upgrader
+ * @return bool
+ */
+ public function isBeingUpgraded($upgrader = null) {
+ return $this->upgraderStatus->isPluginBeingUpgraded($this->pluginFile, $upgrader);
+ }
+
+ /**
+ * Get the details of the currently available update, if any.
+ *
+ * If no updates are available, or if the last known update version is below or equal
+ * to the currently installed version, this method will return NULL.
+ *
+ * Uses cached update data. To retrieve update information straight from
+ * the metadata URL, call requestUpdate() instead.
+ *
+ * @return Puc_v4_Plugin_Update|null
+ */
+ public function getUpdate() {
+ $update = parent::getUpdate();
+ if ( isset($update) ) {
+ /** @var Puc_v4_Plugin_Update $update */
+ $update->filename = $this->pluginFile;
+ }
+ return $update;
+ }
+
+ /**
+ * Add a "Check for updates" link to the plugin row in the "Plugins" page. By default,
+ * the new link will appear after the "Visit plugin site" link.
+ *
+ * You can change the link text by using the "puc_manual_check_link-$slug" filter.
+ * Returning an empty string from the filter will disable the link.
+ *
+ * @param array $pluginMeta Array of meta links.
+ * @param string $pluginFile
+ * @return array
+ */
+ public function addCheckForUpdatesLink($pluginMeta, $pluginFile) {
+ $isRelevant = ($pluginFile == $this->pluginFile)
+ || (!empty($this->muPluginFile) && $pluginFile == $this->muPluginFile);
+
+ if ( $isRelevant && $this->userCanInstallUpdates() ) {
+ $linkUrl = wp_nonce_url(
+ add_query_arg(
+ array(
+ 'puc_check_for_updates' => 1,
+ 'puc_slug' => $this->slug,
+ ),
+ self_admin_url('plugins.php')
+ ),
+ 'puc_check_for_updates'
+ );
+
+ $linkText = apply_filters(
+ $this->getUniqueName('manual_check_link'),
+ __('Check for updates', 'plugin-update-checker')
+ );
+ if ( !empty($linkText) ) {
+ /** @noinspection HtmlUnknownTarget */
+ $pluginMeta[] = sprintf('%s', esc_attr($linkUrl), $linkText);
+ }
+ }
+ return $pluginMeta;
+ }
+
+ /**
+ * Check for updates when the user clicks the "Check for updates" link.
+ * @see self::addCheckForUpdatesLink()
+ *
+ * @return void
+ */
+ public function handleManualCheck() {
+ $shouldCheck =
+ isset($_GET['puc_check_for_updates'], $_GET['puc_slug'])
+ && $_GET['puc_slug'] == $this->slug
+ && $this->userCanInstallUpdates()
+ && check_admin_referer('puc_check_for_updates');
+
+ if ( $shouldCheck ) {
+ $update = $this->checkForUpdates();
+ $status = ($update === null) ? 'no_update' : 'update_available';
+ wp_redirect(add_query_arg(
+ array(
+ 'puc_update_check_result' => $status,
+ 'puc_slug' => $this->slug,
+ ),
+ self_admin_url('plugins.php')
+ ));
+ }
+ }
+
+ /**
+ * Display the results of a manual update check.
+ * @see self::handleManualCheck()
+ *
+ * You can change the result message by using the "puc_manual_check_message-$slug" filter.
+ */
+ public function displayManualCheckResult() {
+ if ( isset($_GET['puc_update_check_result'], $_GET['puc_slug']) && ($_GET['puc_slug'] == $this->slug) ) {
+ $status = strval($_GET['puc_update_check_result']);
+ if ( $status == 'no_update' ) {
+ $message = __('This plugin is up to date.', 'plugin-update-checker');
+ } else if ( $status == 'update_available' ) {
+ $message = __('A new version of this plugin is available.', 'plugin-update-checker');
+ } else {
+ $message = sprintf(__('Unknown update checker status "%s"', 'plugin-update-checker'), htmlentities($status));
+ }
+ printf(
+ '',
+ apply_filters($this->getUniqueName('manual_check_message'), $message, $status)
+ );
+ }
+ }
+
+ /**
+ * Check if the current user has the required permissions to install updates.
+ *
+ * @return bool
+ */
+ public function userCanInstallUpdates() {
+ return current_user_can('update_plugins');
+ }
+
+ /**
+ * Check if the plugin file is inside the mu-plugins directory.
+ *
+ * @return bool
+ */
+ protected function isMuPlugin() {
+ static $cachedResult = null;
+
+ if ( $cachedResult === null ) {
+ //Convert both paths to the canonical form before comparison.
+ $muPluginDir = realpath(WPMU_PLUGIN_DIR);
+ $pluginPath = realpath($this->pluginAbsolutePath);
+
+ $cachedResult = (strpos($pluginPath, $muPluginDir) === 0);
+ }
+
+ return $cachedResult;
+ }
+
+ /**
+ * MU plugins are partially supported, but only when we know which file in mu-plugins
+ * corresponds to this plugin.
+ *
+ * @return bool
+ */
+ protected function isUnknownMuPlugin() {
+ return empty($this->muPluginFile) && $this->isMuPlugin();
+ }
+
+ /**
+ * Clear the cached plugin version. This method can be set up as a filter (hook) and will
+ * return the filter argument unmodified.
+ *
+ * @param mixed $filterArgument
+ * @return mixed
+ */
+ public function clearCachedVersion($filterArgument = null) {
+ $this->cachedInstalledVersion = null;
+ return $filterArgument;
+ }
+
+ /**
+ * Get absolute path to the main plugin file.
+ *
+ * @return string
+ */
+ public function getAbsolutePath() {
+ return $this->pluginAbsolutePath;
+ }
+
+ /**
+ * Register a callback for filtering query arguments.
+ *
+ * The callback function should take one argument - an associative array of query arguments.
+ * It should return a modified array of query arguments.
+ *
+ * @uses add_filter() This method is a convenience wrapper for add_filter().
+ *
+ * @param callable $callback
+ * @return void
+ */
+ public function addQueryArgFilter($callback){
+ $this->addFilter('request_info_query_args', $callback);
+ }
+
+ /**
+ * Register a callback for filtering arguments passed to wp_remote_get().
+ *
+ * The callback function should take one argument - an associative array of arguments -
+ * and return a modified array or arguments. See the WP documentation on wp_remote_get()
+ * for details on what arguments are available and how they work.
+ *
+ * @uses add_filter() This method is a convenience wrapper for add_filter().
+ *
+ * @param callable $callback
+ * @return void
+ */
+ public function addHttpRequestArgFilter($callback) {
+ $this->addFilter('request_info_options', $callback);
+ }
+
+ /**
+ * Register a callback for filtering the plugin info retrieved from the external API.
+ *
+ * The callback function should take two arguments. If the plugin info was retrieved
+ * successfully, the first argument passed will be an instance of PluginInfo. Otherwise,
+ * it will be NULL. The second argument will be the corresponding return value of
+ * wp_remote_get (see WP docs for details).
+ *
+ * The callback function should return a new or modified instance of PluginInfo or NULL.
+ *
+ * @uses add_filter() This method is a convenience wrapper for add_filter().
+ *
+ * @param callable $callback
+ * @return void
+ */
+ public function addResultFilter($callback) {
+ $this->addFilter('request_info_result', $callback, 10, 2);
+ }
+
+ protected function createDebugBarExtension() {
+ return new Puc_v4_DebugBar_PluginExtension($this);
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Scheduler.php b/Puc/v4/Scheduler.php
new file mode 100644
index 00000000..1c1c7813
--- /dev/null
+++ b/Puc/v4/Scheduler.php
@@ -0,0 +1,177 @@
+updateChecker = $updateChecker;
+ $this->checkPeriod = $checkPeriod;
+
+ //Set up the periodic update checks
+ $this->cronHook = $this->updateChecker->getUniqueName('cron_check_updates');
+ if ( $this->checkPeriod > 0 ){
+
+ //Trigger the check via Cron.
+ //Try to use one of the default schedules if possible as it's less likely to conflict
+ //with other plugins and their custom schedules.
+ $defaultSchedules = array(
+ 1 => 'hourly',
+ 12 => 'twicedaily',
+ 24 => 'daily',
+ );
+ if ( array_key_exists($this->checkPeriod, $defaultSchedules) ) {
+ $scheduleName = $defaultSchedules[$this->checkPeriod];
+ } else {
+ //Use a custom cron schedule.
+ $scheduleName = 'every' . $this->checkPeriod . 'hours';
+ add_filter('cron_schedules', array($this, '_addCustomSchedule'));
+ }
+
+ if ( !wp_next_scheduled($this->cronHook) && !defined('WP_INSTALLING') ) {
+ wp_schedule_event(time(), $scheduleName, $this->cronHook);
+ }
+ add_action($this->cronHook, array($this, 'maybeCheckForUpdates'));
+
+ //In case Cron is disabled or unreliable, we also manually trigger
+ //the periodic checks while the user is browsing the Dashboard.
+ add_action( 'admin_init', array($this, 'maybeCheckForUpdates') );
+
+ //Like WordPress itself, we check more often on certain pages.
+ /** @see wp_update_plugins */
+ add_action('load-update-core.php', array($this, 'maybeCheckForUpdates'));
+ //"load-update.php" and "load-plugins.php" or "load-themes.php".
+ $this->hourlyCheckHooks = array_merge($this->hourlyCheckHooks, $hourlyHooks);
+ foreach($this->hourlyCheckHooks as $hook) {
+ add_action($hook, array($this, 'maybeCheckForUpdates'));
+ }
+ //This hook fires after a bulk update is complete.
+ add_action('upgrader_process_complete', array($this, 'maybeCheckForUpdates'), 11, 0);
+
+ } else {
+ //Periodic checks are disabled.
+ wp_clear_scheduled_hook($this->cronHook);
+ }
+ }
+
+ /**
+ * Check for updates if the configured check interval has already elapsed.
+ * Will use a shorter check interval on certain admin pages like "Dashboard -> Updates" or when doing cron.
+ *
+ * You can override the default behaviour by using the "puc_check_now-$slug" filter.
+ * The filter callback will be passed three parameters:
+ * - Current decision. TRUE = check updates now, FALSE = don't check now.
+ * - Last check time as a Unix timestamp.
+ * - Configured check period in hours.
+ * Return TRUE to check for updates immediately, or FALSE to cancel.
+ *
+ * This method is declared public because it's a hook callback. Calling it directly is not recommended.
+ */
+ public function maybeCheckForUpdates(){
+ if ( empty($this->checkPeriod) ){
+ return;
+ }
+
+ $state = $this->updateChecker->getUpdateState();
+ $shouldCheck = ($state->timeSinceLastCheck() >= $this->getEffectiveCheckPeriod());
+
+ //Let plugin authors substitute their own algorithm.
+ $shouldCheck = apply_filters(
+ $this->updateChecker->getUniqueName('check_now'),
+ $shouldCheck,
+ $state->getLastCheck(),
+ $this->checkPeriod
+ );
+
+ if ( $shouldCheck ) {
+ $this->updateChecker->checkForUpdates();
+ }
+ }
+
+ /**
+ * Calculate the actual check period based on the current status and environment.
+ *
+ * @return int Check period in seconds.
+ */
+ protected function getEffectiveCheckPeriod() {
+ $currentFilter = current_filter();
+ if ( in_array($currentFilter, array('load-update-core.php', 'upgrader_process_complete')) ) {
+ //Check more often when the user visits "Dashboard -> Updates" or does a bulk update.
+ $period = 60;
+ } else if ( in_array($currentFilter, $this->hourlyCheckHooks) ) {
+ //Also check more often on /wp-admin/update.php and the "Plugins" or "Themes" page.
+ $period = 3600;
+ } else if ( $this->throttleRedundantChecks && ($this->updateChecker->getUpdate() !== null) ) {
+ //Check less frequently if it's already known that an update is available.
+ $period = $this->throttledCheckPeriod * 3600;
+ } else if ( defined('DOING_CRON') && constant('DOING_CRON') ) {
+ //WordPress cron schedules are not exact, so lets do an update check even
+ //if slightly less than $checkPeriod hours have elapsed since the last check.
+ $cronFuzziness = 20 * 60;
+ $period = $this->checkPeriod * 3600 - $cronFuzziness;
+ } else {
+ $period = $this->checkPeriod * 3600;
+ }
+
+ return $period;
+ }
+
+ /**
+ * Add our custom schedule to the array of Cron schedules used by WP.
+ *
+ * @param array $schedules
+ * @return array
+ */
+ public function _addCustomSchedule($schedules){
+ if ( $this->checkPeriod && ($this->checkPeriod > 0) ){
+ $scheduleName = 'every' . $this->checkPeriod . 'hours';
+ $schedules[$scheduleName] = array(
+ 'interval' => $this->checkPeriod * 3600,
+ 'display' => sprintf('Every %d hours', $this->checkPeriod),
+ );
+ }
+ return $schedules;
+ }
+
+ /**
+ * Remove the scheduled cron event that the library uses to check for updates.
+ *
+ * @return void
+ */
+ public function removeUpdaterCron(){
+ wp_clear_scheduled_hook($this->cronHook);
+ }
+
+ /**
+ * Get the name of the update checker's WP-cron hook. Mostly useful for debugging.
+ *
+ * @return string
+ */
+ public function getCronHookName() {
+ return $this->cronHook;
+ }
+ }
+
+endif;
diff --git a/Puc/v4/StateStore.php b/Puc/v4/StateStore.php
new file mode 100644
index 00000000..a5d7821e
--- /dev/null
+++ b/Puc/v4/StateStore.php
@@ -0,0 +1,207 @@
+optionName = $optionName;
+ }
+
+ /**
+ * Get time elapsed since the last update check.
+ *
+ * If there are no recorded update checks, this method returns a large arbitrary number
+ * (i.e. time since the Unix epoch).
+ *
+ * @return int Elapsed time in seconds.
+ */
+ public function timeSinceLastCheck() {
+ $this->lazyLoad();
+ return time() - $this->lastCheck;
+ }
+
+ /**
+ * @return int
+ */
+ public function getLastCheck() {
+ $this->lazyLoad();
+ return $this->lastCheck;
+ }
+
+ /**
+ * Set the time of the last update check to the current timestamp.
+ *
+ * @return $this
+ */
+ public function setLastCheckToNow() {
+ $this->lazyLoad();
+ $this->lastCheck = time();
+ return $this;
+ }
+
+ /**
+ * @return null|Puc_v4_Update
+ */
+ public function getUpdate() {
+ $this->lazyLoad();
+ return $this->update;
+ }
+
+ /**
+ * @param Puc_v4_Update|null $update
+ * @return $this
+ */
+ public function setUpdate(Puc_v4_Update $update = null) {
+ $this->lazyLoad();
+ $this->update = $update;
+ return $this;
+ }
+
+ /**
+ * @return string
+ */
+ public function getCheckedVersion() {
+ $this->lazyLoad();
+ return $this->checkedVersion;
+ }
+
+ /**
+ * @param string $version
+ * @return $this
+ */
+ public function setCheckedVersion($version) {
+ $this->lazyLoad();
+ $this->checkedVersion = strval($version);
+ return $this;
+ }
+
+ /**
+ * Get translation updates.
+ *
+ * @return array
+ */
+ public function getTranslations() {
+ $this->lazyLoad();
+ if ( isset($this->update, $this->update->translations) ) {
+ return $this->update->translations;
+ }
+ return array();
+ }
+
+ /**
+ * Set translation updates.
+ *
+ * @param array $translationUpdates
+ */
+ public function setTranslations($translationUpdates) {
+ $this->lazyLoad();
+ if ( isset($this->update) ) {
+ $this->update->translations = $translationUpdates;
+ $this->save();
+ }
+ }
+
+ public function save() {
+ $state = new stdClass();
+
+ $state->lastCheck = $this->lastCheck;
+ $state->checkedVersion = $this->checkedVersion;
+
+ if ( isset($this->update)) {
+ $state->update = $this->update->toStdClass();
+
+ $updateClass = get_class($this->update);
+ $state->updateClass = $updateClass;
+ $prefix = $this->getLibPrefix();
+ if ( Puc_v4_Utils::startsWith($updateClass, $prefix) ) {
+ $state->updateBaseClass = substr($updateClass, strlen($prefix));
+ }
+ }
+
+ update_site_option($this->optionName, $state);
+ $this->isLoaded = true;
+ }
+
+ /**
+ * @return $this
+ */
+ public function lazyLoad() {
+ if ( !$this->isLoaded ) {
+ $this->load();
+ }
+ return $this;
+ }
+
+ protected function load() {
+ $this->isLoaded = true;
+
+ $state = get_site_option($this->optionName, null);
+
+ if ( !is_object($state) ) {
+ $this->lastCheck = 0;
+ $this->checkedVersion = '';
+ $this->update = null;
+ return;
+ }
+
+ $this->lastCheck = intval(Puc_v4_Utils::get($state, 'lastCheck', 0));
+ $this->checkedVersion = Puc_v4_Utils::get($state, 'checkedVersion', '');
+ $this->update = null;
+
+ if ( isset($state->update) ) {
+ //This mess is due to the fact that the want the update class from this version
+ //of the library, not the version that saved the update.
+
+ $updateClass = null;
+ if ( isset($state->updateBaseClass) ) {
+ $updateClass = $this->getLibPrefix() . $state->updateBaseClass;
+ } else if ( isset($state->updateClass) && class_exists($state->updateClass) ) {
+ $updateClass = $state->updateClass;
+ }
+
+ if ( $updateClass !== null ) {
+ $this->update = call_user_func(array($updateClass, 'fromObject'), $state->update);
+ }
+ }
+ }
+
+ public function delete() {
+ delete_site_option($this->optionName);
+
+ $this->lastCheck = 0;
+ $this->checkedVersion = '';
+ $this->update = null;
+ }
+
+ private function getLibPrefix() {
+ $parts = explode('_', __CLASS__, 3);
+ return $parts[0] . '_' . $parts[1] . '_';
+ }
+ }
+
+endif;
diff --git a/Puc/v4/Theme/Update.php b/Puc/v4/Theme/Update.php
new file mode 100644
index 00000000..4776c65e
--- /dev/null
+++ b/Puc/v4/Theme/Update.php
@@ -0,0 +1,84 @@
+ $this->slug,
+ 'new_version' => $this->version,
+ 'url' => $this->details_url,
+ );
+
+ if ( !empty($this->download_url) ) {
+ $update['package'] = $this->download_url;
+ }
+
+ return $update;
+ }
+
+ /**
+ * Create a new instance of Theme_Update from its JSON-encoded representation.
+ *
+ * @param string $json Valid JSON string representing a theme information object.
+ * @return self New instance of ThemeUpdate, or NULL on error.
+ */
+ public static function fromJson($json) {
+ $instance = new self();
+ if ( !parent::createFromJson($json, $instance) ) {
+ return null;
+ }
+ return $instance;
+ }
+
+ /**
+ * Create a new instance by copying the necessary fields from another object.
+ *
+ * @param StdClass|Puc_v4_Theme_Update $object The source object.
+ * @return Puc_v4_Theme_Update The new copy.
+ */
+ public static function fromObject($object) {
+ $update = new self();
+ $update->copyFields($object, $update);
+ return $update;
+ }
+
+ /**
+ * Basic validation.
+ *
+ * @param StdClass $apiResponse
+ * @return bool|WP_Error
+ */
+ protected function validateMetadata($apiResponse) {
+ $required = array('version', 'details_url');
+ foreach($required as $key) {
+ if ( !isset($apiResponse->$key) || empty($apiResponse->$key) ) {
+ return new WP_Error(
+ 'tuc-invalid-metadata',
+ sprintf('The theme metadata is missing the required "%s" key.', $key)
+ );
+ }
+ }
+ return true;
+ }
+
+ protected function getFieldNames() {
+ return array_merge(parent::getFieldNames(), self::$extraFields);
+ }
+
+ protected function getPrefixedFilter($tag) {
+ return parent::getPrefixedFilter($tag) . '_theme';
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Theme/UpdateChecker.php b/Puc/v4/Theme/UpdateChecker.php
new file mode 100644
index 00000000..dbf4245e
--- /dev/null
+++ b/Puc/v4/Theme/UpdateChecker.php
@@ -0,0 +1,167 @@
+stylesheet = $stylesheet;
+ $this->theme = wp_get_theme($this->stylesheet);
+
+ parent::__construct(
+ $metadataUrl,
+ $stylesheet,
+ $customSlug ? $customSlug : $stylesheet,
+ $checkPeriod,
+ $optionName
+ );
+ }
+
+ /**
+ * For themes, the update array is indexed by theme directory name.
+ *
+ * @return string
+ */
+ protected function getUpdateListKey() {
+ return $this->directoryName;
+ }
+
+ /**
+ * Retrieve the latest update (if any) from the configured API endpoint.
+ *
+ * @return Puc_v4_Update|null An instance of Update, or NULL when no updates are available.
+ */
+ public function requestUpdate() {
+ list($themeUpdate, $result) = $this->requestMetadata('Puc_v4_Theme_Update', 'request_update');
+
+ if ( $themeUpdate !== null ) {
+ /** @var Puc_v4_Theme_Update $themeUpdate */
+ $themeUpdate->slug = $this->slug;
+ }
+
+ $themeUpdate = $this->filterUpdateResult($themeUpdate, $result);
+ return $themeUpdate;
+ }
+
+ public function userCanInstallUpdates() {
+ return current_user_can('update_themes');
+ }
+
+ /**
+ * Get the currently installed version of the plugin or theme.
+ *
+ * @return string Version number.
+ */
+ public function getInstalledVersion() {
+ return $this->theme->get('Version');
+ }
+
+ /**
+ * Create an instance of the scheduler.
+ *
+ * @param int $checkPeriod
+ * @return Puc_v4_Scheduler
+ */
+ protected function createScheduler($checkPeriod) {
+ return new Puc_v4_Scheduler($this, $checkPeriod, array('load-themes.php'));
+ }
+
+ /**
+ * Is there an update being installed right now for this theme?
+ *
+ * @param WP_Upgrader|null $upgrader The upgrader that's performing the current update.
+ * @return bool
+ */
+ public function isBeingUpgraded($upgrader = null) {
+ return $this->upgraderStatus->isThemeBeingUpgraded($this->stylesheet, $upgrader);
+ }
+
+ protected function createDebugBarExtension() {
+ return new Puc_v4_DebugBar_Extension($this, 'Puc_v4_DebugBar_ThemePanel');
+ }
+
+ /**
+ * Register a callback for filtering query arguments.
+ *
+ * The callback function should take one argument - an associative array of query arguments.
+ * It should return a modified array of query arguments.
+ *
+ * @param callable $callback
+ * @return void
+ */
+ public function addQueryArgFilter($callback){
+ $this->addFilter('request_update_query_args', $callback);
+ }
+
+ /**
+ * Register a callback for filtering arguments passed to wp_remote_get().
+ *
+ * The callback function should take one argument - an associative array of arguments -
+ * and return a modified array or arguments. See the WP documentation on wp_remote_get()
+ * for details on what arguments are available and how they work.
+ *
+ * @uses add_filter() This method is a convenience wrapper for add_filter().
+ *
+ * @param callable $callback
+ * @return void
+ */
+ public function addHttpRequestArgFilter($callback) {
+ $this->addFilter('request_update_options', $callback);
+ }
+
+ /**
+ * Register a callback for filtering theme updates retrieved from the external API.
+ *
+ * The callback function should take two arguments. If the theme update was retrieved
+ * successfully, the first argument passed will be an instance of Theme_Update. Otherwise,
+ * it will be NULL. The second argument will be the corresponding return value of
+ * wp_remote_get (see WP docs for details).
+ *
+ * The callback function should return a new or modified instance of Theme_Update or NULL.
+ *
+ * @uses add_filter() This method is a convenience wrapper for add_filter().
+ *
+ * @param callable $callback
+ * @return void
+ */
+ public function addResultFilter($callback) {
+ $this->addFilter('request_update_result', $callback, 10, 2);
+ }
+
+ /**
+ * @return array
+ */
+ protected function getHeaderNames() {
+ return array(
+ 'Name' => 'Theme Name',
+ 'ThemeURI' => 'Theme URI',
+ 'Description' => 'Description',
+ 'Author' => 'Author',
+ 'AuthorURI' => 'Author URI',
+ 'Version' => 'Version',
+ 'Template' => 'Template',
+ 'Status' => 'Status',
+ 'Tags' => 'Tags',
+ 'TextDomain' => 'Text Domain',
+ 'DomainPath' => 'Domain Path',
+ );
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Update.php b/Puc/v4/Update.php
new file mode 100644
index 00000000..a2753e83
--- /dev/null
+++ b/Puc/v4/Update.php
@@ -0,0 +1,34 @@
+slug = $this->slug;
+ $update->new_version = $this->version;
+ $update->package = $this->download_url;
+
+ return $update;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/UpdateChecker.php b/Puc/v4/UpdateChecker.php
new file mode 100644
index 00000000..f583f2f4
--- /dev/null
+++ b/Puc/v4/UpdateChecker.php
@@ -0,0 +1,807 @@
+debugMode = (bool)(constant('WP_DEBUG'));
+ $this->metadataUrl = $metadataUrl;
+ $this->directoryName = $directoryName;
+ $this->slug = !empty($slug) ? $slug : $this->directoryName;
+
+ $this->optionName = $optionName;
+ if ( empty($this->optionName) ) {
+ //BC: Initially the library only supported plugin updates and didn't use type prefixes
+ //in the option name. Lets use the same prefix-less name when possible.
+ if ( $this->filterSuffix === '' ) {
+ $this->optionName = 'external_updates-' . $this->slug;
+ } else {
+ $this->optionName = $this->getUniqueName('external_updates');
+ }
+ }
+
+ $this->scheduler = $this->createScheduler($checkPeriod);
+ $this->upgraderStatus = new Puc_v4_UpgraderStatus();
+ $this->updateState = new Puc_v4_StateStore($this->optionName);
+
+ $this->loadTextDomain();
+ $this->installHooks();
+ }
+
+ protected function loadTextDomain() {
+ //We're not using load_plugin_textdomain() or its siblings because figuring out where
+ //the library is located (plugin, mu-plugin, theme, custom wp-content paths) is messy.
+ $domain = 'plugin-update-checker';
+ $locale = apply_filters('plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain);
+
+ $moFile = $domain . '-' . $locale . '.mo';
+ $path = realpath(dirname(__FILE__) . '/../../languages');
+
+ if ($path && file_exists($path)) {
+ load_textdomain($domain, $path . '/ ' . $moFile);
+ }
+ }
+
+ protected function installHooks() {
+ //Insert our update info into the update array maintained by WP.
+ add_filter('site_transient_' . $this->updateTransient, array($this,'injectUpdate'));
+
+ //Insert translation updates into the update list.
+ add_filter('site_transient_' . $this->updateTransient, array($this, 'injectTranslationUpdates'));
+
+ //Clear translation updates when WP clears the update cache.
+ //This needs to be done directly because the library doesn't actually remove obsolete plugin updates,
+ //it just hides them (see getUpdate()). We can't do that with translations - too much disk I/O.
+ add_action(
+ 'delete_site_transient_' . $this->updateTransient,
+ array($this, 'clearCachedTranslationUpdates')
+ );
+
+ //Rename the update directory to be the same as the existing directory.
+ if ( $this->directoryName !== '.' ) {
+ add_filter('upgrader_source_selection', array($this, 'fixDirectoryName'), 10, 3);
+ }
+
+ //Allow HTTP requests to the metadata URL even if it's on a local host.
+ add_filter('http_request_host_is_external', array($this, 'allowMetadataHost'), 10, 2);
+
+ //DebugBar integration.
+ if ( did_action('plugins_loaded') ) {
+ $this->maybeInitDebugBar();
+ } else {
+ add_action('plugins_loaded', array($this, 'maybeInitDebugBar'));
+ }
+ }
+
+ /**
+ * Check if the current user has the required permissions to install updates.
+ *
+ * @return bool
+ */
+ abstract public function userCanInstallUpdates();
+
+ /**
+ * Explicitly allow HTTP requests to the metadata URL.
+ *
+ * WordPress has a security feature where the HTTP API will reject all requests that are sent to
+ * another site hosted on the same server as the current site (IP match), a local host, or a local
+ * IP, unless the host exactly matches the current site.
+ *
+ * This feature is opt-in (at least in WP 4.4). Apparently some people enable it.
+ *
+ * That can be a problem when you're developing your plugin and you decide to host the update information
+ * on the same server as your test site. Update requests will mysteriously fail.
+ *
+ * We fix that by adding an exception for the metadata host.
+ *
+ * @param bool $allow
+ * @param string $host
+ * @return bool
+ */
+ public function allowMetadataHost($allow, $host) {
+ static $metadataHost = 0; //Using 0 instead of NULL because parse_url can return NULL.
+ if ( $metadataHost === 0 ) {
+ $metadataHost = @parse_url($this->metadataUrl, PHP_URL_HOST);
+ }
+
+ if ( is_string($metadataHost) && (strtolower($host) === strtolower($metadataHost)) ) {
+ return true;
+ }
+ return $allow;
+ }
+
+ /**
+ * Create an instance of the scheduler.
+ *
+ * This is implemented as a method to make it possible for plugins to subclass the update checker
+ * and substitute their own scheduler.
+ *
+ * @param int $checkPeriod
+ * @return Puc_v4_Scheduler
+ */
+ abstract protected function createScheduler($checkPeriod);
+
+ /**
+ * Check for updates. The results are stored in the DB option specified in $optionName.
+ *
+ * @return Puc_v4_Update|null
+ */
+ public function checkForUpdates() {
+ $installedVersion = $this->getInstalledVersion();
+ //Fail silently if we can't find the plugin/theme or read its header.
+ if ( $installedVersion === null ) {
+ $this->triggerError(
+ sprintf('Skipping update check for %s - installed version unknown.', $this->slug),
+ E_USER_WARNING
+ );
+ return null;
+ }
+
+ $state = $this->updateState;
+ $state->setLastCheckToNow()
+ ->setCheckedVersion($installedVersion)
+ ->save(); //Save before checking in case something goes wrong
+
+ $state->setUpdate($this->requestUpdate());
+ $state->save();
+
+ return $this->getUpdate();
+ }
+
+ /**
+ * Load the update checker state from the DB.
+ *
+ * @return Puc_v4_StateStore
+ */
+ public function getUpdateState() {
+ return $this->updateState->lazyLoad();
+ }
+
+ /**
+ * Reset update checker state - i.e. last check time, cached update data and so on.
+ *
+ * Call this when your plugin is being uninstalled, or if you want to
+ * clear the update cache.
+ */
+ public function resetUpdateState() {
+ $this->updateState->delete();
+ }
+
+ /**
+ * Get the details of the currently available update, if any.
+ *
+ * If no updates are available, or if the last known update version is below or equal
+ * to the currently installed version, this method will return NULL.
+ *
+ * Uses cached update data. To retrieve update information straight from
+ * the metadata URL, call requestUpdate() instead.
+ *
+ * @return Puc_v4_Update|null
+ */
+ public function getUpdate() {
+ $update = $this->updateState->getUpdate();
+
+ //Is there an update available?
+ if ( isset($update) ) {
+ //Check if the update is actually newer than the currently installed version.
+ $installedVersion = $this->getInstalledVersion();
+ if ( ($installedVersion !== null) && version_compare($update->version, $installedVersion, '>') ){
+ return $update;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Retrieve the latest update (if any) from the configured API endpoint.
+ *
+ * Subclasses should run the update through filterUpdateResult before returning it.
+ *
+ * @return Puc_v4_Update An instance of Update, or NULL when no updates are available.
+ */
+ abstract public function requestUpdate();
+
+ /**
+ * Filter the result of a requestUpdate() call.
+ *
+ * @param Puc_v4_Update|null $update
+ * @param array|WP_Error|null $httpResult The value returned by wp_remote_get(), if any.
+ * @return Puc_v4_Update
+ */
+ protected function filterUpdateResult($update, $httpResult = null) {
+ //Let plugins/themes modify the update.
+ $update = apply_filters($this->getUniqueName('request_update_result'), $update, $httpResult);
+
+ if ( isset($update, $update->translations) ) {
+ //Keep only those translation updates that apply to this site.
+ $update->translations = $this->filterApplicableTranslations($update->translations);
+ }
+
+ return $update;
+ }
+
+ /**
+ * Get the currently installed version of the plugin or theme.
+ *
+ * @return string Version number.
+ */
+ abstract public function getInstalledVersion();
+
+ /**
+ * Trigger a PHP error, but only when $debugMode is enabled.
+ *
+ * @param string $message
+ * @param int $errorType
+ */
+ protected function triggerError($message, $errorType) {
+ if ($this->debugMode) {
+ trigger_error($message, $errorType);
+ }
+ }
+
+ /**
+ * Get the full name of an update checker filter, action or DB entry.
+ *
+ * This method adds the "puc_" prefix and the "-$slug" suffix to the filter name.
+ * For example, "pre_inject_update" becomes "puc_pre_inject_update-plugin-slug".
+ *
+ * @param string $baseTag
+ * @return string
+ */
+ public function getUniqueName($baseTag) {
+ $name = 'puc_' . $baseTag;
+ if ($this->filterSuffix !== '') {
+ $name .= '_' . $this->filterSuffix;
+ }
+ return $name . '-' . $this->slug;
+ }
+
+ /* -------------------------------------------------------------------
+ * PUC filters and filter utilities
+ * -------------------------------------------------------------------
+ */
+
+ /**
+ * Register a callback for one of the update checker filters.
+ *
+ * Identical to add_filter(), except it automatically adds the "puc_" prefix
+ * and the "-$slug" suffix to the filter name. For example, "request_info_result"
+ * becomes "puc_request_info_result-your_plugin_slug".
+ *
+ * @param string $tag
+ * @param callable $callback
+ * @param int $priority
+ * @param int $acceptedArgs
+ */
+ public function addFilter($tag, $callback, $priority = 10, $acceptedArgs = 1) {
+ add_filter($this->getUniqueName($tag), $callback, $priority, $acceptedArgs);
+ }
+
+ /* -------------------------------------------------------------------
+ * Inject updates
+ * -------------------------------------------------------------------
+ */
+
+ /**
+ * Insert the latest update (if any) into the update list maintained by WP.
+ *
+ * @param stdClass $updates Update list.
+ * @return stdClass Modified update list.
+ */
+ public function injectUpdate($updates) {
+ //Is there an update to insert?
+ $update = $this->getUpdate();
+
+ if ( !$this->shouldShowUpdates() ) {
+ $update = null;
+ }
+
+ if ( !empty($update) ) {
+ //Let plugins filter the update info before it's passed on to WordPress.
+ $update = apply_filters($this->getUniqueName('pre_inject_update'), $update);
+ $updates = $this->addUpdateToList($updates, $update->toWpFormat());
+ } else {
+ //Clean up any stale update info.
+ $updates = $this->removeUpdateFromList($updates);
+ }
+
+ return $updates;
+ }
+
+ /**
+ * @param stdClass|null $updates
+ * @param stdClass|array $updateToAdd
+ * @return stdClass
+ */
+ protected function addUpdateToList($updates, $updateToAdd) {
+ if ( !is_object($updates) ) {
+ $updates = new stdClass();
+ $updates->response = array();
+ }
+
+ $updates->response[$this->getUpdateListKey()] = $updateToAdd;
+ return $updates;
+ }
+
+ /**
+ * @param stdClass|null $updates
+ * @return stdClass|null
+ */
+ protected function removeUpdateFromList($updates) {
+ if ( isset($updates, $updates->response) ) {
+ unset($updates->response[$this->getUpdateListKey()]);
+ }
+ return $updates;
+ }
+
+ /**
+ * Get the key that will be used when adding updates to the update list that's maintained
+ * by the WordPress core. The list is always an associative array, but the key is different
+ * for plugins and themes.
+ *
+ * @return string
+ */
+ abstract protected function getUpdateListKey();
+
+ /**
+ * Should we show available updates?
+ *
+ * Usually the answer is "yes", but there are exceptions. For example, WordPress doesn't
+ * support automatic updates installation for mu-plugins, so PUC usually won't show update
+ * notifications in that case. See the plugin-specific subclass for details.
+ *
+ * Note: This method only applies to updates that are displayed (or not) in the WordPress
+ * admin. It doesn't affect APIs like requestUpdate and getUpdate.
+ *
+ * @return bool
+ */
+ protected function shouldShowUpdates() {
+ return true;
+ }
+
+ /* -------------------------------------------------------------------
+ * JSON-based update API
+ * -------------------------------------------------------------------
+ */
+
+ /**
+ * Retrieve plugin or theme metadata from the JSON document at $this->metadataUrl.
+ *
+ * @param string $metaClass Parse the JSON as an instance of this class. It must have a static fromJson method.
+ * @param string $filterRoot
+ * @param array $queryArgs Additional query arguments.
+ * @return array [Puc_v4_Metadata|null, array|WP_Error] A metadata instance and the value returned by wp_remote_get().
+ */
+ protected function requestMetadata($metaClass, $filterRoot, $queryArgs = array()) {
+ //Query args to append to the URL. Plugins can add their own by using a filter callback (see addQueryArgFilter()).
+ $installedVersion = $this->getInstalledVersion();
+ $queryArgs['installed_version'] = ($installedVersion !== null) ? $installedVersion : '';
+ $queryArgs = apply_filters($this->getUniqueName($filterRoot . '_query_args'), $queryArgs);
+
+ //Various options for the wp_remote_get() call. Plugins can filter these, too.
+ $options = array(
+ 'timeout' => 10, //seconds
+ 'headers' => array(
+ 'Accept' => 'application/json',
+ ),
+ );
+ $options = apply_filters($this->getUniqueName($filterRoot . '_options'), $options);
+
+ //The metadata file should be at 'http://your-api.com/url/here/$slug/info.json'
+ $url = $this->metadataUrl;
+ if ( !empty($queryArgs) ){
+ $url = add_query_arg($queryArgs, $url);
+ }
+
+ $result = wp_remote_get($url, $options);
+
+ //Try to parse the response
+ $status = $this->validateApiResponse($result);
+ $metadata = null;
+ if ( !is_wp_error($status) ){
+ $metadata = call_user_func(array($metaClass, 'fromJson'), $result['body']);
+ } else {
+ $this->triggerError(
+ sprintf('The URL %s does not point to a valid metadata file. ', $url)
+ . $status->get_error_message(),
+ E_USER_WARNING
+ );
+ }
+
+ return array($metadata, $result);
+ }
+
+ /**
+ * Check if $result is a successful update API response.
+ *
+ * @param array|WP_Error $result
+ * @return true|WP_Error
+ */
+ protected function validateApiResponse($result) {
+ if ( is_wp_error($result) ) { /** @var WP_Error $result */
+ return new WP_Error($result->get_error_code(), 'WP HTTP Error: ' . $result->get_error_message());
+ }
+
+ if ( !isset($result['response']['code']) ) {
+ return new WP_Error(
+ 'puc_no_response_code',
+ 'wp_remote_get() returned an unexpected result.'
+ );
+ }
+
+ if ( $result['response']['code'] !== 200 ) {
+ return new WP_Error(
+ 'puc_unexpected_response_code',
+ 'HTTP response code is ' . $result['response']['code'] . ' (expected: 200)'
+ );
+ }
+
+ if ( empty($result['body']) ) {
+ return new WP_Error('puc_empty_response', 'The metadata file appears to be empty.');
+ }
+
+ return true;
+ }
+
+ /* -------------------------------------------------------------------
+ * Language packs / Translation updates
+ * -------------------------------------------------------------------
+ */
+
+ /**
+ * Filter a list of translation updates and return a new list that contains only updates
+ * that apply to the current site.
+ *
+ * @param array $translations
+ * @return array
+ */
+ protected function filterApplicableTranslations($translations) {
+ $languages = array_flip(array_values(get_available_languages()));
+ $installedTranslations = $this->getInstalledTranslations();
+
+ $applicableTranslations = array();
+ foreach($translations as $translation) {
+ //Does it match one of the available core languages?
+ $isApplicable = array_key_exists($translation->language, $languages);
+ //Is it more recent than an already-installed translation?
+ if ( isset($installedTranslations[$translation->language]) ) {
+ $updateTimestamp = strtotime($translation->updated);
+ $installedTimestamp = strtotime($installedTranslations[$translation->language]['PO-Revision-Date']);
+ $isApplicable = $updateTimestamp > $installedTimestamp;
+ }
+
+ if ( $isApplicable ) {
+ $applicableTranslations[] = $translation;
+ }
+ }
+
+ return $applicableTranslations;
+ }
+
+ /**
+ * Get a list of installed translations for this plugin or theme.
+ *
+ * @return array
+ */
+ protected function getInstalledTranslations() {
+ $installedTranslations = wp_get_installed_translations($this->translationType . 's');
+ if ( isset($installedTranslations[$this->directoryName]) ) {
+ $installedTranslations = $installedTranslations[$this->directoryName];
+ } else {
+ $installedTranslations = array();
+ }
+ return $installedTranslations;
+ }
+
+ /**
+ * Insert translation updates into the list maintained by WordPress.
+ *
+ * @param stdClass $updates
+ * @return stdClass
+ */
+ public function injectTranslationUpdates($updates) {
+ $translationUpdates = $this->getTranslationUpdates();
+ if ( empty($translationUpdates) ) {
+ return $updates;
+ }
+
+ //Being defensive.
+ if ( !is_object($updates) ) {
+ $updates = new stdClass();
+ }
+ if ( !isset($updates->translations) ) {
+ $updates->translations = array();
+ }
+
+ //In case there's a name collision with a plugin or theme hosted on wordpress.org,
+ //remove any preexisting updates that match our thing.
+ $updates->translations = array_values(array_filter(
+ $updates->translations,
+ array($this, 'isNotMyTranslation')
+ ));
+
+ //Add our updates to the list.
+ foreach($translationUpdates as $update) {
+ $convertedUpdate = array_merge(
+ array(
+ 'type' => $this->translationType,
+ 'slug' => $this->directoryName,
+ 'autoupdate' => 0,
+ //AFAICT, WordPress doesn't actually use the "version" field for anything.
+ //But lets make sure it's there, just in case.
+ 'version' => isset($update->version) ? $update->version : ('1.' . strtotime($update->updated)),
+ ),
+ (array)$update
+ );
+
+ $updates->translations[] = $convertedUpdate;
+ }
+
+ return $updates;
+ }
+
+ /**
+ * Get a list of available translation updates.
+ *
+ * This method will return an empty array if there are no updates.
+ * Uses cached update data.
+ *
+ * @return array
+ */
+ public function getTranslationUpdates() {
+ return $this->updateState->getTranslations();
+ }
+
+ /**
+ * Remove all cached translation updates.
+ *
+ * @see wp_clean_update_cache
+ */
+ public function clearCachedTranslationUpdates() {
+ $this->updateState->setTranslations(array());
+ }
+
+ /**
+ * Filter callback. Keeps only translations that *don't* match this plugin or theme.
+ *
+ * @param array $translation
+ * @return bool
+ */
+ protected function isNotMyTranslation($translation) {
+ $isMatch = isset($translation['type'], $translation['slug'])
+ && ($translation['type'] === $this->translationType)
+ && ($translation['slug'] === $this->directoryName);
+
+ return !$isMatch;
+ }
+
+ /* -------------------------------------------------------------------
+ * Fix directory name when installing updates
+ * -------------------------------------------------------------------
+ */
+
+ /**
+ * Rename the update directory to match the existing plugin/theme directory.
+ *
+ * When WordPress installs a plugin or theme update, it assumes that the ZIP file will contain
+ * exactly one directory, and that the directory name will be the same as the directory where
+ * the plugin or theme is currently installed.
+ *
+ * GitHub and other repositories provide ZIP downloads, but they often use directory names like
+ * "project-branch" or "project-tag-hash". We need to change the name to the actual plugin folder.
+ *
+ * This is a hook callback. Don't call it from a plugin.
+ *
+ * @access protected
+ *
+ * @param string $source The directory to copy to /wp-content/plugins or /wp-content/themes. Usually a subdirectory of $remoteSource.
+ * @param string $remoteSource WordPress has extracted the update to this directory.
+ * @param WP_Upgrader $upgrader
+ * @return string|WP_Error
+ */
+ public function fixDirectoryName($source, $remoteSource, $upgrader) {
+ global $wp_filesystem;
+ /** @var WP_Filesystem_Base $wp_filesystem */
+
+ //Basic sanity checks.
+ if ( !isset($source, $remoteSource, $upgrader, $upgrader->skin, $wp_filesystem) ) {
+ return $source;
+ }
+
+ //If WordPress is upgrading anything other than our plugin/theme, leave the directory name unchanged.
+ if ( !$this->isBeingUpgraded($upgrader) ) {
+ return $source;
+ }
+
+ //Rename the source to match the existing directory.
+ $correctedSource = trailingslashit($remoteSource) . $this->directoryName . '/';
+ if ( $source !== $correctedSource ) {
+ //The update archive should contain a single directory that contains the rest of plugin/theme files.
+ //Otherwise, WordPress will try to copy the entire working directory ($source == $remoteSource).
+ //We can't rename $remoteSource because that would break WordPress code that cleans up temporary files
+ //after update.
+ if ( $this->isBadDirectoryStructure($remoteSource) ) {
+ return new WP_Error(
+ 'puc-incorrect-directory-structure',
+ sprintf(
+ 'The directory structure of the update is incorrect. All files should be inside ' .
+ 'a directory named %s, not at the root of the ZIP archive.',
+ htmlentities($this->slug)
+ )
+ );
+ }
+
+ /** @var WP_Upgrader_Skin $upgrader ->skin */
+ $upgrader->skin->feedback(sprintf(
+ 'Renaming %s to %s…',
+ '' . basename($source) . '',
+ '' . $this->directoryName . ''
+ ));
+
+ if ( $wp_filesystem->move($source, $correctedSource, true) ) {
+ $upgrader->skin->feedback('Directory successfully renamed.');
+ return $correctedSource;
+ } else {
+ return new WP_Error(
+ 'puc-rename-failed',
+ 'Unable to rename the update to match the existing directory.'
+ );
+ }
+ }
+
+ return $source;
+ }
+
+ /**
+ * Is there an update being installed right now, for this plugin or theme?
+ *
+ * @param WP_Upgrader|null $upgrader The upgrader that's performing the current update.
+ * @return bool
+ */
+ abstract public function isBeingUpgraded($upgrader = null);
+
+ /**
+ * Check for incorrect update directory structure. An update must contain a single directory,
+ * all other files should be inside that directory.
+ *
+ * @param string $remoteSource Directory path.
+ * @return bool
+ */
+ protected function isBadDirectoryStructure($remoteSource) {
+ global $wp_filesystem;
+ /** @var WP_Filesystem_Base $wp_filesystem */
+
+ $sourceFiles = $wp_filesystem->dirlist($remoteSource);
+ if ( is_array($sourceFiles) ) {
+ $sourceFiles = array_keys($sourceFiles);
+ $firstFilePath = trailingslashit($remoteSource) . $sourceFiles[0];
+ return (count($sourceFiles) > 1) || (!$wp_filesystem->is_dir($firstFilePath));
+ }
+
+ //Assume it's fine.
+ return false;
+ }
+
+ /* -------------------------------------------------------------------
+ * File header parsing
+ * -------------------------------------------------------------------
+ */
+
+ /**
+ * Parse plugin or theme metadata from the header comment.
+ *
+ * This is basically a simplified version of the get_file_data() function from /wp-includes/functions.php.
+ * It's intended as a utility for subclasses that detect updates by parsing files in a VCS.
+ *
+ * @param string|null $content File contents.
+ * @return string[]
+ */
+ public function getFileHeader($content) {
+ $content = (string) $content;
+
+ //WordPress only looks at the first 8 KiB of the file, so we do the same.
+ $content = substr($content, 0, 8192);
+ //Normalize line endings.
+ $content = str_replace("\r", "\n", $content);
+
+ $headers = $this->getHeaderNames();
+ $results = array();
+ foreach ($headers as $field => $name) {
+ $success = preg_match('/^[ \t\/*#@]*' . preg_quote($name, '/') . ':(.*)$/mi', $content, $matches);
+
+ if ( ($success === 1) && $matches[1] ) {
+ $value = $matches[1];
+ if ( function_exists('_cleanup_header_comment') ) {
+ $value = _cleanup_header_comment($value);
+ }
+ $results[$field] = $value;
+ } else {
+ $results[$field] = '';
+ }
+ }
+
+ return $results;
+ }
+
+ /**
+ * @return array Format: ['HeaderKey' => 'Header Name']
+ */
+ abstract protected function getHeaderNames();
+
+ /* -------------------------------------------------------------------
+ * DebugBar integration
+ * -------------------------------------------------------------------
+ */
+
+ /**
+ * Initialize the update checker Debug Bar plugin/add-on thingy.
+ */
+ public function maybeInitDebugBar() {
+ if ( class_exists('Debug_Bar', false) && file_exists(dirname(__FILE__ . '/DebugBar')) ) {
+ $this->createDebugBarExtension();
+ }
+ }
+
+ protected function createDebugBarExtension() {
+ return new Puc_v4_DebugBar_Extension($this);
+ }
+
+ /**
+ * Display additional configuration details in the Debug Bar panel.
+ *
+ * @param Puc_v4_DebugBar_Panel $panel
+ */
+ public function onDisplayConfiguration($panel) {
+ //Do nothing. Subclasses can use this to add additional info to the panel.
+ }
+
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/UpgraderStatus.php b/Puc/v4/UpgraderStatus.php
new file mode 100644
index 00000000..e199bd93
--- /dev/null
+++ b/Puc/v4/UpgraderStatus.php
@@ -0,0 +1,199 @@
+isBeingUpgraded('plugin', $pluginFile, $upgrader);
+ }
+
+ /**
+ * Is there an update being installed for a specific theme?
+ *
+ * @param string $stylesheet Theme directory name.
+ * @param WP_Upgrader|null $upgrader The upgrader that's performing the current update.
+ * @return bool
+ */
+ public function isThemeBeingUpgraded($stylesheet, $upgrader = null) {
+ return $this->isBeingUpgraded('theme', $stylesheet, $upgrader);
+ }
+
+ /**
+ * Check if a specific theme or plugin is being upgraded.
+ *
+ * @param string $type
+ * @param string $id
+ * @param Plugin_Upgrader|WP_Upgrader|null $upgrader
+ * @return bool
+ */
+ protected function isBeingUpgraded($type, $id, $upgrader = null) {
+ if ( isset($upgrader) ) {
+ list($currentType, $currentId) = $this->getThingBeingUpgradedBy($upgrader);
+ if ( $currentType !== null ) {
+ $this->currentType = $currentType;
+ $this->currentId = $currentId;
+ }
+ }
+ return ($this->currentType === $type) && ($this->currentId === $id);
+ }
+
+ /**
+ * Figure out which theme or plugin is being upgraded by a WP_Upgrader instance.
+ *
+ * Returns an array with two items. The first item is the type of the thing that's being
+ * upgraded: "plugin" or "theme". The second item is either the plugin basename or
+ * the theme directory name. If we can't determine what the upgrader is doing, both items
+ * will be NULL.
+ *
+ * Examples:
+ * ['plugin', 'plugin-dir-name/plugin.php']
+ * ['theme', 'theme-dir-name']
+ *
+ * @param Plugin_Upgrader|WP_Upgrader $upgrader
+ * @return array
+ */
+ private function getThingBeingUpgradedBy($upgrader) {
+ if ( !isset($upgrader, $upgrader->skin) ) {
+ return array(null, null);
+ }
+
+ //Figure out which plugin or theme is being upgraded.
+ $pluginFile = null;
+ $themeDirectoryName = null;
+
+ $skin = $upgrader->skin;
+ if ( isset($skin->theme_info) && ($skin->theme_info instanceof WP_Theme) ) {
+ $themeDirectoryName = $skin->theme_info->get_stylesheet();
+ } elseif ( $skin instanceof Plugin_Upgrader_Skin ) {
+ if ( isset($skin->plugin) && is_string($skin->plugin) && ($skin->plugin !== '') ) {
+ $pluginFile = $skin->plugin;
+ }
+ } elseif ( $skin instanceof Theme_Upgrader_Skin ) {
+ if ( isset($skin->theme) && is_string($skin->theme) && ($skin->theme !== '') ) {
+ $themeDirectoryName = $skin->theme;
+ }
+ } elseif ( isset($skin->plugin_info) && is_array($skin->plugin_info) ) {
+ //This case is tricky because Bulk_Plugin_Upgrader_Skin (etc) doesn't actually store the plugin
+ //filename anywhere. Instead, it has the plugin headers in $plugin_info. So the best we can
+ //do is compare those headers to the headers of installed plugins.
+ $pluginFile = $this->identifyPluginByHeaders($skin->plugin_info);
+ }
+
+ if ( $pluginFile !== null ) {
+ return array('plugin', $pluginFile);
+ } elseif ( $themeDirectoryName !== null ) {
+ return array('theme', $themeDirectoryName);
+ }
+ return array(null, null);
+ }
+
+ /**
+ * Identify an installed plugin based on its headers.
+ *
+ * @param array $searchHeaders The plugin file header to look for.
+ * @return string|null Plugin basename ("foo/bar.php"), or NULL if we can't identify the plugin.
+ */
+ private function identifyPluginByHeaders($searchHeaders) {
+ if ( !function_exists('get_plugins') ){
+ /** @noinspection PhpIncludeInspection */
+ require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
+ }
+
+ $installedPlugins = get_plugins();
+ $matches = array();
+ foreach($installedPlugins as $pluginBasename => $headers) {
+ $diff1 = array_diff_assoc($headers, $searchHeaders);
+ $diff2 = array_diff_assoc($searchHeaders, $headers);
+ if ( empty($diff1) && empty($diff2) ) {
+ $matches[] = $pluginBasename;
+ }
+ }
+
+ //It's possible (though very unlikely) that there could be two plugins with identical
+ //headers. In that case, we can't unambiguously identify the plugin that's being upgraded.
+ if ( count($matches) !== 1 ) {
+ return null;
+ }
+
+ return reset($matches);
+ }
+
+ /**
+ * @access private
+ *
+ * @param mixed $input
+ * @param array $hookExtra
+ * @return mixed Returns $input unaltered.
+ */
+ public function setUpgradedThing($input, $hookExtra) {
+ if ( !empty($hookExtra['plugin']) && is_string($hookExtra['plugin']) ) {
+ $this->currentId = $hookExtra['plugin'];
+ $this->currentType = 'plugin';
+ } elseif ( !empty($hookExtra['theme']) && is_string($hookExtra['theme']) ) {
+ $this->currentId = $hookExtra['theme'];
+ $this->currentType = 'theme';
+ } else {
+ $this->currentType = null;
+ $this->currentId = null;
+ }
+ return $input;
+ }
+
+ /**
+ * @access private
+ *
+ * @param array $options
+ * @return array
+ */
+ public function setUpgradedPluginFromOptions($options) {
+ if ( isset($options['hook_extra']['plugin']) && is_string($options['hook_extra']['plugin']) ) {
+ $this->currentType = 'plugin';
+ $this->currentId = $options['hook_extra']['plugin'];
+ } else {
+ $this->currentType = null;
+ $this->currentId = null;
+ }
+ return $options;
+ }
+
+ /**
+ * @access private
+ *
+ * @param mixed $input
+ * @return mixed Returns $input unaltered.
+ */
+ public function clearUpgradedThing($input = null) {
+ $this->currentId = null;
+ $this->currentType = null;
+ return $input;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Utils.php b/Puc/v4/Utils.php
new file mode 100644
index 00000000..b4fd8ea7
--- /dev/null
+++ b/Puc/v4/Utils.php
@@ -0,0 +1,77 @@
+$node) ) {
+ $currentValue = $currentValue->$node;
+ } else {
+ $pathExists = false;
+ break;
+ }
+ }
+
+ if ( $pathExists ) {
+ return $currentValue;
+ }
+ return $default;
+ }
+
+ /**
+ * Get the first array element that is not empty.
+ *
+ * @param array $values
+ * @param mixed|null $default Returns this value if there are no non-empty elements.
+ * @return mixed|null
+ */
+ public static function findNotEmpty($values, $default = null) {
+ if ( empty($values) ) {
+ return $default;
+ }
+
+ foreach ($values as $value) {
+ if ( !empty($value) ) {
+ return $value;
+ }
+ }
+
+ return $default;
+ }
+
+ /**
+ * Check if the input string starts with the specified prefix.
+ *
+ * @param string $input
+ * @param string $prefix
+ * @return bool
+ */
+ public static function startsWith($input, $prefix) {
+ $length = strlen($prefix);
+ return (substr($input, 0, $length) === $prefix);
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Vcs/Api.php b/Puc/v4/Vcs/Api.php
new file mode 100644
index 00000000..f0493440
--- /dev/null
+++ b/Puc/v4/Vcs/Api.php
@@ -0,0 +1,243 @@
+repositoryUrl = $repositoryUrl;
+ $this->setAuthentication($credentials);
+ }
+
+ /**
+ * @return string
+ */
+ public function getRepositoryUrl() {
+ return $this->repositoryUrl;
+ }
+
+ /**
+ * Figure out which reference (i.e tag or branch) contains the latest version.
+ *
+ * @param string $configBranch Start looking in this branch.
+ * @return null|Puc_v4_Vcs_Reference
+ */
+ abstract public function chooseReference($configBranch);
+
+ /**
+ * Get the readme.txt file from the remote repository and parse it
+ * according to the plugin readme standard.
+ *
+ * @param string $ref Tag or branch name.
+ * @return array Parsed readme.
+ */
+ public function getRemoteReadme($ref = 'master') {
+ $fileContents = $this->getRemoteFile('readme.txt', $ref);
+ if ( empty($fileContents) ) {
+ return array();
+ }
+
+ $parser = new PucReadmeParser();
+ return $parser->parse_readme_contents($fileContents);
+ }
+
+ /**
+ * Get a branch.
+ *
+ * @param string $branchName
+ * @return Puc_v4_Vcs_Reference|null
+ */
+ abstract public function getBranch($branchName);
+
+ /**
+ * Get a specific tag.
+ *
+ * @param string $tagName
+ * @return Puc_v4_Vcs_Reference|null
+ */
+ abstract public function getTag($tagName);
+
+ /**
+ * Get the tag that looks like the highest version number.
+ * (Implementations should skip pre-release versions if possible.)
+ *
+ * @return Puc_v4_Vcs_Reference|null
+ */
+ abstract public function getLatestTag();
+
+ /**
+ * Check if a tag name string looks like a version number.
+ *
+ * @param string $name
+ * @return bool
+ */
+ protected function looksLikeVersion($name) {
+ //Tag names may be prefixed with "v", e.g. "v1.2.3".
+ $name = ltrim($name, 'v');
+
+ //The version string must start with a number.
+ if ( !is_numeric($name) ) {
+ return false;
+ }
+
+ //The goal is to accept any SemVer-compatible or "PHP-standardized" version number.
+ return (preg_match('@^(\d{1,5}?)(\.\d{1,10}?){0,4}?($|[abrdp+_\-]|\s)@i', $name) === 1);
+ }
+
+ /**
+ * Check if a tag appears to be named like a version number.
+ *
+ * @param stdClass $tag
+ * @return bool
+ */
+ protected function isVersionTag($tag) {
+ $property = $this->tagNameProperty;
+ return isset($tag->$property) && $this->looksLikeVersion($tag->$property);
+ }
+
+ /**
+ * Sort a list of tags as if they were version numbers.
+ * Tags that don't look like version number will be removed.
+ *
+ * @param stdClass[] $tags Array of tag objects.
+ * @return stdClass[] Filtered array of tags sorted in descending order.
+ */
+ protected function sortTagsByVersion($tags) {
+ //Keep only those tags that look like version numbers.
+ $versionTags = array_filter($tags, array($this, 'isVersionTag'));
+ //Sort them in descending order.
+ usort($versionTags, array($this, 'compareTagNames'));
+
+ return $versionTags;
+ }
+
+ /**
+ * Compare two tags as if they were version number.
+ *
+ * @param stdClass $tag1 Tag object.
+ * @param stdClass $tag2 Another tag object.
+ * @return int
+ */
+ protected function compareTagNames($tag1, $tag2) {
+ $property = $this->tagNameProperty;
+ if ( !isset($tag1->$property) ) {
+ return 1;
+ }
+ if ( !isset($tag2->$property) ) {
+ return -1;
+ }
+ return -version_compare(ltrim($tag1->$property, 'v'), ltrim($tag2->$property, 'v'));
+ }
+
+ /**
+ * Get the contents of a file from a specific branch or tag.
+ *
+ * @param string $path File name.
+ * @param string $ref
+ * @return null|string Either the contents of the file, or null if the file doesn't exist or there's an error.
+ */
+ abstract public function getRemoteFile($path, $ref = 'master');
+
+ /**
+ * Get the timestamp of the latest commit that changed the specified branch or tag.
+ *
+ * @param string $ref Reference name (e.g. branch or tag).
+ * @return string|null
+ */
+ abstract public function getLatestCommitTime($ref);
+
+ /**
+ * Get the contents of the changelog file from the repository.
+ *
+ * @param string $ref
+ * @param string $localDirectory Full path to the local plugin or theme directory.
+ * @return null|string The HTML contents of the changelog.
+ */
+ public function getRemoteChangelog($ref, $localDirectory) {
+ $filename = $this->findChangelogName($localDirectory);
+ if ( empty($filename) ) {
+ return null;
+ }
+
+ $changelog = $this->getRemoteFile($filename, $ref);
+ if ( $changelog === null ) {
+ return null;
+ }
+
+ /** @noinspection PhpUndefinedClassInspection */
+ return Parsedown::instance()->text($changelog);
+ }
+
+ /**
+ * Guess the name of the changelog file.
+ *
+ * @param string $directory
+ * @return string|null
+ */
+ protected function findChangelogName($directory) {
+ if ( empty($directory) || !is_dir($directory) || ($directory === '.') ) {
+ return null;
+ }
+
+ $possibleNames = array('CHANGES.md', 'CHANGELOG.md', 'changes.md', 'changelog.md');
+ $files = scandir($directory);
+ $foundNames = array_intersect($possibleNames, $files);
+
+ if ( !empty($foundNames) ) {
+ return reset($foundNames);
+ }
+ return null;
+ }
+
+ /**
+ * Set authentication credentials.
+ *
+ * @param $credentials
+ */
+ public function setAuthentication($credentials) {
+ $this->credentials = $credentials;
+ }
+
+ public function isAuthenticationEnabled() {
+ return !empty($this->credentials);
+ }
+
+ /**
+ * @param string $url
+ * @return string
+ */
+ public function signDownloadUrl($url) {
+ return $url;
+ }
+
+ /**
+ * @param string $filterName
+ */
+ public function setHttpFilterName($filterName) {
+ $this->httpFilterName = $filterName;
+ }
+ }
+
+endif;
diff --git a/Puc/v4/Vcs/BaseChecker.php b/Puc/v4/Vcs/BaseChecker.php
new file mode 100644
index 00000000..77a8919d
--- /dev/null
+++ b/Puc/v4/Vcs/BaseChecker.php
@@ -0,0 +1,22 @@
+[^/]+?)/(?P[^/#?&]+?)/?$@', $path, $matches) ) {
+ $this->username = $matches['username'];
+ $this->repository = $matches['repository'];
+ } else {
+ throw new InvalidArgumentException('Invalid BitBucket repository URL: "' . $repositoryUrl . '"');
+ }
+
+ parent::__construct($repositoryUrl, $credentials);
+ }
+
+ /**
+ * Figure out which reference (i.e tag or branch) contains the latest version.
+ *
+ * @param string $configBranch Start looking in this branch.
+ * @return null|Puc_v4_Vcs_Reference
+ */
+ public function chooseReference($configBranch) {
+ $updateSource = null;
+
+ //Check if there's a "Stable tag: 1.2.3" header that points to a valid tag.
+ $updateSource = $this->getStableTag($configBranch);
+
+ //Look for version-like tags.
+ if ( !$updateSource && ($configBranch === 'master') ) {
+ $updateSource = $this->getLatestTag();
+ }
+ //If all else fails, use the specified branch itself.
+ if ( !$updateSource ) {
+ $updateSource = $this->getBranch($configBranch);
+ }
+
+ return $updateSource;
+ }
+
+ public function getBranch($branchName) {
+ $branch = $this->api('/refs/branches/' . $branchName);
+ if ( is_wp_error($branch) || empty($branch) ) {
+ return null;
+ }
+
+ return new Puc_v4_Vcs_Reference(array(
+ 'name' => $branch->name,
+ 'updated' => $branch->target->date,
+ 'downloadUrl' => $this->getDownloadUrl($branch->name),
+ ));
+ }
+
+ /**
+ * Get a specific tag.
+ *
+ * @param string $tagName
+ * @return Puc_v4_Vcs_Reference|null
+ */
+ public function getTag($tagName) {
+ $tag = $this->api('/refs/tags/' . $tagName);
+ if ( is_wp_error($tag) || empty($tag) ) {
+ return null;
+ }
+
+ return new Puc_v4_Vcs_Reference(array(
+ 'name' => $tag->name,
+ 'version' => ltrim($tag->name, 'v'),
+ 'updated' => $tag->target->date,
+ 'downloadUrl' => $this->getDownloadUrl($tag->name),
+ ));
+ }
+
+ /**
+ * Get the tag that looks like the highest version number.
+ *
+ * @return Puc_v4_Vcs_Reference|null
+ */
+ public function getLatestTag() {
+ $tags = $this->api('/refs/tags');
+ if ( !isset($tags, $tags->values) || !is_array($tags->values) ) {
+ return null;
+ }
+
+ //Filter and sort the list of tags.
+ $versionTags = $this->sortTagsByVersion($tags->values);
+
+ //Return the first result.
+ if ( !empty($versionTags) ) {
+ $tag = $versionTags[0];
+ return new Puc_v4_Vcs_Reference(array(
+ 'name' => $tag->name,
+ 'version' => ltrim($tag->name, 'v'),
+ 'updated' => $tag->target->date,
+ 'downloadUrl' => $this->getDownloadUrl($tag->name),
+ ));
+ }
+ return null;
+ }
+
+ /**
+ * Get the tag/ref specified by the "Stable tag" header in the readme.txt of a given branch.
+ *
+ * @param string $branch
+ * @return null|Puc_v4_Vcs_Reference
+ */
+ protected function getStableTag($branch) {
+ $remoteReadme = $this->getRemoteReadme($branch);
+ if ( !empty($remoteReadme['stable_tag']) ) {
+ $tag = $remoteReadme['stable_tag'];
+
+ //You can explicitly opt out of using tags by setting "Stable tag" to
+ //"trunk" or the name of the current branch.
+ if ( ($tag === $branch) || ($tag === 'trunk') ) {
+ return $this->getBranch($branch);
+ }
+
+ return $this->getTag($tag);
+ }
+
+ return null;
+ }
+
+ /**
+ * @param string $ref
+ * @return string
+ */
+ protected function getDownloadUrl($ref) {
+ return sprintf(
+ 'https://bitbucket.org/%s/%s/get/%s.zip',
+ $this->username,
+ $this->repository,
+ $ref
+ );
+ }
+
+ /**
+ * Get the contents of a file from a specific branch or tag.
+ *
+ * @param string $path File name.
+ * @param string $ref
+ * @return null|string Either the contents of the file, or null if the file doesn't exist or there's an error.
+ */
+ public function getRemoteFile($path, $ref = 'master') {
+ $response = $this->api('src/' . $ref . '/' . ltrim($path), '1.0');
+ if ( is_wp_error($response) || !isset($response, $response->data) ) {
+ return null;
+ }
+ return $response->data;
+ }
+
+ /**
+ * Get the timestamp of the latest commit that changed the specified branch or tag.
+ *
+ * @param string $ref Reference name (e.g. branch or tag).
+ * @return string|null
+ */
+ public function getLatestCommitTime($ref) {
+ $response = $this->api('commits/' . $ref);
+ if ( isset($response->values, $response->values[0], $response->values[0]->date) ) {
+ return $response->values[0]->date;
+ }
+ return null;
+ }
+
+ /**
+ * Perform a BitBucket API 2.0 request.
+ *
+ * @param string $url
+ * @param string $version
+ * @return mixed|WP_Error
+ */
+ public function api($url, $version = '2.0') {
+ //printf('Requesting %s
' . "\n", $url);
+
+ $url = implode('/', array(
+ 'https://api.bitbucket.org',
+ $version,
+ 'repositories',
+ $this->username,
+ $this->repository,
+ ltrim($url, '/')
+ ));
+
+ if ( $this->oauth ) {
+ $url = $this->oauth->sign($url,'GET');
+ }
+
+ $options = array('timeout' => 10);
+ if ( !empty($this->httpFilterName) ) {
+ $options = apply_filters($this->httpFilterName, $options);
+ }
+ $response = wp_remote_get($url, $options);
+ if ( is_wp_error($response) ) {
+ return $response;
+ }
+
+ $code = wp_remote_retrieve_response_code($response);
+ $body = wp_remote_retrieve_body($response);
+ if ( $code === 200 ) {
+ $document = json_decode($body);
+ return $document;
+ }
+
+ return new WP_Error(
+ 'puc-bitbucket-http-error',
+ 'BitBucket API error. HTTP status: ' . $code
+ );
+ }
+
+ /**
+ * @param array $credentials
+ */
+ public function setAuthentication($credentials) {
+ parent::setAuthentication($credentials);
+
+ if ( !empty($credentials) && !empty($credentials['consumer_key']) ) {
+ $this->oauth = new Puc_v4_OAuthSignature(
+ $credentials['consumer_key'],
+ $credentials['consumer_secret']
+ );
+ } else {
+ $this->oauth = null;
+ }
+ }
+
+ public function signDownloadUrl($url) {
+ //Add authentication data to download URLs. Since OAuth signatures incorporate
+ //timestamps, we have to do this immediately before inserting the update. Otherwise
+ //authentication could fail due to a stale timestamp.
+ if ( $this->oauth ) {
+ $url = $this->oauth->sign($url);
+ }
+ return $url;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Vcs/GitHubApi.php b/Puc/v4/Vcs/GitHubApi.php
new file mode 100644
index 00000000..07cfcd23
--- /dev/null
+++ b/Puc/v4/Vcs/GitHubApi.php
@@ -0,0 +1,274 @@
+[^/]+?)/(?P[^/#?&]+?)/?$@', $path, $matches) ) {
+ $this->userName = $matches['username'];
+ $this->repositoryName = $matches['repository'];
+ } else {
+ throw new InvalidArgumentException('Invalid GitHub repository URL: "' . $repositoryUrl . '"');
+ }
+
+ parent::__construct($repositoryUrl, $accessToken);
+ }
+
+ /**
+ * Get the latest release from GitHub.
+ *
+ * @return Puc_v4_Vcs_Reference|null
+ */
+ public function getLatestRelease() {
+ $release = $this->api('/repos/:user/:repo/releases/latest');
+ if ( is_wp_error($release) || !is_object($release) || !isset($release->tag_name) ) {
+ return null;
+ }
+
+ $reference = new Puc_v4_Vcs_Reference(array(
+ 'name' => $release->tag_name,
+ 'version' => ltrim($release->tag_name, 'v'), //Remove the "v" prefix from "v1.2.3".
+ 'downloadUrl' => $this->signDownloadUrl($release->zipball_url),
+ 'updated' => $release->created_at,
+ ));
+
+ if ( !empty($release->body) ) {
+ /** @noinspection PhpUndefinedClassInspection */
+ $reference->changelog = Parsedown::instance()->text($release->body);
+ }
+ if ( isset($release->assets[0]) ) {
+ $reference->downloadCount = $release->assets[0]->download_count;
+ }
+
+ return $reference;
+ }
+
+ /**
+ * Get the tag that looks like the highest version number.
+ *
+ * @return Puc_v4_Vcs_Reference|null
+ */
+ public function getLatestTag() {
+ $tags = $this->api('/repos/:user/:repo/tags');
+
+ if ( is_wp_error($tags) || empty($tags) || !is_array($tags) ) {
+ return null;
+ }
+
+ $versionTags = $this->sortTagsByVersion($tags);
+ if ( empty($versionTags) ) {
+ return null;
+ }
+
+ $tag = $versionTags[0];
+ return new Puc_v4_Vcs_Reference(array(
+ 'name' => $tag->name,
+ 'version' => ltrim($tag->name, 'v'),
+ 'downloadUrl' => $this->signDownloadUrl($tag->zipball_url),
+ ));
+ }
+
+ /**
+ * Get a branch by name.
+ *
+ * @param string $branchName
+ * @return null|Puc_v4_Vcs_Reference
+ */
+ public function getBranch($branchName) {
+ $branch = $this->api('/repos/:user/:repo/branches/' . $branchName);
+ if ( is_wp_error($branch) || empty($branch) ) {
+ return null;
+ }
+
+ $reference = new Puc_v4_Vcs_Reference(array(
+ 'name' => $branch->name,
+ 'downloadUrl' => $this->buildArchiveDownloadUrl($branch->name),
+ ));
+
+ if ( isset($branch->commit, $branch->commit->commit, $branch->commit->commit->author->date) ) {
+ $reference->updated = $branch->commit->commit->author->date;
+ }
+
+ return $reference;
+ }
+
+ /**
+ * Get the latest commit that changed the specified file.
+ *
+ * @param string $filename
+ * @param string $ref Reference name (e.g. branch or tag).
+ * @return StdClass|null
+ */
+ public function getLatestCommit($filename, $ref = 'master') {
+ $commits = $this->api(
+ '/repos/:user/:repo/commits',
+ array(
+ 'path' => $filename,
+ 'sha' => $ref,
+ )
+ );
+ if ( !is_wp_error($commits) && is_array($commits) && isset($commits[0]) ) {
+ return $commits[0];
+ }
+ return null;
+ }
+
+ /**
+ * Get the timestamp of the latest commit that changed the specified branch or tag.
+ *
+ * @param string $ref Reference name (e.g. branch or tag).
+ * @return string|null
+ */
+ public function getLatestCommitTime($ref) {
+ $commits = $this->api('/repos/:user/:repo/commits', array('sha' => $ref));
+ if ( !is_wp_error($commits) && is_array($commits) && isset($commits[0]) ) {
+ return $commits[0]->commit->author->date;
+ }
+ return null;
+ }
+
+ /**
+ * Perform a GitHub API request.
+ *
+ * @param string $url
+ * @param array $queryParams
+ * @return mixed|WP_Error
+ */
+ protected function api($url, $queryParams = array()) {
+ $variables = array(
+ 'user' => $this->userName,
+ 'repo' => $this->repositoryName,
+ );
+ foreach ($variables as $name => $value) {
+ $url = str_replace('/:' . $name, '/' . urlencode($value), $url);
+ }
+ $url = 'https://api.github.com' . $url;
+
+ if ( !empty($this->accessToken) ) {
+ $queryParams['access_token'] = $this->accessToken;
+ }
+ if ( !empty($queryParams) ) {
+ $url = add_query_arg($queryParams, $url);
+ }
+
+ $options = array('timeout' => 10);
+ if ( !empty($this->httpFilterName) ) {
+ $options = apply_filters($this->httpFilterName, $options);
+ }
+ $response = wp_remote_get($url, $options);
+ if ( is_wp_error($response) ) {
+ return $response;
+ }
+
+ $code = wp_remote_retrieve_response_code($response);
+ $body = wp_remote_retrieve_body($response);
+ if ( $code === 200 ) {
+ $document = json_decode($body);
+ return $document;
+ }
+
+ return new WP_Error(
+ 'puc-github-http-error',
+ 'GitHub API error. HTTP status: ' . $code
+ );
+ }
+
+ /**
+ * Get the contents of a file from a specific branch or tag.
+ *
+ * @param string $path File name.
+ * @param string $ref
+ * @return null|string Either the contents of the file, or null if the file doesn't exist or there's an error.
+ */
+ public function getRemoteFile($path, $ref = 'master') {
+ $apiUrl = '/repos/:user/:repo/contents/' . $path;
+ $response = $this->api($apiUrl, array('ref' => $ref));
+
+ if ( is_wp_error($response) || !isset($response->content) || ($response->encoding !== 'base64') ) {
+ return null;
+ }
+ return base64_decode($response->content);
+ }
+
+ /**
+ * Generate a URL to download a ZIP archive of the specified branch/tag/etc.
+ *
+ * @param string $ref
+ * @return string
+ */
+ public function buildArchiveDownloadUrl($ref = 'master') {
+ $url = sprintf(
+ 'https://api.github.com/repos/%1$s/%2$s/zipball/%3$s',
+ urlencode($this->userName),
+ urlencode($this->repositoryName),
+ urlencode($ref)
+ );
+ if ( !empty($this->accessToken) ) {
+ $url = $this->signDownloadUrl($url);
+ }
+ return $url;
+ }
+
+ /**
+ * Get a specific tag.
+ *
+ * @param string $tagName
+ * @return Puc_v4_Vcs_Reference|null
+ */
+ public function getTag($tagName) {
+ //The current GitHub update checker doesn't use getTag, so I didn't bother to implement it.
+ throw new LogicException('The ' . __METHOD__ . ' method is not implemented and should not be used.');
+ }
+
+ public function setAuthentication($credentials) {
+ parent::setAuthentication($credentials);
+ $this->accessToken = is_string($credentials) ? $credentials : null;
+ }
+
+ /**
+ * Figure out which reference (i.e tag or branch) contains the latest version.
+ *
+ * @param string $configBranch Start looking in this branch.
+ * @return null|Puc_v4_Vcs_Reference
+ */
+ public function chooseReference($configBranch) {
+ $updateSource = null;
+
+ if ( $configBranch === 'master' ) {
+ //Use the latest release.
+ $updateSource = $this->getLatestRelease();
+ if ( $updateSource === null ) {
+ //Failing that, use the tag with the highest version number.
+ $updateSource = $this->getLatestTag();
+ }
+ }
+ //Alternatively, just use the branch itself.
+ if ( empty($updateSource) ) {
+ $updateSource = $this->getBranch($configBranch);
+ }
+
+ return $updateSource;
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Vcs/PluginUpdateChecker.php b/Puc/v4/Vcs/PluginUpdateChecker.php
new file mode 100644
index 00000000..68232d17
--- /dev/null
+++ b/Puc/v4/Vcs/PluginUpdateChecker.php
@@ -0,0 +1,198 @@
+api = $api;
+ $this->api->setHttpFilterName($this->getUniqueName('request_info_options'));
+
+ parent::__construct($api->getRepositoryUrl(), $pluginFile, $slug, $checkPeriod, $optionName, $muPluginFile);
+ }
+
+ public function requestInfo($unusedParameter = null) {
+ //We have to make several remote API requests to gather all the necessary info
+ //which can take a while on slow networks.
+ set_time_limit(60);
+
+ $api = $this->api;
+
+ $info = new Puc_v4_Plugin_Info();
+ $info->filename = $this->pluginFile;
+ $info->slug = $this->slug;
+
+ $this->setInfoFromHeader($this->getPluginHeader(), $info);
+
+ //Pick a branch or tag.
+ $updateSource = $api->chooseReference($this->branch);
+ if ( $updateSource ) {
+ $ref = $updateSource->name;
+ $info->version = $updateSource->version;
+ $info->last_updated = $updateSource->updated;
+ $info->download_url = $updateSource->downloadUrl;
+
+ if ( !empty($updateSource->changelog) ) {
+ $info->sections['changelog'] = $updateSource->changelog;
+ }
+ if ( isset($updateSource->downloadCount) ) {
+ $info->downloaded = $updateSource->downloadCount;
+ }
+ } else {
+ //There's probably a network problem or an authentication error.
+ return null;
+ }
+
+ //Get headers from the main plugin file in this branch/tag. Its "Version" header and other metadata
+ //are what the WordPress install will actually see after upgrading, so they take precedence over releases/tags.
+ $mainPluginFile = basename($this->pluginFile);
+ $remotePlugin = $api->getRemoteFile($mainPluginFile, $ref);
+ if ( !empty($remotePlugin) ) {
+ $remoteHeader = $this->getFileHeader($remotePlugin);
+ $this->setInfoFromHeader($remoteHeader, $info);
+ }
+
+ //Try parsing readme.txt. If it's formatted according to WordPress.org standards, it will contain
+ //a lot of useful information like the required/tested WP version, changelog, and so on.
+ if ( $this->readmeTxtExistsLocally() ) {
+ $this->setInfoFromRemoteReadme($ref, $info);
+ }
+
+ //The changelog might be in a separate file.
+ if ( empty($info->sections['changelog']) ) {
+ $info->sections['changelog'] = $api->getRemoteChangelog($ref, dirname($this->getAbsolutePath()));
+ if ( empty($info->sections['changelog']) ) {
+ $info->sections['changelog'] = __('There is no changelog available.', 'plugin-update-checker');
+ }
+ }
+
+ if ( empty($info->last_updated) ) {
+ //Fetch the latest commit that changed the tag or branch and use it as the "last_updated" date.
+ $latestCommitTime = $api->getLatestCommitTime($ref);
+ if ( $latestCommitTime !== null ) {
+ $info->last_updated = $latestCommitTime;
+ }
+ }
+
+ $info = apply_filters($this->getUniqueName('request_info_result'), $info, null);
+ return $info;
+ }
+
+ /**
+ * Check if the currently installed version has a readme.txt file.
+ *
+ * @return bool
+ */
+ protected function readmeTxtExistsLocally() {
+ $pluginDirectory = dirname($this->pluginAbsolutePath);
+ if ( empty($this->pluginAbsolutePath) || !is_dir($pluginDirectory) || ($pluginDirectory === '.') ) {
+ return false;
+ }
+ return is_file($pluginDirectory . '/readme.txt');
+ }
+
+ /**
+ * Copy plugin metadata from a file header to a Plugin Info object.
+ *
+ * @param array $fileHeader
+ * @param Puc_v4_Plugin_Info $pluginInfo
+ */
+ protected function setInfoFromHeader($fileHeader, $pluginInfo) {
+ $headerToPropertyMap = array(
+ 'Version' => 'version',
+ 'Name' => 'name',
+ 'PluginURI' => 'homepage',
+ 'Author' => 'author',
+ 'AuthorName' => 'author',
+ 'AuthorURI' => 'author_homepage',
+
+ 'Requires WP' => 'requires',
+ 'Tested WP' => 'tested',
+ 'Requires at least' => 'requires',
+ 'Tested up to' => 'tested',
+ );
+ foreach ($headerToPropertyMap as $headerName => $property) {
+ if ( isset($fileHeader[$headerName]) && !empty($fileHeader[$headerName]) ) {
+ $pluginInfo->$property = $fileHeader[$headerName];
+ }
+ }
+
+ if ( !empty($fileHeader['Description']) ) {
+ $pluginInfo->sections['description'] = $fileHeader['Description'];
+ }
+ }
+
+ /**
+ * Copy plugin metadata from the remote readme.txt file.
+ *
+ * @param string $ref GitHub tag or branch where to look for the readme.
+ * @param Puc_v4_Plugin_Info $pluginInfo
+ */
+ protected function setInfoFromRemoteReadme($ref, $pluginInfo) {
+ $readme = $this->api->getRemoteReadme($ref);
+ if ( empty($readme) ) {
+ return;
+ }
+
+ if ( isset($readme['sections']) ) {
+ $pluginInfo->sections = array_merge($pluginInfo->sections, $readme['sections']);
+ }
+ if ( !empty($readme['tested_up_to']) ) {
+ $pluginInfo->tested = $readme['tested_up_to'];
+ }
+ if ( !empty($readme['requires_at_least']) ) {
+ $pluginInfo->requires = $readme['requires_at_least'];
+ }
+
+ if ( isset($readme['upgrade_notice'], $readme['upgrade_notice'][$pluginInfo->version]) ) {
+ $pluginInfo->upgrade_notice = $readme['upgrade_notice'][$pluginInfo->version];
+ }
+ }
+
+ public function setBranch($branch) {
+ $this->branch = $branch;
+ return $this;
+ }
+
+ public function setAuthentication($credentials) {
+ $this->api->setAuthentication($credentials);
+ return $this;
+ }
+
+ public function getUpdate() {
+ $update = parent::getUpdate();
+
+ if ( isset($update) && !empty($update->download_url) ) {
+ $update->download_url = $this->api->signDownloadUrl($update->download_url);
+ }
+
+ return $update;
+ }
+
+ public function onDisplayConfiguration($panel) {
+ parent::onDisplayConfiguration($panel);
+ $panel->row('Branch', $this->branch);
+ $panel->row('Authentication enabled', $this->api->isAuthenticationEnabled() ? 'Yes' : 'No');
+ $panel->row('API client', get_class($this->api));
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Vcs/Reference.php b/Puc/v4/Vcs/Reference.php
new file mode 100644
index 00000000..501955ff
--- /dev/null
+++ b/Puc/v4/Vcs/Reference.php
@@ -0,0 +1,49 @@
+properties = $properties;
+ }
+
+ /**
+ * @param string $name
+ * @return mixed|null
+ */
+ function __get($name) {
+ return array_key_exists($name, $this->properties) ? $this->properties[$name] : null;
+ }
+
+ /**
+ * @param string $name
+ * @param mixed $value
+ */
+ function __set($name, $value) {
+ $this->properties[$name] = $value;
+ }
+
+ /**
+ * @param string $name
+ * @return bool
+ */
+ function __isset($name) {
+ return isset($this->properties[$name]);
+ }
+
+ }
+
+endif;
\ No newline at end of file
diff --git a/Puc/v4/Vcs/ThemeUpdateChecker.php b/Puc/v4/Vcs/ThemeUpdateChecker.php
new file mode 100644
index 00000000..1f546518
--- /dev/null
+++ b/Puc/v4/Vcs/ThemeUpdateChecker.php
@@ -0,0 +1,101 @@
+api = $api;
+ $this->api->setHttpFilterName($this->getUniqueName('request_update_options'));
+
+ parent::__construct($api->getRepositoryUrl(), $stylesheet, $customSlug, $checkPeriod, $optionName);
+ }
+
+ public function requestUpdate() {
+ $api = $this->api;
+
+ $update = new Puc_v4_Theme_Update();
+ $update->slug = $this->slug;
+
+ //Figure out which reference (tag or branch) we'll use to get the latest version of the theme.
+ $updateSource = $api->chooseReference($this->branch);
+ if ( $updateSource ) {
+ $ref = $updateSource->name;
+ $update->download_url = $updateSource->downloadUrl;
+ } else {
+ $ref = $this->branch;
+ }
+
+ //Get headers from the main stylesheet in this branch/tag. Its "Version" header and other metadata
+ //are what the WordPress install will actually see after upgrading, so they take precedence over releases/tags.
+ $remoteHeader = $this->getFileHeader($api->getRemoteFile('style.css', $ref));
+ $update->version = Puc_v4_Utils::findNotEmpty(array(
+ $remoteHeader['Version'],
+ Puc_v4_Utils::get($updateSource, 'version'),
+ ));
+
+ //The details URL defaults to the Theme URI header or the repository URL.
+ $update->details_url = Puc_v4_Utils::findNotEmpty(array(
+ $remoteHeader['ThemeURI'],
+ $this->theme->get('ThemeURI'),
+ $this->metadataUrl,
+ ));
+
+ if ( empty($update->version) ) {
+ //It looks like we didn't find a valid update after all.
+ $update = null;
+ }
+
+ $update = $this->filterUpdateResult($update);
+ return $update;
+ }
+
+ //FIXME: This is duplicated code. Both theme and plugin subclasses that use VCS share these methods.
+
+ public function setBranch($branch) {
+ $this->branch = $branch;
+ return $this;
+ }
+
+ public function setAuthentication($credentials) {
+ $this->api->setAuthentication($credentials);
+ return $this;
+ }
+
+ public function getUpdate() {
+ $update = parent::getUpdate();
+
+ if ( isset($update) && !empty($update->download_url) ) {
+ $update->download_url = $this->api->signDownloadUrl($update->download_url);
+ }
+
+ return $update;
+ }
+
+ public function onDisplayConfiguration($panel) {
+ parent::onDisplayConfiguration($panel);
+ $panel->row('Branch', $this->branch);
+ $panel->row('Authentication enabled', $this->api->isAuthenticationEnabled() ? 'Yes' : 'No');
+ $panel->row('API client', get_class($this->api));
+ }
+ }
+
+endif;
\ No newline at end of file
diff --git a/README.md b/README.md
index 9532a9a6..4092e5ef 100644
--- a/README.md
+++ b/README.md
@@ -1,93 +1,152 @@
Plugin Update Checker
=====================
-This is a custom update checker library for WordPress plugins. It lets you add automatic update notifications and one-click upgrades to your commercial and private plugins. All you need to do is put your plugin details in a JSON file, place the file on your server, and pass the URL to the library. The library periodically checks the URL to see if there's a new version available and displays an update notification to the user if necessary.
+This is a custom update checker library for WordPress plugins and themes. It lets you add automatic update notifications and one-click upgrades to your commercial plugins, private themes, and so on. All you need to do is put your plugin/theme details in a JSON file, place the file on your server, and pass the URL to the library. The library periodically checks the URL to see if there's a new version available and displays an update notification to the user if necessary.
-From the users' perspective, it works just like with plugins hosted on WordPress.org. The update checker uses the default plugin upgrade UI that will already be familiar to most WordPress users.
+From the users' perspective, it works just like with plugins and themes hosted on WordPress.org. The update checker uses the default upgrade UI that is familiar to most WordPress users.
-[See this blog post](http://w-shadow.com/blog/2010/09/02/automatic-updates-for-any-plugin/) for more information and usage instructions.
+
+
+**Table of Contents**
-Getting Started
----------------
+- [Getting Started](#getting-started)
+ - [Self-hosted Plugins and Themes](#self-hosted-plugins-and-themes)
+ - [How to Release an Update](#how-to-release-an-update)
+ - [Notes](#notes)
+ - [GitHub Integration](#github-integration)
+ - [How to Release an Update](#how-to-release-an-update-1)
+ - [Notes](#notes-1)
+ - [BitBucket Integration](#bitbucket-integration)
+ - [How to Release an Update](#how-to-release-an-update-2)
+- [Resources](#resources)
-### Self-hosted Plugins
+
-1. Make a JSON file that describes your plugin. Here's a minimal example:
+Getting Started
+---------------
- ```json
- {
- "name" : "My Cool Plugin",
- "version" : "2.0",
- "author" : "John Smith",
- "download_url" : "http://example.com/plugins/my-cool-plugin.zip",
- "sections" : {
- "description" : "Plugin description here. You can use HTML."
- }
- }
- ```
- See [this table](https://spreadsheets.google.com/pub?key=0AqP80E74YcUWdEdETXZLcXhjd2w0cHMwX2U1eDlWTHc&authkey=CK7h9toK&hl=en&single=true&gid=0&output=html) for a full list of supported fields.
-2. Upload this file to a publicly accessible location.
-3. Download [the update checker](https://github.com/YahnisElsts/plugin-update-checker/releases/latest), unzip the archive and copy the `plugin-update-checker` directory to your plugin.
-4. Add the following code to the main plugin file:
+### Self-hosted Plugins and Themes
+
+1. Download [the latest release](https://github.com/YahnisElsts/plugin-update-checker/releases/latest) and copy the `plugin-update-checker` directory to your plugin or theme.
+2. Go to the `examples` subdirectory and open the .json file that fits your project type. Replace the placeholder data with your plugin/theme details.
+ - Plugin example:
+
+ ```json
+ {
+ "name" : "Plugin Name",
+ "version" : "2.0",
+ "download_url" : "http://example.com/plugin-name-2.0.zip",
+ "sections" : {
+ "description" : "Plugin description here. You can use HTML."
+ }
+ }
+ ```
+
+ This is a minimal example that leaves out optional fields. See [this table](https://spreadsheets.google.com/pub?key=0AqP80E74YcUWdEdETXZLcXhjd2w0cHMwX2U1eDlWTHc&authkey=CK7h9toK&hl=en&single=true&gid=0&output=html) for a full list of supported fields and their descriptions.
+ - Theme example:
+
+ ```json
+ {
+ "version": "2.0",
+ "details_url": "http://example.com/version-2.0-details.html",
+ "download_url": "http://example.com/example-theme-2.0.zip"
+ }
+ ```
+
+ This is actually a complete example that shows all theme-related fields. `version` and `download_url` should be self-explanatory. The `details_url` key specifies the page that the user will see if they click the "View version 1.2.3 details" link in an update notification.
+3. Upload the JSON file to a publicly accessible location.
+4. Add the following code to the main plugin file or to the `functions.php` file:
```php
- require 'plugin-update-checker/plugin-update-checker.php';
- $myUpdateChecker = PucFactory::buildUpdateChecker(
- 'http://example.com/path/to/metadata.json',
+ require 'path/to/plugin-update-checker/plugin-update-checker.php';
+ $myUpdateChecker = Puc_v4_Factory::buildUpdateChecker(
+ 'http://example.com/path/to/details.json',
__FILE__,
- 'unique-plugin-slug'
+ 'unique-plugin-or-theme-slug'
);
```
-#### Notes
-- You can use [wp-update-server](https://github.com/YahnisElsts/wp-update-server) to automatically generate JSON metadata from ZIP packages.
-- The second argument passed to `buildUpdateChecker` should be the full path to the main plugin file.
-- The `$slug` argument is optional but recommended. If it's omitted, the update checker will use the name of the main plugin file as the slug (e.g. `my-cool-plugin.php` → `my-cool-plugin`). This can lead to conflicts if your plugin has a generic file name like `plugin.php`.
-- There are more options available - see the [blog](http://w-shadow.com/blog/2010/09/02/automatic-updates-for-any-plugin/) for details.
+#### How to Release an Update
-### Plugins Hosted on GitHub
+Change the `version` number in the JSON file and make sure that `download_url` points to the latest version. Update the other fields if necessary. Tip: You can use [wp-update-server](https://github.com/YahnisElsts/wp-update-server) to automate this process.
-*(GitHub support is experimental.)*
+By default, the library will check the specified URL for changes every 12 hours. You can force it to check immediately by clicking the "Check Now" link on the "Plugins" page (it's next to the "Visit plugin site" link). Themes don't get a "check now" link, but you can also trigger an update check like this:
+
+ 1. Install [Debug Bar](https://srd.wordpress.org/plugins/debug-bar/).
+ 2. Click the "Debug" menu in the Admin Bar (a.k.a Toolbar).
+ 3. Open the "PUC (your-slug)" panel.
+ 4. Click the "Check Now" button.
-1. Download [the latest release](https://github.com/YahnisElsts/plugin-update-checker/releases/latest), unzip it and copy the `plugin-update-checker` directory to your plugin.
-2. Add the following code to the main file of your plugin:
+#### Notes
+- The second argument passed to `buildUpdateChecker` must be the absolute path to the main plugin file or any file in the theme directory. If you followed the "getting started" instructions, you can just use the `__FILE__` constant.
+- The third argument - i.e. the slug - is optional but recommended. If it's omitted, the update checker will use the name of the main plugin file as the slug (e.g. `my-cool-plugin.php` → `my-cool-plugin`). This can lead to conflicts if your plugin has a generic file name like `plugin.php`.
+
+ This doesn't affect themes because PUC uses the theme directory name as the default slug. Still, if you're planning to use the slug in your own code - e.g. to filter updates or override update checker behaviour - it can be a good idea to set it explicitly.
+
+### GitHub Integration
+
+1. Download [the latest release](https://github.com/YahnisElsts/plugin-update-checker/releases/latest) and copy the `plugin-update-checker` directory to your plugin or theme.
+2. Add the following code to the main plugin file or `functions.php`:
```php
require 'plugin-update-checker/plugin-update-checker.php';
- $className = PucFactory::getLatestClassVersion('PucGitHubChecker');
- $myUpdateChecker = new $className(
- 'https://github.com/user-name/plugin-repo-name/',
+ $myUpdateChecker = Puc_v4_Factory::buildUpdateChecker(
+ 'https://github.com/user-name/repo-name/',
__FILE__,
- 'master'
+ 'unique-plugin-or-theme-slug'
);
+
+ //Optional: If you're using a private repository, specify the access token like this:
+ $myUpdateChecker->setAuthentication('your-token-here');
+
+ //Optional: Set the branch that contains the stable release.
+ $myUpdateChecker->setBranch('stable-branch-name');
```
- The third argument specifies the branch to use for updating your plugin. The default is `master`. If the branch name is omitted or set to `master`, the update checker will use the latest release or tag (if available). Otherwise it will use the specified branch.
-3. Optional: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt). The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link.
+3. Plugins only: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt) to your repository. The contents of this file will be shown when the user clicks the "View version 1.2.3 details" link.
+
+#### How to Release an Update
+
+This library supports a couple of different ways to release updates on GitHub. Pick the one that best fits your workflow.
+
+- **GitHub releases**
+
+ Create a new release using the "Releases" feature on GitHub. The tag name and release title don't matter. The description is optional, but if you do provide one, it will be displayed when the user clicks the "View version x.y.z details" link on the "Plugins" page. Note that PUC ignores releases marked as "This is a pre-release".
+
+- **Tags**
+
+ To release version 1.2.3, create a new Git tag named `v1.2.3` or `1.2.3`. That's it.
+
+ PUC doesn't require strict adherence to [SemVer](http://semver.org/). These are all valid tag names: `v1.2.3`, `v1.2-foo`, `1.2.3_rc1-ABC`, `1.2.3.4.5`. However, be warned that it's not smart enough to filter out alpha/beta/RC versions. If that's a problem, you might want to use GitHub releases or branches instead.
+
+- **Stable branch**
+
+ Point the update checker at a stable, production-ready branch:
+ ```php
+ $updateChecker->setBranch('branch-name');
+ ```
+ PUC will periodically check the `Version` header in the main plugin file or `style.css` and display a notification if it's greater than the installed version.
+
+ Caveat: If you set the branch to `master` (the default), the update checker will look for recent releases and tags first. It'll only use the `master` branch if it doesn't find anything else suitable.
#### Notes
-If your GitHub repository requires an access token, you can specify it like this:
-```php
-$myUpdateChecker->setAccessToken('your-token-here');
-```
-
-The GitHub version of the library will pull update details from the following parts of a release/tag/branch:
+The library will pull update details from the following parts of a release/tag/branch:
+- Version number
+ - The "Version" plugin header.
+ - The latest GitHub release or tag name.
- Changelog
- The "Changelog" section of `readme.txt`.
- One of the following files:
CHANGES.md, CHANGELOG.md, changes.md, changelog.md
- - Release notes.
-- Version number
- - The "Version" plugin header.
- - The latest release or tag name.
+ - GitHub release notes.
- Required and tested WordPress versions
- The "Requires at least" and "Tested up to" fields in `readme.txt`.
- The following plugin headers:
`Required WP`, `Tested WP`, `Requires at least`, `Tested up to`
- "Last updated" timestamp
- - The creation timestamp of the latest release.
- - The latest commit of the selected tag or branch that changed the main plugin file.
+ - The creation timestamp of the latest GitHub release.
+ - The latest commit in the selected tag or branch.
- Number of downloads
- The `download_count` statistic of the latest release.
- If you're not using GitHub releases, there will be no download stats.
@@ -97,11 +156,65 @@ The GitHub version of the library will pull update details from the following pa
- Local plugin headers (i.e. the currently installed version).
- Ratings, banners, screenshots
- Not supported.
+
+### BitBucket Integration
+
+1. Download [the latest release](https://github.com/YahnisElsts/plugin-update-checker/releases/latest) and copy the `plugin-update-checker` directory to your plugin or theme.
+2. Add the following code to the main plugin file or `functions.php`:
+
+ ```php
+ require 'plugin-update-checker/plugin-update-checker.php';
+ $myUpdateChecker = Puc_v4_Factory::buildUpdateChecker(
+ 'https://bitbucket.org/user-name/repo-name',
+ __FILE__,
+ 'unique-plugin-or-theme-slug'
+ );
+
+ //Optional: If you're using a private repository, create an OAuth consumer
+ //and set the authentication credentials like this:
+ $myUpdateChecker->setAuthentication(array(
+ 'consumer_key' => '...',
+ 'consumer_secret' => '...',
+ ));
+
+ //Optional: Set the branch that contains the stable release.
+ $myUpdateChecker->setBranch('stable-branch-name');
+ ```
+3. Optional: Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt) to your repository. For plugins, the contents of this file will be shown when the user clicks the "View version 1.2.3 details" link.
+
+#### How to Release an Update
+
+BitBucket doesn't have an equivalent to GitHub's releases, so the process is slightly different. You can use any of the following approaches:
+
+- **`Stable tag` header**
+
+ This is the recommended approach if you're using tags to mark each version. Add a `readme.txt` file formatted according to the [WordPress.org plugin readme standard](https://wordpress.org/plugins/about/readme.txt) to your repository. Set the "stable tag" header to the tag that represents the latest release. Example:
+ ```text
+ Stable tag: v1.2.3
+ ```
+ The tag doesn't have to start with a "v" or follow any particular format. You can use any name you like as long as it's a valid Git tag.
+
+ Tip: If you explicitly set a stable branch, the update checker will look for a `readme.txt` in that branch. Otherwise it will only look at the `master` branch.
+
+- **Tags**
+
+ You can skip the "stable tag" bit and just create a new Git tag named `v1.2.3` or `1.2.3`. The update checker will look at the most recent tags and pick the one that looks like the highest version number.
+
+ PUC doesn't require strict adherence to [SemVer](http://semver.org/). These are all valid tag names: `v1.2.3`, `v1.2-foo`, `1.2.3_rc1-ABC`, `1.2.3.4.5`. However, be warned that it's not smart enough to filter out alpha/beta/RC versions.
+
+- **Stable branch**
+
+ Point the update checker at a stable, production-ready branch:
+ ```php
+ $updateChecker->setBranch('branch-name');
+ ```
+ PUC will periodically check the `Version` header in the main plugin file or `style.css` and display a notification if it's greater than the installed version. Caveat: If you set the branch to `master`, the update checker will still look for tags first.
Resources
---------
-- [Theme Update Checker](http://w-shadow.com/blog/2011/06/02/automatic-updates-for-commercial-themes/)
+- [This blog post](http://w-shadow.com/blog/2010/09/02/automatic-updates-for-any-plugin/) has more information about the update checker API. *Slightly out of date.*
- [Debug Bar](https://wordpress.org/plugins/debug-bar/) - useful for testing and debugging the update checker.
- [Securing download links](http://w-shadow.com/blog/2013/03/19/plugin-updates-securing-download-links/) - a general overview.
-- [A GUI for entering download credentials](http://open-tools.net/documentation/tutorial-automatic-updates.html#wordpress)
\ No newline at end of file
+- [A GUI for entering download credentials](http://open-tools.net/documentation/tutorial-automatic-updates.html#wordpress)
+- [Theme Update Checker](http://w-shadow.com/blog/2011/06/02/automatic-updates-for-commercial-themes/) - an older, theme-only variant of this update checker.
diff --git a/composer.json b/composer.json
index 8d1d4d31..22fc59b5 100644
--- a/composer.json
+++ b/composer.json
@@ -1,8 +1,8 @@
{
"name": "yahnis-elsts/plugin-update-checker",
"type": "library",
- "description": "A custom update checker for WordPress plugins. Useful if you can't host your plugin in the official WP plugin repository but still want it to support automatic plugin updates.",
- "keywords": ["wordpress", "plugin updates", "automatic updates"],
+ "description": "A custom update checker for WordPress plugins and themes. Useful if you can't host your plugin in the official WP repository but still want it to support automatic updates.",
+ "keywords": ["wordpress", "plugin updates", "automatic updates", "theme updates"],
"homepage": "https://github.com/YahnisElsts/plugin-update-checker/",
"license": "MIT",
"authors": [
diff --git a/css/puc-debug-bar.css b/css/puc-debug-bar.css
index 96756850..d2ddca37 100644
--- a/css/puc-debug-bar.css
+++ b/css/puc-debug-bar.css
@@ -1,4 +1,4 @@
-.puc-debug-bar-panel pre {
+.puc-debug-bar-panel-v4 pre {
margin-top: 0;
}
diff --git a/debug-bar-panel.php b/debug-bar-panel.php
deleted file mode 100644
index c0ad489b..00000000
--- a/debug-bar-panel.php
+++ /dev/null
@@ -1,146 +0,0 @@
-';
-
- public function __construct($updateChecker) {
- $this->updateChecker = $updateChecker;
- $title = sprintf(
- '',
- esc_attr($this->updateChecker->slug),
- $this->updateChecker->slug
- );
- parent::Debug_Bar_Panel($title);
- }
-
- public function render() {
- printf(
- '',
- esc_attr($this->updateChecker->slug),
- esc_attr(wp_create_nonce('puc-ajax'))
- );
-
- $this->displayConfiguration();
- $this->displayStatus();
- $this->displayCurrentUpdate();
-
- echo '
';
- }
-
- private function displayConfiguration() {
- echo 'Configuration
';
- echo '';
- $this->row('Plugin file', htmlentities($this->updateChecker->pluginFile));
- $this->row('Slug', htmlentities($this->updateChecker->slug));
- $this->row('DB option', htmlentities($this->updateChecker->optionName));
-
- $requestInfoButton = '';
- if ( function_exists('get_submit_button') ) {
- $requestInfoButton = get_submit_button('Request Info', 'secondary', 'puc-request-info-button', false, array('id' => 'puc-request-info-button-' . $this->updateChecker->slug));
- }
- $this->row('Metadata URL', htmlentities($this->updateChecker->metadataUrl) . ' ' . $requestInfoButton . $this->responseBox);
-
- $scheduler = $this->updateChecker->scheduler;
- if ( $scheduler->checkPeriod > 0 ) {
- $this->row('Automatic checks', 'Every ' . $scheduler->checkPeriod . ' hours');
- } else {
- $this->row('Automatic checks', 'Disabled');
- }
-
- if ( isset($scheduler->throttleRedundantChecks) ) {
- if ( $scheduler->throttleRedundantChecks && ($scheduler->checkPeriod > 0) ) {
- $this->row(
- 'Throttling',
- sprintf(
- 'Enabled. If an update is already available, check for updates every %1$d hours instead of every %2$d hours.',
- $scheduler->throttledCheckPeriod,
- $scheduler->checkPeriod
- )
- );
- } else {
- $this->row('Throttling', 'Disabled');
- }
- }
- echo '
';
- }
-
- private function displayStatus() {
- echo 'Status
';
- echo '';
- $state = $this->updateChecker->getUpdateState();
- $checkNowButton = '';
- if ( function_exists('get_submit_button') ) {
- $checkNowButton = get_submit_button('Check Now', 'secondary', 'puc-check-now-button', false, array('id' => 'puc-check-now-button-' . $this->updateChecker->slug));
- }
-
- if ( isset($state, $state->lastCheck) ) {
- $this->row('Last check', $this->formatTimeWithDelta($state->lastCheck) . ' ' . $checkNowButton . $this->responseBox);
- } else {
- $this->row('Last check', 'Never');
- }
-
- $nextCheck = wp_next_scheduled($this->updateChecker->scheduler->getCronHookName());
- $this->row('Next automatic check', $this->formatTimeWithDelta($nextCheck));
-
- if ( isset($state, $state->checkedVersion) ) {
- $this->row('Checked version', htmlentities($state->checkedVersion));
- $this->row('Cached update', $state->update);
- }
- $this->row('Update checker class', htmlentities(get_class($this->updateChecker)));
- echo '
';
- }
-
- private function displayCurrentUpdate() {
- $update = $this->updateChecker->getUpdate();
- if ( $update !== null ) {
- echo 'An Update Is Available
';
- echo '';
- $fields = array('version', 'download_url', 'slug', 'homepage', 'upgrade_notice');
- foreach($fields as $field) {
- $this->row(ucwords(str_replace('_', ' ', $field)), htmlentities($update->$field));
- }
- echo '
';
- } else {
- echo 'No updates currently available
';
- }
- }
-
- private function formatTimeWithDelta($unixTime) {
- if ( empty($unixTime) ) {
- return 'Never';
- }
-
- $delta = time() - $unixTime;
- $result = human_time_diff(time(), $unixTime);
- if ( $delta < 0 ) {
- $result = 'after ' . $result;
- } else {
- $result = $result . ' ago';
- }
- $result .= ' (' . $this->formatTimestamp($unixTime) . ')';
- return $result;
- }
-
- private function formatTimestamp($unixTime) {
- return gmdate('Y-m-d H:i:s', $unixTime + (get_option('gmt_offset') * 3600));
- }
-
- private function row($name, $value) {
- if ( is_object($value) || is_array($value) ) {
- $value = '' . htmlentities(print_r($value, true)) . '
';
- } else if ($value === null) {
- $value = 'null';
- }
- printf('| %1$s | %2$s |
|---|
', $name, $value);
- }
-}
-
-}
diff --git a/debug-bar-plugin.php b/debug-bar-plugin.php
deleted file mode 100644
index 9e1e1841..00000000
--- a/debug-bar-plugin.php
+++ /dev/null
@@ -1,102 +0,0 @@
-updateChecker = $updateChecker;
-
- add_filter('debug_bar_panels', array($this, 'addDebugBarPanel'));
- add_action('debug_bar_enqueue_scripts', array($this, 'enqueuePanelDependencies'));
-
- add_action('wp_ajax_puc_debug_check_now', array($this, 'ajaxCheckNow'));
- add_action('wp_ajax_puc_debug_request_info', array($this, 'ajaxRequestInfo'));
- }
-
- /**
- * Register the PUC Debug Bar panel.
- *
- * @param array $panels
- * @return array
- */
- public function addDebugBarPanel($panels) {
- require_once dirname(__FILE__) . '/debug-bar-panel.php';
- if ( current_user_can('update_plugins') && class_exists('PluginUpdateCheckerPanel_3_2', false) ) {
- $panels[] = new PluginUpdateCheckerPanel_3_2($this->updateChecker);
- }
- return $panels;
- }
-
- /**
- * Enqueue our Debug Bar scripts and styles.
- */
- public function enqueuePanelDependencies() {
- wp_enqueue_style(
- 'puc-debug-bar-style',
- plugins_url( "/css/puc-debug-bar.css", __FILE__ ),
- array('debug-bar'),
- '20130927'
- );
-
- wp_enqueue_script(
- 'puc-debug-bar-js',
- plugins_url( "/js/debug-bar.js", __FILE__ ),
- array('jquery'),
- '20121026'
- );
- }
-
- /**
- * Run an update check and output the result. Useful for making sure that
- * the update checking process works as expected.
- */
- public function ajaxCheckNow() {
- if ( $_POST['slug'] !== $this->updateChecker->slug ) {
- return;
- }
- $this->preAjaxReqest();
- $update = $this->updateChecker->checkForUpdates();
- if ( $update !== null ) {
- echo "An update is available:";
- echo '', htmlentities(print_r($update, true)), '
';
- } else {
- echo 'No updates found.';
- }
- exit;
- }
-
- /**
- * Request plugin info and output it.
- */
- public function ajaxRequestInfo() {
- if ( $_POST['slug'] !== $this->updateChecker->slug ) {
- return;
- }
- $this->preAjaxReqest();
- $info = $this->updateChecker->requestInfo();
- if ( $info !== null ) {
- echo 'Successfully retrieved plugin info from the metadata URL:';
- echo '', htmlentities(print_r($info, true)), '
';
- } else {
- echo 'Failed to retrieve plugin info from the metadata URL.';
- }
- exit;
- }
-
- /**
- * Check access permissions and enable error display (for debugging).
- */
- private function preAjaxReqest() {
- if ( !current_user_can('update_plugins') ) {
- die('Access denied');
- }
- check_ajax_referer('puc-ajax');
-
- error_reporting(E_ALL);
- @ini_set('display_errors','On');
- }
-}
-
-}
\ No newline at end of file
diff --git a/examples/plugin.json b/examples/plugin.json
new file mode 100644
index 00000000..685b9435
--- /dev/null
+++ b/examples/plugin.json
@@ -0,0 +1,47 @@
+{
+ "name": "My Example Plugin",
+ "version": "2.0",
+ "download_url": "http://example.com/updates/example-plugin.zip",
+
+ "homepage": "http://example.com/",
+ "requires": "4.5",
+ "tested": "4.8",
+ "last_updated": "2017-01-01 16:17:00",
+ "upgrade_notice": "Here's why you should upgrade...",
+
+ "author": "Janis Elsts",
+ "author_homepage": "http://example.com/",
+
+ "sections": {
+ "description": "(Required) Plugin description. Basic HTML can be used in all sections.",
+ "installation": "(Recommended) Installation instructions.",
+ "changelog": "(Recommended) Changelog. This section will be displayed by default when the user clicks 'View version x.y.z details'.
",
+ "custom_section": "This is a custom section labeled 'Custom Section'."
+ },
+
+ "banners": {
+ "low": "http://w-shadow.com/files/external-update-example/assets/banner-772x250.png",
+ "high": "http://w-shadow.com/files/external-update-example/assets/banner-1544x500.png"
+ },
+
+ "translations": [
+ {
+ "language": "fr_FR",
+ "version": "4.0",
+ "updated": "2016-04-22 23:22:42",
+ "package": "http://example.com/updates/translations/french-language-pack.zip"
+ },
+ {
+ "language": "de_DE",
+ "version": "5.0",
+ "updated": "2016-04-22 23:22:42",
+ "package": "http://example.com/updates/translations/german-language-pack.zip"
+ }
+ ],
+
+ "rating": 90,
+ "num_ratings": 123,
+
+ "downloaded": 1234,
+ "active_installs": 12345
+}
\ No newline at end of file
diff --git a/examples/theme.json b/examples/theme.json
new file mode 100644
index 00000000..df6c8c79
--- /dev/null
+++ b/examples/theme.json
@@ -0,0 +1,5 @@
+{
+ "version": "2.0",
+ "details_url": "http://example.com/version-2.0-details.html",
+ "download_url": "http://example.com/example-theme-2.0.zip"
+}
\ No newline at end of file
diff --git a/github-checker.php b/github-checker.php
deleted file mode 100644
index 96a5ab9b..00000000
--- a/github-checker.php
+++ /dev/null
@@ -1,459 +0,0 @@
-repositoryUrl = $repositoryUrl;
- $this->branch = empty($branch) ? 'master' : $branch;
-
- $path = @parse_url($repositoryUrl, PHP_URL_PATH);
- if ( preg_match('@^/?(?P[^/]+?)/(?P[^/#?&]+?)/?$@', $path, $matches) ) {
- $this->userName = $matches['username'];
- $this->repositoryName = $matches['repository'];
- } else {
- throw new InvalidArgumentException('Invalid GitHub repository URL: "' . $repositoryUrl . '"');
- }
-
- parent::__construct($repositoryUrl, $pluginFile, '', $checkPeriod, $optionName, $muPluginFile);
- }
-
- /**
- * Retrieve details about the latest plugin version from GitHub.
- *
- * @param array $unusedQueryArgs Unused.
- * @return PluginInfo_3_2
- */
- public function requestInfo($unusedQueryArgs = array()) {
- $info = new PluginInfo_3_2();
- $info->filename = $this->pluginFile;
- $info->slug = $this->slug;
-
- $this->setInfoFromHeader($this->getPluginHeader(), $info);
-
- //Figure out which reference (tag or branch) we'll use to get the latest version of the plugin.
- $ref = $this->branch;
- if ( $this->branch === 'master' ) {
- //Use the latest release.
- $release = $this->getLatestRelease();
- if ( $release !== null ) {
- $ref = $release->tag_name;
- $info->version = ltrim($release->tag_name, 'v'); //Remove the "v" prefix from "v1.2.3".
- $info->last_updated = $release->created_at;
- $info->download_url = $release->zipball_url;
-
- if ( !empty($release->body) ) {
- $info->sections['changelog'] = $this->parseMarkdown($release->body);
- }
- if ( isset($release->assets[0]) ) {
- $info->downloaded = $release->assets[0]->download_count;
- }
- } else {
- //Failing that, use the tag with the highest version number.
- $tag = $this->getLatestTag();
- if ( $tag !== null ) {
- $ref = $tag->name;
- $info->version = $tag->name;
- $info->download_url = $tag->zipball_url;
- }
- }
- }
-
- if ( empty($info->download_url) ) {
- $info->download_url = $this->buildArchiveDownloadUrl($ref);
- } else if ( !empty($this->accessToken) ) {
- $info->download_url = add_query_arg('access_token', $this->accessToken, $info->download_url);
- }
-
- //Get headers from the main plugin file in this branch/tag. Its "Version" header and other metadata
- //are what the WordPress install will actually see after upgrading, so they take precedence over releases/tags.
- $mainPluginFile = basename($this->pluginFile);
- $remotePlugin = $this->getRemoteFile($mainPluginFile, $ref);
- if ( !empty($remotePlugin) ) {
- $remoteHeader = $this->getFileHeader($remotePlugin);
- $this->setInfoFromHeader($remoteHeader, $info);
- }
-
- //Try parsing readme.txt. If it's formatted according to WordPress.org standards, it will contain
- //a lot of useful information like the required/tested WP version, changelog, and so on.
- if ( $this->readmeTxtExistsLocally() ) {
- $this->setInfoFromRemoteReadme($ref, $info);
- }
-
- //The changelog might be in a separate file.
- if ( empty($info->sections['changelog']) ) {
- $info->sections['changelog'] = $this->getRemoteChangelog($ref);
- if ( empty($info->sections['changelog']) ) {
- $info->sections['changelog'] = __('There is no changelog available.', 'plugin-update-checker');
- }
- }
-
- if ( empty($info->last_updated) ) {
- //Fetch the latest commit that changed the main plugin file and use it as the "last_updated" date.
- //It's reasonable to assume that every update will change the version number in that file.
- $latestCommit = $this->getLatestCommit($mainPluginFile, $ref);
- if ( $latestCommit !== null ) {
- $info->last_updated = $latestCommit->commit->author->date;
- }
- }
-
- $info = apply_filters('puc_request_info_result-' . $this->slug, $info, null);
- return $info;
- }
-
- /**
- * Get the latest release from GitHub.
- *
- * @return StdClass|null
- */
- protected function getLatestRelease() {
- $releases = $this->api('/repos/:user/:repo/releases');
- if ( is_wp_error($releases) || !is_array($releases) || !isset($releases[0]) ) {
- return null;
- }
-
- $latestRelease = $releases[0];
- return $latestRelease;
- }
-
- /**
- * Get the tag that looks like the highest version number.
- *
- * @return StdClass|null
- */
- protected function getLatestTag() {
- $tags = $this->api('/repos/:user/:repo/tags');
-
- if ( is_wp_error($tags) || empty($tags) || !is_array($tags) ) {
- return null;
- }
-
- usort($tags, array($this, 'compareTagNames')); //Sort from highest to lowest.
- return $tags[0];
- }
-
- /**
- * Compare two GitHub tags as if they were version number.
- *
- * @param string $tag1
- * @param string $tag2
- * @return int
- */
- protected function compareTagNames($tag1, $tag2) {
- if ( !isset($tag1->name) ) {
- return 1;
- }
- if ( !isset($tag2->name) ) {
- return -1;
- }
- return -version_compare($tag1->name, $tag2->name);
- }
-
- /**
- * Get the latest commit that changed the specified file.
- *
- * @param string $filename
- * @param string $ref Reference name (e.g. branch or tag).
- * @return StdClass|null
- */
- protected function getLatestCommit($filename, $ref = 'master') {
- $commits = $this->api(
- '/repos/:user/:repo/commits',
- array(
- 'path' => $filename,
- 'sha' => $ref,
- )
- );
- if ( !is_wp_error($commits) && is_array($commits) && isset($commits[0]) ) {
- return $commits[0];
- }
- return null;
- }
-
- protected function getRemoteChangelog($ref = '') {
- $filename = $this->getChangelogFilename();
- if ( empty($filename) ) {
- return null;
- }
-
- $changelog = $this->getRemoteFile($filename, $ref);
- if ( $changelog === null ) {
- return null;
- }
- return $this->parseMarkdown($changelog);
- }
-
- protected function getChangelogFilename() {
- $pluginDirectory = dirname($this->pluginAbsolutePath);
- if ( empty($this->pluginAbsolutePath) || !is_dir($pluginDirectory) || ($pluginDirectory === '.') ) {
- return null;
- }
-
- $possibleNames = array('CHANGES.md', 'CHANGELOG.md', 'changes.md', 'changelog.md');
- $files = scandir($pluginDirectory);
- $foundNames = array_intersect($possibleNames, $files);
-
- if ( !empty($foundNames) ) {
- return reset($foundNames);
- }
- return null;
- }
-
- /**
- * Convert Markdown to HTML.
- *
- * @param string $markdown
- * @return string
- */
- protected function parseMarkdown($markdown) {
- if ( !class_exists('Parsedown', false) ) {
- require_once(dirname(__FILE__) . '/vendor/Parsedown' . (version_compare(PHP_VERSION, '5.3.0', '>=') ? '' : 'Legacy') . '.php');
- }
-
- $instance = Parsedown::instance();
- return $instance->text($markdown);
- }
-
- /**
- * Perform a GitHub API request.
- *
- * @param string $url
- * @param array $queryParams
- * @return mixed|WP_Error
- */
- protected function api($url, $queryParams = array()) {
- $variables = array(
- 'user' => $this->userName,
- 'repo' => $this->repositoryName,
- );
- foreach ($variables as $name => $value) {
- $url = str_replace('/:' . $name, '/' . urlencode($value), $url);
- }
- $url = 'https://api.github.com' . $url;
-
- if ( !empty($this->accessToken) ) {
- $queryParams['access_token'] = $this->accessToken;
- }
- if ( !empty($queryParams) ) {
- $url = add_query_arg($queryParams, $url);
- }
-
- $response = wp_remote_get($url, array('timeout' => 10));
- if ( is_wp_error($response) ) {
- return $response;
- }
-
- $code = wp_remote_retrieve_response_code($response);
- $body = wp_remote_retrieve_body($response);
- if ( $code === 200 ) {
- $document = json_decode($body);
- return $document;
- }
-
- return new WP_Error(
- 'puc-github-http-error',
- 'GitHub API error. HTTP status: ' . $code
- );
- }
-
- /**
- * Set the access token that will be used to make authenticated GitHub API requests.
- *
- * @param string $accessToken
- */
- public function setAccessToken($accessToken) {
- $this->accessToken = $accessToken;
- }
-
- /**
- * Get the contents of a file from a specific branch or tag.
- *
- * @param string $path File name.
- * @param string $ref
- * @return null|string Either the contents of the file, or null if the file doesn't exist or there's an error.
- */
- protected function getRemoteFile($path, $ref = 'master') {
- $apiUrl = '/repos/:user/:repo/contents/' . $path;
- $response = $this->api($apiUrl, array('ref' => $ref));
-
- if ( is_wp_error($response) || !isset($response->content) || ($response->encoding !== 'base64') ) {
- return null;
- }
- return base64_decode($response->content);
- }
-
- /**
- * Parse plugin metadata from the header comment.
- * This is basically a simplified version of the get_file_data() function from /wp-includes/functions.php.
- *
- * @param $content
- * @return array
- */
- protected function getFileHeader($content) {
- $headers = array(
- 'Name' => 'Plugin Name',
- 'PluginURI' => 'Plugin URI',
- 'Version' => 'Version',
- 'Description' => 'Description',
- 'Author' => 'Author',
- 'AuthorURI' => 'Author URI',
- 'TextDomain' => 'Text Domain',
- 'DomainPath' => 'Domain Path',
- 'Network' => 'Network',
-
- //The newest WordPress version that this plugin requires or has been tested with.
- //We support several different formats for compatibility with other libraries.
- 'Tested WP' => 'Tested WP',
- 'Requires WP' => 'Requires WP',
- 'Tested up to' => 'Tested up to',
- 'Requires at least' => 'Requires at least',
- );
-
- $content = str_replace("\r", "\n", $content); //Normalize line endings.
- $results = array();
- foreach ($headers as $field => $name) {
- $success = preg_match('/^[ \t\/*#@]*' . preg_quote($name, '/') . ':(.*)$/mi', $content, $matches);
- if ( ($success === 1) && $matches[1] ) {
- $results[$field] = _cleanup_header_comment($matches[1]);
- } else {
- $results[$field] = '';
- }
- }
-
- return $results;
- }
-
- /**
- * Copy plugin metadata from a file header to a PluginInfo object.
- *
- * @param array $fileHeader
- * @param PluginInfo_3_2 $pluginInfo
- */
- protected function setInfoFromHeader($fileHeader, $pluginInfo) {
- $headerToPropertyMap = array(
- 'Version' => 'version',
- 'Name' => 'name',
- 'PluginURI' => 'homepage',
- 'Author' => 'author',
- 'AuthorName' => 'author',
- 'AuthorURI' => 'author_homepage',
-
- 'Requires WP' => 'requires',
- 'Tested WP' => 'tested',
- 'Requires at least' => 'requires',
- 'Tested up to' => 'tested',
- );
- foreach ($headerToPropertyMap as $headerName => $property) {
- if ( isset($fileHeader[$headerName]) && !empty($fileHeader[$headerName]) ) {
- $pluginInfo->$property = $fileHeader[$headerName];
- }
- }
-
- if ( !empty($fileHeader['Description']) ) {
- $pluginInfo->sections['description'] = $fileHeader['Description'];
- }
- }
-
- /**
- * Copy plugin metadata from the remote readme.txt file.
- *
- * @param string $ref GitHub tag or branch where to look for the readme.
- * @param PluginInfo_3_2 $pluginInfo
- */
- protected function setInfoFromRemoteReadme($ref, $pluginInfo) {
- $readmeTxt = $this->getRemoteFile('readme.txt', $ref);
- if ( empty($readmeTxt) ) {
- return;
- }
-
- $readme = $this->parseReadme($readmeTxt);
-
- if ( isset($readme['sections']) ) {
- $pluginInfo->sections = array_merge($pluginInfo->sections, $readme['sections']);
- }
- if ( !empty($readme['tested_up_to']) ) {
- $pluginInfo->tested = $readme['tested_up_to'];
- }
- if ( !empty($readme['requires_at_least']) ) {
- $pluginInfo->requires = $readme['requires_at_least'];
- }
-
- if ( isset($readme['upgrade_notice'], $readme['upgrade_notice'][$pluginInfo->version]) ) {
- $pluginInfo->upgrade_notice = $readme['upgrade_notice'][$pluginInfo->version];
- }
- }
-
- protected function parseReadme($content) {
- if ( !class_exists('PucReadmeParser', false) ) {
- require_once(dirname(__FILE__) . '/vendor/readme-parser.php');
- }
- $parser = new PucReadmeParser();
- return $parser->parse_readme_contents($content);
- }
-
- /**
- * Check if the currently installed version has a readme.txt file.
- *
- * @return bool
- */
- protected function readmeTxtExistsLocally() {
- $pluginDirectory = dirname($this->pluginAbsolutePath);
- if ( empty($this->pluginAbsolutePath) || !is_dir($pluginDirectory) || ($pluginDirectory === '.') ) {
- return false;
- }
- return is_file($pluginDirectory . '/readme.txt');
- }
-
- /**
- * Generate a URL to download a ZIP archive of the specified branch/tag/etc.
- *
- * @param string $ref
- * @return string
- */
- protected function buildArchiveDownloadUrl($ref = 'master') {
- $url = sprintf(
- 'https://api.github.com/repos/%1$s/%2$s/zipball/%3$s',
- urlencode($this->userName),
- urlencode($this->repositoryName),
- urlencode($ref)
- );
- if ( !empty($this->accessToken) ) {
- $url = add_query_arg('access_token', $this->accessToken, $url);
- }
- return $url;
- }
-}
-
-endif;
\ No newline at end of file
diff --git a/js/debug-bar.js b/js/debug-bar.js
index 758ee791..57baaa98 100644
--- a/js/debug-bar.js
+++ b/js/debug-bar.js
@@ -2,7 +2,7 @@ jQuery(function($) {
function runAjaxAction(button, action) {
button = $(button);
- var panel = button.closest('.puc-debug-bar-panel');
+ var panel = button.closest('.puc-debug-bar-panel-v4');
var responseBox = button.closest('td').find('.puc-ajax-response');
responseBox.text('Processing...').show();
@@ -10,7 +10,7 @@ jQuery(function($) {
ajaxurl,
{
action : action,
- slug : panel.data('slug'),
+ uid : panel.data('uid'),
_wpnonce: panel.data('nonce')
},
function(data) {
@@ -20,13 +20,13 @@ jQuery(function($) {
);
}
- $('.puc-debug-bar-panel input[name="puc-check-now-button"]').click(function() {
- runAjaxAction(this, 'puc_debug_check_now');
+ $('.puc-debug-bar-panel-v4 input[name="puc-check-now-button"]').click(function() {
+ runAjaxAction(this, 'puc_v4_debug_check_now');
return false;
});
- $('.puc-debug-bar-panel input[name="puc-request-info-button"]').click(function() {
- runAjaxAction(this, 'puc_debug_request_info');
+ $('.puc-debug-bar-panel-v4 input[name="puc-request-info-button"]').click(function() {
+ runAjaxAction(this, 'puc_v4_debug_request_info');
return false;
});
@@ -34,19 +34,19 @@ jQuery(function($) {
// Debug Bar uses the panel class name as part of its link and container IDs. This means we can
// end up with multiple identical IDs if more than one plugin uses the update checker library.
// Fix it by replacing the class name with the plugin slug.
- var panels = $('#debug-menu-targets').find('.puc-debug-bar-panel');
- panels.each(function(index) {
+ var panels = $('#debug-menu-targets').find('.puc-debug-bar-panel-v4');
+ panels.each(function() {
var panel = $(this);
- var slug = panel.data('slug');
+ var uid = panel.data('uid');
var target = panel.closest('.debug-menu-target');
//Change the panel wrapper ID.
- target.attr('id', 'debug-menu-target-puc-' + slug);
+ target.attr('id', 'debug-menu-target-puc-' + uid);
//Change the menu link ID as well and point it at the new target ID.
- $('#puc-debug-menu-link-' + panel.data('slug'))
+ $('#puc-debug-menu-link-' + uid)
.closest('.debug-menu-link')
- .attr('id', 'debug-menu-link-puc-' + slug)
+ .attr('id', 'debug-menu-link-puc-' + uid)
.attr('href', '#' + target.attr('id'));
});
});
\ No newline at end of file
diff --git a/plugin-update-checker.php b/plugin-update-checker.php
index aaf86d9a..8aff3eb4 100644
--- a/plugin-update-checker.php
+++ b/plugin-update-checker.php
@@ -1,1663 +1,21 @@
metadataUrl = $metadataUrl;
- $this->pluginAbsolutePath = $pluginFile;
- $this->pluginFile = plugin_basename($this->pluginAbsolutePath);
- $this->muPluginFile = $muPluginFile;
- $this->slug = $slug;
- $this->optionName = $optionName;
- $this->debugMode = (bool)(constant('WP_DEBUG'));
-
- //If no slug is specified, use the name of the main plugin file as the slug.
- //For example, 'my-cool-plugin/cool-plugin.php' becomes 'cool-plugin'.
- if ( empty($this->slug) ){
- $this->slug = basename($this->pluginFile, '.php');
- }
-
- //Plugin slugs must be unique.
- $slugCheckFilter = 'puc_is_slug_in_use-' . $this->slug;
- $slugUsedBy = apply_filters($slugCheckFilter, false);
- if ( $slugUsedBy ) {
- $this->triggerError(sprintf(
- 'Plugin slug "%s" is already in use by %s. Slugs must be unique.',
- htmlentities($this->slug),
- htmlentities($slugUsedBy)
- ), E_USER_ERROR);
- }
- add_filter($slugCheckFilter, array($this, 'getAbsolutePath'));
-
-
- if ( empty($this->optionName) ){
- $this->optionName = 'external_updates-' . $this->slug;
- }
-
- //Backwards compatibility: If the plugin is a mu-plugin but no $muPluginFile is specified, assume
- //it's the same as $pluginFile given that it's not in a subdirectory (WP only looks in the base dir).
- if ( (strpbrk($this->pluginFile, '/\\') === false) && $this->isUnknownMuPlugin() ) {
- $this->muPluginFile = $this->pluginFile;
- }
-
- $this->scheduler = $this->createScheduler($checkPeriod);
- $this->upgraderStatus = new PucUpgraderStatus_3_2();
-
- $this->installHooks();
- }
-
- /**
- * Create an instance of the scheduler.
- *
- * This is implemented as a method to make it possible for plugins to subclass the update checker
- * and substitute their own scheduler.
- *
- * @param int $checkPeriod
- * @return PucScheduler_3_2
- */
- protected function createScheduler($checkPeriod) {
- return new PucScheduler_3_2($this, $checkPeriod);
- }
-
- /**
- * Install the hooks required to run periodic update checks and inject update info
- * into WP data structures.
- *
- * @return void
- */
- protected function installHooks(){
- //Override requests for plugin information
- add_filter('plugins_api', array($this, 'injectInfo'), 20, 3);
-
- //Insert our update info into the update array maintained by WP.
- add_filter('site_transient_update_plugins', array($this,'injectUpdate')); //WP 3.0+
- add_filter('transient_update_plugins', array($this,'injectUpdate')); //WP 2.8+
- add_filter('site_transient_update_plugins', array($this, 'injectTranslationUpdates'));
-
- add_filter('plugin_row_meta', array($this, 'addCheckForUpdatesLink'), 10, 2);
- add_action('admin_init', array($this, 'handleManualCheck'));
- add_action('all_admin_notices', array($this, 'displayManualCheckResult'));
-
- //Clear the version number cache when something - anything - is upgraded or WP clears the update cache.
- add_filter('upgrader_post_install', array($this, 'clearCachedVersion'));
- add_action('delete_site_transient_update_plugins', array($this, 'clearCachedVersion'));
- //Clear translation updates when WP clears the update cache.
- //This needs to be done directly because the library doesn't actually remove obsolete plugin updates,
- //it just hides them (see getUpdate()). We can't do that with translations - too much disk I/O.
- add_action('delete_site_transient_update_plugins', array($this, 'clearCachedTranslationUpdates'));
-
- if ( did_action('plugins_loaded') ) {
- $this->initDebugBarPanel();
- } else {
- add_action('plugins_loaded', array($this, 'initDebugBarPanel'));
- }
-
- //Rename the update directory to be the same as the existing directory.
- add_filter('upgrader_source_selection', array($this, 'fixDirectoryName'), 10, 3);
-
- //Enable language support (i18n).
- load_plugin_textdomain('plugin-update-checker', false, plugin_basename(dirname(__FILE__)) . '/languages');
-
- //Allow HTTP requests to the metadata URL even if it's on a local host.
- $this->metadataHost = @parse_url($this->metadataUrl, PHP_URL_HOST);
- add_filter('http_request_host_is_external', array($this, 'allowMetadataHost'), 10, 2);
- }
-
- /**
- * Explicitly allow HTTP requests to the metadata URL.
- *
- * WordPress has a security feature where the HTTP API will reject all requests that are sent to
- * another site hosted on the same server as the current site (IP match), a local host, or a local
- * IP, unless the host exactly matches the current site.
- *
- * This feature is opt-in (at least in WP 4.4). Apparently some people enable it.
- *
- * That can be a problem when you're developing your plugin and you decide to host the update information
- * on the same server as your test site. Update requests will mysteriously fail.
- *
- * We fix that by adding an exception for the metadata host.
- *
- * @param bool $allow
- * @param string $host
- * @return bool
- */
- public function allowMetadataHost($allow, $host) {
- if ( strtolower($host) === strtolower($this->metadataHost) ) {
- return true;
- }
- return $allow;
- }
-
- /**
- * Retrieve plugin info from the configured API endpoint.
- *
- * @uses wp_remote_get()
- *
- * @param array $queryArgs Additional query arguments to append to the request. Optional.
- * @return PluginInfo_3_2
- */
- public function requestInfo($queryArgs = array()){
- //Query args to append to the URL. Plugins can add their own by using a filter callback (see addQueryArgFilter()).
- $installedVersion = $this->getInstalledVersion();
- $queryArgs['installed_version'] = ($installedVersion !== null) ? $installedVersion : '';
- $queryArgs = apply_filters('puc_request_info_query_args-'.$this->slug, $queryArgs);
-
- //Various options for the wp_remote_get() call. Plugins can filter these, too.
- $options = array(
- 'timeout' => 10, //seconds
- 'headers' => array(
- 'Accept' => 'application/json'
- ),
- );
- $options = apply_filters('puc_request_info_options-'.$this->slug, $options);
-
- //The plugin info should be at 'http://your-api.com/url/here/$slug/info.json'
- $url = $this->metadataUrl;
- if ( !empty($queryArgs) ){
- $url = add_query_arg($queryArgs, $url);
- }
-
- $result = wp_remote_get(
- $url,
- $options
- );
-
- //Try to parse the response
- $status = $this->validateApiResponse($result);
- $pluginInfo = null;
- if ( !is_wp_error($status) ){
- $pluginInfo = PluginInfo_3_2::fromJson($result['body']);
- if ( $pluginInfo !== null ) {
- $pluginInfo->filename = $this->pluginFile;
- $pluginInfo->slug = $this->slug;
- }
- } else {
- $this->triggerError(
- sprintf('The URL %s does not point to a valid plugin metadata file. ', $url)
- . $status->get_error_message(),
- E_USER_WARNING
- );
- }
-
- $pluginInfo = apply_filters('puc_request_info_result-'.$this->slug, $pluginInfo, $result);
- return $pluginInfo;
- }
-
- /**
- * Check if $result is a successful update API response.
- *
- * @param array|WP_Error $result
- * @return true|WP_Error
- */
- private function validateApiResponse($result) {
- if ( is_wp_error($result) ) { /** @var WP_Error $result */
- return new WP_Error($result->get_error_code(), 'WP HTTP Error: ' . $result->get_error_message());
- }
-
- if ( !isset($result['response']['code']) ) {
- return new WP_Error('puc_no_response_code', 'wp_remote_get() returned an unexpected result.');
- }
-
- if ( $result['response']['code'] !== 200 ) {
- return new WP_Error(
- 'puc_unexpected_response_code',
- 'HTTP response code is ' . $result['response']['code'] . ' (expected: 200)'
- );
- }
-
- if ( empty($result['body']) ) {
- return new WP_Error('puc_empty_response', 'The metadata file appears to be empty.');
- }
-
- return true;
- }
-
- /**
- * Retrieve the latest update (if any) from the configured API endpoint.
- *
- * @uses PluginUpdateChecker::requestInfo()
- *
- * @return PluginUpdate_3_2 An instance of PluginUpdate, or NULL when no updates are available.
- */
- public function requestUpdate(){
- //For the sake of simplicity, this function just calls requestInfo()
- //and transforms the result accordingly.
- $pluginInfo = $this->requestInfo(array('checking_for_updates' => '1'));
- if ( $pluginInfo == null ){
- return null;
- }
- $update = PluginUpdate_3_2::fromPluginInfo($pluginInfo);
-
- //Keep only those translation updates that apply to this site.
- $update->translations = $this->filterApplicableTranslations($update->translations);
-
- return $update;
- }
-
- /**
- * Filter a list of translation updates and return a new list that contains only updates
- * that apply to the current site.
- *
- * @param array $translations
- * @return array
- */
- private function filterApplicableTranslations($translations) {
- $languages = array_flip(array_values(get_available_languages()));
- $installedTranslations = wp_get_installed_translations('plugins');
- if ( isset($installedTranslations[$this->slug]) ) {
- $installedTranslations = $installedTranslations[$this->slug];
- } else {
- $installedTranslations = array();
- }
-
- $applicableTranslations = array();
- foreach($translations as $translation) {
- //Does it match one of the available core languages?
- $isApplicable = array_key_exists($translation->language, $languages);
- //Is it more recent than an already-installed translation?
- if ( isset($installedTranslations[$translation->language]) ) {
- $updateTimestamp = strtotime($translation->updated);
- $installedTimestamp = strtotime($installedTranslations[$translation->language]['PO-Revision-Date']);
- $isApplicable = $updateTimestamp > $installedTimestamp;
- }
-
- if ( $isApplicable ) {
- $applicableTranslations[] = $translation;
- }
- }
-
- return $applicableTranslations;
- }
-
- /**
- * Get the currently installed version of the plugin.
- *
- * @return string Version number.
- */
- public function getInstalledVersion(){
- if ( isset($this->cachedInstalledVersion) ) {
- return $this->cachedInstalledVersion;
- }
-
- $pluginHeader = $this->getPluginHeader();
- if ( isset($pluginHeader['Version']) ) {
- $this->cachedInstalledVersion = $pluginHeader['Version'];
- return $pluginHeader['Version'];
- } else {
- //This can happen if the filename points to something that is not a plugin.
- $this->triggerError(
- sprintf(
- "Can't to read the Version header for '%s'. The filename is incorrect or is not a plugin.",
- $this->pluginFile
- ),
- E_USER_WARNING
- );
- return null;
- }
- }
-
- /**
- * Get plugin's metadata from its file header.
- *
- * @return array
- */
- protected function getPluginHeader() {
- if ( !is_file($this->pluginAbsolutePath) ) {
- //This can happen if the plugin filename is wrong.
- $this->triggerError(
- sprintf(
- "Can't to read the plugin header for '%s'. The file does not exist.",
- $this->pluginFile
- ),
- E_USER_WARNING
- );
- return array();
- }
-
- if ( !function_exists('get_plugin_data') ){
- /** @noinspection PhpIncludeInspection */
- require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
- }
- return get_plugin_data($this->pluginAbsolutePath, false, false);
- }
-
- /**
- * Check for plugin updates.
- * The results are stored in the DB option specified in $optionName.
- *
- * @return PluginUpdate_3_2|null
- */
- public function checkForUpdates(){
- $installedVersion = $this->getInstalledVersion();
- //Fail silently if we can't find the plugin or read its header.
- if ( $installedVersion === null ) {
- $this->triggerError(
- sprintf('Skipping update check for %s - installed version unknown.', $this->pluginFile),
- E_USER_WARNING
- );
- return null;
- }
-
- $state = $this->getUpdateState();
- if ( empty($state) ){
- $state = new stdClass;
- $state->lastCheck = 0;
- $state->checkedVersion = '';
- $state->update = null;
- }
-
- $state->lastCheck = time();
- $state->checkedVersion = $installedVersion;
- $this->setUpdateState($state); //Save before checking in case something goes wrong
-
- $state->update = $this->requestUpdate();
- $this->setUpdateState($state);
-
- return $this->getUpdate();
- }
-
- /**
- * Load the update checker state from the DB.
- *
- * @return stdClass|null
- */
- public function getUpdateState() {
- $state = get_site_option($this->optionName, null);
- if ( empty($state) || !is_object($state)) {
- $state = null;
- }
-
- if ( isset($state, $state->update) && is_object($state->update) ) {
- $state->update = PluginUpdate_3_2::fromObject($state->update);
- }
- return $state;
- }
-
-
- /**
- * Persist the update checker state to the DB.
- *
- * @param StdClass $state
- * @return void
- */
- private function setUpdateState($state) {
- if ( isset($state->update) && is_object($state->update) && method_exists($state->update, 'toStdClass') ) {
- $update = $state->update; /** @var PluginUpdate_3_2 $update */
- $state->update = $update->toStdClass();
- }
- update_site_option($this->optionName, $state);
- }
-
- /**
- * Reset update checker state - i.e. last check time, cached update data and so on.
- *
- * Call this when your plugin is being uninstalled, or if you want to
- * clear the update cache.
- */
- public function resetUpdateState() {
- delete_site_option($this->optionName);
- }
-
- /**
- * Intercept plugins_api() calls that request information about our plugin and
- * use the configured API endpoint to satisfy them.
- *
- * @see plugins_api()
- *
- * @param mixed $result
- * @param string $action
- * @param array|object $args
- * @return mixed
- */
- public function injectInfo($result, $action = null, $args = null){
- $relevant = ($action == 'plugin_information') && isset($args->slug) && (
- ($args->slug == $this->slug) || ($args->slug == dirname($this->pluginFile))
- );
- if ( !$relevant ) {
- return $result;
- }
-
- $pluginInfo = $this->requestInfo();
- $pluginInfo = apply_filters('puc_pre_inject_info-' . $this->slug, $pluginInfo);
- if ( $pluginInfo ) {
- return $pluginInfo->toWpFormat();
- }
-
- return $result;
- }
-
- /**
- * Insert the latest update (if any) into the update list maintained by WP.
- *
- * @param StdClass $updates Update list.
- * @return StdClass Modified update list.
- */
- public function injectUpdate($updates){
- //Is there an update to insert?
- $update = $this->getUpdate();
-
- //No update notifications for mu-plugins unless explicitly enabled. The MU plugin file
- //is usually different from the main plugin file so the update wouldn't show up properly anyway.
- if ( $this->isUnknownMuPlugin() ) {
- $update = null;
- }
-
- if ( !empty($update) ) {
- //Let plugins filter the update info before it's passed on to WordPress.
- $update = apply_filters('puc_pre_inject_update-' . $this->slug, $update);
- $updates = $this->addUpdateToList($updates, $update);
- } else {
- //Clean up any stale update info.
- $updates = $this->removeUpdateFromList($updates);
- }
-
- return $updates;
- }
-
- /**
- * @param StdClass|null $updates
- * @param PluginUpdate_3_2 $updateToAdd
- * @return StdClass
- */
- private function addUpdateToList($updates, $updateToAdd) {
- if ( !is_object($updates) ) {
- $updates = new stdClass();
- $updates->response = array();
- }
-
- $wpUpdate = $updateToAdd->toWpFormat();
- $pluginFile = $this->pluginFile;
-
- if ( $this->isMuPlugin() ) {
- //WP does not support automatic update installation for mu-plugins, but we can still display a notice.
- $wpUpdate->package = null;
- $pluginFile = $this->muPluginFile;
- }
- $updates->response[$pluginFile] = $wpUpdate;
- return $updates;
- }
-
- /**
- * @param stdClass|null $updates
- * @return stdClass|null
- */
- private function removeUpdateFromList($updates) {
- if ( isset($updates, $updates->response) ) {
- unset($updates->response[$this->pluginFile]);
- if ( !empty($this->muPluginFile) ) {
- unset($updates->response[$this->muPluginFile]);
- }
- }
- return $updates;
- }
-
- /**
- * Insert translation updates into the list maintained by WordPress.
- *
- * @param stdClass $updates
- * @return stdClass
- */
- public function injectTranslationUpdates($updates) {
- $translationUpdates = $this->getTranslationUpdates();
- if ( empty($translationUpdates) ) {
- return $updates;
- }
-
- //Being defensive.
- if ( !is_object($updates) ) {
- $updates = new stdClass();
- }
- if ( !isset($updates->translations) ) {
- $updates->translations = array();
- }
-
- //In case there's a name collision with a plugin hosted on wordpress.org,
- //remove any preexisting updates that match our plugin.
- $translationType = 'plugin';
- $filteredTranslations = array();
- foreach($updates->translations as $translation) {
- if ( ($translation['type'] === $translationType) && ($translation['slug'] === $this->slug) ) {
- continue;
- }
- $filteredTranslations[] = $translation;
- }
- $updates->translations = $filteredTranslations;
-
- //Add our updates to the list.
- foreach($translationUpdates as $update) {
- $convertedUpdate = array_merge(
- array(
- 'type' => $translationType,
- 'slug' => $this->slug,
- 'autoupdate' => 0,
- //AFAICT, WordPress doesn't actually use the "version" field for anything.
- //But lets make sure it's there, just in case.
- 'version' => isset($update->version) ? $update->version : ('1.' . strtotime($update->updated)),
- ),
- (array)$update
- );
-
- $updates->translations[] = $convertedUpdate;
- }
-
- return $updates;
- }
-
- /**
- * Rename the update directory to match the existing plugin directory.
- *
- * When WordPress installs a plugin or theme update, it assumes that the ZIP file will contain
- * exactly one directory, and that the directory name will be the same as the directory where
- * the plugin/theme is currently installed.
- *
- * GitHub and other repositories provide ZIP downloads, but they often use directory names like
- * "project-branch" or "project-tag-hash". We need to change the name to the actual plugin folder.
- *
- * This is a hook callback. Don't call it from a plugin.
- *
- * @param string $source The directory to copy to /wp-content/plugins. Usually a subdirectory of $remoteSource.
- * @param string $remoteSource WordPress has extracted the update to this directory.
- * @param WP_Upgrader $upgrader
- * @return string|WP_Error
- */
- public function fixDirectoryName($source, $remoteSource, $upgrader) {
- global $wp_filesystem; /** @var WP_Filesystem_Base $wp_filesystem */
-
- //Basic sanity checks.
- if ( !isset($source, $remoteSource, $upgrader, $upgrader->skin, $wp_filesystem) ) {
- return $source;
- }
-
- //If WordPress is upgrading anything other than our plugin, leave the directory name unchanged.
- if ( !$this->isPluginBeingUpgraded($upgrader) ) {
- return $source;
- }
-
- //Rename the source to match the existing plugin directory.
- $pluginDirectoryName = dirname($this->pluginFile);
- if ( $pluginDirectoryName === '.' ) {
- return $source;
- }
- $correctedSource = trailingslashit($remoteSource) . $pluginDirectoryName . '/';
- if ( $source !== $correctedSource ) {
- //The update archive should contain a single directory that contains the rest of plugin files. Otherwise,
- //WordPress will try to copy the entire working directory ($source == $remoteSource). We can't rename
- //$remoteSource because that would break WordPress code that cleans up temporary files after update.
- if ( $this->isBadDirectoryStructure($remoteSource) ) {
- return new WP_Error(
- 'puc-incorrect-directory-structure',
- sprintf(
- 'The directory structure of the update is incorrect. All plugin files should be inside ' .
- 'a directory named %s, not at the root of the ZIP file.',
- htmlentities($this->slug)
- )
- );
- }
-
- /** @var WP_Upgrader_Skin $upgrader->skin */
- $upgrader->skin->feedback(sprintf(
- 'Renaming %s to %s…',
- '' . basename($source) . '',
- '' . $pluginDirectoryName . ''
- ));
-
- if ( $wp_filesystem->move($source, $correctedSource, true) ) {
- $upgrader->skin->feedback('Plugin directory successfully renamed.');
- return $correctedSource;
- } else {
- return new WP_Error(
- 'puc-rename-failed',
- 'Unable to rename the update to match the existing plugin directory.'
- );
- }
- }
-
- return $source;
- }
-
- /**
- * Check for incorrect update directory structure. An update must contain a single directory,
- * all other files should be inside that directory.
- *
- * @param string $remoteSource Directory path.
- * @return bool
- */
- private function isBadDirectoryStructure($remoteSource) {
- global $wp_filesystem; /** @var WP_Filesystem_Base $wp_filesystem */
-
- $sourceFiles = $wp_filesystem->dirlist($remoteSource);
- if ( is_array($sourceFiles) ) {
- $sourceFiles = array_keys($sourceFiles);
- $firstFilePath = trailingslashit($remoteSource) . $sourceFiles[0];
- return (count($sourceFiles) > 1) || (!$wp_filesystem->is_dir($firstFilePath));
- }
-
- //Assume it's fine.
- return false;
- }
-
- /**
- * Is there and update being installed RIGHT NOW, for this specific plugin?
- *
- * @param WP_Upgrader|null $upgrader The upgrader that's performing the current update.
- * @return bool
- */
- public function isPluginBeingUpgraded($upgrader = null) {
- return $this->upgraderStatus->isPluginBeingUpgraded($this->pluginFile, $upgrader);
- }
-
- /**
- * Get the details of the currently available update, if any.
- *
- * If no updates are available, or if the last known update version is below or equal
- * to the currently installed version, this method will return NULL.
- *
- * Uses cached update data. To retrieve update information straight from
- * the metadata URL, call requestUpdate() instead.
- *
- * @return PluginUpdate_3_2|null
- */
- public function getUpdate() {
- $state = $this->getUpdateState(); /** @var StdClass $state */
-
- //Is there an update available?
- if ( isset($state, $state->update) ) {
- $update = $state->update;
- //Check if the update is actually newer than the currently installed version.
- $installedVersion = $this->getInstalledVersion();
- if ( ($installedVersion !== null) && version_compare($update->version, $installedVersion, '>') ){
- $update->filename = $this->pluginFile;
- return $update;
- }
- }
- return null;
- }
-
- /**
- * Get a list of available translation updates.
- *
- * This method will return an empty array if there are no updates.
- * Uses cached update data.
- *
- * @return array
- */
- public function getTranslationUpdates() {
- $state = $this->getUpdateState();
- if ( isset($state, $state->update, $state->update->translations) ) {
- return $state->update->translations;
- }
- return array();
- }
-
- /**
- * Remove all cached translation updates.
- *
- * @see wp_clean_update_cache
- */
- public function clearCachedTranslationUpdates() {
- $state = $this->getUpdateState();
- if ( isset($state, $state->update, $state->update->translations) ) {
- $state->update->translations = array();
- $this->setUpdateState($state);
- }
- }
-
- /**
- * Add a "Check for updates" link to the plugin row in the "Plugins" page. By default,
- * the new link will appear after the "Visit plugin site" link.
- *
- * You can change the link text by using the "puc_manual_check_link-$slug" filter.
- * Returning an empty string from the filter will disable the link.
- *
- * @param array $pluginMeta Array of meta links.
- * @param string $pluginFile
- * @return array
- */
- public function addCheckForUpdatesLink($pluginMeta, $pluginFile) {
- $isRelevant = ($pluginFile == $this->pluginFile)
- || (!empty($this->muPluginFile) && $pluginFile == $this->muPluginFile);
-
- if ( $isRelevant && current_user_can('update_plugins') ) {
- $linkUrl = wp_nonce_url(
- add_query_arg(
- array(
- 'puc_check_for_updates' => 1,
- 'puc_slug' => $this->slug,
- ),
- self_admin_url('plugins.php')
- ),
- 'puc_check_for_updates'
- );
-
- $linkText = apply_filters('puc_manual_check_link-' . $this->slug, __('Check for updates', 'plugin-update-checker'));
- if ( !empty($linkText) ) {
- $pluginMeta[] = sprintf('%s', esc_attr($linkUrl), $linkText);
- }
- }
- return $pluginMeta;
- }
-
- /**
- * Check for updates when the user clicks the "Check for updates" link.
- * @see self::addCheckForUpdatesLink()
- *
- * @return void
- */
- public function handleManualCheck() {
- $shouldCheck =
- isset($_GET['puc_check_for_updates'], $_GET['puc_slug'])
- && $_GET['puc_slug'] == $this->slug
- && current_user_can('update_plugins')
- && check_admin_referer('puc_check_for_updates');
-
- if ( $shouldCheck ) {
- $update = $this->checkForUpdates();
- $status = ($update === null) ? 'no_update' : 'update_available';
- wp_redirect(add_query_arg(
- array(
- 'puc_update_check_result' => $status,
- 'puc_slug' => $this->slug,
- ),
- self_admin_url('plugins.php')
- ));
- }
- }
-
- /**
- * Display the results of a manual update check.
- * @see self::handleManualCheck()
- *
- * You can change the result message by using the "puc_manual_check_message-$slug" filter.
- */
- public function displayManualCheckResult() {
- if ( isset($_GET['puc_update_check_result'], $_GET['puc_slug']) && ($_GET['puc_slug'] == $this->slug) ) {
- $status = strval($_GET['puc_update_check_result']);
- if ( $status == 'no_update' ) {
- $message = __('This plugin is up to date.', 'plugin-update-checker');
- } else if ( $status == 'update_available' ) {
- $message = __('A new version of this plugin is available.', 'plugin-update-checker');
- } else {
- $message = sprintf(__('Unknown update checker status "%s"', 'plugin-update-checker'), htmlentities($status));
- }
- printf(
- '',
- apply_filters('puc_manual_check_message-' . $this->slug, $message, $status)
- );
- }
- }
-
- /**
- * Check if the plugin file is inside the mu-plugins directory.
- *
- * @return bool
- */
- protected function isMuPlugin() {
- static $cachedResult = null;
-
- if ( $cachedResult === null ) {
- //Convert both paths to the canonical form before comparison.
- $muPluginDir = realpath(WPMU_PLUGIN_DIR);
- $pluginPath = realpath($this->pluginAbsolutePath);
-
- $cachedResult = (strpos($pluginPath, $muPluginDir) === 0);
- }
-
- return $cachedResult;
- }
-
- /**
- * MU plugins are partially supported, but only when we know which file in mu-plugins
- * corresponds to this plugin.
- *
- * @return bool
- */
- protected function isUnknownMuPlugin() {
- return empty($this->muPluginFile) && $this->isMuPlugin();
- }
-
- /**
- * Clear the cached plugin version. This method can be set up as a filter (hook) and will
- * return the filter argument unmodified.
- *
- * @param mixed $filterArgument
- * @return mixed
- */
- public function clearCachedVersion($filterArgument = null) {
- $this->cachedInstalledVersion = null;
- return $filterArgument;
- }
-
- /**
- * Get absolute path to the main plugin file.
- *
- * @return string
- */
- public function getAbsolutePath() {
- return $this->pluginAbsolutePath;
- }
-
- /**
- * Register a callback for filtering query arguments.
- *
- * The callback function should take one argument - an associative array of query arguments.
- * It should return a modified array of query arguments.
- *
- * @uses add_filter() This method is a convenience wrapper for add_filter().
- *
- * @param callable $callback
- * @return void
- */
- public function addQueryArgFilter($callback){
- add_filter('puc_request_info_query_args-'.$this->slug, $callback);
- }
-
- /**
- * Register a callback for filtering arguments passed to wp_remote_get().
- *
- * The callback function should take one argument - an associative array of arguments -
- * and return a modified array or arguments. See the WP documentation on wp_remote_get()
- * for details on what arguments are available and how they work.
- *
- * @uses add_filter() This method is a convenience wrapper for add_filter().
- *
- * @param callable $callback
- * @return void
- */
- public function addHttpRequestArgFilter($callback){
- add_filter('puc_request_info_options-'.$this->slug, $callback);
- }
-
- /**
- * Register a callback for filtering the plugin info retrieved from the external API.
- *
- * The callback function should take two arguments. If the plugin info was retrieved
- * successfully, the first argument passed will be an instance of PluginInfo. Otherwise,
- * it will be NULL. The second argument will be the corresponding return value of
- * wp_remote_get (see WP docs for details).
- *
- * The callback function should return a new or modified instance of PluginInfo or NULL.
- *
- * @uses add_filter() This method is a convenience wrapper for add_filter().
- *
- * @param callable $callback
- * @return void
- */
- public function addResultFilter($callback){
- add_filter('puc_request_info_result-'.$this->slug, $callback, 10, 2);
- }
-
- /**
- * Register a callback for one of the update checker filters.
- *
- * Identical to add_filter(), except it automatically adds the "puc_" prefix
- * and the "-$plugin_slug" suffix to the filter name. For example, "request_info_result"
- * becomes "puc_request_info_result-your_plugin_slug".
- *
- * @param string $tag
- * @param callable $callback
- * @param int $priority
- * @param int $acceptedArgs
- */
- public function addFilter($tag, $callback, $priority = 10, $acceptedArgs = 1) {
- add_filter('puc_' . $tag . '-' . $this->slug, $callback, $priority, $acceptedArgs);
- }
-
- /**
- * Initialize the update checker Debug Bar plugin/add-on thingy.
- */
- public function initDebugBarPanel() {
- $debugBarPlugin = dirname(__FILE__) . '/debug-bar-plugin.php';
- if ( class_exists('Debug_Bar', false) && file_exists($debugBarPlugin) ) {
- /** @noinspection PhpIncludeInspection */
- require_once $debugBarPlugin;
- $this->debugBarPlugin = new PucDebugBarPlugin_3_2($this);
- }
- }
-
- /**
- * Trigger a PHP error, but only when $debugMode is enabled.
- *
- * @param string $message
- * @param int $errorType
- */
- protected function triggerError($message, $errorType) {
- if ( $this->debugMode ) {
- trigger_error($message, $errorType);
- }
- }
-}
-
-endif;
-
-if ( !class_exists('PluginInfo_3_2', false) ):
-
-/**
- * A container class for holding and transforming various plugin metadata.
- *
- * @author Janis Elsts
- * @copyright 2016
- * @version 3.2
- * @access public
- */
-class PluginInfo_3_2 {
- //Most fields map directly to the contents of the plugin's info.json file.
- //See the relevant docs for a description of their meaning.
- public $name;
- public $slug;
- public $version;
- public $homepage;
- public $sections = array();
- public $banners;
- public $translations = array();
- public $download_url;
-
- public $author;
- public $author_homepage;
-
- public $requires;
- public $tested;
- public $upgrade_notice;
-
- public $rating;
- public $num_ratings;
- public $downloaded;
- public $active_installs;
- public $last_updated;
-
- public $id = 0; //The native WP.org API returns numeric plugin IDs, but they're not used for anything.
-
- public $filename; //Plugin filename relative to the plugins directory.
-
- /**
- * Create a new instance of PluginInfo from JSON-encoded plugin info
- * returned by an external update API.
- *
- * @param string $json Valid JSON string representing plugin info.
- * @return PluginInfo_3_2|null New instance of PluginInfo, or NULL on error.
- */
- public static function fromJson($json){
- /** @var StdClass $apiResponse */
- $apiResponse = json_decode($json);
- if ( empty($apiResponse) || !is_object($apiResponse) ){
- trigger_error(
- "Failed to parse plugin metadata. Try validating your .json file with http://jsonlint.com/",
- E_USER_NOTICE
- );
- return null;
- }
-
- $valid = self::validateMetadata($apiResponse);
- if ( is_wp_error($valid) ){
- trigger_error($valid->get_error_message(), E_USER_NOTICE);
- return null;
- }
-
- $info = new self();
- foreach(get_object_vars($apiResponse) as $key => $value){
- $info->$key = $value;
- }
-
- //json_decode decodes assoc. arrays as objects. We want it as an array.
- $info->sections = (array)$info->sections;
-
- return $info;
- }
-
- /**
- * Very, very basic validation.
- *
- * @param StdClass $apiResponse
- * @return bool|WP_Error
- */
- protected static function validateMetadata($apiResponse) {
- if (
- !isset($apiResponse->name, $apiResponse->version)
- || empty($apiResponse->name)
- || empty($apiResponse->version)
- ) {
- return new WP_Error(
- 'puc-invalid-metadata',
- "The plugin metadata file does not contain the required 'name' and/or 'version' keys."
- );
- }
- return true;
- }
-
-
- /**
- * Transform plugin info into the format used by the native WordPress.org API
- *
- * @return object
- */
- public function toWpFormat(){
- $info = new stdClass;
-
- //The custom update API is built so that many fields have the same name and format
- //as those returned by the native WordPress.org API. These can be assigned directly.
- $sameFormat = array(
- 'name', 'slug', 'version', 'requires', 'tested', 'rating', 'upgrade_notice',
- 'num_ratings', 'downloaded', 'active_installs', 'homepage', 'last_updated',
- );
- foreach($sameFormat as $field){
- if ( isset($this->$field) ) {
- $info->$field = $this->$field;
- } else {
- $info->$field = null;
- }
- }
-
- //Other fields need to be renamed and/or transformed.
- $info->download_link = $this->download_url;
- $info->author = $this->getFormattedAuthor();
- $info->sections = array_merge(array('description' => ''), $this->sections);
-
- if ( !empty($this->banners) ) {
- //WP expects an array with two keys: "high" and "low". Both are optional.
- //Docs: https://wordpress.org/plugins/about/faq/#banners
- $info->banners = is_object($this->banners) ? get_object_vars($this->banners) : $this->banners;
- $info->banners = array_intersect_key($info->banners, array('high' => true, 'low' => true));
- }
-
- return $info;
- }
-
- protected function getFormattedAuthor() {
- if ( !empty($this->author_homepage) ){
- return sprintf('%s', $this->author_homepage, $this->author);
- }
- return $this->author;
- }
-}
-
-endif;
-
-if ( !class_exists('PluginUpdate_3_2', false) ):
-
-/**
- * A simple container class for holding information about an available update.
- *
- * @author Janis Elsts
- * @copyright 2016
- * @version 3.2
- * @access public
- */
-class PluginUpdate_3_2 {
- public $id = 0;
- public $slug;
- public $version;
- public $homepage;
- public $download_url;
- public $upgrade_notice;
- public $tested;
- public $translations = array();
- public $filename; //Plugin filename relative to the plugins directory.
-
- private static $fields = array(
- 'id', 'slug', 'version', 'homepage', 'tested',
- 'download_url', 'upgrade_notice', 'filename',
- 'translations'
- );
-
- /**
- * Create a new instance of PluginUpdate from its JSON-encoded representation.
- *
- * @param string $json
- * @return PluginUpdate_3_2|null
- */
- public static function fromJson($json){
- //Since update-related information is simply a subset of the full plugin info,
- //we can parse the update JSON as if it was a plugin info string, then copy over
- //the parts that we care about.
- $pluginInfo = PluginInfo_3_2::fromJson($json);
- if ( $pluginInfo != null ) {
- return self::fromPluginInfo($pluginInfo);
- } else {
- return null;
- }
- }
-
- /**
- * Create a new instance of PluginUpdate based on an instance of PluginInfo.
- * Basically, this just copies a subset of fields from one object to another.
- *
- * @param PluginInfo_3_2 $info
- * @return PluginUpdate_3_2
- */
- public static function fromPluginInfo($info){
- return self::fromObject($info);
- }
-
- /**
- * Create a new instance of PluginUpdate by copying the necessary fields from
- * another object.
- *
- * @param StdClass|PluginInfo_3_2|PluginUpdate_3_2 $object The source object.
- * @return PluginUpdate_3_2 The new copy.
- */
- public static function fromObject($object) {
- $update = new self();
- $fields = self::$fields;
- if ( !empty($object->slug) ) {
- $fields = apply_filters('puc_retain_fields-' . $object->slug, $fields);
- }
- foreach($fields as $field){
- if (property_exists($object, $field)) {
- $update->$field = $object->$field;
- }
- }
- return $update;
- }
-
- /**
- * Create an instance of StdClass that can later be converted back to
- * a PluginUpdate. Useful for serialization and caching, as it avoids
- * the "incomplete object" problem if the cached value is loaded before
- * this class.
- *
- * @return StdClass
- */
- public function toStdClass() {
- $object = new stdClass();
- $fields = self::$fields;
- if ( !empty($this->slug) ) {
- $fields = apply_filters('puc_retain_fields-' . $this->slug, $fields);
- }
- foreach($fields as $field){
- if (property_exists($this, $field)) {
- $object->$field = $this->$field;
- }
- }
- return $object;
- }
-
-
- /**
- * Transform the update into the format used by WordPress native plugin API.
- *
- * @return object
- */
- public function toWpFormat(){
- $update = new stdClass;
-
- $update->id = $this->id;
- $update->slug = $this->slug;
- $update->new_version = $this->version;
- $update->url = $this->homepage;
- $update->package = $this->download_url;
- $update->tested = $this->tested;
- $update->plugin = $this->filename;
-
- if ( !empty($this->upgrade_notice) ){
- $update->upgrade_notice = $this->upgrade_notice;
- }
-
- return $update;
- }
-}
-
-endif;
-
-if ( !class_exists('PucScheduler_3_2', false) ):
-
-/**
- * The scheduler decides when and how often to check for updates.
- * It calls @see PluginUpdateChecker::checkForUpdates() to perform the actual checks.
- *
- * @version 3.2
- */
-class PucScheduler_3_2 {
- public $checkPeriod = 12; //How often to check for updates (in hours).
- public $throttleRedundantChecks = false; //Check less often if we already know that an update is available.
- public $throttledCheckPeriod = 72;
-
- /**
- * @var PluginUpdateChecker_3_2
- */
- protected $updateChecker;
-
- private $cronHook = null;
-
- /**
- * Scheduler constructor.
- *
- * @param PluginUpdateChecker_3_2 $updateChecker
- * @param int $checkPeriod How often to check for updates (in hours).
- */
- public function __construct($updateChecker, $checkPeriod) {
- $this->updateChecker = $updateChecker;
- $this->checkPeriod = $checkPeriod;
-
- //Set up the periodic update checks
- $this->cronHook = 'check_plugin_updates-' . $this->updateChecker->slug;
- if ( $this->checkPeriod > 0 ){
-
- //Trigger the check via Cron.
- //Try to use one of the default schedules if possible as it's less likely to conflict
- //with other plugins and their custom schedules.
- $defaultSchedules = array(
- 1 => 'hourly',
- 12 => 'twicedaily',
- 24 => 'daily',
- );
- if ( array_key_exists($this->checkPeriod, $defaultSchedules) ) {
- $scheduleName = $defaultSchedules[$this->checkPeriod];
- } else {
- //Use a custom cron schedule.
- $scheduleName = 'every' . $this->checkPeriod . 'hours';
- add_filter('cron_schedules', array($this, '_addCustomSchedule'));
- }
-
- if ( !wp_next_scheduled($this->cronHook) && !defined('WP_INSTALLING') ) {
- wp_schedule_event(time(), $scheduleName, $this->cronHook);
- }
- add_action($this->cronHook, array($this, 'maybeCheckForUpdates'));
-
- register_deactivation_hook($this->updateChecker->pluginFile, array($this, '_removeUpdaterCron'));
-
- //In case Cron is disabled or unreliable, we also manually trigger
- //the periodic checks while the user is browsing the Dashboard.
- add_action( 'admin_init', array($this, 'maybeCheckForUpdates') );
-
- //Like WordPress itself, we check more often on certain pages.
- /** @see wp_update_plugins */
- add_action('load-update-core.php', array($this, 'maybeCheckForUpdates'));
- add_action('load-plugins.php', array($this, 'maybeCheckForUpdates'));
- add_action('load-update.php', array($this, 'maybeCheckForUpdates'));
- //This hook fires after a bulk update is complete.
- add_action('upgrader_process_complete', array($this, 'maybeCheckForUpdates'), 11, 0);
-
- } else {
- //Periodic checks are disabled.
- wp_clear_scheduled_hook($this->cronHook);
- }
- }
-
- /**
- * Check for updates if the configured check interval has already elapsed.
- * Will use a shorter check interval on certain admin pages like "Dashboard -> Updates" or when doing cron.
- *
- * You can override the default behaviour by using the "puc_check_now-$slug" filter.
- * The filter callback will be passed three parameters:
- * - Current decision. TRUE = check updates now, FALSE = don't check now.
- * - Last check time as a Unix timestamp.
- * - Configured check period in hours.
- * Return TRUE to check for updates immediately, or FALSE to cancel.
- *
- * This method is declared public because it's a hook callback. Calling it directly is not recommended.
- */
- public function maybeCheckForUpdates(){
- if ( empty($this->checkPeriod) ){
- return;
- }
-
- $state = $this->updateChecker->getUpdateState();
- $shouldCheck =
- empty($state) ||
- !isset($state->lastCheck) ||
- ( (time() - $state->lastCheck) >= $this->getEffectiveCheckPeriod() );
-
- //Let plugin authors substitute their own algorithm.
- $shouldCheck = apply_filters(
- 'puc_check_now-' . $this->updateChecker->slug,
- $shouldCheck,
- (!empty($state) && isset($state->lastCheck)) ? $state->lastCheck : 0,
- $this->checkPeriod
- );
-
- if ( $shouldCheck ) {
- $this->updateChecker->checkForUpdates();
- }
- }
-
- /**
- * Calculate the actual check period based on the current status and environment.
- *
- * @return int Check period in seconds.
- */
- protected function getEffectiveCheckPeriod() {
- $currentFilter = current_filter();
- if ( in_array($currentFilter, array('load-update-core.php', 'upgrader_process_complete')) ) {
- //Check more often when the user visits "Dashboard -> Updates" or does a bulk update.
- $period = 60;
- } else if ( in_array($currentFilter, array('load-plugins.php', 'load-update.php')) ) {
- //Also check more often on the "Plugins" page and /wp-admin/update.php.
- $period = 3600;
- } else if ( $this->throttleRedundantChecks && ($this->updateChecker->getUpdate() !== null) ) {
- //Check less frequently if it's already known that an update is available.
- $period = $this->throttledCheckPeriod * 3600;
- } else if ( defined('DOING_CRON') && constant('DOING_CRON') ) {
- //WordPress cron schedules are not exact, so lets do an update check even
- //if slightly less than $checkPeriod hours have elapsed since the last check.
- $cronFuzziness = 20 * 60;
- $period = $this->checkPeriod * 3600 - $cronFuzziness;
- } else {
- $period = $this->checkPeriod * 3600;
- }
-
- return $period;
- }
-
- /**
- * Add our custom schedule to the array of Cron schedules used by WP.
- *
- * @param array $schedules
- * @return array
- */
- public function _addCustomSchedule($schedules){
- if ( $this->checkPeriod && ($this->checkPeriod > 0) ){
- $scheduleName = 'every' . $this->checkPeriod . 'hours';
- $schedules[$scheduleName] = array(
- 'interval' => $this->checkPeriod * 3600,
- 'display' => sprintf('Every %d hours', $this->checkPeriod),
- );
- }
- return $schedules;
- }
-
- /**
- * Remove the scheduled cron event that the library uses to check for updates.
- *
- * @return void
- */
- public function _removeUpdaterCron(){
- wp_clear_scheduled_hook($this->cronHook);
- }
-
- /**
- * Get the name of the update checker's WP-cron hook. Mostly useful for debugging.
- *
- * @return string
- */
- public function getCronHookName() {
- return $this->cronHook;
- }
-}
-
-endif;
-
-
-if ( !class_exists('PucUpgraderStatus_3_2', false) ):
-
-/**
- * A utility class that helps figure out which plugin WordPress is upgrading.
- *
- * It may seem strange to have an separate class just for that, but the task is surprisingly complicated.
- * Core classes like Plugin_Upgrader don't expose the plugin file name during an in-progress update (AFAICT).
- * This class uses a few workarounds and heuristics to get the file name.
- */
-class PucUpgraderStatus_3_2 {
- private $upgradedPluginFile = null; //The plugin that is currently being upgraded by WordPress.
-
- public function __construct() {
- //Keep track of which plugin WordPress is currently upgrading.
- add_filter('upgrader_pre_install', array($this, 'setUpgradedPlugin'), 10, 2);
- add_filter('upgrader_package_options', array($this, 'setUpgradedPluginFromOptions'), 10, 1);
- add_filter('upgrader_post_install', array($this, 'clearUpgradedPlugin'), 10, 1);
- add_action('upgrader_process_complete', array($this, 'clearUpgradedPlugin'), 10, 1);
- }
-
- /**
- * Is there and update being installed RIGHT NOW, for a specific plugin?
- *
- * Caution: This method is unreliable. WordPress doesn't make it easy to figure out what it is upgrading,
- * and upgrader implementations are liable to change without notice.
- *
- * @param string $pluginFile The plugin to check.
- * @param WP_Upgrader|null $upgrader The upgrader that's performing the current update.
- * @return bool True if the plugin identified by $pluginFile is being upgraded.
- */
- public function isPluginBeingUpgraded($pluginFile, $upgrader = null) {
- if ( isset($upgrader) ) {
- $upgradedPluginFile = $this->getPluginBeingUpgradedBy($upgrader);
- if ( !empty($upgradedPluginFile) ) {
- $this->upgradedPluginFile = $upgradedPluginFile;
- }
- }
- return ( !empty($this->upgradedPluginFile) && ($this->upgradedPluginFile === $pluginFile) );
- }
-
- /**
- * Get the file name of the plugin that's currently being upgraded.
- *
- * @param Plugin_Upgrader|WP_Upgrader $upgrader
- * @return string|null
- */
- private function getPluginBeingUpgradedBy($upgrader) {
- if ( !isset($upgrader, $upgrader->skin) ) {
- return null;
- }
-
- //Figure out which plugin is being upgraded.
- $pluginFile = null;
- $skin = $upgrader->skin;
- if ( $skin instanceof Plugin_Upgrader_Skin ) {
- if ( isset($skin->plugin) && is_string($skin->plugin) && ($skin->plugin !== '') ) {
- $pluginFile = $skin->plugin;
- }
- } elseif ( isset($skin->plugin_info) && is_array($skin->plugin_info) ) {
- //This case is tricky because Bulk_Plugin_Upgrader_Skin (etc) doesn't actually store the plugin
- //filename anywhere. Instead, it has the plugin headers in $plugin_info. So the best we can
- //do is compare those headers to the headers of installed plugins.
- $pluginFile = $this->identifyPluginByHeaders($skin->plugin_info);
- }
-
- return $pluginFile;
- }
-
- /**
- * Identify an installed plugin based on its headers.
- *
- * @param array $searchHeaders The plugin file header to look for.
- * @return string|null Plugin basename ("foo/bar.php"), or NULL if we can't identify the plugin.
- */
- private function identifyPluginByHeaders($searchHeaders) {
- if ( !function_exists('get_plugins') ){
- /** @noinspection PhpIncludeInspection */
- require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
- }
-
- $installedPlugins = get_plugins();
- $matches = array();
- foreach($installedPlugins as $pluginBasename => $headers) {
- $diff1 = array_diff_assoc($headers, $searchHeaders);
- $diff2 = array_diff_assoc($searchHeaders, $headers);
- if ( empty($diff1) && empty($diff2) ) {
- $matches[] = $pluginBasename;
- }
- }
-
- //It's possible (though very unlikely) that there could be two plugins with identical
- //headers. In that case, we can't unambiguously identify the plugin that's being upgraded.
- if ( count($matches) !== 1 ) {
- return null;
- }
-
- return reset($matches);
- }
-
- /**
- * @access private
- *
- * @param mixed $input
- * @param array $hookExtra
- * @return mixed Returns $input unaltered.
- */
- public function setUpgradedPlugin($input, $hookExtra) {
- if (!empty($hookExtra['plugin']) && is_string($hookExtra['plugin'])) {
- $this->upgradedPluginFile = $hookExtra['plugin'];
- } else {
- $this->upgradedPluginFile = null;
- }
- return $input;
- }
-
- /**
- * @access private
- *
- * @param array $options
- * @return array
- */
- public function setUpgradedPluginFromOptions($options) {
- if (isset($options['hook_extra']['plugin']) && is_string($options['hook_extra']['plugin'])) {
- $this->upgradedPluginFile = $options['hook_extra']['plugin'];
- } else {
- $this->upgradedPluginFile = null;
- }
- return $options;
- }
-
- /**
- * @access private
- *
- * @param mixed $input
- * @return mixed Returns $input unaltered.
- */
- public function clearUpgradedPlugin($input = null) {
- $this->upgradedPluginFile = null;
- return $input;
- }
-}
-
-endif;
-
-
-if ( !class_exists('PucFactory', false) ):
-
-/**
- * A factory that builds instances of other classes from this library.
- *
- * When multiple versions of the same class have been loaded (e.g. PluginUpdateChecker 1.2
- * and 1.3), this factory will always use the latest available version. Register class
- * versions by calling {@link PucFactory::addVersion()}.
- *
- * At the moment it can only build instances of the PluginUpdateChecker class. Other classes
- * are intended mainly for internal use and refer directly to specific implementations. If you
- * want to instantiate one of them anyway, you can use {@link PucFactory::getLatestClassVersion()}
- * to get the class name and then create it with new $class(...).
- */
-class PucFactory {
- protected static $classVersions = array();
- protected static $sorted = false;
-
- /**
- * Create a new instance of PluginUpdateChecker.
- *
- * @see PluginUpdateChecker::__construct()
- *
- * @param $metadataUrl
- * @param $pluginFile
- * @param string $slug
- * @param int $checkPeriod
- * @param string $optionName
- * @param string $muPluginFile
- * @return PluginUpdateChecker_3_2
- */
- public static function buildUpdateChecker($metadataUrl, $pluginFile, $slug = '', $checkPeriod = 12, $optionName = '', $muPluginFile = '') {
- $class = self::getLatestClassVersion('PluginUpdateChecker');
- return new $class($metadataUrl, $pluginFile, $slug, $checkPeriod, $optionName, $muPluginFile);
- }
-
- /**
- * Get the specific class name for the latest available version of a class.
- *
- * @param string $class
- * @return string|null
- */
- public static function getLatestClassVersion($class) {
- if ( !self::$sorted ) {
- self::sortVersions();
- }
-
- if ( isset(self::$classVersions[$class]) ) {
- return reset(self::$classVersions[$class]);
- } else {
- return null;
- }
- }
-
- /**
- * Sort available class versions in descending order (i.e. newest first).
- */
- protected static function sortVersions() {
- foreach ( self::$classVersions as $class => $versions ) {
- uksort($versions, array(__CLASS__, 'compareVersions'));
- self::$classVersions[$class] = $versions;
- }
- self::$sorted = true;
- }
-
- protected static function compareVersions($a, $b) {
- return -version_compare($a, $b);
- }
-
- /**
- * Register a version of a class.
- *
- * @access private This method is only for internal use by the library.
- *
- * @param string $generalClass Class name without version numbers, e.g. 'PluginUpdateChecker'.
- * @param string $versionedClass Actual class name, e.g. 'PluginUpdateChecker_1_2'.
- * @param string $version Version number, e.g. '1.2'.
- */
- public static function addVersion($generalClass, $versionedClass, $version) {
- if ( !isset(self::$classVersions[$generalClass]) ) {
- self::$classVersions[$generalClass] = array();
- }
- self::$classVersions[$generalClass][$version] = $versionedClass;
- self::$sorted = false;
- }
-}
-
-endif;
+//Register classes defined in this file with the factory.
+Puc_v4_Factory::addVersion('Plugin_UpdateChecker', 'Puc_v4_Plugin_UpdateChecker', '4.0');
+Puc_v4_Factory::addVersion('Theme_UpdateChecker', 'Puc_v4_Theme_UpdateChecker', '4.0');
-require_once(dirname(__FILE__) . '/github-checker.php');
+Puc_v4_Factory::addVersion('Vcs_PluginUpdateChecker', 'Puc_v4_Vcs_PluginUpdateChecker', '4.0');
+Puc_v4_Factory::addVersion('Vcs_ThemeUpdateChecker', 'Puc_v4_Vcs_ThemeUpdateChecker', '4.0');
-//Register classes defined in this file with the factory.
-PucFactory::addVersion('PluginUpdateChecker', 'PluginUpdateChecker_3_2', '3.2');
-PucFactory::addVersion('PluginUpdate', 'PluginUpdate_3_2', '3.2');
-PucFactory::addVersion('PluginInfo', 'PluginInfo_3_2', '3.2');
-PucFactory::addVersion('PucGitHubChecker', 'PucGitHubChecker_3_2', '3.2');
+Puc_v4_Factory::addVersion('GitHubApi', 'Puc_v4_Vcs_GitHubApi', '4.0');
+Puc_v4_Factory::addVersion('BitBucketApi', 'Puc_v4_Vcs_BitBucketApi', '4.0');
diff --git a/vendor/readme-parser.php b/vendor/readme-parser.php
index ed21eaba..d89a06ea 100644
--- a/vendor/readme-parser.php
+++ b/vendor/readme-parser.php
@@ -1,14 +1,16 @@
=') ? '' : 'Legacy') . '.php');
}
$instance = Parsedown::instance();
@@ -328,4 +331,4 @@ function decodeit( $matches ) {
} // end class
-Class Automattic_Readme extends PucReadmeParser {}
+endif;
\ No newline at end of file