Add a more powerful notify mechanism

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

1 files changed, 150 insertions, 0 deletions

diff --git a/apps/files_external/lib/Lib/Notify/SMBNotifyHandler.php b/apps/files_external/lib/Lib/Notify/SMBNotifyHandler.php
new file mode 100644
index 00000000000..9ac74b32ad8
--- /dev/null
+++ b/apps/files_external/lib/Lib/Notify/SMBNotifyHandler.php
@@ -0,0 +1,150 @@
+<?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 OCA\Files_External\Lib\Notify;
+
+use OC\Files\Notify\Change;
+use OC\Files\Notify\RenameChange;
+use OCP\Files\Notify\IChange;
+use OCP\Files\Notify\INotifyHandler;
+
+class SMBNotifyHandler implements INotifyHandler {
+	/**
+	 * @var \Icewind\SMB\INotifyHandler
+	 */
+	private $shareNotifyHandler;
+
+	/**
+	 * @var string
+	 */
+	private $root;
+
+	private $oldRenamePath = null;
+
+	/**
+	 * SMBNotifyHandler constructor.
+	 *
+	 * @param \Icewind\SMB\INotifyHandler $shareNotifyHandler
+	 * @param string $root
+	 */
+	public function __construct(\Icewind\SMB\INotifyHandler $shareNotifyHandler, $root) {
+		$this->shareNotifyHandler = $shareNotifyHandler;
+		$this->root = $root;
+	}
+
+	private function relativePath($fullPath) {
+		if ($fullPath === $this->root) {
+			return '';
+		} else if (substr($fullPath, 0, strlen($this->root)) === $this->root) {
+			return substr($fullPath, strlen($this->root));
+		} else {
+			return null;
+		}
+	}
+
+	public function listen(callable $callback) {
+		$oldRenamePath = null;
+		$this->shareNotifyHandler->listen(function (\Icewind\SMB\Change $shareChange) use ($callback) {
+			$change = $this->mapChange($shareChange);
+			if (!is_null($change)) {
+				return $callback($change);
+			} else {
+				return true;
+			}
+		});
+	}
+
+	/**
+	 * Get all changes detected since the start of the notify process or the last call to getChanges
+	 *
+	 * @return IChange[]
+	 */
+	public function getChanges() {
+		$shareChanges = $this->shareNotifyHandler->getChanges();
+		$changes = [];
+		foreach ($shareChanges as $shareChange) {
+			$change = $this->mapChange($shareChange);
+			if ($change) {
+				$changes[] = $change;
+			}
+		}
+		return $changes;
+	}
+
+	/**
+	 * Stop listening for changes
+	 *
+	 * Note that any pending changes will be discarded
+	 */
+	public function stop() {
+		$this->shareNotifyHandler->stop();
+	}
+
+	/**
+	 * @param \Icewind\SMB\Change $change
+	 * @return IChange|null
+	 */
+	private function mapChange(\Icewind\SMB\Change $change) {
+		$path = $this->relativePath($change->getPath());
+		if (is_null($path)) {
+			return null;
+		}
+		if ($change->getCode() === \Icewind\SMB\INotifyHandler::NOTIFY_RENAMED_OLD) {
+			$this->oldRenamePath = $path;
+			return null;
+		}
+		$type = $this->mapNotifyType($change->getCode());
+		if (is_null($type)) {
+			return null;
+		}
+		if ($type === IChange::RENAMED) {
+			if (!is_null($this->oldRenamePath)) {
+				$result = new RenameChange($type, $this->oldRenamePath, $path);
+				$this->oldRenamePath = null;
+			} else {
+				$result = null;
+			}
+		} else {
+			$result = new Change($type, $path);
+		}
+		return $result;
+	}
+
+	private function mapNotifyType($smbType) {
+		switch ($smbType) {
+			case \Icewind\SMB\INotifyHandler::NOTIFY_ADDED:
+				return IChange::ADDED;
+			case \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED:
+				return IChange::REMOVED;
+			case \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED:
+			case \Icewind\SMB\INotifyHandler::NOTIFY_ADDED_STREAM:
+			case \Icewind\SMB\INotifyHandler::NOTIFY_MODIFIED_STREAM:
+			case \Icewind\SMB\INotifyHandler::NOTIFY_REMOVED_STREAM:
+				return IChange::MODIFIED;
+			case \Icewind\SMB\INotifyHandler::NOTIFY_RENAMED_NEW:
+				return IChange::RENAMED;
+			default:
+				return null;
+		}
+	}
+}