TaskFinder.php

<?php
declare(strict_types=1);

namespace Queue\Queue;

use Cake\Core\App;
use Cake\Core\Configure;
use Cake\Core\Plugin;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use RecursiveRegexIterator;
use RegexIterator;
use RuntimeException;

class TaskFinder {

	/**
	 * @phpstan-var array<string, class-string<\Queue\Queue\Task>>|null
	 * @var array<string>|null
	 */
	protected ?array $tasks = null;

	/**
	 * @phpstan-return array<string, class-string<\Queue\Queue\Task>>
	 *
	 * @param string $type Type of interface.
	 *
	 * @return array<string>
	 */
	public function allAddable(string $type = AddInterface::class): array {
		$all = $this->all();
		foreach ($all as $task => $class) {
			if (!is_subclass_of($class, $type, true)) {
				unset($all[$task]);
			}
		}

		return $all;
	}

	/**
	 * Returns all possible Queue tasks.
	 *
	 * Makes sure that app tasks are prioritized over plugin ones.
	 *
	 * @phpstan-return array<string, class-string<\Queue\Queue\Task>>
	 *
	 * @return array<string>
	 */
	public function all(): array {
		if ($this->tasks !== null) {
			return $this->tasks;
		}

		$paths = App::classPath('Queue/Task');
		$this->tasks = [];

		foreach ($paths as $path) {
			$this->tasks += $this->getTasks($path);
		}
		$plugins = array_merge((array)Configure::read('Queue.plugins'), Plugin::loaded());
		$plugins = array_unique($plugins);
		foreach ($plugins as $plugin) {
			$pluginPaths = App::classPath('Queue/Task', $plugin);
			foreach ($pluginPaths as $pluginPath) {
				$pluginTasks = $this->getTasks($pluginPath, $plugin);
				$this->tasks += $pluginTasks;
			}
		}

		ksort($this->tasks);

		return $this->tasks;
	}

	/**
	 * @phpstan-return array<string, class-string<\Queue\Queue\Task>>
	 *
	 * @param string $path
	 * @param string|null $plugin
	 *
	 * @return array<string>
	 */
	protected function getTasks(string $path, ?string $plugin = null): array {
		if (!is_dir($path)) {
			return [];
		}

		$tasks = [];
		$ignoredTasks = Config::ignoredTasks();

		$directoryIterator = new RecursiveDirectoryIterator($path);
		$recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
		$iterator = new RegexIterator($recursiveIterator, '#.+\b(\w+)Task\.php$#', RecursiveRegexIterator::GET_MATCH);
		/** @var array<string> $file */
		foreach ($iterator as $file) {
			$path = str_replace(DS, '/', $file[0]);
			$pos = strpos($path, 'src/Queue/Task/');
			if ($pos) {
				$name = substr($path, $pos + strlen('src/Queue/Task/'), -8);
			} else {
				$pos = strpos($path, APP_DIR . '/Queue/Task/');
				if (!$pos) {
					continue;
				}
				$name = substr($path, $pos + strlen(APP_DIR . '/Queue/Task/'), -8);
			}

			$namespace = $plugin ? str_replace('/', '\\', $plugin) : Configure::read('App.namespace');

			/** @phpstan-var class-string<\Queue\Queue\Task> $className */
			$className = $namespace . '\Queue\Task\\' . str_replace('/', '\\', $name) . 'Task';
			$key = $plugin ? $plugin . '.' . $name : $name;

			if (!in_array($className, $ignoredTasks, true)) {
				$tasks[$key] = $className;
			}
		}

		return $tasks;
	}

	/**
	 * Resolves FQCN to a task name.
	 *
	 * @param class-string<\Queue\Queue\Task>|string $jobTask
	 *
	 * @return string
	 */
	public function resolve(string $jobTask): string {
		if (Configure::read('Queue.skipExistenceCheck')) {
			if (!str_contains($jobTask, '\\')) {
				return $jobTask;
			}

			return Config::taskName($jobTask);
		}

		$all = $this->all();
		foreach ($all as $name => $className) {
			if ($jobTask === $className || $jobTask === $name) {
				return $name;
			}
		}

		if (!str_contains($jobTask, '\\')) {
			// Let's try matching without plugin prefix
			foreach ($all as $name => $_) {
				if (!str_contains($name, '.')) {
					continue;
				}
				[$plugin, $name] = explode('.', $name, 2);
				if ($jobTask === $name) {
					$message = 'You seem to be adding a plugin job without plugin syntax (' . $jobTask . '), migrate to using ' . $plugin . '.' . $name . ' instead.';
					trigger_error($message, E_USER_DEPRECATED);

					return $plugin . '.' . $name;
				}
			}
		}

		throw new RuntimeException('No job type can be resolved for ' . $jobTask);
	}

	/**
	 * @phpstan-return class-string<\Queue\Queue\Task>
	 *
	 * @param string $name
	 *
	 * @return string
	 */
	public function getClass(string $name): string {
		$all = $this->all();
		foreach ($all as $taskName => $className) {
			if ($name === $taskName) {
				return $className;
			}
		}

		throw new RuntimeException('No such task: ' . $name);
	}

}