123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121 |
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Björn Schießle <bjoern@schiessle.org>
- * @author cmeh <cmeh@users.noreply.github.com>
- * @author Florin Peter <github@florin-peter.de>
- * @author Jesús Macias <jmacias@solidgear.es>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author karakayasemi <karakayasemi@itu.edu.tr>
- * @author Klaas Freitag <freitag@owncloud.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Luke Policinski <lpolicinski@gmail.com>
- * @author Martin Mattel <martin.mattel@diemattels.at>
- * @author Michael Gapczynski <GapczynskiM@gmail.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Petr Svoboda <weits666@gmail.com>
- * @author Piotr Filiciak <piotr@filiciak.pl>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Sam Tuke <mail@samtuke.com>
- * @author Stefan Weil <sw@weilnetz.de>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Thomas Tanghus <thomas@tanghus.net>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- namespace OC\Files;
- use Icewind\Streams\CallbackWrapper;
- use OC\Files\Mount\MoveableMount;
- use OC\Files\Storage\Storage;
- use OC\User\User;
- use OCP\Constants;
- use OCP\Files\Cache\ICacheEntry;
- use OCP\Files\EmptyFileNameException;
- use OCP\Files\FileNameTooLongException;
- use OCP\Files\InvalidCharacterInPathException;
- use OCP\Files\InvalidDirectoryException;
- use OCP\Files\InvalidPathException;
- use OCP\Files\Mount\IMountPoint;
- use OCP\Files\NotFoundException;
- use OCP\Files\ReservedWordException;
- use OCP\Files\UnseekableException;
- use OCP\Files\Storage\ILockingStorage;
- use OCP\IUser;
- use OCP\Lock\ILockingProvider;
- use OCP\Lock\LockedException;
- /**
- * Class to provide access to ownCloud filesystem via a "view", and methods for
- * working with files within that view (e.g. read, write, delete, etc.). Each
- * view is restricted to a set of directories via a virtual root. The default view
- * uses the currently logged in user's data directory as root (parts of
- * OC_Filesystem are merely a wrapper for OC\Files\View).
- *
- * Apps that need to access files outside of the user data folders (to modify files
- * belonging to a user other than the one currently logged in, for example) should
- * use this class directly rather than using OC_Filesystem, or making use of PHP's
- * built-in file manipulation functions. This will ensure all hooks and proxies
- * are triggered correctly.
- *
- * Filesystem functions are not called directly; they are passed to the correct
- * \OC\Files\Storage\Storage object
- */
- class View {
- /** @var string */
- private $fakeRoot = '';
- /**
- * @var \OCP\Lock\ILockingProvider
- */
- private $lockingProvider;
- private $lockingEnabled;
- private $updaterEnabled = true;
- private $userManager;
- /**
- * @param string $root
- * @throws \Exception If $root contains an invalid path
- */
- public function __construct($root = '') {
- if (is_null($root)) {
- throw new \InvalidArgumentException('Root can\'t be null');
- }
- if (!Filesystem::isValidPath($root)) {
- throw new \Exception();
- }
- $this->fakeRoot = $root;
- $this->lockingProvider = \OC::$server->getLockingProvider();
- $this->lockingEnabled = !($this->lockingProvider instanceof \OC\Lock\NoopLockingProvider);
- $this->userManager = \OC::$server->getUserManager();
- }
- public function getAbsolutePath($path = '/') {
- if ($path === null) {
- return null;
- }
- $this->assertPathLength($path);
- if ($path === '') {
- $path = '/';
- }
- if ($path[0] !== '/') {
- $path = '/' . $path;
- }
- return $this->fakeRoot . $path;
- }
- /**
- * change the root to a fake root
- *
- * @param string $fakeRoot
- * @return boolean|null
- */
- public function chroot($fakeRoot) {
- if (!$fakeRoot == '') {
- if ($fakeRoot[0] !== '/') {
- $fakeRoot = '/' . $fakeRoot;
- }
- }
- $this->fakeRoot = $fakeRoot;
- }
- /**
- * get the fake root
- *
- * @return string
- */
- public function getRoot() {
- return $this->fakeRoot;
- }
- /**
- * get path relative to the root of the view
- *
- * @param string $path
- * @return string
- */
- public function getRelativePath($path) {
- $this->assertPathLength($path);
- if ($this->fakeRoot == '') {
- return $path;
- }
- if (rtrim($path, '/') === rtrim($this->fakeRoot, '/')) {
- return '/';
- }
- // missing slashes can cause wrong matches!
- $root = rtrim($this->fakeRoot, '/') . '/';
- if (strpos($path, $root) !== 0) {
- return null;
- } else {
- $path = substr($path, strlen($this->fakeRoot));
- if (strlen($path) === 0) {
- return '/';
- } else {
- return $path;
- }
- }
- }
- /**
- * get the mountpoint of the storage object for a path
- * ( note: because a storage is not always mounted inside the fakeroot, the
- * returned mountpoint is relative to the absolute root of the filesystem
- * and does not take the chroot into account )
- *
- * @param string $path
- * @return string
- */
- public function getMountPoint($path) {
- return Filesystem::getMountPoint($this->getAbsolutePath($path));
- }
- /**
- * get the mountpoint of the storage object for a path
- * ( note: because a storage is not always mounted inside the fakeroot, the
- * returned mountpoint is relative to the absolute root of the filesystem
- * and does not take the chroot into account )
- *
- * @param string $path
- * @return \OCP\Files\Mount\IMountPoint
- */
- public function getMount($path) {
- return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
- }
- /**
- * resolve a path to a storage and internal path
- *
- * @param string $path
- * @return array an array consisting of the storage and the internal path
- */
- public function resolvePath($path) {
- $a = $this->getAbsolutePath($path);
- $p = Filesystem::normalizePath($a);
- return Filesystem::resolvePath($p);
- }
- /**
- * return the path to a local version of the file
- * we need this because we can't know if a file is stored local or not from
- * outside the filestorage and for some purposes a local file is needed
- *
- * @param string $path
- * @return string
- */
- public function getLocalFile($path) {
- $parent = substr($path, 0, strrpos($path, '/'));
- $path = $this->getAbsolutePath($path);
- list($storage, $internalPath) = Filesystem::resolvePath($path);
- if (Filesystem::isValidPath($parent) and $storage) {
- return $storage->getLocalFile($internalPath);
- } else {
- return null;
- }
- }
- /**
- * @param string $path
- * @return string
- */
- public function getLocalFolder($path) {
- $parent = substr($path, 0, strrpos($path, '/'));
- $path = $this->getAbsolutePath($path);
- list($storage, $internalPath) = Filesystem::resolvePath($path);
- if (Filesystem::isValidPath($parent) and $storage) {
- return $storage->getLocalFolder($internalPath);
- } else {
- return null;
- }
- }
- /**
- * the following functions operate with arguments and return values identical
- * to those of their PHP built-in equivalents. Mostly they are merely wrappers
- * for \OC\Files\Storage\Storage via basicOperation().
- */
- public function mkdir($path) {
- return $this->basicOperation('mkdir', $path, array('create', 'write'));
- }
- /**
- * remove mount point
- *
- * @param \OC\Files\Mount\MoveableMount $mount
- * @param string $path relative to data/
- * @return boolean
- */
- protected function removeMount($mount, $path) {
- if ($mount instanceof MoveableMount) {
- // cut of /user/files to get the relative path to data/user/files
- $pathParts = explode('/', $path, 4);
- $relPath = '/' . $pathParts[3];
- $this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true);
- \OC_Hook::emit(
- Filesystem::CLASSNAME, "umount",
- array(Filesystem::signal_param_path => $relPath)
- );
- $this->changeLock($relPath, ILockingProvider::LOCK_EXCLUSIVE, true);
- $result = $mount->removeMount();
- $this->changeLock($relPath, ILockingProvider::LOCK_SHARED, true);
- if ($result) {
- \OC_Hook::emit(
- Filesystem::CLASSNAME, "post_umount",
- array(Filesystem::signal_param_path => $relPath)
- );
- }
- $this->unlockFile($relPath, ILockingProvider::LOCK_SHARED, true);
- return $result;
- } else {
- // do not allow deleting the storage's root / the mount point
- // because for some storages it might delete the whole contents
- // but isn't supposed to work that way
- return false;
- }
- }
- public function disableCacheUpdate() {
- $this->updaterEnabled = false;
- }
- public function enableCacheUpdate() {
- $this->updaterEnabled = true;
- }
- protected function writeUpdate(Storage $storage, $internalPath, $time = null) {
- if ($this->updaterEnabled) {
- if (is_null($time)) {
- $time = time();
- }
- $storage->getUpdater()->update($internalPath, $time);
- }
- }
- protected function removeUpdate(Storage $storage, $internalPath) {
- if ($this->updaterEnabled) {
- $storage->getUpdater()->remove($internalPath);
- }
- }
- protected function renameUpdate(Storage $sourceStorage, Storage $targetStorage, $sourceInternalPath, $targetInternalPath) {
- if ($this->updaterEnabled) {
- $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
- }
- }
- /**
- * @param string $path
- * @return bool|mixed
- */
- public function rmdir($path) {
- $absolutePath = $this->getAbsolutePath($path);
- $mount = Filesystem::getMountManager()->find($absolutePath);
- if ($mount->getInternalPath($absolutePath) === '') {
- return $this->removeMount($mount, $absolutePath);
- }
- if ($this->is_dir($path)) {
- $result = $this->basicOperation('rmdir', $path, array('delete'));
- } else {
- $result = false;
- }
- if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
- $storage = $mount->getStorage();
- $internalPath = $mount->getInternalPath($absolutePath);
- $storage->getUpdater()->remove($internalPath);
- }
- return $result;
- }
- /**
- * @param string $path
- * @return resource
- */
- public function opendir($path) {
- return $this->basicOperation('opendir', $path, array('read'));
- }
- /**
- * @param $handle
- * @return mixed
- */
- public function readdir($handle) {
- $fsLocal = new Storage\Local(array('datadir' => '/'));
- return $fsLocal->readdir($handle);
- }
- /**
- * @param string $path
- * @return bool|mixed
- */
- public function is_dir($path) {
- if ($path == '/') {
- return true;
- }
- return $this->basicOperation('is_dir', $path);
- }
- /**
- * @param string $path
- * @return bool|mixed
- */
- public function is_file($path) {
- if ($path == '/') {
- return false;
- }
- return $this->basicOperation('is_file', $path);
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function stat($path) {
- return $this->basicOperation('stat', $path);
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function filetype($path) {
- return $this->basicOperation('filetype', $path);
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function filesize($path) {
- return $this->basicOperation('filesize', $path);
- }
- /**
- * @param string $path
- * @return bool|mixed
- * @throws \OCP\Files\InvalidPathException
- */
- public function readfile($path) {
- $this->assertPathLength($path);
- @ob_end_clean();
- $handle = $this->fopen($path, 'rb');
- if ($handle) {
- $chunkSize = 8192; // 8 kB chunks
- while (!feof($handle)) {
- echo fread($handle, $chunkSize);
- flush();
- }
- fclose($handle);
- $size = $this->filesize($path);
- return $size;
- }
- return false;
- }
- /**
- * @param string $path
- * @param int $from
- * @param int $to
- * @return bool|mixed
- * @throws \OCP\Files\InvalidPathException
- * @throws \OCP\Files\UnseekableException
- */
- public function readfilePart($path, $from, $to) {
- $this->assertPathLength($path);
- @ob_end_clean();
- $handle = $this->fopen($path, 'rb');
- if ($handle) {
- if (fseek($handle, $from) === 0) {
- $chunkSize = 8192; // 8 kB chunks
- $end = $to + 1;
- while (!feof($handle) && ftell($handle) < $end) {
- $len = $end - ftell($handle);
- if ($len > $chunkSize) {
- $len = $chunkSize;
- }
- echo fread($handle, $len);
- flush();
- }
- $size = ftell($handle) - $from;
- return $size;
- }
- throw new \OCP\Files\UnseekableException('fseek error');
- }
- return false;
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function isCreatable($path) {
- return $this->basicOperation('isCreatable', $path);
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function isReadable($path) {
- return $this->basicOperation('isReadable', $path);
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function isUpdatable($path) {
- return $this->basicOperation('isUpdatable', $path);
- }
- /**
- * @param string $path
- * @return bool|mixed
- */
- public function isDeletable($path) {
- $absolutePath = $this->getAbsolutePath($path);
- $mount = Filesystem::getMountManager()->find($absolutePath);
- if ($mount->getInternalPath($absolutePath) === '') {
- return $mount instanceof MoveableMount;
- }
- return $this->basicOperation('isDeletable', $path);
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function isSharable($path) {
- return $this->basicOperation('isSharable', $path);
- }
- /**
- * @param string $path
- * @return bool|mixed
- */
- public function file_exists($path) {
- if ($path == '/') {
- return true;
- }
- return $this->basicOperation('file_exists', $path);
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function filemtime($path) {
- return $this->basicOperation('filemtime', $path);
- }
- /**
- * @param string $path
- * @param int|string $mtime
- * @return bool
- */
- public function touch($path, $mtime = null) {
- if (!is_null($mtime) and !is_numeric($mtime)) {
- $mtime = strtotime($mtime);
- }
- $hooks = array('touch');
- if (!$this->file_exists($path)) {
- $hooks[] = 'create';
- $hooks[] = 'write';
- }
- $result = $this->basicOperation('touch', $path, $hooks, $mtime);
- if (!$result) {
- // If create file fails because of permissions on external storage like SMB folders,
- // check file exists and return false if not.
- if (!$this->file_exists($path)) {
- return false;
- }
- if (is_null($mtime)) {
- $mtime = time();
- }
- //if native touch fails, we emulate it by changing the mtime in the cache
- $this->putFileInfo($path, array('mtime' => $mtime));
- }
- return true;
- }
- /**
- * @param string $path
- * @return mixed
- */
- public function file_get_contents($path) {
- return $this->basicOperation('file_get_contents', $path, array('read'));
- }
- /**
- * @param bool $exists
- * @param string $path
- * @param bool $run
- */
- protected function emit_file_hooks_pre($exists, $path, &$run) {
- if (!$exists) {
- \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, array(
- Filesystem::signal_param_path => $this->getHookPath($path),
- Filesystem::signal_param_run => &$run,
- ));
- } else {
- \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, array(
- Filesystem::signal_param_path => $this->getHookPath($path),
- Filesystem::signal_param_run => &$run,
- ));
- }
- \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, array(
- Filesystem::signal_param_path => $this->getHookPath($path),
- Filesystem::signal_param_run => &$run,
- ));
- }
- /**
- * @param bool $exists
- * @param string $path
- */
- protected function emit_file_hooks_post($exists, $path) {
- if (!$exists) {
- \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, array(
- Filesystem::signal_param_path => $this->getHookPath($path),
- ));
- } else {
- \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_update, array(
- Filesystem::signal_param_path => $this->getHookPath($path),
- ));
- }
- \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_write, array(
- Filesystem::signal_param_path => $this->getHookPath($path),
- ));
- }
- /**
- * @param string $path
- * @param mixed $data
- * @return bool|mixed
- * @throws \Exception
- */
- public function file_put_contents($path, $data) {
- if (is_resource($data)) { //not having to deal with streams in file_put_contents makes life easier
- $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
- if (Filesystem::isValidPath($path)
- and !Filesystem::isFileBlacklisted($path)
- ) {
- $path = $this->getRelativePath($absolutePath);
- $this->lockFile($path, ILockingProvider::LOCK_SHARED);
- $exists = $this->file_exists($path);
- $run = true;
- if ($this->shouldEmitHooks($path)) {
- $this->emit_file_hooks_pre($exists, $path, $run);
- }
- if (!$run) {
- $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
- return false;
- }
- $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
- /** @var \OC\Files\Storage\Storage $storage */
- list($storage, $internalPath) = $this->resolvePath($path);
- $target = $storage->fopen($internalPath, 'w');
- if ($target) {
- list (, $result) = \OC_Helper::streamCopy($data, $target);
- fclose($target);
- fclose($data);
- $this->writeUpdate($storage, $internalPath);
- $this->changeLock($path, ILockingProvider::LOCK_SHARED);
- if ($this->shouldEmitHooks($path) && $result !== false) {
- $this->emit_file_hooks_post($exists, $path);
- }
- $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
- return $result;
- } else {
- $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
- return false;
- }
- } else {
- return false;
- }
- } else {
- $hooks = ($this->file_exists($path)) ? array('update', 'write') : array('create', 'write');
- return $this->basicOperation('file_put_contents', $path, $hooks, $data);
- }
- }
- /**
- * @param string $path
- * @return bool|mixed
- */
- public function unlink($path) {
- if ($path === '' || $path === '/') {
- // do not allow deleting the root
- return false;
- }
- $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
- $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
- $mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
- if ($mount and $mount->getInternalPath($absolutePath) === '') {
- return $this->removeMount($mount, $absolutePath);
- }
- $result = $this->basicOperation('unlink', $path, array('delete'));
- if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
- $storage = $mount->getStorage();
- $internalPath = $mount->getInternalPath($absolutePath);
- $storage->getUpdater()->remove($internalPath);
- return true;
- } else {
- return $result;
- }
- }
- /**
- * @param string $directory
- * @return bool|mixed
- */
- public function deleteAll($directory) {
- return $this->rmdir($directory);
- }
- /**
- * Rename/move a file or folder from the source path to target path.
- *
- * @param string $path1 source path
- * @param string $path2 target path
- *
- * @return bool|mixed
- */
- public function rename($path1, $path2) {
- $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
- $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
- $result = false;
- if (
- Filesystem::isValidPath($path2)
- and Filesystem::isValidPath($path1)
- and !Filesystem::isFileBlacklisted($path2)
- ) {
- $path1 = $this->getRelativePath($absolutePath1);
- $path2 = $this->getRelativePath($absolutePath2);
- $exists = $this->file_exists($path2);
- if ($path1 == null or $path2 == null) {
- return false;
- }
- $this->lockFile($path1, ILockingProvider::LOCK_SHARED, true);
- try {
- $this->lockFile($path2, ILockingProvider::LOCK_SHARED, true);
- } catch (LockedException $e) {
- $this->unlockFile($path1, ILockingProvider::LOCK_SHARED);
- throw $e;
- }
- $run = true;
- if ($this->shouldEmitHooks($path1) && (Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2))) {
- // if it was a rename from a part file to a regular file it was a write and not a rename operation
- $this->emit_file_hooks_pre($exists, $path2, $run);
- } elseif ($this->shouldEmitHooks($path1)) {
- \OC_Hook::emit(
- Filesystem::CLASSNAME, Filesystem::signal_rename,
- array(
- Filesystem::signal_param_oldpath => $this->getHookPath($path1),
- Filesystem::signal_param_newpath => $this->getHookPath($path2),
- Filesystem::signal_param_run => &$run
- )
- );
- }
- if ($run) {
- $this->verifyPath(dirname($path2), basename($path2));
- $manager = Filesystem::getMountManager();
- $mount1 = $this->getMount($path1);
- $mount2 = $this->getMount($path2);
- $storage1 = $mount1->getStorage();
- $storage2 = $mount2->getStorage();
- $internalPath1 = $mount1->getInternalPath($absolutePath1);
- $internalPath2 = $mount2->getInternalPath($absolutePath2);
- $this->changeLock($path1, ILockingProvider::LOCK_EXCLUSIVE, true);
- $this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE, true);
- if ($internalPath1 === '' and $mount1 instanceof MoveableMount) {
- if ($this->isTargetAllowed($absolutePath2)) {
- /**
- * @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount1
- */
- $sourceMountPoint = $mount1->getMountPoint();
- $result = $mount1->moveMount($absolutePath2);
- $manager->moveMount($sourceMountPoint, $mount1->getMountPoint());
- } else {
- $result = false;
- }
- // moving a file/folder within the same mount point
- } elseif ($storage1 === $storage2) {
- if ($storage1) {
- $result = $storage1->rename($internalPath1, $internalPath2);
- } else {
- $result = false;
- }
- // moving a file/folder between storages (from $storage1 to $storage2)
- } else {
- $result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
- }
- if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
- // if it was a rename from a part file to a regular file it was a write and not a rename operation
- $this->writeUpdate($storage2, $internalPath2);
- } else if ($result) {
- if ($internalPath1 !== '') { // don't do a cache update for moved mounts
- $this->renameUpdate($storage1, $storage2, $internalPath1, $internalPath2);
- }
- }
- $this->changeLock($path1, ILockingProvider::LOCK_SHARED, true);
- $this->changeLock($path2, ILockingProvider::LOCK_SHARED, true);
- if ((Cache\Scanner::isPartialFile($path1) && !Cache\Scanner::isPartialFile($path2)) && $result !== false) {
- if ($this->shouldEmitHooks()) {
- $this->emit_file_hooks_post($exists, $path2);
- }
- } elseif ($result) {
- if ($this->shouldEmitHooks($path1) and $this->shouldEmitHooks($path2)) {
- \OC_Hook::emit(
- Filesystem::CLASSNAME,
- Filesystem::signal_post_rename,
- array(
- Filesystem::signal_param_oldpath => $this->getHookPath($path1),
- Filesystem::signal_param_newpath => $this->getHookPath($path2)
- )
- );
- }
- }
- }
- $this->unlockFile($path1, ILockingProvider::LOCK_SHARED, true);
- $this->unlockFile($path2, ILockingProvider::LOCK_SHARED, true);
- }
- return $result;
- }
- /**
- * Copy a file/folder from the source path to target path
- *
- * @param string $path1 source path
- * @param string $path2 target path
- * @param bool $preserveMtime whether to preserve mtime on the copy
- *
- * @return bool|mixed
- */
- public function copy($path1, $path2, $preserveMtime = false) {
- $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($path1));
- $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($path2));
- $result = false;
- if (
- Filesystem::isValidPath($path2)
- and Filesystem::isValidPath($path1)
- and !Filesystem::isFileBlacklisted($path2)
- ) {
- $path1 = $this->getRelativePath($absolutePath1);
- $path2 = $this->getRelativePath($absolutePath2);
- if ($path1 == null or $path2 == null) {
- return false;
- }
- $run = true;
- $this->lockFile($path2, ILockingProvider::LOCK_SHARED);
- $this->lockFile($path1, ILockingProvider::LOCK_SHARED);
- $lockTypePath1 = ILockingProvider::LOCK_SHARED;
- $lockTypePath2 = ILockingProvider::LOCK_SHARED;
- try {
- $exists = $this->file_exists($path2);
- if ($this->shouldEmitHooks()) {
- \OC_Hook::emit(
- Filesystem::CLASSNAME,
- Filesystem::signal_copy,
- array(
- Filesystem::signal_param_oldpath => $this->getHookPath($path1),
- Filesystem::signal_param_newpath => $this->getHookPath($path2),
- Filesystem::signal_param_run => &$run
- )
- );
- $this->emit_file_hooks_pre($exists, $path2, $run);
- }
- if ($run) {
- $mount1 = $this->getMount($path1);
- $mount2 = $this->getMount($path2);
- $storage1 = $mount1->getStorage();
- $internalPath1 = $mount1->getInternalPath($absolutePath1);
- $storage2 = $mount2->getStorage();
- $internalPath2 = $mount2->getInternalPath($absolutePath2);
- $this->changeLock($path2, ILockingProvider::LOCK_EXCLUSIVE);
- $lockTypePath2 = ILockingProvider::LOCK_EXCLUSIVE;
- if ($mount1->getMountPoint() == $mount2->getMountPoint()) {
- if ($storage1) {
- $result = $storage1->copy($internalPath1, $internalPath2);
- } else {
- $result = false;
- }
- } else {
- $result = $storage2->copyFromStorage($storage1, $internalPath1, $internalPath2);
- }
- $this->writeUpdate($storage2, $internalPath2);
- $this->changeLock($path2, ILockingProvider::LOCK_SHARED);
- $lockTypePath2 = ILockingProvider::LOCK_SHARED;
- if ($this->shouldEmitHooks() && $result !== false) {
- \OC_Hook::emit(
- Filesystem::CLASSNAME,
- Filesystem::signal_post_copy,
- array(
- Filesystem::signal_param_oldpath => $this->getHookPath($path1),
- Filesystem::signal_param_newpath => $this->getHookPath($path2)
- )
- );
- $this->emit_file_hooks_post($exists, $path2);
- }
- }
- } catch (\Exception $e) {
- $this->unlockFile($path2, $lockTypePath2);
- $this->unlockFile($path1, $lockTypePath1);
- throw $e;
- }
- $this->unlockFile($path2, $lockTypePath2);
- $this->unlockFile($path1, $lockTypePath1);
- }
- return $result;
- }
- /**
- * @param string $path
- * @param string $mode 'r' or 'w'
- * @return resource
- */
- public function fopen($path, $mode) {
- $mode = str_replace('b', '', $mode); // the binary flag is a windows only feature which we do not support
- $hooks = array();
- switch ($mode) {
- case 'r':
- $hooks[] = 'read';
- break;
- case 'r+':
- case 'w+':
- case 'x+':
- case 'a+':
- $hooks[] = 'read';
- $hooks[] = 'write';
- break;
- case 'w':
- case 'x':
- case 'a':
- $hooks[] = 'write';
- break;
- default:
- \OCP\Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, \OCP\Util::ERROR);
- }
- if ($mode !== 'r' && $mode !== 'w') {
- \OC::$server->getLogger()->info('Trying to open a file with a mode other than "r" or "w" can cause severe performance issues with some backends');
- }
- return $this->basicOperation('fopen', $path, $hooks, $mode);
- }
- /**
- * @param string $path
- * @return bool|string
- * @throws \OCP\Files\InvalidPathException
- */
- public function toTmpFile($path) {
- $this->assertPathLength($path);
- if (Filesystem::isValidPath($path)) {
- $source = $this->fopen($path, 'r');
- if ($source) {
- $extension = pathinfo($path, PATHINFO_EXTENSION);
- $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension);
- file_put_contents($tmpFile, $source);
- return $tmpFile;
- } else {
- return false;
- }
- } else {
- return false;
- }
- }
- /**
- * @param string $tmpFile
- * @param string $path
- * @return bool|mixed
- * @throws \OCP\Files\InvalidPathException
- */
- public function fromTmpFile($tmpFile, $path) {
- $this->assertPathLength($path);
- if (Filesystem::isValidPath($path)) {
- // Get directory that the file is going into
- $filePath = dirname($path);
- // Create the directories if any
- if (!$this->file_exists($filePath)) {
- $result = $this->createParentDirectories($filePath);
- if ($result === false) {
- return false;
- }
- }
- $source = fopen($tmpFile, 'r');
- if ($source) {
- $result = $this->file_put_contents($path, $source);
- // $this->file_put_contents() might have already closed
- // the resource, so we check it, before trying to close it
- // to avoid messages in the error log.
- if (is_resource($source)) {
- fclose($source);
- }
- unlink($tmpFile);
- return $result;
- } else {
- return false;
- }
- } else {
- return false;
- }
- }
- /**
- * @param string $path
- * @return mixed
- * @throws \OCP\Files\InvalidPathException
- */
- public function getMimeType($path) {
- $this->assertPathLength($path);
- return $this->basicOperation('getMimeType', $path);
- }
- /**
- * @param string $type
- * @param string $path
- * @param bool $raw
- * @return bool|null|string
- */
- public function hash($type, $path, $raw = false) {
- $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
- $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
- if (Filesystem::isValidPath($path)) {
- $path = $this->getRelativePath($absolutePath);
- if ($path == null) {
- return false;
- }
- if ($this->shouldEmitHooks($path)) {
- \OC_Hook::emit(
- Filesystem::CLASSNAME,
- Filesystem::signal_read,
- array(Filesystem::signal_param_path => $this->getHookPath($path))
- );
- }
- list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
- if ($storage) {
- $result = $storage->hash($type, $internalPath, $raw);
- return $result;
- }
- }
- return null;
- }
- /**
- * @param string $path
- * @return mixed
- * @throws \OCP\Files\InvalidPathException
- */
- public function free_space($path = '/') {
- $this->assertPathLength($path);
- return $this->basicOperation('free_space', $path);
- }
- /**
- * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
- *
- * @param string $operation
- * @param string $path
- * @param array $hooks (optional)
- * @param mixed $extraParam (optional)
- * @return mixed
- * @throws \Exception
- *
- * This method takes requests for basic filesystem functions (e.g. reading & writing
- * files), processes hooks and proxies, sanitises paths, and finally passes them on to
- * \OC\Files\Storage\Storage for delegation to a storage backend for execution
- */
- private function basicOperation($operation, $path, $hooks = [], $extraParam = null) {
- $postFix = (substr($path, -1, 1) === '/') ? '/' : '';
- $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
- if (Filesystem::isValidPath($path)
- and !Filesystem::isFileBlacklisted($path)
- ) {
- $path = $this->getRelativePath($absolutePath);
- if ($path == null) {
- return false;
- }
- if (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks)) {
- // always a shared lock during pre-hooks so the hook can read the file
- $this->lockFile($path, ILockingProvider::LOCK_SHARED);
- }
- $run = $this->runHooks($hooks, $path);
- /** @var \OC\Files\Storage\Storage $storage */
- list($storage, $internalPath) = Filesystem::resolvePath($absolutePath . $postFix);
- if ($run and $storage) {
- if (in_array('write', $hooks) || in_array('delete', $hooks)) {
- $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
- }
- try {
- if (!is_null($extraParam)) {
- $result = $storage->$operation($internalPath, $extraParam);
- } else {
- $result = $storage->$operation($internalPath);
- }
- } catch (\Exception $e) {
- if (in_array('write', $hooks) || in_array('delete', $hooks)) {
- $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
- } else if (in_array('read', $hooks)) {
- $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
- }
- throw $e;
- }
- if ($result && in_array('delete', $hooks) and $result) {
- $this->removeUpdate($storage, $internalPath);
- }
- if ($result && in_array('write', $hooks) and $operation !== 'fopen') {
- $this->writeUpdate($storage, $internalPath);
- }
- if ($result && in_array('touch', $hooks)) {
- $this->writeUpdate($storage, $internalPath, $extraParam);
- }
- if ((in_array('write', $hooks) || in_array('delete', $hooks)) && ($operation !== 'fopen' || $result === false)) {
- $this->changeLock($path, ILockingProvider::LOCK_SHARED);
- }
- $unlockLater = false;
- if ($this->lockingEnabled && $operation === 'fopen' && is_resource($result)) {
- $unlockLater = true;
- // make sure our unlocking callback will still be called if connection is aborted
- ignore_user_abort(true);
- $result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) {
- if (in_array('write', $hooks)) {
- $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
- } else if (in_array('read', $hooks)) {
- $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
- }
- });
- }
- if ($this->shouldEmitHooks($path) && $result !== false) {
- if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open
- $this->runHooks($hooks, $path, true);
- }
- }
- if (!$unlockLater
- && (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks))
- ) {
- $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
- }
- return $result;
- } else {
- $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
- }
- }
- return null;
- }
- /**
- * get the path relative to the default root for hook usage
- *
- * @param string $path
- * @return string
- */
- private function getHookPath($path) {
- if (!Filesystem::getView()) {
- return $path;
- }
- return Filesystem::getView()->getRelativePath($this->getAbsolutePath($path));
- }
- private function shouldEmitHooks($path = '') {
- if ($path && Cache\Scanner::isPartialFile($path)) {
- return false;
- }
- if (!Filesystem::$loaded) {
- return false;
- }
- $defaultRoot = Filesystem::getRoot();
- if ($defaultRoot === null) {
- return false;
- }
- if ($this->fakeRoot === $defaultRoot) {
- return true;
- }
- $fullPath = $this->getAbsolutePath($path);
- if ($fullPath === $defaultRoot) {
- return true;
- }
- return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
- }
- /**
- * @param string[] $hooks
- * @param string $path
- * @param bool $post
- * @return bool
- */
- private function runHooks($hooks, $path, $post = false) {
- $relativePath = $path;
- $path = $this->getHookPath($path);
- $prefix = ($post) ? 'post_' : '';
- $run = true;
- if ($this->shouldEmitHooks($relativePath)) {
- foreach ($hooks as $hook) {
- if ($hook != 'read') {
- \OC_Hook::emit(
- Filesystem::CLASSNAME,
- $prefix . $hook,
- array(
- Filesystem::signal_param_run => &$run,
- Filesystem::signal_param_path => $path
- )
- );
- } elseif (!$post) {
- \OC_Hook::emit(
- Filesystem::CLASSNAME,
- $prefix . $hook,
- array(
- Filesystem::signal_param_path => $path
- )
- );
- }
- }
- }
- return $run;
- }
- /**
- * check if a file or folder has been updated since $time
- *
- * @param string $path
- * @param int $time
- * @return bool
- */
- public function hasUpdated($path, $time) {
- return $this->basicOperation('hasUpdated', $path, array(), $time);
- }
- /**
- * @param string $ownerId
- * @return \OC\User\User
- */
- private function getUserObjectForOwner($ownerId) {
- $owner = $this->userManager->get($ownerId);
- if ($owner instanceof IUser) {
- return $owner;
- } else {
- return new User($ownerId, null);
- }
- }
- /**
- * Get file info from cache
- *
- * If the file is not in cached it will be scanned
- * If the file has changed on storage the cache will be updated
- *
- * @param \OC\Files\Storage\Storage $storage
- * @param string $internalPath
- * @param string $relativePath
- * @return array|bool
- */
- private function getCacheEntry($storage, $internalPath, $relativePath) {
- $cache = $storage->getCache($internalPath);
- $data = $cache->get($internalPath);
- $watcher = $storage->getWatcher($internalPath);
- try {
- // if the file is not in the cache or needs to be updated, trigger the scanner and reload the data
- if (!$data || $data['size'] === -1) {
- $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
- if (!$storage->file_exists($internalPath)) {
- $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
- return false;
- }
- $scanner = $storage->getScanner($internalPath);
- $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
- $data = $cache->get($internalPath);
- $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
- } else if (!Cache\Scanner::isPartialFile($internalPath) && $watcher->needsUpdate($internalPath, $data)) {
- $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
- $watcher->update($internalPath, $data);
- $storage->getPropagator()->propagateChange($internalPath, time());
- $data = $cache->get($internalPath);
- $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
- }
- } catch (LockedException $e) {
- // if the file is locked we just use the old cache info
- }
- return $data;
- }
- /**
- * get the filesystem info
- *
- * @param string $path
- * @param boolean|string $includeMountPoints true to add mountpoint sizes,
- * 'ext' to add only ext storage mount point sizes. Defaults to true.
- * defaults to true
- * @return \OC\Files\FileInfo|false False if file does not exist
- */
- public function getFileInfo($path, $includeMountPoints = true) {
- $this->assertPathLength($path);
- if (!Filesystem::isValidPath($path)) {
- return false;
- }
- if (Cache\Scanner::isPartialFile($path)) {
- return $this->getPartFileInfo($path);
- }
- $relativePath = $path;
- $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
- $mount = Filesystem::getMountManager()->find($path);
- $storage = $mount->getStorage();
- $internalPath = $mount->getInternalPath($path);
- if ($storage) {
- $data = $this->getCacheEntry($storage, $internalPath, $relativePath);
- if (!$data instanceof ICacheEntry) {
- return false;
- }
- if ($mount instanceof MoveableMount && $internalPath === '') {
- $data['permissions'] |= \OCP\Constants::PERMISSION_DELETE;
- }
- $owner = $this->getUserObjectForOwner($storage->getOwner($internalPath));
- $info = new FileInfo($path, $storage, $internalPath, $data, $mount, $owner);
- if ($data and isset($data['fileid'])) {
- if ($includeMountPoints and $data['mimetype'] === 'httpd/unix-directory') {
- //add the sizes of other mount points to the folder
- $extOnly = ($includeMountPoints === 'ext');
- $mounts = Filesystem::getMountManager()->findIn($path);
- $info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) {
- $subStorage = $mount->getStorage();
- return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage);
- }));
- }
- }
- return $info;
- }
- return false;
- }
- /**
- * get the content of a directory
- *
- * @param string $directory path under datadirectory
- * @param string $mimetype_filter limit returned content to this mimetype or mimepart
- * @return FileInfo[]
- */
- public function getDirectoryContent($directory, $mimetype_filter = '') {
- $this->assertPathLength($directory);
- if (!Filesystem::isValidPath($directory)) {
- return [];
- }
- $path = $this->getAbsolutePath($directory);
- $path = Filesystem::normalizePath($path);
- $mount = $this->getMount($directory);
- $storage = $mount->getStorage();
- $internalPath = $mount->getInternalPath($path);
- if ($storage) {
- $cache = $storage->getCache($internalPath);
- $user = \OC_User::getUser();
- $data = $this->getCacheEntry($storage, $internalPath, $directory);
- if (!$data instanceof ICacheEntry || !isset($data['fileid']) || !($data->getPermissions() && Constants::PERMISSION_READ)) {
- return [];
- }
- $folderId = $data['fileid'];
- $contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
- $sharingDisabled = \OCP\Util::isSharingDisabledForUser();
- /**
- * @var \OC\Files\FileInfo[] $files
- */
- $files = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
- if ($sharingDisabled) {
- $content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
- }
- $owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
- return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
- }, $contents);
- //add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
- $mounts = Filesystem::getMountManager()->findIn($path);
- $dirLength = strlen($path);
- foreach ($mounts as $mount) {
- $mountPoint = $mount->getMountPoint();
- $subStorage = $mount->getStorage();
- if ($subStorage) {
- $subCache = $subStorage->getCache('');
- $rootEntry = $subCache->get('');
- if (!$rootEntry) {
- $subScanner = $subStorage->getScanner('');
- try {
- $subScanner->scanFile('');
- } catch (\OCP\Files\StorageNotAvailableException $e) {
- continue;
- } catch (\OCP\Files\StorageInvalidException $e) {
- continue;
- } catch (\Exception $e) {
- // sometimes when the storage is not available it can be any exception
- \OCP\Util::writeLog(
- 'core',
- 'Exception while scanning storage "' . $subStorage->getId() . '": ' .
- get_class($e) . ': ' . $e->getMessage(),
- \OCP\Util::ERROR
- );
- continue;
- }
- $rootEntry = $subCache->get('');
- }
- if ($rootEntry && ($rootEntry->getPermissions() && Constants::PERMISSION_READ)) {
- $relativePath = trim(substr($mountPoint, $dirLength), '/');
- if ($pos = strpos($relativePath, '/')) {
- //mountpoint inside subfolder add size to the correct folder
- $entryName = substr($relativePath, 0, $pos);
- foreach ($files as &$entry) {
- if ($entry->getName() === $entryName) {
- $entry->addSubEntry($rootEntry, $mountPoint);
- }
- }
- } else { //mountpoint in this folder, add an entry for it
- $rootEntry['name'] = $relativePath;
- $rootEntry['type'] = $rootEntry['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file';
- $permissions = $rootEntry['permissions'];
- // do not allow renaming/deleting the mount point if they are not shared files/folders
- // for shared files/folders we use the permissions given by the owner
- if ($mount instanceof MoveableMount) {
- $rootEntry['permissions'] = $permissions | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE;
- } else {
- $rootEntry['permissions'] = $permissions & (\OCP\Constants::PERMISSION_ALL - (\OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE));
- }
- //remove any existing entry with the same name
- foreach ($files as $i => $file) {
- if ($file['name'] === $rootEntry['name']) {
- unset($files[$i]);
- break;
- }
- }
- $rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
- // if sharing was disabled for the user we remove the share permissions
- if (\OCP\Util::isSharingDisabledForUser()) {
- $rootEntry['permissions'] = $rootEntry['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
- }
- $owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
- $files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
- }
- }
- }
- }
- if ($mimetype_filter) {
- $files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) {
- if (strpos($mimetype_filter, '/')) {
- return $file->getMimetype() === $mimetype_filter;
- } else {
- return $file->getMimePart() === $mimetype_filter;
- }
- });
- }
- return $files;
- } else {
- return [];
- }
- }
- /**
- * change file metadata
- *
- * @param string $path
- * @param array|\OCP\Files\FileInfo $data
- * @return int
- *
- * returns the fileid of the updated file
- */
- public function putFileInfo($path, $data) {
- $this->assertPathLength($path);
- if ($data instanceof FileInfo) {
- $data = $data->getData();
- }
- $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
- /**
- * @var \OC\Files\Storage\Storage $storage
- * @var string $internalPath
- */
- list($storage, $internalPath) = Filesystem::resolvePath($path);
- if ($storage) {
- $cache = $storage->getCache($path);
- if (!$cache->inCache($internalPath)) {
- $scanner = $storage->getScanner($internalPath);
- $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
- }
- return $cache->put($internalPath, $data);
- } else {
- return -1;
- }
- }
- /**
- * search for files with the name matching $query
- *
- * @param string $query
- * @return FileInfo[]
- */
- public function search($query) {
- return $this->searchCommon('search', array('%' . $query . '%'));
- }
- /**
- * search for files with the name matching $query
- *
- * @param string $query
- * @return FileInfo[]
- */
- public function searchRaw($query) {
- return $this->searchCommon('search', array($query));
- }
- /**
- * search for files by mimetype
- *
- * @param string $mimetype
- * @return FileInfo[]
- */
- public function searchByMime($mimetype) {
- return $this->searchCommon('searchByMime', array($mimetype));
- }
- /**
- * search for files by tag
- *
- * @param string|int $tag name or tag id
- * @param string $userId owner of the tags
- * @return FileInfo[]
- */
- public function searchByTag($tag, $userId) {
- return $this->searchCommon('searchByTag', array($tag, $userId));
- }
- /**
- * @param string $method cache method
- * @param array $args
- * @return FileInfo[]
- */
- private function searchCommon($method, $args) {
- $files = array();
- $rootLength = strlen($this->fakeRoot);
- $mount = $this->getMount('');
- $mountPoint = $mount->getMountPoint();
- $storage = $mount->getStorage();
- if ($storage) {
- $cache = $storage->getCache('');
- $results = call_user_func_array(array($cache, $method), $args);
- foreach ($results as $result) {
- if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
- $internalPath = $result['path'];
- $path = $mountPoint . $result['path'];
- $result['path'] = substr($mountPoint . $result['path'], $rootLength);
- $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
- $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
- }
- }
- $mounts = Filesystem::getMountManager()->findIn($this->fakeRoot);
- foreach ($mounts as $mount) {
- $mountPoint = $mount->getMountPoint();
- $storage = $mount->getStorage();
- if ($storage) {
- $cache = $storage->getCache('');
- $relativeMountPoint = substr($mountPoint, $rootLength);
- $results = call_user_func_array(array($cache, $method), $args);
- if ($results) {
- foreach ($results as $result) {
- $internalPath = $result['path'];
- $result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
- $path = rtrim($mountPoint . $internalPath, '/');
- $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
- $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
- }
- }
- }
- }
- }
- return $files;
- }
- /**
- * Get the owner for a file or folder
- *
- * @param string $path
- * @return string the user id of the owner
- * @throws NotFoundException
- */
- public function getOwner($path) {
- $info = $this->getFileInfo($path);
- if (!$info) {
- throw new NotFoundException($path . ' not found while trying to get owner');
- }
- return $info->getOwner()->getUID();
- }
- /**
- * get the ETag for a file or folder
- *
- * @param string $path
- * @return string
- */
- public function getETag($path) {
- /**
- * @var Storage\Storage $storage
- * @var string $internalPath
- */
- list($storage, $internalPath) = $this->resolvePath($path);
- if ($storage) {
- return $storage->getETag($internalPath);
- } else {
- return null;
- }
- }
- /**
- * Get the path of a file by id, relative to the view
- *
- * Note that the resulting path is not guarantied to be unique for the id, multiple paths can point to the same file
- *
- * @param int $id
- * @throws NotFoundException
- * @return string
- */
- public function getPath($id) {
- $id = (int)$id;
- $manager = Filesystem::getMountManager();
- $mounts = $manager->findIn($this->fakeRoot);
- $mounts[] = $manager->find($this->fakeRoot);
- // reverse the array so we start with the storage this view is in
- // which is the most likely to contain the file we're looking for
- $mounts = array_reverse($mounts);
- foreach ($mounts as $mount) {
- /**
- * @var \OC\Files\Mount\MountPoint $mount
- */
- if ($mount->getStorage()) {
- $cache = $mount->getStorage()->getCache();
- $internalPath = $cache->getPathById($id);
- if (is_string($internalPath)) {
- $fullPath = $mount->getMountPoint() . $internalPath;
- if (!is_null($path = $this->getRelativePath($fullPath))) {
- return $path;
- }
- }
- }
- }
- throw new NotFoundException(sprintf('File with id "%s" has not been found.', $id));
- }
- /**
- * @param string $path
- * @throws InvalidPathException
- */
- private function assertPathLength($path) {
- $maxLen = min(PHP_MAXPATHLEN, 4000);
- // Check for the string length - performed using isset() instead of strlen()
- // because isset() is about 5x-40x faster.
- if (isset($path[$maxLen])) {
- $pathLen = strlen($path);
- throw new \OCP\Files\InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
- }
- }
- /**
- * check if it is allowed to move a mount point to a given target.
- * It is not allowed to move a mount point into a different mount point or
- * into an already shared folder
- *
- * @param string $target path
- * @return boolean
- */
- private function isTargetAllowed($target) {
- list($targetStorage, $targetInternalPath) = \OC\Files\Filesystem::resolvePath($target);
- if (!$targetStorage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
- \OCP\Util::writeLog('files',
- 'It is not allowed to move one mount point into another one',
- \OCP\Util::DEBUG);
- return false;
- }
- // note: cannot use the view because the target is already locked
- $fileId = (int)$targetStorage->getCache()->getId($targetInternalPath);
- if ($fileId === -1) {
- // target might not exist, need to check parent instead
- $fileId = (int)$targetStorage->getCache()->getId(dirname($targetInternalPath));
- }
- // check if any of the parents were shared by the current owner (include collections)
- $shares = \OCP\Share::getItemShared(
- 'folder',
- $fileId,
- \OCP\Share::FORMAT_NONE,
- null,
- true
- );
- if (count($shares) > 0) {
- \OCP\Util::writeLog('files',
- 'It is not allowed to move one mount point into a shared folder',
- \OCP\Util::DEBUG);
- return false;
- }
- return true;
- }
- /**
- * Get a fileinfo object for files that are ignored in the cache (part files)
- *
- * @param string $path
- * @return \OCP\Files\FileInfo
- */
- private function getPartFileInfo($path) {
- $mount = $this->getMount($path);
- $storage = $mount->getStorage();
- $internalPath = $mount->getInternalPath($this->getAbsolutePath($path));
- $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
- return new FileInfo(
- $this->getAbsolutePath($path),
- $storage,
- $internalPath,
- [
- 'fileid' => null,
- 'mimetype' => $storage->getMimeType($internalPath),
- 'name' => basename($path),
- 'etag' => null,
- 'size' => $storage->filesize($internalPath),
- 'mtime' => $storage->filemtime($internalPath),
- 'encrypted' => false,
- 'permissions' => \OCP\Constants::PERMISSION_ALL
- ],
- $mount,
- $owner
- );
- }
- /**
- * @param string $path
- * @param string $fileName
- * @throws InvalidPathException
- */
- public function verifyPath($path, $fileName) {
- try {
- /** @type \OCP\Files\Storage $storage */
- list($storage, $internalPath) = $this->resolvePath($path);
- $storage->verifyPath($internalPath, $fileName);
- } catch (ReservedWordException $ex) {
- $l = \OC::$server->getL10N('lib');
- throw new InvalidPathException($l->t('File name is a reserved word'));
- } catch (InvalidCharacterInPathException $ex) {
- $l = \OC::$server->getL10N('lib');
- throw new InvalidPathException($l->t('File name contains at least one invalid character'));
- } catch (FileNameTooLongException $ex) {
- $l = \OC::$server->getL10N('lib');
- throw new InvalidPathException($l->t('File name is too long'));
- } catch (InvalidDirectoryException $ex) {
- $l = \OC::$server->getL10N('lib');
- throw new InvalidPathException($l->t('Dot files are not allowed'));
- } catch (EmptyFileNameException $ex) {
- $l = \OC::$server->getL10N('lib');
- throw new InvalidPathException($l->t('Empty filename is not allowed'));
- }
- }
- /**
- * get all parent folders of $path
- *
- * @param string $path
- * @return string[]
- */
- private function getParents($path) {
- $path = trim($path, '/');
- if (!$path) {
- return [];
- }
- $parts = explode('/', $path);
- // remove the single file
- array_pop($parts);
- $result = array('/');
- $resultPath = '';
- foreach ($parts as $part) {
- if ($part) {
- $resultPath .= '/' . $part;
- $result[] = $resultPath;
- }
- }
- return $result;
- }
- /**
- * Returns the mount point for which to lock
- *
- * @param string $absolutePath absolute path
- * @param bool $useParentMount true to return parent mount instead of whatever
- * is mounted directly on the given path, false otherwise
- * @return \OC\Files\Mount\MountPoint mount point for which to apply locks
- */
- private function getMountForLock($absolutePath, $useParentMount = false) {
- $results = [];
- $mount = Filesystem::getMountManager()->find($absolutePath);
- if (!$mount) {
- return $results;
- }
- if ($useParentMount) {
- // find out if something is mounted directly on the path
- $internalPath = $mount->getInternalPath($absolutePath);
- if ($internalPath === '') {
- // resolve the parent mount instead
- $mount = Filesystem::getMountManager()->find(dirname($absolutePath));
- }
- }
- return $mount;
- }
- /**
- * Lock the given path
- *
- * @param string $path the path of the file to lock, relative to the view
- * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
- * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
- *
- * @return bool False if the path is excluded from locking, true otherwise
- * @throws \OCP\Lock\LockedException if the path is already locked
- */
- private function lockPath($path, $type, $lockMountPoint = false) {
- $absolutePath = $this->getAbsolutePath($path);
- $absolutePath = Filesystem::normalizePath($absolutePath);
- if (!$this->shouldLockFile($absolutePath)) {
- return false;
- }
- $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
- if ($mount) {
- try {
- $storage = $mount->getStorage();
- if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
- $storage->acquireLock(
- $mount->getInternalPath($absolutePath),
- $type,
- $this->lockingProvider
- );
- }
- } catch (\OCP\Lock\LockedException $e) {
- // rethrow with the a human-readable path
- throw new \OCP\Lock\LockedException(
- $this->getPathRelativeToFiles($absolutePath),
- $e
- );
- }
- }
- return true;
- }
- /**
- * Change the lock type
- *
- * @param string $path the path of the file to lock, relative to the view
- * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
- * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
- *
- * @return bool False if the path is excluded from locking, true otherwise
- * @throws \OCP\Lock\LockedException if the path is already locked
- */
- public function changeLock($path, $type, $lockMountPoint = false) {
- $path = Filesystem::normalizePath($path);
- $absolutePath = $this->getAbsolutePath($path);
- $absolutePath = Filesystem::normalizePath($absolutePath);
- if (!$this->shouldLockFile($absolutePath)) {
- return false;
- }
- $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
- if ($mount) {
- try {
- $storage = $mount->getStorage();
- if ($storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
- $storage->changeLock(
- $mount->getInternalPath($absolutePath),
- $type,
- $this->lockingProvider
- );
- }
- } catch (\OCP\Lock\LockedException $e) {
- // rethrow with the a human-readable path
- throw new \OCP\Lock\LockedException(
- $this->getPathRelativeToFiles($absolutePath),
- $e
- );
- }
- }
- return true;
- }
- /**
- * Unlock the given path
- *
- * @param string $path the path of the file to unlock, relative to the view
- * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
- * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
- *
- * @return bool False if the path is excluded from locking, true otherwise
- */
- private function unlockPath($path, $type, $lockMountPoint = false) {
- $absolutePath = $this->getAbsolutePath($path);
- $absolutePath = Filesystem::normalizePath($absolutePath);
- if (!$this->shouldLockFile($absolutePath)) {
- return false;
- }
- $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
- if ($mount) {
- $storage = $mount->getStorage();
- if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
- $storage->releaseLock(
- $mount->getInternalPath($absolutePath),
- $type,
- $this->lockingProvider
- );
- }
- }
- return true;
- }
- /**
- * Lock a path and all its parents up to the root of the view
- *
- * @param string $path the path of the file to lock relative to the view
- * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
- * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
- *
- * @return bool False if the path is excluded from locking, true otherwise
- */
- public function lockFile($path, $type, $lockMountPoint = false) {
- $absolutePath = $this->getAbsolutePath($path);
- $absolutePath = Filesystem::normalizePath($absolutePath);
- if (!$this->shouldLockFile($absolutePath)) {
- return false;
- }
- $this->lockPath($path, $type, $lockMountPoint);
- $parents = $this->getParents($path);
- foreach ($parents as $parent) {
- $this->lockPath($parent, ILockingProvider::LOCK_SHARED);
- }
- return true;
- }
- /**
- * Unlock a path and all its parents up to the root of the view
- *
- * @param string $path the path of the file to lock relative to the view
- * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
- * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
- *
- * @return bool False if the path is excluded from locking, true otherwise
- */
- public function unlockFile($path, $type, $lockMountPoint = false) {
- $absolutePath = $this->getAbsolutePath($path);
- $absolutePath = Filesystem::normalizePath($absolutePath);
- if (!$this->shouldLockFile($absolutePath)) {
- return false;
- }
- $this->unlockPath($path, $type, $lockMountPoint);
- $parents = $this->getParents($path);
- foreach ($parents as $parent) {
- $this->unlockPath($parent, ILockingProvider::LOCK_SHARED);
- }
- return true;
- }
- /**
- * Only lock files in data/user/files/
- *
- * @param string $path Absolute path to the file/folder we try to (un)lock
- * @return bool
- */
- protected function shouldLockFile($path) {
- $path = Filesystem::normalizePath($path);
- $pathSegments = explode('/', $path);
- if (isset($pathSegments[2])) {
- // E.g.: /username/files/path-to-file
- return ($pathSegments[2] === 'files') && (count($pathSegments) > 3);
- }
- return true;
- }
- /**
- * Shortens the given absolute path to be relative to
- * "$user/files".
- *
- * @param string $absolutePath absolute path which is under "files"
- *
- * @return string path relative to "files" with trimmed slashes or null
- * if the path was NOT relative to files
- *
- * @throws \InvalidArgumentException if the given path was not under "files"
- * @since 8.1.0
- */
- public function getPathRelativeToFiles($absolutePath) {
- $path = Filesystem::normalizePath($absolutePath);
- $parts = explode('/', trim($path, '/'), 3);
- // "$user", "files", "path/to/dir"
- if (!isset($parts[1]) || $parts[1] !== 'files') {
- throw new \InvalidArgumentException('$absolutePath must be relative to "files"');
- }
- if (isset($parts[2])) {
- return $parts[2];
- }
- return '';
- }
- /**
- * @param string $filename
- * @return array
- * @throws \OC\User\NoUserException
- * @throws NotFoundException
- */
- public function getUidAndFilename($filename) {
- $info = $this->getFileInfo($filename);
- if (!$info instanceof \OCP\Files\FileInfo) {
- throw new NotFoundException($this->getAbsolutePath($filename) . ' not found');
- }
- $uid = $info->getOwner()->getUID();
- if ($uid != \OCP\User::getUser()) {
- Filesystem::initMountPoints($uid);
- $ownerView = new View('/' . $uid . '/files');
- try {
- $filename = $ownerView->getPath($info['fileid']);
- } catch (NotFoundException $e) {
- throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid);
- }
- }
- return [$uid, $filename];
- }
- /**
- * Creates parent non-existing folders
- *
- * @param string $filePath
- * @return bool
- */
- private function createParentDirectories($filePath) {
- $directoryParts = explode('/', $filePath);
- $directoryParts = array_filter($directoryParts);
- foreach ($directoryParts as $key => $part) {
- $currentPathElements = array_slice($directoryParts, 0, $key);
- $currentPath = '/' . implode('/', $currentPathElements);
- if ($this->is_file($currentPath)) {
- return false;
- }
- if (!$this->file_exists($currentPath)) {
- $this->mkdir($currentPath);
- }
- }
- return true;
- }
- }
|