Merge pull request #18080 from nextcloud/enhancement/noid/add-timeout

adding timeout param

Author: blizzz

lib/composer/composer/autoload_classmap.php

@@ -365,6 +365,7 @@
     'OCP\\LDAP\\ILDAPProviderFactory' => $baseDir . '/lib/public/LDAP/ILDAPProviderFactory.php',
     'OCP\\Lock\\ILockingProvider' => $baseDir . '/lib/public/Lock/ILockingProvider.php',
     'OCP\\Lock\\LockedException' => $baseDir . '/lib/public/Lock/LockedException.php',
+    'OCP\\Lock\\ManuallyLockedException' => $baseDir . '/lib/public/Lock/ManuallyLockedException.php',
     'OCP\\Lockdown\\ILockdownManager' => $baseDir . '/lib/public/Lockdown/ILockdownManager.php',
     'OCP\\Log\\IFileBased' => $baseDir . '/lib/public/Log/IFileBased.php',
     'OCP\\Log\\ILogFactory' => $baseDir . '/lib/public/Log/ILogFactory.php',

lib/composer/composer/autoload_static.php

@@ -394,6 +394,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OCP\\LDAP\\ILDAPProviderFactory' => __DIR__ . '/../../..' . '/lib/public/LDAP/ILDAPProviderFactory.php',
         'OCP\\Lock\\ILockingProvider' => __DIR__ . '/../../..' . '/lib/public/Lock/ILockingProvider.php',
         'OCP\\Lock\\LockedException' => __DIR__ . '/../../..' . '/lib/public/Lock/LockedException.php',
+        'OCP\\Lock\\ManuallyLockedException' => __DIR__ . '/../../..' . '/lib/public/Lock/ManuallyLockedException.php',
         'OCP\\Lockdown\\ILockdownManager' => __DIR__ . '/../../..' . '/lib/public/Lockdown/ILockdownManager.php',
         'OCP\\Log\\IFileBased' => __DIR__ . '/../../..' . '/lib/public/Log/IFileBased.php',
         'OCP\\Log\\ILogFactory' => __DIR__ . '/../../..' . '/lib/public/Log/ILogFactory.php',

lib/public/Lock/ManuallyLockedException.php

@@ -0,0 +1,91 @@
+<?php declare(strict_types=1);
+
+
+
+/**
+ * This file is licensed under the Affero General Public License version 3 or
+ * later. See the COPYING file.
+ *
+ * @author Maxence Lange <[email protected]>
+ * @copyright 2019, Maxence Lange <[email protected]>
+ * @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\Lock;
+
+
+/**
+ * Class ManuallyLockedException
+ *
+ * @package OCP\Lock
+ * @since 18.0.0
+ */
+class ManuallyLockedException extends LockedException {
+
+
+	/**
+	 * owner of the lock
+	 *
+	 * @var string|null
+	 */
+	private $owner = null;
+
+	/**
+	 * estimated timeout for the lock
+	 *
+	 * @var int
+	 * @since 18.0.0
+	 */
+	private $timeout = -1;
+
+
+	/**
+	 * ManuallyLockedException constructor.
+	 *
+	 * @param string $path locked path
+	 * @param \Exception|null $previous previous exception for cascading
+	 * @param string $existingLock
+	 * @param string|null $owner
+	 * @param int $timeout
+	 *
+	 * @since 18.0.0
+	 */
+	public function __construct(string $path, \Exception $previous = null, ?string $existingLock = null, ?string $owner = null, int $timeout = -1) {
+		parent::__construct($path, $previous, $existingLock);
+		$this->owner = $owner;
+		$this->timeout = $timeout;
+	}
+
+
+	/**
+	 * @return int
+	 * @since 18.0.0
+	 */
+	public function getTimeout(): int {
+		return $this->timeout;
+	}
+
+	/**
+	 * @return string|null
+	 * @since 18.0.0
+	 */
+	public function getOwner(): ?string {
+		return $this->owner;
+	}
+
+}