hemall.terabimsoft.com.cn/app/framework/Cron/Cron.php

<?php


namespace app\framework\Cron;

use app\common\services\SystemMsgService;
use Illuminate\Support\Facades\Redis;

/**
 * Cron
 *
 * Cron job management
 * NOTE: The excellent library mtdowling/cron-expression (https://github.com/mtdowling/cron-expression) is required.
 *
 * @package Cron
 * @author  Marc Liebig
 */
class Cron
{

    /**
     * @static
     * @var array Saves all the cron jobs
     */
    private static $cronJobs = array();

    /**
     * @static
     * @var \Monolog\Logger Logger object Monolog logger object if logging is wished or null if nothing should be logged to this logger
     */
    private static $logger;

    function __construct()
    {
    }

    /**
     * Add a cron job
     *
     * Expression definition:
     *
     *       *    *    *    *    *    *
     *       -    -    -    -    -    -
     *       |    |    |    |    |    |
     *       |    |    |    |    |    + year [optional]
     *       |    |    |    |    +----- day of week (0 - 7) (Sunday=0 or 7)
     *       |    |    |    +---------- month (1 - 12)
     *       |    |    +--------------- day of month (1 - 31)
     *       |    +-------------------- hour (0 - 23)
     *       +------------------------- min (0 - 59)
     *
     * @static
     * @param string $name The name for the cron job - has to be unique
     * @param string $expression The cron job expression (e.g. for every minute: '* * * * *')
     * @param callable $function The anonymous function which will be executed
     * @param bool $isEnabled optional If the cron job should be enabled or disabled - the standard configuration is enabled
     * @throws \InvalidArgumentException if one of the parameters has the wrong data type, is incorrect or is not set
     */
    public static function add($name, $expression, $function, $isEnabled = true)
    {

        // Check if the given job name is set and is a string
        if (!isset($name) || !is_string($name)) {
            throw new \InvalidArgumentException('Method argument $name is not set or not a string.');
        }

        // Check if the given expression is set and is correct
        if (!isset($expression) || count(explode(' ', $expression)) < 5 || count(explode(' ', $expression)) > 6) {
            throw new \InvalidArgumentException('Method argument $expression is not set or invalid.');
        }

        // Check if the given closure is set and is callabale
        if (!isset($function) || !is_callable($function)) {
            throw new \InvalidArgumentException('Method argument $function is not set or not callable.');
        }

        // Check if the given isEnabled flag is set and is a boolean
        if (!isset($isEnabled) || !is_bool($isEnabled)) {
            throw new \InvalidArgumentException('Method argument $isEnabled is not set or not a boolean.');
        }

        // Check if the name is unique
        foreach (self::$cronJobs as $job) {
            if ($job['name'] === $name) {
                \Log::error('Cron job $name "' . $name . '" is not unique and already used.',$job);
                throw new \InvalidArgumentException('Cron job $name "' . $name . '" is not unique and already used.');
            }
        }

        // Create the CronExpression - all the magic goes here
        $expression = \Cron\CronExpression::factory($expression);

        // Add the new created cron job to the many other little cron jobs
        array_push(self::$cronJobs, array('name' => $name, 'expression' => $expression, 'enabled' => $isEnabled, 'function' => $function));
    }

    /**
     * Remove a cron job by name
     *
     * @static
     * @param string $name The name of the cron job which should be removed from execution
     * @return bool Return true if a cron job with the given name was found and was successfully removed or return false if no job with the given name was found
     */
    public static function remove($name)
    {

        foreach (self::$cronJobs as $jobKey => $jobValue) {
            if ($jobValue['name'] === $name) {
                unset(self::$cronJobs[$jobKey]);
                return true;
            }
        }
        return false;
    }

    private static function lockJob($jobName)
    {
        if ($pid = Redis::hget('RunningCronJobs', $jobName)) {
            if (posix_kill($pid, 0)) {
                // 正在运行
                return false;
            }else{
                Redis::hdel('RunningCronJobs', $jobName);
            }
        }
        Redis::hset('RunningCronJobs', $jobName, getmypid());
        return true;
    }

    private static function unlockJob($jobName)
    {
        Redis::hdel('RunningCronJobs', $jobName);
    }

    /**
     * Run the cron jobs
     * This method checks and runs all the defined cron jobs at the right time
     * This method (route) should be called automatically by a server or service
     *
     * @static
     * @param bool $checkRundateOnce optional When we check if a cronjob is due do we take into account the time when the run function was called ($checkRundateOnce = true) or do we take into account the time when each individual cronjob is executed ($checkRundateOnce = false) - default value is true
     * @return array Return an array with the rundate, runtime, errors and a result cron job array (with name, function return value, runtime in seconds)
     */
    public static function run($checkRundateOnce = true)
    {

        // If a new lock file is created, $overlappingLockFile will be equals the file path
        $overlappingLockFile = "";

        try {
            // Get the rundate
            $runDate = new \DateTime();

            // Fire event before the Cron run will be executed
            \Event::dispatch('cron.beforeRun', array($runDate->getTimestamp()));

            // Check if prevent job overlapping is enabled and create lock file if true
            $preventOverlapping = self::getConfig('preventOverlapping', false);

            if (is_bool($preventOverlapping) && $preventOverlapping) {

                $storagePath = "";
                // Fallback function for Laravel3 with helper function path('storage')
                if (function_exists('storage_path')) {
                    $storagePath = storage_path();
                } else if (function_exists('path')) {
                    $storagePath = path('storage');
                }

                if (!empty($storagePath)) {

                    $lockFile = $storagePath . DIRECTORY_SEPARATOR . 'cron.lock';

                    if (file_exists($lockFile)) {
                        self::log('warning', 'Lock file found - Cron is still running and prevent job overlapping is enabled - second Cron run will be terminated.');

                        // Fire the Cron locked event
                        \Event::dispatch('cron.locked', array('lockfile' => $lockFile));

                        // Fire the after run event, because we are done here
                        \Event::dispatch('cron.afterRun', array('rundate' => $runDate->getTimestamp(), 'inTime' => -1, 'runtime' => -1, 'errors' => 0, 'crons' => array(), 'lastRun' => array()));
                        return array('rundate' => $runDate->getTimestamp(), 'inTime' => -1, 'runtime' => -1, 'errors' => 0, 'crons' => array(), 'lastRun' => array());
                    } else {

                        // Create lock file
                        touch($lockFile);

                        if (!file_exists($lockFile)) {
                            self::log('error', 'Could not create Cron lock file at ' . $lockFile . '.');
                        } else {
                            // Lockfile created successfully
                            // $overlappingLockFile is used to delete the lock file after Cron run
                            $overlappingLockFile = $lockFile;
                        }
                    }
                } else {
                    self::log('error', 'Could not get the path to the Laravel storage directory.');
                }
            }

            // Get the run interval from Laravel config

            // Initialize the job and job error array and start the runtime calculation
            $allJobs = array();
            $errorJobs = array();
            $beforeAll = microtime(true);

            // Should we check if the cron expression is due once at method call
            if ($checkRundateOnce) {
                $checkTime = $runDate;
            } else {
                // or do we compare it to 'now'
                $checkTime = 'now';
            }

            // For all defined cron jobs run this
            self::log('info',  $checkTime->getTimestamp() .' 定时任务开始');
            foreach (self::$cronJobs as $job) {

                // If the job is enabled and if the time for this job has come
                if ($job['enabled'] && $job['expression']->isDue($checkTime)) {

                    // Get the start time of the job runtime
                    $beforeOne = microtime(true);

                    // Run the function and save the return to $return - all the magic goes here
                    try {
                        self::log('info',  $checkTime->getTimestamp().':'.$job['name'] .' start');

                        if (!self::lockJob($job['name'])) {
                            // 避免重复运行
                            continue;
                        }
                        $return = $job['function']();
                        self::unlockJob($job['name']);
                        self::log('info',  $checkTime->getTimestamp().':'.$job['name'] .' finish');
                    } catch (\Exception $e) {
                        // If an uncaught exception occurs
						SystemMsgService::addWorkMessage(['title'=>'定时任务执行错误','content'=>"{$job['name']}:{$e->getMessage()}"]);
						$return = get_class($e) . ' in job ' . $job['name'] . ': ' . $e->getMessage();
                        self::log('error', get_class($e) . ' in job ' . $job['name'] . ': ' . $e->getMessage() . "\r\n" . $e->getTraceAsString());
                    }

                    // Get the end time of the job runtime
                    $afterOne = microtime(true);

                    // If the function returned not null then we assume that there was an error
                    if (!is_null($return)) {
                        // Add to error array
                        array_push($errorJobs, array('name' => $job['name'], 'return' => $return, 'runtime' => ($afterOne - $beforeOne)));
                        // Log error job
                        self::log('error', 'Job with the name ' . $job['name'] . ' was run with errors.');
                        // Fire event after executing a job with erros
                        \Event::dispatch('cron.jobError', array('name' => $job['name'], 'return' => $return, 'runtime' => ($afterOne - $beforeOne), 'rundate' => $runDate->getTimestamp()));
                    } else {
                        // Fire event after executing a job successfully
                        \Event::dispatch('cron.jobSuccess', array('name' => $job['name'], 'runtime' => ($afterOne - $beforeOne), 'rundate' => $runDate->getTimestamp()));
                    }

                    // Push the information of the ran cron job to the allJobs array (including name, return value, runtime)
                    array_push($allJobs, array('name' => $job['name'], 'return' => $return, 'runtime' => ($afterOne - $beforeOne)));
                }

            }
            self::log('info',  $checkTime->getTimestamp() .' 定时任务结束');
            // Get the end runtime after all cron job executions
            $afterAll = microtime(true);
// todo log中记录执行时间
            // If database logging is enabled, save manager und jobs to db
            if (self::isDatabaseLogging()) {
                // todo 记录错误数据$errorJobs


            }

            // Removing overlapping lock file if lockfile was created
            if (!empty($overlappingLockFile)) {
                self::deleteLockFile($overlappingLockFile);
            }

            $returnArray = array('rundate' => $runDate->getTimestamp(), 'inTime' => $inTime, 'runtime' => ($afterAll - $beforeAll), 'errors' => count($errorJobs), 'crons' => $allJobs);

            // If Cron was called before, add the latest call to the $returnArray
            if (isset($lastManager[0]) && !empty($lastManager[0])) {
                $returnArray['lastRun'] = array('rundate' => $lastManager[0]->rundate, 'runtime' => $lastManager[0]->runtime);
            } else {
                $returnArray['lastRun'] = array();
            }

            // Fire event after the Cron run was executed
            \Event::dispatch('cron.afterRun', $returnArray);

            // Return the cron jobs array (including rundate, in-time boolean, runtime in seconds, number of errors and an array with the cron jobs reports)
            return $returnArray;
        } catch (\Exception $ex) {

            // Removing overlapping lock file if lockfile was created
            if (!empty($overlappingLockFile)) {
                self::deleteLockFile($overlappingLockFile);
            }

            throw($ex);
        }
    }

    /**
     * Delete lock file
     *
     * @static
     * @param string $file Path and name of the lock file which should be deleted
     */
    private static function deleteLockFile($file)
    {
        if (file_exists($file)) {
            if (is_writable($file)) {
                unlink($file);

                if (file_exists($file)) {
                    self::log('critical', 'Could not delete Cron lock file at ' . $file . ' - please delete this file manually - as long as this lock file exists, Cron will not run.');
                }
            } else {
                self::log('critical', 'Could not delete Cron lock file at ' . $file . ' because it is not writable - please delete this file manually - as long as this lock file exists, Cron will not run.');
            }
        } else {
            self::log('warning', 'Could not delete Cron lock file at ' . $file . ' because file is not found.');
        }
    }


    /**
     * Add a custom Monolog logger object
     *
     * @static
     * @param \Monolog\Logger $logger optional The Monolog logger object which will be used for cron logging, if this parameter is null the logger will be removed - default value is null
     */
    public static function setLogger(\Monolog\Logger $logger = null)
    {
        self::$logger = $logger;
    }

    /**
     * Get the Monolog logger object
     *
     * @static
     * @return  \Monolog\Logger|null Return the set logger object or null if no logger is set
     */
    public static function getLogger()
    {
        return self::$logger;
    }

    /**
     * Log a message with the given level to Monolog logger if one is set and to Laravels build in Logger if it is enabled
     *
     * @static
     * @param string $level The logger level as string which can be debug, info, notice, warning, error, critival, alert, emergency
     * @param string $message The message which will be logged to Monolog
     * @throws \InvalidArgumentException if the parameter $level or $message is not of the data type string or if the $level parameter does not match with debug, info, notice, warning, error, critival, alert or emergency
     */
    private static function log($level, $message)
    {

        // Check parameter
        if (!is_string($level) || !is_string($message)) {
            throw new \InvalidArgumentException('Function paramter $level or $message is not of the data type string.');
        }

        // If a Monolog logger object is set, use it
        if (!empty(self::$logger)) {
            // Switch the lower case level string and log the message with the given level
            switch (strtolower($level)) {
                case "debug":
                    self::$logger->addDebug($message);
                    break;
                case "info":
                    self::$logger->addInfo($message);
                    break;
                case "notice":
                    self::$logger->addNotice($message);
                    break;
                case "warning":
                    self::$logger->addWarning($message);
                    break;
                case "error":
                    self::$logger->addError($message);
                    break;
                case "critical":
                    self::$logger->addCritical($message);
                    break;
                case "alert":
                    self::$logger->addAlert($message);
                    break;
                case "emergency":
                    self::$logger->addEmergency($message);
                    break;
                default:
                    throw new \InvalidArgumentException('Invalid log $level parameter with string ' . $level . '.');
            }
        }

        $laravelLogging = self::getConfig('laravelLogging');

        // If Laravel logging is enabled
        if (is_bool($laravelLogging) && $laravelLogging) {
            switch (strtolower($level)) {
                case "debug":
                    \Log::debug($message);
                    break;
                case "info":
                    \Log::info($message);
                    break;
                case "notice":
                    \Log::notice($message);
                    break;
                case "warning":
                    \Log::warning($message);
                    break;
                case "error":
                    \Log::error($message);
                    break;
                case "critical":
                    \Log::critical($message);
                    break;
                case "alert":
                    \Log::alert($message);
                    break;
                case "emergency":
                    \Log::emergency($message);
                    break;
                default:
                    throw new \InvalidArgumentException('Invalid log $level parameter with string ' . $level . '.');
            }
        }
    }

    /**
     * Enable or disable Laravels build in logging
     *
     * @static
     * @param bool $bool Set to enable or disable Laravels logging
     * @throws \InvalidArgumentException if the $bool function paramter is not a boolean
     */
    public static function setLaravelLogging($bool)
    {
        if (is_bool($bool)) {
            self::setConfig('laravelLogging', $bool);
        } else {
            throw new \InvalidArgumentException('Function paramter $bool with value "' . $bool . '" is not a boolean.');
        }
    }

    /**
     * Is Laravels build in logging enabled or disabled
     *
     * @static
     * @return bool Return boolean which indicates if Laravels logging is enabled or disabled
     * @throws \UnexpectedValueException if the cron::laravelLogging config value is not a boolean or NULL
     */
    public static function isLaravelLogging()
    {

        $laravelLogging = self::getConfig('laravelLogging');

        if (is_null($laravelLogging) || is_bool($laravelLogging)) {
            return $laravelLogging;
        } else {
            throw new \UnexpectedValueException('Config option "laravelLogging" is not a boolean or not equals NULL.');
        }
    }

    /**
     * Enable or disable database logging
     *
     * @static
     * @param bool $bool Set to enable or disable database logging
     * @throws \InvalidArgumentException if the $bool function paramter is not a boolean
     */
    public static function setDatabaseLogging($bool)
    {
        if (is_bool($bool)) {
            self::setConfig('databaseLogging', $bool);
        } else {
            throw new \InvalidArgumentException('Function paramter $bool with value "' . $bool . '" is not a boolean.');
        }
    }

    /**
     * Is logging to database enabled or disabled
     *
     * @static
     * @return boolean Return boolean which indicates if database logging is enabled or disabled
     * @throws \UnexpectedValueException if the cron::databaseLogging config value is not a boolean
     */
    public static function isDatabaseLogging()
    {
        $databaseLogging = self::getConfig('databaseLogging');

        if (is_null($databaseLogging)) {
            // If the value is not set, return false
            return false;
        } else if (is_bool($databaseLogging)) {
            return $databaseLogging;
        } else {
            throw new \UnexpectedValueException('Config option "databaseLogging" is not a boolean or not equals NULL.');
        }
    }

    /**
     * Enable or disable logging error jobs only to database
     * NOTE: This works only if database logging is enabled
     *
     * @static
     * @param bool $bool Set to enable or disable logging error jobs only
     * @throws \InvalidArgumentException if the $bool function paramter is not a boolean
     */
    public static function setLogOnlyErrorJobsToDatabase($bool)
    {
        if (is_bool($bool)) {
            self::setConfig('logOnlyErrorJobsToDatabase', $bool);
        } else {
            throw new \InvalidArgumentException('Function paramter $bool with value "' . $bool . '" is not a boolean.');
        }
    }

    /**
     * Check if log error jobs to database only is enabled or disabled
     *
     * @return bool Return boolean which indicates if logging only error jobs to database is enabled or disabled
     * @throws \UnexpectedValueException if the cron::logOnlyErrorJobsToDatabase config value is not a boolean
     */
    public static function isLogOnlyErrorJobsToDatabase()
    {

        $logOnlyErrorJobsToDatabase = self::getConfig('logOnlyErrorJobsToDatabase');

        if (is_null($logOnlyErrorJobsToDatabase)) {
            // If the value is not set, return false
            return false;
        } else if (is_bool($logOnlyErrorJobsToDatabase)) {
            return $logOnlyErrorJobsToDatabase;
        } else {
            throw new \UnexpectedValueException('Config option "logOnlyErrorJobsToDatabase" is not a boolean or not equals NULL.');
        }
    }

    /**
     * Reset the Cron class
     * Remove the cron jobs array and the logger object
     *
     * @static
     */
    public static function reset()
    {
        self::$cronJobs = array();
        self::$logger = null;
    }

    /**
     * Set the run interval - the run interval is the time between two cron job route calls
     *
     * @static
     * @param int $minutes Set the interval in minutes
     * @throws \InvalidArgumentException if the $minutes function paramter is not an integer
     */
    public static function setRunInterval($minutes)
    {
        if (is_int($minutes)) {
            self::setConfig('runInterval', $minutes);
        } else {
            throw new \InvalidArgumentException('Function paramter $minutes with value "' . $minutes . '" is not an integer.');
        }
    }

    /**
     * Set the delete time of old database entries in hours
     *
     * @static
     * @param int $hours optional Set the delete time in hours, if this value is 0 the delete old database entries function will be disabled - default value is 0
     * @throws \InvalidArgumentException if the $hours function paramter is not an integer
     */
    public static function setDeleteDatabaseEntriesAfter($hours = 0)
    {
        if (is_int($hours)) {
            self::setConfig('deleteDatabaseEntriesAfter', $hours);
        } else {
            throw new \InvalidArgumentException('Function paramter $hours with value "' . $hours . '" is not an integer.');
        }
    }

    /**
     * Get the current delete time value in hours for old database entries
     *
     * @return int|null Return the current delete time value in hours or NULL if no value was set
     * @throws \UnexpectedValueException if the cron::deleteDatabaseEntriesAfter config value is not an integer or NULL
     */
    public static function getDeleteDatabaseEntriesAfter()
    {

        $deleteDatabaseEntriesAfter = self::getConfig('deleteDatabaseEntriesAfter');

        if (is_null($deleteDatabaseEntriesAfter) || is_int($deleteDatabaseEntriesAfter)) {
            return $deleteDatabaseEntriesAfter;
        } else {
            throw new \UnexpectedValueException('Config option "deleteDatabaseEntriesAfter" is not an integer or not equals NULL.');
        }
    }

    /**
     * Enable a job by job name
     *
     * @static
     * @param string $jobname The name of the job which should be enabled
     * @param bool $enable The trigger for enable (true) or disable (false) the job with the given name
     * @return bool Return true if job was enabled successfully or false if no job with the $jobname parameter was found
     * @throws \InvalidArgumentException if the $enable function paramter is not a boolean
     */
    public static function setEnableJob($jobname, $enable = true)
    {
        // Check patameter
        if (!is_bool($enable)) {
            throw new \InvalidArgumentException('Function paramter $enable with value "' . $enable . '" is not a boolean.');
        }

        // Walk through the cron jobs and find the job with the given name
        foreach (self::$cronJobs as $jobKey => $jobValue) {
            if ($jobValue['name'] === $jobname) {
                // If a job with the given name is found, set the enable boolean
                self::$cronJobs[$jobKey]['enabled'] = $enable;
                return true;
            }
        }
        return false;
    }

    /**
     * Disable a job by job name
     *
     * @static
     * @param String $jobname The name of the job which should be disabled
     * @return bool Return true if job was disabled successfully or false if no job with the $jobname parameter was found
     */
    public static function setDisableJob($jobname)
    {
        return self::setEnableJob($jobname, false);
    }

    /**
     * Is the given job by name enabled or disabled
     *
     * @static
     * @param String $jobname The name of the job which should be checked
     * @return bool|null Return boolean if job is enabled (true) or disabled (false) or null if no job with the given name is found
     */
    public static function isJobEnabled($jobname)
    {

        // Walk through the cron jobs and find the job with the given name
        foreach (self::$cronJobs as $jobKey => $jobValue) {
            if ($jobValue['name'] === $jobname) {
                // If a job with the given name is found, return the is enabled boolean
                return self::$cronJobs[$jobKey]['enabled'];
            }
        }
        return;
    }

    /**
     * Enable prevent job overlapping
     *
     * @static
     */
    public static function setEnablePreventOverlapping()
    {
        self::setConfig('preventOverlapping', true);
    }

    /**
     * Disable prevent job overlapping
     *
     * @static
     */
    public static function setDisablePreventOverlapping()
    {
        self::setConfig('preventOverlapping', false);
    }

    /**
     * Is prevent job overlapping enabled or disabled
     *
     * @static
     * @return bool Return boolean if prevent job overlapping is enabled (true) or disabled (false)
     */
    public static function isPreventOverlapping()
    {

        $preventOverlapping = self::getConfig('preventOverlapping');

        if (is_bool($preventOverlapping)) {
            return $preventOverlapping;
        } else {
            // If no value or not a boolean value is given, prevent overlapping is disabled
            return false;
        }
    }

    /**
     * Enable the Cron run in time check
     *
     * @static
     */
    public static function setEnableInTimeCheck()
    {
        self::setConfig('inTimeCheck', true);
    }

    /**
     * Disable the Cron run in time check
     *
     * @static
     */
    public static function setDisableInTimeCheck()
    {
        self::setConfig('inTimeCheck', false);
    }

    /**
     * Is the Cron run in time check enabled or disabled
     *
     * @static
     * @return bool Return boolean if the Cron run in time check is enabled (true) or disabled (false)
     */
    public static function isInTimeCheck()
    {

        $inTimeCheck = self::getConfig('inTimeCheck');

        if (is_bool($inTimeCheck)) {
            return $inTimeCheck;
        } else {
            // If no value or not a boolean value is given, in time check should be enabled
            return true;
        }
    }

    /**
     * Get added Cron jobs as array
     *
     * @static
     * @return array Return array of the added Cron jobs
     */
    public static function getCronJobs()
    {
        return self::$cronJobs;
    }

    /**
     * Get Config value
     *
     * @static
     * @param string $key Config key to get the value for
     * @param mixed $defaultValue If no value for the given key is available, return this default value
     */
    private static function getConfig($key, $defaultValue = NULL)
    {
        return \Config::get('cron::' . $key) ?: $defaultValue;
    }

    /**
     * Set config value
     *
     * @static
     * @param string $key Config key to set the value for
     * @param mixed $value Value which should be set
     */
    private static function setConfig($key, $value)
    {
        \Config::set('liebigCron.' . $key, $value);
    }
}