nextcloud / server

lib/private/legacy/OC_Helper.php

Indentation +552 added lines, -552 removed lines

@@ -50,556 +50,556 @@
  * Collection of useful functions
  */
 class OC_Helper {
-	private static $templateManager;
-
-	/**
-	 * 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 computer file size
-	 * @param string $str file size in human readable format
-	 * @return float|bool 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 (float)$str;
-		}
-
-		$bytes_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 = (float)$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
-	 *
-	 */
-	public 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
-	 */
-	public 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());
-				} elseif ($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);
-	}
-
-	/**
-	 * @deprecated 18.0.0
-	 * @return \OC\Files\Type\TemplateManager
-	 */
-	public static 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->get(IniGetWrapper::class)->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 [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 [$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 = [];
-		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 mixed $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->get(IniGetWrapper::class);
-		$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->get(IniGetWrapper::class);
-		$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()->createDistributed('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, null, ['/usr/local/sbin', '/usr/local/bin', '/usr/sbin', '/usr/bin', '/sbin', '/bin', '/opt/bin']);
-		}
-		// 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;
-		$mount = $rootInfo->getMountPoint();
-		$storage = $mount->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();
-			}
-			$quota = OC_Util::getUserQuota($user);
-			if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				// always get free space / total space from root + mount points
-				return self::getGlobalStorageInfo($quota);
-			}
-		}
-
-		// 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();
-		}
-		[,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
-
-		return [
-			'free' => $free,
-			'used' => $used,
-			'quota' => $quota,
-			'total' => $total,
-			'relative' => $relative,
-			'owner' => $ownerId,
-			'ownerDisplayName' => $ownerDisplayName,
-			'mountType' => $mount->getMountType(),
-			'mountPoint' => trim($mountPoint, '/'),
-		];
-	}
-
-	/**
-	 * Get storage info including all mount points and quota
-	 *
-	 * @param int $quota
-	 * @return array
-	 */
-	private static function getGlobalStorageInfo($quota) {
-		$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 [
-			'free' => $free,
-			'used' => $used,
-			'total' => $total,
-			'relative' => $relative,
-			'quota' => $quota
-		];
-	}
-
-	/**
-	 * 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;
+
+    /**
+     * 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 computer file size
+     * @param string $str file size in human readable format
+     * @return float|bool 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 (float)$str;
+        }
+
+        $bytes_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 = (float)$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
+     *
+     */
+    public 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
+     */
+    public 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());
+                } elseif ($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);
+    }
+
+    /**
+     * @deprecated 18.0.0
+     * @return \OC\Files\Type\TemplateManager
+     */
+    public static 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->get(IniGetWrapper::class)->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 [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 [$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 = [];
+        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 mixed $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->get(IniGetWrapper::class);
+        $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->get(IniGetWrapper::class);
+        $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()->createDistributed('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, null, ['/usr/local/sbin', '/usr/local/bin', '/usr/sbin', '/usr/bin', '/sbin', '/bin', '/opt/bin']);
+        }
+        // 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;
+        $mount = $rootInfo->getMountPoint();
+        $storage = $mount->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();
+            }
+            $quota = OC_Util::getUserQuota($user);
+            if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                // always get free space / total space from root + mount points
+                return self::getGlobalStorageInfo($quota);
+            }
+        }
+
+        // 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();
+        }
+        [,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
+
+        return [
+            'free' => $free,
+            'used' => $used,
+            'quota' => $quota,
+            'total' => $total,
+            'relative' => $relative,
+            'owner' => $ownerId,
+            'ownerDisplayName' => $ownerDisplayName,
+            'mountType' => $mount->getMountType(),
+            'mountPoint' => trim($mountPoint, '/'),
+        ];
+    }
+
+    /**
+     * Get storage info including all mount points and quota
+     *
+     * @param int $quota
+     * @return array
+     */
+    private static function getGlobalStorageInfo($quota) {
+        $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 [
+            'free' => $free,
+            'used' => $used,
+            'total' => $total,
+            'relative' => $relative,
+            'quota' => $quota
+        ];
+    }
+
+    /**
+     * 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);
+    }
 }

apps/files/lib/Helper.php

Indentation +210 added lines, -210 removed lines

@@ -41,233 +41,233 @@
  * Helper class for manipulating file information
  */
 class Helper {
-	/**
-	 * @param string $dir
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	public static function buildFileStorageStatistics($dir) {
-		// information about storage capacities
-		$storageInfo = \OC_Helper::getStorageInfo($dir);
-		$l = \OC::$server->getL10N('files');
-		$maxUploadFileSize = \OCP\Util::maxUploadFilesize($dir, $storageInfo['free']);
-		$maxHumanFileSize = \OCP\Util::humanFileSize($maxUploadFileSize);
-		$maxHumanFileSize = $l->t('Upload (max. %s)', [$maxHumanFileSize]);
+    /**
+     * @param string $dir
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    public static function buildFileStorageStatistics($dir) {
+        // information about storage capacities
+        $storageInfo = \OC_Helper::getStorageInfo($dir);
+        $l = \OC::$server->getL10N('files');
+        $maxUploadFileSize = \OCP\Util::maxUploadFilesize($dir, $storageInfo['free']);
+        $maxHumanFileSize = \OCP\Util::humanFileSize($maxUploadFileSize);
+        $maxHumanFileSize = $l->t('Upload (max. %s)', [$maxHumanFileSize]);
 
-		return [
-			'uploadMaxFilesize' => $maxUploadFileSize,
-			'maxHumanFilesize'  => $maxHumanFileSize,
-			'freeSpace' => $storageInfo['free'],
-			'quota' => $storageInfo['quota'],
-			'used' => $storageInfo['used'],
-			'usedSpacePercent'  => (int)$storageInfo['relative'],
-			'owner' => $storageInfo['owner'],
-			'ownerDisplayName' => $storageInfo['ownerDisplayName'],
-			'mountType' => $storageInfo['mountType'],
-			'mountPoint' => $storageInfo['mountPoint'],
-		];
-	}
+        return [
+            'uploadMaxFilesize' => $maxUploadFileSize,
+            'maxHumanFilesize'  => $maxHumanFileSize,
+            'freeSpace' => $storageInfo['free'],
+            'quota' => $storageInfo['quota'],
+            'used' => $storageInfo['used'],
+            'usedSpacePercent'  => (int)$storageInfo['relative'],
+            'owner' => $storageInfo['owner'],
+            'ownerDisplayName' => $storageInfo['ownerDisplayName'],
+            'mountType' => $storageInfo['mountType'],
+            'mountPoint' => $storageInfo['mountPoint'],
+        ];
+    }
 
-	/**
-	 * Determine icon for a given file
-	 *
-	 * @param \OCP\Files\FileInfo $file file info
-	 * @return string icon URL
-	 */
-	public static function determineIcon($file) {
-		if ($file['type'] === 'dir') {
-			$icon = \OC::$server->getMimeTypeDetector()->mimeTypeIcon('dir');
-			// TODO: move this part to the client side, using mountType
-			if ($file->isShared()) {
-				$icon = \OC::$server->getMimeTypeDetector()->mimeTypeIcon('dir-shared');
-			} elseif ($file->isMounted()) {
-				$icon = \OC::$server->getMimeTypeDetector()->mimeTypeIcon('dir-external');
-			}
-		} else {
-			$icon = \OC::$server->getMimeTypeDetector()->mimeTypeIcon($file->getMimetype());
-		}
+    /**
+     * Determine icon for a given file
+     *
+     * @param \OCP\Files\FileInfo $file file info
+     * @return string icon URL
+     */
+    public static function determineIcon($file) {
+        if ($file['type'] === 'dir') {
+            $icon = \OC::$server->getMimeTypeDetector()->mimeTypeIcon('dir');
+            // TODO: move this part to the client side, using mountType
+            if ($file->isShared()) {
+                $icon = \OC::$server->getMimeTypeDetector()->mimeTypeIcon('dir-shared');
+            } elseif ($file->isMounted()) {
+                $icon = \OC::$server->getMimeTypeDetector()->mimeTypeIcon('dir-external');
+            }
+        } else {
+            $icon = \OC::$server->getMimeTypeDetector()->mimeTypeIcon($file->getMimetype());
+        }
 
-		return substr($icon, 0, -3) . 'svg';
-	}
+        return substr($icon, 0, -3) . 'svg';
+    }
 
-	/**
-	 * Comparator function to sort files alphabetically and have
-	 * the directories appear first
-	 *
-	 * @param \OCP\Files\FileInfo $a file
-	 * @param \OCP\Files\FileInfo $b file
-	 * @return int -1 if $a must come before $b, 1 otherwise
-	 */
-	public static function compareFileNames(FileInfo $a, FileInfo $b) {
-		$aType = $a->getType();
-		$bType = $b->getType();
-		if ($aType === 'dir' and $bType !== 'dir') {
-			return -1;
-		} elseif ($aType !== 'dir' and $bType === 'dir') {
-			return 1;
-		} else {
-			return \OCP\Util::naturalSortCompare($a->getName(), $b->getName());
-		}
-	}
+    /**
+     * Comparator function to sort files alphabetically and have
+     * the directories appear first
+     *
+     * @param \OCP\Files\FileInfo $a file
+     * @param \OCP\Files\FileInfo $b file
+     * @return int -1 if $a must come before $b, 1 otherwise
+     */
+    public static function compareFileNames(FileInfo $a, FileInfo $b) {
+        $aType = $a->getType();
+        $bType = $b->getType();
+        if ($aType === 'dir' and $bType !== 'dir') {
+            return -1;
+        } elseif ($aType !== 'dir' and $bType === 'dir') {
+            return 1;
+        } else {
+            return \OCP\Util::naturalSortCompare($a->getName(), $b->getName());
+        }
+    }
 
-	/**
-	 * Comparator function to sort files by date
-	 *
-	 * @param \OCP\Files\FileInfo $a file
-	 * @param \OCP\Files\FileInfo $b file
-	 * @return int -1 if $a must come before $b, 1 otherwise
-	 */
-	public static function compareTimestamp(FileInfo $a, FileInfo $b) {
-		$aTime = $a->getMTime();
-		$bTime = $b->getMTime();
-		return ($aTime < $bTime) ? -1 : 1;
-	}
+    /**
+     * Comparator function to sort files by date
+     *
+     * @param \OCP\Files\FileInfo $a file
+     * @param \OCP\Files\FileInfo $b file
+     * @return int -1 if $a must come before $b, 1 otherwise
+     */
+    public static function compareTimestamp(FileInfo $a, FileInfo $b) {
+        $aTime = $a->getMTime();
+        $bTime = $b->getMTime();
+        return ($aTime < $bTime) ? -1 : 1;
+    }
 
-	/**
-	 * Comparator function to sort files by size
-	 *
-	 * @param \OCP\Files\FileInfo $a file
-	 * @param \OCP\Files\FileInfo $b file
-	 * @return int -1 if $a must come before $b, 1 otherwise
-	 */
-	public static function compareSize(FileInfo $a, FileInfo $b) {
-		$aSize = $a->getSize();
-		$bSize = $b->getSize();
-		return ($aSize < $bSize) ? -1 : 1;
-	}
+    /**
+     * Comparator function to sort files by size
+     *
+     * @param \OCP\Files\FileInfo $a file
+     * @param \OCP\Files\FileInfo $b file
+     * @return int -1 if $a must come before $b, 1 otherwise
+     */
+    public static function compareSize(FileInfo $a, FileInfo $b) {
+        $aSize = $a->getSize();
+        $bSize = $b->getSize();
+        return ($aSize < $bSize) ? -1 : 1;
+    }
 
-	/**
-	 * Formats the file info to be returned as JSON to the client.
-	 *
-	 * @param \OCP\Files\FileInfo $i
-	 * @return array formatted file info
-	 */
-	public static function formatFileInfo(FileInfo $i) {
-		$entry = [];
+    /**
+     * Formats the file info to be returned as JSON to the client.
+     *
+     * @param \OCP\Files\FileInfo $i
+     * @return array formatted file info
+     */
+    public static function formatFileInfo(FileInfo $i) {
+        $entry = [];
 
-		$entry['id'] = $i['fileid'];
-		$entry['parentId'] = $i['parent'];
-		$entry['mtime'] = $i['mtime'] * 1000;
-		// only pick out the needed attributes
-		$entry['name'] = $i->getName();
-		$entry['permissions'] = $i['permissions'];
-		$entry['mimetype'] = $i['mimetype'];
-		$entry['size'] = $i['size'];
-		$entry['type'] = $i['type'];
-		$entry['etag'] = $i['etag'];
-		if (isset($i['tags'])) {
-			$entry['tags'] = $i['tags'];
-		}
-		if (isset($i['displayname_owner'])) {
-			$entry['shareOwner'] = $i['displayname_owner'];
-		}
-		if (isset($i['is_share_mount_point'])) {
-			$entry['isShareMountPoint'] = $i['is_share_mount_point'];
-		}
-		$mountType = null;
-		$mount = $i->getMountPoint();
-		$mountType = $mount->getMountType();
-		if ($mountType !== '') {
-			if ($i->getInternalPath() === '') {
-				$mountType .= '-root';
-			}
-			$entry['mountType'] = $mountType;
-		}
-		if (isset($i['extraData'])) {
-			$entry['extraData'] = $i['extraData'];
-		}
-		return $entry;
-	}
+        $entry['id'] = $i['fileid'];
+        $entry['parentId'] = $i['parent'];
+        $entry['mtime'] = $i['mtime'] * 1000;
+        // only pick out the needed attributes
+        $entry['name'] = $i->getName();
+        $entry['permissions'] = $i['permissions'];
+        $entry['mimetype'] = $i['mimetype'];
+        $entry['size'] = $i['size'];
+        $entry['type'] = $i['type'];
+        $entry['etag'] = $i['etag'];
+        if (isset($i['tags'])) {
+            $entry['tags'] = $i['tags'];
+        }
+        if (isset($i['displayname_owner'])) {
+            $entry['shareOwner'] = $i['displayname_owner'];
+        }
+        if (isset($i['is_share_mount_point'])) {
+            $entry['isShareMountPoint'] = $i['is_share_mount_point'];
+        }
+        $mountType = null;
+        $mount = $i->getMountPoint();
+        $mountType = $mount->getMountType();
+        if ($mountType !== '') {
+            if ($i->getInternalPath() === '') {
+                $mountType .= '-root';
+            }
+            $entry['mountType'] = $mountType;
+        }
+        if (isset($i['extraData'])) {
+            $entry['extraData'] = $i['extraData'];
+        }
+        return $entry;
+    }
 
-	/**
-	 * Format file info for JSON
-	 * @param \OCP\Files\FileInfo[] $fileInfos file infos
-	 * @return array
-	 */
-	public static function formatFileInfos($fileInfos) {
-		$files = [];
-		foreach ($fileInfos as $i) {
-			$files[] = self::formatFileInfo($i);
-		}
+    /**
+     * Format file info for JSON
+     * @param \OCP\Files\FileInfo[] $fileInfos file infos
+     * @return array
+     */
+    public static function formatFileInfos($fileInfos) {
+        $files = [];
+        foreach ($fileInfos as $i) {
+            $files[] = self::formatFileInfo($i);
+        }
 
-		return $files;
-	}
+        return $files;
+    }
 
-	/**
-	 * Retrieves the contents of the given directory and
-	 * returns it as a sorted array of FileInfo.
-	 *
-	 * @param string $dir path to the directory
-	 * @param string $sortAttribute attribute to sort on
-	 * @param bool $sortDescending true for descending sort, false otherwise
-	 * @param string $mimetypeFilter limit returned content to this mimetype or mimepart
-	 * @return \OCP\Files\FileInfo[] files
-	 */
-	public static function getFiles($dir, $sortAttribute = 'name', $sortDescending = false, $mimetypeFilter = '') {
-		$content = \OC\Files\Filesystem::getDirectoryContent($dir, $mimetypeFilter);
+    /**
+     * Retrieves the contents of the given directory and
+     * returns it as a sorted array of FileInfo.
+     *
+     * @param string $dir path to the directory
+     * @param string $sortAttribute attribute to sort on
+     * @param bool $sortDescending true for descending sort, false otherwise
+     * @param string $mimetypeFilter limit returned content to this mimetype or mimepart
+     * @return \OCP\Files\FileInfo[] files
+     */
+    public static function getFiles($dir, $sortAttribute = 'name', $sortDescending = false, $mimetypeFilter = '') {
+        $content = \OC\Files\Filesystem::getDirectoryContent($dir, $mimetypeFilter);
 
-		return self::sortFiles($content, $sortAttribute, $sortDescending);
-	}
+        return self::sortFiles($content, $sortAttribute, $sortDescending);
+    }
 
-	/**
-	 * Populate the result set with file tags
-	 *
-	 * @param array $fileList
-	 * @param string $fileIdentifier identifier attribute name for values in $fileList
-	 * @param ITagManager $tagManager
-	 * @return array file list populated with tags
-	 */
-	public static function populateTags(array $fileList, $fileIdentifier = 'fileid', ITagManager $tagManager) {
-		$ids = [];
-		foreach ($fileList as $fileData) {
-			$ids[] = $fileData[$fileIdentifier];
-		}
-		$tagger = $tagManager->load('files');
-		$tags = $tagger->getTagsForObjects($ids);
+    /**
+     * Populate the result set with file tags
+     *
+     * @param array $fileList
+     * @param string $fileIdentifier identifier attribute name for values in $fileList
+     * @param ITagManager $tagManager
+     * @return array file list populated with tags
+     */
+    public static function populateTags(array $fileList, $fileIdentifier = 'fileid', ITagManager $tagManager) {
+        $ids = [];
+        foreach ($fileList as $fileData) {
+            $ids[] = $fileData[$fileIdentifier];
+        }
+        $tagger = $tagManager->load('files');
+        $tags = $tagger->getTagsForObjects($ids);
 
-		if (!is_array($tags)) {
-			throw new \UnexpectedValueException('$tags must be an array');
-		}
+        if (!is_array($tags)) {
+            throw new \UnexpectedValueException('$tags must be an array');
+        }
 
-		// Set empty tag array
-		foreach ($fileList as $key => $fileData) {
-			$fileList[$key]['tags'] = [];
-		}
+        // Set empty tag array
+        foreach ($fileList as $key => $fileData) {
+            $fileList[$key]['tags'] = [];
+        }
 
-		if (!empty($tags)) {
-			foreach ($tags as $fileId => $fileTags) {
-				foreach ($fileList as $key => $fileData) {
-					if ($fileId !== $fileData[$fileIdentifier]) {
-						continue;
-					}
+        if (!empty($tags)) {
+            foreach ($tags as $fileId => $fileTags) {
+                foreach ($fileList as $key => $fileData) {
+                    if ($fileId !== $fileData[$fileIdentifier]) {
+                        continue;
+                    }
 
-					$fileList[$key]['tags'] = $fileTags;
-				}
-			}
-		}
+                    $fileList[$key]['tags'] = $fileTags;
+                }
+            }
+        }
 
-		return $fileList;
-	}
+        return $fileList;
+    }
 
-	/**
-	 * Sort the given file info array
-	 *
-	 * @param \OCP\Files\FileInfo[] $files files to sort
-	 * @param string $sortAttribute attribute to sort on
-	 * @param bool $sortDescending true for descending sort, false otherwise
-	 * @return \OCP\Files\FileInfo[] sorted files
-	 */
-	public static function sortFiles($files, $sortAttribute = 'name', $sortDescending = false) {
-		$sortFunc = 'compareFileNames';
-		if ($sortAttribute === 'mtime') {
-			$sortFunc = 'compareTimestamp';
-		} elseif ($sortAttribute === 'size') {
-			$sortFunc = 'compareSize';
-		}
-		usort($files, [Helper::class, $sortFunc]);
-		if ($sortDescending) {
-			$files = array_reverse($files);
-		}
-		return $files;
-	}
+    /**
+     * Sort the given file info array
+     *
+     * @param \OCP\Files\FileInfo[] $files files to sort
+     * @param string $sortAttribute attribute to sort on
+     * @param bool $sortDescending true for descending sort, false otherwise
+     * @return \OCP\Files\FileInfo[] sorted files
+     */
+    public static function sortFiles($files, $sortAttribute = 'name', $sortDescending = false) {
+        $sortFunc = 'compareFileNames';
+        if ($sortAttribute === 'mtime') {
+            $sortFunc = 'compareTimestamp';
+        } elseif ($sortAttribute === 'size') {
+            $sortFunc = 'compareSize';
+        }
+        usort($files, [Helper::class, $sortFunc]);
+        if ($sortDescending) {
+            $files = array_reverse($files);
+        }
+        return $files;
+    }
 }