View.php 65 KB

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