diff options
Diffstat (limited to 'lib/private/command/asyncbus.php')
-rw-r--r-- | lib/private/command/asyncbus.php | 140 |
1 files changed, 0 insertions, 140 deletions
diff --git a/lib/private/command/asyncbus.php b/lib/private/command/asyncbus.php deleted file mode 100644 index eb692f9a8fb..00000000000 --- a/lib/private/command/asyncbus.php +++ /dev/null @@ -1,140 +0,0 @@ -<?php -/** - * @author Robin Appelman <icewind@owncloud.com> - * - * @copyright Copyright (c) 2016, ownCloud, Inc. - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * - */ - -namespace OC\Command; - -use OCP\Command\IBus; -use OCP\Command\ICommand; -use SuperClosure\Serializer; - -/** - * Asynchronous command bus that uses the background job system as backend - */ -class AsyncBus implements IBus { - /** - * @var \OCP\BackgroundJob\IJobList - */ - private $jobList; - - /** - * List of traits for command which require sync execution - * - * @var string[] - */ - private $syncTraits = []; - - /** - * @param \OCP\BackgroundJob\IJobList $jobList - */ - function __construct($jobList) { - $this->jobList = $jobList; - } - - /** - * Schedule a command to be fired - * - * @param \OCP\Command\ICommand | callable $command - */ - public function push($command) { - if ($this->canRunAsync($command)) { - $this->jobList->add($this->getJobClass($command), $this->serializeCommand($command)); - } else { - $this->runCommand($command); - } - } - - /** - * Require all commands using a trait to be run synchronous - * - * @param string $trait - */ - public function requireSync($trait) { - $this->syncTraits[] = trim($trait, '\\'); - } - - /** - * @param \OCP\Command\ICommand | callable $command - */ - private function runCommand($command) { - if ($command instanceof ICommand) { - $command->handle(); - } else { - $command(); - } - } - - /** - * @param \OCP\Command\ICommand | callable $command - * @return string - */ - private function getJobClass($command) { - if ($command instanceof \Closure) { - return 'OC\Command\ClosureJob'; - } else if (is_callable($command)) { - return 'OC\Command\CallableJob'; - } else if ($command instanceof ICommand) { - return 'OC\Command\CommandJob'; - } else { - throw new \InvalidArgumentException('Invalid command'); - } - } - - /** - * @param \OCP\Command\ICommand | callable $command - * @return string - */ - private function serializeCommand($command) { - if ($command instanceof \Closure) { - $serializer = new Serializer(); - return $serializer->serialize($command); - } else if (is_callable($command) or $command instanceof ICommand) { - return serialize($command); - } else { - throw new \InvalidArgumentException('Invalid command'); - } - } - - /** - * @param \OCP\Command\ICommand | callable $command - * @return bool - */ - private function canRunAsync($command) { - $traits = $this->getTraits($command); - foreach ($traits as $trait) { - if (array_search($trait, $this->syncTraits) !== false) { - return false; - } - } - return true; - } - - /** - * @param \OCP\Command\ICommand | callable $command - * @return string[] - */ - private function getTraits($command) { - if ($command instanceof ICommand) { - return class_uses($command); - } else { - return []; - } - } -} |