diff options
author | Roeland Jago Douma <rullzer@owncloud.com> | 2016-04-15 12:01:13 +0200 |
---|---|---|
committer | Roeland Jago Douma <rullzer@owncloud.com> | 2016-04-15 12:01:13 +0200 |
commit | 5c6079cd89376c7852f23f6e51b8fdd6425bd11e (patch) | |
tree | a783c6f6d227ad7cc565344241760c13e902857e /lib/private/command | |
parent | 7529605676bb8ad83898e2e7271454fd936587ae (diff) | |
download | nextcloud-server-5c6079cd89376c7852f23f6e51b8fdd6425bd11e.tar.gz nextcloud-server-5c6079cd89376c7852f23f6e51b8fdd6425bd11e.zip |
Move \OC\Command to PSR-4
Diffstat (limited to 'lib/private/command')
-rw-r--r-- | lib/private/command/asyncbus.php | 140 | ||||
-rw-r--r-- | lib/private/command/callablejob.php | 35 | ||||
-rw-r--r-- | lib/private/command/closurejob.php | 37 | ||||
-rw-r--r-- | lib/private/command/commandjob.php | 39 | ||||
-rw-r--r-- | lib/private/command/fileaccess.php | 35 | ||||
-rw-r--r-- | lib/private/command/queuebus.php | 72 |
6 files changed, 0 insertions, 358 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 []; - } - } -} diff --git a/lib/private/command/callablejob.php b/lib/private/command/callablejob.php deleted file mode 100644 index acfeb83d606..00000000000 --- a/lib/private/command/callablejob.php +++ /dev/null @@ -1,35 +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 OC\BackgroundJob\QueuedJob; - -class CallableJob extends QueuedJob { - protected function run($serializedCallable) { - $callable = unserialize($serializedCallable); - if (is_callable($callable)) { - $callable(); - } else { - throw new \InvalidArgumentException('Invalid serialized callable'); - } - } -} diff --git a/lib/private/command/closurejob.php b/lib/private/command/closurejob.php deleted file mode 100644 index be2b5f0a4ba..00000000000 --- a/lib/private/command/closurejob.php +++ /dev/null @@ -1,37 +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 OC\BackgroundJob\QueuedJob; -use SuperClosure\Serializer; - -class ClosureJob extends QueuedJob { - protected function run($serializedCallable) { - $serializer = new Serializer(); - $callable = $serializer->unserialize($serializedCallable); - if (is_callable($callable)) { - $callable(); - } else { - throw new \InvalidArgumentException('Invalid serialized callable'); - } - } -} diff --git a/lib/private/command/commandjob.php b/lib/private/command/commandjob.php deleted file mode 100644 index 5d613c0305b..00000000000 --- a/lib/private/command/commandjob.php +++ /dev/null @@ -1,39 +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 OC\BackgroundJob\QueuedJob; -use OCP\Command\ICommand; - -/** - * Wrap a command in the background job interface - */ -class CommandJob extends QueuedJob { - protected function run($serializedCommand) { - $command = unserialize($serializedCommand); - if ($command instanceof ICommand) { - $command->handle(); - } else { - throw new \InvalidArgumentException('Invalid serialized command'); - } - } -} diff --git a/lib/private/command/fileaccess.php b/lib/private/command/fileaccess.php deleted file mode 100644 index 6fe3e111aef..00000000000 --- a/lib/private/command/fileaccess.php +++ /dev/null @@ -1,35 +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\IUser; - -trait FileAccess { - protected function setupFS(IUser $user){ - \OC_Util::setupFS($user->getUID()); - } - - protected function getUserFolder(IUser $user) { - $this->setupFS($user); - return \OC::$server->getUserFolder($user->getUID()); - } -} diff --git a/lib/private/command/queuebus.php b/lib/private/command/queuebus.php deleted file mode 100644 index be4ee589e6f..00000000000 --- a/lib/private/command/queuebus.php +++ /dev/null @@ -1,72 +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; - -class QueueBus implements IBus { - /** - * @var (ICommand|callable)[] - */ - private $queue = []; - - /** - * Schedule a command to be fired - * - * @param \OCP\Command\ICommand | callable $command - */ - public function push($command) { - $this->queue[] = $command; - } - - /** - * Require all commands using a trait to be run synchronous - * - * @param string $trait - */ - public function requireSync($trait) { - } - - /** - * @param \OCP\Command\ICommand | callable $command - */ - private function runCommand($command) { - if ($command instanceof ICommand) { - // ensure the command can be serialized - $serialized = serialize($command); - if(strlen($serialized) > 4000) { - throw new \InvalidArgumentException('Trying to push a command which serialized form can not be stored in the database (>4000 character)'); - } - $unserialized = unserialize($serialized); - $unserialized->handle(); - } else { - $command(); - } - } - - public function run() { - while ($command = array_shift($this->queue)) { - $this->runCommand($command); - } - } -} |