ActionScheduler
2 months ago
CliCommands
1 month ago
Triggers
2 months ago
Workers
2 days ago
CronHelper.php
2 months ago
CronTrigger.php
2 years ago
CronWorkerInterface.php
3 years ago
CronWorkerRunner.php
2 months ago
CronWorkerScheduler.php
10 months ago
Daemon.php
2 days ago
DaemonActionSchedulerRunner.php
6 months ago
DaemonHttpRunner.php
2 months ago
Supervisor.php
3 years ago
index.php
3 years ago
CronHelper.php
241 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Cron; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Router\Endpoints\CronDaemon as CronDaemonEndpoint; |
| 9 | use MailPoet\Router\Router; |
| 10 | use MailPoet\Settings\SettingsController; |
| 11 | use MailPoet\Util\Security; |
| 12 | use MailPoet\WP\Functions as WPFunctions; |
| 13 | |
| 14 | class CronHelper { |
| 15 | const DAEMON_EXECUTION_LIMIT = 20; // seconds |
| 16 | const DAEMON_REQUEST_TIMEOUT = 5; // seconds |
| 17 | const DAEMON_SETTING = 'cron_daemon'; |
| 18 | const DAEMON_STATUS_ACTIVE = 'active'; |
| 19 | const DAEMON_STATUS_INACTIVE = 'inactive'; |
| 20 | |
| 21 | // Error codes |
| 22 | const DAEMON_EXECUTION_LIMIT_REACHED = 1001; |
| 23 | |
| 24 | /** @var SettingsController */ |
| 25 | private $settings; |
| 26 | |
| 27 | /** @var WPFunctions */ |
| 28 | private $wp; |
| 29 | |
| 30 | public function __construct( |
| 31 | SettingsController $settings, |
| 32 | WPFunctions $wp |
| 33 | ) { |
| 34 | $this->settings = $settings; |
| 35 | $this->wp = $wp; |
| 36 | } |
| 37 | |
| 38 | public function getDaemonExecutionLimit() { |
| 39 | $limit = $this->wp->applyFilters('mailpoet_cron_get_execution_limit', self::DAEMON_EXECUTION_LIMIT); |
| 40 | return $limit; |
| 41 | } |
| 42 | |
| 43 | public function getDaemonExecutionTimeout() { |
| 44 | $limit = $this->getDaemonExecutionLimit(); |
| 45 | $timeout = $limit * 1.75; |
| 46 | return $this->wp->applyFilters('mailpoet_cron_get_execution_timeout', $timeout); |
| 47 | } |
| 48 | |
| 49 | public function createDaemon($token) { |
| 50 | $daemon = [ |
| 51 | 'token' => $token, |
| 52 | 'status' => self::DAEMON_STATUS_ACTIVE, |
| 53 | 'run_accessed_at' => null, |
| 54 | 'run_started_at' => null, |
| 55 | 'run_completed_at' => null, |
| 56 | 'last_error' => null, |
| 57 | 'last_error_date' => null, |
| 58 | ]; |
| 59 | $this->saveDaemon($daemon); |
| 60 | return $daemon; |
| 61 | } |
| 62 | |
| 63 | public function restartDaemon($token) { |
| 64 | return $this->createDaemon($token); |
| 65 | } |
| 66 | |
| 67 | public function getDaemon() { |
| 68 | return $this->settings->fetch(self::DAEMON_SETTING); |
| 69 | } |
| 70 | |
| 71 | public function saveDaemonLastError($error) { |
| 72 | $daemon = $this->getDaemon(); |
| 73 | if ($daemon) { |
| 74 | $daemon['last_error'] = $error; |
| 75 | $daemon['last_error_date'] = time(); |
| 76 | $this->saveDaemon($daemon); |
| 77 | } |
| 78 | } |
| 79 | |
| 80 | public function saveDaemonRunCompleted($runCompletedAt) { |
| 81 | $daemon = $this->getDaemon(); |
| 82 | if ($daemon) { |
| 83 | $daemon['run_completed_at'] = $runCompletedAt; |
| 84 | $this->saveDaemon($daemon); |
| 85 | } |
| 86 | } |
| 87 | |
| 88 | public function saveDaemon($daemon) { |
| 89 | $daemon['updated_at'] = time(); |
| 90 | $this->settings->set( |
| 91 | self::DAEMON_SETTING, |
| 92 | $daemon |
| 93 | ); |
| 94 | } |
| 95 | |
| 96 | public function deactivateDaemon($daemon) { |
| 97 | // We do not need to deactivate an inactive daemon |
| 98 | if (isset($daemon['status']) && $daemon['status'] === self::DAEMON_STATUS_INACTIVE) { |
| 99 | return; |
| 100 | } |
| 101 | $daemon['status'] = self::DAEMON_STATUS_INACTIVE; |
| 102 | $this->settings->set( |
| 103 | self::DAEMON_SETTING, |
| 104 | $daemon |
| 105 | ); |
| 106 | } |
| 107 | |
| 108 | public function createToken() { |
| 109 | return Security::generateRandomString(); |
| 110 | } |
| 111 | |
| 112 | public function pingDaemon() { |
| 113 | $url = $this->getCronUrl( |
| 114 | CronDaemonEndpoint::ACTION_PING_RESPONSE |
| 115 | ); |
| 116 | $result = $this->queryCronUrl($url); |
| 117 | if (is_wp_error($result)) return $result->get_error_message(); |
| 118 | $response = $this->wp->wpRemoteRetrieveBody($result); |
| 119 | $response = substr(trim($response), -strlen(DaemonHttpRunner::PING_SUCCESS_RESPONSE)) === DaemonHttpRunner::PING_SUCCESS_RESPONSE ? |
| 120 | DaemonHttpRunner::PING_SUCCESS_RESPONSE : |
| 121 | $response; |
| 122 | return $response; |
| 123 | } |
| 124 | |
| 125 | public function validatePingResponse($response) { |
| 126 | return $response === DaemonHttpRunner::PING_SUCCESS_RESPONSE; |
| 127 | } |
| 128 | |
| 129 | public function accessDaemon($token) { |
| 130 | $data = ['token' => $token]; |
| 131 | $url = $this->getCronUrl( |
| 132 | CronDaemonEndpoint::ACTION_RUN, |
| 133 | $data |
| 134 | ); |
| 135 | $daemon = $this->getDaemon(); |
| 136 | if (!$daemon) { |
| 137 | throw new \LogicException('Daemon does not exist.'); |
| 138 | } |
| 139 | $daemon['run_accessed_at'] = time(); |
| 140 | $this->saveDaemon($daemon); |
| 141 | $result = $this->queryCronUrl($url); |
| 142 | return $this->wp->wpRemoteRetrieveBody($result); |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * @return bool|null |
| 147 | */ |
| 148 | public function isDaemonAccessible() { |
| 149 | $daemon = $this->getDaemon(); |
| 150 | if (!$daemon || !isset($daemon['run_accessed_at'])) { |
| 151 | return null; |
| 152 | } |
| 153 | if ($daemon['run_accessed_at'] <= (int)$daemon['run_started_at']) { |
| 154 | return true; |
| 155 | } |
| 156 | if ( |
| 157 | $daemon['run_accessed_at'] + self::DAEMON_REQUEST_TIMEOUT < time() && |
| 158 | $daemon['run_accessed_at'] > (int)$daemon['run_started_at'] |
| 159 | ) { |
| 160 | return false; |
| 161 | } |
| 162 | return null; |
| 163 | } |
| 164 | |
| 165 | public function queryCronUrl($url) { |
| 166 | $defaultArgs = [ |
| 167 | 'blocking' => true, |
| 168 | 'sslverify' => false, |
| 169 | 'timeout' => self::DAEMON_REQUEST_TIMEOUT, |
| 170 | 'user-agent' => 'MailPoet Cron', |
| 171 | ]; |
| 172 | $args = $this->wp->applyFilters('mailpoet_cron_request_args', $defaultArgs); |
| 173 | return $this->wp->wpRemotePost($url, is_array($args) ? $args : $defaultArgs); |
| 174 | } |
| 175 | |
| 176 | public function getCronUrl($action, $data = false) { |
| 177 | $url = Router::buildRequest( |
| 178 | CronDaemonEndpoint::ENDPOINT, |
| 179 | $action, |
| 180 | $data |
| 181 | ); |
| 182 | $url = is_string($url) ? $url : ''; |
| 183 | $customCronUrl = $this->wp->applyFilters('mailpoet_cron_request_url', $url); |
| 184 | if ($customCronUrl === $url) { |
| 185 | return str_replace(home_url(), $this->getSiteUrl(), $url); |
| 186 | } |
| 187 | return is_string($customCronUrl) ? $customCronUrl : $url; |
| 188 | } |
| 189 | |
| 190 | public function getSiteUrl($siteUrl = false) { |
| 191 | // additional check for some sites running inside a virtual machine or behind |
| 192 | // proxy where there could be different ports (e.g., host:8080 => guest:80) |
| 193 | if (!$siteUrl) { |
| 194 | $siteUrl = defined('MAILPOET_CRON_SITE_URL') ? MAILPOET_CRON_SITE_URL : $this->wp->homeUrl(); |
| 195 | } |
| 196 | $parsedUrl = parse_url($siteUrl); |
| 197 | if (!is_array($parsedUrl)) { |
| 198 | throw new \Exception(__('Site URL is unreachable.', 'mailpoet')); |
| 199 | } |
| 200 | |
| 201 | $callScheme = ''; |
| 202 | if (isset($parsedUrl['scheme']) && ($parsedUrl['scheme'] === 'https')) { |
| 203 | $callScheme = 'ssl://'; |
| 204 | } |
| 205 | |
| 206 | // 1. if site URL does not contain a port, return the URL |
| 207 | if (!isset($parsedUrl['port']) || empty($parsedUrl['port'])) return $siteUrl; |
| 208 | // 2. if site URL contains valid port, try connecting to it |
| 209 | $urlHost = $parsedUrl['host'] ?? ''; |
| 210 | $fp = @fsockopen($callScheme . $urlHost, $parsedUrl['port'], $errno, $errstr, 2); |
| 211 | if ($fp) return $siteUrl; |
| 212 | // 3. if connection fails, attempt to connect the standard port derived from URL |
| 213 | // schema |
| 214 | $urlScheme = $parsedUrl['scheme'] ?? ''; |
| 215 | $port = (strtolower($urlScheme) === 'http') ? 80 : 443; |
| 216 | $fp = @fsockopen($callScheme . $urlHost, $port, $errno, $errstr, 2); |
| 217 | if ($fp) return sprintf('%s://%s', $urlScheme, $urlHost); |
| 218 | // 4. throw an error if all connection attempts failed |
| 219 | throw new \Exception(__('Site URL is unreachable.', 'mailpoet')); |
| 220 | } |
| 221 | |
| 222 | public function enforceExecutionLimit($timer) { |
| 223 | $elapsedTime = microtime(true) - $timer; |
| 224 | $limit = $this->getDaemonExecutionLimit(); |
| 225 | if ($elapsedTime >= $limit) { |
| 226 | throw new \Exception( |
| 227 | sprintf( |
| 228 | // translators: %1$d is the number of seconds the daemon is allowed to run, %2$d is how many more seconds the daemon did run. |
| 229 | __( |
| 230 | 'The maximum execution time of %1$d seconds was exceeded by %2$d seconds. This task will resume during the next run.', |
| 231 | 'mailpoet' |
| 232 | ), |
| 233 | (int)round($limit), |
| 234 | (int)round($elapsedTime - $limit) |
| 235 | ), |
| 236 | self::DAEMON_EXECUTION_LIMIT_REACHED |
| 237 | ); |
| 238 | } |
| 239 | } |
| 240 | } |
| 241 |