Store storage availability in database

Storage status is saved in the database. Failed storages are rechecked every 10 minutes, while working storages are rechecked every request. Using the files_external app will recheck all external storages when the settings page is viewed, or whenever an external storage is saved.
owncloud · Jul 20, 2015 · df19cab · df19cab
1 parent 89d6439
commit df19cab
Show file tree

Hide file tree

Showing 10 changed files with 737 additions and 13 deletions.
diff --git a/apps/files_external/lib/config.php b/apps/files_external/lib/config.php
@@ -494,8 +494,16 @@ public static function getBackendStatus($class, $options, $isPersonal) {
 		if (class_exists($class)) {
 			try {
 				$storage = new $class($options);
-				if ($storage->test($isPersonal)) {
-					return self::STATUS_SUCCESS;
+
+				try {
+					$result = $storage->test($isPersonal);
+					$storage->setAvailability($result);
+					if ($result) {
+						return self::STATUS_SUCCESS;
+					}
+				} catch (\Exception $e) {
+					$storage->setAvailability(false);
+					throw $e;
 				}
 			} catch (Exception $exception) {
 				\OCP\Util::logException('files_external', $exception);

diff --git a/db_structure.xml b/db_structure.xml
@@ -102,6 +102,18 @@
 				<length>4</length>
 			</field>
 
+			<field>
+				<name>available</name>
+				<type>boolean</type>
+				<default>true</default>
+				<notnull>true</notnull>
+			</field>
+
+			<field>
+				<name>last_checked</name>
+				<type>integer</type>
+			</field>
+
 			<index>
 				<name>storages_id_index</name>
 				<unique>true</unique>

diff --git a/lib/private/files/cache/storage.php b/lib/private/files/cache/storage.php
@@ -43,27 +43,25 @@ class Storage {
 
 	/**
 	 * @param \OC\Files\Storage\Storage|string $storage
+	 * @param bool $isAvailable
 	 * @throws \RuntimeException
 	 */
-	public function __construct($storage) {
+	public function __construct($storage, $isAvailable = true) {
 		if ($storage instanceof \OC\Files\Storage\Storage) {
 			$this->storageId = $storage->getId();
 		} else {
 			$this->storageId = $storage;
 		}
 		$this->storageId = self::adjustStorageId($this->storageId);
 
-		$sql = 'SELECT `numeric_id` FROM `*PREFIX*storages` WHERE `id` = ?';
-		$result = \OC_DB::executeAudited($sql, array($this->storageId));
-		if ($row = $result->fetchRow()) {
+		if ($row = self::getStorageById($this->storageId)) {
 			$this->numericId = $row['numeric_id'];
 		} else {
 			$connection = \OC_DB::getConnection();
-			if ($connection->insertIfNotExist('*PREFIX*storages', ['id' => $this->storageId])) {
+			if ($connection->insertIfNotExist('*PREFIX*storages', ['id' => $this->storageId, 'available' => $isAvailable])) {
 				$this->numericId = \OC_DB::insertid('*PREFIX*storages');
 			} else {
-				$result = \OC_DB::executeAudited($sql, array($this->storageId));
-				if ($row = $result->fetchRow()) {
+				if ($row = self::getStorageById($this->storageId)) {
 					$this->numericId = $row['numeric_id'];
 				} else {
 					throw new \RuntimeException('Storage could neither be inserted nor be selected from the database');
@@ -72,6 +70,16 @@ public function __construct($storage) {
 		}
 	}
 
+	/**
+	 * @param string $storageId
+	 * @return array|null
+	 */
+	public static function getStorageById($storageId) {
+		$sql = 'SELECT * FROM `*PREFIX*storages` WHERE `id` = ?';
+		$result = \OC_DB::executeAudited($sql, array($storageId));
+		return $result->fetchRow();
+	}
+
 	/**
 	 * Adjusts the storage id to use md5 if too long
 	 * @param string $storageId storage id
@@ -120,15 +128,35 @@ public static function getStorageId($numericId) {
 	public static function getNumericStorageId($storageId) {
 		$storageId = self::adjustStorageId($storageId);
 
-		$sql = 'SELECT `numeric_id` FROM `*PREFIX*storages` WHERE `id` = ?';
-		$result = \OC_DB::executeAudited($sql, array($storageId));
-		if ($row = $result->fetchRow()) {
+		if ($row = self::getStorageById($storageId)) {
 			return $row['numeric_id'];
 		} else {
 			return null;
 		}
 	}
 
+	/**
+	 * @return array|null [ available, last_checked ]
+	 */
+	public function getAvailability() {
+		if ($row = self::getStorageById($this->storageId)) {
+			return [
+				'available' => $row['available'],
+				'last_checked' => $row['last_checked']
+			];
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * @param bool $isAvailable
+	 */
+	public function setAvailability($isAvailable) {
+		$sql = 'UPDATE `*PREFIX*storages` SET `available` = ?, `last_checked` = ? WHERE `id` = ?';
+		\OC_DB::executeAudited($sql, array($isAvailable, time(), $this->storageId));
+	}
+
 	/**
 	 * Check if a string storage id is known
 	 *

diff --git a/lib/private/files/storage/common.php b/lib/private/files/storage/common.php
@@ -404,6 +404,11 @@ public function cleanPath($path) {
 		return implode('/', $output);
 	}
 
+	/**
+	 * Test a storage for availability
+	 *
+	 * @return bool
+	 */
 	public function test() {
 		if ($this->stat('')) {
 			return true;
@@ -650,4 +655,18 @@ public function releaseLock($path, $type, ILockingProvider $provider) {
 	public function changeLock($path, $type, ILockingProvider $provider) {
 		$provider->changeLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
 	}
+
+	/**
+	 * @return array [ available, last_checked ]
+	 */
+	public function getAvailability() {
+		return $this->getStorageCache()->getAvailability();
+	}
+
+	/**
+	 * @param bool $isAvailable
+	 */
+	public function setAvailability($isAvailable) {
+		$this->getStorageCache()->setAvailability($isAvailable);
+	}
 }