<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM - Open Source CRM application.
 * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
 * Website: https://www.espocrm.com
 *
 * EspoCRM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * EspoCRM 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with EspoCRM. If not, see http://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 General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

namespace Espo\Core\Job;

use Espo\Core\Job\MetadataProvider;

use Espo\Core\{
    Exceptions\Error,
    Utils\ClassFinder,
    InjectableFactory,
};

class JobFactory
{
    private ClassFinder $classFinder;

    private InjectableFactory $injectableFactory;

    private MetadataProvider $metadataProvider;

    public function __construct(
        ClassFinder $classFinder,
        InjectableFactory $injectableFactory,
        MetadataProvider $metadataProvider
    ) {
        $this->classFinder = $classFinder;
        $this->injectableFactory = $injectableFactory;
        $this->metadataProvider = $metadataProvider;
    }

    /**
     * Create a job by a scheduled job name.
     *
     * @return Job|JobDataLess
     * @throws Error
     */
    public function create(string $name): object
    {
        $className = $this->getClassName($name);

        if (!$className) {
            throw new Error("Job '{$name}' not found.");
        }

        return $this->createByClassName($className);
    }

    /**
     * Create a job by a class name.
     * @param class-string<Job|JobDataLess> $className
     * @return Job|JobDataLess
     */
    public function createByClassName(string $className): object
    {
        $job = $this->injectableFactory->create($className);

        return $job;
    }

    /**
     * @return ?class-string<Job|JobDataLess>
     */
    private function getClassName(string $name): ?string
    {
        /** @var ?class-string<Job|JobDataLess> $className */
        $className = $this->metadataProvider->getJobClassName($name);

        if ($className) {
            return $className;
        }

        /** @var ?class-string<Job|JobDataLess> */
        return $this->classFinder->find('Jobs', ucfirst($name));
    }
}