lekoala / silverstripe-simple-jobs

src/CronJob.php

<?php

namespace LeKoala\SimpleJobs;

use Exception;
use Cron\CronExpression;
use LeKoala\CmsActions\CustomAction;

The type LeKoala\CmsActions\CustomAction was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\ORM\DataList;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Config\Config;
use SilverStripe\ORM\DataObject;
use SilverStripe\Forms\FieldList;
use SilverStripe\Security\Member;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\CronTask\Interfaces\CronTask;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordViewer;
use SilverStripe\Security\Permission;

/**
 * Class \LeKoala\SimpleJobs\CronJob
 *
 * @property ?string $TaskClass
 * @property ?string $Title
 * @property ?string $Category
 * @property ?string $Description
 * @property bool|int $Disabled
 * @mixin \SilverStripe\Assets\Shortcodes\FileLinkTracking
 * @mixin \SilverStripe\Assets\AssetControlExtension
 * @mixin \SilverStripe\CMS\Model\SiteTreeLinkTracking
 * @mixin \SilverStripe\Versioned\RecursivePublishable
 * @mixin \SilverStripe\Versioned\VersionedStateExtension
 */
class CronJob extends DataObject
{
    /**
     * @var string
     */
    private static $singular_name = 'Scheduled Job';

The private property $singular_name is not used, and could be removed.

    /**
     * @var string
     */
    private static $plural_name = 'Scheduled Jobs';

The private property $plural_name is not used, and could be removed.

    /**
     * @var string
     */
    private static $table_name = 'CronJob';

The private property $table_name is not used, and could be removed.

    /**
     * @var array<string, string>
     */
    private static $db = [

The private property $db is not used, and could be removed.

        'TaskClass' => 'Varchar(255)',
        'Title' => 'Varchar(255)',
        'Category' => 'Varchar(255)',
        'Description' => 'Varchar(255)',
        'Disabled' => 'Boolean',
    ];

    /**
     * @var string
     */
    private static $default_sort = 'TaskClass ASC';

The private property $default_sort is not used, and could be removed.

    /**
     * @var array<string, string>
     */
    private static $summary_fields = [

The private property $summary_fields is not used, and could be removed.

        'Title' => 'Title',
        'Category' => 'Category',
        'IsDisabled' => 'IsDisabled',
        'Description' => 'Description',
        'LastResult.Created' => 'Last Run',
        'NextRun' => 'Next Run',
    ];

    public function canView($member = null, $context = [])

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

    {
        return Permission::check('CMS_ACCESS_SimpleJobsAdmin', 'any', $member);
    }

    public function canEdit($member = null, $context = [])

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

    {
        return Permission::check('CMS_ACCESS_SimpleJobsAdmin', 'any', $member);
    }

    public function canCreate($member = null, $context = [])
    {
        return Permission::check('CMS_ACCESS_SimpleJobsAdmin', 'any', $member);
    }

    /**
     * @param Member $member
     * @return boolean
     */
    public function canDelete($member = null)
    {
        return false;
    }

    /**
     * @return array<class-string>

The doc comment array<class-string> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array<class-string>.

     */
    public static function allTasks(): array
    {
        return ClassInfo::implementorsOf(CronTask::class);
    }

    public function triggerManually(): string
    {
        $inst = $this->TaskInstance();
        /** @var void|null|string|bool $result */
        $result = $inst->process();

Are you sure the assignment to $result is correct as $inst->process() targeting SilverStripe\CronTask\Interfaces\CronTask::process() seems to always return null.

        if ($result !== null) {
            if ($result === false) {
                return 'Task failed';
            }
            if (is_string($result)) {
                return $result;
            }
        }
        return "Task has been triggered";
    }

    public function getCMSActions()
    {
        $actions = parent::getCMSActions();
        if (class_exists(CustomAction::class) && Permission::check('ADMIN')) {
            $triggerManually = new CustomAction('triggerManually', 'Trigger manually');
            $triggerManually->setConfirmation("Are you sure you want to trigger the task?");
            $actions->push($triggerManually);
        }
        return $actions;
    }

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->makeFieldReadonly('Title');
        $fields->makeFieldReadonly('Category');
        $fields->makeFieldReadonly('Description');
        $fields->makeFieldReadonly('TaskClass');
        if ($this->IsSystemDisabled()) {
            $fields->makeFieldReadonly('Disabled');
        }

        // Display results
        $resultsGridConfig = GridFieldConfig_RecordViewer::create();
        $resultsGrid = new GridField('Results', 'Results', $this->AllResults(), $resultsGridConfig);
        $fields->addFieldToTab('Root.Results', $resultsGrid);

        // Optionally provide a list of to be affected items
        $taskClass = $this->TaskClass;
        if (method_exists($taskClass, 'getJobRecords')) {
            $records = $taskClass::getJobRecords();
            if ($records) {
                $recordsGridConfig = GridFieldConfig_RecordViewer::create();
                $recordsGrid = new GridField('Records', 'Records', $records, $recordsGridConfig);
                $fields->addFieldToTab('Root.Records', $recordsGrid);
            }
        }

        return $fields;
    }

    public static function regenerateFromClasses(bool $update = false): void
    {
        $list = self::allTasks();
        foreach ($list as $class) {
            $obj = self::getByTaskClass($class);
            if ($obj && $update === false) {
                continue;
            }
            if (!$obj) {
                $obj = new CronJob();
            }
            $obj->TaskClass = $class;
            $obj->Title =  method_exists($class, 'getJobTitle') ? $class::getJobTitle() : $class;
            $obj->Category = method_exists($class, 'getJobCategory') ? $class::getJobCategory() : 'general';
            $obj->Description = method_exists($class, 'getJobDescription') ? $class::getJobDescription() : null;
            $obj->write();
        }
    }

    public static function getByTaskClass(string $class): ?CronJob
    {
        /** @var CronJob|null $obj */
        $obj = self::get()->filter('TaskClass', $class)->first();
        return $obj;
    }

    public function IsDisabled(): bool
    {
        if ($this->IsSystemDisabled()) {
            return true;
        }
        return $this->Disabled;

The expression return $this->Disabled could return the type integer which is incompatible with the type-hinted return boolean. Consider adding an additional type-check to rule them out.

    }

    public function IsTaskDisabled(): bool
    {
        $taskClass = $this->TaskClass;
        if ($taskClass && method_exists($taskClass, 'IsDisabled')) {
            return $taskClass::IsDisabled();
        }
        return false;
    }

    public function IsSystemDisabled(): bool
    {
        if ($this->IsTaskDisabled()) {
            return true;
        }
        $disabledTask = Config::inst()->get(SimpleJobsController::class, 'disabled_tasks');
        if (in_array($this->TaskClass, $disabledTask)) {
            return true;
        }
        return false;
    }

    /**
     * @return CronTask
     */
    public function TaskInstance(): CronTask
    {
        /** @var class-string $class */
        $class = $this->TaskClass;
        $inst = new $class;
        if ($inst instanceof CronTask) {
            return $inst;
        }
        throw new Exception("Invalid class $class");
    }

    public function NextRun(): string
    {
        if ($this->IsDisabled()) {
            return '';
        }
        $task = $this->TaskInstance();
        $cron = new CronExpression($task->getSchedule());
        return $cron->getNextRunDate()->format('Y-m-d H:i:s');
    }

    /**
     * @return DataList
     */
    public function AllResults()
    {
        $result = CronTaskResult::get()->filter([
            'TaskClass' => $this->TaskClass
        ])->Sort('Created DESC');
        return $result;
    }

    public function LastResult(): ?CronTaskResult
    {
        /** @var CronTaskResult|null $result */
        $result = CronTaskResult::get()->filter([
            'TaskClass' => $this->TaskClass
        ])->Sort('Created DESC')->first();
        return $result;
    }

    public function LastFailedResult(): ?CronTaskResult
    {
        /** @var CronTaskResult|null $result */
        $result = CronTaskResult::get()->filter([
            'TaskClass' => $this->TaskClass,
            'Failed' => 1
        ])->Sort('Created DESC')->first();
        return $result;
    }
}