You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

View.php 65KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. * @author Ashod Nakashian <ashod.nakashian@collabora.co.uk>
  7. * @author Bart Visscher <bartv@thisnet.nl>
  8. * @author Björn Schießle <bjoern@schiessle.org>
  9. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  10. * @author Florin Peter <github@florin-peter.de>
  11. * @author Jesús Macias <jmacias@solidgear.es>
  12. * @author Joas Schilling <coding@schilljs.com>
  13. * @author Jörn Friedrich Dreyer <jfd@butonic.de>
  14. * @author Julius Härtl <jus@bitgrid.net>
  15. * @author karakayasemi <karakayasemi@itu.edu.tr>
  16. * @author Klaas Freitag <freitag@owncloud.com>
  17. * @author korelstar <korelstar@users.noreply.github.com>
  18. * @author Lukas Reschke <lukas@statuscode.ch>
  19. * @author Luke Policinski <lpolicinski@gmail.com>
  20. * @author Michael Gapczynski <GapczynskiM@gmail.com>
  21. * @author Morris Jobke <hey@morrisjobke.de>
  22. * @author Piotr Filiciak <piotr@filiciak.pl>
  23. * @author Robin Appelman <robin@icewind.nl>
  24. * @author Robin McCorkell <robin@mccorkell.me.uk>
  25. * @author Roeland Jago Douma <roeland@famdouma.nl>
  26. * @author Sam Tuke <mail@samtuke.com>
  27. * @author Scott Dutton <exussum12@users.noreply.github.com>
  28. * @author Thomas Müller <thomas.mueller@tmit.eu>
  29. * @author Thomas Tanghus <thomas@tanghus.net>
  30. * @author Vincent Petry <vincent@nextcloud.com>
  31. *
  32. * @license AGPL-3.0
  33. *
  34. * This code is free software: you can redistribute it and/or modify
  35. * it under the terms of the GNU Affero General Public License, version 3,
  36. * as published by the Free Software Foundation.
  37. *
  38. * This program is distributed in the hope that it will be useful,
  39. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  40. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  41. * GNU Affero General Public License for more details.
  42. *
  43. * You should have received a copy of the GNU Affero General Public License, version 3,
  44. * along with this program. If not, see <http://www.gnu.org/licenses/>
  45. *
  46. */
  47. namespace OC\Files;
  48. use Icewind\Streams\CallbackWrapper;
  49. use OC\Files\Mount\MoveableMount;
  50. use OC\Files\Storage\Storage;
  51. use OC\Share\Share;
  52. use OC\User\LazyUser;
  53. use OC\User\Manager as UserManager;
  54. use OC\User\User;
  55. use OCA\Files_Sharing\SharedMount;
  56. use OCP\Constants;
  57. use OCP\Files\Cache\ICacheEntry;
  58. use OCP\Files\ConnectionLostException;
  59. use OCP\Files\EmptyFileNameException;
  60. use OCP\Files\FileNameTooLongException;
  61. use OCP\Files\InvalidCharacterInPathException;
  62. use OCP\Files\InvalidDirectoryException;
  63. use OCP\Files\InvalidPathException;
  64. use OCP\Files\Mount\IMountPoint;
  65. use OCP\Files\NotFoundException;
  66. use OCP\Files\ReservedWordException;
  67. use OCP\Files\Storage\IStorage;
  68. use OCP\IUser;
  69. use OCP\Lock\ILockingProvider;
  70. use OCP\Lock\LockedException;
  71. use Psr\Log\LoggerInterface;
  72. /**
  73. * Class to provide access to ownCloud filesystem via a "view", and methods for
  74. * working with files within that view (e.g. read, write, delete, etc.). Each
  75. * view is restricted to a set of directories via a virtual root. The default view
  76. * uses the currently logged in user's data directory as root (parts of
  77. * OC_Filesystem are merely a wrapper for OC\Files\View).
  78. *
  79. * Apps that need to access files outside of the user data folders (to modify files
  80. * belonging to a user other than the one currently logged in, for example) should
  81. * use this class directly rather than using OC_Filesystem, or making use of PHP's
  82. * built-in file manipulation functions. This will ensure all hooks and proxies
  83. * are triggered correctly.
  84. *
  85. * Filesystem functions are not called directly; they are passed to the correct
  86. * \OC\Files\Storage\Storage object
  87. */
  88. class View {
  89. private string $fakeRoot = '';
  90. private ILockingProvider $lockingProvider;
  91. private bool $lockingEnabled;
  92. private bool $updaterEnabled = true;
  93. private UserManager $userManager;
  94. private LoggerInterface $logger;
  95. /**
  96. * @throws \Exception If $root contains an invalid path
  97. */
  98. public function __construct(string $root = '') {
  99. if (!Filesystem::isValidPath($root)) {
  100. throw new \Exception();
  101. }
  102. $this->fakeRoot = $root;
  103. $this->lockingProvider = \OC::$server->getLockingProvider();
  104. $this->lockingEnabled = !($this->lockingProvider instanceof \OC\Lock\NoopLockingProvider);
  105. $this->userManager = \OC::$server->getUserManager();
  106. $this->logger = \OC::$server->get(LoggerInterface::class);
  107. }
  108. /**
  109. * @param ?string $path
  110. * @psalm-template S as string|null
  111. * @psalm-param S $path
  112. * @psalm-return (S is string ? string : null)
  113. */
  114. public function getAbsolutePath($path = '/'): ?string {
  115. if ($path === null) {
  116. return null;
  117. }
  118. $this->assertPathLength($path);
  119. if ($path === '') {
  120. $path = '/';
  121. }
  122. if ($path[0] !== '/') {
  123. $path = '/' . $path;
  124. }
  125. return $this->fakeRoot . $path;
  126. }
  127. /**
  128. * Change the root to a fake root
  129. *
  130. * @param string $fakeRoot
  131. */
  132. public function chroot($fakeRoot): void {
  133. if (!$fakeRoot == '') {
  134. if ($fakeRoot[0] !== '/') {
  135. $fakeRoot = '/' . $fakeRoot;
  136. }
  137. }
  138. $this->fakeRoot = $fakeRoot;
  139. }
  140. /**
  141. * Get the fake root
  142. */
  143. public function getRoot(): string {
  144. return $this->fakeRoot;
  145. }
  146. /**
  147. * get path relative to the root of the view
  148. *
  149. * @param string $path
  150. */
  151. public function getRelativePath($path): ?string {
  152. $this->assertPathLength($path);
  153. if ($this->fakeRoot == '') {
  154. return $path;
  155. }
  156. if (rtrim($path, '/') === rtrim($this->fakeRoot, '/')) {
  157. return '/';
  158. }
  159. // missing slashes can cause wrong matches!
  160. $root = rtrim($this->fakeRoot, '/') . '/';
  161. if (!str_starts_with($path, $root)) {
  162. return null;
  163. } else {
  164. $path = substr($path, strlen($this->fakeRoot));
  165. if (strlen($path) === 0) {
  166. return '/';
  167. } else {
  168. return $path;
  169. }
  170. }
  171. }
  172. /**
  173. * Get the mountpoint of the storage object for a path
  174. * ( note: because a storage is not always mounted inside the fakeroot, the
  175. * returned mountpoint is relative to the absolute root of the filesystem
  176. * and does not take the chroot into account )
  177. *
  178. * @param string $path
  179. */
  180. public function getMountPoint($path): string {
  181. return Filesystem::getMountPoint($this->getAbsolutePath($path));
  182. }
  183. /**
  184. * Get the mountpoint of the storage object for a path
  185. * ( note: because a storage is not always mounted inside the fakeroot, the
  186. * returned mountpoint is relative to the absolute root of the filesystem
  187. * and does not take the chroot into account )
  188. *
  189. * @param string $path
  190. */
  191. public function getMount($path): IMountPoint {
  192. return Filesystem::getMountManager()->find($this->getAbsolutePath($path));
  193. }
  194. /**
  195. * Resolve a path to a storage and internal path
  196. *
  197. * @param string $path
  198. * @return array{?\OCP\Files\Storage\IStorage, string} an array consisting of the storage and the internal path
  199. */
  200. public function resolvePath($path): array {
  201. $a = $this->getAbsolutePath($path);
  202. $p = Filesystem::normalizePath($a);
  203. return Filesystem::resolvePath($p);
  204. }
  205. /**
  206. * Return the path to a local version of the file
  207. * we need this because we can't know if a file is stored local or not from
  208. * outside the filestorage and for some purposes a local file is needed
  209. *
  210. * @param string $path
  211. */
  212. public function getLocalFile($path): string|false {
  213. $parent = substr($path, 0, strrpos($path, '/') ?: 0);
  214. $path = $this->getAbsolutePath($path);
  215. [$storage, $internalPath] = Filesystem::resolvePath($path);
  216. if (Filesystem::isValidPath($parent) && $storage) {
  217. return $storage->getLocalFile($internalPath);
  218. } else {
  219. return false;
  220. }
  221. }
  222. /**
  223. * the following functions operate with arguments and return values identical
  224. * to those of their PHP built-in equivalents. Mostly they are merely wrappers
  225. * for \OC\Files\Storage\Storage via basicOperation().
  226. */
  227. public function mkdir($path) {
  228. return $this->basicOperation('mkdir', $path, ['create', 'write']);
  229. }
  230. /**
  231. * remove mount point
  232. *
  233. * @param IMountPoint $mount
  234. * @param string $path relative to data/
  235. */
  236. protected function removeMount($mount, $path): bool {
  237. if ($mount instanceof MoveableMount) {
  238. // cut of /user/files to get the relative path to data/user/files
  239. $pathParts = explode('/', $path, 4);
  240. $relPath = '/' . $pathParts[3];
  241. $this->lockFile($relPath, ILockingProvider::LOCK_SHARED, true);
  242. \OC_Hook::emit(
  243. Filesystem::CLASSNAME, "umount",
  244. [Filesystem::signal_param_path => $relPath]
  245. );
  246. $this->changeLock($relPath, ILockingProvider::LOCK_EXCLUSIVE, true);
  247. $result = $mount->removeMount();
  248. $this->changeLock($relPath, ILockingProvider::LOCK_SHARED, true);
  249. if ($result) {
  250. \OC_Hook::emit(
  251. Filesystem::CLASSNAME, "post_umount",
  252. [Filesystem::signal_param_path => $relPath]
  253. );
  254. }
  255. $this->unlockFile($relPath, ILockingProvider::LOCK_SHARED, true);
  256. return $result;
  257. } else {
  258. // do not allow deleting the storage's root / the mount point
  259. // because for some storages it might delete the whole contents
  260. // but isn't supposed to work that way
  261. return false;
  262. }
  263. }
  264. public function disableCacheUpdate(): void {
  265. $this->updaterEnabled = false;
  266. }
  267. public function enableCacheUpdate(): void {
  268. $this->updaterEnabled = true;
  269. }
  270. protected function writeUpdate(Storage $storage, string $internalPath, ?int $time = null, ?int $sizeDifference = null): void {
  271. if ($this->updaterEnabled) {
  272. if (is_null($time)) {
  273. $time = time();
  274. }
  275. $storage->getUpdater()->update($internalPath, $time, $sizeDifference);
  276. }
  277. }
  278. protected function removeUpdate(Storage $storage, string $internalPath): void {
  279. if ($this->updaterEnabled) {
  280. $storage->getUpdater()->remove($internalPath);
  281. }
  282. }
  283. protected function renameUpdate(Storage $sourceStorage, Storage $targetStorage, string $sourceInternalPath, string $targetInternalPath): void {
  284. if ($this->updaterEnabled) {
  285. $targetStorage->getUpdater()->renameFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
  286. }
  287. }
  288. /**
  289. * @param string $path
  290. * @return bool|mixed
  291. */
  292. public function rmdir($path) {
  293. $absolutePath = $this->getAbsolutePath($path);
  294. $mount = Filesystem::getMountManager()->find($absolutePath);
  295. if ($mount->getInternalPath($absolutePath) === '') {
  296. return $this->removeMount($mount, $absolutePath);
  297. }
  298. if ($this->is_dir($path)) {
  299. $result = $this->basicOperation('rmdir', $path, ['delete']);
  300. } else {
  301. $result = false;
  302. }
  303. if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
  304. $storage = $mount->getStorage();
  305. $internalPath = $mount->getInternalPath($absolutePath);
  306. $storage->getUpdater()->remove($internalPath);
  307. }
  308. return $result;
  309. }
  310. /**
  311. * @param string $path
  312. * @return resource|false
  313. */
  314. public function opendir($path) {
  315. return $this->basicOperation('opendir', $path, ['read']);
  316. }
  317. /**
  318. * @param string $path
  319. * @return bool|mixed
  320. */
  321. public function is_dir($path) {
  322. if ($path == '/') {
  323. return true;
  324. }
  325. return $this->basicOperation('is_dir', $path);
  326. }
  327. /**
  328. * @param string $path
  329. * @return bool|mixed
  330. */
  331. public function is_file($path) {
  332. if ($path == '/') {
  333. return false;
  334. }
  335. return $this->basicOperation('is_file', $path);
  336. }
  337. /**
  338. * @param string $path
  339. * @return mixed
  340. */
  341. public function stat($path) {
  342. return $this->basicOperation('stat', $path);
  343. }
  344. /**
  345. * @param string $path
  346. * @return mixed
  347. */
  348. public function filetype($path) {
  349. return $this->basicOperation('filetype', $path);
  350. }
  351. /**
  352. * @param string $path
  353. * @return mixed
  354. */
  355. public function filesize(string $path) {
  356. return $this->basicOperation('filesize', $path);
  357. }
  358. /**
  359. * @param string $path
  360. * @return bool|mixed
  361. * @throws InvalidPathException
  362. */
  363. public function readfile($path) {
  364. $this->assertPathLength($path);
  365. if (ob_get_level()) {
  366. ob_end_clean();
  367. }
  368. $handle = $this->fopen($path, 'rb');
  369. if ($handle) {
  370. $chunkSize = 524288; // 512 kiB chunks
  371. while (!feof($handle)) {
  372. echo fread($handle, $chunkSize);
  373. flush();
  374. $this->checkConnectionStatus();
  375. }
  376. fclose($handle);
  377. return $this->filesize($path);
  378. }
  379. return false;
  380. }
  381. /**
  382. * @param string $path
  383. * @param int $from
  384. * @param int $to
  385. * @return bool|mixed
  386. * @throws InvalidPathException
  387. * @throws \OCP\Files\UnseekableException
  388. */
  389. public function readfilePart($path, $from, $to) {
  390. $this->assertPathLength($path);
  391. if (ob_get_level()) {
  392. ob_end_clean();
  393. }
  394. $handle = $this->fopen($path, 'rb');
  395. if ($handle) {
  396. $chunkSize = 524288; // 512 kiB chunks
  397. $startReading = true;
  398. if ($from !== 0 && $from !== '0' && fseek($handle, $from) !== 0) {
  399. // forward file handle via chunked fread because fseek seem to have failed
  400. $end = $from + 1;
  401. while (!feof($handle) && ftell($handle) < $end && ftell($handle) !== $from) {
  402. $len = $from - ftell($handle);
  403. if ($len > $chunkSize) {
  404. $len = $chunkSize;
  405. }
  406. $result = fread($handle, $len);
  407. if ($result === false) {
  408. $startReading = false;
  409. break;
  410. }
  411. }
  412. }
  413. if ($startReading) {
  414. $end = $to + 1;
  415. while (!feof($handle) && ftell($handle) < $end) {
  416. $len = $end - ftell($handle);
  417. if ($len > $chunkSize) {
  418. $len = $chunkSize;
  419. }
  420. echo fread($handle, $len);
  421. flush();
  422. $this->checkConnectionStatus();
  423. }
  424. return ftell($handle) - $from;
  425. }
  426. throw new \OCP\Files\UnseekableException('fseek error');
  427. }
  428. return false;
  429. }
  430. private function checkConnectionStatus(): void {
  431. $connectionStatus = \connection_status();
  432. if ($connectionStatus !== CONNECTION_NORMAL) {
  433. throw new ConnectionLostException("Connection lost. Status: $connectionStatus");
  434. }
  435. }
  436. /**
  437. * @param string $path
  438. * @return mixed
  439. */
  440. public function isCreatable($path) {
  441. return $this->basicOperation('isCreatable', $path);
  442. }
  443. /**
  444. * @param string $path
  445. * @return mixed
  446. */
  447. public function isReadable($path) {
  448. return $this->basicOperation('isReadable', $path);
  449. }
  450. /**
  451. * @param string $path
  452. * @return mixed
  453. */
  454. public function isUpdatable($path) {
  455. return $this->basicOperation('isUpdatable', $path);
  456. }
  457. /**
  458. * @param string $path
  459. * @return bool|mixed
  460. */
  461. public function isDeletable($path) {
  462. $absolutePath = $this->getAbsolutePath($path);
  463. $mount = Filesystem::getMountManager()->find($absolutePath);
  464. if ($mount->getInternalPath($absolutePath) === '') {
  465. return $mount instanceof MoveableMount;
  466. }
  467. return $this->basicOperation('isDeletable', $path);
  468. }
  469. /**
  470. * @param string $path
  471. * @return mixed
  472. */
  473. public function isSharable($path) {
  474. return $this->basicOperation('isSharable', $path);
  475. }
  476. /**
  477. * @param string $path
  478. * @return bool|mixed
  479. */
  480. public function file_exists($path) {
  481. if ($path == '/') {
  482. return true;
  483. }
  484. return $this->basicOperation('file_exists', $path);
  485. }
  486. /**
  487. * @param string $path
  488. * @return mixed
  489. */
  490. public function filemtime($path) {
  491. return $this->basicOperation('filemtime', $path);
  492. }
  493. /**
  494. * @param string $path
  495. * @param int|string $mtime
  496. */
  497. public function touch($path, $mtime = null): bool {
  498. if (!is_null($mtime) && !is_numeric($mtime)) {
  499. $mtime = strtotime($mtime);
  500. }
  501. $hooks = ['touch'];
  502. if (!$this->file_exists($path)) {
  503. $hooks[] = 'create';
  504. $hooks[] = 'write';
  505. }
  506. try {
  507. $result = $this->basicOperation('touch', $path, $hooks, $mtime);
  508. } catch (\Exception $e) {
  509. $this->logger->info('Error while setting modified time', ['app' => 'core', 'exception' => $e]);
  510. $result = false;
  511. }
  512. if (!$result) {
  513. // If create file fails because of permissions on external storage like SMB folders,
  514. // check file exists and return false if not.
  515. if (!$this->file_exists($path)) {
  516. return false;
  517. }
  518. if (is_null($mtime)) {
  519. $mtime = time();
  520. }
  521. //if native touch fails, we emulate it by changing the mtime in the cache
  522. $this->putFileInfo($path, ['mtime' => floor($mtime)]);
  523. }
  524. return true;
  525. }
  526. /**
  527. * @param string $path
  528. * @return string|false
  529. * @throws LockedException
  530. */
  531. public function file_get_contents($path) {
  532. return $this->basicOperation('file_get_contents', $path, ['read']);
  533. }
  534. protected function emit_file_hooks_pre(bool $exists, string $path, bool &$run): void {
  535. if (!$exists) {
  536. \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, [
  537. Filesystem::signal_param_path => $this->getHookPath($path),
  538. Filesystem::signal_param_run => &$run,
  539. ]);
  540. } else {
  541. \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_update, [
  542. Filesystem::signal_param_path => $this->getHookPath($path),
  543. Filesystem::signal_param_run => &$run,
  544. ]);
  545. }
  546. \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_write, [
  547. Filesystem::signal_param_path => $this->getHookPath($path),
  548. Filesystem::signal_param_run => &$run,
  549. ]);
  550. }
  551. protected function emit_file_hooks_post(bool $exists, string $path): void {
  552. if (!$exists) {
  553. \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, [
  554. Filesystem::signal_param_path => $this->getHookPath($path),
  555. ]);
  556. } else {
  557. \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_update, [
  558. Filesystem::signal_param_path => $this->getHookPath($path),
  559. ]);
  560. }
  561. \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_write, [
  562. Filesystem::signal_param_path => $this->getHookPath($path),
  563. ]);
  564. }
  565. /**
  566. * @param string $path
  567. * @param string|resource $data
  568. * @return bool|mixed
  569. * @throws LockedException
  570. */
  571. public function file_put_contents($path, $data) {
  572. if (is_resource($data)) { //not having to deal with streams in file_put_contents makes life easier
  573. $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
  574. if (Filesystem::isValidPath($path)
  575. && !Filesystem::isFileBlacklisted($path)
  576. ) {
  577. $path = $this->getRelativePath($absolutePath);
  578. if ($path === null) {
  579. throw new InvalidPathException("Path $absolutePath is not in the expected root");
  580. }
  581. $this->lockFile($path, ILockingProvider::LOCK_SHARED);
  582. $exists = $this->file_exists($path);
  583. $run = true;
  584. if ($this->shouldEmitHooks($path)) {
  585. $this->emit_file_hooks_pre($exists, $path, $run);
  586. }
  587. if (!$run) {
  588. $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
  589. return false;
  590. }
  591. try {
  592. $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
  593. } catch (\Exception $e) {
  594. // Release the shared lock before throwing.
  595. $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
  596. throw $e;
  597. }
  598. /** @var Storage $storage */
  599. [$storage, $internalPath] = $this->resolvePath($path);
  600. $target = $storage->fopen($internalPath, 'w');
  601. if ($target) {
  602. [, $result] = \OC_Helper::streamCopy($data, $target);
  603. fclose($target);
  604. fclose($data);
  605. $this->writeUpdate($storage, $internalPath);
  606. $this->changeLock($path, ILockingProvider::LOCK_SHARED);
  607. if ($this->shouldEmitHooks($path) && $result !== false) {
  608. $this->emit_file_hooks_post($exists, $path);
  609. }
  610. $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
  611. return $result;
  612. } else {
  613. $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
  614. return false;
  615. }
  616. } else {
  617. return false;
  618. }
  619. } else {
  620. $hooks = $this->file_exists($path) ? ['update', 'write'] : ['create', 'write'];
  621. return $this->basicOperation('file_put_contents', $path, $hooks, $data);
  622. }
  623. }
  624. /**
  625. * @param string $path
  626. * @return bool|mixed
  627. */
  628. public function unlink($path) {
  629. if ($path === '' || $path === '/') {
  630. // do not allow deleting the root
  631. return false;
  632. }
  633. $postFix = (substr($path, -1) === '/') ? '/' : '';
  634. $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
  635. $mount = Filesystem::getMountManager()->find($absolutePath . $postFix);
  636. if ($mount->getInternalPath($absolutePath) === '') {
  637. return $this->removeMount($mount, $absolutePath);
  638. }
  639. if ($this->is_dir($path)) {
  640. $result = $this->basicOperation('rmdir', $path, ['delete']);
  641. } else {
  642. $result = $this->basicOperation('unlink', $path, ['delete']);
  643. }
  644. if (!$result && !$this->file_exists($path)) { //clear ghost files from the cache on delete
  645. $storage = $mount->getStorage();
  646. $internalPath = $mount->getInternalPath($absolutePath);
  647. $storage->getUpdater()->remove($internalPath);
  648. return true;
  649. } else {
  650. return $result;
  651. }
  652. }
  653. /**
  654. * @param string $directory
  655. * @return bool|mixed
  656. */
  657. public function deleteAll($directory) {
  658. return $this->rmdir($directory);
  659. }
  660. /**
  661. * Rename/move a file or folder from the source path to target path.
  662. *
  663. * @param string $source source path
  664. * @param string $target target path
  665. *
  666. * @return bool|mixed
  667. * @throws LockedException
  668. */
  669. public function rename($source, $target) {
  670. $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($source));
  671. $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($target));
  672. $result = false;
  673. if (
  674. Filesystem::isValidPath($target)
  675. && Filesystem::isValidPath($source)
  676. && !Filesystem::isFileBlacklisted($target)
  677. ) {
  678. $source = $this->getRelativePath($absolutePath1);
  679. $target = $this->getRelativePath($absolutePath2);
  680. $exists = $this->file_exists($target);
  681. if ($source == null || $target == null) {
  682. return false;
  683. }
  684. $this->lockFile($source, ILockingProvider::LOCK_SHARED, true);
  685. try {
  686. $this->lockFile($target, ILockingProvider::LOCK_SHARED, true);
  687. $run = true;
  688. if ($this->shouldEmitHooks($source) && (Cache\Scanner::isPartialFile($source) && !Cache\Scanner::isPartialFile($target))) {
  689. // if it was a rename from a part file to a regular file it was a write and not a rename operation
  690. $this->emit_file_hooks_pre($exists, $target, $run);
  691. } elseif ($this->shouldEmitHooks($source)) {
  692. $sourcePath = $this->getHookPath($source);
  693. $targetPath = $this->getHookPath($target);
  694. if ($sourcePath !== null && $targetPath !== null) {
  695. \OC_Hook::emit(
  696. Filesystem::CLASSNAME, Filesystem::signal_rename,
  697. [
  698. Filesystem::signal_param_oldpath => $sourcePath,
  699. Filesystem::signal_param_newpath => $targetPath,
  700. Filesystem::signal_param_run => &$run
  701. ]
  702. );
  703. }
  704. }
  705. if ($run) {
  706. $this->verifyPath(dirname($target), basename($target));
  707. $manager = Filesystem::getMountManager();
  708. $mount1 = $this->getMount($source);
  709. $mount2 = $this->getMount($target);
  710. $storage1 = $mount1->getStorage();
  711. $storage2 = $mount2->getStorage();
  712. $internalPath1 = $mount1->getInternalPath($absolutePath1);
  713. $internalPath2 = $mount2->getInternalPath($absolutePath2);
  714. $this->changeLock($source, ILockingProvider::LOCK_EXCLUSIVE, true);
  715. try {
  716. $this->changeLock($target, ILockingProvider::LOCK_EXCLUSIVE, true);
  717. if ($internalPath1 === '') {
  718. if ($mount1 instanceof MoveableMount) {
  719. $sourceParentMount = $this->getMount(dirname($source));
  720. if ($sourceParentMount === $mount2 && $this->targetIsNotShared($storage2, $internalPath2)) {
  721. /**
  722. * @var \OC\Files\Mount\MountPoint | \OC\Files\Mount\MoveableMount $mount1
  723. */
  724. $sourceMountPoint = $mount1->getMountPoint();
  725. $result = $mount1->moveMount($absolutePath2);
  726. $manager->moveMount($sourceMountPoint, $mount1->getMountPoint());
  727. } else {
  728. $result = false;
  729. }
  730. } else {
  731. $result = false;
  732. }
  733. // moving a file/folder within the same mount point
  734. } elseif ($storage1 === $storage2) {
  735. if ($storage1) {
  736. $result = $storage1->rename($internalPath1, $internalPath2);
  737. } else {
  738. $result = false;
  739. }
  740. // moving a file/folder between storages (from $storage1 to $storage2)
  741. } else {
  742. $result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
  743. }
  744. if ((Cache\Scanner::isPartialFile($source) && !Cache\Scanner::isPartialFile($target)) && $result !== false) {
  745. // if it was a rename from a part file to a regular file it was a write and not a rename operation
  746. $this->writeUpdate($storage2, $internalPath2);
  747. } elseif ($result) {
  748. if ($internalPath1 !== '') { // don't do a cache update for moved mounts
  749. $this->renameUpdate($storage1, $storage2, $internalPath1, $internalPath2);
  750. }
  751. }
  752. } catch (\Exception $e) {
  753. throw $e;
  754. } finally {
  755. $this->changeLock($source, ILockingProvider::LOCK_SHARED, true);
  756. $this->changeLock($target, ILockingProvider::LOCK_SHARED, true);
  757. }
  758. if ((Cache\Scanner::isPartialFile($source) && !Cache\Scanner::isPartialFile($target)) && $result !== false) {
  759. if ($this->shouldEmitHooks()) {
  760. $this->emit_file_hooks_post($exists, $target);
  761. }
  762. } elseif ($result) {
  763. if ($this->shouldEmitHooks($source) && $this->shouldEmitHooks($target)) {
  764. $sourcePath = $this->getHookPath($source);
  765. $targetPath = $this->getHookPath($target);
  766. if ($sourcePath !== null && $targetPath !== null) {
  767. \OC_Hook::emit(
  768. Filesystem::CLASSNAME,
  769. Filesystem::signal_post_rename,
  770. [
  771. Filesystem::signal_param_oldpath => $sourcePath,
  772. Filesystem::signal_param_newpath => $targetPath,
  773. ]
  774. );
  775. }
  776. }
  777. }
  778. }
  779. } catch (\Exception $e) {
  780. throw $e;
  781. } finally {
  782. $this->unlockFile($source, ILockingProvider::LOCK_SHARED, true);
  783. $this->unlockFile($target, ILockingProvider::LOCK_SHARED, true);
  784. }
  785. }
  786. return $result;
  787. }
  788. /**
  789. * Copy a file/folder from the source path to target path
  790. *
  791. * @param string $source source path
  792. * @param string $target target path
  793. * @param bool $preserveMtime whether to preserve mtime on the copy
  794. *
  795. * @return bool|mixed
  796. */
  797. public function copy($source, $target, $preserveMtime = false) {
  798. $absolutePath1 = Filesystem::normalizePath($this->getAbsolutePath($source));
  799. $absolutePath2 = Filesystem::normalizePath($this->getAbsolutePath($target));
  800. $result = false;
  801. if (
  802. Filesystem::isValidPath($target)
  803. && Filesystem::isValidPath($source)
  804. && !Filesystem::isFileBlacklisted($target)
  805. ) {
  806. $source = $this->getRelativePath($absolutePath1);
  807. $target = $this->getRelativePath($absolutePath2);
  808. if ($source == null || $target == null) {
  809. return false;
  810. }
  811. $run = true;
  812. $this->lockFile($target, ILockingProvider::LOCK_SHARED);
  813. $this->lockFile($source, ILockingProvider::LOCK_SHARED);
  814. $lockTypePath1 = ILockingProvider::LOCK_SHARED;
  815. $lockTypePath2 = ILockingProvider::LOCK_SHARED;
  816. try {
  817. $exists = $this->file_exists($target);
  818. if ($this->shouldEmitHooks()) {
  819. \OC_Hook::emit(
  820. Filesystem::CLASSNAME,
  821. Filesystem::signal_copy,
  822. [
  823. Filesystem::signal_param_oldpath => $this->getHookPath($source),
  824. Filesystem::signal_param_newpath => $this->getHookPath($target),
  825. Filesystem::signal_param_run => &$run
  826. ]
  827. );
  828. $this->emit_file_hooks_pre($exists, $target, $run);
  829. }
  830. if ($run) {
  831. $mount1 = $this->getMount($source);
  832. $mount2 = $this->getMount($target);
  833. $storage1 = $mount1->getStorage();
  834. $internalPath1 = $mount1->getInternalPath($absolutePath1);
  835. $storage2 = $mount2->getStorage();
  836. $internalPath2 = $mount2->getInternalPath($absolutePath2);
  837. $this->changeLock($target, ILockingProvider::LOCK_EXCLUSIVE);
  838. $lockTypePath2 = ILockingProvider::LOCK_EXCLUSIVE;
  839. if ($mount1->getMountPoint() == $mount2->getMountPoint()) {
  840. if ($storage1) {
  841. $result = $storage1->copy($internalPath1, $internalPath2);
  842. } else {
  843. $result = false;
  844. }
  845. } else {
  846. $result = $storage2->copyFromStorage($storage1, $internalPath1, $internalPath2);
  847. }
  848. $this->writeUpdate($storage2, $internalPath2);
  849. $this->changeLock($target, ILockingProvider::LOCK_SHARED);
  850. $lockTypePath2 = ILockingProvider::LOCK_SHARED;
  851. if ($this->shouldEmitHooks() && $result !== false) {
  852. \OC_Hook::emit(
  853. Filesystem::CLASSNAME,
  854. Filesystem::signal_post_copy,
  855. [
  856. Filesystem::signal_param_oldpath => $this->getHookPath($source),
  857. Filesystem::signal_param_newpath => $this->getHookPath($target)
  858. ]
  859. );
  860. $this->emit_file_hooks_post($exists, $target);
  861. }
  862. }
  863. } catch (\Exception $e) {
  864. $this->unlockFile($target, $lockTypePath2);
  865. $this->unlockFile($source, $lockTypePath1);
  866. throw $e;
  867. }
  868. $this->unlockFile($target, $lockTypePath2);
  869. $this->unlockFile($source, $lockTypePath1);
  870. }
  871. return $result;
  872. }
  873. /**
  874. * @param string $path
  875. * @param string $mode 'r' or 'w'
  876. * @return resource|false
  877. * @throws LockedException
  878. */
  879. public function fopen($path, $mode) {
  880. $mode = str_replace('b', '', $mode); // the binary flag is a windows only feature which we do not support
  881. $hooks = [];
  882. switch ($mode) {
  883. case 'r':
  884. $hooks[] = 'read';
  885. break;
  886. case 'r+':
  887. case 'w+':
  888. case 'x+':
  889. case 'a+':
  890. $hooks[] = 'read';
  891. $hooks[] = 'write';
  892. break;
  893. case 'w':
  894. case 'x':
  895. case 'a':
  896. $hooks[] = 'write';
  897. break;
  898. default:
  899. $this->logger->error('invalid mode (' . $mode . ') for ' . $path, ['app' => 'core']);
  900. }
  901. if ($mode !== 'r' && $mode !== 'w') {
  902. $this->logger->info('Trying to open a file with a mode other than "r" or "w" can cause severe performance issues with some backends', ['app' => 'core']);
  903. }
  904. $handle = $this->basicOperation('fopen', $path, $hooks, $mode);
  905. if (!is_resource($handle) && $mode === 'r') {
  906. // trying to read a file that isn't on disk, check if the cache is out of sync and rescan if needed
  907. $mount = $this->getMount($path);
  908. $internalPath = $mount->getInternalPath($this->getAbsolutePath($path));
  909. $storage = $mount->getStorage();
  910. if ($storage->getCache()->inCache($internalPath) && !$storage->file_exists($path)) {
  911. $this->writeUpdate($storage, $internalPath);
  912. }
  913. }
  914. return $handle;
  915. }
  916. /**
  917. * @param string $path
  918. * @throws InvalidPathException
  919. */
  920. public function toTmpFile($path): string|false {
  921. $this->assertPathLength($path);
  922. if (Filesystem::isValidPath($path)) {
  923. $source = $this->fopen($path, 'r');
  924. if ($source) {
  925. $extension = pathinfo($path, PATHINFO_EXTENSION);
  926. $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($extension);
  927. file_put_contents($tmpFile, $source);
  928. return $tmpFile;
  929. } else {
  930. return false;
  931. }
  932. } else {
  933. return false;
  934. }
  935. }
  936. /**
  937. * @param string $tmpFile
  938. * @param string $path
  939. * @return bool|mixed
  940. * @throws InvalidPathException
  941. */
  942. public function fromTmpFile($tmpFile, $path) {
  943. $this->assertPathLength($path);
  944. if (Filesystem::isValidPath($path)) {
  945. // Get directory that the file is going into
  946. $filePath = dirname($path);
  947. // Create the directories if any
  948. if (!$this->file_exists($filePath)) {
  949. $result = $this->createParentDirectories($filePath);
  950. if ($result === false) {
  951. return false;
  952. }
  953. }
  954. $source = fopen($tmpFile, 'r');
  955. if ($source) {
  956. $result = $this->file_put_contents($path, $source);
  957. /**
  958. * $this->file_put_contents() might have already closed
  959. * the resource, so we check it, before trying to close it
  960. * to avoid messages in the error log.
  961. * @psalm-suppress RedundantCondition false-positive
  962. */
  963. if (is_resource($source)) {
  964. fclose($source);
  965. }
  966. unlink($tmpFile);
  967. return $result;
  968. } else {
  969. return false;
  970. }
  971. } else {
  972. return false;
  973. }
  974. }
  975. /**
  976. * @param string $path
  977. * @return mixed
  978. * @throws InvalidPathException
  979. */
  980. public function getMimeType($path) {
  981. $this->assertPathLength($path);
  982. return $this->basicOperation('getMimeType', $path);
  983. }
  984. /**
  985. * @param string $type
  986. * @param string $path
  987. * @param bool $raw
  988. */
  989. public function hash($type, $path, $raw = false): string|bool {
  990. $postFix = (substr($path, -1) === '/') ? '/' : '';
  991. $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
  992. if (Filesystem::isValidPath($path)) {
  993. $path = $this->getRelativePath($absolutePath);
  994. if ($path == null) {
  995. return false;
  996. }
  997. if ($this->shouldEmitHooks($path)) {
  998. \OC_Hook::emit(
  999. Filesystem::CLASSNAME,
  1000. Filesystem::signal_read,
  1001. [Filesystem::signal_param_path => $this->getHookPath($path)]
  1002. );
  1003. }
  1004. /** @var Storage|null $storage */
  1005. [$storage, $internalPath] = Filesystem::resolvePath($absolutePath . $postFix);
  1006. if ($storage) {
  1007. return $storage->hash($type, $internalPath, $raw);
  1008. }
  1009. }
  1010. return false;
  1011. }
  1012. /**
  1013. * @param string $path
  1014. * @return mixed
  1015. * @throws InvalidPathException
  1016. */
  1017. public function free_space($path = '/') {
  1018. $this->assertPathLength($path);
  1019. $result = $this->basicOperation('free_space', $path);
  1020. if ($result === null) {
  1021. throw new InvalidPathException();
  1022. }
  1023. return $result;
  1024. }
  1025. /**
  1026. * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage
  1027. *
  1028. * @param mixed $extraParam (optional)
  1029. * @return mixed
  1030. * @throws LockedException
  1031. *
  1032. * This method takes requests for basic filesystem functions (e.g. reading & writing
  1033. * files), processes hooks and proxies, sanitises paths, and finally passes them on to
  1034. * \OC\Files\Storage\Storage for delegation to a storage backend for execution
  1035. */
  1036. private function basicOperation(string $operation, string $path, array $hooks = [], $extraParam = null) {
  1037. $postFix = (substr($path, -1) === '/') ? '/' : '';
  1038. $absolutePath = Filesystem::normalizePath($this->getAbsolutePath($path));
  1039. if (Filesystem::isValidPath($path)
  1040. && !Filesystem::isFileBlacklisted($path)
  1041. ) {
  1042. $path = $this->getRelativePath($absolutePath);
  1043. if ($path == null) {
  1044. return false;
  1045. }
  1046. if (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks)) {
  1047. // always a shared lock during pre-hooks so the hook can read the file
  1048. $this->lockFile($path, ILockingProvider::LOCK_SHARED);
  1049. }
  1050. $run = $this->runHooks($hooks, $path);
  1051. [$storage, $internalPath] = Filesystem::resolvePath($absolutePath . $postFix);
  1052. if ($run && $storage) {
  1053. /** @var Storage $storage */
  1054. if (in_array('write', $hooks) || in_array('delete', $hooks)) {
  1055. try {
  1056. $this->changeLock($path, ILockingProvider::LOCK_EXCLUSIVE);
  1057. } catch (LockedException $e) {
  1058. // release the shared lock we acquired before quitting
  1059. $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
  1060. throw $e;
  1061. }
  1062. }
  1063. try {
  1064. if (!is_null($extraParam)) {
  1065. $result = $storage->$operation($internalPath, $extraParam);
  1066. } else {
  1067. $result = $storage->$operation($internalPath);
  1068. }
  1069. } catch (\Exception $e) {
  1070. if (in_array('write', $hooks) || in_array('delete', $hooks)) {
  1071. $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
  1072. } elseif (in_array('read', $hooks)) {
  1073. $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
  1074. }
  1075. throw $e;
  1076. }
  1077. if ($result !== false && in_array('delete', $hooks)) {
  1078. $this->removeUpdate($storage, $internalPath);
  1079. }
  1080. if ($result !== false && in_array('write', $hooks, true) && $operation !== 'fopen' && $operation !== 'touch') {
  1081. $isCreateOperation = $operation === 'mkdir' || ($operation === 'file_put_contents' && in_array('create', $hooks, true));
  1082. $sizeDifference = $operation === 'mkdir' ? 0 : $result;
  1083. $this->writeUpdate($storage, $internalPath, null, $isCreateOperation ? $sizeDifference : null);
  1084. }
  1085. if ($result !== false && in_array('touch', $hooks)) {
  1086. $this->writeUpdate($storage, $internalPath, $extraParam);
  1087. }
  1088. if ((in_array('write', $hooks) || in_array('delete', $hooks)) && ($operation !== 'fopen' || $result === false)) {
  1089. $this->changeLock($path, ILockingProvider::LOCK_SHARED);
  1090. }
  1091. $unlockLater = false;
  1092. if ($this->lockingEnabled && $operation === 'fopen' && is_resource($result)) {
  1093. $unlockLater = true;
  1094. // make sure our unlocking callback will still be called if connection is aborted
  1095. ignore_user_abort(true);
  1096. $result = CallbackWrapper::wrap($result, null, null, function () use ($hooks, $path) {
  1097. if (in_array('write', $hooks)) {
  1098. $this->unlockFile($path, ILockingProvider::LOCK_EXCLUSIVE);
  1099. } elseif (in_array('read', $hooks)) {
  1100. $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
  1101. }
  1102. });
  1103. }
  1104. if ($this->shouldEmitHooks($path) && $result !== false) {
  1105. if ($operation != 'fopen') { //no post hooks for fopen, the file stream is still open
  1106. $this->runHooks($hooks, $path, true);
  1107. }
  1108. }
  1109. if (!$unlockLater
  1110. && (in_array('write', $hooks) || in_array('delete', $hooks) || in_array('read', $hooks))
  1111. ) {
  1112. $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
  1113. }
  1114. return $result;
  1115. } else {
  1116. $this->unlockFile($path, ILockingProvider::LOCK_SHARED);
  1117. }
  1118. }
  1119. return null;
  1120. }
  1121. /**
  1122. * get the path relative to the default root for hook usage
  1123. *
  1124. * @param string $path
  1125. * @return ?string
  1126. */
  1127. private function getHookPath($path): ?string {
  1128. $view = Filesystem::getView();
  1129. if (!$view) {
  1130. return $path;
  1131. }
  1132. return $view->getRelativePath($this->getAbsolutePath($path));
  1133. }
  1134. private function shouldEmitHooks(string $path = ''): bool {
  1135. if ($path && Cache\Scanner::isPartialFile($path)) {
  1136. return false;
  1137. }
  1138. if (!Filesystem::$loaded) {
  1139. return false;
  1140. }
  1141. $defaultRoot = Filesystem::getRoot();
  1142. if ($defaultRoot === null) {
  1143. return false;
  1144. }
  1145. if ($this->fakeRoot === $defaultRoot) {
  1146. return true;
  1147. }
  1148. $fullPath = $this->getAbsolutePath($path);
  1149. if ($fullPath === $defaultRoot) {
  1150. return true;
  1151. }
  1152. return (strlen($fullPath) > strlen($defaultRoot)) && (substr($fullPath, 0, strlen($defaultRoot) + 1) === $defaultRoot . '/');
  1153. }
  1154. /**
  1155. * @param string[] $hooks
  1156. * @param string $path
  1157. * @param bool $post
  1158. * @return bool
  1159. */
  1160. private function runHooks($hooks, $path, $post = false) {
  1161. $relativePath = $path;
  1162. $path = $this->getHookPath($path);
  1163. $prefix = $post ? 'post_' : '';
  1164. $run = true;
  1165. if ($this->shouldEmitHooks($relativePath)) {
  1166. foreach ($hooks as $hook) {
  1167. if ($hook != 'read') {
  1168. \OC_Hook::emit(
  1169. Filesystem::CLASSNAME,
  1170. $prefix . $hook,
  1171. [
  1172. Filesystem::signal_param_run => &$run,
  1173. Filesystem::signal_param_path => $path
  1174. ]
  1175. );
  1176. } elseif (!$post) {
  1177. \OC_Hook::emit(
  1178. Filesystem::CLASSNAME,
  1179. $prefix . $hook,
  1180. [
  1181. Filesystem::signal_param_path => $path
  1182. ]
  1183. );
  1184. }
  1185. }
  1186. }
  1187. return $run;
  1188. }
  1189. /**
  1190. * check if a file or folder has been updated since $time
  1191. *
  1192. * @param string $path
  1193. * @param int $time
  1194. * @return bool
  1195. */
  1196. public function hasUpdated($path, $time) {
  1197. return $this->basicOperation('hasUpdated', $path, [], $time);
  1198. }
  1199. /**
  1200. * @param string $ownerId
  1201. * @return IUser
  1202. */
  1203. private function getUserObjectForOwner(string $ownerId) {
  1204. return new LazyUser($ownerId, $this->userManager);
  1205. }
  1206. /**
  1207. * Get file info from cache
  1208. *
  1209. * If the file is not in cached it will be scanned
  1210. * If the file has changed on storage the cache will be updated
  1211. *
  1212. * @param Storage $storage
  1213. * @param string $internalPath
  1214. * @param string $relativePath
  1215. * @return ICacheEntry|bool
  1216. */
  1217. private function getCacheEntry($storage, $internalPath, $relativePath) {
  1218. $cache = $storage->getCache($internalPath);
  1219. $data = $cache->get($internalPath);
  1220. $watcher = $storage->getWatcher($internalPath);
  1221. try {
  1222. // if the file is not in the cache or needs to be updated, trigger the scanner and reload the data
  1223. if (!$data || (isset($data['size']) && $data['size'] === -1)) {
  1224. if (!$storage->file_exists($internalPath)) {
  1225. return false;
  1226. }
  1227. // don't need to get a lock here since the scanner does it's own locking
  1228. $scanner = $storage->getScanner($internalPath);
  1229. $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
  1230. $data = $cache->get($internalPath);
  1231. } elseif (!Cache\Scanner::isPartialFile($internalPath) && $watcher->needsUpdate($internalPath, $data)) {
  1232. $this->lockFile($relativePath, ILockingProvider::LOCK_SHARED);
  1233. $watcher->update($internalPath, $data);
  1234. $storage->getPropagator()->propagateChange($internalPath, time());
  1235. $data = $cache->get($internalPath);
  1236. $this->unlockFile($relativePath, ILockingProvider::LOCK_SHARED);
  1237. }
  1238. } catch (LockedException $e) {
  1239. // if the file is locked we just use the old cache info
  1240. }
  1241. return $data;
  1242. }
  1243. /**
  1244. * get the filesystem info
  1245. *
  1246. * @param string $path
  1247. * @param bool|string $includeMountPoints true to add mountpoint sizes,
  1248. * 'ext' to add only ext storage mount point sizes. Defaults to true.
  1249. * @return \OC\Files\FileInfo|false False if file does not exist
  1250. */
  1251. public function getFileInfo($path, $includeMountPoints = true) {
  1252. $this->assertPathLength($path);
  1253. if (!Filesystem::isValidPath($path)) {
  1254. return false;
  1255. }
  1256. if (Cache\Scanner::isPartialFile($path)) {
  1257. return $this->getPartFileInfo($path);
  1258. }
  1259. $relativePath = $path;
  1260. $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
  1261. $mount = Filesystem::getMountManager()->find($path);
  1262. $storage = $mount->getStorage();
  1263. $internalPath = $mount->getInternalPath($path);
  1264. if ($storage) {
  1265. $data = $this->getCacheEntry($storage, $internalPath, $relativePath);
  1266. if (!$data instanceof ICacheEntry) {
  1267. return false;
  1268. }
  1269. if ($mount instanceof MoveableMount && $internalPath === '') {
  1270. $data['permissions'] |= \OCP\Constants::PERMISSION_DELETE;
  1271. }
  1272. $ownerId = $storage->getOwner($internalPath);
  1273. $owner = null;
  1274. if ($ownerId !== null && $ownerId !== false) {
  1275. // ownerId might be null if files are accessed with an access token without file system access
  1276. $owner = $this->getUserObjectForOwner($ownerId);
  1277. }
  1278. $info = new FileInfo($path, $storage, $internalPath, $data, $mount, $owner);
  1279. if (isset($data['fileid'])) {
  1280. if ($includeMountPoints && $data['mimetype'] === 'httpd/unix-directory') {
  1281. //add the sizes of other mount points to the folder
  1282. $extOnly = ($includeMountPoints === 'ext');
  1283. $this->addSubMounts($info, $extOnly);
  1284. }
  1285. }
  1286. return $info;
  1287. } else {
  1288. $this->logger->warning('Storage not valid for mountpoint: ' . $mount->getMountPoint(), ['app' => 'core']);
  1289. }
  1290. return false;
  1291. }
  1292. /**
  1293. * Extend a FileInfo that was previously requested with `$includeMountPoints = false` to include the sub mounts
  1294. */
  1295. public function addSubMounts(FileInfo $info, $extOnly = false): void {
  1296. $mounts = Filesystem::getMountManager()->findIn($info->getPath());
  1297. $info->setSubMounts(array_filter($mounts, function (IMountPoint $mount) use ($extOnly) {
  1298. $subStorage = $mount->getStorage();
  1299. return !($extOnly && $subStorage instanceof \OCA\Files_Sharing\SharedStorage);
  1300. }));
  1301. }
  1302. /**
  1303. * get the content of a directory
  1304. *
  1305. * @param string $directory path under datadirectory
  1306. * @param string $mimetype_filter limit returned content to this mimetype or mimepart
  1307. * @return FileInfo[]
  1308. */
  1309. public function getDirectoryContent($directory, $mimetype_filter = '', \OCP\Files\FileInfo $directoryInfo = null) {
  1310. $this->assertPathLength($directory);
  1311. if (!Filesystem::isValidPath($directory)) {
  1312. return [];
  1313. }
  1314. $path = $this->getAbsolutePath($directory);
  1315. $path = Filesystem::normalizePath($path);
  1316. $mount = $this->getMount($directory);
  1317. $storage = $mount->getStorage();
  1318. $internalPath = $mount->getInternalPath($path);
  1319. if (!$storage) {
  1320. return [];
  1321. }
  1322. $cache = $storage->getCache($internalPath);
  1323. $user = \OC_User::getUser();
  1324. if (!$directoryInfo) {
  1325. $data = $this->getCacheEntry($storage, $internalPath, $directory);
  1326. if (!$data instanceof ICacheEntry || !isset($data['fileid'])) {
  1327. return [];
  1328. }
  1329. } else {
  1330. $data = $directoryInfo;
  1331. }
  1332. if (!($data->getPermissions() & Constants::PERMISSION_READ)) {
  1333. return [];
  1334. }
  1335. $folderId = $data->getId();
  1336. $contents = $cache->getFolderContentsById($folderId); //TODO: mimetype_filter
  1337. $sharingDisabled = \OCP\Util::isSharingDisabledForUser();
  1338. $fileNames = array_map(function (ICacheEntry $content) {
  1339. return $content->getName();
  1340. }, $contents);
  1341. /**
  1342. * @var \OC\Files\FileInfo[] $fileInfos
  1343. */
  1344. $fileInfos = array_map(function (ICacheEntry $content) use ($path, $storage, $mount, $sharingDisabled) {
  1345. if ($sharingDisabled) {
  1346. $content['permissions'] = $content['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
  1347. }
  1348. $owner = $this->getUserObjectForOwner($storage->getOwner($content['path']));
  1349. return new FileInfo($path . '/' . $content['name'], $storage, $content['path'], $content, $mount, $owner);
  1350. }, $contents);
  1351. $files = array_combine($fileNames, $fileInfos);
  1352. //add a folder for any mountpoint in this directory and add the sizes of other mountpoints to the folders
  1353. $mounts = Filesystem::getMountManager()->findIn($path);
  1354. $dirLength = strlen($path);
  1355. foreach ($mounts as $mount) {
  1356. $mountPoint = $mount->getMountPoint();
  1357. $subStorage = $mount->getStorage();
  1358. if ($subStorage) {
  1359. $subCache = $subStorage->getCache('');
  1360. $rootEntry = $subCache->get('');
  1361. if (!$rootEntry) {
  1362. $subScanner = $subStorage->getScanner();
  1363. try {
  1364. $subScanner->scanFile('');
  1365. } catch (\OCP\Files\StorageNotAvailableException $e) {
  1366. continue;
  1367. } catch (\OCP\Files\StorageInvalidException $e) {
  1368. continue;
  1369. } catch (\Exception $e) {
  1370. // sometimes when the storage is not available it can be any exception
  1371. $this->logger->error('Exception while scanning storage "' . $subStorage->getId() . '"', [
  1372. 'exception' => $e,
  1373. 'app' => 'core',
  1374. ]);
  1375. continue;
  1376. }
  1377. $rootEntry = $subCache->get('');
  1378. }
  1379. if ($rootEntry && ($rootEntry->getPermissions() & Constants::PERMISSION_READ)) {
  1380. $relativePath = trim(substr($mountPoint, $dirLength), '/');
  1381. if ($pos = strpos($relativePath, '/')) {
  1382. //mountpoint inside subfolder add size to the correct folder
  1383. $entryName = substr($relativePath, 0, $pos);
  1384. if (isset($files[$entryName])) {
  1385. $files[$entryName]->addSubEntry($rootEntry, $mountPoint);
  1386. }
  1387. } else { //mountpoint in this folder, add an entry for it
  1388. $rootEntry['name'] = $relativePath;
  1389. $rootEntry['type'] = $rootEntry['mimetype'] === 'httpd/unix-directory' ? 'dir' : 'file';
  1390. $permissions = $rootEntry['permissions'];
  1391. // do not allow renaming/deleting the mount point if they are not shared files/folders
  1392. // for shared files/folders we use the permissions given by the owner
  1393. if ($mount instanceof MoveableMount) {
  1394. $rootEntry['permissions'] = $permissions | \OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE;
  1395. } else {
  1396. $rootEntry['permissions'] = $permissions & (\OCP\Constants::PERMISSION_ALL - (\OCP\Constants::PERMISSION_UPDATE | \OCP\Constants::PERMISSION_DELETE));
  1397. }
  1398. $rootEntry['path'] = substr(Filesystem::normalizePath($path . '/' . $rootEntry['name']), strlen($user) + 2); // full path without /$user/
  1399. // if sharing was disabled for the user we remove the share permissions
  1400. if ($sharingDisabled) {
  1401. $rootEntry['permissions'] = $rootEntry['permissions'] & ~\OCP\Constants::PERMISSION_SHARE;
  1402. }
  1403. $owner = $this->getUserObjectForOwner($subStorage->getOwner(''));
  1404. $files[$rootEntry->getName()] = new FileInfo($path . '/' . $rootEntry['name'], $subStorage, '', $rootEntry, $mount, $owner);
  1405. }
  1406. }
  1407. }
  1408. }
  1409. if ($mimetype_filter) {
  1410. $files = array_filter($files, function (FileInfo $file) use ($mimetype_filter) {
  1411. if (strpos($mimetype_filter, '/')) {
  1412. return $file->getMimetype() === $mimetype_filter;
  1413. } else {
  1414. return $file->getMimePart() === $mimetype_filter;
  1415. }
  1416. });
  1417. }
  1418. return array_values($files);
  1419. }
  1420. /**
  1421. * change file metadata
  1422. *
  1423. * @param string $path
  1424. * @param array|\OCP\Files\FileInfo $data
  1425. * @return int
  1426. *
  1427. * returns the fileid of the updated file
  1428. */
  1429. public function putFileInfo($path, $data) {
  1430. $this->assertPathLength($path);
  1431. if ($data instanceof FileInfo) {
  1432. $data = $data->getData();
  1433. }
  1434. $path = Filesystem::normalizePath($this->fakeRoot . '/' . $path);
  1435. /**
  1436. * @var Storage $storage
  1437. * @var string $internalPath
  1438. */
  1439. [$storage, $internalPath] = Filesystem::resolvePath($path);
  1440. if ($storage) {
  1441. $cache = $storage->getCache($path);
  1442. if (!$cache->inCache($internalPath)) {
  1443. $scanner = $storage->getScanner($internalPath);
  1444. $scanner->scan($internalPath, Cache\Scanner::SCAN_SHALLOW);
  1445. }
  1446. return $cache->put($internalPath, $data);
  1447. } else {
  1448. return -1;
  1449. }
  1450. }
  1451. /**
  1452. * search for files with the name matching $query
  1453. *
  1454. * @param string $query
  1455. * @return FileInfo[]
  1456. */
  1457. public function search($query) {
  1458. return $this->searchCommon('search', ['%' . $query . '%']);
  1459. }
  1460. /**
  1461. * search for files with the name matching $query
  1462. *
  1463. * @param string $query
  1464. * @return FileInfo[]
  1465. */
  1466. public function searchRaw($query) {
  1467. return $this->searchCommon('search', [$query]);
  1468. }
  1469. /**
  1470. * search for files by mimetype
  1471. *
  1472. * @param string $mimetype
  1473. * @return FileInfo[]
  1474. */
  1475. public function searchByMime($mimetype) {
  1476. return $this->searchCommon('searchByMime', [$mimetype]);
  1477. }
  1478. /**
  1479. * search for files by tag
  1480. *
  1481. * @param string|int $tag name or tag id
  1482. * @param string $userId owner of the tags
  1483. * @return FileInfo[]
  1484. */
  1485. public function searchByTag($tag, $userId) {
  1486. return $this->searchCommon('searchByTag', [$tag, $userId]);
  1487. }
  1488. /**
  1489. * @param string $method cache method
  1490. * @param array $args
  1491. * @return FileInfo[]
  1492. */
  1493. private function searchCommon($method, $args) {
  1494. $files = [];
  1495. $rootLength = strlen($this->fakeRoot);
  1496. $mount = $this->getMount('');
  1497. $mountPoint = $mount->getMountPoint();
  1498. $storage = $mount->getStorage();
  1499. $userManager = \OC::$server->getUserManager();
  1500. if ($storage) {
  1501. $cache = $storage->getCache('');
  1502. $results = call_user_func_array([$cache, $method], $args);
  1503. foreach ($results as $result) {
  1504. if (substr($mountPoint . $result['path'], 0, $rootLength + 1) === $this->fakeRoot . '/') {
  1505. $internalPath = $result['path'];
  1506. $path = $mountPoint . $result['path'];
  1507. $result['path'] = substr($mountPoint . $result['path'], $rootLength);
  1508. $owner = $userManager->get($storage->getOwner($internalPath));
  1509. $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
  1510. }
  1511. }
  1512. $mounts = Filesystem::getMountManager()->findIn($this->fakeRoot);
  1513. foreach ($mounts as $mount) {
  1514. $mountPoint = $mount->getMountPoint();
  1515. $storage = $mount->getStorage();
  1516. if ($storage) {
  1517. $cache = $storage->getCache('');
  1518. $relativeMountPoint = substr($mountPoint, $rootLength);
  1519. $results = call_user_func_array([$cache, $method], $args);
  1520. if ($results) {
  1521. foreach ($results as $result) {
  1522. $internalPath = $result['path'];
  1523. $result['path'] = rtrim($relativeMountPoint . $result['path'], '/');
  1524. $path = rtrim($mountPoint . $internalPath, '/');
  1525. $owner = $userManager->get($storage->getOwner($internalPath));
  1526. $files[] = new FileInfo($path, $storage, $internalPath, $result, $mount, $owner);
  1527. }
  1528. }
  1529. }
  1530. }
  1531. }
  1532. return $files;
  1533. }
  1534. /**
  1535. * Get the owner for a file or folder
  1536. *
  1537. * @param string $path
  1538. * @return string the user id of the owner
  1539. * @throws NotFoundException
  1540. */
  1541. public function getOwner($path) {
  1542. $info = $this->getFileInfo($path);
  1543. if (!$info) {
  1544. throw new NotFoundException($path . ' not found while trying to get owner');
  1545. }
  1546. if ($info->getOwner() === null) {
  1547. throw new NotFoundException($path . ' has no owner');
  1548. }
  1549. return $info->getOwner()->getUID();
  1550. }
  1551. /**
  1552. * get the ETag for a file or folder
  1553. *
  1554. * @param string $path
  1555. * @return string|false
  1556. */
  1557. public function getETag($path) {
  1558. [$storage, $internalPath] = $this->resolvePath($path);
  1559. if ($storage) {
  1560. return $storage->getETag($internalPath);
  1561. } else {
  1562. return false;
  1563. }
  1564. }
  1565. /**
  1566. * Get the path of a file by id, relative to the view
  1567. *
  1568. * Note that the resulting path is not guaranteed to be unique for the id, multiple paths can point to the same file
  1569. *
  1570. * @param int $id
  1571. * @param int|null $storageId
  1572. * @return string
  1573. * @throws NotFoundException
  1574. */
  1575. public function getPath($id, int $storageId = null) {
  1576. $id = (int)$id;
  1577. $manager = Filesystem::getMountManager();
  1578. $mounts = $manager->findIn($this->fakeRoot);
  1579. $mounts[] = $manager->find($this->fakeRoot);
  1580. $mounts = array_filter($mounts);
  1581. // reverse the array, so we start with the storage this view is in
  1582. // which is the most likely to contain the file we're looking for
  1583. $mounts = array_reverse($mounts);
  1584. // put non-shared mounts in front of the shared mount
  1585. // this prevents unneeded recursion into shares
  1586. usort($mounts, function (IMountPoint $a, IMountPoint $b) {
  1587. return $a instanceof SharedMount && (!$b instanceof SharedMount) ? 1 : -1;
  1588. });
  1589. if (!is_null($storageId)) {
  1590. $mounts = array_filter($mounts, function (IMountPoint $mount) use ($storageId) {
  1591. return $mount->getNumericStorageId() === $storageId;
  1592. });
  1593. }
  1594. foreach ($mounts as $mount) {
  1595. /**
  1596. * @var \OC\Files\Mount\MountPoint $mount
  1597. */
  1598. if ($mount->getStorage()) {
  1599. $cache = $mount->getStorage()->getCache();
  1600. $internalPath = $cache->getPathById($id);
  1601. if (is_string($internalPath)) {
  1602. $fullPath = $mount->getMountPoint() . $internalPath;
  1603. if (!is_null($path = $this->getRelativePath($fullPath))) {
  1604. return $path;
  1605. }
  1606. }
  1607. }
  1608. }
  1609. throw new NotFoundException(sprintf('File with id "%s" has not been found.', $id));
  1610. }
  1611. /**
  1612. * @param string $path
  1613. * @throws InvalidPathException
  1614. */
  1615. private function assertPathLength($path): void {
  1616. $maxLen = min(PHP_MAXPATHLEN, 4000);
  1617. // Check for the string length - performed using isset() instead of strlen()
  1618. // because isset() is about 5x-40x faster.
  1619. if (isset($path[$maxLen])) {
  1620. $pathLen = strlen($path);
  1621. throw new InvalidPathException("Path length($pathLen) exceeds max path length($maxLen): $path");
  1622. }
  1623. }
  1624. /**
  1625. * check if it is allowed to move a mount point to a given target.
  1626. * It is not allowed to move a mount point into a different mount point or
  1627. * into an already shared folder
  1628. */
  1629. private function targetIsNotShared(IStorage $targetStorage, string $targetInternalPath): bool {
  1630. // note: cannot use the view because the target is already locked
  1631. $fileId = $targetStorage->getCache()->getId($targetInternalPath);
  1632. if ($fileId === -1) {
  1633. // target might not exist, need to check parent instead
  1634. $fileId = $targetStorage->getCache()->getId(dirname($targetInternalPath));
  1635. }
  1636. // check if any of the parents were shared by the current owner (include collections)
  1637. $shares = Share::getItemShared(
  1638. 'folder',
  1639. (string)$fileId,
  1640. \OC\Share\Constants::FORMAT_NONE,
  1641. null,
  1642. true
  1643. );
  1644. if (count($shares) > 0) {
  1645. $this->logger->debug(
  1646. 'It is not allowed to move one mount point into a shared folder',
  1647. ['app' => 'files']);
  1648. return false;
  1649. }
  1650. return true;
  1651. }
  1652. /**
  1653. * Get a fileinfo object for files that are ignored in the cache (part files)
  1654. */
  1655. private function getPartFileInfo(string $path): \OC\Files\FileInfo {
  1656. $mount = $this->getMount($path);
  1657. $storage = $mount->getStorage();
  1658. $internalPath = $mount->getInternalPath($this->getAbsolutePath($path));
  1659. $owner = \OC::$server->getUserManager()->get($storage->getOwner($internalPath));
  1660. return new FileInfo(
  1661. $this->getAbsolutePath($path),
  1662. $storage,
  1663. $internalPath,
  1664. [
  1665. 'fileid' => null,
  1666. 'mimetype' => $storage->getMimeType($internalPath),
  1667. 'name' => basename($path),
  1668. 'etag' => null,
  1669. 'size' => $storage->filesize($internalPath),
  1670. 'mtime' => $storage->filemtime($internalPath),
  1671. 'encrypted' => false,
  1672. 'permissions' => \OCP\Constants::PERMISSION_ALL
  1673. ],
  1674. $mount,
  1675. $owner
  1676. );
  1677. }
  1678. /**
  1679. * @param string $path
  1680. * @param string $fileName
  1681. * @throws InvalidPathException
  1682. */
  1683. public function verifyPath($path, $fileName): void {
  1684. try {
  1685. /** @type \OCP\Files\Storage $storage */
  1686. [$storage, $internalPath] = $this->resolvePath($path);
  1687. $storage->verifyPath($internalPath, $fileName);
  1688. } catch (ReservedWordException $ex) {
  1689. $l = \OCP\Util::getL10N('lib');
  1690. throw new InvalidPathException($l->t('File name is a reserved word'));
  1691. } catch (InvalidCharacterInPathException $ex) {
  1692. $l = \OCP\Util::getL10N('lib');
  1693. throw new InvalidPathException($l->t('File name contains at least one invalid character'));
  1694. } catch (FileNameTooLongException $ex) {
  1695. $l = \OCP\Util::getL10N('lib');
  1696. throw new InvalidPathException($l->t('File name is too long'));
  1697. } catch (InvalidDirectoryException $ex) {
  1698. $l = \OCP\Util::getL10N('lib');
  1699. throw new InvalidPathException($l->t('Dot files are not allowed'));
  1700. } catch (EmptyFileNameException $ex) {
  1701. $l = \OCP\Util::getL10N('lib');
  1702. throw new InvalidPathException($l->t('Empty filename is not allowed'));
  1703. }
  1704. }
  1705. /**
  1706. * get all parent folders of $path
  1707. *
  1708. * @param string $path
  1709. * @return string[]
  1710. */
  1711. private function getParents($path) {
  1712. $path = trim($path, '/');
  1713. if (!$path) {
  1714. return [];
  1715. }
  1716. $parts = explode('/', $path);
  1717. // remove the single file
  1718. array_pop($parts);
  1719. $result = ['/'];
  1720. $resultPath = '';
  1721. foreach ($parts as $part) {
  1722. if ($part) {
  1723. $resultPath .= '/' . $part;
  1724. $result[] = $resultPath;
  1725. }
  1726. }
  1727. return $result;
  1728. }
  1729. /**
  1730. * Returns the mount point for which to lock
  1731. *
  1732. * @param string $absolutePath absolute path
  1733. * @param bool $useParentMount true to return parent mount instead of whatever
  1734. * is mounted directly on the given path, false otherwise
  1735. * @return IMountPoint mount point for which to apply locks
  1736. */
  1737. private function getMountForLock(string $absolutePath, bool $useParentMount = false): IMountPoint {
  1738. $mount = Filesystem::getMountManager()->find($absolutePath);
  1739. if ($useParentMount) {
  1740. // find out if something is mounted directly on the path
  1741. $internalPath = $mount->getInternalPath($absolutePath);
  1742. if ($internalPath === '') {
  1743. // resolve the parent mount instead
  1744. $mount = Filesystem::getMountManager()->find(dirname($absolutePath));
  1745. }
  1746. }
  1747. return $mount;
  1748. }
  1749. /**
  1750. * Lock the given path
  1751. *
  1752. * @param string $path the path of the file to lock, relative to the view
  1753. * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
  1754. * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
  1755. *
  1756. * @return bool False if the path is excluded from locking, true otherwise
  1757. * @throws LockedException if the path is already locked
  1758. */
  1759. private function lockPath($path, $type, $lockMountPoint = false) {
  1760. $absolutePath = $this->getAbsolutePath($path);
  1761. $absolutePath = Filesystem::normalizePath($absolutePath);
  1762. if (!$this->shouldLockFile($absolutePath)) {
  1763. return false;
  1764. }
  1765. $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
  1766. try {
  1767. $storage = $mount->getStorage();
  1768. if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
  1769. $storage->acquireLock(
  1770. $mount->getInternalPath($absolutePath),
  1771. $type,
  1772. $this->lockingProvider
  1773. );
  1774. }
  1775. } catch (LockedException $e) {
  1776. // rethrow with the a human-readable path
  1777. throw new LockedException(
  1778. $this->getPathRelativeToFiles($absolutePath),
  1779. $e,
  1780. $e->getExistingLock()
  1781. );
  1782. }
  1783. return true;
  1784. }
  1785. /**
  1786. * Change the lock type
  1787. *
  1788. * @param string $path the path of the file to lock, relative to the view
  1789. * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
  1790. * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
  1791. *
  1792. * @return bool False if the path is excluded from locking, true otherwise
  1793. * @throws LockedException if the path is already locked
  1794. */
  1795. public function changeLock($path, $type, $lockMountPoint = false) {
  1796. $path = Filesystem::normalizePath($path);
  1797. $absolutePath = $this->getAbsolutePath($path);
  1798. $absolutePath = Filesystem::normalizePath($absolutePath);
  1799. if (!$this->shouldLockFile($absolutePath)) {
  1800. return false;
  1801. }
  1802. $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
  1803. try {
  1804. $storage = $mount->getStorage();
  1805. if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
  1806. $storage->changeLock(
  1807. $mount->getInternalPath($absolutePath),
  1808. $type,
  1809. $this->lockingProvider
  1810. );
  1811. }
  1812. } catch (LockedException $e) {
  1813. try {
  1814. // rethrow with the a human-readable path
  1815. throw new LockedException(
  1816. $this->getPathRelativeToFiles($absolutePath),
  1817. $e,
  1818. $e->getExistingLock()
  1819. );
  1820. } catch (\InvalidArgumentException $ex) {
  1821. throw new LockedException(
  1822. $absolutePath,
  1823. $ex,
  1824. $e->getExistingLock()
  1825. );
  1826. }
  1827. }
  1828. return true;
  1829. }
  1830. /**
  1831. * Unlock the given path
  1832. *
  1833. * @param string $path the path of the file to unlock, relative to the view
  1834. * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
  1835. * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
  1836. *
  1837. * @return bool False if the path is excluded from locking, true otherwise
  1838. * @throws LockedException
  1839. */
  1840. private function unlockPath($path, $type, $lockMountPoint = false) {
  1841. $absolutePath = $this->getAbsolutePath($path);
  1842. $absolutePath = Filesystem::normalizePath($absolutePath);
  1843. if (!$this->shouldLockFile($absolutePath)) {
  1844. return false;
  1845. }
  1846. $mount = $this->getMountForLock($absolutePath, $lockMountPoint);
  1847. $storage = $mount->getStorage();
  1848. if ($storage && $storage->instanceOfStorage('\OCP\Files\Storage\ILockingStorage')) {
  1849. $storage->releaseLock(
  1850. $mount->getInternalPath($absolutePath),
  1851. $type,
  1852. $this->lockingProvider
  1853. );
  1854. }
  1855. return true;
  1856. }
  1857. /**
  1858. * Lock a path and all its parents up to the root of the view
  1859. *
  1860. * @param string $path the path of the file to lock relative to the view
  1861. * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
  1862. * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
  1863. *
  1864. * @return bool False if the path is excluded from locking, true otherwise
  1865. * @throws LockedException
  1866. */
  1867. public function lockFile($path, $type, $lockMountPoint = false) {
  1868. $absolutePath = $this->getAbsolutePath($path);
  1869. $absolutePath = Filesystem::normalizePath($absolutePath);
  1870. if (!$this->shouldLockFile($absolutePath)) {
  1871. return false;
  1872. }
  1873. $this->lockPath($path, $type, $lockMountPoint);
  1874. $parents = $this->getParents($path);
  1875. foreach ($parents as $parent) {
  1876. $this->lockPath($parent, ILockingProvider::LOCK_SHARED);
  1877. }
  1878. return true;
  1879. }
  1880. /**
  1881. * Unlock a path and all its parents up to the root of the view
  1882. *
  1883. * @param string $path the path of the file to lock relative to the view
  1884. * @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
  1885. * @param bool $lockMountPoint true to lock the mount point, false to lock the attached mount/storage
  1886. *
  1887. * @return bool False if the path is excluded from locking, true otherwise
  1888. * @throws LockedException
  1889. */
  1890. public function unlockFile($path, $type, $lockMountPoint = false) {
  1891. $absolutePath = $this->getAbsolutePath($path);
  1892. $absolutePath = Filesystem::normalizePath($absolutePath);
  1893. if (!$this->shouldLockFile($absolutePath)) {
  1894. return false;
  1895. }
  1896. $this->unlockPath($path, $type, $lockMountPoint);
  1897. $parents = $this->getParents($path);
  1898. foreach ($parents as $parent) {
  1899. $this->unlockPath($parent, ILockingProvider::LOCK_SHARED);
  1900. }
  1901. return true;
  1902. }
  1903. /**
  1904. * Only lock files in data/user/files/
  1905. *
  1906. * @param string $path Absolute path to the file/folder we try to (un)lock
  1907. * @return bool
  1908. */
  1909. protected function shouldLockFile($path) {
  1910. $path = Filesystem::normalizePath($path);
  1911. $pathSegments = explode('/', $path);
  1912. if (isset($pathSegments[2])) {
  1913. // E.g.: /username/files/path-to-file
  1914. return ($pathSegments[2] === 'files') && (count($pathSegments) > 3);
  1915. }
  1916. return !str_starts_with($path, '/appdata_');
  1917. }
  1918. /**
  1919. * Shortens the given absolute path to be relative to
  1920. * "$user/files".
  1921. *
  1922. * @param string $absolutePath absolute path which is under "files"
  1923. *
  1924. * @return string path relative to "files" with trimmed slashes or null
  1925. * if the path was NOT relative to files
  1926. *
  1927. * @throws \InvalidArgumentException if the given path was not under "files"
  1928. * @since 8.1.0
  1929. */
  1930. public function getPathRelativeToFiles($absolutePath) {
  1931. $path = Filesystem::normalizePath($absolutePath);
  1932. $parts = explode('/', trim($path, '/'), 3);
  1933. // "$user", "files", "path/to/dir"
  1934. if (!isset($parts[1]) || $parts[1] !== 'files') {
  1935. $this->logger->error(
  1936. '$absolutePath must be relative to "files", value is "{absolutePath}"',
  1937. [
  1938. 'absolutePath' => $absolutePath,
  1939. ]
  1940. );
  1941. throw new \InvalidArgumentException('$absolutePath must be relative to "files"');
  1942. }
  1943. if (isset($parts[2])) {
  1944. return $parts[2];
  1945. }
  1946. return '';
  1947. }
  1948. /**
  1949. * @param string $filename
  1950. * @return array
  1951. * @throws \OC\User\NoUserException
  1952. * @throws NotFoundException
  1953. */
  1954. public function getUidAndFilename($filename) {
  1955. $info = $this->getFileInfo($filename);
  1956. if (!$info instanceof \OCP\Files\FileInfo) {
  1957. throw new NotFoundException($this->getAbsolutePath($filename) . ' not found');
  1958. }
  1959. $uid = $info->getOwner()->getUID();
  1960. if ($uid != \OC_User::getUser()) {
  1961. Filesystem::initMountPoints($uid);
  1962. $ownerView = new View('/' . $uid . '/files');
  1963. try {
  1964. $filename = $ownerView->getPath($info['fileid']);
  1965. } catch (NotFoundException $e) {
  1966. throw new NotFoundException('File with id ' . $info['fileid'] . ' not found for user ' . $uid);
  1967. }
  1968. }
  1969. return [$uid, $filename];
  1970. }
  1971. /**
  1972. * Creates parent non-existing folders
  1973. *
  1974. * @param string $filePath
  1975. * @return bool
  1976. */
  1977. private function createParentDirectories($filePath) {
  1978. $directoryParts = explode('/', $filePath);
  1979. $directoryParts = array_filter($directoryParts);
  1980. foreach ($directoryParts as $key => $part) {
  1981. $currentPathElements = array_slice($directoryParts, 0, $key);
  1982. $currentPath = '/' . implode('/', $currentPathElements);
  1983. if ($this->is_file($currentPath)) {
  1984. return false;
  1985. }
  1986. if (!$this->file_exists($currentPath)) {
  1987. $this->mkdir($currentPath);
  1988. }
  1989. }
  1990. return true;
  1991. }
  1992. }