12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937 |
- <?php
- /**
- * @author Arthur Schiwon <blizzz@owncloud.com>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Björn Schießle <schiessle@owncloud.com>
- * @author cmeh <cmeh@users.noreply.github.com>
- * @author Florin Peter <github@florin-peter.de>
- * @author Jesus Macias <jmacias@full-on-net.com>
- * @author Joas Schilling <nickvergessen@owncloud.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Klaas Freitag <freitag@owncloud.com>
- * @author Lukas Reschke <lukas@owncloud.com>
- * @author Luke Policinski <lpolicinski@gmail.com>
- * @author Michael Gapczynski <GapczynskiM@gmail.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <icewind@owncloud.com>
- * @author Robin McCorkell <rmccorkell@karoshi.org.uk>
- * @author Roman Geber <rgeber@owncloudapps.com>
- * @author Sam Tuke <mail@samtuke.com>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Thomas Tanghus <thomas@tanghus.net>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @copyright Copyright (c) 2015, ownCloud, Inc.
- * @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\Cache\Updater;
- use OC\Files\Mount\MoveableMount;
- use OCP\Files\FileNameTooLongException;
- use OCP\Files\InvalidCharacterInPathException;
- use OCP\Files\InvalidPathException;
- use OCP\Files\ReservedWordException;
- 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 \OC\Files\Cache\Updater */
- protected $updater;
- /**
- * @var \OCP\Lock\ILockingProvider
- */
- private $lockingProvider;
- private $lockingEnabled;
- /**
- * @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->updater = new Updater($this);
- $this->lockingProvider = \OC::$server->getLockingProvider();
- $this->lockingEnabled = !($this->lockingProvider instanceof \OC\Lock\NoopLockingProvider);
- }
- 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 '/';
- }
- if (strpos($path, $this->fakeRoot) !== 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];
- \OC_Hook::emit(
- Filesystem::CLASSNAME, "umount",
- array(Filesystem::signal_param_path => $relPath)
- );
- $result = $mount->removeMount();
- if ($result) {
- \OC_Hook::emit(
- Filesystem::CLASSNAME, "post_umount",
- array(Filesystem::signal_param_path => $relPath)
- );
- }
- 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;
- }
- }
- /**
- * @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, $path);
- }
- if ($this->is_dir($path)) {
- return $this->basicOperation('rmdir', $path, array('delete'));
- } else {
- return false;
- }
- }
- /**
- * @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();
- }
- $size = $this->filesize($path);
- return $size;
- }
- 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
- */
- 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->updater->update($path);
- $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);
- }
- return $this->basicOperation('unlink', $path, array('delete'));
- }
- /**
- * @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->updater->update($path2);
- } else if ($result) {
- if ($internalPath1 !== '') { // dont do a cache update for moved mounts
- $this->updater->rename($path1, $path2);
- } else { // only do etag propagation
- $this->getUpdater()->getPropagator()->addChange($path1);
- $this->getUpdater()->getPropagator()->addChange($path2);
- $this->getUpdater()->getPropagator()->propagateChanges();
- }
- }
- $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);
- $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);
- if ($mount1->getMountPoint() == $mount2->getMountPoint()) {
- if ($storage1) {
- $result = $storage1->copy($internalPath1, $internalPath2);
- } else {
- $result = false;
- }
- } else {
- $result = $storage2->copyFromStorage($storage1, $internalPath1, $internalPath2);
- }
- $this->updater->update($path2);
- $this->changeLock($path2, 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);
- }
- $this->unlockFile($path2, ILockingProvider::LOCK_SHARED);
- $this->unlockFile($path1, ILockingProvider::LOCK_SHARED);
- }
- }
- return $result;
- }
- /**
- * @param string $path
- * @param string $mode
- * @return resource
- */
- public function fopen($path, $mode) {
- $hooks = array();
- switch ($mode) {
- case 'r':
- case 'rb':
- $hooks[] = 'read';
- break;
- case 'r+':
- case 'rb+':
- case 'w+':
- case 'wb+':
- case 'x+':
- case 'xb+':
- case 'a+':
- case 'ab+':
- $hooks[] = 'read';
- $hooks[] = 'write';
- break;
- case 'w':
- case 'wb':
- case 'x':
- case 'xb':
- case 'a':
- case 'ab':
- $hooks[] = 'write';
- break;
- default:
- \OCP\Util::writeLog('core', 'invalid mode (' . $mode . ') for ' . $path, \OCP\Util::ERROR);
- }
- 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_Helper::tmpFile($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)) {
- $this->mkdir($filePath);
- }
- $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
- *
- * 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 = array(), $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);
- 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 (in_array('delete', $hooks) and $result) {
- $this->updater->remove($path);
- }
- if (in_array('write', $hooks) and $operation !== 'fopen') {
- $this->updater->update($path);
- }
- if (in_array('touch', $hooks)) {
- $this->updater->update($path, $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;
- $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);
- }
- /**
- * 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
- */
- public function getFileInfo($path, $includeMountPoints = true) {
- $this->assertPathLength($path);
- $data = array();
- if (!Filesystem::isValidPath($path)) {
- return $data;
- }
- 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);
- $data = null;
- if ($storage) {
- $cache = $storage->getCache($internalPath);
- try {
- $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
- $data = $cache->get($internalPath);
- $watcher = $storage->getWatcher($internalPath);
- // if the file is not in the cache or needs to be updated, trigger the scanner and reload the data
- if (!$data) {
- 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);
- } else if (!Cache\Scanner::isPartialFile($internalPath) && $watcher->checkUpdate($internalPath, $data)) {
- $this->updater->propagate($path);
- $data = $cache->get($internalPath);
- }
- $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
- } catch (LockedException $e) {
- // dont try to update the cache when the file is locked
- $data = $cache->get($internalPath);
- }
- if ($data and isset($data['fileid'])) {
- // upgrades from oc6 or lower might not have the permissions set in the file cache
- if ($data['permissions'] === 0) {
- $data['permissions'] = $storage->getPermissions($data['path']);
- $cache->update($data['fileid'], array('permissions' => $data['permissions']));
- }
- if ($includeMountPoints and $data['mimetype'] === 'httpd/unix-directory') {
- //add the sizes of other mount points to the folder
- $extOnly = ($includeMountPoints === 'ext');
- $mountPoints = Filesystem::getMountPoints($path);
- foreach ($mountPoints as $mountPoint) {
- $subStorage = Filesystem::getStorage($mountPoint);
- if ($subStorage) {
- // exclude shared storage ?
- if ($extOnly && $subStorage instanceof \OC\Files\Storage\Shared) {
- continue;
- }
- $subCache = $subStorage->getCache('');
- $rootEntry = $subCache->get('');
- $data['size'] += isset($rootEntry['size']) ? $rootEntry['size'] : 0;
- }
- }
- }
- }
- }
- if (!$data) {
- return false;
- }
- if ($mount instanceof MoveableMount && $internalPath === '') {
- $data['permissions'] |= \OCP\Constants::PERMISSION_DELETE;
- }
- return new FileInfo($path, $storage, $internalPath, $data, $mount);
- }
- /**
- * 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);
- $result = array();
- if (!Filesystem::isValidPath($directory)) {
- return $result;
- }
- $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();
- /**
- * @var \OC\Files\FileInfo[] $files
- */
- $files = array();
- try {
- $this->lockFile($directory, ILockingProvider::LOCK_SHARED);
- $data = $cache->get($internalPath);
- $watcher = $storage->getWatcher($internalPath);
- if (!$data or $data['size'] === -1) {
- if (!$storage->file_exists($internalPath)) {
- $this->unlockFile($directory, ILockingProvider::LOCK_SHARED);
- return array();
- }
- $scanner = $storage->getScanner($internalPath);
- $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
- $data = $cache->get($internalPath);
- } else if ($watcher->checkUpdate($internalPath, $data)) {
- $this->updater->propagate($path);
- $data = $cache->get($internalPath);
- }
- $folderId = $data['fileid'];
- $contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
- $this->unlockFile($directory, ILockingProvider::LOCK_SHARED);
- } catch (LockedException $e) {
- // dont try to update the cache when the file is locked
- $contents = $cache->getFolderContents($internalPath);
- }
- foreach ($contents as $content) {
- if ($content['permissions'] === 0) {
- $content['permissions'] = $storage->getPermissions($content['path']);
- $cache->update($content['fileid'], array('permissions' => $content['permissions']));
- }
- // if sharing was disabled for the user we remove the share permissions
- if (\OCP\Util::isSharingDisabledForUser()) {
- $content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
- }
- $files[] = new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount);
- }
- //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('');
- if ($subCache->getStatus('') === Cache\Cache::NOT_FOUND) {
- $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) {
- $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['name'] === $entryName) {
- $entry['size'] += $rootEntry['size'];
- }
- }
- } 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;
- }
- $files[] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount);
- }
- }
- }
- }
- if ($mimetype_filter) {
- foreach ($files as $file) {
- if (strpos($mimetype_filter, '/')) {
- if ($file['mimetype'] === $mimetype_filter) {
- $result[] = $file;
- }
- } else {
- if ($file['mimepart'] === $mimetype_filter) {
- $result[] = $file;
- }
- }
- }
- } else {
- $result = $files;
- }
- }
- return $result;
- }
- /**
- * 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);
- $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount);
- }
- }
- $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, '/');
- $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount);
- }
- }
- }
- }
- }
- return $files;
- }
- /**
- * Get the owner for a file or folder
- *
- * @param string $path
- * @return string
- */
- public function getOwner($path) {
- return $this->basicOperation('getOwner', $path);
- }
- /**
- * 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
- * @return string|null
- */
- 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;
- }
- }
- }
- }
- return null;
- }
- 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
- *
- * @param string $target path
- * @return boolean
- */
- private function isTargetAllowed($target) {
- $result = false;
- list($targetStorage,) = \OC\Files\Filesystem::resolvePath($target);
- if ($targetStorage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
- $result = true;
- } else {
- \OCP\Util::writeLog('files',
- 'It is not allowed to move one mount point into another one',
- \OCP\Util::DEBUG);
- }
- return $result;
- }
- /**
- * 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));
- 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
- );
- }
- /**
- * @return Updater
- */
- public function getUpdater() {
- return $this->updater;
- }
- /**
- * @param string $path
- * @param string $fileName
- * @throws InvalidPathException
- */
- public function verifyPath($path, $fileName) {
- $l10n = \OC::$server->getL10N('lib');
- // verify empty and dot files
- $trimmed = trim($fileName);
- if ($trimmed === '') {
- throw new InvalidPathException($l10n->t('Empty filename is not allowed'));
- }
- if ($trimmed === '.' || $trimmed === '..') {
- throw new InvalidPathException($l10n->t('Dot files are not allowed'));
- }
- // verify database - e.g. mysql only 3-byte chars
- if (preg_match('%(?:
- \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
- | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
- | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
- )%xs', $fileName)) {
- throw new InvalidPathException($l10n->t('4-byte characters are not supported in file names'));
- }
- try {
- /** @type \OCP\Files\Storage $storage */
- list($storage, $internalPath) = $this->resolvePath($path);
- $storage->verifyPath($internalPath, $fileName);
- } catch (ReservedWordException $ex) {
- throw new InvalidPathException($l10n->t('File name is a reserved word'));
- } catch (InvalidCharacterInPathException $ex) {
- throw new InvalidPathException($l10n->t('File name contains at least one invalid character'));
- } catch (FileNameTooLongException $ex) {
- throw new InvalidPathException($l10n->t('File name is too long'));
- }
- }
- /**
- * 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 {
- $mount->getStorage()->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 {
- $mount->getStorage()->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) {
- $mount->getStorage()->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';
- }
- 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 '';
- }
- }
|