nextcloud / server

lib/private/Files/Config/UserMountCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 	}
 
 	/**
-	 * @param $fileId
+	 * @param integer $fileId
 	 * @return array
 	 * @throws \OCP\Files\NotFoundException
 	 */

Unused Use Statements -1 removed lines

@@ -24,7 +24,6 @@
 
 namespace OC\Files\Config;
 
-use OC\DB\QueryBuilder\Literal;
 use OCA\Files_Sharing\SharedMount;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\Files\Config\ICachedMountInfo;

Spacing +11 added lines, -11 removed lines

@@ -87,11 +87,11 @@ 
 
 	public function registerMounts(IUser $user, array $mounts) {
 		// filter out non-proper storages coming from unit tests
-		$mounts = array_filter($mounts, function (IMountPoint $mount) {
+		$mounts = array_filter($mounts, function(IMountPoint $mount) {
 			return $mount instanceof SharedMount || $mount->getStorage() && $mount->getStorage()->getCache();
 		});
 		/** @var ICachedMountInfo[] $newMounts */
-		$newMounts = array_map(function (IMountPoint $mount) use ($user) {
+		$newMounts = array_map(function(IMountPoint $mount) use ($user) {
 			// filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
 			if ($mount->getStorageRootId() === -1) {
 				return null;
@@ -102,7 +102,7 @@ 
 		$newMounts = array_values(array_filter($newMounts));
 
 		$cachedMounts = $this->getMountsForUser($user);
-		$mountDiff = function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
+		$mountDiff = function(ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
 			// since we are only looking for mounts for a specific user comparing on root id is enough
 			return $mount1->getRootId() - $mount2->getRootId();
 		};
@@ -163,7 +163,7 @@ 
 			], ['root_id', 'user_id']);
 		} else {
 			// in some cases this is legitimate, like orphaned shares
-			$this->logger->debug('Could not get storage info for mount at ' . $mount->getMountPoint());
+			$this->logger->debug('Could not get storage info for mount at '.$mount->getMountPoint());
 		}
 	}
 
@@ -194,7 +194,7 @@ 
 		if (is_null($user)) {
 			return null;
 		}
-		return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point'], $row['mount_id'], isset($row['path']) ? $row['path'] : '');
+		return new CachedMountInfo($user, (int) $row['storage_id'], (int) $row['root_id'], $row['mount_point'], $row['mount_id'], isset($row['path']) ? $row['path'] : '');
 	}
 
 	/**
@@ -268,12 +268,12 @@ 
 			$row = $query->execute()->fetch();
 			if (is_array($row)) {
 				$this->cacheInfoCache[$fileId] = [
-					(int)$row['storage'],
+					(int) $row['storage'],
 					$row['path'],
-					(int)$row['mimetype']
+					(int) $row['mimetype']
 				];
 			} else {
-				throw new NotFoundException('File with id "' . $fileId . '" not found');
+				throw new NotFoundException('File with id "'.$fileId.'" not found');
 			}
 		}
 		return $this->cacheInfoCache[$fileId];
@@ -294,13 +294,13 @@ 
 		$mountsForStorage = $this->getMountsForStorageId($storageId, $user);
 
 		// filter mounts that are from the same storage but a different directory
-		return array_filter($mountsForStorage, function (ICachedMountInfo $mount) use ($internalPath, $fileId) {
+		return array_filter($mountsForStorage, function(ICachedMountInfo $mount) use ($internalPath, $fileId) {
 			if ($fileId === $mount->getRootId()) {
 				return true;
 			}
 			$internalMountPath = $mount->getRootInternalPath();
 
-			return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath . '/';
+			return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath.'/';
 		});
 	}
 
@@ -344,7 +344,7 @@ 
 			$slash
 		);
 
-		$userIds = array_map(function (IUser $user) {
+		$userIds = array_map(function(IUser $user) {
 			return $user->getUID();
 		}, $users);
 

Indentation +325 added lines, -325 removed lines

@@ -42,329 +42,329 @@
  * Cache mounts points per user in the cache so we can easilly look them up
  */
 class UserMountCache implements IUserMountCache {
-	/**
-	 * @var IDBConnection
-	 */
-	private $connection;
-
-	/**
-	 * @var IUserManager
-	 */
-	private $userManager;
-
-	/**
-	 * Cached mount info.
-	 * Map of $userId to ICachedMountInfo.
-	 *
-	 * @var ICache
-	 **/
-	private $mountsForUsers;
-
-	/**
-	 * @var ILogger
-	 */
-	private $logger;
-
-	/**
-	 * @var ICache
-	 */
-	private $cacheInfoCache;
-
-	/**
-	 * UserMountCache constructor.
-	 *
-	 * @param IDBConnection $connection
-	 * @param IUserManager $userManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(IDBConnection $connection, IUserManager $userManager, ILogger $logger) {
-		$this->connection = $connection;
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$this->cacheInfoCache = new CappedMemoryCache();
-		$this->mountsForUsers = new CappedMemoryCache();
-	}
-
-	public function registerMounts(IUser $user, array $mounts) {
-		// filter out non-proper storages coming from unit tests
-		$mounts = array_filter($mounts, function (IMountPoint $mount) {
-			return $mount instanceof SharedMount || $mount->getStorage() && $mount->getStorage()->getCache();
-		});
-		/** @var ICachedMountInfo[] $newMounts */
-		$newMounts = array_map(function (IMountPoint $mount) use ($user) {
-			// filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
-			if ($mount->getStorageRootId() === -1) {
-				return null;
-			} else {
-				return new LazyStorageMountInfo($user, $mount);
-			}
-		}, $mounts);
-		$newMounts = array_values(array_filter($newMounts));
-
-		$cachedMounts = $this->getMountsForUser($user);
-		$mountDiff = function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
-			// since we are only looking for mounts for a specific user comparing on root id is enough
-			return $mount1->getRootId() - $mount2->getRootId();
-		};
-
-		/** @var ICachedMountInfo[] $addedMounts */
-		$addedMounts = array_udiff($newMounts, $cachedMounts, $mountDiff);
-		/** @var ICachedMountInfo[] $removedMounts */
-		$removedMounts = array_udiff($cachedMounts, $newMounts, $mountDiff);
-
-		$changedMounts = $this->findChangedMounts($newMounts, $cachedMounts);
-
-		foreach ($addedMounts as $mount) {
-			$this->addToCache($mount);
-			$this->mountsForUsers[$user->getUID()][] = $mount;
-		}
-		foreach ($removedMounts as $mount) {
-			$this->removeFromCache($mount);
-			$index = array_search($mount, $this->mountsForUsers[$user->getUID()]);
-			unset($this->mountsForUsers[$user->getUID()][$index]);
-		}
-		foreach ($changedMounts as $mount) {
-			$this->updateCachedMount($mount);
-		}
-	}
-
-	/**
-	 * @param ICachedMountInfo[] $newMounts
-	 * @param ICachedMountInfo[] $cachedMounts
-	 * @return ICachedMountInfo[]
-	 */
-	private function findChangedMounts(array $newMounts, array $cachedMounts) {
-		$changed = [];
-		foreach ($newMounts as $newMount) {
-			foreach ($cachedMounts as $cachedMount) {
-				if (
-					$newMount->getRootId() === $cachedMount->getRootId() &&
-					(
-						$newMount->getMountPoint() !== $cachedMount->getMountPoint() ||
-						$newMount->getStorageId() !== $cachedMount->getStorageId() ||
-						$newMount->getMountId() !== $cachedMount->getMountId()
-					)
-				) {
-					$changed[] = $newMount;
-				}
-			}
-		}
-		return $changed;
-	}
-
-	private function addToCache(ICachedMountInfo $mount) {
-		if ($mount->getStorageId() !== -1) {
-			$this->connection->insertIfNotExist('*PREFIX*mounts', [
-				'storage_id' => $mount->getStorageId(),
-				'root_id' => $mount->getRootId(),
-				'user_id' => $mount->getUser()->getUID(),
-				'mount_point' => $mount->getMountPoint(),
-				'mount_id' => $mount->getMountId()
-			], ['root_id', 'user_id']);
-		} else {
-			// in some cases this is legitimate, like orphaned shares
-			$this->logger->debug('Could not get storage info for mount at ' . $mount->getMountPoint());
-		}
-	}
-
-	private function updateCachedMount(ICachedMountInfo $mount) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->update('mounts')
-			->set('storage_id', $builder->createNamedParameter($mount->getStorageId()))
-			->set('mount_point', $builder->createNamedParameter($mount->getMountPoint()))
-			->set('mount_id', $builder->createNamedParameter($mount->getMountId(), IQueryBuilder::PARAM_INT))
-			->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
-			->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), IQueryBuilder::PARAM_INT)));
-
-		$query->execute();
-	}
-
-	private function removeFromCache(ICachedMountInfo $mount) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->delete('mounts')
-			->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
-			->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	private function dbRowToMountInfo(array $row) {
-		$user = $this->userManager->get($row['user_id']);
-		if (is_null($user)) {
-			return null;
-		}
-		return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point'], $row['mount_id'], isset($row['path']) ? $row['path'] : '');
-	}
-
-	/**
-	 * @param IUser $user
-	 * @return ICachedMountInfo[]
-	 */
-	public function getMountsForUser(IUser $user) {
-		if (!isset($this->mountsForUsers[$user->getUID()])) {
-			$builder = $this->connection->getQueryBuilder();
-			$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point', 'mount_id', 'f.path')
-				->from('mounts', 'm')
-				->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
-				->where($builder->expr()->eq('user_id', $builder->createPositionalParameter($user->getUID())));
-
-			$rows = $query->execute()->fetchAll();
-
-			$this->mountsForUsers[$user->getUID()] = array_filter(array_map([$this, 'dbRowToMountInfo'], $rows));
-		}
-		return $this->mountsForUsers[$user->getUID()];
-	}
-
-	/**
-	 * @param int $numericStorageId
-	 * @param string|null $user limit the results to a single user
-	 * @return CachedMountInfo[]
-	 */
-	public function getMountsForStorageId($numericStorageId, $user = null) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point', 'mount_id', 'f.path')
-			->from('mounts', 'm')
-			->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
-			->where($builder->expr()->eq('storage_id', $builder->createPositionalParameter($numericStorageId, IQueryBuilder::PARAM_INT)));
-
-		if ($user) {
-			$query->andWhere($builder->expr()->eq('user_id', $builder->createPositionalParameter($user)));
-		}
-
-		$rows = $query->execute()->fetchAll();
-
-		return array_filter(array_map([$this, 'dbRowToMountInfo'], $rows));
-	}
-
-	/**
-	 * @param int $rootFileId
-	 * @return CachedMountInfo[]
-	 */
-	public function getMountsForRootId($rootFileId) {
-		$builder = $this->connection->getQueryBuilder();
-		$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point', 'mount_id', 'f.path')
-			->from('mounts', 'm')
-			->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
-			->where($builder->expr()->eq('root_id', $builder->createPositionalParameter($rootFileId, IQueryBuilder::PARAM_INT)));
-
-		$rows = $query->execute()->fetchAll();
-
-		return array_filter(array_map([$this, 'dbRowToMountInfo'], $rows));
-	}
-
-	/**
-	 * @param $fileId
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	private function getCacheInfoFromFileId($fileId) {
-		if (!isset($this->cacheInfoCache[$fileId])) {
-			$builder = $this->connection->getQueryBuilder();
-			$query = $builder->select('storage', 'path', 'mimetype')
-				->from('filecache')
-				->where($builder->expr()->eq('fileid', $builder->createNamedParameter($fileId, IQueryBuilder::PARAM_INT)));
-
-			$row = $query->execute()->fetch();
-			if (is_array($row)) {
-				$this->cacheInfoCache[$fileId] = [
-					(int)$row['storage'],
-					$row['path'],
-					(int)$row['mimetype']
-				];
-			} else {
-				throw new NotFoundException('File with id "' . $fileId . '" not found');
-			}
-		}
-		return $this->cacheInfoCache[$fileId];
-	}
-
-	/**
-	 * @param int $fileId
-	 * @param string|null $user optionally restrict the results to a single user
-	 * @return ICachedMountInfo[]
-	 * @since 9.0.0
-	 */
-	public function getMountsForFileId($fileId, $user = null) {
-		try {
-			list($storageId, $internalPath) = $this->getCacheInfoFromFileId($fileId);
-		} catch (NotFoundException $e) {
-			return [];
-		}
-		$mountsForStorage = $this->getMountsForStorageId($storageId, $user);
-
-		// filter mounts that are from the same storage but a different directory
-		return array_filter($mountsForStorage, function (ICachedMountInfo $mount) use ($internalPath, $fileId) {
-			if ($fileId === $mount->getRootId()) {
-				return true;
-			}
-			$internalMountPath = $mount->getRootInternalPath();
-
-			return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath . '/';
-		});
-	}
-
-	/**
-	 * Remove all cached mounts for a user
-	 *
-	 * @param IUser $user
-	 */
-	public function removeUserMounts(IUser $user) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->delete('mounts')
-			->where($builder->expr()->eq('user_id', $builder->createNamedParameter($user->getUID())));
-		$query->execute();
-	}
-
-	public function removeUserStorageMount($storageId, $userId) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->delete('mounts')
-			->where($builder->expr()->eq('user_id', $builder->createNamedParameter($userId)))
-			->andWhere($builder->expr()->eq('storage_id', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	public function remoteStorageMounts($storageId) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$query = $builder->delete('mounts')
-			->where($builder->expr()->eq('storage_id', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
-		$query->execute();
-	}
-
-	/**
-	 * @param array $users
-	 * @return array
-	 * @suppress SqlInjectionChecker
-	 */
-	public function getUsedSpaceForUsers(array $users) {
-		$builder = $this->connection->getQueryBuilder();
-
-		$slash = $builder->createNamedParameter('/');
-
-		$mountPoint = $builder->func()->concat(
-			$builder->func()->concat($slash, 'user_id'),
-			$slash
-		);
-
-		$userIds = array_map(function (IUser $user) {
-			return $user->getUID();
-		}, $users);
-
-		$query = $builder->select('m.user_id', 'f.size')
-			->from('mounts', 'm')
-			->innerJoin('m', 'filecache', 'f',
-				$builder->expr()->andX(
-					$builder->expr()->eq('m.storage_id', 'f.storage'),
-					$builder->expr()->eq('f.path', $builder->createNamedParameter('files'))
-				))
-			->where($builder->expr()->eq('m.mount_point', $mountPoint))
-			->andWhere($builder->expr()->in('m.user_id', $builder->createNamedParameter($userIds, IQueryBuilder::PARAM_STR_ARRAY)));
-
-		$result = $query->execute();
-
-		return $result->fetchAll(\PDO::FETCH_KEY_PAIR);
-	}
+    /**
+     * @var IDBConnection
+     */
+    private $connection;
+
+    /**
+     * @var IUserManager
+     */
+    private $userManager;
+
+    /**
+     * Cached mount info.
+     * Map of $userId to ICachedMountInfo.
+     *
+     * @var ICache
+     **/
+    private $mountsForUsers;
+
+    /**
+     * @var ILogger
+     */
+    private $logger;
+
+    /**
+     * @var ICache
+     */
+    private $cacheInfoCache;
+
+    /**
+     * UserMountCache constructor.
+     *
+     * @param IDBConnection $connection
+     * @param IUserManager $userManager
+     * @param ILogger $logger
+     */
+    public function __construct(IDBConnection $connection, IUserManager $userManager, ILogger $logger) {
+        $this->connection = $connection;
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $this->cacheInfoCache = new CappedMemoryCache();
+        $this->mountsForUsers = new CappedMemoryCache();
+    }
+
+    public function registerMounts(IUser $user, array $mounts) {
+        // filter out non-proper storages coming from unit tests
+        $mounts = array_filter($mounts, function (IMountPoint $mount) {
+            return $mount instanceof SharedMount || $mount->getStorage() && $mount->getStorage()->getCache();
+        });
+        /** @var ICachedMountInfo[] $newMounts */
+        $newMounts = array_map(function (IMountPoint $mount) use ($user) {
+            // filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
+            if ($mount->getStorageRootId() === -1) {
+                return null;
+            } else {
+                return new LazyStorageMountInfo($user, $mount);
+            }
+        }, $mounts);
+        $newMounts = array_values(array_filter($newMounts));
+
+        $cachedMounts = $this->getMountsForUser($user);
+        $mountDiff = function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
+            // since we are only looking for mounts for a specific user comparing on root id is enough
+            return $mount1->getRootId() - $mount2->getRootId();
+        };
+
+        /** @var ICachedMountInfo[] $addedMounts */
+        $addedMounts = array_udiff($newMounts, $cachedMounts, $mountDiff);
+        /** @var ICachedMountInfo[] $removedMounts */
+        $removedMounts = array_udiff($cachedMounts, $newMounts, $mountDiff);
+
+        $changedMounts = $this->findChangedMounts($newMounts, $cachedMounts);
+
+        foreach ($addedMounts as $mount) {
+            $this->addToCache($mount);
+            $this->mountsForUsers[$user->getUID()][] = $mount;
+        }
+        foreach ($removedMounts as $mount) {
+            $this->removeFromCache($mount);
+            $index = array_search($mount, $this->mountsForUsers[$user->getUID()]);
+            unset($this->mountsForUsers[$user->getUID()][$index]);
+        }
+        foreach ($changedMounts as $mount) {
+            $this->updateCachedMount($mount);
+        }
+    }
+
+    /**
+     * @param ICachedMountInfo[] $newMounts
+     * @param ICachedMountInfo[] $cachedMounts
+     * @return ICachedMountInfo[]
+     */
+    private function findChangedMounts(array $newMounts, array $cachedMounts) {
+        $changed = [];
+        foreach ($newMounts as $newMount) {
+            foreach ($cachedMounts as $cachedMount) {
+                if (
+                    $newMount->getRootId() === $cachedMount->getRootId() &&
+                    (
+                        $newMount->getMountPoint() !== $cachedMount->getMountPoint() ||
+                        $newMount->getStorageId() !== $cachedMount->getStorageId() ||
+                        $newMount->getMountId() !== $cachedMount->getMountId()
+                    )
+                ) {
+                    $changed[] = $newMount;
+                }
+            }
+        }
+        return $changed;
+    }
+
+    private function addToCache(ICachedMountInfo $mount) {
+        if ($mount->getStorageId() !== -1) {
+            $this->connection->insertIfNotExist('*PREFIX*mounts', [
+                'storage_id' => $mount->getStorageId(),
+                'root_id' => $mount->getRootId(),
+                'user_id' => $mount->getUser()->getUID(),
+                'mount_point' => $mount->getMountPoint(),
+                'mount_id' => $mount->getMountId()
+            ], ['root_id', 'user_id']);
+        } else {
+            // in some cases this is legitimate, like orphaned shares
+            $this->logger->debug('Could not get storage info for mount at ' . $mount->getMountPoint());
+        }
+    }
+
+    private function updateCachedMount(ICachedMountInfo $mount) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->update('mounts')
+            ->set('storage_id', $builder->createNamedParameter($mount->getStorageId()))
+            ->set('mount_point', $builder->createNamedParameter($mount->getMountPoint()))
+            ->set('mount_id', $builder->createNamedParameter($mount->getMountId(), IQueryBuilder::PARAM_INT))
+            ->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
+            ->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), IQueryBuilder::PARAM_INT)));
+
+        $query->execute();
+    }
+
+    private function removeFromCache(ICachedMountInfo $mount) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->delete('mounts')
+            ->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
+            ->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    private function dbRowToMountInfo(array $row) {
+        $user = $this->userManager->get($row['user_id']);
+        if (is_null($user)) {
+            return null;
+        }
+        return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point'], $row['mount_id'], isset($row['path']) ? $row['path'] : '');
+    }
+
+    /**
+     * @param IUser $user
+     * @return ICachedMountInfo[]
+     */
+    public function getMountsForUser(IUser $user) {
+        if (!isset($this->mountsForUsers[$user->getUID()])) {
+            $builder = $this->connection->getQueryBuilder();
+            $query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point', 'mount_id', 'f.path')
+                ->from('mounts', 'm')
+                ->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
+                ->where($builder->expr()->eq('user_id', $builder->createPositionalParameter($user->getUID())));
+
+            $rows = $query->execute()->fetchAll();
+
+            $this->mountsForUsers[$user->getUID()] = array_filter(array_map([$this, 'dbRowToMountInfo'], $rows));
+        }
+        return $this->mountsForUsers[$user->getUID()];
+    }
+
+    /**
+     * @param int $numericStorageId
+     * @param string|null $user limit the results to a single user
+     * @return CachedMountInfo[]
+     */
+    public function getMountsForStorageId($numericStorageId, $user = null) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point', 'mount_id', 'f.path')
+            ->from('mounts', 'm')
+            ->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
+            ->where($builder->expr()->eq('storage_id', $builder->createPositionalParameter($numericStorageId, IQueryBuilder::PARAM_INT)));
+
+        if ($user) {
+            $query->andWhere($builder->expr()->eq('user_id', $builder->createPositionalParameter($user)));
+        }
+
+        $rows = $query->execute()->fetchAll();
+
+        return array_filter(array_map([$this, 'dbRowToMountInfo'], $rows));
+    }
+
+    /**
+     * @param int $rootFileId
+     * @return CachedMountInfo[]
+     */
+    public function getMountsForRootId($rootFileId) {
+        $builder = $this->connection->getQueryBuilder();
+        $query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point', 'mount_id', 'f.path')
+            ->from('mounts', 'm')
+            ->innerJoin('m', 'filecache', 'f', $builder->expr()->eq('m.root_id', 'f.fileid'))
+            ->where($builder->expr()->eq('root_id', $builder->createPositionalParameter($rootFileId, IQueryBuilder::PARAM_INT)));
+
+        $rows = $query->execute()->fetchAll();
+
+        return array_filter(array_map([$this, 'dbRowToMountInfo'], $rows));
+    }
+
+    /**
+     * @param $fileId
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    private function getCacheInfoFromFileId($fileId) {
+        if (!isset($this->cacheInfoCache[$fileId])) {
+            $builder = $this->connection->getQueryBuilder();
+            $query = $builder->select('storage', 'path', 'mimetype')
+                ->from('filecache')
+                ->where($builder->expr()->eq('fileid', $builder->createNamedParameter($fileId, IQueryBuilder::PARAM_INT)));
+
+            $row = $query->execute()->fetch();
+            if (is_array($row)) {
+                $this->cacheInfoCache[$fileId] = [
+                    (int)$row['storage'],
+                    $row['path'],
+                    (int)$row['mimetype']
+                ];
+            } else {
+                throw new NotFoundException('File with id "' . $fileId . '" not found');
+            }
+        }
+        return $this->cacheInfoCache[$fileId];
+    }
+
+    /**
+     * @param int $fileId
+     * @param string|null $user optionally restrict the results to a single user
+     * @return ICachedMountInfo[]
+     * @since 9.0.0
+     */
+    public function getMountsForFileId($fileId, $user = null) {
+        try {
+            list($storageId, $internalPath) = $this->getCacheInfoFromFileId($fileId);
+        } catch (NotFoundException $e) {
+            return [];
+        }
+        $mountsForStorage = $this->getMountsForStorageId($storageId, $user);
+
+        // filter mounts that are from the same storage but a different directory
+        return array_filter($mountsForStorage, function (ICachedMountInfo $mount) use ($internalPath, $fileId) {
+            if ($fileId === $mount->getRootId()) {
+                return true;
+            }
+            $internalMountPath = $mount->getRootInternalPath();
+
+            return $internalMountPath === '' || substr($internalPath, 0, strlen($internalMountPath) + 1) === $internalMountPath . '/';
+        });
+    }
+
+    /**
+     * Remove all cached mounts for a user
+     *
+     * @param IUser $user
+     */
+    public function removeUserMounts(IUser $user) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->delete('mounts')
+            ->where($builder->expr()->eq('user_id', $builder->createNamedParameter($user->getUID())));
+        $query->execute();
+    }
+
+    public function removeUserStorageMount($storageId, $userId) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->delete('mounts')
+            ->where($builder->expr()->eq('user_id', $builder->createNamedParameter($userId)))
+            ->andWhere($builder->expr()->eq('storage_id', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    public function remoteStorageMounts($storageId) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $query = $builder->delete('mounts')
+            ->where($builder->expr()->eq('storage_id', $builder->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
+        $query->execute();
+    }
+
+    /**
+     * @param array $users
+     * @return array
+     * @suppress SqlInjectionChecker
+     */
+    public function getUsedSpaceForUsers(array $users) {
+        $builder = $this->connection->getQueryBuilder();
+
+        $slash = $builder->createNamedParameter('/');
+
+        $mountPoint = $builder->func()->concat(
+            $builder->func()->concat($slash, 'user_id'),
+            $slash
+        );
+
+        $userIds = array_map(function (IUser $user) {
+            return $user->getUID();
+        }, $users);
+
+        $query = $builder->select('m.user_id', 'f.size')
+            ->from('mounts', 'm')
+            ->innerJoin('m', 'filecache', 'f',
+                $builder->expr()->andX(
+                    $builder->expr()->eq('m.storage_id', 'f.storage'),
+                    $builder->expr()->eq('f.path', $builder->createNamedParameter('files'))
+                ))
+            ->where($builder->expr()->eq('m.mount_point', $mountPoint))
+            ->andWhere($builder->expr()->in('m.user_id', $builder->createNamedParameter($userIds, IQueryBuilder::PARAM_STR_ARRAY)));
+
+        $result = $query->execute();
+
+        return $result->fetchAll(\PDO::FETCH_KEY_PAIR);
+    }
 }

lib/private/Files/Node/LazyRoot.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	 * Magic method to first get the real rootFolder and then
 	 * call $method with $args on it
 	 *
-	 * @param $method
+	 * @param string $method
 	 * @param $args
 	 * @return mixed
 	 */

Indentation +443 added lines, -443 removed lines

@@ -34,447 +34,447 @@
  * @package OC\Files\Node
  */
 class LazyRoot implements IRootFolder {
-	/** @var \Closure */
-	private $rootFolderClosure;
-
-	/** @var IRootFolder */
-	private $rootFolder;
-
-	/**
-	 * LazyRoot constructor.
-	 *
-	 * @param \Closure $rootFolderClosure
-	 */
-	public function __construct(\Closure $rootFolderClosure) {
-		$this->rootFolderClosure = $rootFolderClosure;
-	}
-
-	/**
-	 * Magic method to first get the real rootFolder and then
-	 * call $method with $args on it
-	 *
-	 * @param $method
-	 * @param $args
-	 * @return mixed
-	 */
-	public function __call($method, $args) {
-		if ($this->rootFolder === null) {
-			$this->rootFolder = call_user_func($this->rootFolderClosure);
-		}
-
-		return call_user_func_array([$this->rootFolder, $method], $args);
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getUser() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function listen($scope, $method, callable $callback) {
-		$this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function removeListener($scope = null, $method = null, callable $callback = null) {
-		$this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function emit($scope, $method, $arguments = array()) {
-		$this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function mount($storage, $mountPoint, $arguments = array()) {
-		$this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getMount($mountPoint) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getMountsIn($mountPoint) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getMountByStorageId($storageId) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getMountByNumericStorageId($numericId) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function unMount($mount) {
-		$this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function get($path) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function rename($targetPath) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function delete() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function copy($targetPath) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function touch($mtime = null) {
-		$this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getStorage() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getPath() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getInternalPath() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getId() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function stat() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getMTime() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getSize() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getEtag() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getPermissions() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isReadable() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isUpdateable() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isDeletable() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isShareable() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getParent() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getName() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getUserFolder($userId) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getMimetype() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getMimePart() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isEncrypted() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getType() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isShared() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isMounted() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getMountPoint() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getOwner() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getChecksum() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getFullPath($path) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getRelativePath($path) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isSubNode($node) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getDirectoryListing() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function nodeExists($path) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function newFolder($path) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function newFile($path) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function search($query) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function searchByMime($mimetype) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function searchByTag($tag, $userId) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getById($id) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getFreeSpace() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function isCreatable() {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getNonExistingName($name) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function move($targetPath) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function lock($type) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function changeLock($targetType) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function unlock($type) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getRecent($limit, $offset = 0) {
-		return $this->__call(__FUNCTION__, func_get_args());
-	}
+    /** @var \Closure */
+    private $rootFolderClosure;
+
+    /** @var IRootFolder */
+    private $rootFolder;
+
+    /**
+     * LazyRoot constructor.
+     *
+     * @param \Closure $rootFolderClosure
+     */
+    public function __construct(\Closure $rootFolderClosure) {
+        $this->rootFolderClosure = $rootFolderClosure;
+    }
+
+    /**
+     * Magic method to first get the real rootFolder and then
+     * call $method with $args on it
+     *
+     * @param $method
+     * @param $args
+     * @return mixed
+     */
+    public function __call($method, $args) {
+        if ($this->rootFolder === null) {
+            $this->rootFolder = call_user_func($this->rootFolderClosure);
+        }
+
+        return call_user_func_array([$this->rootFolder, $method], $args);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getUser() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function listen($scope, $method, callable $callback) {
+        $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function removeListener($scope = null, $method = null, callable $callback = null) {
+        $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function emit($scope, $method, $arguments = array()) {
+        $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function mount($storage, $mountPoint, $arguments = array()) {
+        $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMount($mountPoint) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMountsIn($mountPoint) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMountByStorageId($storageId) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMountByNumericStorageId($numericId) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function unMount($mount) {
+        $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function get($path) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function rename($targetPath) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function delete() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function copy($targetPath) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function touch($mtime = null) {
+        $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getStorage() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPath() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getInternalPath() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getId() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function stat() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMTime() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getSize() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getEtag() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPermissions() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isReadable() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isUpdateable() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isDeletable() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isShareable() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getParent() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getName() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getUserFolder($userId) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMimetype() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMimePart() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isEncrypted() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getType() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isShared() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isMounted() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMountPoint() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getOwner() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getChecksum() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getFullPath($path) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getRelativePath($path) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isSubNode($node) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getDirectoryListing() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function nodeExists($path) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function newFolder($path) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function newFile($path) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function search($query) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function searchByMime($mimetype) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function searchByTag($tag, $userId) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getById($id) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getFreeSpace() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function isCreatable() {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getNonExistingName($name) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function move($targetPath) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function lock($type) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function changeLock($targetType) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function unlock($type) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getRecent($limit, $offset = 0) {
+        return $this->__call(__FUNCTION__, func_get_args());
+    }
 }

lib/private/Files/Storage/Flysystem.php

Doc Comments +3 added lines

@@ -54,6 +54,9 @@
 		$this->flysystem->addPlugin(new GetWithMetadata());
 	}
 
+	/**
+	 * @param string $path
+	 */
 	protected function buildPath($path) {
 		$fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
 		return ltrim($fullPath, '/');

Indentation +201 added lines, -201 removed lines

@@ -35,223 +35,223 @@
  * To use: subclass and call $this->buildFlysystem with the flysystem adapter of choice
  */
 abstract class Flysystem extends Common {
-	/**
-	 * @var Filesystem
-	 */
-	protected $flysystem;
+    /**
+     * @var Filesystem
+     */
+    protected $flysystem;
 
-	/**
-	 * @var string
-	 */
-	protected $root = '';
+    /**
+     * @var string
+     */
+    protected $root = '';
 
-	/**
-	 * Initialize the storage backend with a flyssytem adapter
-	 *
-	 * @param \League\Flysystem\AdapterInterface $adapter
-	 */
-	protected function buildFlySystem(AdapterInterface $adapter) {
-		$this->flysystem = new Filesystem($adapter);
-		$this->flysystem->addPlugin(new GetWithMetadata());
-	}
+    /**
+     * Initialize the storage backend with a flyssytem adapter
+     *
+     * @param \League\Flysystem\AdapterInterface $adapter
+     */
+    protected function buildFlySystem(AdapterInterface $adapter) {
+        $this->flysystem = new Filesystem($adapter);
+        $this->flysystem->addPlugin(new GetWithMetadata());
+    }
 
-	protected function buildPath($path) {
-		$fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
-		return ltrim($fullPath, '/');
-	}
+    protected function buildPath($path) {
+        $fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
+        return ltrim($fullPath, '/');
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function file_get_contents($path) {
-		return $this->flysystem->read($this->buildPath($path));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function file_get_contents($path) {
+        return $this->flysystem->read($this->buildPath($path));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function file_put_contents($path, $data) {
-		return $this->flysystem->put($this->buildPath($path), $data);
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function file_put_contents($path, $data) {
+        return $this->flysystem->put($this->buildPath($path), $data);
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function file_exists($path) {
-		return $this->flysystem->has($this->buildPath($path));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function file_exists($path) {
+        return $this->flysystem->has($this->buildPath($path));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function unlink($path) {
-		if ($this->is_dir($path)) {
-			return $this->rmdir($path);
-		}
-		try {
-			return $this->flysystem->delete($this->buildPath($path));
-		} catch (FileNotFoundException $e) {
-			return false;
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function unlink($path) {
+        if ($this->is_dir($path)) {
+            return $this->rmdir($path);
+        }
+        try {
+            return $this->flysystem->delete($this->buildPath($path));
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rename($source, $target) {
-		if ($this->file_exists($target)) {
-			$this->unlink($target);
-		}
-		return $this->flysystem->rename($this->buildPath($source), $this->buildPath($target));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function rename($source, $target) {
+        if ($this->file_exists($target)) {
+            $this->unlink($target);
+        }
+        return $this->flysystem->rename($this->buildPath($source), $this->buildPath($target));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function copy($source, $target) {
-		if ($this->file_exists($target)) {
-			$this->unlink($target);
-		}
-		return $this->flysystem->copy($this->buildPath($source), $this->buildPath($target));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function copy($source, $target) {
+        if ($this->file_exists($target)) {
+            $this->unlink($target);
+        }
+        return $this->flysystem->copy($this->buildPath($source), $this->buildPath($target));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function filesize($path) {
-		if ($this->is_dir($path)) {
-			return 0;
-		} else {
-			return $this->flysystem->getSize($this->buildPath($path));
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function filesize($path) {
+        if ($this->is_dir($path)) {
+            return 0;
+        } else {
+            return $this->flysystem->getSize($this->buildPath($path));
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function mkdir($path) {
-		if ($this->file_exists($path)) {
-			return false;
-		}
-		return $this->flysystem->createDir($this->buildPath($path));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function mkdir($path) {
+        if ($this->file_exists($path)) {
+            return false;
+        }
+        return $this->flysystem->createDir($this->buildPath($path));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function filemtime($path) {
-		return $this->flysystem->getTimestamp($this->buildPath($path));
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function filemtime($path) {
+        return $this->flysystem->getTimestamp($this->buildPath($path));
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rmdir($path) {
-		try {
-			return @$this->flysystem->deleteDir($this->buildPath($path));
-		} catch (FileNotFoundException $e) {
-			return false;
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function rmdir($path) {
+        try {
+            return @$this->flysystem->deleteDir($this->buildPath($path));
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function opendir($path) {
-		try {
-			$content = $this->flysystem->listContents($this->buildPath($path));
-		} catch (FileNotFoundException $e) {
-			return false;
-		}
-		$names = array_map(function ($object) {
-			return $object['basename'];
-		}, $content);
-		return IteratorDirectory::wrap($names);
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function opendir($path) {
+        try {
+            $content = $this->flysystem->listContents($this->buildPath($path));
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+        $names = array_map(function ($object) {
+            return $object['basename'];
+        }, $content);
+        return IteratorDirectory::wrap($names);
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function fopen($path, $mode) {
-		$fullPath = $this->buildPath($path);
-		$useExisting = true;
-		switch ($mode) {
-			case 'r':
-			case 'rb':
-				try {
-					return $this->flysystem->readStream($fullPath);
-				} catch (FileNotFoundException $e) {
-					return false;
-				}
-			case 'w':
-			case 'w+':
-			case 'wb':
-			case 'wb+':
-				$useExisting = false;
-			case 'a':
-			case 'ab':
-			case 'r+':
-			case 'a+':
-			case 'x':
-			case 'x+':
-			case 'c':
-			case 'c+':
-				//emulate these
-				if ($useExisting and $this->file_exists($path)) {
-					if (!$this->isUpdatable($path)) {
-						return false;
-					}
-					$tmpFile = $this->getCachedFile($path);
-				} else {
-					if (!$this->isCreatable(dirname($path))) {
-						return false;
-					}
-					$tmpFile = \OCP\Files::tmpFile();
-				}
-				$source = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath) {
-					$this->flysystem->putStream($fullPath, fopen($tmpFile, 'r'));
-					unlink($tmpFile);
-				});
-		}
-		return false;
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function fopen($path, $mode) {
+        $fullPath = $this->buildPath($path);
+        $useExisting = true;
+        switch ($mode) {
+            case 'r':
+            case 'rb':
+                try {
+                    return $this->flysystem->readStream($fullPath);
+                } catch (FileNotFoundException $e) {
+                    return false;
+                }
+            case 'w':
+            case 'w+':
+            case 'wb':
+            case 'wb+':
+                $useExisting = false;
+            case 'a':
+            case 'ab':
+            case 'r+':
+            case 'a+':
+            case 'x':
+            case 'x+':
+            case 'c':
+            case 'c+':
+                //emulate these
+                if ($useExisting and $this->file_exists($path)) {
+                    if (!$this->isUpdatable($path)) {
+                        return false;
+                    }
+                    $tmpFile = $this->getCachedFile($path);
+                } else {
+                    if (!$this->isCreatable(dirname($path))) {
+                        return false;
+                    }
+                    $tmpFile = \OCP\Files::tmpFile();
+                }
+                $source = fopen($tmpFile, $mode);
+                return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath) {
+                    $this->flysystem->putStream($fullPath, fopen($tmpFile, 'r'));
+                    unlink($tmpFile);
+                });
+        }
+        return false;
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function touch($path, $mtime = null) {
-		if ($this->file_exists($path)) {
-			return false;
-		} else {
-			$this->file_put_contents($path, '');
-			return true;
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function touch($path, $mtime = null) {
+        if ($this->file_exists($path)) {
+            return false;
+        } else {
+            $this->file_put_contents($path, '');
+            return true;
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function stat($path) {
-		$info = $this->flysystem->getWithMetadata($this->buildPath($path), ['timestamp', 'size']);
-		return [
-			'mtime' => $info['timestamp'],
-			'size' => $info['size']
-		];
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function stat($path) {
+        $info = $this->flysystem->getWithMetadata($this->buildPath($path), ['timestamp', 'size']);
+        return [
+            'mtime' => $info['timestamp'],
+            'size' => $info['size']
+        ];
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function filetype($path) {
-		if ($path === '' or $path === '/' or $path === '.') {
-			return 'dir';
-		}
-		try {
-			$info = $this->flysystem->getMetadata($this->buildPath($path));
-		} catch (FileNotFoundException $e) {
-			return false;
-		}
-		return $info['type'];
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function filetype($path) {
+        if ($path === '' or $path === '/' or $path === '.') {
+            return 'dir';
+        }
+        try {
+            $info = $this->flysystem->getMetadata($this->buildPath($path));
+        } catch (FileNotFoundException $e) {
+            return false;
+        }
+        return $info['type'];
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -56,7 +56,7 @@ 
 	}
 
 	protected function buildPath($path) {
-		$fullPath = \OC\Files\Filesystem::normalizePath($this->root . '/' . $path);
+		$fullPath = \OC\Files\Filesystem::normalizePath($this->root.'/'.$path);
 		return ltrim($fullPath, '/');
 	}
 
@@ -163,7 +163,7 @@ 
 		} catch (FileNotFoundException $e) {
 			return false;
 		}
-		$names = array_map(function ($object) {
+		$names = array_map(function($object) {
 			return $object['basename'];
 		}, $content);
 		return IteratorDirectory::wrap($names);
@@ -209,7 +209,7 @@ 
 					$tmpFile = \OCP\Files::tmpFile();
 				}
 				$source = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath) {
+				return CallbackWrapper::wrap($source, null, null, function() use ($tmpFile, $fullPath) {
 					$this->flysystem->putStream($fullPath, fopen($tmpFile, 'r'));
 					unlink($tmpFile);
 				});

lib/private/Files/Storage/Wrapper/Quota.php

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
 	 * Checks whether the given path is a part file
 	 *
 	 * @param string $path Path that may identify a .part file
-	 * @return string File path without .part extension
+	 * @return boolean File path without .part extension
 	 * @note this is needed for reusing keys
 	 */
 	private function isPartFile($path) {

Indentation +168 added lines, -168 removed lines

@@ -30,172 +30,172 @@
 
 class Quota extends Wrapper {
 
-	/**
-	 * @var int $quota
-	 */
-	protected $quota;
-
-	/**
-	 * @var string $sizeRoot
-	 */
-	protected $sizeRoot;
-
-	/**
-	 * @param array $parameters
-	 */
-	public function __construct($parameters) {
-		$this->storage = $parameters['storage'];
-		$this->quota = $parameters['quota'];
-		$this->sizeRoot = isset($parameters['root']) ? $parameters['root'] : '';
-	}
-
-	/**
-	 * @return int quota value
-	 */
-	public function getQuota() {
-		return $this->quota;
-	}
-
-	/**
-	 * @param string $path
-	 * @param \OC\Files\Storage\Storage $storage
-	 */
-	protected function getSize($path, $storage = null) {
-		if (is_null($storage)) {
-			$cache = $this->getCache();
-		} else {
-			$cache = $storage->getCache();
-		}
-		$data = $cache->get($path);
-		if ($data instanceof ICacheEntry and isset($data['size'])) {
-			return $data['size'];
-		} else {
-			return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
-		}
-	}
-
-	/**
-	 * Get free space as limited by the quota
-	 *
-	 * @param string $path
-	 * @return int
-	 */
-	public function free_space($path) {
-		if ($this->quota < 0) {
-			return $this->storage->free_space($path);
-		} else {
-			$used = $this->getSize($this->sizeRoot);
-			if ($used < 0) {
-				return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
-			} else {
-				$free = $this->storage->free_space($path);
-				$quotaFree = max($this->quota - $used, 0);
-				// if free space is known
-				if ($free >= 0) {
-					$free = min($free, $quotaFree);
-				} else {
-					$free = $quotaFree;
-				}
-				return $free;
-			}
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_put_contents.php
-	 *
-	 * @param string $path
-	 * @param string $data
-	 * @return bool
-	 */
-	public function file_put_contents($path, $data) {
-		$free = $this->free_space('');
-		if ($free < 0 or strlen($data) < $free) {
-			return $this->storage->file_put_contents($path, $data);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.copy.php
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return bool
-	 */
-	public function copy($source, $target) {
-		$free = $this->free_space('');
-		if ($free < 0 or $this->getSize($source) < $free) {
-			return $this->storage->copy($source, $target);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource
-	 */
-	public function fopen($path, $mode) {
-		$source = $this->storage->fopen($path, $mode);
-
-		// don't apply quota for part files
-		if (!$this->isPartFile($path)) {
-			$free = $this->free_space('');
-			if ($source && $free >= 0 && $mode !== 'r' && $mode !== 'rb') {
-				// only apply quota for files, not metadata, trash or others
-				if (strpos(ltrim($path, '/'), 'files/') === 0) {
-					return \OC\Files\Stream\Quota::wrap($source, $free);
-				}
-			}
-		}
-		return $source;
-	}
-
-	/**
-	 * Checks whether the given path is a part file
-	 *
-	 * @param string $path Path that may identify a .part file
-	 * @return string File path without .part extension
-	 * @note this is needed for reusing keys
-	 */
-	private function isPartFile($path) {
-		$extension = pathinfo($path, PATHINFO_EXTENSION);
-
-		return ($extension === 'part');
-	}
-
-	/**
-	 * @param \OCP\Files\Storage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function copyFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		$free = $this->free_space('');
-		if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
-			return $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * @param \OCP\Files\Storage $sourceStorage
-	 * @param string $sourceInternalPath
-	 * @param string $targetInternalPath
-	 * @return bool
-	 */
-	public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
-		$free = $this->free_space('');
-		if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
-			return $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
-		} else {
-			return false;
-		}
-	}
+    /**
+     * @var int $quota
+     */
+    protected $quota;
+
+    /**
+     * @var string $sizeRoot
+     */
+    protected $sizeRoot;
+
+    /**
+     * @param array $parameters
+     */
+    public function __construct($parameters) {
+        $this->storage = $parameters['storage'];
+        $this->quota = $parameters['quota'];
+        $this->sizeRoot = isset($parameters['root']) ? $parameters['root'] : '';
+    }
+
+    /**
+     * @return int quota value
+     */
+    public function getQuota() {
+        return $this->quota;
+    }
+
+    /**
+     * @param string $path
+     * @param \OC\Files\Storage\Storage $storage
+     */
+    protected function getSize($path, $storage = null) {
+        if (is_null($storage)) {
+            $cache = $this->getCache();
+        } else {
+            $cache = $storage->getCache();
+        }
+        $data = $cache->get($path);
+        if ($data instanceof ICacheEntry and isset($data['size'])) {
+            return $data['size'];
+        } else {
+            return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
+        }
+    }
+
+    /**
+     * Get free space as limited by the quota
+     *
+     * @param string $path
+     * @return int
+     */
+    public function free_space($path) {
+        if ($this->quota < 0) {
+            return $this->storage->free_space($path);
+        } else {
+            $used = $this->getSize($this->sizeRoot);
+            if ($used < 0) {
+                return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED;
+            } else {
+                $free = $this->storage->free_space($path);
+                $quotaFree = max($this->quota - $used, 0);
+                // if free space is known
+                if ($free >= 0) {
+                    $free = min($free, $quotaFree);
+                } else {
+                    $free = $quotaFree;
+                }
+                return $free;
+            }
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_put_contents.php
+     *
+     * @param string $path
+     * @param string $data
+     * @return bool
+     */
+    public function file_put_contents($path, $data) {
+        $free = $this->free_space('');
+        if ($free < 0 or strlen($data) < $free) {
+            return $this->storage->file_put_contents($path, $data);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.copy.php
+     *
+     * @param string $source
+     * @param string $target
+     * @return bool
+     */
+    public function copy($source, $target) {
+        $free = $this->free_space('');
+        if ($free < 0 or $this->getSize($source) < $free) {
+            return $this->storage->copy($source, $target);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource
+     */
+    public function fopen($path, $mode) {
+        $source = $this->storage->fopen($path, $mode);
+
+        // don't apply quota for part files
+        if (!$this->isPartFile($path)) {
+            $free = $this->free_space('');
+            if ($source && $free >= 0 && $mode !== 'r' && $mode !== 'rb') {
+                // only apply quota for files, not metadata, trash or others
+                if (strpos(ltrim($path, '/'), 'files/') === 0) {
+                    return \OC\Files\Stream\Quota::wrap($source, $free);
+                }
+            }
+        }
+        return $source;
+    }
+
+    /**
+     * Checks whether the given path is a part file
+     *
+     * @param string $path Path that may identify a .part file
+     * @return string File path without .part extension
+     * @note this is needed for reusing keys
+     */
+    private function isPartFile($path) {
+        $extension = pathinfo($path, PATHINFO_EXTENSION);
+
+        return ($extension === 'part');
+    }
+
+    /**
+     * @param \OCP\Files\Storage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function copyFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        $free = $this->free_space('');
+        if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
+            return $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * @param \OCP\Files\Storage $sourceStorage
+     * @param string $sourceInternalPath
+     * @param string $targetInternalPath
+     * @return bool
+     */
+    public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
+        $free = $this->free_space('');
+        if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) {
+            return $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
+        } else {
+            return false;
+        }
+    }
 }

lib/private/legacy/api.php

Doc Comments +1 added lines, -1 removed lines

@@ -331,7 +331,7 @@
 
 	/**
 	 * http basic auth
-	 * @return string|false (username, or false on failure)
+	 * @return string (username, or false on failure)
 	 */
 	private static function loginUser() {
 		if(self::$isLoggedIn === true) {

Spacing +32 added lines, -32 removed lines

@@ -92,7 +92,7 @@ 
 				$requirements = array()) {
 		$name = strtolower($method).$url;
 		$name = str_replace(array('/', '{', '}'), '_', $name);
-		if(!isset(self::$actions[$name])) {
+		if (!isset(self::$actions[$name])) {
 			$oldCollection = OC::$server->getRouter()->getCurrentCollection();
 			OC::$server->getRouter()->useCollection('ocs');
 			OC::$server->getRouter()->create($name, $url)
@@ -115,17 +115,17 @@ 
 		$method = $request->getMethod();
 
 		// Prepare the request variables
-		if($method === 'PUT') {
+		if ($method === 'PUT') {
 			$parameters['_put'] = $request->getParams();
-		} else if($method === 'DELETE') {
+		} else if ($method === 'DELETE') {
 			$parameters['_delete'] = $request->getParams();
 		}
 		$name = $parameters['_route'];
 		// Foreach registered action
 		$responses = array();
-		foreach(self::$actions[$name] as $action) {
+		foreach (self::$actions[$name] as $action) {
 			// Check authentication and availability
-			if(!self::isAuthorised($action)) {
+			if (!self::isAuthorised($action)) {
 				$responses[] = array(
 					'app' => $action['app'],
 					'response' => new OC_OCS_Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'),
@@ -133,7 +133,7 @@ 
 					);
 				continue;
 			}
-			if(!is_callable($action['action'])) {
+			if (!is_callable($action['action'])) {
 				$responses[] = array(
 					'app' => $action['app'],
 					'response' => new OC_OCS_Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'),
@@ -173,15 +173,15 @@ 
 			'failed' => array(),
 			);
 
-		foreach($responses as $response) {
-			if($response['shipped'] || ($response['app'] === 'core')) {
-				if($response['response']->succeeded()) {
+		foreach ($responses as $response) {
+			if ($response['shipped'] || ($response['app'] === 'core')) {
+				if ($response['response']->succeeded()) {
 					$shipped['succeeded'][$response['app']] = $response;
 				} else {
 					$shipped['failed'][$response['app']] = $response;
 				}
 			} else {
-				if($response['response']->succeeded()) {
+				if ($response['response']->succeeded()) {
 					$thirdparty['succeeded'][$response['app']] = $response;
 				} else {
 					$thirdparty['failed'][$response['app']] = $response;
@@ -190,14 +190,14 @@ 
 		}
 
 		// Remove any error responses if there is one shipped response that succeeded
-		if(!empty($shipped['failed'])) {
+		if (!empty($shipped['failed'])) {
 			// Which shipped response do we use if they all failed?
 			// They may have failed for different reasons (different status codes)
 			// Which response code should we return?
 			// Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
 			// Merge failed responses if more than one
 			$data = array();
-			foreach($shipped['failed'] as $failure) {
+			foreach ($shipped['failed'] as $failure) {
 				$data = array_merge_recursive($data, $failure['response']->getData());
 			}
 			$picked = reset($shipped['failed']);
@@ -206,12 +206,12 @@ 
 			$headers = $picked['response']->getHeaders();
 			$response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
 			return $response;
-		} elseif(!empty($shipped['succeeded'])) {
+		} elseif (!empty($shipped['succeeded'])) {
 			$responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
-		} elseif(!empty($thirdparty['failed'])) {
+		} elseif (!empty($thirdparty['failed'])) {
 			// Merge failed responses if more than one
 			$data = array();
-			foreach($thirdparty['failed'] as $failure) {
+			foreach ($thirdparty['failed'] as $failure) {
 				$data = array_merge_recursive($data, $failure['response']->getData());
 			}
 			$picked = reset($thirdparty['failed']);
@@ -228,8 +228,8 @@ 
 		$codes = [];
 		$header = [];
 
-		foreach($responses as $response) {
-			if($response['shipped']) {
+		foreach ($responses as $response) {
+			if ($response['shipped']) {
 				$data = array_merge_recursive($response['response']->getData(), $data);
 			} else {
 				$data = array_merge_recursive($data, $response['response']->getData());
@@ -242,8 +242,8 @@ 
 		// Use any non 100 status codes
 		$statusCode = 100;
 		$statusMessage = null;
-		foreach($codes as $code) {
-			if($code['code'] != 100) {
+		foreach ($codes as $code) {
+			if ($code['code'] != 100) {
 				$statusCode = $code['code'];
 				$statusMessage = $code['meta']['message'];
 				break;
@@ -260,7 +260,7 @@ 
 	 */
 	private static function isAuthorised($action) {
 		$level = $action['authlevel'];
-		switch($level) {
+		switch ($level) {
 			case API::GUEST_AUTH:
 				// Anyone can access
 				return true;
@@ -270,16 +270,16 @@ 
 			case API::SUBADMIN_AUTH:
 				// Check for subadmin
 				$user = self::loginUser();
-				if(!$user) {
+				if (!$user) {
 					return false;
 				} else {
 					$userObject = \OC::$server->getUserSession()->getUser();
-					if($userObject === null) {
+					if ($userObject === null) {
 						return false;
 					}
 					$isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
 					$admin = OC_User::isAdminUser($user);
-					if($isSubAdmin || $admin) {
+					if ($isSubAdmin || $admin) {
 						return true;
 					} else {
 						return false;
@@ -288,7 +288,7 @@ 
 			case API::ADMIN_AUTH:
 				// Check for admin
 				$user = self::loginUser();
-				if(!$user) {
+				if (!$user) {
 					return false;
 				} else {
 					return OC_User::isAdminUser($user);
@@ -304,7 +304,7 @@ 
 	 * @return string|false (username, or false on failure)
 	 */
 	private static function loginUser() {
-		if(self::$isLoggedIn === true) {
+		if (self::$isLoggedIn === true) {
 			return \OC_User::getUser();
 		}
 
@@ -358,13 +358,13 @@ 
 	 * @param OC_OCS_Result $result
 	 * @param string $format the format xml|json
 	 */
-	public static function respond($result, $format='xml') {
+	public static function respond($result, $format = 'xml') {
 		$request = \OC::$server->getRequest();
 
 		// Send 401 headers if unauthorised
-		if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
+		if ($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
 			// If request comes from JS return dummy auth request
-			if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
+			if ($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
 				header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
 			} else {
 				header('WWW-Authenticate: Basic realm="Authorisation Required"');
@@ -372,8 +372,8 @@ 
 			header('HTTP/1.0 401 Unauthorized');
 		}
 
-		foreach($result->getHeaders() as $name => $value) {
-			header($name . ': ' . $value);
+		foreach ($result->getHeaders() as $name => $value) {
+			header($name.': '.$value);
 		}
 
 		$meta = $result->getMeta();
@@ -395,14 +395,14 @@ 
 	 * @param XMLWriter $writer
 	 */
 	private static function toXML($array, $writer) {
-		foreach($array as $k => $v) {
+		foreach ($array as $k => $v) {
 			if ($k[0] === '@') {
 				$writer->writeAttribute(substr($k, 1), $v);
 				continue;
 			} else if (is_numeric($k)) {
 				$k = 'element';
 			}
-			if(is_array($v)) {
+			if (is_array($v)) {
 				$writer->startElement($k);
 				self::toXML($v, $writer);
 				$writer->endElement();

Indentation +458 added lines, -458 removed lines

@@ -37,462 +37,462 @@
 
 class OC_API {
 
-	/**
-	 * API authentication levels
-	 */
-
-	/** @deprecated Use \OCP\API::GUEST_AUTH instead */
-	const GUEST_AUTH = 0;
-
-	/** @deprecated Use \OCP\API::USER_AUTH instead */
-	const USER_AUTH = 1;
-
-	/** @deprecated Use \OCP\API::SUBADMIN_AUTH instead */
-	const SUBADMIN_AUTH = 2;
-
-	/** @deprecated Use \OCP\API::ADMIN_AUTH instead */
-	const ADMIN_AUTH = 3;
-
-	/**
-	 * API Response Codes
-	 */
-
-	/** @deprecated Use \OCP\API::RESPOND_UNAUTHORISED instead */
-	const RESPOND_UNAUTHORISED = 997;
-
-	/** @deprecated Use \OCP\API::RESPOND_SERVER_ERROR instead */
-	const RESPOND_SERVER_ERROR = 996;
-
-	/** @deprecated Use \OCP\API::RESPOND_NOT_FOUND instead */
-	const RESPOND_NOT_FOUND = 998;
-
-	/** @deprecated Use \OCP\API::RESPOND_UNKNOWN_ERROR instead */
-	const RESPOND_UNKNOWN_ERROR = 999;
-
-	/**
-	 * api actions
-	 */
-	protected static $actions = array();
-	private static $logoutRequired = false;
-	private static $isLoggedIn = false;
-
-	/**
-	 * registers an api call
-	 * @param string $method the http method
-	 * @param string $url the url to match
-	 * @param callable $action the function to run
-	 * @param string $app the id of the app registering the call
-	 * @param int $authLevel the level of authentication required for the call
-	 * @param array $defaults
-	 * @param array $requirements
-	 */
-	public static function register($method, $url, $action, $app,
-				$authLevel = API::USER_AUTH,
-				$defaults = array(),
-				$requirements = array()) {
-		$name = strtolower($method).$url;
-		$name = str_replace(array('/', '{', '}'), '_', $name);
-		if(!isset(self::$actions[$name])) {
-			$oldCollection = OC::$server->getRouter()->getCurrentCollection();
-			OC::$server->getRouter()->useCollection('ocs');
-			OC::$server->getRouter()->create($name, $url)
-				->method($method)
-				->defaults($defaults)
-				->requirements($requirements)
-				->action('OC_API', 'call');
-			self::$actions[$name] = array();
-			OC::$server->getRouter()->useCollection($oldCollection);
-		}
-		self::$actions[$name][] = array('app' => $app, 'action' => $action, 'authlevel' => $authLevel);
-	}
-
-	/**
-	 * handles an api call
-	 * @param array $parameters
-	 */
-	public static function call($parameters) {
-		$request = \OC::$server->getRequest();
-		$method = $request->getMethod();
-
-		// Prepare the request variables
-		if($method === 'PUT') {
-			$parameters['_put'] = $request->getParams();
-		} else if($method === 'DELETE') {
-			$parameters['_delete'] = $request->getParams();
-		}
-		$name = $parameters['_route'];
-		// Foreach registered action
-		$responses = array();
-		foreach(self::$actions[$name] as $action) {
-			// Check authentication and availability
-			if(!self::isAuthorised($action)) {
-				$responses[] = array(
-					'app' => $action['app'],
-					'response' => new OC_OCS_Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'),
-					'shipped' => OC_App::isShipped($action['app']),
-					);
-				continue;
-			}
-			if(!is_callable($action['action'])) {
-				$responses[] = array(
-					'app' => $action['app'],
-					'response' => new OC_OCS_Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'),
-					'shipped' => OC_App::isShipped($action['app']),
-					);
-				continue;
-			}
-			// Run the action
-			$responses[] = array(
-				'app' => $action['app'],
-				'response' => call_user_func($action['action'], $parameters),
-				'shipped' => OC_App::isShipped($action['app']),
-				);
-		}
-		$response = self::mergeResponses($responses);
-		$format = self::requestedFormat();
-		if (self::$logoutRequired) {
-			\OC::$server->getUserSession()->logout();
-		}
-
-		self::respond($response, $format);
-	}
-
-	/**
-	 * merge the returned result objects into one response
-	 * @param array $responses
-	 * @return OC_OCS_Result
-	 */
-	public static function mergeResponses($responses) {
-		// Sort into shipped and third-party
-		$shipped = array(
-			'succeeded' => array(),
-			'failed' => array(),
-			);
-		$thirdparty = array(
-			'succeeded' => array(),
-			'failed' => array(),
-			);
-
-		foreach($responses as $response) {
-			if($response['shipped'] || ($response['app'] === 'core')) {
-				if($response['response']->succeeded()) {
-					$shipped['succeeded'][$response['app']] = $response;
-				} else {
-					$shipped['failed'][$response['app']] = $response;
-				}
-			} else {
-				if($response['response']->succeeded()) {
-					$thirdparty['succeeded'][$response['app']] = $response;
-				} else {
-					$thirdparty['failed'][$response['app']] = $response;
-				}
-			}
-		}
-
-		// Remove any error responses if there is one shipped response that succeeded
-		if(!empty($shipped['failed'])) {
-			// Which shipped response do we use if they all failed?
-			// They may have failed for different reasons (different status codes)
-			// Which response code should we return?
-			// Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
-			// Merge failed responses if more than one
-			$data = array();
-			foreach($shipped['failed'] as $failure) {
-				$data = array_merge_recursive($data, $failure['response']->getData());
-			}
-			$picked = reset($shipped['failed']);
-			$code = $picked['response']->getStatusCode();
-			$meta = $picked['response']->getMeta();
-			$headers = $picked['response']->getHeaders();
-			$response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
-			return $response;
-		} elseif(!empty($shipped['succeeded'])) {
-			$responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
-		} elseif(!empty($thirdparty['failed'])) {
-			// Merge failed responses if more than one
-			$data = array();
-			foreach($thirdparty['failed'] as $failure) {
-				$data = array_merge_recursive($data, $failure['response']->getData());
-			}
-			$picked = reset($thirdparty['failed']);
-			$code = $picked['response']->getStatusCode();
-			$meta = $picked['response']->getMeta();
-			$headers = $picked['response']->getHeaders();
-			$response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
-			return $response;
-		} else {
-			$responses = $thirdparty['succeeded'];
-		}
-		// Merge the successful responses
-		$data = [];
-		$codes = [];
-		$header = [];
-
-		foreach($responses as $response) {
-			if($response['shipped']) {
-				$data = array_merge_recursive($response['response']->getData(), $data);
-			} else {
-				$data = array_merge_recursive($data, $response['response']->getData());
-			}
-			$header = array_merge_recursive($header, $response['response']->getHeaders());
-			$codes[] = ['code' => $response['response']->getStatusCode(),
-				'meta' => $response['response']->getMeta()];
-		}
-
-		// Use any non 100 status codes
-		$statusCode = 100;
-		$statusMessage = null;
-		foreach($codes as $code) {
-			if($code['code'] != 100) {
-				$statusCode = $code['code'];
-				$statusMessage = $code['meta']['message'];
-				break;
-			}
-		}
-
-		return new OC_OCS_Result($data, $statusCode, $statusMessage, $header);
-	}
-
-	/**
-	 * authenticate the api call
-	 * @param array $action the action details as supplied to OC_API::register()
-	 * @return bool
-	 */
-	private static function isAuthorised($action) {
-		$level = $action['authlevel'];
-		switch($level) {
-			case API::GUEST_AUTH:
-				// Anyone can access
-				return true;
-			case API::USER_AUTH:
-				// User required
-				return self::loginUser();
-			case API::SUBADMIN_AUTH:
-				// Check for subadmin
-				$user = self::loginUser();
-				if(!$user) {
-					return false;
-				} else {
-					$userObject = \OC::$server->getUserSession()->getUser();
-					if($userObject === null) {
-						return false;
-					}
-					$isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
-					$admin = OC_User::isAdminUser($user);
-					if($isSubAdmin || $admin) {
-						return true;
-					} else {
-						return false;
-					}
-				}
-			case API::ADMIN_AUTH:
-				// Check for admin
-				$user = self::loginUser();
-				if(!$user) {
-					return false;
-				} else {
-					return OC_User::isAdminUser($user);
-				}
-			default:
-				// oops looks like invalid level supplied
-				return false;
-		}
-	}
-
-	/**
-	 * http basic auth
-	 * @return string|false (username, or false on failure)
-	 */
-	private static function loginUser() {
-		if(self::$isLoggedIn === true) {
-			return \OC_User::getUser();
-		}
-
-		// reuse existing login
-		$loggedIn = \OC::$server->getUserSession()->isLoggedIn();
-		if ($loggedIn === true) {
-			if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
-				// Do not allow access to OCS until the 2FA challenge was solved successfully
-				return false;
-			}
-			$ocsApiRequest = isset($_SERVER['HTTP_OCS_APIREQUEST']) ? $_SERVER['HTTP_OCS_APIREQUEST'] === 'true' : false;
-			if ($ocsApiRequest) {
-
-				// initialize the user's filesystem
-				\OC_Util::setupFS(\OC_User::getUser());
-				self::$isLoggedIn = true;
-
-				return OC_User::getUser();
-			}
-			return false;
-		}
-
-		// basic auth - because OC_User::login will create a new session we shall only try to login
-		// if user and pass are set
-		$userSession = \OC::$server->getUserSession();
-		$request = \OC::$server->getRequest();
-		try {
-			if ($userSession->tryTokenLogin($request)
-				|| $userSession->tryBasicAuthLogin($request, \OC::$server->getBruteForceThrottler())) {
-				self::$logoutRequired = true;
-			} else {
-				return false;
-			}
-			// initialize the user's filesystem
-			\OC_Util::setupFS(\OC_User::getUser());
-			self::$isLoggedIn = true;
-
-			return \OC_User::getUser();
-		} catch (\OC\User\LoginException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * respond to a call
-	 * @param OC_OCS_Result $result
-	 * @param string $format the format xml|json
-	 */
-	public static function respond($result, $format='xml') {
-		$request = \OC::$server->getRequest();
-
-		// Send 401 headers if unauthorised
-		if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
-			// If request comes from JS return dummy auth request
-			if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
-				header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
-			} else {
-				header('WWW-Authenticate: Basic realm="Authorisation Required"');
-			}
-			header('HTTP/1.0 401 Unauthorized');
-		}
-
-		foreach($result->getHeaders() as $name => $value) {
-			header($name . ': ' . $value);
-		}
-
-		$meta = $result->getMeta();
-		$data = $result->getData();
-		if (self::isV2($request)) {
-			$statusCode = self::mapStatusCodes($result->getStatusCode());
-			if (!is_null($statusCode)) {
-				$meta['statuscode'] = $statusCode;
-				OC_Response::setStatus($statusCode);
-			}
-		}
-
-		self::setContentType($format);
-		$body = self::renderResult($format, $meta, $data);
-		echo $body;
-	}
-
-	/**
-	 * @param XMLWriter $writer
-	 */
-	private static function toXML($array, $writer) {
-		foreach($array as $k => $v) {
-			if ($k[0] === '@') {
-				$writer->writeAttribute(substr($k, 1), $v);
-				continue;
-			} else if (is_numeric($k)) {
-				$k = 'element';
-			}
-			if(is_array($v)) {
-				$writer->startElement($k);
-				self::toXML($v, $writer);
-				$writer->endElement();
-			} else {
-				$writer->writeElement($k, $v);
-			}
-		}
-	}
-
-	/**
-	 * @return string
-	 */
-	public static function requestedFormat() {
-		$formats = array('json', 'xml');
-
-		$format = !empty($_GET['format']) && in_array($_GET['format'], $formats) ? $_GET['format'] : 'xml';
-		return $format;
-	}
-
-	/**
-	 * Based on the requested format the response content type is set
-	 * @param string $format
-	 */
-	public static function setContentType($format = null) {
-		$format = is_null($format) ? self::requestedFormat() : $format;
-		if ($format === 'xml') {
-			header('Content-type: text/xml; charset=UTF-8');
-			return;
-		}
-
-		if ($format === 'json') {
-			header('Content-Type: application/json; charset=utf-8');
-			return;
-		}
-
-		header('Content-Type: application/octet-stream; charset=utf-8');
-	}
-
-	/**
-	 * @param \OCP\IRequest $request
-	 * @return bool
-	 */
-	protected static function isV2(\OCP\IRequest $request) {
-		$script = $request->getScriptName();
-
-		return substr($script, -11) === '/ocs/v2.php';
-	}
-
-	/**
-	 * @param integer $sc
-	 * @return int
-	 */
-	public static function mapStatusCodes($sc) {
-		switch ($sc) {
-			case API::RESPOND_NOT_FOUND:
-				return Http::STATUS_NOT_FOUND;
-			case API::RESPOND_SERVER_ERROR:
-				return Http::STATUS_INTERNAL_SERVER_ERROR;
-			case API::RESPOND_UNKNOWN_ERROR:
-				return Http::STATUS_INTERNAL_SERVER_ERROR;
-			case API::RESPOND_UNAUTHORISED:
-				// already handled for v1
-				return null;
-			case 100:
-				return Http::STATUS_OK;
-		}
-		// any 2xx, 4xx and 5xx will be used as is
-		if ($sc >= 200 && $sc < 600) {
-			return $sc;
-		}
-
-		return Http::STATUS_BAD_REQUEST;
-	}
-
-	/**
-	 * @param string $format
-	 * @return string
-	 */
-	public static function renderResult($format, $meta, $data) {
-		$response = array(
-			'ocs' => array(
-				'meta' => $meta,
-				'data' => $data,
-			),
-		);
-		if ($format == 'json') {
-			return OC_JSON::encode($response);
-		}
-
-		$writer = new XMLWriter();
-		$writer->openMemory();
-		$writer->setIndent(true);
-		$writer->startDocument();
-		self::toXML($response, $writer);
-		$writer->endDocument();
-		return $writer->outputMemory(true);
-	}
+    /**
+     * API authentication levels
+     */
+
+    /** @deprecated Use \OCP\API::GUEST_AUTH instead */
+    const GUEST_AUTH = 0;
+
+    /** @deprecated Use \OCP\API::USER_AUTH instead */
+    const USER_AUTH = 1;
+
+    /** @deprecated Use \OCP\API::SUBADMIN_AUTH instead */
+    const SUBADMIN_AUTH = 2;
+
+    /** @deprecated Use \OCP\API::ADMIN_AUTH instead */
+    const ADMIN_AUTH = 3;
+
+    /**
+     * API Response Codes
+     */
+
+    /** @deprecated Use \OCP\API::RESPOND_UNAUTHORISED instead */
+    const RESPOND_UNAUTHORISED = 997;
+
+    /** @deprecated Use \OCP\API::RESPOND_SERVER_ERROR instead */
+    const RESPOND_SERVER_ERROR = 996;
+
+    /** @deprecated Use \OCP\API::RESPOND_NOT_FOUND instead */
+    const RESPOND_NOT_FOUND = 998;
+
+    /** @deprecated Use \OCP\API::RESPOND_UNKNOWN_ERROR instead */
+    const RESPOND_UNKNOWN_ERROR = 999;
+
+    /**
+     * api actions
+     */
+    protected static $actions = array();
+    private static $logoutRequired = false;
+    private static $isLoggedIn = false;
+
+    /**
+     * registers an api call
+     * @param string $method the http method
+     * @param string $url the url to match
+     * @param callable $action the function to run
+     * @param string $app the id of the app registering the call
+     * @param int $authLevel the level of authentication required for the call
+     * @param array $defaults
+     * @param array $requirements
+     */
+    public static function register($method, $url, $action, $app,
+                $authLevel = API::USER_AUTH,
+                $defaults = array(),
+                $requirements = array()) {
+        $name = strtolower($method).$url;
+        $name = str_replace(array('/', '{', '}'), '_', $name);
+        if(!isset(self::$actions[$name])) {
+            $oldCollection = OC::$server->getRouter()->getCurrentCollection();
+            OC::$server->getRouter()->useCollection('ocs');
+            OC::$server->getRouter()->create($name, $url)
+                ->method($method)
+                ->defaults($defaults)
+                ->requirements($requirements)
+                ->action('OC_API', 'call');
+            self::$actions[$name] = array();
+            OC::$server->getRouter()->useCollection($oldCollection);
+        }
+        self::$actions[$name][] = array('app' => $app, 'action' => $action, 'authlevel' => $authLevel);
+    }
+
+    /**
+     * handles an api call
+     * @param array $parameters
+     */
+    public static function call($parameters) {
+        $request = \OC::$server->getRequest();
+        $method = $request->getMethod();
+
+        // Prepare the request variables
+        if($method === 'PUT') {
+            $parameters['_put'] = $request->getParams();
+        } else if($method === 'DELETE') {
+            $parameters['_delete'] = $request->getParams();
+        }
+        $name = $parameters['_route'];
+        // Foreach registered action
+        $responses = array();
+        foreach(self::$actions[$name] as $action) {
+            // Check authentication and availability
+            if(!self::isAuthorised($action)) {
+                $responses[] = array(
+                    'app' => $action['app'],
+                    'response' => new OC_OCS_Result(null, API::RESPOND_UNAUTHORISED, 'Unauthorised'),
+                    'shipped' => OC_App::isShipped($action['app']),
+                    );
+                continue;
+            }
+            if(!is_callable($action['action'])) {
+                $responses[] = array(
+                    'app' => $action['app'],
+                    'response' => new OC_OCS_Result(null, API::RESPOND_NOT_FOUND, 'Api method not found'),
+                    'shipped' => OC_App::isShipped($action['app']),
+                    );
+                continue;
+            }
+            // Run the action
+            $responses[] = array(
+                'app' => $action['app'],
+                'response' => call_user_func($action['action'], $parameters),
+                'shipped' => OC_App::isShipped($action['app']),
+                );
+        }
+        $response = self::mergeResponses($responses);
+        $format = self::requestedFormat();
+        if (self::$logoutRequired) {
+            \OC::$server->getUserSession()->logout();
+        }
+
+        self::respond($response, $format);
+    }
+
+    /**
+     * merge the returned result objects into one response
+     * @param array $responses
+     * @return OC_OCS_Result
+     */
+    public static function mergeResponses($responses) {
+        // Sort into shipped and third-party
+        $shipped = array(
+            'succeeded' => array(),
+            'failed' => array(),
+            );
+        $thirdparty = array(
+            'succeeded' => array(),
+            'failed' => array(),
+            );
+
+        foreach($responses as $response) {
+            if($response['shipped'] || ($response['app'] === 'core')) {
+                if($response['response']->succeeded()) {
+                    $shipped['succeeded'][$response['app']] = $response;
+                } else {
+                    $shipped['failed'][$response['app']] = $response;
+                }
+            } else {
+                if($response['response']->succeeded()) {
+                    $thirdparty['succeeded'][$response['app']] = $response;
+                } else {
+                    $thirdparty['failed'][$response['app']] = $response;
+                }
+            }
+        }
+
+        // Remove any error responses if there is one shipped response that succeeded
+        if(!empty($shipped['failed'])) {
+            // Which shipped response do we use if they all failed?
+            // They may have failed for different reasons (different status codes)
+            // Which response code should we return?
+            // Maybe any that are not \OCP\API::RESPOND_SERVER_ERROR
+            // Merge failed responses if more than one
+            $data = array();
+            foreach($shipped['failed'] as $failure) {
+                $data = array_merge_recursive($data, $failure['response']->getData());
+            }
+            $picked = reset($shipped['failed']);
+            $code = $picked['response']->getStatusCode();
+            $meta = $picked['response']->getMeta();
+            $headers = $picked['response']->getHeaders();
+            $response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
+            return $response;
+        } elseif(!empty($shipped['succeeded'])) {
+            $responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']);
+        } elseif(!empty($thirdparty['failed'])) {
+            // Merge failed responses if more than one
+            $data = array();
+            foreach($thirdparty['failed'] as $failure) {
+                $data = array_merge_recursive($data, $failure['response']->getData());
+            }
+            $picked = reset($thirdparty['failed']);
+            $code = $picked['response']->getStatusCode();
+            $meta = $picked['response']->getMeta();
+            $headers = $picked['response']->getHeaders();
+            $response = new OC_OCS_Result($data, $code, $meta['message'], $headers);
+            return $response;
+        } else {
+            $responses = $thirdparty['succeeded'];
+        }
+        // Merge the successful responses
+        $data = [];
+        $codes = [];
+        $header = [];
+
+        foreach($responses as $response) {
+            if($response['shipped']) {
+                $data = array_merge_recursive($response['response']->getData(), $data);
+            } else {
+                $data = array_merge_recursive($data, $response['response']->getData());
+            }
+            $header = array_merge_recursive($header, $response['response']->getHeaders());
+            $codes[] = ['code' => $response['response']->getStatusCode(),
+                'meta' => $response['response']->getMeta()];
+        }
+
+        // Use any non 100 status codes
+        $statusCode = 100;
+        $statusMessage = null;
+        foreach($codes as $code) {
+            if($code['code'] != 100) {
+                $statusCode = $code['code'];
+                $statusMessage = $code['meta']['message'];
+                break;
+            }
+        }
+
+        return new OC_OCS_Result($data, $statusCode, $statusMessage, $header);
+    }
+
+    /**
+     * authenticate the api call
+     * @param array $action the action details as supplied to OC_API::register()
+     * @return bool
+     */
+    private static function isAuthorised($action) {
+        $level = $action['authlevel'];
+        switch($level) {
+            case API::GUEST_AUTH:
+                // Anyone can access
+                return true;
+            case API::USER_AUTH:
+                // User required
+                return self::loginUser();
+            case API::SUBADMIN_AUTH:
+                // Check for subadmin
+                $user = self::loginUser();
+                if(!$user) {
+                    return false;
+                } else {
+                    $userObject = \OC::$server->getUserSession()->getUser();
+                    if($userObject === null) {
+                        return false;
+                    }
+                    $isSubAdmin = \OC::$server->getGroupManager()->getSubAdmin()->isSubAdmin($userObject);
+                    $admin = OC_User::isAdminUser($user);
+                    if($isSubAdmin || $admin) {
+                        return true;
+                    } else {
+                        return false;
+                    }
+                }
+            case API::ADMIN_AUTH:
+                // Check for admin
+                $user = self::loginUser();
+                if(!$user) {
+                    return false;
+                } else {
+                    return OC_User::isAdminUser($user);
+                }
+            default:
+                // oops looks like invalid level supplied
+                return false;
+        }
+    }
+
+    /**
+     * http basic auth
+     * @return string|false (username, or false on failure)
+     */
+    private static function loginUser() {
+        if(self::$isLoggedIn === true) {
+            return \OC_User::getUser();
+        }
+
+        // reuse existing login
+        $loggedIn = \OC::$server->getUserSession()->isLoggedIn();
+        if ($loggedIn === true) {
+            if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) {
+                // Do not allow access to OCS until the 2FA challenge was solved successfully
+                return false;
+            }
+            $ocsApiRequest = isset($_SERVER['HTTP_OCS_APIREQUEST']) ? $_SERVER['HTTP_OCS_APIREQUEST'] === 'true' : false;
+            if ($ocsApiRequest) {
+
+                // initialize the user's filesystem
+                \OC_Util::setupFS(\OC_User::getUser());
+                self::$isLoggedIn = true;
+
+                return OC_User::getUser();
+            }
+            return false;
+        }
+
+        // basic auth - because OC_User::login will create a new session we shall only try to login
+        // if user and pass are set
+        $userSession = \OC::$server->getUserSession();
+        $request = \OC::$server->getRequest();
+        try {
+            if ($userSession->tryTokenLogin($request)
+                || $userSession->tryBasicAuthLogin($request, \OC::$server->getBruteForceThrottler())) {
+                self::$logoutRequired = true;
+            } else {
+                return false;
+            }
+            // initialize the user's filesystem
+            \OC_Util::setupFS(\OC_User::getUser());
+            self::$isLoggedIn = true;
+
+            return \OC_User::getUser();
+        } catch (\OC\User\LoginException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * respond to a call
+     * @param OC_OCS_Result $result
+     * @param string $format the format xml|json
+     */
+    public static function respond($result, $format='xml') {
+        $request = \OC::$server->getRequest();
+
+        // Send 401 headers if unauthorised
+        if($result->getStatusCode() === API::RESPOND_UNAUTHORISED) {
+            // If request comes from JS return dummy auth request
+            if($request->getHeader('X-Requested-With') === 'XMLHttpRequest') {
+                header('WWW-Authenticate: DummyBasic realm="Authorisation Required"');
+            } else {
+                header('WWW-Authenticate: Basic realm="Authorisation Required"');
+            }
+            header('HTTP/1.0 401 Unauthorized');
+        }
+
+        foreach($result->getHeaders() as $name => $value) {
+            header($name . ': ' . $value);
+        }
+
+        $meta = $result->getMeta();
+        $data = $result->getData();
+        if (self::isV2($request)) {
+            $statusCode = self::mapStatusCodes($result->getStatusCode());
+            if (!is_null($statusCode)) {
+                $meta['statuscode'] = $statusCode;
+                OC_Response::setStatus($statusCode);
+            }
+        }
+
+        self::setContentType($format);
+        $body = self::renderResult($format, $meta, $data);
+        echo $body;
+    }
+
+    /**
+     * @param XMLWriter $writer
+     */
+    private static function toXML($array, $writer) {
+        foreach($array as $k => $v) {
+            if ($k[0] === '@') {
+                $writer->writeAttribute(substr($k, 1), $v);
+                continue;
+            } else if (is_numeric($k)) {
+                $k = 'element';
+            }
+            if(is_array($v)) {
+                $writer->startElement($k);
+                self::toXML($v, $writer);
+                $writer->endElement();
+            } else {
+                $writer->writeElement($k, $v);
+            }
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public static function requestedFormat() {
+        $formats = array('json', 'xml');
+
+        $format = !empty($_GET['format']) && in_array($_GET['format'], $formats) ? $_GET['format'] : 'xml';
+        return $format;
+    }
+
+    /**
+     * Based on the requested format the response content type is set
+     * @param string $format
+     */
+    public static function setContentType($format = null) {
+        $format = is_null($format) ? self::requestedFormat() : $format;
+        if ($format === 'xml') {
+            header('Content-type: text/xml; charset=UTF-8');
+            return;
+        }
+
+        if ($format === 'json') {
+            header('Content-Type: application/json; charset=utf-8');
+            return;
+        }
+
+        header('Content-Type: application/octet-stream; charset=utf-8');
+    }
+
+    /**
+     * @param \OCP\IRequest $request
+     * @return bool
+     */
+    protected static function isV2(\OCP\IRequest $request) {
+        $script = $request->getScriptName();
+
+        return substr($script, -11) === '/ocs/v2.php';
+    }
+
+    /**
+     * @param integer $sc
+     * @return int
+     */
+    public static function mapStatusCodes($sc) {
+        switch ($sc) {
+            case API::RESPOND_NOT_FOUND:
+                return Http::STATUS_NOT_FOUND;
+            case API::RESPOND_SERVER_ERROR:
+                return Http::STATUS_INTERNAL_SERVER_ERROR;
+            case API::RESPOND_UNKNOWN_ERROR:
+                return Http::STATUS_INTERNAL_SERVER_ERROR;
+            case API::RESPOND_UNAUTHORISED:
+                // already handled for v1
+                return null;
+            case 100:
+                return Http::STATUS_OK;
+        }
+        // any 2xx, 4xx and 5xx will be used as is
+        if ($sc >= 200 && $sc < 600) {
+            return $sc;
+        }
+
+        return Http::STATUS_BAD_REQUEST;
+    }
+
+    /**
+     * @param string $format
+     * @return string
+     */
+    public static function renderResult($format, $meta, $data) {
+        $response = array(
+            'ocs' => array(
+                'meta' => $meta,
+                'data' => $data,
+            ),
+        );
+        if ($format == 'json') {
+            return OC_JSON::encode($response);
+        }
+
+        $writer = new XMLWriter();
+        $writer->openMemory();
+        $writer->setIndent(true);
+        $writer->startDocument();
+        self::toXML($response, $writer);
+        $writer->endDocument();
+        return $writer->outputMemory(true);
+    }
 }

lib/private/legacy/eventsource.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 	 * send a message to the client
 	 *
 	 * @param string $type
-	 * @param mixed $data
+	 * @param string $data
 	 *
 	 * @throws \BadMethodCallException
 	 * if only one parameter is given, a typeless message will be send with that parameter as data

Indentation +88 added lines, -88 removed lines

@@ -33,98 +33,98 @@
  * use server side events with caution, to many open requests can hang the server
  */
 class OC_EventSource implements \OCP\IEventSource {
-	/**
-	 * @var bool
-	 */
-	private $fallback;
+    /**
+     * @var bool
+     */
+    private $fallback;
 
-	/**
-	 * @var int
-	 */
-	private $fallBackId = 0;
+    /**
+     * @var int
+     */
+    private $fallBackId = 0;
 
-	/**
-	 * @var bool
-	 */
-	private $started = false;
+    /**
+     * @var bool
+     */
+    private $started = false;
 
-	protected function init() {
-		if ($this->started) {
-			return;
-		}
-		$this->started = true;
+    protected function init() {
+        if ($this->started) {
+            return;
+        }
+        $this->started = true;
 
-		// prevent php output buffering, caching and nginx buffering
-		OC_Util::obEnd();
-		header('Cache-Control: no-cache');
-		header('X-Accel-Buffering: no');
-		$this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
-		if ($this->fallback) {
-			$this->fallBackId = (int)$_GET['fallback_id'];
-			/**
-			 * FIXME: The default content-security-policy of ownCloud forbids inline
-			 * JavaScript for security reasons. IE starting on Windows 10 will
-			 * however also obey the CSP which will break the event source fallback.
-			 *
-			 * As a workaround thus we set a custom policy which allows the execution
-			 * of inline JavaScript.
-			 *
-			 * @link https://github.com/owncloud/core/issues/14286
-			 */
-			header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
-			header("Content-Type: text/html");
-			echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
-		} else {
-			header("Content-Type: text/event-stream");
-		}
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
-			header('Location: '.\OC::$WEBROOT);
-			exit();
-		}
-		if (!(\OC::$server->getRequest()->passesCSRFCheck())) {
-			$this->send('error', 'Possible CSRF attack. Connection will be closed.');
-			$this->close();
-			exit();
-		}
-		flush();
-	}
+        // prevent php output buffering, caching and nginx buffering
+        OC_Util::obEnd();
+        header('Cache-Control: no-cache');
+        header('X-Accel-Buffering: no');
+        $this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
+        if ($this->fallback) {
+            $this->fallBackId = (int)$_GET['fallback_id'];
+            /**
+             * FIXME: The default content-security-policy of ownCloud forbids inline
+             * JavaScript for security reasons. IE starting on Windows 10 will
+             * however also obey the CSP which will break the event source fallback.
+             *
+             * As a workaround thus we set a custom policy which allows the execution
+             * of inline JavaScript.
+             *
+             * @link https://github.com/owncloud/core/issues/14286
+             */
+            header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
+            header("Content-Type: text/html");
+            echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
+        } else {
+            header("Content-Type: text/event-stream");
+        }
+        if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+            header('Location: '.\OC::$WEBROOT);
+            exit();
+        }
+        if (!(\OC::$server->getRequest()->passesCSRFCheck())) {
+            $this->send('error', 'Possible CSRF attack. Connection will be closed.');
+            $this->close();
+            exit();
+        }
+        flush();
+    }
 
-	/**
-	 * send a message to the client
-	 *
-	 * @param string $type
-	 * @param mixed $data
-	 *
-	 * @throws \BadMethodCallException
-	 * if only one parameter is given, a typeless message will be send with that parameter as data
-	 */
-	public function send($type, $data = null) {
-		if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
-			throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
-		}
-		$this->init();
-		if (is_null($data)) {
-			$data = $type;
-			$type = null;
-		}
-		if ($this->fallback) {
-			$response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
-				. $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
-			echo $response;
-		} else {
-			if ($type) {
-				echo 'event: ' . $type . PHP_EOL;
-			}
-			echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
-		}
-		echo PHP_EOL;
-		flush();
-	}
+    /**
+     * send a message to the client
+     *
+     * @param string $type
+     * @param mixed $data
+     *
+     * @throws \BadMethodCallException
+     * if only one parameter is given, a typeless message will be send with that parameter as data
+     */
+    public function send($type, $data = null) {
+        if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
+            throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
+        }
+        $this->init();
+        if (is_null($data)) {
+            $data = $type;
+            $type = null;
+        }
+        if ($this->fallback) {
+            $response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
+                . $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
+            echo $response;
+        } else {
+            if ($type) {
+                echo 'event: ' . $type . PHP_EOL;
+            }
+            echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
+        }
+        echo PHP_EOL;
+        flush();
+    }
 
-	/**
-	 * close the connection of the event source
-	 */
-	public function close() {
-		$this->send('__internal__', 'close'); //server side closing can be an issue, let the client do it
-	}
+    /**
+     * close the connection of the event source
+     */
+    public function close() {
+        $this->send('__internal__', 'close'); //server side closing can be an issue, let the client do it
+    }
 }

Spacing +7 added lines, -7 removed lines

@@ -60,7 +60,7 @@ 
 		header('X-Accel-Buffering: no');
 		$this->fallback = isset($_GET['fallback']) and $_GET['fallback'] == 'true';
 		if ($this->fallback) {
-			$this->fallBackId = (int)$_GET['fallback_id'];
+			$this->fallBackId = (int) $_GET['fallback_id'];
 			/**
 			 * FIXME: The default content-security-policy of ownCloud forbids inline
 			 * JavaScript for security reasons. IE starting on Windows 10 will
@@ -73,11 +73,11 @@ 
 			 */
 			header("Content-Security-Policy: default-src 'none'; script-src 'unsafe-inline'");
 			header("Content-Type: text/html");
-			echo str_repeat('<span></span>' . PHP_EOL, 10); //dummy data to keep IE happy
+			echo str_repeat('<span></span>'.PHP_EOL, 10); //dummy data to keep IE happy
 		} else {
 			header("Content-Type: text/event-stream");
 		}
-		if(!\OC::$server->getRequest()->passesStrictCookieCheck()) {
+		if (!\OC::$server->getRequest()->passesStrictCookieCheck()) {
 			header('Location: '.\OC::$WEBROOT);
 			exit();
 		}
@@ -100,7 +100,7 @@ 
 	 */
 	public function send($type, $data = null) {
 		if ($data and !preg_match('/^[A-Za-z0-9_]+$/', $type)) {
-			throw new BadMethodCallException('Type needs to be alphanumeric ('. $type .')');
+			throw new BadMethodCallException('Type needs to be alphanumeric ('.$type.')');
 		}
 		$this->init();
 		if (is_null($data)) {
@@ -109,13 +109,13 @@ 
 		}
 		if ($this->fallback) {
 			$response = '<script type="text/javascript">window.parent.OC.EventSource.fallBackCallBack('
-				. $this->fallBackId . ',"' . $type . '",' . OCP\JSON::encode($data) . ')</script>' . PHP_EOL;
+				. $this->fallBackId.',"'.$type.'",'.OCP\JSON::encode($data).')</script>'.PHP_EOL;
 			echo $response;
 		} else {
 			if ($type) {
-				echo 'event: ' . $type . PHP_EOL;
+				echo 'event: '.$type.PHP_EOL;
 			}
-			echo 'data: ' . OCP\JSON::encode($data) . PHP_EOL;
+			echo 'data: '.OCP\JSON::encode($data).PHP_EOL;
 		}
 		echo PHP_EOL;
 		flush();

lib/private/legacy/helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -560,7 +560,7 @@
 	 *
 	 * @param string $path
 	 * @param \OCP\Files\FileInfo $rootInfo (optional)
-	 * @return array
+	 * @return string
 	 * @throws \OCP\Files\NotFoundException
 	 */
 	public static function getStorageInfo($path, $rootInfo = null) {

Spacing +17 added lines, -17 removed lines

@@ -64,7 +64,7 @@ 
 		} else {
 			$url = OC::$server->getURLGenerator()->getAbsoluteURL(OC::$server->getURLGenerator()->linkTo('', 'public.php').'?service='.$service);
 		}
-		return $url . (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
+		return $url.(($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
 	}
 
 	/**
@@ -114,18 +114,18 @@ 
 			return "?";
 		}
 		if ($bytes < 1024) {
-			return $bytes . "B";
+			return $bytes."B";
 		}
 		$bytes = round($bytes / 1024, 1);
 		if ($bytes < 1024) {
-			return $bytes . "K";
+			return $bytes."K";
 		}
 		$bytes = round($bytes / 1024, 1);
 		if ($bytes < 1024) {
-			return $bytes . "M";
+			return $bytes."M";
 		}
 		$bytes = round($bytes / 1024, 1);
-		return $bytes . "G";
+		return $bytes."G";
 	}
 
 	/**
@@ -271,7 +271,7 @@ 
 		}
 		foreach ($dirs as $dir) {
 			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext))
+				if ($check_fn("$dir/$name".$ext))
 					return true;
 			}
 		}
@@ -342,7 +342,7 @@ 
 			$ext = '';
 		}
 
-		$newpath = $path . '/' . $filename;
+		$newpath = $path.'/'.$filename;
 		if ($view->file_exists($newpath)) {
 			if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
 				//Replace the last "(number)" with "(number+1)"
@@ -358,11 +358,11 @@ 
 			do {
 				if ($offset) {
 					//Replace the last "(number)" with "(number+1)"
-					$newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
+					$newname = substr_replace($name, '('.$counter.')', $offset, $match_length);
 				} else {
-					$newname = $name . ' (' . $counter . ')';
+					$newname = $name.' ('.$counter.')';
 				}
-				$newpath = $path . '/' . $newname . $ext;
+				$newpath = $path.'/'.$newname.$ext;
 				$counter++;
 			} while ($view->file_exists($newpath));
 		}
@@ -425,7 +425,7 @@ 
 	 * @return int number of bytes representing
 	 */
 	public static function maxUploadFilesize($dir, $freeSpace = null) {
-		if (is_null($freeSpace) || $freeSpace < 0){
+		if (is_null($freeSpace) || $freeSpace < 0) {
 			$freeSpace = self::freeSpace($dir);
 		}
 		return min($freeSpace, self::uploadLimit());
@@ -443,7 +443,7 @@ 
 			$freeSpace = max($freeSpace, 0);
 			return $freeSpace;
 		} else {
-			return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+			return (INF > 0) ? INF : PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
 		}
 	}
 
@@ -456,9 +456,9 @@ 
 		$ini = \OC::$server->getIniWrapper();
 		$upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
 		$post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
-		if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
+		if ((int) $upload_max_filesize === 0 and (int) $post_max_size === 0) {
 			return INF;
-		} elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
+		} elseif ((int) $upload_max_filesize === 0 or (int) $post_max_size === 0) {
 			return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
 		} else {
 			return min($upload_max_filesize, $post_max_size);
@@ -510,9 +510,9 @@ 
 				if (empty($paths)) {
 					$paths = '/usr/local/bin /usr/bin /opt/bin /bin';
 				} else {
-					$paths = str_replace(':',' ',getenv('PATH'));
+					$paths = str_replace(':', ' ', getenv('PATH'));
 				}
-				$command = 'find ' . $paths . ' -name ' . escapeshellarg($program) . ' 2> /dev/null';
+				$command = 'find '.$paths.' -name '.escapeshellarg($program).' 2> /dev/null';
 				exec($command, $output, $returnCode);
 				if (count($output) > 0) {
 					$result = escapeshellcmd($output[0]);
@@ -597,7 +597,7 @@ 
 		$ownerId = $storage->getOwner($path);
 		$ownerDisplayName = '';
 		$owner = \OC::$server->getUserManager()->get($ownerId);
-		if($owner) {
+		if ($owner) {
 			$ownerDisplayName = $owner->getDisplayName();
 		}
 

Braces +3 added lines, -2 removed lines

@@ -271,8 +271,9 @@
 		}
 		foreach ($dirs as $dir) {
 			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext))
-					return true;
+				if ($check_fn("$dir/$name" . $ext)) {
+									return true;
+				}
 			}
 		}
 		return false;

Indentation +602 added lines, -602 removed lines

@@ -48,606 +48,606 @@
  * Collection of useful functions
  */
 class OC_Helper {
-	private static $templateManager;
-
-	/**
-	 * Creates an absolute url for public use
-	 * @param string $service id
-	 * @param bool $add_slash
-	 * @return string the url
-	 *
-	 * Returns a absolute url to the given service.
-	 */
-	public static function linkToPublic($service, $add_slash = false) {
-		if ($service === 'files') {
-			$url = OC::$server->getURLGenerator()->getAbsoluteURL('/s');
-		} else {
-			$url = OC::$server->getURLGenerator()->getAbsoluteURL(OC::$server->getURLGenerator()->linkTo('', 'public.php').'?service='.$service);
-		}
-		return $url . (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
-	}
-
-	/**
-	 * Make a human file size
-	 * @param int $bytes file size in bytes
-	 * @return string a human readable file size
-	 *
-	 * Makes 2048 to 2 kB.
-	 */
-	public static function humanFileSize($bytes) {
-		if ($bytes < 0) {
-			return "?";
-		}
-		if ($bytes < 1024) {
-			return "$bytes B";
-		}
-		$bytes = round($bytes / 1024, 0);
-		if ($bytes < 1024) {
-			return "$bytes KB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes MB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes GB";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return "$bytes TB";
-		}
-
-		$bytes = round($bytes / 1024, 1);
-		return "$bytes PB";
-	}
-
-	/**
-	 * Make a php file size
-	 * @param int $bytes file size in bytes
-	 * @return string a php parseable file size
-	 *
-	 * Makes 2048 to 2k and 2^41 to 2048G
-	 */
-	public static function phpFileSize($bytes) {
-		if ($bytes < 0) {
-			return "?";
-		}
-		if ($bytes < 1024) {
-			return $bytes . "B";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return $bytes . "K";
-		}
-		$bytes = round($bytes / 1024, 1);
-		if ($bytes < 1024) {
-			return $bytes . "M";
-		}
-		$bytes = round($bytes / 1024, 1);
-		return $bytes . "G";
-	}
-
-	/**
-	 * Make a computer file size
-	 * @param string $str file size in human readable format
-	 * @return float a file size in bytes
-	 *
-	 * Makes 2kB to 2048.
-	 *
-	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
-	 */
-	public static function computerFileSize($str) {
-		$str = strtolower($str);
-		if (is_numeric($str)) {
-			return floatval($str);
-		}
-
-		$bytes_array = array(
-			'b' => 1,
-			'k' => 1024,
-			'kb' => 1024,
-			'mb' => 1024 * 1024,
-			'm' => 1024 * 1024,
-			'gb' => 1024 * 1024 * 1024,
-			'g' => 1024 * 1024 * 1024,
-			'tb' => 1024 * 1024 * 1024 * 1024,
-			't' => 1024 * 1024 * 1024 * 1024,
-			'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
-			'p' => 1024 * 1024 * 1024 * 1024 * 1024,
-		);
-
-		$bytes = floatval($str);
-
-		if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
-			$bytes *= $bytes_array[$matches[1]];
-		} else {
-			return false;
-		}
-
-		$bytes = round($bytes);
-
-		return $bytes;
-	}
-
-	/**
-	 * Recursive copying of folders
-	 * @param string $src source folder
-	 * @param string $dest target folder
-	 *
-	 */
-	static function copyr($src, $dest) {
-		if (is_dir($src)) {
-			if (!is_dir($dest)) {
-				mkdir($dest);
-			}
-			$files = scandir($src);
-			foreach ($files as $file) {
-				if ($file != "." && $file != "..") {
-					self::copyr("$src/$file", "$dest/$file");
-				}
-			}
-		} elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
-			copy($src, $dest);
-		}
-	}
-
-	/**
-	 * Recursive deletion of folders
-	 * @param string $dir path to the folder
-	 * @param bool $deleteSelf if set to false only the content of the folder will be deleted
-	 * @return bool
-	 */
-	static function rmdirr($dir, $deleteSelf = true) {
-		if (is_dir($dir)) {
-			$files = new RecursiveIteratorIterator(
-				new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
-				RecursiveIteratorIterator::CHILD_FIRST
-			);
-
-			foreach ($files as $fileInfo) {
-				/** @var SplFileInfo $fileInfo */
-				if ($fileInfo->isLink()) {
-					unlink($fileInfo->getPathname());
-				} else if ($fileInfo->isDir()) {
-					rmdir($fileInfo->getRealPath());
-				} else {
-					unlink($fileInfo->getRealPath());
-				}
-			}
-			if ($deleteSelf) {
-				rmdir($dir);
-			}
-		} elseif (file_exists($dir)) {
-			if ($deleteSelf) {
-				unlink($dir);
-			}
-		}
-		if (!$deleteSelf) {
-			return true;
-		}
-
-		return !file_exists($dir);
-	}
-
-	/**
-	 * @return \OC\Files\Type\TemplateManager
-	 */
-	static public function getFileTemplateManager() {
-		if (!self::$templateManager) {
-			self::$templateManager = new \OC\Files\Type\TemplateManager();
-		}
-		return self::$templateManager;
-	}
-
-	/**
-	 * detect if a given program is found in the search PATH
-	 *
-	 * @param string $name
-	 * @param bool $path
-	 * @internal param string $program name
-	 * @internal param string $optional search path, defaults to $PATH
-	 * @return bool    true if executable program found in path
-	 */
-	public static function canExecute($name, $path = false) {
-		// path defaults to PATH from environment if not set
-		if ($path === false) {
-			$path = getenv("PATH");
-		}
-		// we look for an executable file of that name
-		$exts = [""];
-		$check_fn = "is_executable";
-		// Default check will be done with $path directories :
-		$dirs = explode(PATH_SEPARATOR, $path);
-		// WARNING : We have to check if open_basedir is enabled :
-		$obd = OC::$server->getIniWrapper()->getString('open_basedir');
-		if ($obd != "none") {
-			$obd_values = explode(PATH_SEPARATOR, $obd);
-			if (count($obd_values) > 0 and $obd_values[0]) {
-				// open_basedir is in effect !
-				// We need to check if the program is in one of these dirs :
-				$dirs = $obd_values;
-			}
-		}
-		foreach ($dirs as $dir) {
-			foreach ($exts as $ext) {
-				if ($check_fn("$dir/$name" . $ext))
-					return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * copy the contents of one stream to another
-	 *
-	 * @param resource $source
-	 * @param resource $target
-	 * @return array the number of bytes copied and result
-	 */
-	public static function streamCopy($source, $target) {
-		if (!$source or !$target) {
-			return array(0, false);
-		}
-		$bufSize = 8192;
-		$result = true;
-		$count = 0;
-		while (!feof($source)) {
-			$buf = fread($source, $bufSize);
-			$bytesWritten = fwrite($target, $buf);
-			if ($bytesWritten !== false) {
-				$count += $bytesWritten;
-			}
-			// note: strlen is expensive so only use it when necessary,
-			// on the last block
-			if ($bytesWritten === false
-				|| ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
-			) {
-				// write error, could be disk full ?
-				$result = false;
-				break;
-			}
-		}
-		return array($count, $result);
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileName($path, $filename) {
-		$view = \OC\Files\Filesystem::getView();
-		return self::buildNotExistingFileNameForView($path, $filename, $view);
-	}
-
-	/**
-	 * Adds a suffix to the name in case the file exists
-	 *
-	 * @param string $path
-	 * @param string $filename
-	 * @return string
-	 */
-	public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
-		if ($path === '/') {
-			$path = '';
-		}
-		if ($pos = strrpos($filename, '.')) {
-			$name = substr($filename, 0, $pos);
-			$ext = substr($filename, $pos);
-		} else {
-			$name = $filename;
-			$ext = '';
-		}
-
-		$newpath = $path . '/' . $filename;
-		if ($view->file_exists($newpath)) {
-			if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
-				//Replace the last "(number)" with "(number+1)"
-				$last_match = count($matches[0]) - 1;
-				$counter = $matches[1][$last_match][0] + 1;
-				$offset = $matches[0][$last_match][1];
-				$match_length = strlen($matches[0][$last_match][0]);
-			} else {
-				$counter = 2;
-				$match_length = 0;
-				$offset = false;
-			}
-			do {
-				if ($offset) {
-					//Replace the last "(number)" with "(number+1)"
-					$newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
-				} else {
-					$newname = $name . ' (' . $counter . ')';
-				}
-				$newpath = $path . '/' . $newname . $ext;
-				$counter++;
-			} while ($view->file_exists($newpath));
-		}
-
-		return $newpath;
-	}
-
-	/**
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 *
-	 * @param array $input The array to work on
-	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
-	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
-	 * @return array
-	 *
-	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
-	 * based on http://www.php.net/manual/en/function.array-change-key-case.php#107715
-	 *
-	 */
-	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
-		$case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
-		$ret = array();
-		foreach ($input as $k => $v) {
-			$ret[mb_convert_case($k, $case, $encoding)] = $v;
-		}
-		return $ret;
-	}
-
-	/**
-	 * performs a search in a nested array
-	 * @param array $haystack the array to be searched
-	 * @param string $needle the search string
-	 * @param string $index optional, only search this key name
-	 * @return mixed the key of the matching field, otherwise false
-	 *
-	 * performs a search in a nested array
-	 *
-	 * taken from http://www.php.net/manual/en/function.array-search.php#97645
-	 */
-	public static function recursiveArraySearch($haystack, $needle, $index = null) {
-		$aIt = new RecursiveArrayIterator($haystack);
-		$it = new RecursiveIteratorIterator($aIt);
-
-		while ($it->valid()) {
-			if (((isset($index) AND ($it->key() == $index)) OR (!isset($index))) AND ($it->current() == $needle)) {
-				return $aIt->key();
-			}
-
-			$it->next();
-		}
-
-		return false;
-	}
-
-	/**
-	 * calculates the maximum upload size respecting system settings, free space and user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
-	 * @return int number of bytes representing
-	 */
-	public static function maxUploadFilesize($dir, $freeSpace = null) {
-		if (is_null($freeSpace) || $freeSpace < 0){
-			$freeSpace = self::freeSpace($dir);
-		}
-		return min($freeSpace, self::uploadLimit());
-	}
-
-	/**
-	 * Calculate free space left within user quota
-	 *
-	 * @param string $dir the current folder where the user currently operates
-	 * @return int number of bytes representing
-	 */
-	public static function freeSpace($dir) {
-		$freeSpace = \OC\Files\Filesystem::free_space($dir);
-		if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-			$freeSpace = max($freeSpace, 0);
-			return $freeSpace;
-		} else {
-			return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
-		}
-	}
-
-	/**
-	 * Calculate PHP upload limit
-	 *
-	 * @return int PHP upload file size limit
-	 */
-	public static function uploadLimit() {
-		$ini = \OC::$server->getIniWrapper();
-		$upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
-		$post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
-		if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
-			return INF;
-		} elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
-			return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
-		} else {
-			return min($upload_max_filesize, $post_max_size);
-		}
-	}
-
-	/**
-	 * Checks if a function is available
-	 *
-	 * @param string $function_name
-	 * @return bool
-	 */
-	public static function is_function_enabled($function_name) {
-		if (!function_exists($function_name)) {
-			return false;
-		}
-		$ini = \OC::$server->getIniWrapper();
-		$disabled = explode(',', $ini->get('disable_functions'));
-		$disabled = array_map('trim', $disabled);
-		if (in_array($function_name, $disabled)) {
-			return false;
-		}
-		$disabled = explode(',', $ini->get('suhosin.executor.func.blacklist'));
-		$disabled = array_map('trim', $disabled);
-		if (in_array($function_name, $disabled)) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * Try to find a program
-	 *
-	 * @param string $program
-	 * @return null|string
-	 */
-	public static function findBinaryPath($program) {
-		$memcache = \OC::$server->getMemCacheFactory()->create('findBinaryPath');
-		if ($memcache->hasKey($program)) {
-			return $memcache->get($program);
-		}
-		$result = null;
-		if (self::is_function_enabled('exec')) {
-			$exeSniffer = new ExecutableFinder();
-			// Returns null if nothing is found
-			$result = $exeSniffer->find($program);
-			if (empty($result)) {
-				$paths = getenv('PATH');
-				if (empty($paths)) {
-					$paths = '/usr/local/bin /usr/bin /opt/bin /bin';
-				} else {
-					$paths = str_replace(':',' ',getenv('PATH'));
-				}
-				$command = 'find ' . $paths . ' -name ' . escapeshellarg($program) . ' 2> /dev/null';
-				exec($command, $output, $returnCode);
-				if (count($output) > 0) {
-					$result = escapeshellcmd($output[0]);
-				}
-			}
-		}
-		// store the value for 5 minutes
-		$memcache->set($program, $result, 300);
-		return $result;
-	}
-
-	/**
-	 * Calculate the disc space for the given path
-	 *
-	 * @param string $path
-	 * @param \OCP\Files\FileInfo $rootInfo (optional)
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	public static function getStorageInfo($path, $rootInfo = null) {
-		// return storage info without adding mount points
-		$includeExtStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
-
-		if (!$rootInfo) {
-			$rootInfo = \OC\Files\Filesystem::getFileInfo($path, $includeExtStorage ? 'ext' : false);
-		}
-		if (!$rootInfo instanceof \OCP\Files\FileInfo) {
-			throw new \OCP\Files\NotFoundException();
-		}
-		$used = $rootInfo->getSize();
-		if ($used < 0) {
-			$used = 0;
-		}
-		$quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
-		$storage = $rootInfo->getStorage();
-		$sourceStorage = $storage;
-		if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
-			$includeExtStorage = false;
-			$sourceStorage = $storage->getSourceStorage();
-		}
-		if ($includeExtStorage) {
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
-				|| $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
-			) {
-				/** @var \OC\Files\Storage\Home $storage */
-				$user = $storage->getUser();
-			} else {
-				$user = \OC::$server->getUserSession()->getUser()->getUID();
-			}
-			if ($user) {
-				$quota = OC_Util::getUserQuota($user);
-			} else {
-				$quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
-			}
-			if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				// always get free space / total space from root + mount points
-				return self::getGlobalStorageInfo();
-			}
-		}
-
-		// TODO: need a better way to get total space from storage
-		if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
-			/** @var \OC\Files\Storage\Wrapper\Quota $storage */
-			$quota = $sourceStorage->getQuota();
-		}
-		$free = $sourceStorage->free_space($rootInfo->getInternalPath());
-		if ($free >= 0) {
-			$total = $free + $used;
-		} else {
-			$total = $free; //either unknown or unlimited
-		}
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		$ownerId = $storage->getOwner($path);
-		$ownerDisplayName = '';
-		$owner = \OC::$server->getUserManager()->get($ownerId);
-		if($owner) {
-			$ownerDisplayName = $owner->getDisplayName();
-		}
-
-		return [
-			'free' => $free,
-			'used' => $used,
-			'quota' => $quota,
-			'total' => $total,
-			'relative' => $relative,
-			'owner' => $ownerId,
-			'ownerDisplayName' => $ownerDisplayName,
-		];
-	}
-
-	/**
-	 * Get storage info including all mount points and quota
-	 *
-	 * @return array
-	 */
-	private static function getGlobalStorageInfo() {
-		$quota = OC_Util::getUserQuota(\OCP\User::getUser());
-
-		$rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
-		$used = $rootInfo['size'];
-		if ($used < 0) {
-			$used = 0;
-		}
-
-		$total = $quota;
-		$free = $quota - $used;
-
-		if ($total > 0) {
-			if ($quota > 0 && $total > $quota) {
-				$total = $quota;
-			}
-			// prevent division by zero or error codes (negative values)
-			$relative = round(($used / $total) * 10000) / 100;
-		} else {
-			$relative = 0;
-		}
-
-		return array('free' => $free, 'used' => $used, 'total' => $total, 'relative' => $relative);
-
-	}
-
-	/**
-	 * Returns whether the config file is set manually to read-only
-	 * @return bool
-	 */
-	public static function isReadOnlyConfigEnabled() {
-		return \OC::$server->getConfig()->getSystemValue('config_is_read_only', false);
-	}
+    private static $templateManager;
+
+    /**
+     * Creates an absolute url for public use
+     * @param string $service id
+     * @param bool $add_slash
+     * @return string the url
+     *
+     * Returns a absolute url to the given service.
+     */
+    public static function linkToPublic($service, $add_slash = false) {
+        if ($service === 'files') {
+            $url = OC::$server->getURLGenerator()->getAbsoluteURL('/s');
+        } else {
+            $url = OC::$server->getURLGenerator()->getAbsoluteURL(OC::$server->getURLGenerator()->linkTo('', 'public.php').'?service='.$service);
+        }
+        return $url . (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
+    }
+
+    /**
+     * Make a human file size
+     * @param int $bytes file size in bytes
+     * @return string a human readable file size
+     *
+     * Makes 2048 to 2 kB.
+     */
+    public static function humanFileSize($bytes) {
+        if ($bytes < 0) {
+            return "?";
+        }
+        if ($bytes < 1024) {
+            return "$bytes B";
+        }
+        $bytes = round($bytes / 1024, 0);
+        if ($bytes < 1024) {
+            return "$bytes KB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes MB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes GB";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return "$bytes TB";
+        }
+
+        $bytes = round($bytes / 1024, 1);
+        return "$bytes PB";
+    }
+
+    /**
+     * Make a php file size
+     * @param int $bytes file size in bytes
+     * @return string a php parseable file size
+     *
+     * Makes 2048 to 2k and 2^41 to 2048G
+     */
+    public static function phpFileSize($bytes) {
+        if ($bytes < 0) {
+            return "?";
+        }
+        if ($bytes < 1024) {
+            return $bytes . "B";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return $bytes . "K";
+        }
+        $bytes = round($bytes / 1024, 1);
+        if ($bytes < 1024) {
+            return $bytes . "M";
+        }
+        $bytes = round($bytes / 1024, 1);
+        return $bytes . "G";
+    }
+
+    /**
+     * Make a computer file size
+     * @param string $str file size in human readable format
+     * @return float a file size in bytes
+     *
+     * Makes 2kB to 2048.
+     *
+     * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
+     */
+    public static function computerFileSize($str) {
+        $str = strtolower($str);
+        if (is_numeric($str)) {
+            return floatval($str);
+        }
+
+        $bytes_array = array(
+            'b' => 1,
+            'k' => 1024,
+            'kb' => 1024,
+            'mb' => 1024 * 1024,
+            'm' => 1024 * 1024,
+            'gb' => 1024 * 1024 * 1024,
+            'g' => 1024 * 1024 * 1024,
+            'tb' => 1024 * 1024 * 1024 * 1024,
+            't' => 1024 * 1024 * 1024 * 1024,
+            'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
+            'p' => 1024 * 1024 * 1024 * 1024 * 1024,
+        );
+
+        $bytes = floatval($str);
+
+        if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
+            $bytes *= $bytes_array[$matches[1]];
+        } else {
+            return false;
+        }
+
+        $bytes = round($bytes);
+
+        return $bytes;
+    }
+
+    /**
+     * Recursive copying of folders
+     * @param string $src source folder
+     * @param string $dest target folder
+     *
+     */
+    static function copyr($src, $dest) {
+        if (is_dir($src)) {
+            if (!is_dir($dest)) {
+                mkdir($dest);
+            }
+            $files = scandir($src);
+            foreach ($files as $file) {
+                if ($file != "." && $file != "..") {
+                    self::copyr("$src/$file", "$dest/$file");
+                }
+            }
+        } elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
+            copy($src, $dest);
+        }
+    }
+
+    /**
+     * Recursive deletion of folders
+     * @param string $dir path to the folder
+     * @param bool $deleteSelf if set to false only the content of the folder will be deleted
+     * @return bool
+     */
+    static function rmdirr($dir, $deleteSelf = true) {
+        if (is_dir($dir)) {
+            $files = new RecursiveIteratorIterator(
+                new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS),
+                RecursiveIteratorIterator::CHILD_FIRST
+            );
+
+            foreach ($files as $fileInfo) {
+                /** @var SplFileInfo $fileInfo */
+                if ($fileInfo->isLink()) {
+                    unlink($fileInfo->getPathname());
+                } else if ($fileInfo->isDir()) {
+                    rmdir($fileInfo->getRealPath());
+                } else {
+                    unlink($fileInfo->getRealPath());
+                }
+            }
+            if ($deleteSelf) {
+                rmdir($dir);
+            }
+        } elseif (file_exists($dir)) {
+            if ($deleteSelf) {
+                unlink($dir);
+            }
+        }
+        if (!$deleteSelf) {
+            return true;
+        }
+
+        return !file_exists($dir);
+    }
+
+    /**
+     * @return \OC\Files\Type\TemplateManager
+     */
+    static public function getFileTemplateManager() {
+        if (!self::$templateManager) {
+            self::$templateManager = new \OC\Files\Type\TemplateManager();
+        }
+        return self::$templateManager;
+    }
+
+    /**
+     * detect if a given program is found in the search PATH
+     *
+     * @param string $name
+     * @param bool $path
+     * @internal param string $program name
+     * @internal param string $optional search path, defaults to $PATH
+     * @return bool    true if executable program found in path
+     */
+    public static function canExecute($name, $path = false) {
+        // path defaults to PATH from environment if not set
+        if ($path === false) {
+            $path = getenv("PATH");
+        }
+        // we look for an executable file of that name
+        $exts = [""];
+        $check_fn = "is_executable";
+        // Default check will be done with $path directories :
+        $dirs = explode(PATH_SEPARATOR, $path);
+        // WARNING : We have to check if open_basedir is enabled :
+        $obd = OC::$server->getIniWrapper()->getString('open_basedir');
+        if ($obd != "none") {
+            $obd_values = explode(PATH_SEPARATOR, $obd);
+            if (count($obd_values) > 0 and $obd_values[0]) {
+                // open_basedir is in effect !
+                // We need to check if the program is in one of these dirs :
+                $dirs = $obd_values;
+            }
+        }
+        foreach ($dirs as $dir) {
+            foreach ($exts as $ext) {
+                if ($check_fn("$dir/$name" . $ext))
+                    return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * copy the contents of one stream to another
+     *
+     * @param resource $source
+     * @param resource $target
+     * @return array the number of bytes copied and result
+     */
+    public static function streamCopy($source, $target) {
+        if (!$source or !$target) {
+            return array(0, false);
+        }
+        $bufSize = 8192;
+        $result = true;
+        $count = 0;
+        while (!feof($source)) {
+            $buf = fread($source, $bufSize);
+            $bytesWritten = fwrite($target, $buf);
+            if ($bytesWritten !== false) {
+                $count += $bytesWritten;
+            }
+            // note: strlen is expensive so only use it when necessary,
+            // on the last block
+            if ($bytesWritten === false
+                || ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
+            ) {
+                // write error, could be disk full ?
+                $result = false;
+                break;
+            }
+        }
+        return array($count, $result);
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileName($path, $filename) {
+        $view = \OC\Files\Filesystem::getView();
+        return self::buildNotExistingFileNameForView($path, $filename, $view);
+    }
+
+    /**
+     * Adds a suffix to the name in case the file exists
+     *
+     * @param string $path
+     * @param string $filename
+     * @return string
+     */
+    public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
+        if ($path === '/') {
+            $path = '';
+        }
+        if ($pos = strrpos($filename, '.')) {
+            $name = substr($filename, 0, $pos);
+            $ext = substr($filename, $pos);
+        } else {
+            $name = $filename;
+            $ext = '';
+        }
+
+        $newpath = $path . '/' . $filename;
+        if ($view->file_exists($newpath)) {
+            if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
+                //Replace the last "(number)" with "(number+1)"
+                $last_match = count($matches[0]) - 1;
+                $counter = $matches[1][$last_match][0] + 1;
+                $offset = $matches[0][$last_match][1];
+                $match_length = strlen($matches[0][$last_match][0]);
+            } else {
+                $counter = 2;
+                $match_length = 0;
+                $offset = false;
+            }
+            do {
+                if ($offset) {
+                    //Replace the last "(number)" with "(number+1)"
+                    $newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
+                } else {
+                    $newname = $name . ' (' . $counter . ')';
+                }
+                $newpath = $path . '/' . $newname . $ext;
+                $counter++;
+            } while ($view->file_exists($newpath));
+        }
+
+        return $newpath;
+    }
+
+    /**
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     *
+     * @param array $input The array to work on
+     * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
+     * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
+     * @return array
+     *
+     * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
+     * based on http://www.php.net/manual/en/function.array-change-key-case.php#107715
+     *
+     */
+    public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
+        $case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
+        $ret = array();
+        foreach ($input as $k => $v) {
+            $ret[mb_convert_case($k, $case, $encoding)] = $v;
+        }
+        return $ret;
+    }
+
+    /**
+     * performs a search in a nested array
+     * @param array $haystack the array to be searched
+     * @param string $needle the search string
+     * @param string $index optional, only search this key name
+     * @return mixed the key of the matching field, otherwise false
+     *
+     * performs a search in a nested array
+     *
+     * taken from http://www.php.net/manual/en/function.array-search.php#97645
+     */
+    public static function recursiveArraySearch($haystack, $needle, $index = null) {
+        $aIt = new RecursiveArrayIterator($haystack);
+        $it = new RecursiveIteratorIterator($aIt);
+
+        while ($it->valid()) {
+            if (((isset($index) AND ($it->key() == $index)) OR (!isset($index))) AND ($it->current() == $needle)) {
+                return $aIt->key();
+            }
+
+            $it->next();
+        }
+
+        return false;
+    }
+
+    /**
+     * calculates the maximum upload size respecting system settings, free space and user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly
+     * @return int number of bytes representing
+     */
+    public static function maxUploadFilesize($dir, $freeSpace = null) {
+        if (is_null($freeSpace) || $freeSpace < 0){
+            $freeSpace = self::freeSpace($dir);
+        }
+        return min($freeSpace, self::uploadLimit());
+    }
+
+    /**
+     * Calculate free space left within user quota
+     *
+     * @param string $dir the current folder where the user currently operates
+     * @return int number of bytes representing
+     */
+    public static function freeSpace($dir) {
+        $freeSpace = \OC\Files\Filesystem::free_space($dir);
+        if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+            $freeSpace = max($freeSpace, 0);
+            return $freeSpace;
+        } else {
+            return (INF > 0)? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+        }
+    }
+
+    /**
+     * Calculate PHP upload limit
+     *
+     * @return int PHP upload file size limit
+     */
+    public static function uploadLimit() {
+        $ini = \OC::$server->getIniWrapper();
+        $upload_max_filesize = OCP\Util::computerFileSize($ini->get('upload_max_filesize'));
+        $post_max_size = OCP\Util::computerFileSize($ini->get('post_max_size'));
+        if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
+            return INF;
+        } elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
+            return max($upload_max_filesize, $post_max_size); //only the non 0 value counts
+        } else {
+            return min($upload_max_filesize, $post_max_size);
+        }
+    }
+
+    /**
+     * Checks if a function is available
+     *
+     * @param string $function_name
+     * @return bool
+     */
+    public static function is_function_enabled($function_name) {
+        if (!function_exists($function_name)) {
+            return false;
+        }
+        $ini = \OC::$server->getIniWrapper();
+        $disabled = explode(',', $ini->get('disable_functions'));
+        $disabled = array_map('trim', $disabled);
+        if (in_array($function_name, $disabled)) {
+            return false;
+        }
+        $disabled = explode(',', $ini->get('suhosin.executor.func.blacklist'));
+        $disabled = array_map('trim', $disabled);
+        if (in_array($function_name, $disabled)) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Try to find a program
+     *
+     * @param string $program
+     * @return null|string
+     */
+    public static function findBinaryPath($program) {
+        $memcache = \OC::$server->getMemCacheFactory()->create('findBinaryPath');
+        if ($memcache->hasKey($program)) {
+            return $memcache->get($program);
+        }
+        $result = null;
+        if (self::is_function_enabled('exec')) {
+            $exeSniffer = new ExecutableFinder();
+            // Returns null if nothing is found
+            $result = $exeSniffer->find($program);
+            if (empty($result)) {
+                $paths = getenv('PATH');
+                if (empty($paths)) {
+                    $paths = '/usr/local/bin /usr/bin /opt/bin /bin';
+                } else {
+                    $paths = str_replace(':',' ',getenv('PATH'));
+                }
+                $command = 'find ' . $paths . ' -name ' . escapeshellarg($program) . ' 2> /dev/null';
+                exec($command, $output, $returnCode);
+                if (count($output) > 0) {
+                    $result = escapeshellcmd($output[0]);
+                }
+            }
+        }
+        // store the value for 5 minutes
+        $memcache->set($program, $result, 300);
+        return $result;
+    }
+
+    /**
+     * Calculate the disc space for the given path
+     *
+     * @param string $path
+     * @param \OCP\Files\FileInfo $rootInfo (optional)
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    public static function getStorageInfo($path, $rootInfo = null) {
+        // return storage info without adding mount points
+        $includeExtStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
+
+        if (!$rootInfo) {
+            $rootInfo = \OC\Files\Filesystem::getFileInfo($path, $includeExtStorage ? 'ext' : false);
+        }
+        if (!$rootInfo instanceof \OCP\Files\FileInfo) {
+            throw new \OCP\Files\NotFoundException();
+        }
+        $used = $rootInfo->getSize();
+        if ($used < 0) {
+            $used = 0;
+        }
+        $quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
+        $storage = $rootInfo->getStorage();
+        $sourceStorage = $storage;
+        if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
+            $includeExtStorage = false;
+            $sourceStorage = $storage->getSourceStorage();
+        }
+        if ($includeExtStorage) {
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
+                || $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
+            ) {
+                /** @var \OC\Files\Storage\Home $storage */
+                $user = $storage->getUser();
+            } else {
+                $user = \OC::$server->getUserSession()->getUser()->getUID();
+            }
+            if ($user) {
+                $quota = OC_Util::getUserQuota($user);
+            } else {
+                $quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
+            }
+            if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                // always get free space / total space from root + mount points
+                return self::getGlobalStorageInfo();
+            }
+        }
+
+        // TODO: need a better way to get total space from storage
+        if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
+            /** @var \OC\Files\Storage\Wrapper\Quota $storage */
+            $quota = $sourceStorage->getQuota();
+        }
+        $free = $sourceStorage->free_space($rootInfo->getInternalPath());
+        if ($free >= 0) {
+            $total = $free + $used;
+        } else {
+            $total = $free; //either unknown or unlimited
+        }
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        $ownerId = $storage->getOwner($path);
+        $ownerDisplayName = '';
+        $owner = \OC::$server->getUserManager()->get($ownerId);
+        if($owner) {
+            $ownerDisplayName = $owner->getDisplayName();
+        }
+
+        return [
+            'free' => $free,
+            'used' => $used,
+            'quota' => $quota,
+            'total' => $total,
+            'relative' => $relative,
+            'owner' => $ownerId,
+            'ownerDisplayName' => $ownerDisplayName,
+        ];
+    }
+
+    /**
+     * Get storage info including all mount points and quota
+     *
+     * @return array
+     */
+    private static function getGlobalStorageInfo() {
+        $quota = OC_Util::getUserQuota(\OCP\User::getUser());
+
+        $rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
+        $used = $rootInfo['size'];
+        if ($used < 0) {
+            $used = 0;
+        }
+
+        $total = $quota;
+        $free = $quota - $used;
+
+        if ($total > 0) {
+            if ($quota > 0 && $total > $quota) {
+                $total = $quota;
+            }
+            // prevent division by zero or error codes (negative values)
+            $relative = round(($used / $total) * 10000) / 100;
+        } else {
+            $relative = 0;
+        }
+
+        return array('free' => $free, 'used' => $used, 'total' => $total, 'relative' => $relative);
+
+    }
+
+    /**
+     * Returns whether the config file is set manually to read-only
+     * @return bool
+     */
+    public static function isReadOnlyConfigEnabled() {
+        return \OC::$server->getConfig()->getSystemValue('config_is_read_only', false);
+    }
 }

lib/private/Memcache/Memcached.php

Doc Comments +1 added lines, -1 removed lines

@@ -155,7 +155,7 @@
 	 * Set a value in the cache if it's not already stored
 	 *
 	 * @param string $key
-	 * @param mixed $value
+	 * @param integer $value
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
 	 * @return bool
 	 * @throws \Exception

Indentation +189 added lines, -189 removed lines

@@ -33,193 +33,193 @@
 use OCP\IMemcache;
 
 class Memcached extends Cache implements IMemcache {
-	use CASTrait;
-
-	/**
-	 * @var \Memcached $cache
-	 */
-	private static $cache = null;
-
-	use CADTrait;
-
-	public function __construct($prefix = '') {
-		parent::__construct($prefix);
-		if (is_null(self::$cache)) {
-			self::$cache = new \Memcached();
-
-			$defaultOptions = [
-				\Memcached::OPT_CONNECT_TIMEOUT => 50,
-				\Memcached::OPT_RETRY_TIMEOUT =>   50,
-				\Memcached::OPT_SEND_TIMEOUT =>    50,
-				\Memcached::OPT_RECV_TIMEOUT =>    50,
-				\Memcached::OPT_POLL_TIMEOUT =>    50,
-
-				// Enable compression
-				\Memcached::OPT_COMPRESSION =>          true,
-
-				// Turn on consistent hashing
-				\Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
-
-				// Enable Binary Protocol
-				//\Memcached::OPT_BINARY_PROTOCOL =>      true,
-			];
-			// by default enable igbinary serializer if available
-			if (\Memcached::HAVE_IGBINARY) {
-				$defaultOptions[\Memcached::OPT_SERIALIZER] =
-					\Memcached::SERIALIZER_IGBINARY;
-			}
-			$options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
-			if (is_array($options)) {
-				$options = $options + $defaultOptions;
-				self::$cache->setOptions($options);
-			} else {
-				throw new HintException("Expected 'memcached_options' config to be an array, got $options");
-			}
-
-			$servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
-			if (!$servers) {
-				$server = \OC::$server->getSystemConfig()->getValue('memcached_server');
-				if ($server) {
-					$servers = [$server];
-				} else {
-					$servers = [['localhost', 11211]];
-				}
-			}
-			self::$cache->addServers($servers);
-		}
-	}
-
-	/**
-	 * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
-	 */
-	protected function getNameSpace() {
-		return $this->prefix;
-	}
-
-	public function get($key) {
-		$result = self::$cache->get($this->getNameSpace() . $key);
-		if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
-			return null;
-		} else {
-			return $result;
-		}
-	}
-
-	public function set($key, $value, $ttl = 0) {
-		if ($ttl > 0) {
-			$result =  self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
-		} else {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value);
-		}
-		if ($result !== true) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	public function hasKey($key) {
-		self::$cache->get($this->getNameSpace() . $key);
-		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
-	}
-
-	public function remove($key) {
-		$result= self::$cache->delete($this->getNameSpace() . $key);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	public function clear($prefix = '') {
-		$prefix = $this->getNameSpace() . $prefix;
-		$allKeys = self::$cache->getAllKeys();
-		if ($allKeys === false) {
-			// newer Memcached doesn't like getAllKeys(), flush everything
-			self::$cache->flush();
-			return true;
-		}
-		$keys = array();
-		$prefixLength = strlen($prefix);
-		foreach ($allKeys as $key) {
-			if (substr($key, 0, $prefixLength) === $prefix) {
-				$keys[] = $key;
-			}
-		}
-		if (method_exists(self::$cache, 'deleteMulti')) {
-			self::$cache->deleteMulti($keys);
-		} else {
-			foreach ($keys as $key) {
-				self::$cache->delete($key);
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 * @throws \Exception
-	 */
-	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
-		if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
-			$this->verifyReturnCode();
-		}
-		return $result;
-	}
-
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
-
-		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
-			return false;
-		}
-
-		return $result;
-	}
-
-	static public function isAvailable() {
-		return extension_loaded('memcached');
-	}
-
-	/**
-	 * @throws \Exception
-	 */
-	private function verifyReturnCode() {
-		$code = self::$cache->getResultCode();
-		if ($code === \Memcached::RES_SUCCESS) {
-			return;
-		}
-		$message = self::$cache->getResultMessage();
-		throw new \Exception("Error $code interacting with memcached : $message");
-	}
+    use CASTrait;
+
+    /**
+     * @var \Memcached $cache
+     */
+    private static $cache = null;
+
+    use CADTrait;
+
+    public function __construct($prefix = '') {
+        parent::__construct($prefix);
+        if (is_null(self::$cache)) {
+            self::$cache = new \Memcached();
+
+            $defaultOptions = [
+                \Memcached::OPT_CONNECT_TIMEOUT => 50,
+                \Memcached::OPT_RETRY_TIMEOUT =>   50,
+                \Memcached::OPT_SEND_TIMEOUT =>    50,
+                \Memcached::OPT_RECV_TIMEOUT =>    50,
+                \Memcached::OPT_POLL_TIMEOUT =>    50,
+
+                // Enable compression
+                \Memcached::OPT_COMPRESSION =>          true,
+
+                // Turn on consistent hashing
+                \Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
+
+                // Enable Binary Protocol
+                //\Memcached::OPT_BINARY_PROTOCOL =>      true,
+            ];
+            // by default enable igbinary serializer if available
+            if (\Memcached::HAVE_IGBINARY) {
+                $defaultOptions[\Memcached::OPT_SERIALIZER] =
+                    \Memcached::SERIALIZER_IGBINARY;
+            }
+            $options = \OC::$server->getConfig()->getSystemValue('memcached_options', []);
+            if (is_array($options)) {
+                $options = $options + $defaultOptions;
+                self::$cache->setOptions($options);
+            } else {
+                throw new HintException("Expected 'memcached_options' config to be an array, got $options");
+            }
+
+            $servers = \OC::$server->getSystemConfig()->getValue('memcached_servers');
+            if (!$servers) {
+                $server = \OC::$server->getSystemConfig()->getValue('memcached_server');
+                if ($server) {
+                    $servers = [$server];
+                } else {
+                    $servers = [['localhost', 11211]];
+                }
+            }
+            self::$cache->addServers($servers);
+        }
+    }
+
+    /**
+     * entries in XCache gets namespaced to prevent collisions between owncloud instances and users
+     */
+    protected function getNameSpace() {
+        return $this->prefix;
+    }
+
+    public function get($key) {
+        $result = self::$cache->get($this->getNameSpace() . $key);
+        if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
+            return null;
+        } else {
+            return $result;
+        }
+    }
+
+    public function set($key, $value, $ttl = 0) {
+        if ($ttl > 0) {
+            $result =  self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
+        } else {
+            $result = self::$cache->set($this->getNameSpace() . $key, $value);
+        }
+        if ($result !== true) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    public function hasKey($key) {
+        self::$cache->get($this->getNameSpace() . $key);
+        return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
+    }
+
+    public function remove($key) {
+        $result= self::$cache->delete($this->getNameSpace() . $key);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    public function clear($prefix = '') {
+        $prefix = $this->getNameSpace() . $prefix;
+        $allKeys = self::$cache->getAllKeys();
+        if ($allKeys === false) {
+            // newer Memcached doesn't like getAllKeys(), flush everything
+            self::$cache->flush();
+            return true;
+        }
+        $keys = array();
+        $prefixLength = strlen($prefix);
+        foreach ($allKeys as $key) {
+            if (substr($key, 0, $prefixLength) === $prefix) {
+                $keys[] = $key;
+            }
+        }
+        if (method_exists(self::$cache, 'deleteMulti')) {
+            self::$cache->deleteMulti($keys);
+        } else {
+            foreach ($keys as $key) {
+                self::$cache->delete($key);
+            }
+        }
+        return true;
+    }
+
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     * @throws \Exception
+     */
+    public function add($key, $value, $ttl = 0) {
+        $result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+        if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
+            $this->verifyReturnCode();
+        }
+        return $result;
+    }
+
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $this->add($key, 0);
+        $result = self::$cache->increment($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        $result = self::$cache->decrement($this->getPrefix() . $key, $step);
+
+        if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
+            return false;
+        }
+
+        return $result;
+    }
+
+    static public function isAvailable() {
+        return extension_loaded('memcached');
+    }
+
+    /**
+     * @throws \Exception
+     */
+    private function verifyReturnCode() {
+        $code = self::$cache->getResultCode();
+        if ($code === \Memcached::RES_SUCCESS) {
+            return;
+        }
+        $message = self::$cache->getResultMessage();
+        throw new \Exception("Error $code interacting with memcached : $message");
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -97,7 +97,7 @@ 
 	}
 
 	public function get($key) {
-		$result = self::$cache->get($this->getNameSpace() . $key);
+		$result = self::$cache->get($this->getNameSpace().$key);
 		if ($result === false and self::$cache->getResultCode() == \Memcached::RES_NOTFOUND) {
 			return null;
 		} else {
@@ -107,9 +107,9 @@ 
 
 	public function set($key, $value, $ttl = 0) {
 		if ($ttl > 0) {
-			$result =  self::$cache->set($this->getNameSpace() . $key, $value, $ttl);
+			$result = self::$cache->set($this->getNameSpace().$key, $value, $ttl);
 		} else {
-			$result = self::$cache->set($this->getNameSpace() . $key, $value);
+			$result = self::$cache->set($this->getNameSpace().$key, $value);
 		}
 		if ($result !== true) {
 			$this->verifyReturnCode();
@@ -118,12 +118,12 @@ 
 	}
 
 	public function hasKey($key) {
-		self::$cache->get($this->getNameSpace() . $key);
+		self::$cache->get($this->getNameSpace().$key);
 		return self::$cache->getResultCode() === \Memcached::RES_SUCCESS;
 	}
 
 	public function remove($key) {
-		$result= self::$cache->delete($this->getNameSpace() . $key);
+		$result = self::$cache->delete($this->getNameSpace().$key);
 		if (self::$cache->getResultCode() !== \Memcached::RES_NOTFOUND) {
 			$this->verifyReturnCode();
 		}
@@ -131,7 +131,7 @@ 
 	}
 
 	public function clear($prefix = '') {
-		$prefix = $this->getNameSpace() . $prefix;
+		$prefix = $this->getNameSpace().$prefix;
 		$allKeys = self::$cache->getAllKeys();
 		if ($allKeys === false) {
 			// newer Memcached doesn't like getAllKeys(), flush everything
@@ -165,7 +165,7 @@ 
 	 * @throws \Exception
 	 */
 	public function add($key, $value, $ttl = 0) {
-		$result = self::$cache->add($this->getPrefix() . $key, $value, $ttl);
+		$result = self::$cache->add($this->getPrefix().$key, $value, $ttl);
 		if (self::$cache->getResultCode() !== \Memcached::RES_NOTSTORED) {
 			$this->verifyReturnCode();
 		}
@@ -181,7 +181,7 @@ 
 	 */
 	public function inc($key, $step = 1) {
 		$this->add($key, 0);
-		$result = self::$cache->increment($this->getPrefix() . $key, $step);
+		$result = self::$cache->increment($this->getPrefix().$key, $step);
 
 		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
 			return false;
@@ -198,7 +198,7 @@ 
 	 * @return int | bool
 	 */
 	public function dec($key, $step = 1) {
-		$result = self::$cache->decrement($this->getPrefix() . $key, $step);
+		$result = self::$cache->decrement($this->getPrefix().$key, $step);
 
 		if (self::$cache->getResultCode() !== \Memcached::RES_SUCCESS) {
 			return false;

lib/private/Repair.php

Doc Comments +1 added lines, -2 removed lines

@@ -139,7 +139,7 @@ 
 	 * Returns expensive repair steps to be run on the
 	 * command line with a special option.
 	 *
-	 * @return IRepairStep[]
+	 * @return OldGroupMembershipShares[]
 	 */
 	public static function getExpensiveRepairSteps() {
 		return [
@@ -216,7 +216,6 @@ 
 	}
 
 	/**
-	 * @param int $max
 	 */
 	public function finishProgress() {
 		// for now just emit as we did in the past

Spacing +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
-class Repair implements IOutput{
+class Repair implements IOutput {
 	/* @var IRepairStep[] */
 	private $repairSteps;
 	/** @var EventDispatcher */

Indentation +175 added lines, -175 removed lines

@@ -53,179 +53,179 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class Repair implements IOutput{
-	/* @var IRepairStep[] */
-	private $repairSteps;
-	/** @var EventDispatcher */
-	private $dispatcher;
-	/** @var string */
-	private $currentStep;
-
-	/**
-	 * Creates a new repair step runner
-	 *
-	 * @param IRepairStep[] $repairSteps array of RepairStep instances
-	 * @param EventDispatcher $dispatcher
-	 */
-	public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
-		$this->repairSteps = $repairSteps;
-		$this->dispatcher = $dispatcher;
-	}
-
-	/**
-	 * Run a series of repair steps for common problems
-	 */
-	public function run() {
-		if (count($this->repairSteps) === 0) {
-			$this->emit('\OC\Repair', 'info', array('No repair steps available'));
-			return;
-		}
-		// run each repair step
-		foreach ($this->repairSteps as $step) {
-			$this->currentStep = $step->getName();
-			$this->emit('\OC\Repair', 'step', [$this->currentStep]);
-			$step->run($this);
-		}
-	}
-
-	/**
-	 * Add repair step
-	 *
-	 * @param IRepairStep|string $repairStep repair step
-	 * @throws \Exception
-	 */
-	public function addStep($repairStep) {
-		if (is_string($repairStep)) {
-			try {
-				$s = \OC::$server->query($repairStep);
-			} catch (QueryException $e) {
-				if (class_exists($repairStep)) {
-					$s = new $repairStep();
-				} else {
-					throw new \Exception("Repair step '$repairStep' is unknown");
-				}
-			}
-
-			if ($s instanceof IRepairStep) {
-				$this->repairSteps[] = $s;
-			} else {
-				throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
-			}
-		} else {
-			$this->repairSteps[] = $repairStep;
-		}
-	}
-
-	/**
-	 * Returns the default repair steps to be run on the
-	 * command line or after an upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getRepairSteps() {
-		return [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
-			new RepairMimeTypes(\OC::$server->getConfig()),
-			new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
-			new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
-			new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
-			new MoveUpdaterStepFile(\OC::$server->getConfig()),
-			new MoveAvatars(
-				\OC::$server->getJobList(),
-				\OC::$server->getConfig()
-			),
-			new CleanPreviews(
-				\OC::$server->getJobList(),
-				\OC::$server->getUserManager(),
-				\OC::$server->getConfig()
-			),
-			new FixMountStorages(\OC::$server->getDatabaseConnection()),
-			new UpdateLanguageCodes(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
-			new InstallCoreBundle(
-				\OC::$server->query(BundleFetcher::class),
-				\OC::$server->getConfig(),
-				\OC::$server->query(Installer::class)
-			),
-			new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig())
-		];
-	}
-
-	/**
-	 * Returns expensive repair steps to be run on the
-	 * command line with a special option.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getExpensiveRepairSteps() {
-		return [
-			new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager())
-		];
-	}
-
-	/**
-	 * Returns the repair steps to be run before an
-	 * upgrade.
-	 *
-	 * @return IRepairStep[]
-	 */
-	public static function getBeforeUpgradeRepairSteps() {
-		$connection = \OC::$server->getDatabaseConnection();
-		$config = \OC::$server->getConfig();
-		$steps = [
-			new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
-			new SqliteAutoincrement($connection),
-			new SaveAccountsTableData($connection, $config),
-		];
-
-		return $steps;
-	}
-
-	/**
-	 * @param string $scope
-	 * @param string $method
-	 * @param array $arguments
-	 */
-	public function emit($scope, $method, array $arguments = []) {
-		if (!is_null($this->dispatcher)) {
-			$this->dispatcher->dispatch("$scope::$method",
-				new GenericEvent("$scope::$method", $arguments));
-		}
-	}
-
-	public function info($string) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'info', array($string));
-	}
-
-	/**
-	 * @param string $message
-	 */
-	public function warning($message) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'warning', [$message]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function startProgress($max = 0) {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
-	}
-
-	/**
-	 * @param int $step
-	 * @param string $description
-	 */
-	public function advance($step = 1, $description = '') {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'advance', [$step, $description]);
-	}
-
-	/**
-	 * @param int $max
-	 */
-	public function finishProgress() {
-		// for now just emit as we did in the past
-		$this->emit('\OC\Repair', 'finishProgress', []);
-	}
+    /* @var IRepairStep[] */
+    private $repairSteps;
+    /** @var EventDispatcher */
+    private $dispatcher;
+    /** @var string */
+    private $currentStep;
+
+    /**
+     * Creates a new repair step runner
+     *
+     * @param IRepairStep[] $repairSteps array of RepairStep instances
+     * @param EventDispatcher $dispatcher
+     */
+    public function __construct($repairSteps = [], EventDispatcher $dispatcher = null) {
+        $this->repairSteps = $repairSteps;
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * Run a series of repair steps for common problems
+     */
+    public function run() {
+        if (count($this->repairSteps) === 0) {
+            $this->emit('\OC\Repair', 'info', array('No repair steps available'));
+            return;
+        }
+        // run each repair step
+        foreach ($this->repairSteps as $step) {
+            $this->currentStep = $step->getName();
+            $this->emit('\OC\Repair', 'step', [$this->currentStep]);
+            $step->run($this);
+        }
+    }
+
+    /**
+     * Add repair step
+     *
+     * @param IRepairStep|string $repairStep repair step
+     * @throws \Exception
+     */
+    public function addStep($repairStep) {
+        if (is_string($repairStep)) {
+            try {
+                $s = \OC::$server->query($repairStep);
+            } catch (QueryException $e) {
+                if (class_exists($repairStep)) {
+                    $s = new $repairStep();
+                } else {
+                    throw new \Exception("Repair step '$repairStep' is unknown");
+                }
+            }
+
+            if ($s instanceof IRepairStep) {
+                $this->repairSteps[] = $s;
+            } else {
+                throw new \Exception("Repair step '$repairStep' is not of type \\OCP\\Migration\\IRepairStep");
+            }
+        } else {
+            $this->repairSteps[] = $repairStep;
+        }
+    }
+
+    /**
+     * Returns the default repair steps to be run on the
+     * command line or after an upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getRepairSteps() {
+        return [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), \OC::$server->getDatabaseConnection(), false),
+            new RepairMimeTypes(\OC::$server->getConfig()),
+            new CleanTags(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager()),
+            new RepairInvalidShares(\OC::$server->getConfig(), \OC::$server->getDatabaseConnection()),
+            new RemoveRootShares(\OC::$server->getDatabaseConnection(), \OC::$server->getUserManager(), \OC::$server->getLazyRootFolder()),
+            new MoveUpdaterStepFile(\OC::$server->getConfig()),
+            new MoveAvatars(
+                \OC::$server->getJobList(),
+                \OC::$server->getConfig()
+            ),
+            new CleanPreviews(
+                \OC::$server->getJobList(),
+                \OC::$server->getUserManager(),
+                \OC::$server->getConfig()
+            ),
+            new FixMountStorages(\OC::$server->getDatabaseConnection()),
+            new UpdateLanguageCodes(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
+            new InstallCoreBundle(
+                \OC::$server->query(BundleFetcher::class),
+                \OC::$server->getConfig(),
+                \OC::$server->query(Installer::class)
+            ),
+            new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig())
+        ];
+    }
+
+    /**
+     * Returns expensive repair steps to be run on the
+     * command line with a special option.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getExpensiveRepairSteps() {
+        return [
+            new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager())
+        ];
+    }
+
+    /**
+     * Returns the repair steps to be run before an
+     * upgrade.
+     *
+     * @return IRepairStep[]
+     */
+    public static function getBeforeUpgradeRepairSteps() {
+        $connection = \OC::$server->getDatabaseConnection();
+        $config = \OC::$server->getConfig();
+        $steps = [
+            new Collation(\OC::$server->getConfig(), \OC::$server->getLogger(), $connection, true),
+            new SqliteAutoincrement($connection),
+            new SaveAccountsTableData($connection, $config),
+        ];
+
+        return $steps;
+    }
+
+    /**
+     * @param string $scope
+     * @param string $method
+     * @param array $arguments
+     */
+    public function emit($scope, $method, array $arguments = []) {
+        if (!is_null($this->dispatcher)) {
+            $this->dispatcher->dispatch("$scope::$method",
+                new GenericEvent("$scope::$method", $arguments));
+        }
+    }
+
+    public function info($string) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'info', array($string));
+    }
+
+    /**
+     * @param string $message
+     */
+    public function warning($message) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'warning', [$message]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function startProgress($max = 0) {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'startProgress', [$max, $this->currentStep]);
+    }
+
+    /**
+     * @param int $step
+     * @param string $description
+     */
+    public function advance($step = 1, $description = '') {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'advance', [$step, $description]);
+    }
+
+    /**
+     * @param int $max
+     */
+    public function finishProgress() {
+        // for now just emit as we did in the past
+        $this->emit('\OC\Repair', 'finishProgress', []);
+    }
 }