Completed
Push — master ( 7de6c0...0011bf )
by Morris
23:52
created
apps/files_versions/lib/Storage.php 2 patches
Indentation   +801 added lines, -801 removed lines patch added patch discarded remove patch
@@ -54,806 +54,806 @@
 block discarded – undo
54 54
 
55 55
 class Storage {
56 56
 
57
-	const DEFAULTENABLED=true;
58
-	const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
59
-	const VERSIONS_ROOT = 'files_versions/';
60
-
61
-	const DELETE_TRIGGER_MASTER_REMOVED = 0;
62
-	const DELETE_TRIGGER_RETENTION_CONSTRAINT = 1;
63
-	const DELETE_TRIGGER_QUOTA_EXCEEDED = 2;
64
-
65
-	// files for which we can remove the versions after the delete operation was successful
66
-	private static $deletedFiles = array();
67
-
68
-	private static $sourcePathAndUser = array();
69
-
70
-	private static $max_versions_per_interval = array(
71
-		//first 10sec, one version every 2sec
72
-		1 => array('intervalEndsAfter' => 10,      'step' => 2),
73
-		//next minute, one version every 10sec
74
-		2 => array('intervalEndsAfter' => 60,      'step' => 10),
75
-		//next hour, one version every minute
76
-		3 => array('intervalEndsAfter' => 3600,    'step' => 60),
77
-		//next 24h, one version every hour
78
-		4 => array('intervalEndsAfter' => 86400,   'step' => 3600),
79
-		//next 30days, one version per day
80
-		5 => array('intervalEndsAfter' => 2592000, 'step' => 86400),
81
-		//until the end one version per week
82
-		6 => array('intervalEndsAfter' => -1,      'step' => 604800),
83
-	);
84
-
85
-	/** @var \OCA\Files_Versions\AppInfo\Application */
86
-	private static $application;
87
-
88
-	/**
89
-	 * get the UID of the owner of the file and the path to the file relative to
90
-	 * owners files folder
91
-	 *
92
-	 * @param string $filename
93
-	 * @return array
94
-	 * @throws \OC\User\NoUserException
95
-	 */
96
-	public static function getUidAndFilename($filename) {
97
-		$uid = Filesystem::getOwner($filename);
98
-		$userManager = \OC::$server->getUserManager();
99
-		// if the user with the UID doesn't exists, e.g. because the UID points
100
-		// to a remote user with a federated cloud ID we use the current logged-in
101
-		// user. We need a valid local user to create the versions
102
-		if (!$userManager->userExists($uid)) {
103
-			$uid = User::getUser();
104
-		}
105
-		Filesystem::initMountPoints($uid);
106
-		if ( $uid !== User::getUser() ) {
107
-			$info = Filesystem::getFileInfo($filename);
108
-			$ownerView = new View('/'.$uid.'/files');
109
-			try {
110
-				$filename = $ownerView->getPath($info['fileid']);
111
-				// make sure that the file name doesn't end with a trailing slash
112
-				// can for example happen single files shared across servers
113
-				$filename = rtrim($filename, '/');
114
-			} catch (NotFoundException $e) {
115
-				$filename = null;
116
-			}
117
-		}
118
-		return [$uid, $filename];
119
-	}
120
-
121
-	/**
122
-	 * Remember the owner and the owner path of the source file
123
-	 *
124
-	 * @param string $source source path
125
-	 */
126
-	public static function setSourcePathAndUser($source) {
127
-		list($uid, $path) = self::getUidAndFilename($source);
128
-		self::$sourcePathAndUser[$source] = array('uid' => $uid, 'path' => $path);
129
-	}
130
-
131
-	/**
132
-	 * Gets the owner and the owner path from the source path
133
-	 *
134
-	 * @param string $source source path
135
-	 * @return array with user id and path
136
-	 */
137
-	public static function getSourcePathAndUser($source) {
138
-
139
-		if (isset(self::$sourcePathAndUser[$source])) {
140
-			$uid = self::$sourcePathAndUser[$source]['uid'];
141
-			$path = self::$sourcePathAndUser[$source]['path'];
142
-			unset(self::$sourcePathAndUser[$source]);
143
-		} else {
144
-			$uid = $path = false;
145
-		}
146
-		return array($uid, $path);
147
-	}
148
-
149
-	/**
150
-	 * get current size of all versions from a given user
151
-	 *
152
-	 * @param string $user user who owns the versions
153
-	 * @return int versions size
154
-	 */
155
-	private static function getVersionsSize($user) {
156
-		$view = new View('/' . $user);
157
-		$fileInfo = $view->getFileInfo('/files_versions');
158
-		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
159
-	}
160
-
161
-	/**
162
-	 * store a new version of a file.
163
-	 */
164
-	public static function store($filename) {
165
-
166
-		// if the file gets streamed we need to remove the .part extension
167
-		// to get the right target
168
-		$ext = pathinfo($filename, PATHINFO_EXTENSION);
169
-		if ($ext === 'part') {
170
-			$filename = substr($filename, 0, -5);
171
-		}
172
-
173
-		// we only handle existing files
174
-		if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
175
-			return false;
176
-		}
177
-
178
-		list($uid, $filename) = self::getUidAndFilename($filename);
179
-
180
-		$files_view = new View('/'.$uid .'/files');
181
-		$users_view = new View('/'.$uid);
182
-
183
-		$eventDispatcher = \OC::$server->getEventDispatcher();
184
-		$id = $files_view->getFileInfo($filename)->getId();
185
-		$nodes = \OC::$server->getRootFolder()->getById($id);
186
-		foreach ($nodes as $node) {
187
-			$event = new CreateVersionEvent($node);
188
-			$eventDispatcher->dispatch('OCA\Files_Versions::createVersion', $event);
189
-			if ($event->shouldCreateVersion() === false) {
190
-				return false;
191
-			}
192
-		}
193
-
194
-		// no use making versions for empty files
195
-		if ($files_view->filesize($filename) === 0) {
196
-			return false;
197
-		}
198
-
199
-		// create all parent folders
200
-		self::createMissingDirectories($filename, $users_view);
201
-
202
-		self::scheduleExpire($uid, $filename);
203
-
204
-		// store a new version of a file
205
-		$mtime = $users_view->filemtime('files/' . $filename);
206
-		$users_view->copy('files/' . $filename, 'files_versions/' . $filename . '.v' . $mtime);
207
-		// call getFileInfo to enforce a file cache entry for the new version
208
-		$users_view->getFileInfo('files_versions/' . $filename . '.v' . $mtime);
209
-	}
210
-
211
-
212
-	/**
213
-	 * mark file as deleted so that we can remove the versions if the file is gone
214
-	 * @param string $path
215
-	 */
216
-	public static function markDeletedFile($path) {
217
-		list($uid, $filename) = self::getUidAndFilename($path);
218
-		self::$deletedFiles[$path] = array(
219
-			'uid' => $uid,
220
-			'filename' => $filename);
221
-	}
222
-
223
-	/**
224
-	 * delete the version from the storage and cache
225
-	 *
226
-	 * @param View $view
227
-	 * @param string $path
228
-	 */
229
-	protected static function deleteVersion($view, $path) {
230
-		$view->unlink($path);
231
-		/**
232
-		 * @var \OC\Files\Storage\Storage $storage
233
-		 * @var string $internalPath
234
-		 */
235
-		list($storage, $internalPath) = $view->resolvePath($path);
236
-		$cache = $storage->getCache($internalPath);
237
-		$cache->remove($internalPath);
238
-	}
239
-
240
-	/**
241
-	 * Delete versions of a file
242
-	 */
243
-	public static function delete($path) {
244
-
245
-		$deletedFile = self::$deletedFiles[$path];
246
-		$uid = $deletedFile['uid'];
247
-		$filename = $deletedFile['filename'];
248
-
249
-		if (!Filesystem::file_exists($path)) {
250
-
251
-			$view = new View('/' . $uid . '/files_versions');
252
-
253
-			$versions = self::getVersions($uid, $filename);
254
-			if (!empty($versions)) {
255
-				foreach ($versions as $v) {
256
-					\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
257
-					self::deleteVersion($view, $filename . '.v' . $v['version']);
258
-					\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
259
-				}
260
-			}
261
-		}
262
-		unset(self::$deletedFiles[$path]);
263
-	}
264
-
265
-	/**
266
-	 * Rename or copy versions of a file of the given paths
267
-	 *
268
-	 * @param string $sourcePath source path of the file to move, relative to
269
-	 * the currently logged in user's "files" folder
270
-	 * @param string $targetPath target path of the file to move, relative to
271
-	 * the currently logged in user's "files" folder
272
-	 * @param string $operation can be 'copy' or 'rename'
273
-	 */
274
-	public static function renameOrCopy($sourcePath, $targetPath, $operation) {
275
-		list($sourceOwner, $sourcePath) = self::getSourcePathAndUser($sourcePath);
276
-
277
-		// it was a upload of a existing file if no old path exists
278
-		// in this case the pre-hook already called the store method and we can
279
-		// stop here
280
-		if ($sourcePath === false) {
281
-			return true;
282
-		}
283
-
284
-		list($targetOwner, $targetPath) = self::getUidAndFilename($targetPath);
285
-
286
-		$sourcePath = ltrim($sourcePath, '/');
287
-		$targetPath = ltrim($targetPath, '/');
288
-
289
-		$rootView = new View('');
290
-
291
-		// did we move a directory ?
292
-		if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
293
-			// does the directory exists for versions too ?
294
-			if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
295
-				// create missing dirs if necessary
296
-				self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
297
-
298
-				// move the directory containing the versions
299
-				$rootView->$operation(
300
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath,
301
-					'/' . $targetOwner . '/files_versions/' . $targetPath
302
-				);
303
-			}
304
-		} else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
305
-			// create missing dirs if necessary
306
-			self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
307
-
308
-			foreach ($versions as $v) {
309
-				// move each version one by one to the target directory
310
-				$rootView->$operation(
311
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
312
-					'/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
313
-				);
314
-			}
315
-		}
316
-
317
-		// if we moved versions directly for a file, schedule expiration check for that file
318
-		if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
319
-			self::scheduleExpire($targetOwner, $targetPath);
320
-		}
321
-
322
-	}
323
-
324
-	/**
325
-	 * Rollback to an old version of a file.
326
-	 *
327
-	 * @param string $file file name
328
-	 * @param int $revision revision timestamp
329
-	 * @return bool
330
-	 */
331
-	public static function rollback($file, $revision) {
332
-
333
-		// add expected leading slash
334
-		$file = '/' . ltrim($file, '/');
335
-		list($uid, $filename) = self::getUidAndFilename($file);
336
-		if ($uid === null || trim($filename, '/') === '') {
337
-			return false;
338
-		}
339
-
340
-		// Fetch the userfolder to trigger view hooks
341
-		$userFolder = \OC::$server->getUserFolder($uid);
342
-
343
-		$users_view = new View('/'.$uid);
344
-		$files_view = new View('/'. User::getUser().'/files');
345
-
346
-		$versionCreated = false;
347
-
348
-		$fileInfo = $files_view->getFileInfo($file);
349
-
350
-		// check if user has the permissions to revert a version
351
-		if (!$fileInfo->isUpdateable()) {
352
-			return false;
353
-		}
354
-
355
-		//first create a new version
356
-		$version = 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename);
357
-		if (!$users_view->file_exists($version)) {
358
-			$users_view->copy('files'.$filename, 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename));
359
-			$versionCreated = true;
360
-		}
361
-
362
-		$fileToRestore =  'files_versions' . $filename . '.v' . $revision;
363
-
364
-		// Restore encrypted version of the old file for the newly restored file
365
-		// This has to happen manually here since the file is manually copied below
366
-		$oldVersion = $users_view->getFileInfo($fileToRestore)->getEncryptedVersion();
367
-		$oldFileInfo = $users_view->getFileInfo($fileToRestore);
368
-		$cache = $fileInfo->getStorage()->getCache();
369
-		$cache->update(
370
-			$fileInfo->getId(), [
371
-				'encrypted' => $oldVersion,
372
-				'encryptedVersion' => $oldVersion,
373
-				'size' => $oldFileInfo->getSize()
374
-			]
375
-		);
376
-
377
-		// rollback
378
-		if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
379
-			$files_view->touch($file, $revision);
380
-			Storage::scheduleExpire($uid, $file);
381
-
382
-			$node = $userFolder->get($file);
383
-
384
-			// TODO: move away from those legacy hooks!
385
-			\OC_Hook::emit('\OCP\Versions', 'rollback', array(
386
-				'path' => $filename,
387
-				'revision' => $revision,
388
-				'node' => $node,
389
-			));
390
-			return true;
391
-		} else if ($versionCreated) {
392
-			self::deleteVersion($users_view, $version);
393
-		}
394
-
395
-		return false;
396
-
397
-	}
398
-
399
-	/**
400
-	 * Stream copy file contents from $path1 to $path2
401
-	 *
402
-	 * @param View $view view to use for copying
403
-	 * @param string $path1 source file to copy
404
-	 * @param string $path2 target file
405
-	 *
406
-	 * @return bool true for success, false otherwise
407
-	 */
408
-	private static function copyFileContents($view, $path1, $path2) {
409
-		/** @var \OC\Files\Storage\Storage $storage1 */
410
-		list($storage1, $internalPath1) = $view->resolvePath($path1);
411
-		/** @var \OC\Files\Storage\Storage $storage2 */
412
-		list($storage2, $internalPath2) = $view->resolvePath($path2);
413
-
414
-		$view->lockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
415
-		$view->lockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
416
-
417
-		// TODO add a proper way of overwriting a file while maintaining file ids
418
-		if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
419
-			$source = $storage1->fopen($internalPath1, 'r');
420
-			$target = $storage2->fopen($internalPath2, 'w');
421
-			list(, $result) = \OC_Helper::streamCopy($source, $target);
422
-			fclose($source);
423
-			fclose($target);
424
-
425
-			if ($result !== false) {
426
-				$storage1->unlink($internalPath1);
427
-			}
428
-		} else {
429
-			$result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
430
-		}
431
-
432
-		$view->unlockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
433
-		$view->unlockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
434
-
435
-		return ($result !== false);
436
-	}
437
-
438
-	/**
439
-	 * get a list of all available versions of a file in descending chronological order
440
-	 * @param string $uid user id from the owner of the file
441
-	 * @param string $filename file to find versions of, relative to the user files dir
442
-	 * @param string $userFullPath
443
-	 * @return array versions newest version first
444
-	 */
445
-	public static function getVersions($uid, $filename, $userFullPath = '') {
446
-		$versions = array();
447
-		if (empty($filename)) {
448
-			return $versions;
449
-		}
450
-		// fetch for old versions
451
-		$view = new View('/' . $uid . '/');
452
-
453
-		$pathinfo = pathinfo($filename);
454
-		$versionedFile = $pathinfo['basename'];
455
-
456
-		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
457
-
458
-		$dirContent = false;
459
-		if ($view->is_dir($dir)) {
460
-			$dirContent = $view->opendir($dir);
461
-		}
462
-
463
-		if ($dirContent === false) {
464
-			return $versions;
465
-		}
466
-
467
-		if (is_resource($dirContent)) {
468
-			while (($entryName = readdir($dirContent)) !== false) {
469
-				if (!Filesystem::isIgnoredDir($entryName)) {
470
-					$pathparts = pathinfo($entryName);
471
-					$filename = $pathparts['filename'];
472
-					if ($filename === $versionedFile) {
473
-						$pathparts = pathinfo($entryName);
474
-						$timestamp = substr($pathparts['extension'], 1);
475
-						$filename = $pathparts['filename'];
476
-						$key = $timestamp . '#' . $filename;
477
-						$versions[$key]['version'] = $timestamp;
478
-						$versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
479
-						if (empty($userFullPath)) {
480
-							$versions[$key]['preview'] = '';
481
-						} else {
482
-							$versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
483
-						}
484
-						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
485
-						$versions[$key]['name'] = $versionedFile;
486
-						$versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
487
-						$versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
488
-					}
489
-				}
490
-			}
491
-			closedir($dirContent);
492
-		}
493
-
494
-		// sort with newest version first
495
-		krsort($versions);
496
-
497
-		return $versions;
498
-	}
499
-
500
-	/**
501
-	 * Expire versions that older than max version retention time
502
-	 * @param string $uid
503
-	 */
504
-	public static function expireOlderThanMaxForUser($uid){
505
-		$expiration = self::getExpiration();
506
-		$threshold = $expiration->getMaxAgeAsTimestamp();
507
-		$versions = self::getAllVersions($uid);
508
-		if (!$threshold || !array_key_exists('all', $versions)) {
509
-			return;
510
-		}
511
-
512
-		$toDelete = [];
513
-		foreach (array_reverse($versions['all']) as $key => $version) {
514
-			if ((int)$version['version'] <$threshold) {
515
-				$toDelete[$key] = $version;
516
-			} else {
517
-				//Versions are sorted by time - nothing mo to iterate.
518
-				break;
519
-			}
520
-		}
521
-
522
-		$view = new View('/' . $uid . '/files_versions');
523
-		if (!empty($toDelete)) {
524
-			foreach ($toDelete as $version) {
525
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
526
-				self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
527
-				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
528
-			}
529
-		}
530
-	}
531
-
532
-	/**
533
-	 * translate a timestamp into a string like "5 days ago"
534
-	 * @param int $timestamp
535
-	 * @return string for example "5 days ago"
536
-	 */
537
-	private static function getHumanReadableTimestamp($timestamp) {
538
-
539
-		$diff = time() - $timestamp;
540
-
541
-		if ($diff < 60) { // first minute
542
-			return  $diff . " seconds ago";
543
-		} elseif ($diff < 3600) { //first hour
544
-			return round($diff / 60) . " minutes ago";
545
-		} elseif ($diff < 86400) { // first day
546
-			return round($diff / 3600) . " hours ago";
547
-		} elseif ($diff < 604800) { //first week
548
-			return round($diff / 86400) . " days ago";
549
-		} elseif ($diff < 2419200) { //first month
550
-			return round($diff / 604800) . " weeks ago";
551
-		} elseif ($diff < 29030400) { // first year
552
-			return round($diff / 2419200) . " months ago";
553
-		} else {
554
-			return round($diff / 29030400) . " years ago";
555
-		}
556
-
557
-	}
558
-
559
-	/**
560
-	 * returns all stored file versions from a given user
561
-	 * @param string $uid id of the user
562
-	 * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
563
-	 */
564
-	private static function getAllVersions($uid) {
565
-		$view = new View('/' . $uid . '/');
566
-		$dirs = array(self::VERSIONS_ROOT);
567
-		$versions = array();
568
-
569
-		while (!empty($dirs)) {
570
-			$dir = array_pop($dirs);
571
-			$files = $view->getDirectoryContent($dir);
572
-
573
-			foreach ($files as $file) {
574
-				$fileData = $file->getData();
575
-				$filePath = $dir . '/' . $fileData['name'];
576
-				if ($file['type'] === 'dir') {
577
-					$dirs[] = $filePath;
578
-				} else {
579
-					$versionsBegin = strrpos($filePath, '.v');
580
-					$relPathStart = strlen(self::VERSIONS_ROOT);
581
-					$version = substr($filePath, $versionsBegin + 2);
582
-					$relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
583
-					$key = $version . '#' . $relpath;
584
-					$versions[$key] = array('path' => $relpath, 'timestamp' => $version);
585
-				}
586
-			}
587
-		}
588
-
589
-		// newest version first
590
-		krsort($versions);
591
-
592
-		$result = array();
593
-
594
-		foreach ($versions as $key => $value) {
595
-			$size = $view->filesize(self::VERSIONS_ROOT.'/'.$value['path'].'.v'.$value['timestamp']);
596
-			$filename = $value['path'];
597
-
598
-			$result['all'][$key]['version'] = $value['timestamp'];
599
-			$result['all'][$key]['path'] = $filename;
600
-			$result['all'][$key]['size'] = $size;
601
-
602
-			$result['by_file'][$filename][$key]['version'] = $value['timestamp'];
603
-			$result['by_file'][$filename][$key]['path'] = $filename;
604
-			$result['by_file'][$filename][$key]['size'] = $size;
605
-		}
606
-
607
-		return $result;
608
-	}
609
-
610
-	/**
611
-	 * get list of files we want to expire
612
-	 * @param array $versions list of versions
613
-	 * @param integer $time
614
-	 * @param bool $quotaExceeded is versions storage limit reached
615
-	 * @return array containing the list of to deleted versions and the size of them
616
-	 */
617
-	protected static function getExpireList($time, $versions, $quotaExceeded = false) {
618
-		$expiration = self::getExpiration();
619
-
620
-		if ($expiration->shouldAutoExpire()) {
621
-			list($toDelete, $size) = self::getAutoExpireList($time, $versions);
622
-		} else {
623
-			$size = 0;
624
-			$toDelete = [];  // versions we want to delete
625
-		}
626
-
627
-		foreach ($versions as $key => $version) {
628
-			if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
629
-				$size += $version['size'];
630
-				$toDelete[$key] = $version['path'] . '.v' . $version['version'];
631
-			}
632
-		}
633
-
634
-		return [$toDelete, $size];
635
-	}
636
-
637
-	/**
638
-	 * get list of files we want to expire
639
-	 * @param array $versions list of versions
640
-	 * @param integer $time
641
-	 * @return array containing the list of to deleted versions and the size of them
642
-	 */
643
-	protected static function getAutoExpireList($time, $versions) {
644
-		$size = 0;
645
-		$toDelete = array();  // versions we want to delete
646
-
647
-		$interval = 1;
648
-		$step = Storage::$max_versions_per_interval[$interval]['step'];
649
-		if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
650
-			$nextInterval = -1;
651
-		} else {
652
-			$nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
653
-		}
654
-
655
-		$firstVersion = reset($versions);
656
-		$firstKey = key($versions);
657
-		$prevTimestamp = $firstVersion['version'];
658
-		$nextVersion = $firstVersion['version'] - $step;
659
-		unset($versions[$firstKey]);
660
-
661
-		foreach ($versions as $key => $version) {
662
-			$newInterval = true;
663
-			while ($newInterval) {
664
-				if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
665
-					if ($version['version'] > $nextVersion) {
666
-						//distance between two version too small, mark to delete
667
-						$toDelete[$key] = $version['path'] . '.v' . $version['version'];
668
-						$size += $version['size'];
669
-						\OC::$server->getLogger()->info('Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, ['app' => 'files_versions']);
670
-					} else {
671
-						$nextVersion = $version['version'] - $step;
672
-						$prevTimestamp = $version['version'];
673
-					}
674
-					$newInterval = false; // version checked so we can move to the next one
675
-				} else { // time to move on to the next interval
676
-					$interval++;
677
-					$step = Storage::$max_versions_per_interval[$interval]['step'];
678
-					$nextVersion = $prevTimestamp - $step;
679
-					if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
680
-						$nextInterval = -1;
681
-					} else {
682
-						$nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
683
-					}
684
-					$newInterval = true; // we changed the interval -> check same version with new interval
685
-				}
686
-			}
687
-		}
688
-
689
-		return array($toDelete, $size);
690
-	}
691
-
692
-	/**
693
-	 * Schedule versions expiration for the given file
694
-	 *
695
-	 * @param string $uid owner of the file
696
-	 * @param string $fileName file/folder for which to schedule expiration
697
-	 */
698
-	private static function scheduleExpire($uid, $fileName) {
699
-		// let the admin disable auto expire
700
-		$expiration = self::getExpiration();
701
-		if ($expiration->isEnabled()) {
702
-			$command = new Expire($uid, $fileName);
703
-			\OC::$server->getCommandBus()->push($command);
704
-		}
705
-	}
706
-
707
-	/**
708
-	 * Expire versions which exceed the quota.
709
-	 *
710
-	 * This will setup the filesystem for the given user but will not
711
-	 * tear it down afterwards.
712
-	 *
713
-	 * @param string $filename path to file to expire
714
-	 * @param string $uid user for which to expire the version
715
-	 * @return bool|int|null
716
-	 */
717
-	public static function expire($filename, $uid) {
718
-		$expiration = self::getExpiration();
719
-
720
-		if ($expiration->isEnabled()) {
721
-			// get available disk space for user
722
-			$user = \OC::$server->getUserManager()->get($uid);
723
-			if (is_null($user)) {
724
-				\OC::$server->getLogger()->error('Backends provided no user object for ' . $uid, ['app' => 'files_versions']);
725
-				throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
726
-			}
727
-
728
-			\OC_Util::setupFS($uid);
729
-
730
-			if (!Filesystem::file_exists($filename)) {
731
-				return false;
732
-			}
733
-
734
-			if (empty($filename)) {
735
-				// file maybe renamed or deleted
736
-				return false;
737
-			}
738
-			$versionsFileview = new View('/'.$uid.'/files_versions');
739
-
740
-			$softQuota = true;
741
-			$quota = $user->getQuota();
742
-			if ( $quota === null || $quota === 'none' ) {
743
-				$quota = Filesystem::free_space('/');
744
-				$softQuota = false;
745
-			} else {
746
-				$quota = \OCP\Util::computerFileSize($quota);
747
-			}
748
-
749
-			// make sure that we have the current size of the version history
750
-			$versionsSize = self::getVersionsSize($uid);
751
-
752
-			// calculate available space for version history
753
-			// subtract size of files and current versions size from quota
754
-			if ($quota >= 0) {
755
-				if ($softQuota) {
756
-					$files_view = new View('/' . $uid . '/files');
757
-					$rootInfo = $files_view->getFileInfo('/', false);
758
-					$free = $quota - $rootInfo['size']; // remaining free space for user
759
-					if ($free > 0) {
760
-						$availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $versionsSize; // how much space can be used for versions
761
-					} else {
762
-						$availableSpace = $free - $versionsSize;
763
-					}
764
-				} else {
765
-					$availableSpace = $quota;
766
-				}
767
-			} else {
768
-				$availableSpace = PHP_INT_MAX;
769
-			}
770
-
771
-			$allVersions = Storage::getVersions($uid, $filename);
772
-
773
-			$time = time();
774
-			list($toDelete, $sizeOfDeletedVersions) = self::getExpireList($time, $allVersions, $availableSpace <= 0);
775
-
776
-			$availableSpace = $availableSpace + $sizeOfDeletedVersions;
777
-			$versionsSize = $versionsSize - $sizeOfDeletedVersions;
778
-
779
-			// if still not enough free space we rearrange the versions from all files
780
-			if ($availableSpace <= 0) {
781
-				$result = Storage::getAllVersions($uid);
782
-				$allVersions = $result['all'];
783
-
784
-				foreach ($result['by_file'] as $versions) {
785
-					list($toDeleteNew, $size) = self::getExpireList($time, $versions, $availableSpace <= 0);
786
-					$toDelete = array_merge($toDelete, $toDeleteNew);
787
-					$sizeOfDeletedVersions += $size;
788
-				}
789
-				$availableSpace = $availableSpace + $sizeOfDeletedVersions;
790
-				$versionsSize = $versionsSize - $sizeOfDeletedVersions;
791
-			}
792
-
793
-			$logger = \OC::$server->getLogger();
794
-			foreach($toDelete as $key => $path) {
795
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
796
-				self::deleteVersion($versionsFileview, $path);
797
-				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
798
-				unset($allVersions[$key]); // update array with the versions we keep
799
-				$logger->info('Expire: ' . $path, ['app' => 'files_versions']);
800
-			}
801
-
802
-			// Check if enough space is available after versions are rearranged.
803
-			// If not we delete the oldest versions until we meet the size limit for versions,
804
-			// but always keep the two latest versions
805
-			$numOfVersions = count($allVersions) -2 ;
806
-			$i = 0;
807
-			// sort oldest first and make sure that we start at the first element
808
-			ksort($allVersions);
809
-			reset($allVersions);
810
-			while ($availableSpace < 0 && $i < $numOfVersions) {
811
-				$version = current($allVersions);
812
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
813
-				self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
814
-				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
815
-				\OC::$server->getLogger()->info('running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'], ['app' => 'files_versions']);
816
-				$versionsSize -= $version['size'];
817
-				$availableSpace += $version['size'];
818
-				next($allVersions);
819
-				$i++;
820
-			}
821
-
822
-			return $versionsSize; // finally return the new size of the version history
823
-		}
824
-
825
-		return false;
826
-	}
827
-
828
-	/**
829
-	 * Create recursively missing directories inside of files_versions
830
-	 * that match the given path to a file.
831
-	 *
832
-	 * @param string $filename $path to a file, relative to the user's
833
-	 * "files" folder
834
-	 * @param View $view view on data/user/
835
-	 */
836
-	private static function createMissingDirectories($filename, $view) {
837
-		$dirname = Filesystem::normalizePath(dirname($filename));
838
-		$dirParts = explode('/', $dirname);
839
-		$dir = "/files_versions";
840
-		foreach ($dirParts as $part) {
841
-			$dir = $dir . '/' . $part;
842
-			if (!$view->file_exists($dir)) {
843
-				$view->mkdir($dir);
844
-			}
845
-		}
846
-	}
847
-
848
-	/**
849
-	 * Static workaround
850
-	 * @return Expiration
851
-	 */
852
-	protected static function getExpiration(){
853
-		if (is_null(self::$application)) {
854
-			self::$application = new Application();
855
-		}
856
-		return self::$application->getContainer()->query(Expiration::class);
857
-	}
57
+    const DEFAULTENABLED=true;
58
+    const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
59
+    const VERSIONS_ROOT = 'files_versions/';
60
+
61
+    const DELETE_TRIGGER_MASTER_REMOVED = 0;
62
+    const DELETE_TRIGGER_RETENTION_CONSTRAINT = 1;
63
+    const DELETE_TRIGGER_QUOTA_EXCEEDED = 2;
64
+
65
+    // files for which we can remove the versions after the delete operation was successful
66
+    private static $deletedFiles = array();
67
+
68
+    private static $sourcePathAndUser = array();
69
+
70
+    private static $max_versions_per_interval = array(
71
+        //first 10sec, one version every 2sec
72
+        1 => array('intervalEndsAfter' => 10,      'step' => 2),
73
+        //next minute, one version every 10sec
74
+        2 => array('intervalEndsAfter' => 60,      'step' => 10),
75
+        //next hour, one version every minute
76
+        3 => array('intervalEndsAfter' => 3600,    'step' => 60),
77
+        //next 24h, one version every hour
78
+        4 => array('intervalEndsAfter' => 86400,   'step' => 3600),
79
+        //next 30days, one version per day
80
+        5 => array('intervalEndsAfter' => 2592000, 'step' => 86400),
81
+        //until the end one version per week
82
+        6 => array('intervalEndsAfter' => -1,      'step' => 604800),
83
+    );
84
+
85
+    /** @var \OCA\Files_Versions\AppInfo\Application */
86
+    private static $application;
87
+
88
+    /**
89
+     * get the UID of the owner of the file and the path to the file relative to
90
+     * owners files folder
91
+     *
92
+     * @param string $filename
93
+     * @return array
94
+     * @throws \OC\User\NoUserException
95
+     */
96
+    public static function getUidAndFilename($filename) {
97
+        $uid = Filesystem::getOwner($filename);
98
+        $userManager = \OC::$server->getUserManager();
99
+        // if the user with the UID doesn't exists, e.g. because the UID points
100
+        // to a remote user with a federated cloud ID we use the current logged-in
101
+        // user. We need a valid local user to create the versions
102
+        if (!$userManager->userExists($uid)) {
103
+            $uid = User::getUser();
104
+        }
105
+        Filesystem::initMountPoints($uid);
106
+        if ( $uid !== User::getUser() ) {
107
+            $info = Filesystem::getFileInfo($filename);
108
+            $ownerView = new View('/'.$uid.'/files');
109
+            try {
110
+                $filename = $ownerView->getPath($info['fileid']);
111
+                // make sure that the file name doesn't end with a trailing slash
112
+                // can for example happen single files shared across servers
113
+                $filename = rtrim($filename, '/');
114
+            } catch (NotFoundException $e) {
115
+                $filename = null;
116
+            }
117
+        }
118
+        return [$uid, $filename];
119
+    }
120
+
121
+    /**
122
+     * Remember the owner and the owner path of the source file
123
+     *
124
+     * @param string $source source path
125
+     */
126
+    public static function setSourcePathAndUser($source) {
127
+        list($uid, $path) = self::getUidAndFilename($source);
128
+        self::$sourcePathAndUser[$source] = array('uid' => $uid, 'path' => $path);
129
+    }
130
+
131
+    /**
132
+     * Gets the owner and the owner path from the source path
133
+     *
134
+     * @param string $source source path
135
+     * @return array with user id and path
136
+     */
137
+    public static function getSourcePathAndUser($source) {
138
+
139
+        if (isset(self::$sourcePathAndUser[$source])) {
140
+            $uid = self::$sourcePathAndUser[$source]['uid'];
141
+            $path = self::$sourcePathAndUser[$source]['path'];
142
+            unset(self::$sourcePathAndUser[$source]);
143
+        } else {
144
+            $uid = $path = false;
145
+        }
146
+        return array($uid, $path);
147
+    }
148
+
149
+    /**
150
+     * get current size of all versions from a given user
151
+     *
152
+     * @param string $user user who owns the versions
153
+     * @return int versions size
154
+     */
155
+    private static function getVersionsSize($user) {
156
+        $view = new View('/' . $user);
157
+        $fileInfo = $view->getFileInfo('/files_versions');
158
+        return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
159
+    }
160
+
161
+    /**
162
+     * store a new version of a file.
163
+     */
164
+    public static function store($filename) {
165
+
166
+        // if the file gets streamed we need to remove the .part extension
167
+        // to get the right target
168
+        $ext = pathinfo($filename, PATHINFO_EXTENSION);
169
+        if ($ext === 'part') {
170
+            $filename = substr($filename, 0, -5);
171
+        }
172
+
173
+        // we only handle existing files
174
+        if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
175
+            return false;
176
+        }
177
+
178
+        list($uid, $filename) = self::getUidAndFilename($filename);
179
+
180
+        $files_view = new View('/'.$uid .'/files');
181
+        $users_view = new View('/'.$uid);
182
+
183
+        $eventDispatcher = \OC::$server->getEventDispatcher();
184
+        $id = $files_view->getFileInfo($filename)->getId();
185
+        $nodes = \OC::$server->getRootFolder()->getById($id);
186
+        foreach ($nodes as $node) {
187
+            $event = new CreateVersionEvent($node);
188
+            $eventDispatcher->dispatch('OCA\Files_Versions::createVersion', $event);
189
+            if ($event->shouldCreateVersion() === false) {
190
+                return false;
191
+            }
192
+        }
193
+
194
+        // no use making versions for empty files
195
+        if ($files_view->filesize($filename) === 0) {
196
+            return false;
197
+        }
198
+
199
+        // create all parent folders
200
+        self::createMissingDirectories($filename, $users_view);
201
+
202
+        self::scheduleExpire($uid, $filename);
203
+
204
+        // store a new version of a file
205
+        $mtime = $users_view->filemtime('files/' . $filename);
206
+        $users_view->copy('files/' . $filename, 'files_versions/' . $filename . '.v' . $mtime);
207
+        // call getFileInfo to enforce a file cache entry for the new version
208
+        $users_view->getFileInfo('files_versions/' . $filename . '.v' . $mtime);
209
+    }
210
+
211
+
212
+    /**
213
+     * mark file as deleted so that we can remove the versions if the file is gone
214
+     * @param string $path
215
+     */
216
+    public static function markDeletedFile($path) {
217
+        list($uid, $filename) = self::getUidAndFilename($path);
218
+        self::$deletedFiles[$path] = array(
219
+            'uid' => $uid,
220
+            'filename' => $filename);
221
+    }
222
+
223
+    /**
224
+     * delete the version from the storage and cache
225
+     *
226
+     * @param View $view
227
+     * @param string $path
228
+     */
229
+    protected static function deleteVersion($view, $path) {
230
+        $view->unlink($path);
231
+        /**
232
+         * @var \OC\Files\Storage\Storage $storage
233
+         * @var string $internalPath
234
+         */
235
+        list($storage, $internalPath) = $view->resolvePath($path);
236
+        $cache = $storage->getCache($internalPath);
237
+        $cache->remove($internalPath);
238
+    }
239
+
240
+    /**
241
+     * Delete versions of a file
242
+     */
243
+    public static function delete($path) {
244
+
245
+        $deletedFile = self::$deletedFiles[$path];
246
+        $uid = $deletedFile['uid'];
247
+        $filename = $deletedFile['filename'];
248
+
249
+        if (!Filesystem::file_exists($path)) {
250
+
251
+            $view = new View('/' . $uid . '/files_versions');
252
+
253
+            $versions = self::getVersions($uid, $filename);
254
+            if (!empty($versions)) {
255
+                foreach ($versions as $v) {
256
+                    \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
257
+                    self::deleteVersion($view, $filename . '.v' . $v['version']);
258
+                    \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
259
+                }
260
+            }
261
+        }
262
+        unset(self::$deletedFiles[$path]);
263
+    }
264
+
265
+    /**
266
+     * Rename or copy versions of a file of the given paths
267
+     *
268
+     * @param string $sourcePath source path of the file to move, relative to
269
+     * the currently logged in user's "files" folder
270
+     * @param string $targetPath target path of the file to move, relative to
271
+     * the currently logged in user's "files" folder
272
+     * @param string $operation can be 'copy' or 'rename'
273
+     */
274
+    public static function renameOrCopy($sourcePath, $targetPath, $operation) {
275
+        list($sourceOwner, $sourcePath) = self::getSourcePathAndUser($sourcePath);
276
+
277
+        // it was a upload of a existing file if no old path exists
278
+        // in this case the pre-hook already called the store method and we can
279
+        // stop here
280
+        if ($sourcePath === false) {
281
+            return true;
282
+        }
283
+
284
+        list($targetOwner, $targetPath) = self::getUidAndFilename($targetPath);
285
+
286
+        $sourcePath = ltrim($sourcePath, '/');
287
+        $targetPath = ltrim($targetPath, '/');
288
+
289
+        $rootView = new View('');
290
+
291
+        // did we move a directory ?
292
+        if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
293
+            // does the directory exists for versions too ?
294
+            if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
295
+                // create missing dirs if necessary
296
+                self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
297
+
298
+                // move the directory containing the versions
299
+                $rootView->$operation(
300
+                    '/' . $sourceOwner . '/files_versions/' . $sourcePath,
301
+                    '/' . $targetOwner . '/files_versions/' . $targetPath
302
+                );
303
+            }
304
+        } else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
305
+            // create missing dirs if necessary
306
+            self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
307
+
308
+            foreach ($versions as $v) {
309
+                // move each version one by one to the target directory
310
+                $rootView->$operation(
311
+                    '/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
312
+                    '/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
313
+                );
314
+            }
315
+        }
316
+
317
+        // if we moved versions directly for a file, schedule expiration check for that file
318
+        if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
319
+            self::scheduleExpire($targetOwner, $targetPath);
320
+        }
321
+
322
+    }
323
+
324
+    /**
325
+     * Rollback to an old version of a file.
326
+     *
327
+     * @param string $file file name
328
+     * @param int $revision revision timestamp
329
+     * @return bool
330
+     */
331
+    public static function rollback($file, $revision) {
332
+
333
+        // add expected leading slash
334
+        $file = '/' . ltrim($file, '/');
335
+        list($uid, $filename) = self::getUidAndFilename($file);
336
+        if ($uid === null || trim($filename, '/') === '') {
337
+            return false;
338
+        }
339
+
340
+        // Fetch the userfolder to trigger view hooks
341
+        $userFolder = \OC::$server->getUserFolder($uid);
342
+
343
+        $users_view = new View('/'.$uid);
344
+        $files_view = new View('/'. User::getUser().'/files');
345
+
346
+        $versionCreated = false;
347
+
348
+        $fileInfo = $files_view->getFileInfo($file);
349
+
350
+        // check if user has the permissions to revert a version
351
+        if (!$fileInfo->isUpdateable()) {
352
+            return false;
353
+        }
354
+
355
+        //first create a new version
356
+        $version = 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename);
357
+        if (!$users_view->file_exists($version)) {
358
+            $users_view->copy('files'.$filename, 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename));
359
+            $versionCreated = true;
360
+        }
361
+
362
+        $fileToRestore =  'files_versions' . $filename . '.v' . $revision;
363
+
364
+        // Restore encrypted version of the old file for the newly restored file
365
+        // This has to happen manually here since the file is manually copied below
366
+        $oldVersion = $users_view->getFileInfo($fileToRestore)->getEncryptedVersion();
367
+        $oldFileInfo = $users_view->getFileInfo($fileToRestore);
368
+        $cache = $fileInfo->getStorage()->getCache();
369
+        $cache->update(
370
+            $fileInfo->getId(), [
371
+                'encrypted' => $oldVersion,
372
+                'encryptedVersion' => $oldVersion,
373
+                'size' => $oldFileInfo->getSize()
374
+            ]
375
+        );
376
+
377
+        // rollback
378
+        if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
379
+            $files_view->touch($file, $revision);
380
+            Storage::scheduleExpire($uid, $file);
381
+
382
+            $node = $userFolder->get($file);
383
+
384
+            // TODO: move away from those legacy hooks!
385
+            \OC_Hook::emit('\OCP\Versions', 'rollback', array(
386
+                'path' => $filename,
387
+                'revision' => $revision,
388
+                'node' => $node,
389
+            ));
390
+            return true;
391
+        } else if ($versionCreated) {
392
+            self::deleteVersion($users_view, $version);
393
+        }
394
+
395
+        return false;
396
+
397
+    }
398
+
399
+    /**
400
+     * Stream copy file contents from $path1 to $path2
401
+     *
402
+     * @param View $view view to use for copying
403
+     * @param string $path1 source file to copy
404
+     * @param string $path2 target file
405
+     *
406
+     * @return bool true for success, false otherwise
407
+     */
408
+    private static function copyFileContents($view, $path1, $path2) {
409
+        /** @var \OC\Files\Storage\Storage $storage1 */
410
+        list($storage1, $internalPath1) = $view->resolvePath($path1);
411
+        /** @var \OC\Files\Storage\Storage $storage2 */
412
+        list($storage2, $internalPath2) = $view->resolvePath($path2);
413
+
414
+        $view->lockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
415
+        $view->lockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
416
+
417
+        // TODO add a proper way of overwriting a file while maintaining file ids
418
+        if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
419
+            $source = $storage1->fopen($internalPath1, 'r');
420
+            $target = $storage2->fopen($internalPath2, 'w');
421
+            list(, $result) = \OC_Helper::streamCopy($source, $target);
422
+            fclose($source);
423
+            fclose($target);
424
+
425
+            if ($result !== false) {
426
+                $storage1->unlink($internalPath1);
427
+            }
428
+        } else {
429
+            $result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
430
+        }
431
+
432
+        $view->unlockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
433
+        $view->unlockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
434
+
435
+        return ($result !== false);
436
+    }
437
+
438
+    /**
439
+     * get a list of all available versions of a file in descending chronological order
440
+     * @param string $uid user id from the owner of the file
441
+     * @param string $filename file to find versions of, relative to the user files dir
442
+     * @param string $userFullPath
443
+     * @return array versions newest version first
444
+     */
445
+    public static function getVersions($uid, $filename, $userFullPath = '') {
446
+        $versions = array();
447
+        if (empty($filename)) {
448
+            return $versions;
449
+        }
450
+        // fetch for old versions
451
+        $view = new View('/' . $uid . '/');
452
+
453
+        $pathinfo = pathinfo($filename);
454
+        $versionedFile = $pathinfo['basename'];
455
+
456
+        $dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
457
+
458
+        $dirContent = false;
459
+        if ($view->is_dir($dir)) {
460
+            $dirContent = $view->opendir($dir);
461
+        }
462
+
463
+        if ($dirContent === false) {
464
+            return $versions;
465
+        }
466
+
467
+        if (is_resource($dirContent)) {
468
+            while (($entryName = readdir($dirContent)) !== false) {
469
+                if (!Filesystem::isIgnoredDir($entryName)) {
470
+                    $pathparts = pathinfo($entryName);
471
+                    $filename = $pathparts['filename'];
472
+                    if ($filename === $versionedFile) {
473
+                        $pathparts = pathinfo($entryName);
474
+                        $timestamp = substr($pathparts['extension'], 1);
475
+                        $filename = $pathparts['filename'];
476
+                        $key = $timestamp . '#' . $filename;
477
+                        $versions[$key]['version'] = $timestamp;
478
+                        $versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
479
+                        if (empty($userFullPath)) {
480
+                            $versions[$key]['preview'] = '';
481
+                        } else {
482
+                            $versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
483
+                        }
484
+                        $versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
485
+                        $versions[$key]['name'] = $versionedFile;
486
+                        $versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
487
+                        $versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
488
+                    }
489
+                }
490
+            }
491
+            closedir($dirContent);
492
+        }
493
+
494
+        // sort with newest version first
495
+        krsort($versions);
496
+
497
+        return $versions;
498
+    }
499
+
500
+    /**
501
+     * Expire versions that older than max version retention time
502
+     * @param string $uid
503
+     */
504
+    public static function expireOlderThanMaxForUser($uid){
505
+        $expiration = self::getExpiration();
506
+        $threshold = $expiration->getMaxAgeAsTimestamp();
507
+        $versions = self::getAllVersions($uid);
508
+        if (!$threshold || !array_key_exists('all', $versions)) {
509
+            return;
510
+        }
511
+
512
+        $toDelete = [];
513
+        foreach (array_reverse($versions['all']) as $key => $version) {
514
+            if ((int)$version['version'] <$threshold) {
515
+                $toDelete[$key] = $version;
516
+            } else {
517
+                //Versions are sorted by time - nothing mo to iterate.
518
+                break;
519
+            }
520
+        }
521
+
522
+        $view = new View('/' . $uid . '/files_versions');
523
+        if (!empty($toDelete)) {
524
+            foreach ($toDelete as $version) {
525
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
526
+                self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
527
+                \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
528
+            }
529
+        }
530
+    }
531
+
532
+    /**
533
+     * translate a timestamp into a string like "5 days ago"
534
+     * @param int $timestamp
535
+     * @return string for example "5 days ago"
536
+     */
537
+    private static function getHumanReadableTimestamp($timestamp) {
538
+
539
+        $diff = time() - $timestamp;
540
+
541
+        if ($diff < 60) { // first minute
542
+            return  $diff . " seconds ago";
543
+        } elseif ($diff < 3600) { //first hour
544
+            return round($diff / 60) . " minutes ago";
545
+        } elseif ($diff < 86400) { // first day
546
+            return round($diff / 3600) . " hours ago";
547
+        } elseif ($diff < 604800) { //first week
548
+            return round($diff / 86400) . " days ago";
549
+        } elseif ($diff < 2419200) { //first month
550
+            return round($diff / 604800) . " weeks ago";
551
+        } elseif ($diff < 29030400) { // first year
552
+            return round($diff / 2419200) . " months ago";
553
+        } else {
554
+            return round($diff / 29030400) . " years ago";
555
+        }
556
+
557
+    }
558
+
559
+    /**
560
+     * returns all stored file versions from a given user
561
+     * @param string $uid id of the user
562
+     * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
563
+     */
564
+    private static function getAllVersions($uid) {
565
+        $view = new View('/' . $uid . '/');
566
+        $dirs = array(self::VERSIONS_ROOT);
567
+        $versions = array();
568
+
569
+        while (!empty($dirs)) {
570
+            $dir = array_pop($dirs);
571
+            $files = $view->getDirectoryContent($dir);
572
+
573
+            foreach ($files as $file) {
574
+                $fileData = $file->getData();
575
+                $filePath = $dir . '/' . $fileData['name'];
576
+                if ($file['type'] === 'dir') {
577
+                    $dirs[] = $filePath;
578
+                } else {
579
+                    $versionsBegin = strrpos($filePath, '.v');
580
+                    $relPathStart = strlen(self::VERSIONS_ROOT);
581
+                    $version = substr($filePath, $versionsBegin + 2);
582
+                    $relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
583
+                    $key = $version . '#' . $relpath;
584
+                    $versions[$key] = array('path' => $relpath, 'timestamp' => $version);
585
+                }
586
+            }
587
+        }
588
+
589
+        // newest version first
590
+        krsort($versions);
591
+
592
+        $result = array();
593
+
594
+        foreach ($versions as $key => $value) {
595
+            $size = $view->filesize(self::VERSIONS_ROOT.'/'.$value['path'].'.v'.$value['timestamp']);
596
+            $filename = $value['path'];
597
+
598
+            $result['all'][$key]['version'] = $value['timestamp'];
599
+            $result['all'][$key]['path'] = $filename;
600
+            $result['all'][$key]['size'] = $size;
601
+
602
+            $result['by_file'][$filename][$key]['version'] = $value['timestamp'];
603
+            $result['by_file'][$filename][$key]['path'] = $filename;
604
+            $result['by_file'][$filename][$key]['size'] = $size;
605
+        }
606
+
607
+        return $result;
608
+    }
609
+
610
+    /**
611
+     * get list of files we want to expire
612
+     * @param array $versions list of versions
613
+     * @param integer $time
614
+     * @param bool $quotaExceeded is versions storage limit reached
615
+     * @return array containing the list of to deleted versions and the size of them
616
+     */
617
+    protected static function getExpireList($time, $versions, $quotaExceeded = false) {
618
+        $expiration = self::getExpiration();
619
+
620
+        if ($expiration->shouldAutoExpire()) {
621
+            list($toDelete, $size) = self::getAutoExpireList($time, $versions);
622
+        } else {
623
+            $size = 0;
624
+            $toDelete = [];  // versions we want to delete
625
+        }
626
+
627
+        foreach ($versions as $key => $version) {
628
+            if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
629
+                $size += $version['size'];
630
+                $toDelete[$key] = $version['path'] . '.v' . $version['version'];
631
+            }
632
+        }
633
+
634
+        return [$toDelete, $size];
635
+    }
636
+
637
+    /**
638
+     * get list of files we want to expire
639
+     * @param array $versions list of versions
640
+     * @param integer $time
641
+     * @return array containing the list of to deleted versions and the size of them
642
+     */
643
+    protected static function getAutoExpireList($time, $versions) {
644
+        $size = 0;
645
+        $toDelete = array();  // versions we want to delete
646
+
647
+        $interval = 1;
648
+        $step = Storage::$max_versions_per_interval[$interval]['step'];
649
+        if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
650
+            $nextInterval = -1;
651
+        } else {
652
+            $nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
653
+        }
654
+
655
+        $firstVersion = reset($versions);
656
+        $firstKey = key($versions);
657
+        $prevTimestamp = $firstVersion['version'];
658
+        $nextVersion = $firstVersion['version'] - $step;
659
+        unset($versions[$firstKey]);
660
+
661
+        foreach ($versions as $key => $version) {
662
+            $newInterval = true;
663
+            while ($newInterval) {
664
+                if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
665
+                    if ($version['version'] > $nextVersion) {
666
+                        //distance between two version too small, mark to delete
667
+                        $toDelete[$key] = $version['path'] . '.v' . $version['version'];
668
+                        $size += $version['size'];
669
+                        \OC::$server->getLogger()->info('Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, ['app' => 'files_versions']);
670
+                    } else {
671
+                        $nextVersion = $version['version'] - $step;
672
+                        $prevTimestamp = $version['version'];
673
+                    }
674
+                    $newInterval = false; // version checked so we can move to the next one
675
+                } else { // time to move on to the next interval
676
+                    $interval++;
677
+                    $step = Storage::$max_versions_per_interval[$interval]['step'];
678
+                    $nextVersion = $prevTimestamp - $step;
679
+                    if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
680
+                        $nextInterval = -1;
681
+                    } else {
682
+                        $nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
683
+                    }
684
+                    $newInterval = true; // we changed the interval -> check same version with new interval
685
+                }
686
+            }
687
+        }
688
+
689
+        return array($toDelete, $size);
690
+    }
691
+
692
+    /**
693
+     * Schedule versions expiration for the given file
694
+     *
695
+     * @param string $uid owner of the file
696
+     * @param string $fileName file/folder for which to schedule expiration
697
+     */
698
+    private static function scheduleExpire($uid, $fileName) {
699
+        // let the admin disable auto expire
700
+        $expiration = self::getExpiration();
701
+        if ($expiration->isEnabled()) {
702
+            $command = new Expire($uid, $fileName);
703
+            \OC::$server->getCommandBus()->push($command);
704
+        }
705
+    }
706
+
707
+    /**
708
+     * Expire versions which exceed the quota.
709
+     *
710
+     * This will setup the filesystem for the given user but will not
711
+     * tear it down afterwards.
712
+     *
713
+     * @param string $filename path to file to expire
714
+     * @param string $uid user for which to expire the version
715
+     * @return bool|int|null
716
+     */
717
+    public static function expire($filename, $uid) {
718
+        $expiration = self::getExpiration();
719
+
720
+        if ($expiration->isEnabled()) {
721
+            // get available disk space for user
722
+            $user = \OC::$server->getUserManager()->get($uid);
723
+            if (is_null($user)) {
724
+                \OC::$server->getLogger()->error('Backends provided no user object for ' . $uid, ['app' => 'files_versions']);
725
+                throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
726
+            }
727
+
728
+            \OC_Util::setupFS($uid);
729
+
730
+            if (!Filesystem::file_exists($filename)) {
731
+                return false;
732
+            }
733
+
734
+            if (empty($filename)) {
735
+                // file maybe renamed or deleted
736
+                return false;
737
+            }
738
+            $versionsFileview = new View('/'.$uid.'/files_versions');
739
+
740
+            $softQuota = true;
741
+            $quota = $user->getQuota();
742
+            if ( $quota === null || $quota === 'none' ) {
743
+                $quota = Filesystem::free_space('/');
744
+                $softQuota = false;
745
+            } else {
746
+                $quota = \OCP\Util::computerFileSize($quota);
747
+            }
748
+
749
+            // make sure that we have the current size of the version history
750
+            $versionsSize = self::getVersionsSize($uid);
751
+
752
+            // calculate available space for version history
753
+            // subtract size of files and current versions size from quota
754
+            if ($quota >= 0) {
755
+                if ($softQuota) {
756
+                    $files_view = new View('/' . $uid . '/files');
757
+                    $rootInfo = $files_view->getFileInfo('/', false);
758
+                    $free = $quota - $rootInfo['size']; // remaining free space for user
759
+                    if ($free > 0) {
760
+                        $availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $versionsSize; // how much space can be used for versions
761
+                    } else {
762
+                        $availableSpace = $free - $versionsSize;
763
+                    }
764
+                } else {
765
+                    $availableSpace = $quota;
766
+                }
767
+            } else {
768
+                $availableSpace = PHP_INT_MAX;
769
+            }
770
+
771
+            $allVersions = Storage::getVersions($uid, $filename);
772
+
773
+            $time = time();
774
+            list($toDelete, $sizeOfDeletedVersions) = self::getExpireList($time, $allVersions, $availableSpace <= 0);
775
+
776
+            $availableSpace = $availableSpace + $sizeOfDeletedVersions;
777
+            $versionsSize = $versionsSize - $sizeOfDeletedVersions;
778
+
779
+            // if still not enough free space we rearrange the versions from all files
780
+            if ($availableSpace <= 0) {
781
+                $result = Storage::getAllVersions($uid);
782
+                $allVersions = $result['all'];
783
+
784
+                foreach ($result['by_file'] as $versions) {
785
+                    list($toDeleteNew, $size) = self::getExpireList($time, $versions, $availableSpace <= 0);
786
+                    $toDelete = array_merge($toDelete, $toDeleteNew);
787
+                    $sizeOfDeletedVersions += $size;
788
+                }
789
+                $availableSpace = $availableSpace + $sizeOfDeletedVersions;
790
+                $versionsSize = $versionsSize - $sizeOfDeletedVersions;
791
+            }
792
+
793
+            $logger = \OC::$server->getLogger();
794
+            foreach($toDelete as $key => $path) {
795
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
796
+                self::deleteVersion($versionsFileview, $path);
797
+                \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
798
+                unset($allVersions[$key]); // update array with the versions we keep
799
+                $logger->info('Expire: ' . $path, ['app' => 'files_versions']);
800
+            }
801
+
802
+            // Check if enough space is available after versions are rearranged.
803
+            // If not we delete the oldest versions until we meet the size limit for versions,
804
+            // but always keep the two latest versions
805
+            $numOfVersions = count($allVersions) -2 ;
806
+            $i = 0;
807
+            // sort oldest first and make sure that we start at the first element
808
+            ksort($allVersions);
809
+            reset($allVersions);
810
+            while ($availableSpace < 0 && $i < $numOfVersions) {
811
+                $version = current($allVersions);
812
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
813
+                self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
814
+                \OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
815
+                \OC::$server->getLogger()->info('running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'], ['app' => 'files_versions']);
816
+                $versionsSize -= $version['size'];
817
+                $availableSpace += $version['size'];
818
+                next($allVersions);
819
+                $i++;
820
+            }
821
+
822
+            return $versionsSize; // finally return the new size of the version history
823
+        }
824
+
825
+        return false;
826
+    }
827
+
828
+    /**
829
+     * Create recursively missing directories inside of files_versions
830
+     * that match the given path to a file.
831
+     *
832
+     * @param string $filename $path to a file, relative to the user's
833
+     * "files" folder
834
+     * @param View $view view on data/user/
835
+     */
836
+    private static function createMissingDirectories($filename, $view) {
837
+        $dirname = Filesystem::normalizePath(dirname($filename));
838
+        $dirParts = explode('/', $dirname);
839
+        $dir = "/files_versions";
840
+        foreach ($dirParts as $part) {
841
+            $dir = $dir . '/' . $part;
842
+            if (!$view->file_exists($dir)) {
843
+                $view->mkdir($dir);
844
+            }
845
+        }
846
+    }
847
+
848
+    /**
849
+     * Static workaround
850
+     * @return Expiration
851
+     */
852
+    protected static function getExpiration(){
853
+        if (is_null(self::$application)) {
854
+            self::$application = new Application();
855
+        }
856
+        return self::$application->getContainer()->query(Expiration::class);
857
+    }
858 858
 
859 859
 }
Please login to merge, or discard this patch.
Spacing   +67 added lines, -67 removed lines patch added patch discarded remove patch
@@ -54,8 +54,8 @@  discard block
 block discarded – undo
54 54
 
55 55
 class Storage {
56 56
 
57
-	const DEFAULTENABLED=true;
58
-	const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
57
+	const DEFAULTENABLED = true;
58
+	const DEFAULTMAXSIZE = 50; // unit: percentage; 50% of available disk space/quota
59 59
 	const VERSIONS_ROOT = 'files_versions/';
60 60
 
61 61
 	const DELETE_TRIGGER_MASTER_REMOVED = 0;
@@ -69,17 +69,17 @@  discard block
 block discarded – undo
69 69
 
70 70
 	private static $max_versions_per_interval = array(
71 71
 		//first 10sec, one version every 2sec
72
-		1 => array('intervalEndsAfter' => 10,      'step' => 2),
72
+		1 => array('intervalEndsAfter' => 10, 'step' => 2),
73 73
 		//next minute, one version every 10sec
74
-		2 => array('intervalEndsAfter' => 60,      'step' => 10),
74
+		2 => array('intervalEndsAfter' => 60, 'step' => 10),
75 75
 		//next hour, one version every minute
76
-		3 => array('intervalEndsAfter' => 3600,    'step' => 60),
76
+		3 => array('intervalEndsAfter' => 3600, 'step' => 60),
77 77
 		//next 24h, one version every hour
78
-		4 => array('intervalEndsAfter' => 86400,   'step' => 3600),
78
+		4 => array('intervalEndsAfter' => 86400, 'step' => 3600),
79 79
 		//next 30days, one version per day
80 80
 		5 => array('intervalEndsAfter' => 2592000, 'step' => 86400),
81 81
 		//until the end one version per week
82
-		6 => array('intervalEndsAfter' => -1,      'step' => 604800),
82
+		6 => array('intervalEndsAfter' => -1, 'step' => 604800),
83 83
 	);
84 84
 
85 85
 	/** @var \OCA\Files_Versions\AppInfo\Application */
@@ -103,7 +103,7 @@  discard block
 block discarded – undo
103 103
 			$uid = User::getUser();
104 104
 		}
105 105
 		Filesystem::initMountPoints($uid);
106
-		if ( $uid !== User::getUser() ) {
106
+		if ($uid !== User::getUser()) {
107 107
 			$info = Filesystem::getFileInfo($filename);
108 108
 			$ownerView = new View('/'.$uid.'/files');
109 109
 			try {
@@ -153,7 +153,7 @@  discard block
 block discarded – undo
153 153
 	 * @return int versions size
154 154
 	 */
155 155
 	private static function getVersionsSize($user) {
156
-		$view = new View('/' . $user);
156
+		$view = new View('/'.$user);
157 157
 		$fileInfo = $view->getFileInfo('/files_versions');
158 158
 		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
159 159
 	}
@@ -171,13 +171,13 @@  discard block
 block discarded – undo
171 171
 		}
172 172
 
173 173
 		// we only handle existing files
174
-		if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
174
+		if (!Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
175 175
 			return false;
176 176
 		}
177 177
 
178 178
 		list($uid, $filename) = self::getUidAndFilename($filename);
179 179
 
180
-		$files_view = new View('/'.$uid .'/files');
180
+		$files_view = new View('/'.$uid.'/files');
181 181
 		$users_view = new View('/'.$uid);
182 182
 
183 183
 		$eventDispatcher = \OC::$server->getEventDispatcher();
@@ -202,10 +202,10 @@  discard block
 block discarded – undo
202 202
 		self::scheduleExpire($uid, $filename);
203 203
 
204 204
 		// store a new version of a file
205
-		$mtime = $users_view->filemtime('files/' . $filename);
206
-		$users_view->copy('files/' . $filename, 'files_versions/' . $filename . '.v' . $mtime);
205
+		$mtime = $users_view->filemtime('files/'.$filename);
206
+		$users_view->copy('files/'.$filename, 'files_versions/'.$filename.'.v'.$mtime);
207 207
 		// call getFileInfo to enforce a file cache entry for the new version
208
-		$users_view->getFileInfo('files_versions/' . $filename . '.v' . $mtime);
208
+		$users_view->getFileInfo('files_versions/'.$filename.'.v'.$mtime);
209 209
 	}
210 210
 
211 211
 
@@ -248,14 +248,14 @@  discard block
 block discarded – undo
248 248
 
249 249
 		if (!Filesystem::file_exists($path)) {
250 250
 
251
-			$view = new View('/' . $uid . '/files_versions');
251
+			$view = new View('/'.$uid.'/files_versions');
252 252
 
253 253
 			$versions = self::getVersions($uid, $filename);
254 254
 			if (!empty($versions)) {
255 255
 				foreach ($versions as $v) {
256
-					\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
257
-					self::deleteVersion($view, $filename . '.v' . $v['version']);
258
-					\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
256
+					\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path.$v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
257
+					self::deleteVersion($view, $filename.'.v'.$v['version']);
258
+					\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path.$v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED));
259 259
 				}
260 260
 			}
261 261
 		}
@@ -289,33 +289,33 @@  discard block
 block discarded – undo
289 289
 		$rootView = new View('');
290 290
 
291 291
 		// did we move a directory ?
292
-		if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
292
+		if ($rootView->is_dir('/'.$targetOwner.'/files/'.$targetPath)) {
293 293
 			// does the directory exists for versions too ?
294
-			if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
294
+			if ($rootView->is_dir('/'.$sourceOwner.'/files_versions/'.$sourcePath)) {
295 295
 				// create missing dirs if necessary
296
-				self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
296
+				self::createMissingDirectories($targetPath, new View('/'.$targetOwner));
297 297
 
298 298
 				// move the directory containing the versions
299 299
 				$rootView->$operation(
300
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath,
301
-					'/' . $targetOwner . '/files_versions/' . $targetPath
300
+					'/'.$sourceOwner.'/files_versions/'.$sourcePath,
301
+					'/'.$targetOwner.'/files_versions/'.$targetPath
302 302
 				);
303 303
 			}
304
-		} else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
304
+		} else if ($versions = Storage::getVersions($sourceOwner, '/'.$sourcePath)) {
305 305
 			// create missing dirs if necessary
306
-			self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
306
+			self::createMissingDirectories($targetPath, new View('/'.$targetOwner));
307 307
 
308 308
 			foreach ($versions as $v) {
309 309
 				// move each version one by one to the target directory
310 310
 				$rootView->$operation(
311
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
312
-					'/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
311
+					'/'.$sourceOwner.'/files_versions/'.$sourcePath.'.v'.$v['version'],
312
+					'/'.$targetOwner.'/files_versions/'.$targetPath.'.v'.$v['version']
313 313
 				);
314 314
 			}
315 315
 		}
316 316
 
317 317
 		// if we moved versions directly for a file, schedule expiration check for that file
318
-		if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
318
+		if (!$rootView->is_dir('/'.$targetOwner.'/files/'.$targetPath)) {
319 319
 			self::scheduleExpire($targetOwner, $targetPath);
320 320
 		}
321 321
 
@@ -331,7 +331,7 @@  discard block
 block discarded – undo
331 331
 	public static function rollback($file, $revision) {
332 332
 
333 333
 		// add expected leading slash
334
-		$file = '/' . ltrim($file, '/');
334
+		$file = '/'.ltrim($file, '/');
335 335
 		list($uid, $filename) = self::getUidAndFilename($file);
336 336
 		if ($uid === null || trim($filename, '/') === '') {
337 337
 			return false;
@@ -341,7 +341,7 @@  discard block
 block discarded – undo
341 341
 		$userFolder = \OC::$server->getUserFolder($uid);
342 342
 
343 343
 		$users_view = new View('/'.$uid);
344
-		$files_view = new View('/'. User::getUser().'/files');
344
+		$files_view = new View('/'.User::getUser().'/files');
345 345
 
346 346
 		$versionCreated = false;
347 347
 
@@ -359,7 +359,7 @@  discard block
 block discarded – undo
359 359
 			$versionCreated = true;
360 360
 		}
361 361
 
362
-		$fileToRestore =  'files_versions' . $filename . '.v' . $revision;
362
+		$fileToRestore = 'files_versions'.$filename.'.v'.$revision;
363 363
 
364 364
 		// Restore encrypted version of the old file for the newly restored file
365 365
 		// This has to happen manually here since the file is manually copied below
@@ -375,7 +375,7 @@  discard block
 block discarded – undo
375 375
 		);
376 376
 
377 377
 		// rollback
378
-		if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
378
+		if (self::copyFileContents($users_view, $fileToRestore, 'files'.$filename)) {
379 379
 			$files_view->touch($file, $revision);
380 380
 			Storage::scheduleExpire($uid, $file);
381 381
 
@@ -448,12 +448,12 @@  discard block
 block discarded – undo
448 448
 			return $versions;
449 449
 		}
450 450
 		// fetch for old versions
451
-		$view = new View('/' . $uid . '/');
451
+		$view = new View('/'.$uid.'/');
452 452
 
453 453
 		$pathinfo = pathinfo($filename);
454 454
 		$versionedFile = $pathinfo['basename'];
455 455
 
456
-		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
456
+		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT.'/'.$pathinfo['dirname']);
457 457
 
458 458
 		$dirContent = false;
459 459
 		if ($view->is_dir($dir)) {
@@ -473,7 +473,7 @@  discard block
 block discarded – undo
473 473
 						$pathparts = pathinfo($entryName);
474 474
 						$timestamp = substr($pathparts['extension'], 1);
475 475
 						$filename = $pathparts['filename'];
476
-						$key = $timestamp . '#' . $filename;
476
+						$key = $timestamp.'#'.$filename;
477 477
 						$versions[$key]['version'] = $timestamp;
478 478
 						$versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
479 479
 						if (empty($userFullPath)) {
@@ -481,9 +481,9 @@  discard block
 block discarded – undo
481 481
 						} else {
482 482
 							$versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
483 483
 						}
484
-						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
484
+						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'].'/'.$filename);
485 485
 						$versions[$key]['name'] = $versionedFile;
486
-						$versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
486
+						$versions[$key]['size'] = $view->filesize($dir.'/'.$entryName);
487 487
 						$versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
488 488
 					}
489 489
 				}
@@ -501,7 +501,7 @@  discard block
 block discarded – undo
501 501
 	 * Expire versions that older than max version retention time
502 502
 	 * @param string $uid
503 503
 	 */
504
-	public static function expireOlderThanMaxForUser($uid){
504
+	public static function expireOlderThanMaxForUser($uid) {
505 505
 		$expiration = self::getExpiration();
506 506
 		$threshold = $expiration->getMaxAgeAsTimestamp();
507 507
 		$versions = self::getAllVersions($uid);
@@ -511,7 +511,7 @@  discard block
 block discarded – undo
511 511
 
512 512
 		$toDelete = [];
513 513
 		foreach (array_reverse($versions['all']) as $key => $version) {
514
-			if ((int)$version['version'] <$threshold) {
514
+			if ((int) $version['version'] < $threshold) {
515 515
 				$toDelete[$key] = $version;
516 516
 			} else {
517 517
 				//Versions are sorted by time - nothing mo to iterate.
@@ -519,11 +519,11 @@  discard block
 block discarded – undo
519 519
 			}
520 520
 		}
521 521
 
522
-		$view = new View('/' . $uid . '/files_versions');
522
+		$view = new View('/'.$uid.'/files_versions');
523 523
 		if (!empty($toDelete)) {
524 524
 			foreach ($toDelete as $version) {
525 525
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
526
-				self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
526
+				self::deleteVersion($view, $version['path'].'.v'.$version['version']);
527 527
 				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT));
528 528
 			}
529 529
 		}
@@ -539,19 +539,19 @@  discard block
 block discarded – undo
539 539
 		$diff = time() - $timestamp;
540 540
 
541 541
 		if ($diff < 60) { // first minute
542
-			return  $diff . " seconds ago";
542
+			return  $diff." seconds ago";
543 543
 		} elseif ($diff < 3600) { //first hour
544
-			return round($diff / 60) . " minutes ago";
544
+			return round($diff / 60)." minutes ago";
545 545
 		} elseif ($diff < 86400) { // first day
546
-			return round($diff / 3600) . " hours ago";
546
+			return round($diff / 3600)." hours ago";
547 547
 		} elseif ($diff < 604800) { //first week
548
-			return round($diff / 86400) . " days ago";
548
+			return round($diff / 86400)." days ago";
549 549
 		} elseif ($diff < 2419200) { //first month
550
-			return round($diff / 604800) . " weeks ago";
550
+			return round($diff / 604800)." weeks ago";
551 551
 		} elseif ($diff < 29030400) { // first year
552
-			return round($diff / 2419200) . " months ago";
552
+			return round($diff / 2419200)." months ago";
553 553
 		} else {
554
-			return round($diff / 29030400) . " years ago";
554
+			return round($diff / 29030400)." years ago";
555 555
 		}
556 556
 
557 557
 	}
@@ -562,7 +562,7 @@  discard block
 block discarded – undo
562 562
 	 * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
563 563
 	 */
564 564
 	private static function getAllVersions($uid) {
565
-		$view = new View('/' . $uid . '/');
565
+		$view = new View('/'.$uid.'/');
566 566
 		$dirs = array(self::VERSIONS_ROOT);
567 567
 		$versions = array();
568 568
 
@@ -572,7 +572,7 @@  discard block
 block discarded – undo
572 572
 
573 573
 			foreach ($files as $file) {
574 574
 				$fileData = $file->getData();
575
-				$filePath = $dir . '/' . $fileData['name'];
575
+				$filePath = $dir.'/'.$fileData['name'];
576 576
 				if ($file['type'] === 'dir') {
577 577
 					$dirs[] = $filePath;
578 578
 				} else {
@@ -580,7 +580,7 @@  discard block
 block discarded – undo
580 580
 					$relPathStart = strlen(self::VERSIONS_ROOT);
581 581
 					$version = substr($filePath, $versionsBegin + 2);
582 582
 					$relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
583
-					$key = $version . '#' . $relpath;
583
+					$key = $version.'#'.$relpath;
584 584
 					$versions[$key] = array('path' => $relpath, 'timestamp' => $version);
585 585
 				}
586 586
 			}
@@ -621,13 +621,13 @@  discard block
 block discarded – undo
621 621
 			list($toDelete, $size) = self::getAutoExpireList($time, $versions);
622 622
 		} else {
623 623
 			$size = 0;
624
-			$toDelete = [];  // versions we want to delete
624
+			$toDelete = []; // versions we want to delete
625 625
 		}
626 626
 
627 627
 		foreach ($versions as $key => $version) {
628 628
 			if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
629 629
 				$size += $version['size'];
630
-				$toDelete[$key] = $version['path'] . '.v' . $version['version'];
630
+				$toDelete[$key] = $version['path'].'.v'.$version['version'];
631 631
 			}
632 632
 		}
633 633
 
@@ -642,7 +642,7 @@  discard block
 block discarded – undo
642 642
 	 */
643 643
 	protected static function getAutoExpireList($time, $versions) {
644 644
 		$size = 0;
645
-		$toDelete = array();  // versions we want to delete
645
+		$toDelete = array(); // versions we want to delete
646 646
 
647 647
 		$interval = 1;
648 648
 		$step = Storage::$max_versions_per_interval[$interval]['step'];
@@ -664,9 +664,9 @@  discard block
 block discarded – undo
664 664
 				if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
665 665
 					if ($version['version'] > $nextVersion) {
666 666
 						//distance between two version too small, mark to delete
667
-						$toDelete[$key] = $version['path'] . '.v' . $version['version'];
667
+						$toDelete[$key] = $version['path'].'.v'.$version['version'];
668 668
 						$size += $version['size'];
669
-						\OC::$server->getLogger()->info('Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, ['app' => 'files_versions']);
669
+						\OC::$server->getLogger()->info('Mark to expire '.$version['path'].' next version should be '.$nextVersion." or smaller. (prevTimestamp: ".$prevTimestamp."; step: ".$step, ['app' => 'files_versions']);
670 670
 					} else {
671 671
 						$nextVersion = $version['version'] - $step;
672 672
 						$prevTimestamp = $version['version'];
@@ -721,8 +721,8 @@  discard block
 block discarded – undo
721 721
 			// get available disk space for user
722 722
 			$user = \OC::$server->getUserManager()->get($uid);
723 723
 			if (is_null($user)) {
724
-				\OC::$server->getLogger()->error('Backends provided no user object for ' . $uid, ['app' => 'files_versions']);
725
-				throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
724
+				\OC::$server->getLogger()->error('Backends provided no user object for '.$uid, ['app' => 'files_versions']);
725
+				throw new \OC\User\NoUserException('Backends provided no user object for '.$uid);
726 726
 			}
727 727
 
728 728
 			\OC_Util::setupFS($uid);
@@ -739,7 +739,7 @@  discard block
 block discarded – undo
739 739
 
740 740
 			$softQuota = true;
741 741
 			$quota = $user->getQuota();
742
-			if ( $quota === null || $quota === 'none' ) {
742
+			if ($quota === null || $quota === 'none') {
743 743
 				$quota = Filesystem::free_space('/');
744 744
 				$softQuota = false;
745 745
 			} else {
@@ -753,7 +753,7 @@  discard block
 block discarded – undo
753 753
 			// subtract size of files and current versions size from quota
754 754
 			if ($quota >= 0) {
755 755
 				if ($softQuota) {
756
-					$files_view = new View('/' . $uid . '/files');
756
+					$files_view = new View('/'.$uid.'/files');
757 757
 					$rootInfo = $files_view->getFileInfo('/', false);
758 758
 					$free = $quota - $rootInfo['size']; // remaining free space for user
759 759
 					if ($free > 0) {
@@ -791,18 +791,18 @@  discard block
 block discarded – undo
791 791
 			}
792 792
 
793 793
 			$logger = \OC::$server->getLogger();
794
-			foreach($toDelete as $key => $path) {
794
+			foreach ($toDelete as $key => $path) {
795 795
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
796 796
 				self::deleteVersion($versionsFileview, $path);
797 797
 				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
798 798
 				unset($allVersions[$key]); // update array with the versions we keep
799
-				$logger->info('Expire: ' . $path, ['app' => 'files_versions']);
799
+				$logger->info('Expire: '.$path, ['app' => 'files_versions']);
800 800
 			}
801 801
 
802 802
 			// Check if enough space is available after versions are rearranged.
803 803
 			// If not we delete the oldest versions until we meet the size limit for versions,
804 804
 			// but always keep the two latest versions
805
-			$numOfVersions = count($allVersions) -2 ;
805
+			$numOfVersions = count($allVersions) - 2;
806 806
 			$i = 0;
807 807
 			// sort oldest first and make sure that we start at the first element
808 808
 			ksort($allVersions);
@@ -810,9 +810,9 @@  discard block
 block discarded – undo
810 810
 			while ($availableSpace < 0 && $i < $numOfVersions) {
811 811
 				$version = current($allVersions);
812 812
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
813
-				self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
813
+				self::deleteVersion($versionsFileview, $version['path'].'.v'.$version['version']);
814 814
 				\OC_Hook::emit('\OCP\Versions', 'delete', array('path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED));
815
-				\OC::$server->getLogger()->info('running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'], ['app' => 'files_versions']);
815
+				\OC::$server->getLogger()->info('running out of space! Delete oldest version: '.$version['path'].'.v'.$version['version'], ['app' => 'files_versions']);
816 816
 				$versionsSize -= $version['size'];
817 817
 				$availableSpace += $version['size'];
818 818
 				next($allVersions);
@@ -838,7 +838,7 @@  discard block
 block discarded – undo
838 838
 		$dirParts = explode('/', $dirname);
839 839
 		$dir = "/files_versions";
840 840
 		foreach ($dirParts as $part) {
841
-			$dir = $dir . '/' . $part;
841
+			$dir = $dir.'/'.$part;
842 842
 			if (!$view->file_exists($dir)) {
843 843
 				$view->mkdir($dir);
844 844
 			}
@@ -849,7 +849,7 @@  discard block
 block discarded – undo
849 849
 	 * Static workaround
850 850
 	 * @return Expiration
851 851
 	 */
852
-	protected static function getExpiration(){
852
+	protected static function getExpiration() {
853 853
 		if (is_null(self::$application)) {
854 854
 			self::$application = new Application();
855 855
 		}
Please login to merge, or discard this patch.
lib/private/Preview/Watcher.php 1 patch
Indentation   +30 added lines, -30 removed lines patch added patch discarded remove patch
@@ -36,39 +36,39 @@
 block discarded – undo
36 36
  * Class that will watch filesystem activity and remove previews as needed.
37 37
  */
38 38
 class Watcher {
39
-	/** @var IAppData */
40
-	private $appData;
39
+    /** @var IAppData */
40
+    private $appData;
41 41
 
42
-	/**
43
-	 * Watcher constructor.
44
-	 *
45
-	 * @param IAppData $appData
46
-	 */
47
-	public function __construct(IAppData $appData) {
48
-		$this->appData = $appData;
49
-	}
42
+    /**
43
+     * Watcher constructor.
44
+     *
45
+     * @param IAppData $appData
46
+     */
47
+    public function __construct(IAppData $appData) {
48
+        $this->appData = $appData;
49
+    }
50 50
 
51
-	public function postWrite(Node $node) {
52
-		$this->deleteNode($node);
53
-	}
51
+    public function postWrite(Node $node) {
52
+        $this->deleteNode($node);
53
+    }
54 54
 
55
-	protected function deleteNode(Node $node) {
56
-		// We only handle files
57
-		if ($node instanceof Folder) {
58
-			return;
59
-		}
55
+    protected function deleteNode(Node $node) {
56
+        // We only handle files
57
+        if ($node instanceof Folder) {
58
+            return;
59
+        }
60 60
 
61
-		try {
62
-			$folder = $this->appData->getFolder((string)$node->getId());
63
-			$folder->delete();
64
-		} catch (NotFoundException $e) {
65
-			//Nothing to do
66
-		}
67
-	}
61
+        try {
62
+            $folder = $this->appData->getFolder((string)$node->getId());
63
+            $folder->delete();
64
+        } catch (NotFoundException $e) {
65
+            //Nothing to do
66
+        }
67
+    }
68 68
 
69
-	public function versionRollback(array $data) {
70
-		if (isset($data['node'])) {
71
-			$this->deleteNode($data['node']);
72
-		}
73
-	}
69
+    public function versionRollback(array $data) {
70
+        if (isset($data['node'])) {
71
+            $this->deleteNode($data['node']);
72
+        }
73
+    }
74 74
 }
Please login to merge, or discard this patch.
lib/private/Preview/WatcherConnector.php 2 patches
Indentation   +30 added lines, -30 removed lines patch added patch discarded remove patch
@@ -29,39 +29,39 @@
 block discarded – undo
29 29
 
30 30
 class WatcherConnector {
31 31
 
32
-	/** @var IRootFolder */
33
-	private $root;
32
+    /** @var IRootFolder */
33
+    private $root;
34 34
 
35
-	/** @var SystemConfig */
36
-	private $config;
35
+    /** @var SystemConfig */
36
+    private $config;
37 37
 
38
-	/**
39
-	 * WatcherConnector constructor.
40
-	 *
41
-	 * @param IRootFolder $root
42
-	 * @param SystemConfig $config
43
-	 */
44
-	public function __construct(IRootFolder $root,
45
-								SystemConfig $config) {
46
-		$this->root = $root;
47
-		$this->config = $config;
48
-	}
38
+    /**
39
+     * WatcherConnector constructor.
40
+     *
41
+     * @param IRootFolder $root
42
+     * @param SystemConfig $config
43
+     */
44
+    public function __construct(IRootFolder $root,
45
+                                SystemConfig $config) {
46
+        $this->root = $root;
47
+        $this->config = $config;
48
+    }
49 49
 
50
-	/**
51
-	 * @return Watcher
52
-	 */
53
-	private function getWatcher(): Watcher {
54
-		return \OC::$server->query(Watcher::class);
55
-	}
50
+    /**
51
+     * @return Watcher
52
+     */
53
+    private function getWatcher(): Watcher {
54
+        return \OC::$server->query(Watcher::class);
55
+    }
56 56
 
57
-	public function connectWatcher() {
58
-		// Do not connect if we are not setup yet!
59
-		if ($this->config->getValue('instanceid', null) !== null) {
60
-			$this->root->listen('\OC\Files', 'postWrite', function (Node $node) {
61
-				$this->getWatcher()->postWrite($node);
62
-			});
57
+    public function connectWatcher() {
58
+        // Do not connect if we are not setup yet!
59
+        if ($this->config->getValue('instanceid', null) !== null) {
60
+            $this->root->listen('\OC\Files', 'postWrite', function (Node $node) {
61
+                $this->getWatcher()->postWrite($node);
62
+            });
63 63
 
64
-			\OC_Hook::connect('\OCP\Versions', 'rollback', $this->getWatcher(), 'versionRollback');
65
-		}
66
-	}
64
+            \OC_Hook::connect('\OCP\Versions', 'rollback', $this->getWatcher(), 'versionRollback');
65
+        }
66
+    }
67 67
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -57,7 +57,7 @@
 block discarded – undo
57 57
 	public function connectWatcher() {
58 58
 		// Do not connect if we are not setup yet!
59 59
 		if ($this->config->getValue('instanceid', null) !== null) {
60
-			$this->root->listen('\OC\Files', 'postWrite', function (Node $node) {
60
+			$this->root->listen('\OC\Files', 'postWrite', function(Node $node) {
61 61
 				$this->getWatcher()->postWrite($node);
62 62
 			});
63 63
 
Please login to merge, or discard this patch.