Move \OC\Hooks to PSR-4

6 files changed, 306 insertions, 0 deletions

diff --git a/lib/private/Hooks/BasicEmitter.php b/lib/private/Hooks/BasicEmitter.php
new file mode 100644
index 00000000000..067962ec081
--- /dev/null
+++ b/lib/private/Hooks/BasicEmitter.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @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\Hooks;
+
+abstract class BasicEmitter implements Emitter {
+	use EmitterTrait;
+}
diff --git a/lib/private/Hooks/Emitter.php b/lib/private/Hooks/Emitter.php
new file mode 100644
index 00000000000..d639e5ef892
--- /dev/null
+++ b/lib/private/Hooks/Emitter.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @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\Hooks;
+
+/**
+ * Class Emitter
+ *
+ * interface for all classes that are able to emit events
+ *
+ * @package OC\Hooks
+ */
+interface Emitter {
+	/**
+	 * @param string $scope
+	 * @param string $method
+	 * @param callable $callback
+	 * @return void
+	 */
+	public function listen($scope, $method, callable $callback);
+
+	/**
+	 * @param string $scope optional
+	 * @param string $method optional
+	 * @param callable $callback optional
+	 * @return void
+	 */
+	public function removeListener($scope = null, $method = null, callable $callback = null);
+}
diff --git a/lib/private/Hooks/EmitterTrait.php b/lib/private/Hooks/EmitterTrait.php
new file mode 100644
index 00000000000..775f46f838c
--- /dev/null
+++ b/lib/private/Hooks/EmitterTrait.php
@@ -0,0 +1,102 @@
+<?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\Hooks;
+
+trait EmitterTrait {
+
+	/**
+	 * @var (callable[])[] $listeners
+	 */
+	protected $listeners = array();
+
+	/**
+	 * @param string $scope
+	 * @param string $method
+	 * @param callable $callback
+	 */
+	public function listen($scope, $method, callable $callback) {
+		$eventName = $scope . '::' . $method;
+		if (!isset($this->listeners[$eventName])) {
+			$this->listeners[$eventName] = array();
+		}
+		if (array_search($callback, $this->listeners[$eventName], true) === false) {
+			$this->listeners[$eventName][] = $callback;
+		}
+	}
+
+	/**
+	 * @param string $scope optional
+	 * @param string $method optional
+	 * @param callable $callback optional
+	 */
+	public function removeListener($scope = null, $method = null, callable $callback = null) {
+		$names = array();
+		$allNames = array_keys($this->listeners);
+		if ($scope and $method) {
+			$name = $scope . '::' . $method;
+			if (isset($this->listeners[$name])) {
+				$names[] = $name;
+			}
+		} elseif ($scope) {
+			foreach ($allNames as $name) {
+				$parts = explode('::', $name, 2);
+				if ($parts[0] == $scope) {
+					$names[] = $name;
+				}
+			}
+		} elseif ($method) {
+			foreach ($allNames as $name) {
+				$parts = explode('::', $name, 2);
+				if ($parts[1] == $method) {
+					$names[] = $name;
+				}
+			}
+		} else {
+			$names = $allNames;
+		}
+
+		foreach ($names as $name) {
+			if ($callback) {
+				$index = array_search($callback, $this->listeners[$name], true);
+				if ($index !== false) {
+					unset($this->listeners[$name][$index]);
+				}
+			} else {
+				$this->listeners[$name] = array();
+			}
+		}
+	}
+
+	/**
+	 * @param string $scope
+	 * @param string $method
+	 * @param array $arguments optional
+	 */
+	protected function emit($scope, $method, array $arguments = array()) {
+		$eventName = $scope . '::' . $method;
+		if (isset($this->listeners[$eventName])) {
+			foreach ($this->listeners[$eventName] as $callback) {
+				call_user_func_array($callback, $arguments);
+			}
+		}
+	}
+}
diff --git a/lib/private/Hooks/ForwardingEmitter.php b/lib/private/Hooks/ForwardingEmitter.php
new file mode 100644
index 00000000000..6a1fc571cea
--- /dev/null
+++ b/lib/private/Hooks/ForwardingEmitter.php
@@ -0,0 +1,64 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @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\Hooks;
+
+/**
+ * Class ForwardingEmitter
+ *
+ * allows forwarding all listen calls to other emitters
+ *
+ * @package OC\Hooks
+ */
+abstract class ForwardingEmitter extends BasicEmitter {
+	/**
+	 * @var \OC\Hooks\Emitter[] array
+	 */
+	private $forwardEmitters = array();
+
+	/**
+	 * @param string $scope
+	 * @param string $method
+	 * @param callable $callback
+	 */
+	public function listen($scope, $method, callable $callback) {
+		parent::listen($scope, $method, $callback);
+		foreach ($this->forwardEmitters as $emitter) {
+			$emitter->listen($scope, $method, $callback);
+		}
+	}
+
+	/**
+	 * @param \OC\Hooks\Emitter $emitter
+	 */
+	protected function forward(Emitter $emitter) {
+		$this->forwardEmitters[] = $emitter;
+
+		//forward all previously connected hooks
+		foreach ($this->listeners as $key => $listeners) {
+			list($scope, $method) = explode('::', $key, 2);
+			foreach ($listeners as $listener) {
+				$emitter->listen($scope, $method, $listener);
+			}
+		}
+	}
+}
diff --git a/lib/private/Hooks/LegacyEmitter.php b/lib/private/Hooks/LegacyEmitter.php
new file mode 100644
index 00000000000..ac83477a144
--- /dev/null
+++ b/lib/private/Hooks/LegacyEmitter.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @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\Hooks;
+
+abstract class LegacyEmitter extends BasicEmitter {
+	protected function emit($scope, $method, array $arguments = array()) {
+		\OC_Hook::emit($scope, $method, $arguments);
+		parent::emit($scope, $method, $arguments);
+	}
+}
diff --git a/lib/private/Hooks/PublicEmitter.php b/lib/private/Hooks/PublicEmitter.php
new file mode 100644
index 00000000000..4fe71073a1e
--- /dev/null
+++ b/lib/private/Hooks/PublicEmitter.php
@@ -0,0 +1,34 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @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\Hooks;
+
+class PublicEmitter extends BasicEmitter {
+	/**
+	 * @param string $scope
+	 * @param string $method
+	 * @param array $arguments optional
+	 */
+	public function emit($scope, $method, array $arguments = array()) {
+		parent::emit($scope, $method, $arguments);
+	}
+}