123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641 |
- <?php
- use bantu\IniGetWrapper\IniGetWrapper;
- use OC\Files\FilenameValidator;
- use OC\Files\Filesystem;
- use OCP\Files\Mount\IMountPoint;
- use OCP\IBinaryFinder;
- use OCP\ICacheFactory;
- use OCP\IUser;
- use OCP\Util;
- use Psr\Log\LoggerInterface;
- class OC_Helper {
- private static $templateManager;
- private static ?ICacheFactory $cacheFactory = null;
- private static ?bool $quotaIncludeExternalStorage = null;
-
- public static function humanFileSize(int|float $bytes): string {
- 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";
- }
-
- public static function computerFileSize(string $str): false|int|float {
- $str = strtolower($str);
- if (is_numeric($str)) {
- return Util::numericToNumber($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) && isset($bytes_array[$matches[1]])) {
- $bytes *= $bytes_array[$matches[1]];
- } else {
- return false;
- }
- return Util::numericToNumber(round($bytes));
- }
-
- public static function copyr($src, $dest) {
- if (!file_exists($src)) {
- return;
- }
- 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");
- }
- }
- } else {
- $validator = \OCP\Server::get(FilenameValidator::class);
- if (!$validator->isForbidden($src)) {
- copy($src, $dest);
- }
- }
- }
-
- 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) {
-
- 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);
- }
-
- public static function getFileTemplateManager() {
- if (!self::$templateManager) {
- self::$templateManager = new \OC\Files\Type\TemplateManager();
- }
- return self::$templateManager;
- }
-
- public static function canExecute($name, $path = false) {
-
- if ($path === false) {
- $path = getenv('PATH');
- }
-
- $exts = [''];
- $check_fn = 'is_executable';
-
- $dirs = explode(PATH_SEPARATOR, $path);
-
- $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]) {
-
-
- $dirs = $obd_values;
- }
- }
- foreach ($dirs as $dir) {
- foreach ($exts as $ext) {
- if ($check_fn("$dir/$name" . $ext)) {
- return true;
- }
- }
- }
- return false;
- }
-
- 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;
- }
-
-
- if ($bytesWritten === false
- || ($bytesWritten < $bufSize && $bytesWritten < strlen($buf))
- ) {
-
- $result = false;
- break;
- }
- }
- return [$count, $result];
- }
-
- public static function buildNotExistingFileName($path, $filename) {
- $view = \OC\Files\Filesystem::getView();
- return self::buildNotExistingFileNameForView($path, $filename, $view);
- }
-
- 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)) {
-
- $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) {
-
- $newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
- } else {
- $newname = $name . ' (' . $counter . ')';
- }
- $newpath = $path . '/' . $newname . $ext;
- $counter++;
- } while ($view->file_exists($newpath));
- }
- return $newpath;
- }
-
- 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;
- }
-
- 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;
- }
-
- public static function maxUploadFilesize($dir, $freeSpace = null) {
- if (is_null($freeSpace) || $freeSpace < 0) {
- $freeSpace = self::freeSpace($dir);
- }
- return min($freeSpace, self::uploadLimit());
- }
-
- 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;
- }
- }
-
- public static function uploadLimit() {
- $ini = \OC::$server->get(IniGetWrapper::class);
- $upload_max_filesize = Util::computerFileSize($ini->get('upload_max_filesize')) ?: 0;
- $post_max_size = Util::computerFileSize($ini->get('post_max_size')) ?: 0;
- if ($upload_max_filesize === 0 && $post_max_size === 0) {
- return INF;
- } elseif ($upload_max_filesize === 0 || $post_max_size === 0) {
- return max($upload_max_filesize, $post_max_size);
- } else {
- return min($upload_max_filesize, $post_max_size);
- }
- }
-
- public static function is_function_enabled(string $function_name): bool {
- return \OCP\Util::isFunctionEnabled($function_name);
- }
-
- public static function findBinaryPath(string $program): ?string {
- $result = \OCP\Server::get(IBinaryFinder::class)->findBinaryPath($program);
- return $result !== false ? $result : null;
- }
-
- public static function getStorageInfo($path, $rootInfo = null, $includeMountPoints = true, $useCache = true) {
- if (!self::$cacheFactory) {
- self::$cacheFactory = \OC::$server->get(ICacheFactory::class);
- }
- $memcache = self::$cacheFactory->createLocal('storage_info');
-
- if (self::$quotaIncludeExternalStorage === null) {
- self::$quotaIncludeExternalStorage = \OC::$server->getSystemConfig()->getValue('quota_include_external_storage', false);
- }
- $view = Filesystem::getView();
- if (!$view) {
- throw new \OCP\Files\NotFoundException();
- }
- $fullPath = Filesystem::normalizePath($view->getAbsolutePath($path));
- $cacheKey = $fullPath . '::' . ($includeMountPoints ? 'include' : 'exclude');
- if ($useCache) {
- $cached = $memcache->get($cacheKey);
- if ($cached) {
- return $cached;
- }
- }
- if (!$rootInfo) {
- $rootInfo = \OC\Files\Filesystem::getFileInfo($path, self::$quotaIncludeExternalStorage ? 'ext' : false);
- }
- if (!$rootInfo instanceof \OCP\Files\FileInfo) {
- throw new \OCP\Files\NotFoundException('The root directory of the user\'s files is missing');
- }
- $used = $rootInfo->getSize($includeMountPoints);
- if ($used < 0) {
- $used = 0.0;
- }
-
- $quota = \OCP\Files\FileInfo::SPACE_UNLIMITED;
- $mount = $rootInfo->getMountPoint();
- $storage = $mount->getStorage();
- $sourceStorage = $storage;
- if ($storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
- self::$quotaIncludeExternalStorage = false;
- }
- if (self::$quotaIncludeExternalStorage) {
- if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
- || $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
- ) {
-
- $user = $storage->getUser();
- } else {
- $user = \OC::$server->getUserSession()->getUser();
- }
- $quota = OC_Util::getUserQuota($user);
- if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-
- return self::getGlobalStorageInfo($quota, $user, $mount);
- }
- }
-
- if ($sourceStorage->instanceOfStorage('\OC\Files\Storage\Wrapper\Quota')) {
-
- $quota = $sourceStorage->getQuota();
- }
- try {
- $free = $sourceStorage->free_space($rootInfo->getInternalPath());
- if (is_bool($free)) {
- $free = 0.0;
- }
- } catch (\Exception $e) {
- if ($path === '') {
- throw $e;
- }
-
- $logger = \OC::$server->get(LoggerInterface::class);
- $logger->warning('Error while getting quota info, using root quota', ['exception' => $e]);
- $rootInfo = self::getStorageInfo('');
- $memcache->set($cacheKey, $rootInfo, 5 * 60);
- return $rootInfo;
- }
- if ($free >= 0) {
- $total = $free + $used;
- } else {
- $total = $free;
- }
- if ($total > 0) {
- if ($quota > 0 && $total > $quota) {
- $total = $quota;
- }
-
- $relative = round(($used / $total) * 10000) / 100;
- } else {
- $relative = 0;
- }
- $ownerId = $storage->getOwner($path);
- $ownerDisplayName = '';
- if ($ownerId !== false) {
- $ownerDisplayName = \OC::$server->getUserManager()->getDisplayName($ownerId) ?? '';
- }
- if (substr_count($mount->getMountPoint(), '/') < 3) {
- $mountPoint = '';
- } else {
- [,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
- }
- $info = [
- 'free' => $free,
- 'used' => $used,
- 'quota' => $quota,
- 'total' => $total,
- 'relative' => $relative,
- 'owner' => $ownerId,
- 'ownerDisplayName' => $ownerDisplayName,
- 'mountType' => $mount->getMountType(),
- 'mountPoint' => trim($mountPoint, '/'),
- ];
- if ($ownerId && $path === '/') {
-
- \OCP\Server::get(\OCP\IConfig::class)->setUserValue($ownerId, 'files', 'lastSeenQuotaUsage', (string)$relative);
- }
- $memcache->set($cacheKey, $info, 5 * 60);
- return $info;
- }
-
- private static function getGlobalStorageInfo(int|float $quota, IUser $user, IMountPoint $mount): array {
- $rootInfo = \OC\Files\Filesystem::getFileInfo('', 'ext');
-
- $used = $rootInfo['size'];
- if ($used < 0) {
- $used = 0.0;
- }
- $total = $quota;
-
- $free = $quota - $used;
- if ($total > 0) {
- if ($quota > 0 && $total > $quota) {
- $total = $quota;
- }
-
- $relative = round(($used / $total) * 10000) / 100;
- } else {
- $relative = 0.0;
- }
- if (substr_count($mount->getMountPoint(), '/') < 3) {
- $mountPoint = '';
- } else {
- [,,,$mountPoint] = explode('/', $mount->getMountPoint(), 4);
- }
- return [
- 'free' => $free,
- 'used' => $used,
- 'total' => $total,
- 'relative' => $relative,
- 'quota' => $quota,
- 'owner' => $user->getUID(),
- 'ownerDisplayName' => $user->getDisplayName(),
- 'mountType' => $mount->getMountType(),
- 'mountPoint' => trim($mountPoint, '/'),
- ];
- }
- public static function clearStorageInfo(string $absolutePath): void {
-
- $cacheFactory = \OC::$server->get(ICacheFactory::class);
- $memcache = $cacheFactory->createLocal('storage_info');
- $cacheKeyPrefix = Filesystem::normalizePath($absolutePath) . '::';
- $memcache->remove($cacheKeyPrefix . 'include');
- $memcache->remove($cacheKeyPrefix . 'exclude');
- }
-
- public static function isReadOnlyConfigEnabled() {
- return \OC::$server->getConfig()->getSystemValueBool('config_is_read_only', false);
- }
- }
|