Keith Solomon
2bbd2dc7c8
The bundled PUC was missing the setBranch() method on the main UpdateChecker class (it's only on Vcs\PluginUpdateChecker via the VcsCheckerMethods trait). When called with a non-VCS URL like the Gitea update URL, this caused a fatal error at plugin activation. Updating to PUC v5.7 (May 2026) which is the latest upstream release. The setBranch() call is removed because PUC doesn't recognize Gitea as a VCS host; the plugin falls back to PUC's plain JSON metadata mode, which is fine for a plugin hosted on a self-managed repo.
301 lines
11 KiB
PHP
301 lines
11 KiB
PHP
<?php
|
|
namespace YahnisElsts\PluginUpdateChecker\v5p7;
|
|
|
|
if ( !class_exists(Scheduler::class, false) ):
|
|
|
|
/**
|
|
* The scheduler decides when and how often to check for updates.
|
|
* It calls @see UpdateChecker::checkForUpdates() to perform the actual checks.
|
|
*/
|
|
class Scheduler {
|
|
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;
|
|
|
|
protected $hourlyCheckHooks = array('load-update.php');
|
|
|
|
/**
|
|
* @var UpdateChecker
|
|
*/
|
|
protected $updateChecker;
|
|
|
|
private $cronHook = null;
|
|
|
|
/**
|
|
* Scheduler constructor.
|
|
*
|
|
* @param UpdateChecker $updateChecker
|
|
* @param int $checkPeriod How often to check for updates (in hours).
|
|
* @param array $hourlyHooks
|
|
*/
|
|
public function __construct($updateChecker, $checkPeriod, $hourlyHooks = array('load-plugins.php')) {
|
|
$this->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';
|
|
//phpcs:ignore WordPress.WP.CronInterval.ChangeDetected -- WPCS fails to parse the callback.
|
|
add_filter('cron_schedules', array($this, '_addCustomSchedule'));
|
|
}
|
|
|
|
if ( !wp_next_scheduled($this->cronHook) && !defined('WP_INSTALLING') ) {
|
|
//Randomly offset the schedule to help prevent update server traffic spikes. Without this
|
|
//most checks may happen during times of day when people are most likely to install new plugins.
|
|
$upperLimit = max($this->checkPeriod * 3600 - 15 * 60, 1);
|
|
if ( function_exists('wp_rand') ) {
|
|
$randomOffset = wp_rand(0, $upperLimit);
|
|
} else {
|
|
//This constructor may be called before wp_rand() is available.
|
|
//phpcs:ignore WordPress.WP.AlternativeFunctions.rand_rand
|
|
$randomOffset = rand(0, $upperLimit);
|
|
}
|
|
$firstCheckTime = time() - $randomOffset;
|
|
$firstCheckTime = apply_filters(
|
|
$this->updateChecker->getUniqueName('first_check_time'),
|
|
$firstCheckTime
|
|
);
|
|
wp_schedule_event($firstCheckTime, $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'));
|
|
//phpcs:ignore Squiz.PHP.CommentedOutCode.Found -- Not actually code, just file names.
|
|
//"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, 'removeHooksIfLibraryGone'), 1, 0);
|
|
add_action('upgrader_process_complete', array($this, 'upgraderProcessComplete'), 11, 2);
|
|
|
|
} else {
|
|
//Periodic checks are disabled.
|
|
wp_clear_scheduled_hook($this->cronHook);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Remove all hooks if this version of PUC has been deleted or overwritten.
|
|
*
|
|
* Callback for the "upgrader_process_complete" action.
|
|
*/
|
|
public function removeHooksIfLibraryGone() {
|
|
//Cancel all further actions if the current version of PUC has been deleted or overwritten
|
|
//by a different version during the upgrade. If we try to do anything more in that situation,
|
|
//we could trigger a fatal error by trying to autoload a deleted class.
|
|
clearstatcache();
|
|
if ( !file_exists(__FILE__) ) {
|
|
$this->removeHooks();
|
|
$this->updateChecker->removeHooks();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Runs upon the WP action upgrader_process_complete.
|
|
*
|
|
* We look at the parameters to decide whether to call maybeCheckForUpdates() or not.
|
|
* We also check if the update checker has been removed by the update.
|
|
*
|
|
* @param \WP_Upgrader $upgrader WP_Upgrader instance
|
|
* @param array $upgradeInfo extra information about the upgrade
|
|
*/
|
|
public function upgraderProcessComplete(
|
|
/** @noinspection PhpUnusedParameterInspection */
|
|
$upgrader, $upgradeInfo
|
|
) {
|
|
//Sanity check and limitation to relevant types.
|
|
if (
|
|
!is_array($upgradeInfo) || !isset($upgradeInfo['type'], $upgradeInfo['action'])
|
|
|| 'update' !== $upgradeInfo['action'] || !in_array($upgradeInfo['type'], array('plugin', 'theme'))
|
|
) {
|
|
return;
|
|
}
|
|
|
|
//Filter out notifications of upgrades that should have no bearing upon whether or not our
|
|
//current info is up-to-date.
|
|
if ( is_a($this->updateChecker, Theme\UpdateChecker::class) ) {
|
|
if ( 'theme' !== $upgradeInfo['type'] || !isset($upgradeInfo['themes']) ) {
|
|
return;
|
|
}
|
|
|
|
//Letting too many things going through for checks is not a real problem, so we compare widely.
|
|
if ( !in_array(
|
|
strtolower($this->updateChecker->directoryName),
|
|
array_map('strtolower', $upgradeInfo['themes'])
|
|
) ) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
if ( is_a($this->updateChecker, Plugin\UpdateChecker::class) ) {
|
|
if ( 'plugin' !== $upgradeInfo['type'] || !isset($upgradeInfo['plugins']) ) {
|
|
return;
|
|
}
|
|
|
|
//Themes pass in directory names in the information array, but plugins use the relative plugin path.
|
|
if ( !in_array(
|
|
strtolower($this->updateChecker->directoryName),
|
|
array_map('dirname', array_map('strtolower', $upgradeInfo['plugins']))
|
|
) ) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
$this->maybeCheckForUpdates();
|
|
}
|
|
|
|
/**
|
|
* 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());
|
|
|
|
if ( $shouldCheck ) {
|
|
//Sanity check: Do not proceed if one of the critical classes is missing.
|
|
//That can happen - theoretically and extremely rarely - if maybeCheckForUpdates()
|
|
//is called before the old version of our plugin has been fully deleted, or
|
|
//called from an independent AJAX request during deletion.
|
|
if ( !(
|
|
class_exists(Utils::class)
|
|
&& class_exists(Metadata::class)
|
|
&& class_exists(Plugin\Update::class)
|
|
&& class_exists(Theme\Update::class)
|
|
) ) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
//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 let's 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;
|
|
}
|
|
|
|
/**
|
|
* Remove most hooks added by the scheduler.
|
|
*/
|
|
public function removeHooks() {
|
|
remove_filter('cron_schedules', array($this, '_addCustomSchedule'));
|
|
remove_action('admin_init', array($this, 'maybeCheckForUpdates'));
|
|
remove_action('load-update-core.php', array($this, 'maybeCheckForUpdates'));
|
|
|
|
if ( $this->cronHook !== null ) {
|
|
remove_action($this->cronHook, array($this, 'maybeCheckForUpdates'));
|
|
}
|
|
if ( !empty($this->hourlyCheckHooks) ) {
|
|
foreach ($this->hourlyCheckHooks as $hook) {
|
|
remove_action($hook, array($this, 'maybeCheckForUpdates'));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
endif;
|