Initial commit

application/Espo/Core/Job/JobScheduler.php

@@ -0,0 +1,193 @@
+<?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\Job;
+
+use Espo\Core\Field\DateTime as DateTimeField;
+use Espo\Core\Job\Job\Data;
+use Espo\Core\Job\JobScheduler\Creator;
+
+use ReflectionClass;
+use DateTimeInterface;
+use DateTimeImmutable;
+use DateInterval;
+use RuntimeException;
+use TypeError;
+
+/**
+ * Creates jobs in a queue.
+ */
+class JobScheduler
+{
+    /** @var ?class-string<Job|JobDataLess> */
+    private ?string $className = null;
+    private ?string $queue = null;
+    private ?string $group = null;
+    private ?Data $data = null;
+    private ?DateTimeImmutable $time = null;
+    private ?DateInterval $delay = null;
+
+    public function __construct(
+        private Creator $creator,
+    ) {}
+
+    /**
+     * A class name of the job. Should implement the `Job` interface.
+     *
+     * @param class-string<Job|JobDataLess> $className
+     */
+    public function setClassName(string $className): self
+    {
+        if (!class_exists($className)) {
+            throw new RuntimeException("Class '$className' does not exist.");
+        }
+
+        $class = new ReflectionClass($className);
+
+        if (
+            !$class->implementsInterface(Job::class) &&
+            !$class->implementsInterface(JobDataLess::class)
+        ) {
+            throw new RuntimeException("Class '$className' does not implement 'Job' or 'JobDataLess' interface.");
+        }
+
+        $this->className = $className;
+
+        return $this;
+    }
+
+    /**
+     * In what queue to run the job.
+     *
+     * @param ?string $queue A queue name. Available names are defined in the `QueueName` class.
+     */
+    public function setQueue(?string $queue): self
+    {
+        $this->queue = $queue;
+
+        return $this;
+    }
+
+    /**
+     * In what group to run the job. Jobs within a group will run one-by-one. Jobs with different group
+     * can run in parallel. The job can't have both queue and group set.
+     *
+     * @param ?string $group A group. Any string ID value can be used as a group name. E.g. a user ID.
+     */
+    public function setGroup(?string $group): self
+    {
+        $this->group = $group;
+
+        return $this;
+    }
+
+    /**
+     * Set an execution time. If not set, then the current time will be used.
+     */
+    public function setTime(?DateTimeInterface $time): self
+    {
+        $timeCopy = $time;
+
+        if (!is_null($time) && !$time instanceof DateTimeImmutable) {
+            /** @noinspection PhpParamsInspection */
+            $timeCopy = DateTimeImmutable::createFromMutable($time);
+        }
+
+        /** @var ?DateTimeImmutable $timeCopy */
+
+        $this->time = $timeCopy;
+
+        return $this;
+    }
+
+    /**
+     * Set an execution delay.
+     */
+    public function setDelay(?DateInterval $delay): self
+    {
+        $this->delay = $delay;
+
+        return $this;
+    }
+
+    /**
+     * Set data to be passed to the job.
+     *
+     * @param Data|array<string, mixed>|null $data
+     */
+    public function setData($data): self
+    {
+        /** @var mixed $data */
+
+        if (!is_null($data) && !is_array($data) && !$data instanceof Data) {
+            throw new TypeError();
+        }
+
+        if (!$data instanceof Data) {
+            $data = Data::create($data);
+        }
+
+        $this->data = $data;
+
+        return $this;
+    }
+
+    public function schedule(): void
+    {
+        if (!$this->className) {
+            throw new RuntimeException("Class name is not set.");
+        }
+
+        if ($this->group && $this->queue) {
+            throw new RuntimeException("Can't have both queue and group.");
+        }
+
+        $time = $this->time;
+
+        if (!$this->time && $this->delay) {
+            $time = new DateTimeImmutable();
+        }
+
+        if ($time && $this->delay) {
+            $time = $time->add($this->delay);
+        }
+
+        $data = $this->data ?? Data::create();
+
+        $creatorData = new Creator\Data(
+            className: $this->className,
+            queue: $this->queue,
+            group: $this->group,
+            data: $data,
+            time: $time ? DateTimeField::fromDateTime($time) : null,
+        );
+
+        $this->creator->create($creatorData);
+    }
+}