get('scheduler.defaults', []); $this->config = $config; $this->status_path = Grav::instance()['locator']->findResource('user-data://scheduler', true, true); if (!file_exists($this->status_path)) { Folder::create($this->status_path); } } /** * Load saved jobs from config/scheduler.yaml file */ public function loadSavedJobs() { $this->saved_jobs = []; $saved_jobs = (array) Grav::instance()['config']->get('scheduler.custom_jobs', []); foreach ($saved_jobs as $id => $j) { $args = $j['args'] ?? []; $id = Grav::instance()['inflector']->hyphenize($id); $job = $this->addCommand($j['command'], $args, $id); if (isset($j['at'])) { $job->at($j['at']); } if (isset($j['output'])) { $mode = isset($j['output_mode']) && $j['output_mode'] === 'append' ? true : false; $job->output($j['output'], $mode); } if (isset($j['email'])) { $job->email($j['email']); } // store in saved_jobs $this->saved_jobs[] = $job; } return $this; } /** * Get the queued jobs as background/foreground * * @param bool $all * @return array */ public function getQueuedJobs($all = false) { $background = []; $foreground = []; foreach ($this->jobs as $job) { if ($all || $job->getEnabled()) { if ($job->runInBackground()) { $background[] = $job; } else { $foreground[] = $job; } } } return [$background, $foreground]; } /** * Get all jobs if they are disabled or not as one array * * @return array */ public function getAllJobs() { list($background, $foreground) = $this->loadSavedJobs()->getQueuedJobs(true); return array_merge($background, $foreground); } /** * Queues a PHP function execution. * * @param callable $fn The function to execute * @param array $args Optional arguments to pass to the php script * @param string $id Optional custom identifier * @return Job */ public function addFunction(callable $fn, $args = [], $id = null) { $job = new Job($fn, $args, $id); $this->queueJob($job->configure($this->config)); return $job; } /** * Queue a raw shell command. * * @param string $command The command to execute * @param array $args Optional arguments to pass to the command * @param string $id Optional custom identifier * @return Job */ public function addCommand($command, $args = [], $id = null) { $job = new Job($command, $args, $id); $this->queueJob($job->configure($this->config)); return $job; } /** * Run the scheduler. * * @param \DateTime|null $runTime Optional, run at specific moment */ public function run(\DateTime $runTime = null) { $this->loadSavedJobs(); list($background, $foreground) = $this->getQueuedJobs(false); $alljobs = array_merge($background, $foreground); if (null === $runTime) { $runTime = new \DateTime('now'); } // Star processing jobs foreach ($alljobs as $job) { if ($job->isDue($runTime)) { $job->run(); $this->jobs_run[] = $job; } } // Finish handling any background jobs foreach($background as $job) { $job->finalize(); } // Store states $this->saveJobStates(); } /** * Reset all collected data of last run. * * Call before run() if you call run() multiple times. */ public function resetRun() { // Reset collected data of last run $this->executed_jobs = []; $this->failed_jobs = []; $this->output_schedule = []; return $this; } /** * Get the scheduler verbose output. * * @param string $type Allowed: text, html, array * @return mixed The return depends on the requested $type */ public function getVerboseOutput($type = 'text') { switch ($type) { case 'text': return implode("\n", $this->output_schedule); case 'html': return implode('
', $this->output_schedule); case 'array': return $this->output_schedule; default: throw new \InvalidArgumentException('Invalid output type'); } } /** * Remove all queued Jobs. */ public function clearJobs() { $this->jobs = []; return $this; } /** * Helper to get the full Cron command * * @return string */ public function getCronCommand() { $phpBinaryFinder = new PhpExecutableFinder(); $php = $phpBinaryFinder->find(); $command = 'cd ' . str_replace(' ', '\ ', GRAV_ROOT) . ';' . $php . ' bin/grav scheduler'; return "(crontab -l; echo \"* * * * * {$command} 1>> /dev/null 2>&1\") | crontab -"; } /** * Helper to determine if cron job is setup * * @return int */ public function isCrontabSetup() { $process = new Process('crontab -l'); $process->run(); if ($process->isSuccessful()) { $output = $process->getOutput(); return preg_match('$bin\/grav schedule$', $output) ? 1 : 0; } $error = $process->getErrorOutput(); return Utils::startsWith($error, 'crontab: no crontab') ? 0 : 2; } /** * Get the Job states file * * @return \RocketTheme\Toolbox\File\FileInterface|YamlFile */ public function getJobStates() { return YamlFile::instance($this->status_path . '/status.yaml'); } /** * Save job states to statys file */ private function saveJobStates() { $now = time(); $new_states = []; foreach ($this->jobs_run as $job) { if ($job->isSuccessful()) { $new_states[$job->getId()] = ['state' => 'success', 'last-run' => $now]; $this->pushExecutedJob($job); } else { $new_states[$job->getId()] = ['state' => 'failure', 'last-run' => $now, 'error' => $job->getOutput()]; $this->pushFailedJob($job); } } $saved_states = $this->getJobStates(); $saved_states->save(array_merge($saved_states->content(), $new_states)); } /** * Queue a job for execution in the correct queue. * * @param Job $job * @return void */ private function queueJob(Job $job) { $this->jobs[] = $job; // Store jobs } /** * Add an entry to the scheduler verbose output array. * * @param string $string * @return void */ private function addSchedulerVerboseOutput($string) { $now = '[' . (new \DateTime('now'))->format('c') . '] '; $this->output_schedule[] = $now . $string; // Print to stdoutput in light gray // echo "\033[37m{$string}\033[0m\n"; } /** * Push a succesfully executed job. * * @param Job $job * @return Job */ private function pushExecutedJob(Job $job) { $this->executed_jobs[] = $job; $command = $job->getCommand(); $args = $job->getArguments(); // If callable, log the string Closure if (is_callable($command)) { $command = \is_string($command) ? $command : 'Closure'; } $this->addSchedulerVerboseOutput("Success: {$command} {$args}"); return $job; } /** * Push a failed job. * * @param Job $job * @return Job */ private function pushFailedJob(Job $job) { $this->failed_jobs[] = $job; $command = $job->getCommand(); // If callable, log the string Closure if (is_callable($command)) { $command = \is_string($command) ? $command : 'Closure'; } $output = trim($job->getOutput()); $this->addSchedulerVerboseOutput("Error: {$command}{$output}"); return $job; } }