Initial commit

application/Espo/Core/Console/Commands/RunJob.php

@@ -0,0 +1,111 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * 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 "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Console\Commands;
+
+use Espo\Core\Console\Command;
+use Espo\Core\Console\Command\Params;
+use Espo\Core\Console\IO;
+use Espo\Core\Job\JobManager;
+use Espo\Core\Job\Job\Status;
+use Espo\Core\Utils\Util;
+use Espo\ORM\EntityManager;
+use Espo\Entities\Job;
+
+use Throwable;
+
+/**
+ * @noinspection PhpUnused
+ */
+class RunJob implements Command
+{
+    public function __construct(private JobManager $jobManager, private EntityManager $entityManager)
+    {}
+
+    public function run(Params $params, IO $io): void
+    {
+        $options = $params->getOptions();
+        $argumentList = $params->getArgumentList();
+
+        $jobName = $options['job'] ?? null;
+        $targetId = $options['targetId'] ?? null;
+        $targetType = $options['targetType'] ?? null;
+
+        if (!$jobName && count($argumentList)) {
+            $jobName = $argumentList[0];
+        }
+
+        if (!$jobName) {
+            $io->writeLine("");
+            $io->writeLine("A job name must be specified:");
+            $io->writeLine("");
+
+            $io->writeLine(" bin/command run-job [JobName]");
+            $io->writeLine("");
+
+            $io->writeLine("To print all available jobs, run:");
+            $io->writeLine("");
+            $io->writeLine(" bin/command app-info --jobs");
+            $io->writeLine("");
+
+            return;
+        }
+
+        $jobName = ucfirst(Util::hyphenToCamelCase($jobName));
+
+        $entityManager = $this->entityManager;
+
+        /** @var Job $job */
+        $job = $entityManager->createEntity(Job::ENTITY_TYPE, [
+            'name' => $jobName,
+            'job' => $jobName,
+            'targetType' => $targetType,
+            'targetId' => $targetId,
+            'attempts' => 0,
+            'status' => Status::READY,
+        ]);
+
+        try {
+            $this->jobManager->runJob($job);
+        } catch (Throwable $e) {
+            $message = "Error: Job '$jobName' failed to execute.";
+
+            if ($e->getMessage()) {
+                $message .= ' ' . $e->getMessage();
+            }
+
+            $io->writeLine($message);
+            $io->setExitStatus(1);
+
+            return;
+        }
+
+        $io->writeLine("Job '$jobName' has been executed.");
+    }
+}