aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Command
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Command')
-rw-r--r--lib/private/Command/AsyncBus.php140
-rw-r--r--lib/private/Command/CallableJob.php35
-rw-r--r--lib/private/Command/ClosureJob.php37
-rw-r--r--lib/private/Command/CommandJob.php39
-rw-r--r--lib/private/Command/FileAccess.php35
-rw-r--r--lib/private/Command/QueueBus.php72
6 files changed, 358 insertions, 0 deletions
diff --git a/lib/private/Command/AsyncBus.php b/lib/private/Command/AsyncBus.php
new file mode 100644
index 00000000000..eb692f9a8fb
--- /dev/null
+++ b/lib/private/Command/AsyncBus.php
@@ -0,0 +1,140 @@
+<?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
new file mode 100644
index 00000000000..acfeb83d606
--- /dev/null
+++ b/lib/private/Command/CallableJob.php
@@ -0,0 +1,35 @@
+<?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
new file mode 100644
index 00000000000..be2b5f0a4ba
--- /dev/null
+++ b/lib/private/Command/ClosureJob.php
@@ -0,0 +1,37 @@
+<?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
new file mode 100644
index 00000000000..5d613c0305b
--- /dev/null
+++ b/lib/private/Command/CommandJob.php
@@ -0,0 +1,39 @@
+<?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
new file mode 100644
index 00000000000..6fe3e111aef
--- /dev/null
+++ b/lib/private/Command/FileAccess.php
@@ -0,0 +1,35 @@
+<?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
new file mode 100644
index 00000000000..be4ee589e6f
--- /dev/null
+++ b/lib/private/Command/QueueBus.php
@@ -0,0 +1,72 @@
+<?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);
+ }
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-30 23:32:56 +0000