SuiteCRM-Core/core/backend/Schedulers/Command/RunSchedulersCommand.php

<?php
/**
 * SuiteCRM is a customer relationship management program developed by SuiteCRM Ltd.
 * Copyright (C) 2025 SuiteCRM Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUITECRM, SUITECRM DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Supercharged by SuiteCRM".
 */

namespace App\Schedulers\Command;

use App\Authentication\LegacyHandler\Authentication;
use App\Engine\LegacyHandler\DefaultLegacyHandler;
use App\Install\Command\BaseCommand;
use App\Schedulers\LegacyHandler\SchedulerHandler;
use App\SystemConfig\LegacyHandler\SystemConfigHandler;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCommand(name: 'schedulers:run')]
class RunSchedulersCommand extends BaseCommand
{
    public function __construct(
        protected SchedulerHandler $schedulerHandler,
        protected Authentication $authentication,
        protected DefaultLegacyHandler $legacyHandler,
        protected SystemConfigHandler $systemConfigHandler,
        ?string          $name = null
    )
    {
        $this->initSession = true;
        parent::__construct($name);
    }

    protected function configure(): void
    {
        $this
            ->setDescription('Run all Schedulers');
    }


    protected function executeCommand(InputInterface $input, OutputInterface $output, array $inputs): int
    {
        $runningUser = $this->cronHandler->getRunningUser();
        $this->authentication->initLegacySystemSession();

        $allowed = $this->cronHandler->isAllowedCronUser();

        if (!$allowed) {
            $this->lastRun->setLastRun($this->getName(), $runningUser);
            $output->writeln([
                '',
                'ERROR: The cron job is being run by an unauthorized user.',
                'Please ensure that the cron job is run by one of the following users:',
                implode(', ', $this->cronHandler->getAllowedUsers()),
                'Current user: ' . $runningUser,
                '',
                'You can do this by adding/updating the "allowed_cron_users" array within the "cron" entry in your config.php file.',
            ]);
            return Command::FAILURE;
        }

        $this->lastRun->setLastRun($this->getName(), $runningUser);


        $appStrings = $this->getAppStrings();

        $this->writeHeader($output, $appStrings['LBL_RUN_SCHEDULERS']);

        $this->runSchedulers($output);

        return Command::SUCCESS;
    }


    /**
     * @param OutputInterface $output
     * @return void
     */
    public function runSchedulers(OutputInterface $output): void
    {
        $results = $this->schedulerHandler->runSchedulers();
        $this->showResults($output, $results);
    }

    /**
     * @param OutputInterface $output
     * @param string $header
     */
    protected function writeHeader(OutputInterface $output, string $header): void
    {
        $output->writeln([
            '',
            $header,
            '=========================',
            ''
        ]);
    }

    protected function showResults(OutputInterface $output, array $results): void
    {
        $appStrings = $this->getAppStrings();
        $color = 'green';
        $label = '(' .  $appStrings['LBL_PASSED'] . ')';


        if (empty($results)) {
            $output->writeln([
                'No Schedulers to run.'
            ]);
        }

        foreach ($results as $result) {

            if ($result['result'] === false) {
                $label = '(' .  $appStrings['LBL_FAILED'] . ')';
                $color = 'red';
            }

            $output->writeln([
                $result['name'] . ' ' . $this->colorText($color, $label),
            ]);
        }

        $output->writeln(['']);
    }
}