QueueProcessesController.php

<?php
declare(strict_types=1);

namespace Queue\Controller\Admin;

use Cake\Core\Configure;
use Exception;
use const SIGTERM;

/**
 * @property \Queue\Model\Table\QueueProcessesTable $QueueProcesses
 * @property \Queue\Model\Table\QueuedJobsTable $QueuedJobs
 * @method \Cake\Datasource\ResultSetInterface<\Queue\Model\Entity\QueueProcess> paginate(\Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface|string|null $object = null, array $settings = [])
 */
class QueueProcessesController extends QueueAppController {

	/**
	 * @var string|null
	 */
	protected ?string $defaultTable = 'Queue.QueueProcesses';

	/**
	 * @var array<string, mixed>
	 */
	protected array $paginate = [
		'order' => [
			'created' => 'DESC',
		],
	];

	/**
	 * @return void
	 */
	public function initialize(): void {
		parent::initialize();

		// Set connection for multi-connection support
		if ($this->activeConnection !== 'default') {
			$this->QueueProcesses->setConnection($this->getActiveConnectionObject());
		}
	}

	/**
	 * Index method
	 *
	 * @return \Cake\Http\Response|null|void
	 */
	public function index() {
		$queueProcesses = $this->paginate();

		$this->set(compact('queueProcesses'));
	}

	/**
	 * View method
	 *
	 * @param int|null $id Queue Process id.
	 *
	 * @return \Cake\Http\Response|null|void
	 */
	public function view(?int $id = null) {
		$queueProcess = $this->QueueProcesses->get($id);

		$this->set(compact('queueProcess'));
	}

	/**
	 * Edit method
	 *
	 * @param int|null $id Queue Process id.
	 *
	 * @return \Cake\Http\Response|null|void Redirects on successful edit, renders view otherwise.
	 */
	public function edit(?int $id = null) {
		$queueProcess = $this->QueueProcesses->get($id);
		if ($this->request->is(['patch', 'post', 'put'])) {
			$queueProcess = $this->QueueProcesses->patchEntity($queueProcess, $this->request->getData());
			if ($this->QueueProcesses->save($queueProcess)) {
				$this->Flash->success(__d('queue', 'The queue process has been saved.'));

				return $this->redirect(['action' => 'index']);
			}

			$this->Flash->error(__d('queue', 'The queue process could not be saved. Please, try again.'));
		}

		$this->set(compact('queueProcess'));
	}

	/**
	 * @param int|null $id Queue Process id.
	 *
	 * @return \Cake\Http\Response|null|void Redirects to index.
	 */
	public function terminate(?int $id = null) {
		$this->request->allowMethod(['post', 'delete']);

		try {
			$queueProcess = $this->QueueProcesses->get($id);
			$queueProcess->terminate = true;
			$this->QueueProcesses->saveOrFail($queueProcess);
			$this->Flash->success(__d('queue', 'The queue process has been deleted.'));
		} catch (Exception) {
			$this->Flash->error(__d('queue', 'The queue process could not be deleted. Please, try again.'));
		}

		return $this->redirect(['action' => 'index']);
	}

	/**
	 * @param int|null $id Queue Process id.
	 * @param int|null $sig Signal (defaults to graceful SIGTERM = 15).
	 *
	 * @return \Cake\Http\Response|null|void Redirects to index.
	 */
	public function delete(?int $id = null, ?int $sig = null) {
		$this->request->allowMethod(['post', 'delete']);
		$queueProcess = $this->QueueProcesses->get($id);

		if (!Configure::read('Queue.multiserver')) {
			$this->QueueProcesses->terminateProcess($queueProcess->pid, $sig ?: SIGTERM);
		}

		if ($this->QueueProcesses->delete($queueProcess)) {
			$this->Flash->success(__d('queue', 'The queue process has been deleted.'));
		} else {
			$this->Flash->error(__d('queue', 'The queue process could not be deleted. Please, try again.'));
		}

		return $this->redirect(['action' => 'index']);
	}

	/**
	 * @return \Cake\Http\Response|null|void Redirects to index.
	 */
	public function cleanup() {
		$this->request->allowMethod(['post', 'delete']);

		$count = $this->QueueProcesses->cleanEndedProcesses();

		$this->Flash->success($count . ' leftovers cleaned out.');

		return $this->redirect($this->referer(['action' => 'index'], true));
	}

}