Add a more powerful notify mechanism

Signed-off-by: Robin Appelman <robin@icewind.nl>

6 files changed, 262 insertions, 0 deletions

diff --git a/lib/private/Files/Notify/Change.php b/lib/private/Files/Notify/Change.php
new file mode 100644
index 00000000000..78cc007b27d
--- /dev/null
+++ b/lib/private/Files/Notify/Change.php
@@ -0,0 +1,65 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
+ *
+ * @author Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Files\Notify;
+
+use OCP\Files\Notify\IChange;
+
+class Change implements IChange {
+	/** @var int */
+	private $type;
+
+	/** @var string */
+	private $path;
+
+	/**
+	 * Change constructor.
+	 *
+	 * @param int $type
+	 * @param string $path
+	 */
+	public function __construct($type, $path) {
+		$this->type = $type;
+		$this->path = $path;
+	}
+
+	/**
+	 * Get the type of the change
+	 *
+	 * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED
+	 */
+	public function getType() {
+		return $this->type;
+	}
+
+	/**
+	 * Get the path of the file that was changed relative to the root of the storage
+	 *
+	 * Note, for rename changes this path is the old path for the file
+	 *
+	 * @return mixed
+	 */
+	public function getPath() {
+		return $this->path;
+	}
+}
diff --git a/lib/private/Files/Notify/RenameChange.php b/lib/private/Files/Notify/RenameChange.php
new file mode 100644
index 00000000000..b83dffa0cb2
--- /dev/null
+++ b/lib/private/Files/Notify/RenameChange.php
@@ -0,0 +1,52 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
+ *
+ * @author Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Files\Notify;
+
+use OCP\Files\Notify\IRenameChange;
+
+class RenameChange extends Change implements IRenameChange {
+	/** @var string */
+	private $targetPath;
+
+	/**
+	 * Change constructor.
+	 *
+	 * @param int $type
+	 * @param string $path
+	 * @param string $targetPath
+	 */
+	public function __construct($type, $path, $targetPath) {
+		parent::__construct($type, $path);
+		$this->targetPath = $targetPath;
+	}
+
+	/**
+	 * Get the new path of the renamed file relative to the storage root
+	 *
+	 * @return string
+	 */
+	public function getTargetPath() {
+		return $this->targetPath;
+	}
+}
diff --git a/lib/public/Files/Notify/IChange.php b/lib/public/Files/Notify/IChange.php
new file mode 100644
index 00000000000..09d9500a3de
--- /dev/null
+++ b/lib/public/Files/Notify/IChange.php
@@ -0,0 +1,47 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
+ *
+ * @author Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Files\Notify;
+
+interface IChange {
+	const ADDED = 1;
+	const REMOVED = 2;
+	const MODIFIED = 3;
+	const RENAMED = 4;
+
+	/**
+	 * Get the type of the change
+	 *
+	 * @return int IChange::ADDED, IChange::REMOVED, IChange::MODIFIED or IChange::RENAMED
+	 */
+	public function getType();
+
+	/**
+	 * Get the path of the file that was changed relative to the root of the storage
+	 *
+	 * Note, for rename changes this path is the old path for the file
+	 *
+	 * @return mixed
+	 */
+	public function getPath();
+}
diff --git a/lib/public/Files/Notify/INotifyHandler.php b/lib/public/Files/Notify/INotifyHandler.php
new file mode 100644
index 00000000000..be672426a06
--- /dev/null
+++ b/lib/public/Files/Notify/INotifyHandler.php
@@ -0,0 +1,52 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
+ *
+ * @author Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Files\Notify;
+
+interface INotifyHandler {
+	/**
+	 * Start listening for update notifications
+	 *
+	 * The provided callback will be called for every incoming notification with the following parameters
+	 *  - IChange|IRenameChange $change
+	 *
+	 * Note that this call is blocking and will not exit on it's own, to stop listening for notifications return `false` from the callback
+	 *
+	 * @param callable $callback
+	 */
+	public function listen(callable $callback);
+
+	/**
+	 * Get all changes detected since the start of the notify process or the last call to getChanges
+	 *
+	 * @return IChange[]
+	 */
+	public function getChanges();
+
+	/**
+	 * Stop listening for changes
+	 *
+	 * Note that any pending changes will be discarded
+	 */
+	public function stop();
+}
diff --git a/lib/public/Files/Notify/IRenameChange.php b/lib/public/Files/Notify/IRenameChange.php
new file mode 100644
index 00000000000..710a8acf0f2
--- /dev/null
+++ b/lib/public/Files/Notify/IRenameChange.php
@@ -0,0 +1,33 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
+ *
+ * @author Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCP\Files\Notify;
+
+interface IRenameChange extends IChange {
+	/**
+	 * Get the new path of the renamed file relative to the storage root
+	 *
+	 * @return string
+	 */
+	public function getTargetPath();
+}
diff --git a/lib/public/Files/Storage/INotifyStorage.php b/lib/public/Files/Storage/INotifyStorage.php
index e99124abdfd..c6fdd44724f 100644
--- a/lib/public/Files/Storage/INotifyStorage.php
+++ b/lib/public/Files/Storage/INotifyStorage.php
@@ -23,6 +23,8 @@
 
 namespace OCP\Files\Storage;
 
+use OCP\Files\Notify\INotifyHandler;
+
 /**
  * Storage backend that support active notifications
  *
@@ -48,6 +50,17 @@ interface INotifyStorage {
 	 * @param callable $callback
 	 *
 	 * @since 9.1.0
+	 * @deprecated 12.0.0 use INotifyStorage::notify()->listen() instead
 	 */
 	public function listen($path, callable $callback);
+
+	/**
+	 * Start the notification handler for this storage
+	 *
+	 * @param $path
+	 * @return INotifyHandler
+	 *
+	 * @since 12.0.0
+	 */
+	public function notify($path);
 }