aimeos / aimeos-base

src/Process/Pcntl.php

<?php

/**
 * @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2017-2025
 * @package Base
 * @subpackage Process
 */


namespace Aimeos\Base\Process;


/**
 * Posix process control for parallel processing classes
 *
 * @package Base
 * @subpackage Process
 */
class Pcntl implements Iface
{
	private int $max;
	private int $prio;
	private array $list = [];


	/**
	 * Initializes the object and sets up the signal handler
	 *
	 * @param int $max Maximum number of tasks allowed to run in parallel
	 * @param int $prio Task priority from -20 (high) to 20 (low)
	 * @throws \Aimeos\Base\Process\Exception If setting up the signal handler failed
	 */
	public function __construct( int $max = 4, int $prio = 19 )
	{
		$this->max = $max;
		$this->prio = $prio;

		if( $this->isAvailable() )
		{
			$handler = function( $signo ) {

				foreach( $this->list as $pid => $entry )
				{
					if( function_exists( 'posix_kill' ) ) {
						posix_kill( $pid, $signo );
					}

					$status = 0;
					pcntl_waitpid( $pid, $status );
				}

				exit( 0 );

Using exit here is not recommended.

			};

			if( pcntl_signal( SIGTERM, $handler ) === false ) {
				throw new Exception( 'Unable to install signal handler: ' . pcntl_strerror( pcntl_get_last_error() ) );

Are you sure pcntl_strerror(pcntl_get_last_error()) of type string|true can be used in concatenation?

			}
		}
	}


	/**
	 * Clears the cloned object
	 */
	public function __clone()
	{
		$this->list = [];
	}


	/**
	 * Checks if processing tasks in parallel is available
	 *
	 * @return bool True if available, false if not
	 */
	public function isAvailable() : bool
	{
		if( php_sapi_name() === 'cli' && $this->max > 0
			&& function_exists( 'pcntl_fork' ) && function_exists( 'pcntl_wait' )
			&& function_exists( 'pcntl_signal' ) && function_exists( 'pcntl_waitpid' )
			&& function_exists( 'pcntl_setpriority' )
		) {
			return true;
		}

		return false;
	}


	/**
	 * Starts a new task by executing the given anonymous function
	 *
	 * @param \Closure $fcn Anonymous function to execute
	 * @param array $data List of parameters that is passed to the closure function
	 * @param bool $restart True if the task should be restarted if it fails (only once)
	 * @return \Aimeos\Base\Process\Iface Self object for method chaining
	 * @throws \Aimeos\Base\Process\Exception If starting the new task failed
	 */
	public function start( \Closure $fcn, array $data, bool $restart = false ) : Iface
	{
		while( count( $this->list ) >= $this->max ) {
			$this->waitOne();
		}

		$data = $this->copy( $data );
		flush(); // flush all pending output so it's not printed in childs again

		if( ( $pid = pcntl_fork() ) === -1 ) {
			throw new Exception( 'Unable to fork new process: ' . pcntl_strerror( pcntl_get_last_error() ) );

Are you sure pcntl_strerror(pcntl_get_last_error()) of type string|true can be used in concatenation?

		}

		if( $pid === 0 ) // child process
		{
			$this->list = []; // use own child process list
			exit( $this->exec( $fcn, $data ) );

Using exit here is not recommended.

		}

		$this->list[$pid] = [$fcn, $data, $restart];

		return $this;
	}


	/**
	 * Waits for the running tasks until all have finished
	 *
	 * @return \Aimeos\Base\Process\Iface Self object for method chaining
	 */
	public function wait() : Iface
	{
		while( !empty( $this->list ) ) {
			$this->waitOne();
		}

		return $this;
	}


	/**
	 * Clone all objects in the function parameter list
	 *
	 * @param array $data Function parameter list
	 * @return array Function parameter list with cloned objects
	 */
	protected function copy( array $data ) : array
	{
		foreach( $data as $key => $value )
		{
			if( is_object( $value ) )
			{
				$value = clone $value;

				if( method_exists( $value, '__sleep' ) ) {
					$value->__sleep();
				}

				$data[$key] = $value;
			}
		}

		return $data;
	}


	/**
	 * Executes the worker function
	 *
	 * @param \Closure $fcn Worker function
	 * @param array $data Function parameter list
	 * @return int Process error code
	 */
	protected function exec( \Closure $fcn, array $data ) : int
	{
		pcntl_setpriority( $this->prio );

		if( ob_get_level() > 0 ) {
			ob_clean(); // avoid printing buffered messages of the parent again
		}

		call_user_func_array( $fcn, $data );
		return 0;
	}


	/**
	 * Waits for the next running tasks to finish
	 *
	 * @throws \Aimeos\Base\Process\Exception If an error occurs or the task exited with an error
	 */
	protected function waitOne()
	{
		$status = -1;

		if( ( $pid = pcntl_wait( $status ) ) === -1 ) {
			throw new Exception( 'Unable to wait for child process: ' . pcntl_strerror( pcntl_get_last_error() ) );

Are you sure pcntl_strerror(pcntl_get_last_error()) of type string|true can be used in concatenation?

		}

		list( $fcn, $data, $restart ) = $this->list[$pid];
		unset( $this->list[$pid] );

		if( $status > 0 && $restart !== false ) {
			$this->start( $fcn, $data, false );
		}
	}
}