yiicod / yii2-cron

commands/behaviors/LockUnLockBehavior.php

<?php

namespace yiicod\cron\commands\behaviors;

use Yii;
use yii\base\Behavior;
use yii\console\Controller;
use yii\helpers\Console;

/**
 * Exclude duplicate console command run.
 */
class LockUnLockBehavior extends Behavior
{
    /**
     * File time live. Default 28800 seconds (8 hour)
     */
    public $timeLock = 28800;

    /**
     * File path
     */
    protected $lockFilePath;

    /**
     * Declares events and the corresponding event handler methods.
     * If you override this method, make sure you merge the parent result to the return value.
     *
     * @return array events (array keys) and the corresponding event handler methods (array values)
     *
     * @see CBehavior::events
     */
    public function events()
    {
        return [
            Controller::EVENT_BEFORE_ACTION => 'beforeAction',
            Controller::EVENT_AFTER_ACTION => 'afterAction',
        ];
    }

    /**
     * Parses the command line arguments and determines which action to perform.
     *
     * @param array $args command line arguments
     *
     * @return array the action name, named options (name=>value), and unnamed options
     *
     * @since 1.1.5
     */
    protected function resolveRequest($args)
    {
        $options = []; // named parameters
        $params = []; // unnamed parameters
        foreach ($args as $arg) {
            if (preg_match('/^--(\w+)(=(.*))?$/', $arg, $matches)) {  // an option
                $name = $matches[1];
                $value = isset($matches[3]) ? $matches[3] : true;
                if (isset($options[$name])) {
                    if (!is_array($options[$name])) {
                        $options[$name] = [$options[$name]];
                    }
                    $options[$name][] = $value;
                } else {
                    $options[$name] = $value;
                }
            } elseif (isset($action)) {
                $params[] = $arg;
            } else {
                $action = $arg;
            }
        }
        if (!isset($action)) {
            $action = $this->defaultAction;

The property defaultAction does not exist on object<yiicod\cron\commands\behaviors\LockUnLockBehavior>. Since you implemented __set, maybe consider adding a @property annotation.

        }

        //Change "/" for "." if action not default (like "controller/action")
        $action = str_replace('/', '.', $action);

        return [$action, $options, $params];
    }

    /**
     * @param $event
     *
     * @return bool
     */
    public function beforeAction($event)
    {
        $this->prepareLockFilePath();

        if (false === $this->lock()) {
            $event->isValid = false;
            $this->owner->stdout("Cron has run\n", Console::FG_RED);
        }
    }

    /**
     * @param $event
     */
    public function afterAction($event)

The parameter $event is not used and could be removed.

    {
        $this->unLock();
    }

    /**
     * Prepare lock file path
     */
    protected function prepareLockFilePath()
    {
        $filePath = sprintf('%s/runtime/locks', Yii::$app->basePath);
        if (false === is_dir($filePath)) {
            @mkdir($filePath, 0755, true);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

        }
        $argv = array_diff($_SERVER['argv'], ['yii']);
        list($action, $options, $args) = $this->resolveRequest($argv);
        $this->lockFilePath = mb_strtolower(sprintf('%s/%s.bin', $filePath, $action . preg_replace('/[^A-Za-z0-9-]+/', '_', trim(implode(' ', $args)) . trim(implode(' ', $options)))));
    }

    /**
     * Check the end of the process.
     * If a thread is not locked, it will be locked and started command.
     *
     * @return bool
     */
    protected function lock()
    {
        $lockFilePath = $this->lockFilePath;

        // current time
        if (false === file_exists($lockFilePath)) {
            file_put_contents($lockFilePath, time());

            return true;
        } else {
            $timeSec = time();
            // time change file
            $timeFile = @filemtime($lockFilePath) ? @filemtime($lockFilePath) : time();

            // Now find out how much time has passed (in seconds)
            if (($timeSec - $timeFile) > $this->timeLock) {
                $this->unLock();
                file_put_contents($lockFilePath, time());

                return true;
            }

            return false;
        }
    }

    /**
     * Unlocking the process
     *
     * @return bool
     */
    protected function unLock()
    {
        $lockFilePath = $this->lockFilePath;

        if (true === file_exists($lockFilePath)) {
            return unlink($lockFilePath);
        } else {
            return true;
        }
    }
}