nextcloud / server

apps/theming/lib/ThemingDefaults.php

Indentation +375 added lines, -375 removed lines

@@ -50,379 +50,379 @@
 
 class ThemingDefaults extends \OC_Defaults {
 
-	/** @var IConfig */
-	private $config;
-	/** @var IL10N */
-	private $l;
-	/** @var ImageManager */
-	private $imageManager;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var ICacheFactory */
-	private $cacheFactory;
-	/** @var Util */
-	private $util;
-	/** @var IAppManager */
-	private $appManager;
-	/** @var INavigationManager */
-	private $navigationManager;
-
-	/** @var string */
-	private $name;
-	/** @var string */
-	private $title;
-	/** @var string */
-	private $entity;
-	/** @var string */
-	private $url;
-	/** @var string */
-	private $color;
-
-	/** @var string */
-	private $iTunesAppId;
-	/** @var string */
-	private $iOSClientUrl;
-	/** @var string */
-	private $AndroidClientUrl;
-
-	/**
-	 * ThemingDefaults constructor.
-	 *
-	 * @param IConfig $config
-	 * @param IL10N $l
-	 * @param ImageManager $imageManager
-	 * @param IURLGenerator $urlGenerator
-	 * @param ICacheFactory $cacheFactory
-	 * @param Util $util
-	 * @param IAppManager $appManager
-	 */
-	public function __construct(IConfig $config,
-								IL10N $l,
-								IURLGenerator $urlGenerator,
-								ICacheFactory $cacheFactory,
-								Util $util,
-								ImageManager $imageManager,
-								IAppManager $appManager,
-								INavigationManager $navigationManager
-	) {
-		parent::__construct();
-		$this->config = $config;
-		$this->l = $l;
-		$this->imageManager = $imageManager;
-		$this->urlGenerator = $urlGenerator;
-		$this->cacheFactory = $cacheFactory;
-		$this->util = $util;
-		$this->appManager = $appManager;
-		$this->navigationManager = $navigationManager;
-
-		$this->name = parent::getName();
-		$this->title = parent::getTitle();
-		$this->entity = parent::getEntity();
-		$this->url = parent::getBaseUrl();
-		$this->color = parent::getColorPrimary();
-		$this->iTunesAppId = parent::getiTunesAppId();
-		$this->iOSClientUrl = parent::getiOSClientUrl();
-		$this->AndroidClientUrl = parent::getAndroidClientUrl();
-	}
-
-	public function getName() {
-		return strip_tags($this->config->getAppValue('theming', 'name', $this->name));
-	}
-
-	public function getHTMLName() {
-		return $this->config->getAppValue('theming', 'name', $this->name);
-	}
-
-	public function getTitle() {
-		return strip_tags($this->config->getAppValue('theming', 'name', $this->title));
-	}
-
-	public function getEntity() {
-		return strip_tags($this->config->getAppValue('theming', 'name', $this->entity));
-	}
-
-	public function getBaseUrl() {
-		return $this->config->getAppValue('theming', 'url', $this->url);
-	}
-
-	public function getSlogan() {
-		return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', parent::getSlogan()));
-	}
-
-	public function getImprintUrl() {
-		return (string)$this->config->getAppValue('theming', 'imprintUrl', '');
-	}
-
-	public function getPrivacyUrl() {
-		return (string)$this->config->getAppValue('theming', 'privacyUrl', '');
-	}
-
-	public function getShortFooter() {
-		$slogan = $this->getSlogan();
-		$baseUrl = $this->getBaseUrl();
-		if ($baseUrl !== '') {
-			$footer = '<a href="' . $baseUrl . '" target="_blank"' .
-				' rel="noreferrer noopener" class="entity-name">' . $this->getEntity() . '</a>';
-		} else {
-			$footer = '<span class="entity-name">' .$this->getEntity() . '</span>';
-		}
-		$footer .= ($slogan !== '' ? ' – ' . $slogan : '');
-
-		$links = [
-			[
-				'text' => $this->l->t('Legal notice'),
-				'url' => (string)$this->getImprintUrl()
-			],
-			[
-				'text' => $this->l->t('Privacy policy'),
-				'url' => (string)$this->getPrivacyUrl()
-			],
-		];
-
-		$navigation = $this->navigationManager->getAll(INavigationManager::TYPE_GUEST);
-		$guestNavigation = array_map(function ($nav) {
-			return [
-				'text' => $nav['name'],
-				'url' => $nav['href']
-			];
-		}, $navigation);
-		$links = array_merge($links, $guestNavigation);
-
-		$legalLinks = ''; $divider = '';
-		foreach($links as $link) {
-			if($link['url'] !== ''
-				&& filter_var($link['url'], FILTER_VALIDATE_URL)
-			) {
-				$legalLinks .= $divider . '<a href="' . $link['url'] . '" class="legal" target="_blank"' .
-					' rel="noreferrer noopener">' . $link['text'] . '</a>';
-				$divider = ' · ';
-			}
-		}
-		if($legalLinks !== '') {
-			$footer .= '<br/>' . $legalLinks;
-		}
-
-		return $footer;
-	}
-
-	/**
-	 * Color that is used for the header as well as for mail headers
-	 *
-	 * @return string
-	 */
-	public function getColorPrimary() {
-		return $this->config->getAppValue('theming', 'color', $this->color);
-	}
-
-	/**
-	 * Themed logo url
-	 *
-	 * @param bool $useSvg Whether to point to the SVG image or a fallback
-	 * @return string
-	 */
-	public function getLogo($useSvg = true): string {
-		$logo = $this->config->getAppValue('theming', 'logoMime', false);
-
-		$logoExists = true;
-		try {
-			$this->imageManager->getImage('logo', $useSvg);
-		} catch (\Exception $e) {
-			$logoExists = false;
-		}
-
-		$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
-
-		if(!$logo || !$logoExists) {
-			if($useSvg) {
-				$logo = $this->urlGenerator->imagePath('core', 'logo/logo.svg');
-			} else {
-				$logo = $this->urlGenerator->imagePath('core', 'logo/logo.png');
-			}
-			return $logo . '?v=' . $cacheBusterCounter;
-		}
-
-		return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter ]);
-	}
-
-	/**
-	 * Themed background image url
-	 *
-	 * @return string
-	 */
-	public function getBackground(): string {
-		return $this->imageManager->getImageUrl('background');
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getiTunesAppId() {
-		return $this->config->getAppValue('theming', 'iTunesAppId', $this->iTunesAppId);
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getiOSClientUrl() {
-		return $this->config->getAppValue('theming', 'iOSClientUrl', $this->iOSClientUrl);
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getAndroidClientUrl() {
-		return $this->config->getAppValue('theming', 'AndroidClientUrl', $this->AndroidClientUrl);
-	}
-
-
-	/**
-	 * @return array scss variables to overwrite
-	 */
-	public function getScssVariables() {
-		$cache = $this->cacheFactory->createDistributed('theming-' . $this->urlGenerator->getBaseUrl());
-		if ($value = $cache->get('getScssVariables')) {
-			return $value;
-		}
-
-		$variables = [
-			'theming-cachebuster' => "'" . $this->config->getAppValue('theming', 'cachebuster', '0') . "'",
-			'theming-logo-mime' => "'" . $this->config->getAppValue('theming', 'logoMime') . "'",
-			'theming-background-mime' => "'" . $this->config->getAppValue('theming', 'backgroundMime') . "'",
-			'theming-logoheader-mime' => "'" . $this->config->getAppValue('theming', 'logoheaderMime') . "'",
-			'theming-favicon-mime' => "'" . $this->config->getAppValue('theming', 'faviconMime') . "'"
-		];
-
-		$variables['image-logo'] = "url('".$this->imageManager->getImageUrl('logo')."')";
-		$variables['image-logoheader'] = "url('".$this->imageManager->getImageUrl('logoheader')."')";
-		$variables['image-favicon'] = "url('".$this->imageManager->getImageUrl('favicon')."')";
-		$variables['image-login-background'] = "url('".$this->imageManager->getImageUrl('background')."')";
-		$variables['image-login-plain'] = 'false';
-
-		if ($this->config->getAppValue('theming', 'color', null) !== null) {
-			$variables['color-primary'] = $this->getColorPrimary();
-			$variables['color-primary-text'] = $this->getTextColorPrimary();
-			$variables['color-primary-element'] = $this->util->elementColor($this->getColorPrimary());
-		}
-
-		if ($this->config->getAppValue('theming', 'backgroundMime', null) === 'backgroundColor') {
-			$variables['image-login-plain'] = 'true';
-		}
-
-		$variables['has-legal-links'] = 'false';
-		if($this->getImprintUrl() !== '' || $this->getPrivacyUrl() !== '') {
-			$variables['has-legal-links'] = 'true';
-		}
-
-		$cache->set('getScssVariables', $variables);
-		return $variables;
-	}
-
-	/**
-	 * Check if the image should be replaced by the theming app
-	 * and return the new image location then
-	 *
-	 * @param string $app name of the app
-	 * @param string $image filename of the image
-	 * @return bool|string false if image should not replaced, otherwise the location of the image
-	 */
-	public function replaceImagePath($app, $image) {
-		if ($app === '' || $app === 'files_sharing') {
-			$app = 'core';
-		}
-		$cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
-
-		try {
-			$customFavicon = $this->imageManager->getImage('favicon');
-		} catch (NotFoundException $e) {
-			$customFavicon = null;
-		}
-
-		$route = false;
-		if ($image === 'favicon.ico' && ($customFavicon !== null || $this->imageManager->shouldReplaceIcons())) {
-			$route = $this->urlGenerator->linkToRoute('theming.Icon.getFavicon', ['app' => $app]);
-		}
-		if (($image === 'favicon-touch.png' || $image === 'favicon-fb.png') && ($customFavicon !== null || $this->imageManager->shouldReplaceIcons())) {
-			$route = $this->urlGenerator->linkToRoute('theming.Icon.getTouchIcon', ['app' => $app]);
-		}
-		if ($image === 'manifest.json') {
-			try {
-				$appPath = $this->appManager->getAppPath($app);
-				if (file_exists($appPath . '/img/manifest.json')) {
-					return false;
-				}
-			} catch (AppPathNotFoundException $e) {}
-			$route = $this->urlGenerator->linkToRoute('theming.Theming.getManifest');
-		}
-		if (strpos($image, 'filetypes/') === 0 && file_exists(\OC::$SERVERROOT . '/core/img/' . $image)) {
-			$route = $this->urlGenerator->linkToRoute('theming.Icon.getThemedIcon', ['app' => $app, 'image' => $image]);
-		}
-
-		if ($route) {
-			return $route . '?v=' . $cacheBusterValue;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Increases the cache buster key
-	 */
-	private function increaseCacheBuster() {
-		$cacheBusterKey = $this->config->getAppValue('theming', 'cachebuster', '0');
-		$this->config->setAppValue('theming', 'cachebuster', (int)$cacheBusterKey+1);
-		$this->cacheFactory->createDistributed('theming-')->clear();
-		$this->cacheFactory->createDistributed('imagePath')->clear();
-
-	}
-
-	/**
-	 * Update setting in the database
-	 *
-	 * @param string $setting
-	 * @param string $value
-	 */
-	public function set($setting, $value) {
-		$this->config->setAppValue('theming', $setting, $value);
-		$this->increaseCacheBuster();
-	}
-
-	/**
-	 * Revert settings to the default value
-	 *
-	 * @param string $setting setting which should be reverted
-	 * @return string default value
-	 */
-	public function undo($setting) {
-		$this->config->deleteAppValue('theming', $setting);
-		$this->increaseCacheBuster();
-
-		switch ($setting) {
-			case 'name':
-				$returnValue = $this->getEntity();
-				break;
-			case 'url':
-				$returnValue = $this->getBaseUrl();
-				break;
-			case 'slogan':
-				$returnValue = $this->getSlogan();
-				break;
-			case 'color':
-				$returnValue = $this->getColorPrimary();
-				break;
-			default:
-				$returnValue = '';
-				break;
-		}
-
-		return $returnValue;
-	}
-
-	/**
-	 * Color of text in the header and primary buttons
-	 *
-	 * @return string
-	 */
-	public function getTextColorPrimary() {
-		return $this->util->invertTextColor($this->getColorPrimary()) ? '#000000' : '#ffffff';
-	}
+    /** @var IConfig */
+    private $config;
+    /** @var IL10N */
+    private $l;
+    /** @var ImageManager */
+    private $imageManager;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var ICacheFactory */
+    private $cacheFactory;
+    /** @var Util */
+    private $util;
+    /** @var IAppManager */
+    private $appManager;
+    /** @var INavigationManager */
+    private $navigationManager;
+
+    /** @var string */
+    private $name;
+    /** @var string */
+    private $title;
+    /** @var string */
+    private $entity;
+    /** @var string */
+    private $url;
+    /** @var string */
+    private $color;
+
+    /** @var string */
+    private $iTunesAppId;
+    /** @var string */
+    private $iOSClientUrl;
+    /** @var string */
+    private $AndroidClientUrl;
+
+    /**
+     * ThemingDefaults constructor.
+     *
+     * @param IConfig $config
+     * @param IL10N $l
+     * @param ImageManager $imageManager
+     * @param IURLGenerator $urlGenerator
+     * @param ICacheFactory $cacheFactory
+     * @param Util $util
+     * @param IAppManager $appManager
+     */
+    public function __construct(IConfig $config,
+                                IL10N $l,
+                                IURLGenerator $urlGenerator,
+                                ICacheFactory $cacheFactory,
+                                Util $util,
+                                ImageManager $imageManager,
+                                IAppManager $appManager,
+                                INavigationManager $navigationManager
+    ) {
+        parent::__construct();
+        $this->config = $config;
+        $this->l = $l;
+        $this->imageManager = $imageManager;
+        $this->urlGenerator = $urlGenerator;
+        $this->cacheFactory = $cacheFactory;
+        $this->util = $util;
+        $this->appManager = $appManager;
+        $this->navigationManager = $navigationManager;
+
+        $this->name = parent::getName();
+        $this->title = parent::getTitle();
+        $this->entity = parent::getEntity();
+        $this->url = parent::getBaseUrl();
+        $this->color = parent::getColorPrimary();
+        $this->iTunesAppId = parent::getiTunesAppId();
+        $this->iOSClientUrl = parent::getiOSClientUrl();
+        $this->AndroidClientUrl = parent::getAndroidClientUrl();
+    }
+
+    public function getName() {
+        return strip_tags($this->config->getAppValue('theming', 'name', $this->name));
+    }
+
+    public function getHTMLName() {
+        return $this->config->getAppValue('theming', 'name', $this->name);
+    }
+
+    public function getTitle() {
+        return strip_tags($this->config->getAppValue('theming', 'name', $this->title));
+    }
+
+    public function getEntity() {
+        return strip_tags($this->config->getAppValue('theming', 'name', $this->entity));
+    }
+
+    public function getBaseUrl() {
+        return $this->config->getAppValue('theming', 'url', $this->url);
+    }
+
+    public function getSlogan() {
+        return \OCP\Util::sanitizeHTML($this->config->getAppValue('theming', 'slogan', parent::getSlogan()));
+    }
+
+    public function getImprintUrl() {
+        return (string)$this->config->getAppValue('theming', 'imprintUrl', '');
+    }
+
+    public function getPrivacyUrl() {
+        return (string)$this->config->getAppValue('theming', 'privacyUrl', '');
+    }
+
+    public function getShortFooter() {
+        $slogan = $this->getSlogan();
+        $baseUrl = $this->getBaseUrl();
+        if ($baseUrl !== '') {
+            $footer = '<a href="' . $baseUrl . '" target="_blank"' .
+                ' rel="noreferrer noopener" class="entity-name">' . $this->getEntity() . '</a>';
+        } else {
+            $footer = '<span class="entity-name">' .$this->getEntity() . '</span>';
+        }
+        $footer .= ($slogan !== '' ? ' – ' . $slogan : '');
+
+        $links = [
+            [
+                'text' => $this->l->t('Legal notice'),
+                'url' => (string)$this->getImprintUrl()
+            ],
+            [
+                'text' => $this->l->t('Privacy policy'),
+                'url' => (string)$this->getPrivacyUrl()
+            ],
+        ];
+
+        $navigation = $this->navigationManager->getAll(INavigationManager::TYPE_GUEST);
+        $guestNavigation = array_map(function ($nav) {
+            return [
+                'text' => $nav['name'],
+                'url' => $nav['href']
+            ];
+        }, $navigation);
+        $links = array_merge($links, $guestNavigation);
+
+        $legalLinks = ''; $divider = '';
+        foreach($links as $link) {
+            if($link['url'] !== ''
+                && filter_var($link['url'], FILTER_VALIDATE_URL)
+            ) {
+                $legalLinks .= $divider . '<a href="' . $link['url'] . '" class="legal" target="_blank"' .
+                    ' rel="noreferrer noopener">' . $link['text'] . '</a>';
+                $divider = ' · ';
+            }
+        }
+        if($legalLinks !== '') {
+            $footer .= '<br/>' . $legalLinks;
+        }
+
+        return $footer;
+    }
+
+    /**
+     * Color that is used for the header as well as for mail headers
+     *
+     * @return string
+     */
+    public function getColorPrimary() {
+        return $this->config->getAppValue('theming', 'color', $this->color);
+    }
+
+    /**
+     * Themed logo url
+     *
+     * @param bool $useSvg Whether to point to the SVG image or a fallback
+     * @return string
+     */
+    public function getLogo($useSvg = true): string {
+        $logo = $this->config->getAppValue('theming', 'logoMime', false);
+
+        $logoExists = true;
+        try {
+            $this->imageManager->getImage('logo', $useSvg);
+        } catch (\Exception $e) {
+            $logoExists = false;
+        }
+
+        $cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
+
+        if(!$logo || !$logoExists) {
+            if($useSvg) {
+                $logo = $this->urlGenerator->imagePath('core', 'logo/logo.svg');
+            } else {
+                $logo = $this->urlGenerator->imagePath('core', 'logo/logo.png');
+            }
+            return $logo . '?v=' . $cacheBusterCounter;
+        }
+
+        return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter ]);
+    }
+
+    /**
+     * Themed background image url
+     *
+     * @return string
+     */
+    public function getBackground(): string {
+        return $this->imageManager->getImageUrl('background');
+    }
+
+    /**
+     * @return string
+     */
+    public function getiTunesAppId() {
+        return $this->config->getAppValue('theming', 'iTunesAppId', $this->iTunesAppId);
+    }
+
+    /**
+     * @return string
+     */
+    public function getiOSClientUrl() {
+        return $this->config->getAppValue('theming', 'iOSClientUrl', $this->iOSClientUrl);
+    }
+
+    /**
+     * @return string
+     */
+    public function getAndroidClientUrl() {
+        return $this->config->getAppValue('theming', 'AndroidClientUrl', $this->AndroidClientUrl);
+    }
+
+
+    /**
+     * @return array scss variables to overwrite
+     */
+    public function getScssVariables() {
+        $cache = $this->cacheFactory->createDistributed('theming-' . $this->urlGenerator->getBaseUrl());
+        if ($value = $cache->get('getScssVariables')) {
+            return $value;
+        }
+
+        $variables = [
+            'theming-cachebuster' => "'" . $this->config->getAppValue('theming', 'cachebuster', '0') . "'",
+            'theming-logo-mime' => "'" . $this->config->getAppValue('theming', 'logoMime') . "'",
+            'theming-background-mime' => "'" . $this->config->getAppValue('theming', 'backgroundMime') . "'",
+            'theming-logoheader-mime' => "'" . $this->config->getAppValue('theming', 'logoheaderMime') . "'",
+            'theming-favicon-mime' => "'" . $this->config->getAppValue('theming', 'faviconMime') . "'"
+        ];
+
+        $variables['image-logo'] = "url('".$this->imageManager->getImageUrl('logo')."')";
+        $variables['image-logoheader'] = "url('".$this->imageManager->getImageUrl('logoheader')."')";
+        $variables['image-favicon'] = "url('".$this->imageManager->getImageUrl('favicon')."')";
+        $variables['image-login-background'] = "url('".$this->imageManager->getImageUrl('background')."')";
+        $variables['image-login-plain'] = 'false';
+
+        if ($this->config->getAppValue('theming', 'color', null) !== null) {
+            $variables['color-primary'] = $this->getColorPrimary();
+            $variables['color-primary-text'] = $this->getTextColorPrimary();
+            $variables['color-primary-element'] = $this->util->elementColor($this->getColorPrimary());
+        }
+
+        if ($this->config->getAppValue('theming', 'backgroundMime', null) === 'backgroundColor') {
+            $variables['image-login-plain'] = 'true';
+        }
+
+        $variables['has-legal-links'] = 'false';
+        if($this->getImprintUrl() !== '' || $this->getPrivacyUrl() !== '') {
+            $variables['has-legal-links'] = 'true';
+        }
+
+        $cache->set('getScssVariables', $variables);
+        return $variables;
+    }
+
+    /**
+     * Check if the image should be replaced by the theming app
+     * and return the new image location then
+     *
+     * @param string $app name of the app
+     * @param string $image filename of the image
+     * @return bool|string false if image should not replaced, otherwise the location of the image
+     */
+    public function replaceImagePath($app, $image) {
+        if ($app === '' || $app === 'files_sharing') {
+            $app = 'core';
+        }
+        $cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0');
+
+        try {
+            $customFavicon = $this->imageManager->getImage('favicon');
+        } catch (NotFoundException $e) {
+            $customFavicon = null;
+        }
+
+        $route = false;
+        if ($image === 'favicon.ico' && ($customFavicon !== null || $this->imageManager->shouldReplaceIcons())) {
+            $route = $this->urlGenerator->linkToRoute('theming.Icon.getFavicon', ['app' => $app]);
+        }
+        if (($image === 'favicon-touch.png' || $image === 'favicon-fb.png') && ($customFavicon !== null || $this->imageManager->shouldReplaceIcons())) {
+            $route = $this->urlGenerator->linkToRoute('theming.Icon.getTouchIcon', ['app' => $app]);
+        }
+        if ($image === 'manifest.json') {
+            try {
+                $appPath = $this->appManager->getAppPath($app);
+                if (file_exists($appPath . '/img/manifest.json')) {
+                    return false;
+                }
+            } catch (AppPathNotFoundException $e) {}
+            $route = $this->urlGenerator->linkToRoute('theming.Theming.getManifest');
+        }
+        if (strpos($image, 'filetypes/') === 0 && file_exists(\OC::$SERVERROOT . '/core/img/' . $image)) {
+            $route = $this->urlGenerator->linkToRoute('theming.Icon.getThemedIcon', ['app' => $app, 'image' => $image]);
+        }
+
+        if ($route) {
+            return $route . '?v=' . $cacheBusterValue;
+        }
+
+        return false;
+    }
+
+    /**
+     * Increases the cache buster key
+     */
+    private function increaseCacheBuster() {
+        $cacheBusterKey = $this->config->getAppValue('theming', 'cachebuster', '0');
+        $this->config->setAppValue('theming', 'cachebuster', (int)$cacheBusterKey+1);
+        $this->cacheFactory->createDistributed('theming-')->clear();
+        $this->cacheFactory->createDistributed('imagePath')->clear();
+
+    }
+
+    /**
+     * Update setting in the database
+     *
+     * @param string $setting
+     * @param string $value
+     */
+    public function set($setting, $value) {
+        $this->config->setAppValue('theming', $setting, $value);
+        $this->increaseCacheBuster();
+    }
+
+    /**
+     * Revert settings to the default value
+     *
+     * @param string $setting setting which should be reverted
+     * @return string default value
+     */
+    public function undo($setting) {
+        $this->config->deleteAppValue('theming', $setting);
+        $this->increaseCacheBuster();
+
+        switch ($setting) {
+            case 'name':
+                $returnValue = $this->getEntity();
+                break;
+            case 'url':
+                $returnValue = $this->getBaseUrl();
+                break;
+            case 'slogan':
+                $returnValue = $this->getSlogan();
+                break;
+            case 'color':
+                $returnValue = $this->getColorPrimary();
+                break;
+            default:
+                $returnValue = '';
+                break;
+        }
+
+        return $returnValue;
+    }
+
+    /**
+     * Color of text in the header and primary buttons
+     *
+     * @return string
+     */
+    public function getTextColorPrimary() {
+        return $this->util->invertTextColor($this->getColorPrimary()) ? '#000000' : '#ffffff';
+    }
 }

Spacing +30 added lines, -30 removed lines

@@ -150,37 +150,37 @@ 
 	}
 
 	public function getImprintUrl() {
-		return (string)$this->config->getAppValue('theming', 'imprintUrl', '');
+		return (string) $this->config->getAppValue('theming', 'imprintUrl', '');
 	}
 
 	public function getPrivacyUrl() {
-		return (string)$this->config->getAppValue('theming', 'privacyUrl', '');
+		return (string) $this->config->getAppValue('theming', 'privacyUrl', '');
 	}
 
 	public function getShortFooter() {
 		$slogan = $this->getSlogan();
 		$baseUrl = $this->getBaseUrl();
 		if ($baseUrl !== '') {
-			$footer = '<a href="' . $baseUrl . '" target="_blank"' .
-				' rel="noreferrer noopener" class="entity-name">' . $this->getEntity() . '</a>';
+			$footer = '<a href="'.$baseUrl.'" target="_blank"'.
+				' rel="noreferrer noopener" class="entity-name">'.$this->getEntity().'</a>';
 		} else {
-			$footer = '<span class="entity-name">' .$this->getEntity() . '</span>';
+			$footer = '<span class="entity-name">'.$this->getEntity().'</span>';
 		}
-		$footer .= ($slogan !== '' ? ' – ' . $slogan : '');
+		$footer .= ($slogan !== '' ? ' – '.$slogan : '');
 
 		$links = [
 			[
 				'text' => $this->l->t('Legal notice'),
-				'url' => (string)$this->getImprintUrl()
+				'url' => (string) $this->getImprintUrl()
 			],
 			[
 				'text' => $this->l->t('Privacy policy'),
-				'url' => (string)$this->getPrivacyUrl()
+				'url' => (string) $this->getPrivacyUrl()
 			],
 		];
 
 		$navigation = $this->navigationManager->getAll(INavigationManager::TYPE_GUEST);
-		$guestNavigation = array_map(function ($nav) {
+		$guestNavigation = array_map(function($nav) {
 			return [
 				'text' => $nav['name'],
 				'url' => $nav['href']
@@ -189,17 +189,17 @@ 
 		$links = array_merge($links, $guestNavigation);
 
 		$legalLinks = ''; $divider = '';
-		foreach($links as $link) {
-			if($link['url'] !== ''
+		foreach ($links as $link) {
+			if ($link['url'] !== ''
 				&& filter_var($link['url'], FILTER_VALIDATE_URL)
 			) {
-				$legalLinks .= $divider . '<a href="' . $link['url'] . '" class="legal" target="_blank"' .
-					' rel="noreferrer noopener">' . $link['text'] . '</a>';
+				$legalLinks .= $divider.'<a href="'.$link['url'].'" class="legal" target="_blank"'.
+					' rel="noreferrer noopener">'.$link['text'].'</a>';
 				$divider = ' · ';
 			}
 		}
-		if($legalLinks !== '') {
-			$footer .= '<br/>' . $legalLinks;
+		if ($legalLinks !== '') {
+			$footer .= '<br/>'.$legalLinks;
 		}
 
 		return $footer;
@@ -232,16 +232,16 @@ 
 
 		$cacheBusterCounter = $this->config->getAppValue('theming', 'cachebuster', '0');
 
-		if(!$logo || !$logoExists) {
-			if($useSvg) {
+		if (!$logo || !$logoExists) {
+			if ($useSvg) {
 				$logo = $this->urlGenerator->imagePath('core', 'logo/logo.svg');
 			} else {
 				$logo = $this->urlGenerator->imagePath('core', 'logo/logo.png');
 			}
-			return $logo . '?v=' . $cacheBusterCounter;
+			return $logo.'?v='.$cacheBusterCounter;
 		}
 
-		return $this->urlGenerator->linkToRoute('theming.Theming.getImage', [ 'key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter ]);
+		return $this->urlGenerator->linkToRoute('theming.Theming.getImage', ['key' => 'logo', 'useSvg' => $useSvg, 'v' => $cacheBusterCounter]);
 	}
 
 	/**
@@ -279,17 +279,17 @@ 
 	 * @return array scss variables to overwrite
 	 */
 	public function getScssVariables() {
-		$cache = $this->cacheFactory->createDistributed('theming-' . $this->urlGenerator->getBaseUrl());
+		$cache = $this->cacheFactory->createDistributed('theming-'.$this->urlGenerator->getBaseUrl());
 		if ($value = $cache->get('getScssVariables')) {
 			return $value;
 		}
 
 		$variables = [
-			'theming-cachebuster' => "'" . $this->config->getAppValue('theming', 'cachebuster', '0') . "'",
-			'theming-logo-mime' => "'" . $this->config->getAppValue('theming', 'logoMime') . "'",
-			'theming-background-mime' => "'" . $this->config->getAppValue('theming', 'backgroundMime') . "'",
-			'theming-logoheader-mime' => "'" . $this->config->getAppValue('theming', 'logoheaderMime') . "'",
-			'theming-favicon-mime' => "'" . $this->config->getAppValue('theming', 'faviconMime') . "'"
+			'theming-cachebuster' => "'".$this->config->getAppValue('theming', 'cachebuster', '0')."'",
+			'theming-logo-mime' => "'".$this->config->getAppValue('theming', 'logoMime')."'",
+			'theming-background-mime' => "'".$this->config->getAppValue('theming', 'backgroundMime')."'",
+			'theming-logoheader-mime' => "'".$this->config->getAppValue('theming', 'logoheaderMime')."'",
+			'theming-favicon-mime' => "'".$this->config->getAppValue('theming', 'faviconMime')."'"
 		];
 
 		$variables['image-logo'] = "url('".$this->imageManager->getImageUrl('logo')."')";
@@ -309,7 +309,7 @@ 
 		}
 
 		$variables['has-legal-links'] = 'false';
-		if($this->getImprintUrl() !== '' || $this->getPrivacyUrl() !== '') {
+		if ($this->getImprintUrl() !== '' || $this->getPrivacyUrl() !== '') {
 			$variables['has-legal-links'] = 'true';
 		}
 
@@ -347,18 +347,18 @@ 
 		if ($image === 'manifest.json') {
 			try {
 				$appPath = $this->appManager->getAppPath($app);
-				if (file_exists($appPath . '/img/manifest.json')) {
+				if (file_exists($appPath.'/img/manifest.json')) {
 					return false;
 				}
 			} catch (AppPathNotFoundException $e) {}
 			$route = $this->urlGenerator->linkToRoute('theming.Theming.getManifest');
 		}
-		if (strpos($image, 'filetypes/') === 0 && file_exists(\OC::$SERVERROOT . '/core/img/' . $image)) {
+		if (strpos($image, 'filetypes/') === 0 && file_exists(\OC::$SERVERROOT.'/core/img/'.$image)) {
 			$route = $this->urlGenerator->linkToRoute('theming.Icon.getThemedIcon', ['app' => $app, 'image' => $image]);
 		}
 
 		if ($route) {
-			return $route . '?v=' . $cacheBusterValue;
+			return $route.'?v='.$cacheBusterValue;
 		}
 
 		return false;
@@ -369,7 +369,7 @@ 
 	 */
 	private function increaseCacheBuster() {
 		$cacheBusterKey = $this->config->getAppValue('theming', 'cachebuster', '0');
-		$this->config->setAppValue('theming', 'cachebuster', (int)$cacheBusterKey+1);
+		$this->config->setAppValue('theming', 'cachebuster', (int) $cacheBusterKey + 1);
 		$this->cacheFactory->createDistributed('theming-')->clear();
 		$this->cacheFactory->createDistributed('imagePath')->clear();
 

apps/theming/appinfo/app.php

Indentation +18 added lines, -18 removed lines

@@ -32,29 +32,29 @@
 $app->getContainer()->registerCapability(\OCA\Theming\Capabilities::class);
 
 $linkToCSS = \OC::$server->getURLGenerator()->linkToRoute(
-	'theming.Theming.getStylesheet',
-	[
-		'v' => \OC::$server->getConfig()->getAppValue('theming', 'cachebuster', '0'),
-	]
+    'theming.Theming.getStylesheet',
+    [
+        'v' => \OC::$server->getConfig()->getAppValue('theming', 'cachebuster', '0'),
+    ]
 );
 \OCP\Util::addHeader(
-	'link',
-	[
-		'rel' => 'stylesheet',
-		'href' => $linkToCSS,
-	]
+    'link',
+    [
+        'rel' => 'stylesheet',
+        'href' => $linkToCSS,
+    ]
 );
 
 $linkToJs = \OC::$server->getURLGenerator()->linkToRoute(
-	'theming.Theming.getJavascript',
-	[
-		'v' => \OC::$server->getConfig()->getAppValue('theming', 'cachebuster', '0'),
-	]
+    'theming.Theming.getJavascript',
+    [
+        'v' => \OC::$server->getConfig()->getAppValue('theming', 'cachebuster', '0'),
+    ]
 );
 \OCP\Util::addHeader(
-	'script',
-	[
-		'src' => $linkToJs,
-		'nonce' => \OC::$server->getContentSecurityPolicyNonceManager()->getNonce()
-	], ''
+    'script',
+    [
+        'src' => $linkToJs,
+        'nonce' => \OC::$server->getContentSecurityPolicyNonceManager()->getNonce()
+    ], ''
 );

apps/files_versions/lib/Storage.php

Indentation +796 added lines, -796 removed lines

@@ -58,801 +58,801 @@
 
 class Storage {
 
-	const DEFAULTENABLED=true;
-	const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
-	const VERSIONS_ROOT = 'files_versions/';
-
-	const DELETE_TRIGGER_MASTER_REMOVED = 0;
-	const DELETE_TRIGGER_RETENTION_CONSTRAINT = 1;
-	const DELETE_TRIGGER_QUOTA_EXCEEDED = 2;
-
-	// files for which we can remove the versions after the delete operation was successful
-	private static $deletedFiles = [];
-
-	private static $sourcePathAndUser = [];
-
-	private static $max_versions_per_interval = [
-		//first 10sec, one version every 2sec
-		1 => ['intervalEndsAfter' => 10,      'step' => 2],
-		//next minute, one version every 10sec
-		2 => ['intervalEndsAfter' => 60,      'step' => 10],
-		//next hour, one version every minute
-		3 => ['intervalEndsAfter' => 3600,    'step' => 60],
-		//next 24h, one version every hour
-		4 => ['intervalEndsAfter' => 86400,   'step' => 3600],
-		//next 30days, one version per day
-		5 => ['intervalEndsAfter' => 2592000, 'step' => 86400],
-		//until the end one version per week
-		6 => ['intervalEndsAfter' => -1,      'step' => 604800],
-	];
-
-	/** @var \OCA\Files_Versions\AppInfo\Application */
-	private static $application;
-
-	/**
-	 * get the UID of the owner of the file and the path to the file relative to
-	 * owners files folder
-	 *
-	 * @param string $filename
-	 * @return array
-	 * @throws \OC\User\NoUserException
-	 */
-	public static function getUidAndFilename($filename) {
-		$uid = Filesystem::getOwner($filename);
-		$userManager = \OC::$server->getUserManager();
-		// if the user with the UID doesn't exists, e.g. because the UID points
-		// to a remote user with a federated cloud ID we use the current logged-in
-		// user. We need a valid local user to create the versions
-		if (!$userManager->userExists($uid)) {
-			$uid = User::getUser();
-		}
-		Filesystem::initMountPoints($uid);
-		if ($uid !== User::getUser()) {
-			$info = Filesystem::getFileInfo($filename);
-			$ownerView = new View('/'.$uid.'/files');
-			try {
-				$filename = $ownerView->getPath($info['fileid']);
-				// make sure that the file name doesn't end with a trailing slash
-				// can for example happen single files shared across servers
-				$filename = rtrim($filename, '/');
-			} catch (NotFoundException $e) {
-				$filename = null;
-			}
-		}
-		return [$uid, $filename];
-	}
-
-	/**
-	 * Remember the owner and the owner path of the source file
-	 *
-	 * @param string $source source path
-	 */
-	public static function setSourcePathAndUser($source) {
-		list($uid, $path) = self::getUidAndFilename($source);
-		self::$sourcePathAndUser[$source] = ['uid' => $uid, 'path' => $path];
-	}
-
-	/**
-	 * Gets the owner and the owner path from the source path
-	 *
-	 * @param string $source source path
-	 * @return array with user id and path
-	 */
-	public static function getSourcePathAndUser($source) {
-
-		if (isset(self::$sourcePathAndUser[$source])) {
-			$uid = self::$sourcePathAndUser[$source]['uid'];
-			$path = self::$sourcePathAndUser[$source]['path'];
-			unset(self::$sourcePathAndUser[$source]);
-		} else {
-			$uid = $path = false;
-		}
-		return [$uid, $path];
-	}
-
-	/**
-	 * get current size of all versions from a given user
-	 *
-	 * @param string $user user who owns the versions
-	 * @return int versions size
-	 */
-	private static function getVersionsSize($user) {
-		$view = new View('/' . $user);
-		$fileInfo = $view->getFileInfo('/files_versions');
-		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
-	}
-
-	/**
-	 * store a new version of a file.
-	 */
-	public static function store($filename) {
-
-		// if the file gets streamed we need to remove the .part extension
-		// to get the right target
-		$ext = pathinfo($filename, PATHINFO_EXTENSION);
-		if ($ext === 'part') {
-			$filename = substr($filename, 0, -5);
-		}
-
-		// we only handle existing files
-		if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
-			return false;
-		}
-
-		list($uid, $filename) = self::getUidAndFilename($filename);
-
-		$files_view = new View('/'.$uid .'/files');
-
-		$eventDispatcher = \OC::$server->getEventDispatcher();
-		$fileInfo = $files_view->getFileInfo($filename);
-		$id = $fileInfo->getId();
-		$nodes = \OC::$server->getRootFolder()->getUserFolder($uid)->getById($id);
-		foreach ($nodes as $node) {
-			$event = new CreateVersionEvent($node);
-			$eventDispatcher->dispatch('OCA\Files_Versions::createVersion', $event);
-			if ($event->shouldCreateVersion() === false) {
-				return false;
-			}
-		}
-
-		// no use making versions for empty files
-		if ($fileInfo->getSize() === 0) {
-			return false;
-		}
-
-		/** @var IVersionManager $versionManager */
-		$versionManager = \OC::$server->query(IVersionManager::class);
-		$userManager = \OC::$server->getUserManager();
-		$user = $userManager->get($uid);
-
-		$versionManager->createVersion($user, $fileInfo);
-	}
-
-
-	/**
-	 * mark file as deleted so that we can remove the versions if the file is gone
-	 * @param string $path
-	 */
-	public static function markDeletedFile($path) {
-		list($uid, $filename) = self::getUidAndFilename($path);
-		self::$deletedFiles[$path] = [
-			'uid' => $uid,
-			'filename' => $filename];
-	}
-
-	/**
-	 * delete the version from the storage and cache
-	 *
-	 * @param View $view
-	 * @param string $path
-	 */
-	protected static function deleteVersion($view, $path) {
-		$view->unlink($path);
-		/**
-		 * @var \OC\Files\Storage\Storage $storage
-		 * @var string $internalPath
-		 */
-		list($storage, $internalPath) = $view->resolvePath($path);
-		$cache = $storage->getCache($internalPath);
-		$cache->remove($internalPath);
-	}
-
-	/**
-	 * Delete versions of a file
-	 */
-	public static function delete($path) {
-
-		$deletedFile = self::$deletedFiles[$path];
-		$uid = $deletedFile['uid'];
-		$filename = $deletedFile['filename'];
-
-		if (!Filesystem::file_exists($path)) {
-
-			$view = new View('/' . $uid . '/files_versions');
-
-			$versions = self::getVersions($uid, $filename);
-			if (!empty($versions)) {
-				foreach ($versions as $v) {
-					\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED]);
-					self::deleteVersion($view, $filename . '.v' . $v['version']);
-					\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED]);
-				}
-			}
-		}
-		unset(self::$deletedFiles[$path]);
-	}
-
-	/**
-	 * Rename or copy versions of a file of the given paths
-	 *
-	 * @param string $sourcePath source path of the file to move, relative to
-	 * the currently logged in user's "files" folder
-	 * @param string $targetPath target path of the file to move, relative to
-	 * the currently logged in user's "files" folder
-	 * @param string $operation can be 'copy' or 'rename'
-	 */
-	public static function renameOrCopy($sourcePath, $targetPath, $operation) {
-		list($sourceOwner, $sourcePath) = self::getSourcePathAndUser($sourcePath);
-
-		// it was a upload of a existing file if no old path exists
-		// in this case the pre-hook already called the store method and we can
-		// stop here
-		if ($sourcePath === false) {
-			return true;
-		}
-
-		list($targetOwner, $targetPath) = self::getUidAndFilename($targetPath);
-
-		$sourcePath = ltrim($sourcePath, '/');
-		$targetPath = ltrim($targetPath, '/');
-
-		$rootView = new View('');
-
-		// did we move a directory ?
-		if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
-			// does the directory exists for versions too ?
-			if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
-				// create missing dirs if necessary
-				self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
-
-				// move the directory containing the versions
-				$rootView->$operation(
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath,
-					'/' . $targetOwner . '/files_versions/' . $targetPath
-				);
-			}
-		} else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
-			// create missing dirs if necessary
-			self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
-
-			foreach ($versions as $v) {
-				// move each version one by one to the target directory
-				$rootView->$operation(
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
-					'/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
-				);
-			}
-		}
-
-		// if we moved versions directly for a file, schedule expiration check for that file
-		if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
-			self::scheduleExpire($targetOwner, $targetPath);
-		}
-
-	}
-
-	/**
-	 * Rollback to an old version of a file.
-	 *
-	 * @param string $file file name
-	 * @param int $revision revision timestamp
-	 * @return bool
-	 */
-	public static function rollback(string $file, int $revision, IUser $user) {
-
-		// add expected leading slash
-		$filename = '/' . ltrim($file, '/');
-
-		// Fetch the userfolder to trigger view hooks
-		$userFolder = \OC::$server->getUserFolder($user->getUID());
-
-		$users_view = new View('/'.$user->getUID());
-		$files_view = new View('/'. $user->getUID().'/files');
-
-		$versionCreated = false;
-
-		$fileInfo = $files_view->getFileInfo($file);
-
-		// check if user has the permissions to revert a version
-		if (!$fileInfo->isUpdateable()) {
-			return false;
-		}
-
-		//first create a new version
-		$version = 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename);
-		if (!$users_view->file_exists($version)) {
-			$users_view->copy('files'.$filename, 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename));
-			$versionCreated = true;
-		}
-
-		$fileToRestore =  'files_versions' . $filename . '.v' . $revision;
-
-		// Restore encrypted version of the old file for the newly restored file
-		// This has to happen manually here since the file is manually copied below
-		$oldVersion = $users_view->getFileInfo($fileToRestore)->getEncryptedVersion();
-		$oldFileInfo = $users_view->getFileInfo($fileToRestore);
-		$cache = $fileInfo->getStorage()->getCache();
-		$cache->update(
-			$fileInfo->getId(), [
-				'encrypted' => $oldVersion,
-				'encryptedVersion' => $oldVersion,
-				'size' => $oldFileInfo->getSize()
-			]
-		);
-
-		// rollback
-		if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
-			$files_view->touch($file, $revision);
-			Storage::scheduleExpire($user->getUID(), $file);
-
-			$node = $userFolder->get($file);
-
-			// TODO: move away from those legacy hooks!
-			\OC_Hook::emit('\OCP\Versions', 'rollback', [
-				'path' => $filename,
-				'revision' => $revision,
-				'node' => $node,
-			]);
-			return true;
-		} else if ($versionCreated) {
-			self::deleteVersion($users_view, $version);
-		}
-
-		return false;
-
-	}
-
-	/**
-	 * Stream copy file contents from $path1 to $path2
-	 *
-	 * @param View $view view to use for copying
-	 * @param string $path1 source file to copy
-	 * @param string $path2 target file
-	 *
-	 * @return bool true for success, false otherwise
-	 */
-	private static function copyFileContents($view, $path1, $path2) {
-		/** @var \OC\Files\Storage\Storage $storage1 */
-		list($storage1, $internalPath1) = $view->resolvePath($path1);
-		/** @var \OC\Files\Storage\Storage $storage2 */
-		list($storage2, $internalPath2) = $view->resolvePath($path2);
-
-		$view->lockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
-		$view->lockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
-
-		// TODO add a proper way of overwriting a file while maintaining file ids
-		if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
-			$source = $storage1->fopen($internalPath1, 'r');
-			$target = $storage2->fopen($internalPath2, 'w');
-			list(, $result) = \OC_Helper::streamCopy($source, $target);
-			fclose($source);
-			fclose($target);
-
-			if ($result !== false) {
-				$storage1->unlink($internalPath1);
-			}
-		} else {
-			$result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
-		}
-
-		$view->unlockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
-		$view->unlockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
-
-		return ($result !== false);
-	}
-
-	/**
-	 * get a list of all available versions of a file in descending chronological order
-	 * @param string $uid user id from the owner of the file
-	 * @param string $filename file to find versions of, relative to the user files dir
-	 * @param string $userFullPath
-	 * @return array versions newest version first
-	 */
-	public static function getVersions($uid, $filename, $userFullPath = '') {
-		$versions = [];
-		if (empty($filename)) {
-			return $versions;
-		}
-		// fetch for old versions
-		$view = new View('/' . $uid . '/');
-
-		$pathinfo = pathinfo($filename);
-		$versionedFile = $pathinfo['basename'];
-
-		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
-
-		$dirContent = false;
-		if ($view->is_dir($dir)) {
-			$dirContent = $view->opendir($dir);
-		}
-
-		if ($dirContent === false) {
-			return $versions;
-		}
-
-		if (is_resource($dirContent)) {
-			while (($entryName = readdir($dirContent)) !== false) {
-				if (!Filesystem::isIgnoredDir($entryName)) {
-					$pathparts = pathinfo($entryName);
-					$filename = $pathparts['filename'];
-					if ($filename === $versionedFile) {
-						$pathparts = pathinfo($entryName);
-						$timestamp = substr($pathparts['extension'], 1);
-						$filename = $pathparts['filename'];
-						$key = $timestamp . '#' . $filename;
-						$versions[$key]['version'] = $timestamp;
-						$versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
-						if (empty($userFullPath)) {
-							$versions[$key]['preview'] = '';
-						} else {
-							$versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
-						}
-						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
-						$versions[$key]['name'] = $versionedFile;
-						$versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
-						$versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
-					}
-				}
-			}
-			closedir($dirContent);
-		}
-
-		// sort with newest version first
-		krsort($versions);
-
-		return $versions;
-	}
-
-	/**
-	 * Expire versions that older than max version retention time
-	 * @param string $uid
-	 */
-	public static function expireOlderThanMaxForUser($uid) {
-		$expiration = self::getExpiration();
-		$threshold = $expiration->getMaxAgeAsTimestamp();
-		$versions = self::getAllVersions($uid);
-		if (!$threshold || !array_key_exists('all', $versions)) {
-			return;
-		}
-
-		$toDelete = [];
-		foreach (array_reverse($versions['all']) as $key => $version) {
-			if ((int)$version['version'] <$threshold) {
-				$toDelete[$key] = $version;
-			} else {
-				//Versions are sorted by time - nothing mo to iterate.
-				break;
-			}
-		}
-
-		$view = new View('/' . $uid . '/files_versions');
-		if (!empty($toDelete)) {
-			foreach ($toDelete as $version) {
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT]);
-				self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
-				\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT]);
-			}
-		}
-	}
-
-	/**
-	 * translate a timestamp into a string like "5 days ago"
-	 * @param int $timestamp
-	 * @return string for example "5 days ago"
-	 */
-	private static function getHumanReadableTimestamp($timestamp) {
-
-		$diff = time() - $timestamp;
-
-		if ($diff < 60) { // first minute
-			return  $diff . " seconds ago";
-		} elseif ($diff < 3600) { //first hour
-			return round($diff / 60) . " minutes ago";
-		} elseif ($diff < 86400) { // first day
-			return round($diff / 3600) . " hours ago";
-		} elseif ($diff < 604800) { //first week
-			return round($diff / 86400) . " days ago";
-		} elseif ($diff < 2419200) { //first month
-			return round($diff / 604800) . " weeks ago";
-		} elseif ($diff < 29030400) { // first year
-			return round($diff / 2419200) . " months ago";
-		} else {
-			return round($diff / 29030400) . " years ago";
-		}
-
-	}
-
-	/**
-	 * returns all stored file versions from a given user
-	 * @param string $uid id of the user
-	 * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
-	 */
-	private static function getAllVersions($uid) {
-		$view = new View('/' . $uid . '/');
-		$dirs = [self::VERSIONS_ROOT];
-		$versions = [];
-
-		while (!empty($dirs)) {
-			$dir = array_pop($dirs);
-			$files = $view->getDirectoryContent($dir);
-
-			foreach ($files as $file) {
-				$fileData = $file->getData();
-				$filePath = $dir . '/' . $fileData['name'];
-				if ($file['type'] === 'dir') {
-					$dirs[] = $filePath;
-				} else {
-					$versionsBegin = strrpos($filePath, '.v');
-					$relPathStart = strlen(self::VERSIONS_ROOT);
-					$version = substr($filePath, $versionsBegin + 2);
-					$relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
-					$key = $version . '#' . $relpath;
-					$versions[$key] = ['path' => $relpath, 'timestamp' => $version];
-				}
-			}
-		}
-
-		// newest version first
-		krsort($versions);
-
-		$result = [];
-
-		foreach ($versions as $key => $value) {
-			$size = $view->filesize(self::VERSIONS_ROOT.'/'.$value['path'].'.v'.$value['timestamp']);
-			$filename = $value['path'];
-
-			$result['all'][$key]['version'] = $value['timestamp'];
-			$result['all'][$key]['path'] = $filename;
-			$result['all'][$key]['size'] = $size;
-
-			$result['by_file'][$filename][$key]['version'] = $value['timestamp'];
-			$result['by_file'][$filename][$key]['path'] = $filename;
-			$result['by_file'][$filename][$key]['size'] = $size;
-		}
-
-		return $result;
-	}
-
-	/**
-	 * get list of files we want to expire
-	 * @param array $versions list of versions
-	 * @param integer $time
-	 * @param bool $quotaExceeded is versions storage limit reached
-	 * @return array containing the list of to deleted versions and the size of them
-	 */
-	protected static function getExpireList($time, $versions, $quotaExceeded = false) {
-		$expiration = self::getExpiration();
-
-		if ($expiration->shouldAutoExpire()) {
-			list($toDelete, $size) = self::getAutoExpireList($time, $versions);
-		} else {
-			$size = 0;
-			$toDelete = [];  // versions we want to delete
-		}
-
-		foreach ($versions as $key => $version) {
-			if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
-				$size += $version['size'];
-				$toDelete[$key] = $version['path'] . '.v' . $version['version'];
-			}
-		}
-
-		return [$toDelete, $size];
-	}
-
-	/**
-	 * get list of files we want to expire
-	 * @param array $versions list of versions
-	 * @param integer $time
-	 * @return array containing the list of to deleted versions and the size of them
-	 */
-	protected static function getAutoExpireList($time, $versions) {
-		$size = 0;
-		$toDelete = [];  // versions we want to delete
-
-		$interval = 1;
-		$step = Storage::$max_versions_per_interval[$interval]['step'];
-		if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
-			$nextInterval = -1;
-		} else {
-			$nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
-		}
-
-		$firstVersion = reset($versions);
-		$firstKey = key($versions);
-		$prevTimestamp = $firstVersion['version'];
-		$nextVersion = $firstVersion['version'] - $step;
-		unset($versions[$firstKey]);
-
-		foreach ($versions as $key => $version) {
-			$newInterval = true;
-			while ($newInterval) {
-				if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
-					if ($version['version'] > $nextVersion) {
-						//distance between two version too small, mark to delete
-						$toDelete[$key] = $version['path'] . '.v' . $version['version'];
-						$size += $version['size'];
-						\OC::$server->getLogger()->info('Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, ['app' => 'files_versions']);
-					} else {
-						$nextVersion = $version['version'] - $step;
-						$prevTimestamp = $version['version'];
-					}
-					$newInterval = false; // version checked so we can move to the next one
-				} else { // time to move on to the next interval
-					$interval++;
-					$step = Storage::$max_versions_per_interval[$interval]['step'];
-					$nextVersion = $prevTimestamp - $step;
-					if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
-						$nextInterval = -1;
-					} else {
-						$nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
-					}
-					$newInterval = true; // we changed the interval -> check same version with new interval
-				}
-			}
-		}
-
-		return [$toDelete, $size];
-	}
-
-	/**
-	 * Schedule versions expiration for the given file
-	 *
-	 * @param string $uid owner of the file
-	 * @param string $fileName file/folder for which to schedule expiration
-	 */
-	public static function scheduleExpire($uid, $fileName) {
-		// let the admin disable auto expire
-		$expiration = self::getExpiration();
-		if ($expiration->isEnabled()) {
-			$command = new Expire($uid, $fileName);
-			\OC::$server->getCommandBus()->push($command);
-		}
-	}
-
-	/**
-	 * Expire versions which exceed the quota.
-	 *
-	 * This will setup the filesystem for the given user but will not
-	 * tear it down afterwards.
-	 *
-	 * @param string $filename path to file to expire
-	 * @param string $uid user for which to expire the version
-	 * @return bool|int|null
-	 */
-	public static function expire($filename, $uid) {
-		$expiration = self::getExpiration();
-
-		if ($expiration->isEnabled()) {
-			// get available disk space for user
-			$user = \OC::$server->getUserManager()->get($uid);
-			if (is_null($user)) {
-				\OC::$server->getLogger()->error('Backends provided no user object for ' . $uid, ['app' => 'files_versions']);
-				throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
-			}
-
-			\OC_Util::setupFS($uid);
-
-			if (!Filesystem::file_exists($filename)) {
-				return false;
-			}
-
-			if (empty($filename)) {
-				// file maybe renamed or deleted
-				return false;
-			}
-			$versionsFileview = new View('/'.$uid.'/files_versions');
-
-			$softQuota = true;
-			$quota = $user->getQuota();
-			if ($quota === null || $quota === 'none') {
-				$quota = Filesystem::free_space('/');
-				$softQuota = false;
-			} else {
-				$quota = \OCP\Util::computerFileSize($quota);
-			}
-
-			// make sure that we have the current size of the version history
-			$versionsSize = self::getVersionsSize($uid);
-
-			// calculate available space for version history
-			// subtract size of files and current versions size from quota
-			if ($quota >= 0) {
-				if ($softQuota) {
-					$userFolder = \OC::$server->getUserFolder($uid);
-					if(is_null($userFolder)) {
-						$availableSpace = 0;
-					} else {
-						$free = $quota - $userFolder->getSize(false); // remaining free space for user
-						if ($free > 0) {
-							$availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $versionsSize; // how much space can be used for versions
-						} else {
-							$availableSpace = $free - $versionsSize;
-						}
-					}
-				} else {
-					$availableSpace = $quota;
-				}
-			} else {
-				$availableSpace = PHP_INT_MAX;
-			}
-
-			$allVersions = Storage::getVersions($uid, $filename);
-
-			$time = time();
-			list($toDelete, $sizeOfDeletedVersions) = self::getExpireList($time, $allVersions, $availableSpace <= 0);
-
-			$availableSpace = $availableSpace + $sizeOfDeletedVersions;
-			$versionsSize = $versionsSize - $sizeOfDeletedVersions;
-
-			// if still not enough free space we rearrange the versions from all files
-			if ($availableSpace <= 0) {
-				$result = Storage::getAllVersions($uid);
-				$allVersions = $result['all'];
-
-				foreach ($result['by_file'] as $versions) {
-					list($toDeleteNew, $size) = self::getExpireList($time, $versions, $availableSpace <= 0);
-					$toDelete = array_merge($toDelete, $toDeleteNew);
-					$sizeOfDeletedVersions += $size;
-				}
-				$availableSpace = $availableSpace + $sizeOfDeletedVersions;
-				$versionsSize = $versionsSize - $sizeOfDeletedVersions;
-			}
-
-			$logger = \OC::$server->getLogger();
-			foreach($toDelete as $key => $path) {
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
-				self::deleteVersion($versionsFileview, $path);
-				\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
-				unset($allVersions[$key]); // update array with the versions we keep
-				$logger->info('Expire: ' . $path, ['app' => 'files_versions']);
-			}
-
-			// Check if enough space is available after versions are rearranged.
-			// If not we delete the oldest versions until we meet the size limit for versions,
-			// but always keep the two latest versions
-			$numOfVersions = count($allVersions) -2 ;
-			$i = 0;
-			// sort oldest first and make sure that we start at the first element
-			ksort($allVersions);
-			reset($allVersions);
-			while ($availableSpace < 0 && $i < $numOfVersions) {
-				$version = current($allVersions);
-				\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
-				self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
-				\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
-				\OC::$server->getLogger()->info('running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'], ['app' => 'files_versions']);
-				$versionsSize -= $version['size'];
-				$availableSpace += $version['size'];
-				next($allVersions);
-				$i++;
-			}
-
-			return $versionsSize; // finally return the new size of the version history
-		}
-
-		return false;
-	}
-
-	/**
-	 * Create recursively missing directories inside of files_versions
-	 * that match the given path to a file.
-	 *
-	 * @param string $filename $path to a file, relative to the user's
-	 * "files" folder
-	 * @param View $view view on data/user/
-	 */
-	public static function createMissingDirectories($filename, $view) {
-		$dirname = Filesystem::normalizePath(dirname($filename));
-		$dirParts = explode('/', $dirname);
-		$dir = "/files_versions";
-		foreach ($dirParts as $part) {
-			$dir = $dir . '/' . $part;
-			if (!$view->file_exists($dir)) {
-				$view->mkdir($dir);
-			}
-		}
-	}
-
-	/**
-	 * Static workaround
-	 * @return Expiration
-	 */
-	protected static function getExpiration() {
-		if (self::$application === null) {
-			self::$application = \OC::$server->query(Application::class);
-		}
-		return self::$application->getContainer()->query(Expiration::class);
-	}
+    const DEFAULTENABLED=true;
+    const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
+    const VERSIONS_ROOT = 'files_versions/';
+
+    const DELETE_TRIGGER_MASTER_REMOVED = 0;
+    const DELETE_TRIGGER_RETENTION_CONSTRAINT = 1;
+    const DELETE_TRIGGER_QUOTA_EXCEEDED = 2;
+
+    // files for which we can remove the versions after the delete operation was successful
+    private static $deletedFiles = [];
+
+    private static $sourcePathAndUser = [];
+
+    private static $max_versions_per_interval = [
+        //first 10sec, one version every 2sec
+        1 => ['intervalEndsAfter' => 10,      'step' => 2],
+        //next minute, one version every 10sec
+        2 => ['intervalEndsAfter' => 60,      'step' => 10],
+        //next hour, one version every minute
+        3 => ['intervalEndsAfter' => 3600,    'step' => 60],
+        //next 24h, one version every hour
+        4 => ['intervalEndsAfter' => 86400,   'step' => 3600],
+        //next 30days, one version per day
+        5 => ['intervalEndsAfter' => 2592000, 'step' => 86400],
+        //until the end one version per week
+        6 => ['intervalEndsAfter' => -1,      'step' => 604800],
+    ];
+
+    /** @var \OCA\Files_Versions\AppInfo\Application */
+    private static $application;
+
+    /**
+     * get the UID of the owner of the file and the path to the file relative to
+     * owners files folder
+     *
+     * @param string $filename
+     * @return array
+     * @throws \OC\User\NoUserException
+     */
+    public static function getUidAndFilename($filename) {
+        $uid = Filesystem::getOwner($filename);
+        $userManager = \OC::$server->getUserManager();
+        // if the user with the UID doesn't exists, e.g. because the UID points
+        // to a remote user with a federated cloud ID we use the current logged-in
+        // user. We need a valid local user to create the versions
+        if (!$userManager->userExists($uid)) {
+            $uid = User::getUser();
+        }
+        Filesystem::initMountPoints($uid);
+        if ($uid !== User::getUser()) {
+            $info = Filesystem::getFileInfo($filename);
+            $ownerView = new View('/'.$uid.'/files');
+            try {
+                $filename = $ownerView->getPath($info['fileid']);
+                // make sure that the file name doesn't end with a trailing slash
+                // can for example happen single files shared across servers
+                $filename = rtrim($filename, '/');
+            } catch (NotFoundException $e) {
+                $filename = null;
+            }
+        }
+        return [$uid, $filename];
+    }
+
+    /**
+     * Remember the owner and the owner path of the source file
+     *
+     * @param string $source source path
+     */
+    public static function setSourcePathAndUser($source) {
+        list($uid, $path) = self::getUidAndFilename($source);
+        self::$sourcePathAndUser[$source] = ['uid' => $uid, 'path' => $path];
+    }
+
+    /**
+     * Gets the owner and the owner path from the source path
+     *
+     * @param string $source source path
+     * @return array with user id and path
+     */
+    public static function getSourcePathAndUser($source) {
+
+        if (isset(self::$sourcePathAndUser[$source])) {
+            $uid = self::$sourcePathAndUser[$source]['uid'];
+            $path = self::$sourcePathAndUser[$source]['path'];
+            unset(self::$sourcePathAndUser[$source]);
+        } else {
+            $uid = $path = false;
+        }
+        return [$uid, $path];
+    }
+
+    /**
+     * get current size of all versions from a given user
+     *
+     * @param string $user user who owns the versions
+     * @return int versions size
+     */
+    private static function getVersionsSize($user) {
+        $view = new View('/' . $user);
+        $fileInfo = $view->getFileInfo('/files_versions');
+        return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
+    }
+
+    /**
+     * store a new version of a file.
+     */
+    public static function store($filename) {
+
+        // if the file gets streamed we need to remove the .part extension
+        // to get the right target
+        $ext = pathinfo($filename, PATHINFO_EXTENSION);
+        if ($ext === 'part') {
+            $filename = substr($filename, 0, -5);
+        }
+
+        // we only handle existing files
+        if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
+            return false;
+        }
+
+        list($uid, $filename) = self::getUidAndFilename($filename);
+
+        $files_view = new View('/'.$uid .'/files');
+
+        $eventDispatcher = \OC::$server->getEventDispatcher();
+        $fileInfo = $files_view->getFileInfo($filename);
+        $id = $fileInfo->getId();
+        $nodes = \OC::$server->getRootFolder()->getUserFolder($uid)->getById($id);
+        foreach ($nodes as $node) {
+            $event = new CreateVersionEvent($node);
+            $eventDispatcher->dispatch('OCA\Files_Versions::createVersion', $event);
+            if ($event->shouldCreateVersion() === false) {
+                return false;
+            }
+        }
+
+        // no use making versions for empty files
+        if ($fileInfo->getSize() === 0) {
+            return false;
+        }
+
+        /** @var IVersionManager $versionManager */
+        $versionManager = \OC::$server->query(IVersionManager::class);
+        $userManager = \OC::$server->getUserManager();
+        $user = $userManager->get($uid);
+
+        $versionManager->createVersion($user, $fileInfo);
+    }
+
+
+    /**
+     * mark file as deleted so that we can remove the versions if the file is gone
+     * @param string $path
+     */
+    public static function markDeletedFile($path) {
+        list($uid, $filename) = self::getUidAndFilename($path);
+        self::$deletedFiles[$path] = [
+            'uid' => $uid,
+            'filename' => $filename];
+    }
+
+    /**
+     * delete the version from the storage and cache
+     *
+     * @param View $view
+     * @param string $path
+     */
+    protected static function deleteVersion($view, $path) {
+        $view->unlink($path);
+        /**
+         * @var \OC\Files\Storage\Storage $storage
+         * @var string $internalPath
+         */
+        list($storage, $internalPath) = $view->resolvePath($path);
+        $cache = $storage->getCache($internalPath);
+        $cache->remove($internalPath);
+    }
+
+    /**
+     * Delete versions of a file
+     */
+    public static function delete($path) {
+
+        $deletedFile = self::$deletedFiles[$path];
+        $uid = $deletedFile['uid'];
+        $filename = $deletedFile['filename'];
+
+        if (!Filesystem::file_exists($path)) {
+
+            $view = new View('/' . $uid . '/files_versions');
+
+            $versions = self::getVersions($uid, $filename);
+            if (!empty($versions)) {
+                foreach ($versions as $v) {
+                    \OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED]);
+                    self::deleteVersion($view, $filename . '.v' . $v['version']);
+                    \OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED]);
+                }
+            }
+        }
+        unset(self::$deletedFiles[$path]);
+    }
+
+    /**
+     * Rename or copy versions of a file of the given paths
+     *
+     * @param string $sourcePath source path of the file to move, relative to
+     * the currently logged in user's "files" folder
+     * @param string $targetPath target path of the file to move, relative to
+     * the currently logged in user's "files" folder
+     * @param string $operation can be 'copy' or 'rename'
+     */
+    public static function renameOrCopy($sourcePath, $targetPath, $operation) {
+        list($sourceOwner, $sourcePath) = self::getSourcePathAndUser($sourcePath);
+
+        // it was a upload of a existing file if no old path exists
+        // in this case the pre-hook already called the store method and we can
+        // stop here
+        if ($sourcePath === false) {
+            return true;
+        }
+
+        list($targetOwner, $targetPath) = self::getUidAndFilename($targetPath);
+
+        $sourcePath = ltrim($sourcePath, '/');
+        $targetPath = ltrim($targetPath, '/');
+
+        $rootView = new View('');
+
+        // did we move a directory ?
+        if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
+            // does the directory exists for versions too ?
+            if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
+                // create missing dirs if necessary
+                self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
+
+                // move the directory containing the versions
+                $rootView->$operation(
+                    '/' . $sourceOwner . '/files_versions/' . $sourcePath,
+                    '/' . $targetOwner . '/files_versions/' . $targetPath
+                );
+            }
+        } else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
+            // create missing dirs if necessary
+            self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
+
+            foreach ($versions as $v) {
+                // move each version one by one to the target directory
+                $rootView->$operation(
+                    '/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
+                    '/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
+                );
+            }
+        }
+
+        // if we moved versions directly for a file, schedule expiration check for that file
+        if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
+            self::scheduleExpire($targetOwner, $targetPath);
+        }
+
+    }
+
+    /**
+     * Rollback to an old version of a file.
+     *
+     * @param string $file file name
+     * @param int $revision revision timestamp
+     * @return bool
+     */
+    public static function rollback(string $file, int $revision, IUser $user) {
+
+        // add expected leading slash
+        $filename = '/' . ltrim($file, '/');
+
+        // Fetch the userfolder to trigger view hooks
+        $userFolder = \OC::$server->getUserFolder($user->getUID());
+
+        $users_view = new View('/'.$user->getUID());
+        $files_view = new View('/'. $user->getUID().'/files');
+
+        $versionCreated = false;
+
+        $fileInfo = $files_view->getFileInfo($file);
+
+        // check if user has the permissions to revert a version
+        if (!$fileInfo->isUpdateable()) {
+            return false;
+        }
+
+        //first create a new version
+        $version = 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename);
+        if (!$users_view->file_exists($version)) {
+            $users_view->copy('files'.$filename, 'files_versions'.$filename.'.v'.$users_view->filemtime('files'.$filename));
+            $versionCreated = true;
+        }
+
+        $fileToRestore =  'files_versions' . $filename . '.v' . $revision;
+
+        // Restore encrypted version of the old file for the newly restored file
+        // This has to happen manually here since the file is manually copied below
+        $oldVersion = $users_view->getFileInfo($fileToRestore)->getEncryptedVersion();
+        $oldFileInfo = $users_view->getFileInfo($fileToRestore);
+        $cache = $fileInfo->getStorage()->getCache();
+        $cache->update(
+            $fileInfo->getId(), [
+                'encrypted' => $oldVersion,
+                'encryptedVersion' => $oldVersion,
+                'size' => $oldFileInfo->getSize()
+            ]
+        );
+
+        // rollback
+        if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
+            $files_view->touch($file, $revision);
+            Storage::scheduleExpire($user->getUID(), $file);
+
+            $node = $userFolder->get($file);
+
+            // TODO: move away from those legacy hooks!
+            \OC_Hook::emit('\OCP\Versions', 'rollback', [
+                'path' => $filename,
+                'revision' => $revision,
+                'node' => $node,
+            ]);
+            return true;
+        } else if ($versionCreated) {
+            self::deleteVersion($users_view, $version);
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Stream copy file contents from $path1 to $path2
+     *
+     * @param View $view view to use for copying
+     * @param string $path1 source file to copy
+     * @param string $path2 target file
+     *
+     * @return bool true for success, false otherwise
+     */
+    private static function copyFileContents($view, $path1, $path2) {
+        /** @var \OC\Files\Storage\Storage $storage1 */
+        list($storage1, $internalPath1) = $view->resolvePath($path1);
+        /** @var \OC\Files\Storage\Storage $storage2 */
+        list($storage2, $internalPath2) = $view->resolvePath($path2);
+
+        $view->lockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
+        $view->lockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
+
+        // TODO add a proper way of overwriting a file while maintaining file ids
+        if ($storage1->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage') || $storage2->instanceOfStorage('\OC\Files\ObjectStore\ObjectStoreStorage')) {
+            $source = $storage1->fopen($internalPath1, 'r');
+            $target = $storage2->fopen($internalPath2, 'w');
+            list(, $result) = \OC_Helper::streamCopy($source, $target);
+            fclose($source);
+            fclose($target);
+
+            if ($result !== false) {
+                $storage1->unlink($internalPath1);
+            }
+        } else {
+            $result = $storage2->moveFromStorage($storage1, $internalPath1, $internalPath2);
+        }
+
+        $view->unlockFile($path1, ILockingProvider::LOCK_EXCLUSIVE);
+        $view->unlockFile($path2, ILockingProvider::LOCK_EXCLUSIVE);
+
+        return ($result !== false);
+    }
+
+    /**
+     * get a list of all available versions of a file in descending chronological order
+     * @param string $uid user id from the owner of the file
+     * @param string $filename file to find versions of, relative to the user files dir
+     * @param string $userFullPath
+     * @return array versions newest version first
+     */
+    public static function getVersions($uid, $filename, $userFullPath = '') {
+        $versions = [];
+        if (empty($filename)) {
+            return $versions;
+        }
+        // fetch for old versions
+        $view = new View('/' . $uid . '/');
+
+        $pathinfo = pathinfo($filename);
+        $versionedFile = $pathinfo['basename'];
+
+        $dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
+
+        $dirContent = false;
+        if ($view->is_dir($dir)) {
+            $dirContent = $view->opendir($dir);
+        }
+
+        if ($dirContent === false) {
+            return $versions;
+        }
+
+        if (is_resource($dirContent)) {
+            while (($entryName = readdir($dirContent)) !== false) {
+                if (!Filesystem::isIgnoredDir($entryName)) {
+                    $pathparts = pathinfo($entryName);
+                    $filename = $pathparts['filename'];
+                    if ($filename === $versionedFile) {
+                        $pathparts = pathinfo($entryName);
+                        $timestamp = substr($pathparts['extension'], 1);
+                        $filename = $pathparts['filename'];
+                        $key = $timestamp . '#' . $filename;
+                        $versions[$key]['version'] = $timestamp;
+                        $versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
+                        if (empty($userFullPath)) {
+                            $versions[$key]['preview'] = '';
+                        } else {
+                            $versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
+                        }
+                        $versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
+                        $versions[$key]['name'] = $versionedFile;
+                        $versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
+                        $versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
+                    }
+                }
+            }
+            closedir($dirContent);
+        }
+
+        // sort with newest version first
+        krsort($versions);
+
+        return $versions;
+    }
+
+    /**
+     * Expire versions that older than max version retention time
+     * @param string $uid
+     */
+    public static function expireOlderThanMaxForUser($uid) {
+        $expiration = self::getExpiration();
+        $threshold = $expiration->getMaxAgeAsTimestamp();
+        $versions = self::getAllVersions($uid);
+        if (!$threshold || !array_key_exists('all', $versions)) {
+            return;
+        }
+
+        $toDelete = [];
+        foreach (array_reverse($versions['all']) as $key => $version) {
+            if ((int)$version['version'] <$threshold) {
+                $toDelete[$key] = $version;
+            } else {
+                //Versions are sorted by time - nothing mo to iterate.
+                break;
+            }
+        }
+
+        $view = new View('/' . $uid . '/files_versions');
+        if (!empty($toDelete)) {
+            foreach ($toDelete as $version) {
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT]);
+                self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
+                \OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT]);
+            }
+        }
+    }
+
+    /**
+     * translate a timestamp into a string like "5 days ago"
+     * @param int $timestamp
+     * @return string for example "5 days ago"
+     */
+    private static function getHumanReadableTimestamp($timestamp) {
+
+        $diff = time() - $timestamp;
+
+        if ($diff < 60) { // first minute
+            return  $diff . " seconds ago";
+        } elseif ($diff < 3600) { //first hour
+            return round($diff / 60) . " minutes ago";
+        } elseif ($diff < 86400) { // first day
+            return round($diff / 3600) . " hours ago";
+        } elseif ($diff < 604800) { //first week
+            return round($diff / 86400) . " days ago";
+        } elseif ($diff < 2419200) { //first month
+            return round($diff / 604800) . " weeks ago";
+        } elseif ($diff < 29030400) { // first year
+            return round($diff / 2419200) . " months ago";
+        } else {
+            return round($diff / 29030400) . " years ago";
+        }
+
+    }
+
+    /**
+     * returns all stored file versions from a given user
+     * @param string $uid id of the user
+     * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
+     */
+    private static function getAllVersions($uid) {
+        $view = new View('/' . $uid . '/');
+        $dirs = [self::VERSIONS_ROOT];
+        $versions = [];
+
+        while (!empty($dirs)) {
+            $dir = array_pop($dirs);
+            $files = $view->getDirectoryContent($dir);
+
+            foreach ($files as $file) {
+                $fileData = $file->getData();
+                $filePath = $dir . '/' . $fileData['name'];
+                if ($file['type'] === 'dir') {
+                    $dirs[] = $filePath;
+                } else {
+                    $versionsBegin = strrpos($filePath, '.v');
+                    $relPathStart = strlen(self::VERSIONS_ROOT);
+                    $version = substr($filePath, $versionsBegin + 2);
+                    $relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
+                    $key = $version . '#' . $relpath;
+                    $versions[$key] = ['path' => $relpath, 'timestamp' => $version];
+                }
+            }
+        }
+
+        // newest version first
+        krsort($versions);
+
+        $result = [];
+
+        foreach ($versions as $key => $value) {
+            $size = $view->filesize(self::VERSIONS_ROOT.'/'.$value['path'].'.v'.$value['timestamp']);
+            $filename = $value['path'];
+
+            $result['all'][$key]['version'] = $value['timestamp'];
+            $result['all'][$key]['path'] = $filename;
+            $result['all'][$key]['size'] = $size;
+
+            $result['by_file'][$filename][$key]['version'] = $value['timestamp'];
+            $result['by_file'][$filename][$key]['path'] = $filename;
+            $result['by_file'][$filename][$key]['size'] = $size;
+        }
+
+        return $result;
+    }
+
+    /**
+     * get list of files we want to expire
+     * @param array $versions list of versions
+     * @param integer $time
+     * @param bool $quotaExceeded is versions storage limit reached
+     * @return array containing the list of to deleted versions and the size of them
+     */
+    protected static function getExpireList($time, $versions, $quotaExceeded = false) {
+        $expiration = self::getExpiration();
+
+        if ($expiration->shouldAutoExpire()) {
+            list($toDelete, $size) = self::getAutoExpireList($time, $versions);
+        } else {
+            $size = 0;
+            $toDelete = [];  // versions we want to delete
+        }
+
+        foreach ($versions as $key => $version) {
+            if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
+                $size += $version['size'];
+                $toDelete[$key] = $version['path'] . '.v' . $version['version'];
+            }
+        }
+
+        return [$toDelete, $size];
+    }
+
+    /**
+     * get list of files we want to expire
+     * @param array $versions list of versions
+     * @param integer $time
+     * @return array containing the list of to deleted versions and the size of them
+     */
+    protected static function getAutoExpireList($time, $versions) {
+        $size = 0;
+        $toDelete = [];  // versions we want to delete
+
+        $interval = 1;
+        $step = Storage::$max_versions_per_interval[$interval]['step'];
+        if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
+            $nextInterval = -1;
+        } else {
+            $nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
+        }
+
+        $firstVersion = reset($versions);
+        $firstKey = key($versions);
+        $prevTimestamp = $firstVersion['version'];
+        $nextVersion = $firstVersion['version'] - $step;
+        unset($versions[$firstKey]);
+
+        foreach ($versions as $key => $version) {
+            $newInterval = true;
+            while ($newInterval) {
+                if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
+                    if ($version['version'] > $nextVersion) {
+                        //distance between two version too small, mark to delete
+                        $toDelete[$key] = $version['path'] . '.v' . $version['version'];
+                        $size += $version['size'];
+                        \OC::$server->getLogger()->info('Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, ['app' => 'files_versions']);
+                    } else {
+                        $nextVersion = $version['version'] - $step;
+                        $prevTimestamp = $version['version'];
+                    }
+                    $newInterval = false; // version checked so we can move to the next one
+                } else { // time to move on to the next interval
+                    $interval++;
+                    $step = Storage::$max_versions_per_interval[$interval]['step'];
+                    $nextVersion = $prevTimestamp - $step;
+                    if (Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'] === -1) {
+                        $nextInterval = -1;
+                    } else {
+                        $nextInterval = $time - Storage::$max_versions_per_interval[$interval]['intervalEndsAfter'];
+                    }
+                    $newInterval = true; // we changed the interval -> check same version with new interval
+                }
+            }
+        }
+
+        return [$toDelete, $size];
+    }
+
+    /**
+     * Schedule versions expiration for the given file
+     *
+     * @param string $uid owner of the file
+     * @param string $fileName file/folder for which to schedule expiration
+     */
+    public static function scheduleExpire($uid, $fileName) {
+        // let the admin disable auto expire
+        $expiration = self::getExpiration();
+        if ($expiration->isEnabled()) {
+            $command = new Expire($uid, $fileName);
+            \OC::$server->getCommandBus()->push($command);
+        }
+    }
+
+    /**
+     * Expire versions which exceed the quota.
+     *
+     * This will setup the filesystem for the given user but will not
+     * tear it down afterwards.
+     *
+     * @param string $filename path to file to expire
+     * @param string $uid user for which to expire the version
+     * @return bool|int|null
+     */
+    public static function expire($filename, $uid) {
+        $expiration = self::getExpiration();
+
+        if ($expiration->isEnabled()) {
+            // get available disk space for user
+            $user = \OC::$server->getUserManager()->get($uid);
+            if (is_null($user)) {
+                \OC::$server->getLogger()->error('Backends provided no user object for ' . $uid, ['app' => 'files_versions']);
+                throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
+            }
+
+            \OC_Util::setupFS($uid);
+
+            if (!Filesystem::file_exists($filename)) {
+                return false;
+            }
+
+            if (empty($filename)) {
+                // file maybe renamed or deleted
+                return false;
+            }
+            $versionsFileview = new View('/'.$uid.'/files_versions');
+
+            $softQuota = true;
+            $quota = $user->getQuota();
+            if ($quota === null || $quota === 'none') {
+                $quota = Filesystem::free_space('/');
+                $softQuota = false;
+            } else {
+                $quota = \OCP\Util::computerFileSize($quota);
+            }
+
+            // make sure that we have the current size of the version history
+            $versionsSize = self::getVersionsSize($uid);
+
+            // calculate available space for version history
+            // subtract size of files and current versions size from quota
+            if ($quota >= 0) {
+                if ($softQuota) {
+                    $userFolder = \OC::$server->getUserFolder($uid);
+                    if(is_null($userFolder)) {
+                        $availableSpace = 0;
+                    } else {
+                        $free = $quota - $userFolder->getSize(false); // remaining free space for user
+                        if ($free > 0) {
+                            $availableSpace = ($free * self::DEFAULTMAXSIZE / 100) - $versionsSize; // how much space can be used for versions
+                        } else {
+                            $availableSpace = $free - $versionsSize;
+                        }
+                    }
+                } else {
+                    $availableSpace = $quota;
+                }
+            } else {
+                $availableSpace = PHP_INT_MAX;
+            }
+
+            $allVersions = Storage::getVersions($uid, $filename);
+
+            $time = time();
+            list($toDelete, $sizeOfDeletedVersions) = self::getExpireList($time, $allVersions, $availableSpace <= 0);
+
+            $availableSpace = $availableSpace + $sizeOfDeletedVersions;
+            $versionsSize = $versionsSize - $sizeOfDeletedVersions;
+
+            // if still not enough free space we rearrange the versions from all files
+            if ($availableSpace <= 0) {
+                $result = Storage::getAllVersions($uid);
+                $allVersions = $result['all'];
+
+                foreach ($result['by_file'] as $versions) {
+                    list($toDeleteNew, $size) = self::getExpireList($time, $versions, $availableSpace <= 0);
+                    $toDelete = array_merge($toDelete, $toDeleteNew);
+                    $sizeOfDeletedVersions += $size;
+                }
+                $availableSpace = $availableSpace + $sizeOfDeletedVersions;
+                $versionsSize = $versionsSize - $sizeOfDeletedVersions;
+            }
+
+            $logger = \OC::$server->getLogger();
+            foreach($toDelete as $key => $path) {
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
+                self::deleteVersion($versionsFileview, $path);
+                \OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
+                unset($allVersions[$key]); // update array with the versions we keep
+                $logger->info('Expire: ' . $path, ['app' => 'files_versions']);
+            }
+
+            // Check if enough space is available after versions are rearranged.
+            // If not we delete the oldest versions until we meet the size limit for versions,
+            // but always keep the two latest versions
+            $numOfVersions = count($allVersions) -2 ;
+            $i = 0;
+            // sort oldest first and make sure that we start at the first element
+            ksort($allVersions);
+            reset($allVersions);
+            while ($availableSpace < 0 && $i < $numOfVersions) {
+                $version = current($allVersions);
+                \OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
+                self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
+                \OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
+                \OC::$server->getLogger()->info('running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'], ['app' => 'files_versions']);
+                $versionsSize -= $version['size'];
+                $availableSpace += $version['size'];
+                next($allVersions);
+                $i++;
+            }
+
+            return $versionsSize; // finally return the new size of the version history
+        }
+
+        return false;
+    }
+
+    /**
+     * Create recursively missing directories inside of files_versions
+     * that match the given path to a file.
+     *
+     * @param string $filename $path to a file, relative to the user's
+     * "files" folder
+     * @param View $view view on data/user/
+     */
+    public static function createMissingDirectories($filename, $view) {
+        $dirname = Filesystem::normalizePath(dirname($filename));
+        $dirParts = explode('/', $dirname);
+        $dir = "/files_versions";
+        foreach ($dirParts as $part) {
+            $dir = $dir . '/' . $part;
+            if (!$view->file_exists($dir)) {
+                $view->mkdir($dir);
+            }
+        }
+    }
+
+    /**
+     * Static workaround
+     * @return Expiration
+     */
+    protected static function getExpiration() {
+        if (self::$application === null) {
+            self::$application = \OC::$server->query(Application::class);
+        }
+        return self::$application->getContainer()->query(Expiration::class);
+    }
 
 }

Spacing +60 added lines, -60 removed lines

@@ -58,8 +58,8 @@ 
 
 class Storage {
 
-	const DEFAULTENABLED=true;
-	const DEFAULTMAXSIZE=50; // unit: percentage; 50% of available disk space/quota
+	const DEFAULTENABLED = true;
+	const DEFAULTMAXSIZE = 50; // unit: percentage; 50% of available disk space/quota
 	const VERSIONS_ROOT = 'files_versions/';
 
 	const DELETE_TRIGGER_MASTER_REMOVED = 0;
@@ -73,17 +73,17 @@ 
 
 	private static $max_versions_per_interval = [
 		//first 10sec, one version every 2sec
-		1 => ['intervalEndsAfter' => 10,      'step' => 2],
+		1 => ['intervalEndsAfter' => 10, 'step' => 2],
 		//next minute, one version every 10sec
-		2 => ['intervalEndsAfter' => 60,      'step' => 10],
+		2 => ['intervalEndsAfter' => 60, 'step' => 10],
 		//next hour, one version every minute
-		3 => ['intervalEndsAfter' => 3600,    'step' => 60],
+		3 => ['intervalEndsAfter' => 3600, 'step' => 60],
 		//next 24h, one version every hour
-		4 => ['intervalEndsAfter' => 86400,   'step' => 3600],
+		4 => ['intervalEndsAfter' => 86400, 'step' => 3600],
 		//next 30days, one version per day
 		5 => ['intervalEndsAfter' => 2592000, 'step' => 86400],
 		//until the end one version per week
-		6 => ['intervalEndsAfter' => -1,      'step' => 604800],
+		6 => ['intervalEndsAfter' => -1, 'step' => 604800],
 	];
 
 	/** @var \OCA\Files_Versions\AppInfo\Application */
@@ -157,7 +157,7 @@ 
 	 * @return int versions size
 	 */
 	private static function getVersionsSize($user) {
-		$view = new View('/' . $user);
+		$view = new View('/'.$user);
 		$fileInfo = $view->getFileInfo('/files_versions');
 		return isset($fileInfo['size']) ? $fileInfo['size'] : 0;
 	}
@@ -175,13 +175,13 @@ 
 		}
 
 		// we only handle existing files
-		if (! Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
+		if (!Filesystem::file_exists($filename) || Filesystem::is_dir($filename)) {
 			return false;
 		}
 
 		list($uid, $filename) = self::getUidAndFilename($filename);
 
-		$files_view = new View('/'.$uid .'/files');
+		$files_view = new View('/'.$uid.'/files');
 
 		$eventDispatcher = \OC::$server->getEventDispatcher();
 		$fileInfo = $files_view->getFileInfo($filename);
@@ -248,14 +248,14 @@ 
 
 		if (!Filesystem::file_exists($path)) {
 
-			$view = new View('/' . $uid . '/files_versions');
+			$view = new View('/'.$uid.'/files_versions');
 
 			$versions = self::getVersions($uid, $filename);
 			if (!empty($versions)) {
 				foreach ($versions as $v) {
-					\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED]);
-					self::deleteVersion($view, $filename . '.v' . $v['version']);
-					\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $path . $v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED]);
+					\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $path.$v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED]);
+					self::deleteVersion($view, $filename.'.v'.$v['version']);
+					\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $path.$v['version'], 'trigger' => self::DELETE_TRIGGER_MASTER_REMOVED]);
 				}
 			}
 		}
@@ -289,33 +289,33 @@ 
 		$rootView = new View('');
 
 		// did we move a directory ?
-		if ($rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
+		if ($rootView->is_dir('/'.$targetOwner.'/files/'.$targetPath)) {
 			// does the directory exists for versions too ?
-			if ($rootView->is_dir('/' . $sourceOwner . '/files_versions/' . $sourcePath)) {
+			if ($rootView->is_dir('/'.$sourceOwner.'/files_versions/'.$sourcePath)) {
 				// create missing dirs if necessary
-				self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
+				self::createMissingDirectories($targetPath, new View('/'.$targetOwner));
 
 				// move the directory containing the versions
 				$rootView->$operation(
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath,
-					'/' . $targetOwner . '/files_versions/' . $targetPath
+					'/'.$sourceOwner.'/files_versions/'.$sourcePath,
+					'/'.$targetOwner.'/files_versions/'.$targetPath
 				);
 			}
-		} else if ($versions = Storage::getVersions($sourceOwner, '/' . $sourcePath)) {
+		} else if ($versions = Storage::getVersions($sourceOwner, '/'.$sourcePath)) {
 			// create missing dirs if necessary
-			self::createMissingDirectories($targetPath, new View('/'. $targetOwner));
+			self::createMissingDirectories($targetPath, new View('/'.$targetOwner));
 
 			foreach ($versions as $v) {
 				// move each version one by one to the target directory
 				$rootView->$operation(
-					'/' . $sourceOwner . '/files_versions/' . $sourcePath.'.v' . $v['version'],
-					'/' . $targetOwner . '/files_versions/' . $targetPath.'.v'.$v['version']
+					'/'.$sourceOwner.'/files_versions/'.$sourcePath.'.v'.$v['version'],
+					'/'.$targetOwner.'/files_versions/'.$targetPath.'.v'.$v['version']
 				);
 			}
 		}
 
 		// if we moved versions directly for a file, schedule expiration check for that file
-		if (!$rootView->is_dir('/' . $targetOwner . '/files/' . $targetPath)) {
+		if (!$rootView->is_dir('/'.$targetOwner.'/files/'.$targetPath)) {
 			self::scheduleExpire($targetOwner, $targetPath);
 		}
 
@@ -331,13 +331,13 @@ 
 	public static function rollback(string $file, int $revision, IUser $user) {
 
 		// add expected leading slash
-		$filename = '/' . ltrim($file, '/');
+		$filename = '/'.ltrim($file, '/');
 
 		// Fetch the userfolder to trigger view hooks
 		$userFolder = \OC::$server->getUserFolder($user->getUID());
 
 		$users_view = new View('/'.$user->getUID());
-		$files_view = new View('/'. $user->getUID().'/files');
+		$files_view = new View('/'.$user->getUID().'/files');
 
 		$versionCreated = false;
 
@@ -355,7 +355,7 @@ 
 			$versionCreated = true;
 		}
 
-		$fileToRestore =  'files_versions' . $filename . '.v' . $revision;
+		$fileToRestore = 'files_versions'.$filename.'.v'.$revision;
 
 		// Restore encrypted version of the old file for the newly restored file
 		// This has to happen manually here since the file is manually copied below
@@ -371,7 +371,7 @@ 
 		);
 
 		// rollback
-		if (self::copyFileContents($users_view, $fileToRestore, 'files' . $filename)) {
+		if (self::copyFileContents($users_view, $fileToRestore, 'files'.$filename)) {
 			$files_view->touch($file, $revision);
 			Storage::scheduleExpire($user->getUID(), $file);
 
@@ -444,12 +444,12 @@ 
 			return $versions;
 		}
 		// fetch for old versions
-		$view = new View('/' . $uid . '/');
+		$view = new View('/'.$uid.'/');
 
 		$pathinfo = pathinfo($filename);
 		$versionedFile = $pathinfo['basename'];
 
-		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT . '/' . $pathinfo['dirname']);
+		$dir = Filesystem::normalizePath(self::VERSIONS_ROOT.'/'.$pathinfo['dirname']);
 
 		$dirContent = false;
 		if ($view->is_dir($dir)) {
@@ -469,7 +469,7 @@ 
 						$pathparts = pathinfo($entryName);
 						$timestamp = substr($pathparts['extension'], 1);
 						$filename = $pathparts['filename'];
-						$key = $timestamp . '#' . $filename;
+						$key = $timestamp.'#'.$filename;
 						$versions[$key]['version'] = $timestamp;
 						$versions[$key]['humanReadableTimestamp'] = self::getHumanReadableTimestamp($timestamp);
 						if (empty($userFullPath)) {
@@ -477,9 +477,9 @@ 
 						} else {
 							$versions[$key]['preview'] = \OC::$server->getURLGenerator('files_version.Preview.getPreview', ['file' => $userFullPath, 'version' => $timestamp]);
 						}
-						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'] . '/' . $filename);
+						$versions[$key]['path'] = Filesystem::normalizePath($pathinfo['dirname'].'/'.$filename);
 						$versions[$key]['name'] = $versionedFile;
-						$versions[$key]['size'] = $view->filesize($dir . '/' . $entryName);
+						$versions[$key]['size'] = $view->filesize($dir.'/'.$entryName);
 						$versions[$key]['mimetype'] = \OC::$server->getMimeTypeDetector()->detectPath($versionedFile);
 					}
 				}
@@ -507,7 +507,7 @@ 
 
 		$toDelete = [];
 		foreach (array_reverse($versions['all']) as $key => $version) {
-			if ((int)$version['version'] <$threshold) {
+			if ((int) $version['version'] < $threshold) {
 				$toDelete[$key] = $version;
 			} else {
 				//Versions are sorted by time - nothing mo to iterate.
@@ -515,11 +515,11 @@ 
 			}
 		}
 
-		$view = new View('/' . $uid . '/files_versions');
+		$view = new View('/'.$uid.'/files_versions');
 		if (!empty($toDelete)) {
 			foreach ($toDelete as $version) {
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT]);
-				self::deleteVersion($view, $version['path'] . '.v' . $version['version']);
+				self::deleteVersion($view, $version['path'].'.v'.$version['version']);
 				\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_RETENTION_CONSTRAINT]);
 			}
 		}
@@ -535,19 +535,19 @@ 
 		$diff = time() - $timestamp;
 
 		if ($diff < 60) { // first minute
-			return  $diff . " seconds ago";
+			return  $diff." seconds ago";
 		} elseif ($diff < 3600) { //first hour
-			return round($diff / 60) . " minutes ago";
+			return round($diff / 60)." minutes ago";
 		} elseif ($diff < 86400) { // first day
-			return round($diff / 3600) . " hours ago";
+			return round($diff / 3600)." hours ago";
 		} elseif ($diff < 604800) { //first week
-			return round($diff / 86400) . " days ago";
+			return round($diff / 86400)." days ago";
 		} elseif ($diff < 2419200) { //first month
-			return round($diff / 604800) . " weeks ago";
+			return round($diff / 604800)." weeks ago";
 		} elseif ($diff < 29030400) { // first year
-			return round($diff / 2419200) . " months ago";
+			return round($diff / 2419200)." months ago";
 		} else {
-			return round($diff / 29030400) . " years ago";
+			return round($diff / 29030400)." years ago";
 		}
 
 	}
@@ -558,7 +558,7 @@ 
 	 * @return array with contains two arrays 'all' which contains all versions sorted by age and 'by_file' which contains all versions sorted by filename
 	 */
 	private static function getAllVersions($uid) {
-		$view = new View('/' . $uid . '/');
+		$view = new View('/'.$uid.'/');
 		$dirs = [self::VERSIONS_ROOT];
 		$versions = [];
 
@@ -568,7 +568,7 @@ 
 
 			foreach ($files as $file) {
 				$fileData = $file->getData();
-				$filePath = $dir . '/' . $fileData['name'];
+				$filePath = $dir.'/'.$fileData['name'];
 				if ($file['type'] === 'dir') {
 					$dirs[] = $filePath;
 				} else {
@@ -576,7 +576,7 @@ 
 					$relPathStart = strlen(self::VERSIONS_ROOT);
 					$version = substr($filePath, $versionsBegin + 2);
 					$relpath = substr($filePath, $relPathStart, $versionsBegin - $relPathStart);
-					$key = $version . '#' . $relpath;
+					$key = $version.'#'.$relpath;
 					$versions[$key] = ['path' => $relpath, 'timestamp' => $version];
 				}
 			}
@@ -617,13 +617,13 @@ 
 			list($toDelete, $size) = self::getAutoExpireList($time, $versions);
 		} else {
 			$size = 0;
-			$toDelete = [];  // versions we want to delete
+			$toDelete = []; // versions we want to delete
 		}
 
 		foreach ($versions as $key => $version) {
 			if ($expiration->isExpired($version['version'], $quotaExceeded) && !isset($toDelete[$key])) {
 				$size += $version['size'];
-				$toDelete[$key] = $version['path'] . '.v' . $version['version'];
+				$toDelete[$key] = $version['path'].'.v'.$version['version'];
 			}
 		}
 
@@ -638,7 +638,7 @@ 
 	 */
 	protected static function getAutoExpireList($time, $versions) {
 		$size = 0;
-		$toDelete = [];  // versions we want to delete
+		$toDelete = []; // versions we want to delete
 
 		$interval = 1;
 		$step = Storage::$max_versions_per_interval[$interval]['step'];
@@ -660,9 +660,9 @@ 
 				if ($nextInterval === -1 || $prevTimestamp > $nextInterval) {
 					if ($version['version'] > $nextVersion) {
 						//distance between two version too small, mark to delete
-						$toDelete[$key] = $version['path'] . '.v' . $version['version'];
+						$toDelete[$key] = $version['path'].'.v'.$version['version'];
 						$size += $version['size'];
-						\OC::$server->getLogger()->info('Mark to expire '. $version['path'] .' next version should be ' . $nextVersion . " or smaller. (prevTimestamp: " . $prevTimestamp . "; step: " . $step, ['app' => 'files_versions']);
+						\OC::$server->getLogger()->info('Mark to expire '.$version['path'].' next version should be '.$nextVersion." or smaller. (prevTimestamp: ".$prevTimestamp."; step: ".$step, ['app' => 'files_versions']);
 					} else {
 						$nextVersion = $version['version'] - $step;
 						$prevTimestamp = $version['version'];
@@ -717,8 +717,8 @@ 
 			// get available disk space for user
 			$user = \OC::$server->getUserManager()->get($uid);
 			if (is_null($user)) {
-				\OC::$server->getLogger()->error('Backends provided no user object for ' . $uid, ['app' => 'files_versions']);
-				throw new \OC\User\NoUserException('Backends provided no user object for ' . $uid);
+				\OC::$server->getLogger()->error('Backends provided no user object for '.$uid, ['app' => 'files_versions']);
+				throw new \OC\User\NoUserException('Backends provided no user object for '.$uid);
 			}
 
 			\OC_Util::setupFS($uid);
@@ -750,7 +750,7 @@ 
 			if ($quota >= 0) {
 				if ($softQuota) {
 					$userFolder = \OC::$server->getUserFolder($uid);
-					if(is_null($userFolder)) {
+					if (is_null($userFolder)) {
 						$availableSpace = 0;
 					} else {
 						$free = $quota - $userFolder->getSize(false); // remaining free space for user
@@ -790,18 +790,18 @@ 
 			}
 
 			$logger = \OC::$server->getLogger();
-			foreach($toDelete as $key => $path) {
+			foreach ($toDelete as $key => $path) {
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
 				self::deleteVersion($versionsFileview, $path);
 				\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $path, 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
 				unset($allVersions[$key]); // update array with the versions we keep
-				$logger->info('Expire: ' . $path, ['app' => 'files_versions']);
+				$logger->info('Expire: '.$path, ['app' => 'files_versions']);
 			}
 
 			// Check if enough space is available after versions are rearranged.
 			// If not we delete the oldest versions until we meet the size limit for versions,
 			// but always keep the two latest versions
-			$numOfVersions = count($allVersions) -2 ;
+			$numOfVersions = count($allVersions) - 2;
 			$i = 0;
 			// sort oldest first and make sure that we start at the first element
 			ksort($allVersions);
@@ -809,9 +809,9 @@ 
 			while ($availableSpace < 0 && $i < $numOfVersions) {
 				$version = current($allVersions);
 				\OC_Hook::emit('\OCP\Versions', 'preDelete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
-				self::deleteVersion($versionsFileview, $version['path'] . '.v' . $version['version']);
+				self::deleteVersion($versionsFileview, $version['path'].'.v'.$version['version']);
 				\OC_Hook::emit('\OCP\Versions', 'delete', ['path' => $version['path'].'.v'.$version['version'], 'trigger' => self::DELETE_TRIGGER_QUOTA_EXCEEDED]);
-				\OC::$server->getLogger()->info('running out of space! Delete oldest version: ' . $version['path'].'.v'.$version['version'], ['app' => 'files_versions']);
+				\OC::$server->getLogger()->info('running out of space! Delete oldest version: '.$version['path'].'.v'.$version['version'], ['app' => 'files_versions']);
 				$versionsSize -= $version['size'];
 				$availableSpace += $version['size'];
 				next($allVersions);
@@ -837,7 +837,7 @@ 
 		$dirParts = explode('/', $dirname);
 		$dir = "/files_versions";
 		foreach ($dirParts as $part) {
-			$dir = $dir . '/' . $part;
+			$dir = $dir.'/'.$part;
 			if (!$view->file_exists($dir)) {
 				$view->mkdir($dir);
 			}

apps/files_versions/lib/Expiration.php

Indentation +169 added lines, -169 removed lines

@@ -29,173 +29,173 @@
 
 class Expiration {
 
-	// how long do we keep files a version if no other value is defined in the config file (unit: days)
-	const NO_OBLIGATION = -1;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/** @var string */
-	private $retentionObligation;
-
-	/** @var int */
-	private $minAge;
-
-	/** @var int */
-	private $maxAge;
-
-	/** @var bool */
-	private $canPurgeToSaveSpace;
-
-	public function __construct(IConfig $config,ITimeFactory $timeFactory) {
-		$this->timeFactory = $timeFactory;
-		$this->retentionObligation = $config->getSystemValue('versions_retention_obligation', 'auto');
-
-		if ($this->retentionObligation !== 'disabled') {
-			$this->parseRetentionObligation();
-		}
-	}
-
-	/**
-	 * Is versions expiration enabled
-	 * @return bool
-	 */
-	public function isEnabled() {
-		return $this->retentionObligation !== 'disabled';
-	}
-
-	/**
-	 * Is default expiration active
-	 */
-	public function shouldAutoExpire() {
-		return $this->minAge === self::NO_OBLIGATION
-				|| $this->maxAge === self::NO_OBLIGATION;
-	}
-
-	/**
-	 * Check if given timestamp in expiration range
-	 * @param int $timestamp
-	 * @param bool $quotaExceeded
-	 * @return bool
-	 */
-	public function isExpired($timestamp, $quotaExceeded = false) {
-		// No expiration if disabled
-		if (!$this->isEnabled()) {
-			return false;
-		}
-
-		// Purge to save space (if allowed)
-		if ($quotaExceeded && $this->canPurgeToSaveSpace) {
-			return true;
-		}
-
-		$time = $this->timeFactory->getTime();
-		// Never expire dates in future e.g. misconfiguration or negative time
-		// adjustment
-		if ($time<$timestamp) {
-			return false;
-		}
-
-		// Purge as too old
-		if ($this->maxAge !== self::NO_OBLIGATION) {
-			$maxTimestamp = $time - ($this->maxAge * 86400);
-			$isOlderThanMax = $timestamp < $maxTimestamp;
-		} else {
-			$isOlderThanMax = false;
-		}
-
-		if ($this->minAge !== self::NO_OBLIGATION) {
-			// older than Min obligation and we are running out of quota?
-			$minTimestamp = $time - ($this->minAge * 86400);
-			$isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded;
-		} else {
-			$isMinReached = false;
-		}
-
-		return $isOlderThanMax || $isMinReached;
-	}
-
-	/**
-	 * Get maximal retention obligation as a timestamp
-	 * @return int
-	 */
-	public function getMaxAgeAsTimestamp() {
-		$maxAge = false;
-		if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) {
-			$time = $this->timeFactory->getTime();
-			$maxAge = $time - ($this->maxAge * 86400);
-		}
-		return $maxAge;
-	}
-
-	/**
-	 * Read versions_retention_obligation, validate it
-	 * and set private members accordingly
-	 */
-	private function parseRetentionObligation() {
-		$splitValues = explode(',', $this->retentionObligation);
-		if (!isset($splitValues[0])) {
-			$minValue = 'auto';
-		} else {
-			$minValue = trim($splitValues[0]);
-		}
-
-		if (!isset($splitValues[1])) {
-			$maxValue = 'auto';
-		} else {
-			$maxValue = trim($splitValues[1]);
-		}
-
-		$isValid = true;
-		// Validate
-		if (!ctype_digit($minValue) && $minValue !== 'auto') {
-			$isValid = false;
-			\OC::$server->getLogger()->warning(
-					$minValue . ' is not a valid value for minimal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
-					['app'=>'files_versions']
-			);
-		}
-
-		if (!ctype_digit($maxValue) && $maxValue !== 'auto') {
-			$isValid = false;
-			\OC::$server->getLogger()->warning(
-					$maxValue . ' is not a valid value for maximal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
-					['app'=>'files_versions']
-			);
-		}
-
-		if (!$isValid){
-			$minValue = 'auto';
-			$maxValue = 'auto';
-		}
-
-
-		if ($minValue === 'auto' && $maxValue === 'auto') {
-			// Default: Delete anytime if space needed
-			$this->minAge = self::NO_OBLIGATION;
-			$this->maxAge = self::NO_OBLIGATION;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue !== 'auto' && $maxValue === 'auto') {
-			// Keep for X days but delete anytime if space needed
-			$this->minAge = (int)$minValue;
-			$this->maxAge = self::NO_OBLIGATION;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue === 'auto' && $maxValue !== 'auto') {
-			// Delete anytime if space needed, Delete all older than max automatically
-			$this->minAge = self::NO_OBLIGATION;
-			$this->maxAge = (int)$maxValue;
-			$this->canPurgeToSaveSpace = true;
-		} elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
-			// Delete all older than max OR older than min if space needed
-
-			// Max < Min as per https://github.com/owncloud/core/issues/16301
-			if ($maxValue < $minValue) {
-				$maxValue = $minValue;
-			}
-
-			$this->minAge = (int)$minValue;
-			$this->maxAge = (int)$maxValue;
-			$this->canPurgeToSaveSpace = false;
-		}
-	}
+    // how long do we keep files a version if no other value is defined in the config file (unit: days)
+    const NO_OBLIGATION = -1;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    /** @var string */
+    private $retentionObligation;
+
+    /** @var int */
+    private $minAge;
+
+    /** @var int */
+    private $maxAge;
+
+    /** @var bool */
+    private $canPurgeToSaveSpace;
+
+    public function __construct(IConfig $config,ITimeFactory $timeFactory) {
+        $this->timeFactory = $timeFactory;
+        $this->retentionObligation = $config->getSystemValue('versions_retention_obligation', 'auto');
+
+        if ($this->retentionObligation !== 'disabled') {
+            $this->parseRetentionObligation();
+        }
+    }
+
+    /**
+     * Is versions expiration enabled
+     * @return bool
+     */
+    public function isEnabled() {
+        return $this->retentionObligation !== 'disabled';
+    }
+
+    /**
+     * Is default expiration active
+     */
+    public function shouldAutoExpire() {
+        return $this->minAge === self::NO_OBLIGATION
+                || $this->maxAge === self::NO_OBLIGATION;
+    }
+
+    /**
+     * Check if given timestamp in expiration range
+     * @param int $timestamp
+     * @param bool $quotaExceeded
+     * @return bool
+     */
+    public function isExpired($timestamp, $quotaExceeded = false) {
+        // No expiration if disabled
+        if (!$this->isEnabled()) {
+            return false;
+        }
+
+        // Purge to save space (if allowed)
+        if ($quotaExceeded && $this->canPurgeToSaveSpace) {
+            return true;
+        }
+
+        $time = $this->timeFactory->getTime();
+        // Never expire dates in future e.g. misconfiguration or negative time
+        // adjustment
+        if ($time<$timestamp) {
+            return false;
+        }
+
+        // Purge as too old
+        if ($this->maxAge !== self::NO_OBLIGATION) {
+            $maxTimestamp = $time - ($this->maxAge * 86400);
+            $isOlderThanMax = $timestamp < $maxTimestamp;
+        } else {
+            $isOlderThanMax = false;
+        }
+
+        if ($this->minAge !== self::NO_OBLIGATION) {
+            // older than Min obligation and we are running out of quota?
+            $minTimestamp = $time - ($this->minAge * 86400);
+            $isMinReached = ($timestamp < $minTimestamp) && $quotaExceeded;
+        } else {
+            $isMinReached = false;
+        }
+
+        return $isOlderThanMax || $isMinReached;
+    }
+
+    /**
+     * Get maximal retention obligation as a timestamp
+     * @return int
+     */
+    public function getMaxAgeAsTimestamp() {
+        $maxAge = false;
+        if ($this->isEnabled() && $this->maxAge !== self::NO_OBLIGATION) {
+            $time = $this->timeFactory->getTime();
+            $maxAge = $time - ($this->maxAge * 86400);
+        }
+        return $maxAge;
+    }
+
+    /**
+     * Read versions_retention_obligation, validate it
+     * and set private members accordingly
+     */
+    private function parseRetentionObligation() {
+        $splitValues = explode(',', $this->retentionObligation);
+        if (!isset($splitValues[0])) {
+            $minValue = 'auto';
+        } else {
+            $minValue = trim($splitValues[0]);
+        }
+
+        if (!isset($splitValues[1])) {
+            $maxValue = 'auto';
+        } else {
+            $maxValue = trim($splitValues[1]);
+        }
+
+        $isValid = true;
+        // Validate
+        if (!ctype_digit($minValue) && $minValue !== 'auto') {
+            $isValid = false;
+            \OC::$server->getLogger()->warning(
+                    $minValue . ' is not a valid value for minimal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
+                    ['app'=>'files_versions']
+            );
+        }
+
+        if (!ctype_digit($maxValue) && $maxValue !== 'auto') {
+            $isValid = false;
+            \OC::$server->getLogger()->warning(
+                    $maxValue . ' is not a valid value for maximal versions retention obligation. Check versions_retention_obligation in your config.php. Falling back to auto.',
+                    ['app'=>'files_versions']
+            );
+        }
+
+        if (!$isValid){
+            $minValue = 'auto';
+            $maxValue = 'auto';
+        }
+
+
+        if ($minValue === 'auto' && $maxValue === 'auto') {
+            // Default: Delete anytime if space needed
+            $this->minAge = self::NO_OBLIGATION;
+            $this->maxAge = self::NO_OBLIGATION;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue !== 'auto' && $maxValue === 'auto') {
+            // Keep for X days but delete anytime if space needed
+            $this->minAge = (int)$minValue;
+            $this->maxAge = self::NO_OBLIGATION;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue === 'auto' && $maxValue !== 'auto') {
+            // Delete anytime if space needed, Delete all older than max automatically
+            $this->minAge = self::NO_OBLIGATION;
+            $this->maxAge = (int)$maxValue;
+            $this->canPurgeToSaveSpace = true;
+        } elseif ($minValue !== 'auto' && $maxValue !== 'auto') {
+            // Delete all older than max OR older than min if space needed
+
+            // Max < Min as per https://github.com/owncloud/core/issues/16301
+            if ($maxValue < $minValue) {
+                $maxValue = $minValue;
+            }
+
+            $this->minAge = (int)$minValue;
+            $this->maxAge = (int)$maxValue;
+            $this->canPurgeToSaveSpace = false;
+        }
+    }
 }

apps/files_versions/lib/Listener/LoadSidebarListener.php

Indentation +8 added lines, -8 removed lines

@@ -34,14 +34,14 @@
 use OCP\Util;
 
 class LoadSidebarListener implements IEventListener {
-	public function handle(Event $event): void {
-		if (!($event instanceof LoadSidebar)) {
-			return;
-		}
+    public function handle(Event $event): void {
+        if (!($event instanceof LoadSidebar)) {
+            return;
+        }
 
-		// TODO: make sure to only include the sidebar script when
-		// we properly split it between files list and sidebar
-		Util::addScript(Application::APP_ID, 'files_versions');
-	}
+        // TODO: make sure to only include the sidebar script when
+        // we properly split it between files list and sidebar
+        Util::addScript(Application::APP_ID, 'files_versions');
+    }
 
 }

apps/files_versions/lib/Listener/LoadAdditionalListener.php

Indentation +8 added lines, -8 removed lines

@@ -34,14 +34,14 @@
 use OCP\Util;
 
 class LoadAdditionalListener implements IEventListener {
-	public function handle(Event $event): void {
-		if (!($event instanceof LoadAdditionalScriptsEvent)) {
-			return;
-		}
+    public function handle(Event $event): void {
+        if (!($event instanceof LoadAdditionalScriptsEvent)) {
+            return;
+        }
 
-		// TODO: make sure to only include the sidebar script when
-		// we properly split it between files list and sidebar
-		Util::addScript(Application::APP_ID, 'files_versions');
-	}
+        // TODO: make sure to only include the sidebar script when
+        // we properly split it between files list and sidebar
+        Util::addScript(Application::APP_ID, 'files_versions');
+    }
 
 }

apps/files_sharing/lib/Controller/ShareController.php

Indentation +662 added lines, -662 removed lines

@@ -83,670 +83,670 @@
  */
 class ShareController extends AuthPublicShareController {
 
-	/** @var IConfig */
-	protected $config;
-	/** @var IUserManager */
-	protected $userManager;
-	/** @var ILogger */
-	protected $logger;
-	/** @var \OCP\Activity\IManager */
-	protected $activityManager;
-	/** @var IPreview */
-	protected $previewManager;
-	/** @var IRootFolder */
-	protected $rootFolder;
-	/** @var FederatedShareProvider */
-	protected $federatedShareProvider;
-	/** @var IAccountManager */
-	protected $accountManager;
-	/** @var EventDispatcherInterface */
-	protected $eventDispatcher;
-	/** @var IL10N */
-	protected $l10n;
-	/** @var Defaults */
-	protected $defaults;
-	/** @var ShareManager */
-	protected $shareManager;
-
-	/** @var Share\IShare */
-	protected $share;
-
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IConfig $config
-	 * @param IURLGenerator $urlGenerator
-	 * @param IUserManager $userManager
-	 * @param ILogger $logger
-	 * @param \OCP\Activity\IManager $activityManager
-	 * @param \OCP\Share\IManager $shareManager
-	 * @param ISession $session
-	 * @param IPreview $previewManager
-	 * @param IRootFolder $rootFolder
-	 * @param FederatedShareProvider $federatedShareProvider
-	 * @param IAccountManager $accountManager
-	 * @param EventDispatcherInterface $eventDispatcher
-	 * @param IL10N $l10n
-	 * @param Defaults $defaults
-	 */
-	public function __construct(string $appName,
-								IRequest $request,
-								IConfig $config,
-								IURLGenerator $urlGenerator,
-								IUserManager $userManager,
-								ILogger $logger,
-								\OCP\Activity\IManager $activityManager,
-								ShareManager $shareManager,
-								ISession $session,
-								IPreview $previewManager,
-								IRootFolder $rootFolder,
-								FederatedShareProvider $federatedShareProvider,
-								IAccountManager $accountManager,
-								EventDispatcherInterface $eventDispatcher,
-								IL10N $l10n,
-								Defaults $defaults) {
-		parent::__construct($appName, $request, $session, $urlGenerator);
-
-		$this->config = $config;
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$this->activityManager = $activityManager;
-		$this->previewManager = $previewManager;
-		$this->rootFolder = $rootFolder;
-		$this->federatedShareProvider = $federatedShareProvider;
-		$this->accountManager = $accountManager;
-		$this->eventDispatcher = $eventDispatcher;
-		$this->l10n = $l10n;
-		$this->defaults = $defaults;
-		$this->shareManager = $shareManager;
-	}
-
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * Show the authentication page
-	 * The form has to submit to the authenticate method route
-	 */
-	public function showAuthenticate(): TemplateResponse {
-		$templateParameters = ['share' => $this->share];
-
-		$event = new GenericEvent(null, $templateParameters);
-		$this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts::publicShareAuth', $event);
-
-		$response = new TemplateResponse('core', 'publicshareauth', $templateParameters, 'guest');
-		if ($this->share->getSendPasswordByTalk()) {
-			$csp = new ContentSecurityPolicy();
-			$csp->addAllowedConnectDomain('*');
-			$csp->addAllowedMediaDomain('blob:');
-			$response->setContentSecurityPolicy($csp);
-		}
-
-		return $response;
-	}
-
-	/**
-	 * The template to show when authentication failed
-	 */
-	protected function showAuthFailed(): TemplateResponse {
-		$templateParameters = ['share' => $this->share, 'wrongpw' => true];
-
-		$event = new GenericEvent(null, $templateParameters);
-		$this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts::publicShareAuth', $event);
-
-		$response = new TemplateResponse('core', 'publicshareauth', $templateParameters, 'guest');
-		if ($this->share->getSendPasswordByTalk()) {
-			$csp = new ContentSecurityPolicy();
-			$csp->addAllowedConnectDomain('*');
-			$csp->addAllowedMediaDomain('blob:');
-			$response->setContentSecurityPolicy($csp);
-		}
-
-		return $response;
-	}
-
-	protected function verifyPassword(string $password): bool {
-		return $this->shareManager->checkPassword($this->share, $password);
-	}
-
-	protected function getPasswordHash(): string {
-		return $this->share->getPassword();
-	}
-
-	public function isValidToken(): bool {
-		try {
-			$this->share = $this->shareManager->getShareByToken($this->getToken());
-		} catch (ShareNotFound $e) {
-			return false;
-		}
-
-		return true;
-	}
-
-	protected function isPasswordProtected(): bool {
-		return $this->share->getPassword() !== null;
-	}
-
-	protected function authSucceeded() {
-		// For share this was always set so it is still used in other apps
-		$this->session->set('public_link_authenticated', (string)$this->share->getId());
-	}
-
-	protected function authFailed() {
-		$this->emitAccessShareHook($this->share, 403, 'Wrong password');
-	}
-
-	/**
-	 * throws hooks when a share is attempted to be accessed
-	 *
-	 * @param \OCP\Share\IShare|string $share the Share instance if available,
-	 * otherwise token
-	 * @param int $errorCode
-	 * @param string $errorMessage
-	 * @throws \OC\HintException
-	 * @throws \OC\ServerNotAvailableException
-	 */
-	protected function emitAccessShareHook($share, $errorCode = 200, $errorMessage = '') {
-		$itemType = $itemSource = $uidOwner = '';
-		$token = $share;
-		$exception = null;
-		if($share instanceof \OCP\Share\IShare) {
-			try {
-				$token = $share->getToken();
-				$uidOwner = $share->getSharedBy();
-				$itemType = $share->getNodeType();
-				$itemSource = $share->getNodeId();
-			} catch (\Exception $e) {
-				// we log what we know and pass on the exception afterwards
-				$exception = $e;
-			}
-		}
-		\OC_Hook::emit(Share::class, 'share_link_access', [
-			'itemType' => $itemType,
-			'itemSource' => $itemSource,
-			'uidOwner' => $uidOwner,
-			'token' => $token,
-			'errorCode' => $errorCode,
-			'errorMessage' => $errorMessage,
-		]);
-		if(!is_null($exception)) {
-			throw $exception;
-		}
-	}
-
-	/**
-	 * Validate the permissions of the share
-	 *
-	 * @param Share\IShare $share
-	 * @return bool
-	 */
-	private function validateShare(\OCP\Share\IShare $share) {
-		// If the owner is disabled no access to the linke is granted
-		$owner = $this->userManager->get($share->getShareOwner());
-		if ($owner === null || !$owner->isEnabled()) {
-			return false;
-		}
-
-		// If the initiator of the share is disabled no access is granted
-		$initiator = $this->userManager->get($share->getSharedBy());
-		if ($initiator === null || !$initiator->isEnabled()) {
-			return false;
-		}
-
-		return $share->getNode()->isReadable() && $share->getNode()->isShareable();
-	}
-
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 *
-	 * @param string $path
-	 * @return TemplateResponse
-	 * @throws NotFoundException
-	 * @throws \Exception
-	 */
-	public function showShare($path = ''): TemplateResponse {
-		\OC_User::setIncognitoMode(true);
-
-		// Check whether share exists
-		try {
-			$share = $this->shareManager->getShareByToken($this->getToken());
-		} catch (ShareNotFound $e) {
-			$this->emitAccessShareHook($this->getToken(), 404, 'Share not found');
-			throw new NotFoundException();
-		}
-
-		if (!$this->validateShare($share)) {
-			throw new NotFoundException();
-		}
-
-		$shareNode = $share->getNode();
-
-		// We can't get the path of a file share
-		try {
-			if ($shareNode instanceof \OCP\Files\File && $path !== '') {
-				$this->emitAccessShareHook($share, 404, 'Share not found');
-				throw new NotFoundException();
-			}
-		} catch (\Exception $e) {
-			$this->emitAccessShareHook($share, 404, 'Share not found');
-			throw $e;
-		}
-
-		$shareTmpl = [];
-		$shareTmpl['owner'] = '';
-		$shareTmpl['shareOwner'] = '';
-
-		$owner = $this->userManager->get($share->getShareOwner());
-		if ($owner instanceof IUser) {
-			$ownerAccount = $this->accountManager->getAccount($owner);
-
-			$ownerName = $ownerAccount->getProperty(IAccountManager::PROPERTY_DISPLAYNAME);
-			if ($ownerName->getScope() === IAccountManager::VISIBILITY_PUBLIC) {
-				$shareTmpl['owner'] = $owner->getUID();
-				$shareTmpl['shareOwner'] = $owner->getDisplayName();
-			}
-		}
-
-		$shareTmpl['filename'] = $shareNode->getName();
-		$shareTmpl['directory_path'] = $share->getTarget();
-		$shareTmpl['note'] = $share->getNote();
-		$shareTmpl['mimetype'] = $shareNode->getMimetype();
-		$shareTmpl['previewSupported'] = $this->previewManager->isMimeSupported($shareNode->getMimetype());
-		$shareTmpl['dirToken'] = $this->getToken();
-		$shareTmpl['sharingToken'] = $this->getToken();
-		$shareTmpl['server2serversharing'] = $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
-		$shareTmpl['protected'] = $share->getPassword() !== null ? 'true' : 'false';
-		$shareTmpl['dir'] = '';
-		$shareTmpl['nonHumanFileSize'] = $shareNode->getSize();
-		$shareTmpl['fileSize'] = \OCP\Util::humanFileSize($shareNode->getSize());
-		$shareTmpl['hideDownload'] = $share->getHideDownload();
-
-		$hideFileList = false;
-
-		if ($shareNode instanceof \OCP\Files\Folder) {
-
-			$shareIsFolder = true;
-
-			try {
-				$folderNode = $shareNode->get($path);
-			} catch (\OCP\Files\NotFoundException $e) {
-				$this->emitAccessShareHook($share, 404, 'Share not found');
-				throw new NotFoundException();
-			}
-
-			$shareTmpl['dir'] = $shareNode->getRelativePath($folderNode->getPath());
-
-			/*
+    /** @var IConfig */
+    protected $config;
+    /** @var IUserManager */
+    protected $userManager;
+    /** @var ILogger */
+    protected $logger;
+    /** @var \OCP\Activity\IManager */
+    protected $activityManager;
+    /** @var IPreview */
+    protected $previewManager;
+    /** @var IRootFolder */
+    protected $rootFolder;
+    /** @var FederatedShareProvider */
+    protected $federatedShareProvider;
+    /** @var IAccountManager */
+    protected $accountManager;
+    /** @var EventDispatcherInterface */
+    protected $eventDispatcher;
+    /** @var IL10N */
+    protected $l10n;
+    /** @var Defaults */
+    protected $defaults;
+    /** @var ShareManager */
+    protected $shareManager;
+
+    /** @var Share\IShare */
+    protected $share;
+
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IConfig $config
+     * @param IURLGenerator $urlGenerator
+     * @param IUserManager $userManager
+     * @param ILogger $logger
+     * @param \OCP\Activity\IManager $activityManager
+     * @param \OCP\Share\IManager $shareManager
+     * @param ISession $session
+     * @param IPreview $previewManager
+     * @param IRootFolder $rootFolder
+     * @param FederatedShareProvider $federatedShareProvider
+     * @param IAccountManager $accountManager
+     * @param EventDispatcherInterface $eventDispatcher
+     * @param IL10N $l10n
+     * @param Defaults $defaults
+     */
+    public function __construct(string $appName,
+                                IRequest $request,
+                                IConfig $config,
+                                IURLGenerator $urlGenerator,
+                                IUserManager $userManager,
+                                ILogger $logger,
+                                \OCP\Activity\IManager $activityManager,
+                                ShareManager $shareManager,
+                                ISession $session,
+                                IPreview $previewManager,
+                                IRootFolder $rootFolder,
+                                FederatedShareProvider $federatedShareProvider,
+                                IAccountManager $accountManager,
+                                EventDispatcherInterface $eventDispatcher,
+                                IL10N $l10n,
+                                Defaults $defaults) {
+        parent::__construct($appName, $request, $session, $urlGenerator);
+
+        $this->config = $config;
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $this->activityManager = $activityManager;
+        $this->previewManager = $previewManager;
+        $this->rootFolder = $rootFolder;
+        $this->federatedShareProvider = $federatedShareProvider;
+        $this->accountManager = $accountManager;
+        $this->eventDispatcher = $eventDispatcher;
+        $this->l10n = $l10n;
+        $this->defaults = $defaults;
+        $this->shareManager = $shareManager;
+    }
+
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * Show the authentication page
+     * The form has to submit to the authenticate method route
+     */
+    public function showAuthenticate(): TemplateResponse {
+        $templateParameters = ['share' => $this->share];
+
+        $event = new GenericEvent(null, $templateParameters);
+        $this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts::publicShareAuth', $event);
+
+        $response = new TemplateResponse('core', 'publicshareauth', $templateParameters, 'guest');
+        if ($this->share->getSendPasswordByTalk()) {
+            $csp = new ContentSecurityPolicy();
+            $csp->addAllowedConnectDomain('*');
+            $csp->addAllowedMediaDomain('blob:');
+            $response->setContentSecurityPolicy($csp);
+        }
+
+        return $response;
+    }
+
+    /**
+     * The template to show when authentication failed
+     */
+    protected function showAuthFailed(): TemplateResponse {
+        $templateParameters = ['share' => $this->share, 'wrongpw' => true];
+
+        $event = new GenericEvent(null, $templateParameters);
+        $this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts::publicShareAuth', $event);
+
+        $response = new TemplateResponse('core', 'publicshareauth', $templateParameters, 'guest');
+        if ($this->share->getSendPasswordByTalk()) {
+            $csp = new ContentSecurityPolicy();
+            $csp->addAllowedConnectDomain('*');
+            $csp->addAllowedMediaDomain('blob:');
+            $response->setContentSecurityPolicy($csp);
+        }
+
+        return $response;
+    }
+
+    protected function verifyPassword(string $password): bool {
+        return $this->shareManager->checkPassword($this->share, $password);
+    }
+
+    protected function getPasswordHash(): string {
+        return $this->share->getPassword();
+    }
+
+    public function isValidToken(): bool {
+        try {
+            $this->share = $this->shareManager->getShareByToken($this->getToken());
+        } catch (ShareNotFound $e) {
+            return false;
+        }
+
+        return true;
+    }
+
+    protected function isPasswordProtected(): bool {
+        return $this->share->getPassword() !== null;
+    }
+
+    protected function authSucceeded() {
+        // For share this was always set so it is still used in other apps
+        $this->session->set('public_link_authenticated', (string)$this->share->getId());
+    }
+
+    protected function authFailed() {
+        $this->emitAccessShareHook($this->share, 403, 'Wrong password');
+    }
+
+    /**
+     * throws hooks when a share is attempted to be accessed
+     *
+     * @param \OCP\Share\IShare|string $share the Share instance if available,
+     * otherwise token
+     * @param int $errorCode
+     * @param string $errorMessage
+     * @throws \OC\HintException
+     * @throws \OC\ServerNotAvailableException
+     */
+    protected function emitAccessShareHook($share, $errorCode = 200, $errorMessage = '') {
+        $itemType = $itemSource = $uidOwner = '';
+        $token = $share;
+        $exception = null;
+        if($share instanceof \OCP\Share\IShare) {
+            try {
+                $token = $share->getToken();
+                $uidOwner = $share->getSharedBy();
+                $itemType = $share->getNodeType();
+                $itemSource = $share->getNodeId();
+            } catch (\Exception $e) {
+                // we log what we know and pass on the exception afterwards
+                $exception = $e;
+            }
+        }
+        \OC_Hook::emit(Share::class, 'share_link_access', [
+            'itemType' => $itemType,
+            'itemSource' => $itemSource,
+            'uidOwner' => $uidOwner,
+            'token' => $token,
+            'errorCode' => $errorCode,
+            'errorMessage' => $errorMessage,
+        ]);
+        if(!is_null($exception)) {
+            throw $exception;
+        }
+    }
+
+    /**
+     * Validate the permissions of the share
+     *
+     * @param Share\IShare $share
+     * @return bool
+     */
+    private function validateShare(\OCP\Share\IShare $share) {
+        // If the owner is disabled no access to the linke is granted
+        $owner = $this->userManager->get($share->getShareOwner());
+        if ($owner === null || !$owner->isEnabled()) {
+            return false;
+        }
+
+        // If the initiator of the share is disabled no access is granted
+        $initiator = $this->userManager->get($share->getSharedBy());
+        if ($initiator === null || !$initiator->isEnabled()) {
+            return false;
+        }
+
+        return $share->getNode()->isReadable() && $share->getNode()->isShareable();
+    }
+
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     *
+     * @param string $path
+     * @return TemplateResponse
+     * @throws NotFoundException
+     * @throws \Exception
+     */
+    public function showShare($path = ''): TemplateResponse {
+        \OC_User::setIncognitoMode(true);
+
+        // Check whether share exists
+        try {
+            $share = $this->shareManager->getShareByToken($this->getToken());
+        } catch (ShareNotFound $e) {
+            $this->emitAccessShareHook($this->getToken(), 404, 'Share not found');
+            throw new NotFoundException();
+        }
+
+        if (!$this->validateShare($share)) {
+            throw new NotFoundException();
+        }
+
+        $shareNode = $share->getNode();
+
+        // We can't get the path of a file share
+        try {
+            if ($shareNode instanceof \OCP\Files\File && $path !== '') {
+                $this->emitAccessShareHook($share, 404, 'Share not found');
+                throw new NotFoundException();
+            }
+        } catch (\Exception $e) {
+            $this->emitAccessShareHook($share, 404, 'Share not found');
+            throw $e;
+        }
+
+        $shareTmpl = [];
+        $shareTmpl['owner'] = '';
+        $shareTmpl['shareOwner'] = '';
+
+        $owner = $this->userManager->get($share->getShareOwner());
+        if ($owner instanceof IUser) {
+            $ownerAccount = $this->accountManager->getAccount($owner);
+
+            $ownerName = $ownerAccount->getProperty(IAccountManager::PROPERTY_DISPLAYNAME);
+            if ($ownerName->getScope() === IAccountManager::VISIBILITY_PUBLIC) {
+                $shareTmpl['owner'] = $owner->getUID();
+                $shareTmpl['shareOwner'] = $owner->getDisplayName();
+            }
+        }
+
+        $shareTmpl['filename'] = $shareNode->getName();
+        $shareTmpl['directory_path'] = $share->getTarget();
+        $shareTmpl['note'] = $share->getNote();
+        $shareTmpl['mimetype'] = $shareNode->getMimetype();
+        $shareTmpl['previewSupported'] = $this->previewManager->isMimeSupported($shareNode->getMimetype());
+        $shareTmpl['dirToken'] = $this->getToken();
+        $shareTmpl['sharingToken'] = $this->getToken();
+        $shareTmpl['server2serversharing'] = $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
+        $shareTmpl['protected'] = $share->getPassword() !== null ? 'true' : 'false';
+        $shareTmpl['dir'] = '';
+        $shareTmpl['nonHumanFileSize'] = $shareNode->getSize();
+        $shareTmpl['fileSize'] = \OCP\Util::humanFileSize($shareNode->getSize());
+        $shareTmpl['hideDownload'] = $share->getHideDownload();
+
+        $hideFileList = false;
+
+        if ($shareNode instanceof \OCP\Files\Folder) {
+
+            $shareIsFolder = true;
+
+            try {
+                $folderNode = $shareNode->get($path);
+            } catch (\OCP\Files\NotFoundException $e) {
+                $this->emitAccessShareHook($share, 404, 'Share not found');
+                throw new NotFoundException();
+            }
+
+            $shareTmpl['dir'] = $shareNode->getRelativePath($folderNode->getPath());
+
+            /*
 			 * The OC_Util methods require a view. This just uses the node API
 			 */
-			$freeSpace = $share->getNode()->getStorage()->free_space($share->getNode()->getInternalPath());
-			if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-				$freeSpace = max($freeSpace, 0);
-			} else {
-				$freeSpace = (INF > 0) ? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
-			}
-
-			$hideFileList = !($share->getPermissions() & \OCP\Constants::PERMISSION_READ);
-			$maxUploadFilesize = $freeSpace;
-
-			$folder = new Template('files', 'list', '');
-
-			$folder->assign('dir', $shareNode->getRelativePath($folderNode->getPath()));
-			$folder->assign('dirToken', $this->getToken());
-			$folder->assign('permissions', \OCP\Constants::PERMISSION_READ);
-			$folder->assign('isPublic', true);
-			$folder->assign('hideFileList', $hideFileList);
-			$folder->assign('publicUploadEnabled', 'no');
-			// default to list view
-			$folder->assign('showgridview', false);
-			$folder->assign('uploadMaxFilesize', $maxUploadFilesize);
-			$folder->assign('uploadMaxHumanFilesize', \OCP\Util::humanFileSize($maxUploadFilesize));
-			$folder->assign('freeSpace', $freeSpace);
-			$folder->assign('usedSpacePercent', 0);
-			$folder->assign('trash', false);
-			$shareTmpl['folder'] = $folder->fetchPage();
-		} else {
-			$shareIsFolder = false;
-		}
-
-		// default to list view
-		$shareTmpl['showgridview'] = false;
-
-		$shareTmpl['hideFileList'] = $hideFileList;
-		$shareTmpl['downloadURL'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.downloadShare', ['token' => $this->getToken()]);
-		$shareTmpl['shareUrl'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare', ['token' => $this->getToken()]);
-		$shareTmpl['maxSizeAnimateGif'] = $this->config->getSystemValue('max_filesize_animated_gifs_public_sharing', 10);
-		$shareTmpl['previewEnabled'] = $this->config->getSystemValue('enable_previews', true);
-		$shareTmpl['previewMaxX'] = $this->config->getSystemValue('preview_max_x', 1024);
-		$shareTmpl['previewMaxY'] = $this->config->getSystemValue('preview_max_y', 1024);
-		$shareTmpl['disclaimer'] = $this->config->getAppValue('core', 'shareapi_public_link_disclaimertext', null);
-		$shareTmpl['previewURL'] = $shareTmpl['downloadURL'];
-
-		if ($shareTmpl['previewSupported']) {
-			$shareTmpl['previewImage'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.PublicPreview.getPreview',
-				['x' => 200, 'y' => 200, 'file' => $shareTmpl['directory_path'], 'token' => $shareTmpl['dirToken']]);
-			$ogPreview = $shareTmpl['previewImage'];
-
-			// We just have direct previews for image files
-			if ($shareNode->getMimePart() === 'image') {
-				$shareTmpl['previewURL'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.publicpreview.directLink', ['token' => $this->getToken()]);
-
-				$ogPreview = $shareTmpl['previewURL'];
-
-				//Whatapp is kind of picky about their size requirements
-				if ($this->request->isUserAgent(['/^WhatsApp/'])) {
-					$ogPreview = $this->urlGenerator->linkToRouteAbsolute('files_sharing.PublicPreview.getPreview', [
-						'token' => $this->getToken(),
-						'x' => 256,
-						'y' => 256,
-						'a' => true,
-					]);
-				}
-			}
-		} else {
-			$shareTmpl['previewImage'] = $this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath('core', 'favicon-fb.png'));
-			$ogPreview = $shareTmpl['previewImage'];
-		}
-
-		// Load files we need
-		\OCP\Util::addScript('files', 'semaphore');
-		\OCP\Util::addScript('files', 'file-upload');
-		\OCP\Util::addStyle('files_sharing', 'publicView');
-		\OCP\Util::addScript('files_sharing', 'public');
-		\OCP\Util::addScript('files_sharing', 'templates');
-		\OCP\Util::addScript('files', 'fileactions');
-		\OCP\Util::addScript('files', 'fileactionsmenu');
-		\OCP\Util::addScript('files', 'jquery.fileupload');
-		\OCP\Util::addScript('files_sharing', 'files_drop');
-
-		if (isset($shareTmpl['folder'])) {
-			// JS required for folders
-			\OCP\Util::addStyle('files', 'merged');
-			\OCP\Util::addScript('files', 'filesummary');
-			\OCP\Util::addScript('files', 'templates');
-			\OCP\Util::addScript('files', 'breadcrumb');
-			\OCP\Util::addScript('files', 'fileinfomodel');
-			\OCP\Util::addScript('files', 'newfilemenu');
-			\OCP\Util::addScript('files', 'files');
-			\OCP\Util::addScript('files', 'filemultiselectmenu');
-			\OCP\Util::addScript('files', 'filelist');
-			\OCP\Util::addScript('files', 'keyboardshortcuts');
-			\OCP\Util::addScript('files', 'operationprogressbar');
-
-			// Load Viewer scripts
-			if (class_exists(LoadViewer::class)) {
-				$this->eventDispatcher->dispatch(LoadViewer::class, new LoadViewer());
-			}
-		}
-
-		// OpenGraph Support: http://ogp.me/
-		\OCP\Util::addHeader('meta', ['property' => "og:title", 'content' => $shareTmpl['filename']]);
-		\OCP\Util::addHeader('meta', ['property' => "og:description", 'content' => $this->defaults->getName() . ($this->defaults->getSlogan() !== '' ? ' - ' . $this->defaults->getSlogan() : '')]);
-		\OCP\Util::addHeader('meta', ['property' => "og:site_name", 'content' => $this->defaults->getName()]);
-		\OCP\Util::addHeader('meta', ['property' => "og:url", 'content' => $shareTmpl['shareUrl']]);
-		\OCP\Util::addHeader('meta', ['property' => "og:type", 'content' => "object"]);
-		\OCP\Util::addHeader('meta', ['property' => "og:image", 'content' => $ogPreview]);
-
-		$event = new GenericEvent(null, ['share' => $share]);
-		$this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts', $event);
-
-		$csp = new \OCP\AppFramework\Http\ContentSecurityPolicy();
-		$csp->addAllowedFrameDomain('\'self\'');
-
-		$response = new PublicTemplateResponse($this->appName, 'public', $shareTmpl);
-		$response->setHeaderTitle($shareTmpl['filename']);
-		if ($shareTmpl['shareOwner'] !== '') {
-			$response->setHeaderDetails($this->l10n->t('shared by %s', [$shareTmpl['shareOwner']]));
-		}
-
-		$isNoneFileDropFolder = $shareIsFolder === false || $share->getPermissions() !== \OCP\Constants::PERMISSION_CREATE;
-
-		if ($isNoneFileDropFolder && !$share->getHideDownload()) {
-			\OCP\Util::addScript('files_sharing', 'public_note');
-
-			$downloadWhite = new SimpleMenuAction('download', $this->l10n->t('Download'), 'icon-download-white', $shareTmpl['downloadURL'], 0);
-			$downloadAllWhite = new SimpleMenuAction('download', $this->l10n->t('Download all files'), 'icon-download-white', $shareTmpl['downloadURL'], 0);
-			$download = new SimpleMenuAction('download', $this->l10n->t('Download'), 'icon-download', $shareTmpl['downloadURL'], 10, $shareTmpl['fileSize']);
-			$downloadAll = new SimpleMenuAction('download', $this->l10n->t('Download all files'), 'icon-download', $shareTmpl['downloadURL'], 10, $shareTmpl['fileSize']);
-			$directLink = new LinkMenuAction($this->l10n->t('Direct link'), 'icon-public', $shareTmpl['previewURL']);
-			$externalShare = new ExternalShareMenuAction($this->l10n->t('Add to your Nextcloud'), 'icon-external', $shareTmpl['owner'], $shareTmpl['shareOwner'], $shareTmpl['filename']);
-
-			$responseComposer = [];
-
-			if ($shareIsFolder) {
-				$responseComposer[] = $downloadAllWhite;
-				$responseComposer[] = $downloadAll;
-			} else {
-				$responseComposer[] = $downloadWhite;
-				$responseComposer[] = $download;
-			}
-			$responseComposer[] = $directLink;
-			if ($this->federatedShareProvider->isOutgoingServer2serverShareEnabled()) {
-				$responseComposer[] = $externalShare;
-			}
-
-			$response->setHeaderActions($responseComposer);
-		}
-
-		$response->setContentSecurityPolicy($csp);
-
-		$this->emitAccessShareHook($share);
-
-		return $response;
-	}
-
-	/**
-	 * @PublicPage
-	 * @NoCSRFRequired
-	 *
-	 * @param string $token
-	 * @param string $files
-	 * @param string $path
-	 * @param string $downloadStartSecret
-	 * @return void|\OCP\AppFramework\Http\Response
-	 * @throws NotFoundException
-	 */
-	public function downloadShare($token, $files = null, $path = '', $downloadStartSecret = '') {
-		\OC_User::setIncognitoMode(true);
-
-		$share = $this->shareManager->getShareByToken($token);
-
-		if(!($share->getPermissions() & \OCP\Constants::PERMISSION_READ)) {
-			return new \OCP\AppFramework\Http\DataResponse('Share is read-only');
-		}
-
-		$files_list = null;
-		if (!is_null($files)) { // download selected files
-			$files_list = json_decode($files);
-			// in case we get only a single file
-			if ($files_list === null) {
-				$files_list = [$files];
-			}
-			// Just in case $files is a single int like '1234'
-			if (!is_array($files_list)) {
-				$files_list = [$files_list];
-			}
-		}
-
-		if (!$this->validateShare($share)) {
-			throw new NotFoundException();
-		}
-
-		$userFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
-		$originalSharePath = $userFolder->getRelativePath($share->getNode()->getPath());
-
-
-		// Single file share
-		if ($share->getNode() instanceof \OCP\Files\File) {
-			// Single file download
-			$this->singleFileDownloaded($share, $share->getNode());
-		}
-		// Directory share
-		else {
-			/** @var \OCP\Files\Folder $node */
-			$node = $share->getNode();
-
-			// Try to get the path
-			if ($path !== '') {
-				try {
-					$node = $node->get($path);
-				} catch (NotFoundException $e) {
-					$this->emitAccessShareHook($share, 404, 'Share not found');
-					return new NotFoundResponse();
-				}
-			}
-
-			$originalSharePath = $userFolder->getRelativePath($node->getPath());
-
-			if ($node instanceof \OCP\Files\File) {
-				// Single file download
-				$this->singleFileDownloaded($share, $share->getNode());
-			} else {
-				try {
-					if (!empty($files_list)) {
-						$this->fileListDownloaded($share, $files_list, $node);
-					} else {
-						// The folder is downloaded
-						$this->singleFileDownloaded($share, $share->getNode());
-					}
-				} catch (NotFoundException $e) {
-					return new NotFoundResponse();
-				}
-			}
-		}
-
-		/* FIXME: We should do this all nicely in OCP */
-		OC_Util::tearDownFS();
-		OC_Util::setupFS($share->getShareOwner());
-
-		/**
-		 * this sets a cookie to be able to recognize the start of the download
-		 * the content must not be longer than 32 characters and must only contain
-		 * alphanumeric characters
-		 */
-		if (!empty($downloadStartSecret)
-			&& !isset($downloadStartSecret[32])
-			&& preg_match('!^[a-zA-Z0-9]+$!', $downloadStartSecret) === 1) {
-
-			// FIXME: set on the response once we use an actual app framework response
-			setcookie('ocDownloadStarted', $downloadStartSecret, time() + 20, '/');
-		}
-
-		$this->emitAccessShareHook($share);
-
-		$server_params = [ 'head' => $this->request->getMethod() === 'HEAD' ];
-
-		/**
-		 * Http range requests support
-		 */
-		if (isset($_SERVER['HTTP_RANGE'])) {
-			$server_params['range'] = $this->request->getHeader('Range');
-		}
-
-		// download selected files
-		if (!is_null($files) && $files !== '') {
-			// FIXME: The exit is required here because otherwise the AppFramework is trying to add headers as well
-			// after dispatching the request which results in a "Cannot modify header information" notice.
-			OC_Files::get($originalSharePath, $files_list, $server_params);
-			exit();
-		} else {
-			// FIXME: The exit is required here because otherwise the AppFramework is trying to add headers as well
-			// after dispatching the request which results in a "Cannot modify header information" notice.
-			OC_Files::get(dirname($originalSharePath), basename($originalSharePath), $server_params);
-			exit();
-		}
-	}
-
-	/**
-	 * create activity for every downloaded file
-	 *
-	 * @param Share\IShare $share
-	 * @param array $files_list
-	 * @param \OCP\Files\Folder $node
-	 * @throws NotFoundException when trying to download a folder or multiple files of a "hide download" share
-	 */
-	protected function fileListDownloaded(Share\IShare $share, array $files_list, \OCP\Files\Folder $node) {
-		if ($share->getHideDownload() && count($files_list) > 1) {
-			throw new NotFoundException('Downloading more than 1 file');
-		}
-
-		foreach ($files_list as $file) {
-			$subNode = $node->get($file);
-			$this->singleFileDownloaded($share, $subNode);
-		}
-
-	}
-
-	/**
-	 * create activity if a single file was downloaded from a link share
-	 *
-	 * @param Share\IShare $share
-	 * @throws NotFoundException when trying to download a folder of a "hide download" share
-	 */
-	protected function singleFileDownloaded(Share\IShare $share, \OCP\Files\Node $node) {
-		if ($share->getHideDownload() && $node instanceof Folder) {
-			throw new NotFoundException('Downloading a folder');
-		}
-
-		$fileId = $node->getId();
-
-		$userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
-		$userNodeList = $userFolder->getById($fileId);
-		$userNode = $userNodeList[0];
-		$ownerFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
-		$userPath = $userFolder->getRelativePath($userNode->getPath());
-		$ownerPath = $ownerFolder->getRelativePath($node->getPath());
-
-		$parameters = [$userPath];
-
-		if ($share->getShareType() === \OCP\Share::SHARE_TYPE_EMAIL) {
-			if ($node instanceof \OCP\Files\File) {
-				$subject = Downloads::SUBJECT_SHARED_FILE_BY_EMAIL_DOWNLOADED;
-			} else {
-				$subject = Downloads::SUBJECT_SHARED_FOLDER_BY_EMAIL_DOWNLOADED;
-			}
-			$parameters[] = $share->getSharedWith();
-		} else {
-			if ($node instanceof \OCP\Files\File) {
-				$subject = Downloads::SUBJECT_PUBLIC_SHARED_FILE_DOWNLOADED;
-			} else {
-				$subject = Downloads::SUBJECT_PUBLIC_SHARED_FOLDER_DOWNLOADED;
-			}
-		}
-
-		$this->publishActivity($subject, $parameters, $share->getSharedBy(), $fileId, $userPath);
-
-		if ($share->getShareOwner() !== $share->getSharedBy()) {
-			$parameters[0] = $ownerPath;
-			$this->publishActivity($subject, $parameters, $share->getShareOwner(), $fileId, $ownerPath);
-		}
-	}
-
-	/**
-	 * publish activity
-	 *
-	 * @param string $subject
-	 * @param array $parameters
-	 * @param string $affectedUser
-	 * @param int $fileId
-	 * @param string $filePath
-	 */
-	protected function publishActivity($subject,
-										array $parameters,
-										$affectedUser,
-										$fileId,
-										$filePath) {
-
-		$event = $this->activityManager->generateEvent();
-		$event->setApp('files_sharing')
-			->setType('public_links')
-			->setSubject($subject, $parameters)
-			->setAffectedUser($affectedUser)
-			->setObject('files', $fileId, $filePath);
-		$this->activityManager->publish($event);
-	}
+            $freeSpace = $share->getNode()->getStorage()->free_space($share->getNode()->getInternalPath());
+            if ($freeSpace < \OCP\Files\FileInfo::SPACE_UNLIMITED) {
+                $freeSpace = max($freeSpace, 0);
+            } else {
+                $freeSpace = (INF > 0) ? INF: PHP_INT_MAX; // work around https://bugs.php.net/bug.php?id=69188
+            }
+
+            $hideFileList = !($share->getPermissions() & \OCP\Constants::PERMISSION_READ);
+            $maxUploadFilesize = $freeSpace;
+
+            $folder = new Template('files', 'list', '');
+
+            $folder->assign('dir', $shareNode->getRelativePath($folderNode->getPath()));
+            $folder->assign('dirToken', $this->getToken());
+            $folder->assign('permissions', \OCP\Constants::PERMISSION_READ);
+            $folder->assign('isPublic', true);
+            $folder->assign('hideFileList', $hideFileList);
+            $folder->assign('publicUploadEnabled', 'no');
+            // default to list view
+            $folder->assign('showgridview', false);
+            $folder->assign('uploadMaxFilesize', $maxUploadFilesize);
+            $folder->assign('uploadMaxHumanFilesize', \OCP\Util::humanFileSize($maxUploadFilesize));
+            $folder->assign('freeSpace', $freeSpace);
+            $folder->assign('usedSpacePercent', 0);
+            $folder->assign('trash', false);
+            $shareTmpl['folder'] = $folder->fetchPage();
+        } else {
+            $shareIsFolder = false;
+        }
+
+        // default to list view
+        $shareTmpl['showgridview'] = false;
+
+        $shareTmpl['hideFileList'] = $hideFileList;
+        $shareTmpl['downloadURL'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.downloadShare', ['token' => $this->getToken()]);
+        $shareTmpl['shareUrl'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.sharecontroller.showShare', ['token' => $this->getToken()]);
+        $shareTmpl['maxSizeAnimateGif'] = $this->config->getSystemValue('max_filesize_animated_gifs_public_sharing', 10);
+        $shareTmpl['previewEnabled'] = $this->config->getSystemValue('enable_previews', true);
+        $shareTmpl['previewMaxX'] = $this->config->getSystemValue('preview_max_x', 1024);
+        $shareTmpl['previewMaxY'] = $this->config->getSystemValue('preview_max_y', 1024);
+        $shareTmpl['disclaimer'] = $this->config->getAppValue('core', 'shareapi_public_link_disclaimertext', null);
+        $shareTmpl['previewURL'] = $shareTmpl['downloadURL'];
+
+        if ($shareTmpl['previewSupported']) {
+            $shareTmpl['previewImage'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.PublicPreview.getPreview',
+                ['x' => 200, 'y' => 200, 'file' => $shareTmpl['directory_path'], 'token' => $shareTmpl['dirToken']]);
+            $ogPreview = $shareTmpl['previewImage'];
+
+            // We just have direct previews for image files
+            if ($shareNode->getMimePart() === 'image') {
+                $shareTmpl['previewURL'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.publicpreview.directLink', ['token' => $this->getToken()]);
+
+                $ogPreview = $shareTmpl['previewURL'];
+
+                //Whatapp is kind of picky about their size requirements
+                if ($this->request->isUserAgent(['/^WhatsApp/'])) {
+                    $ogPreview = $this->urlGenerator->linkToRouteAbsolute('files_sharing.PublicPreview.getPreview', [
+                        'token' => $this->getToken(),
+                        'x' => 256,
+                        'y' => 256,
+                        'a' => true,
+                    ]);
+                }
+            }
+        } else {
+            $shareTmpl['previewImage'] = $this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath('core', 'favicon-fb.png'));
+            $ogPreview = $shareTmpl['previewImage'];
+        }
+
+        // Load files we need
+        \OCP\Util::addScript('files', 'semaphore');
+        \OCP\Util::addScript('files', 'file-upload');
+        \OCP\Util::addStyle('files_sharing', 'publicView');
+        \OCP\Util::addScript('files_sharing', 'public');
+        \OCP\Util::addScript('files_sharing', 'templates');
+        \OCP\Util::addScript('files', 'fileactions');
+        \OCP\Util::addScript('files', 'fileactionsmenu');
+        \OCP\Util::addScript('files', 'jquery.fileupload');
+        \OCP\Util::addScript('files_sharing', 'files_drop');
+
+        if (isset($shareTmpl['folder'])) {
+            // JS required for folders
+            \OCP\Util::addStyle('files', 'merged');
+            \OCP\Util::addScript('files', 'filesummary');
+            \OCP\Util::addScript('files', 'templates');
+            \OCP\Util::addScript('files', 'breadcrumb');
+            \OCP\Util::addScript('files', 'fileinfomodel');
+            \OCP\Util::addScript('files', 'newfilemenu');
+            \OCP\Util::addScript('files', 'files');
+            \OCP\Util::addScript('files', 'filemultiselectmenu');
+            \OCP\Util::addScript('files', 'filelist');
+            \OCP\Util::addScript('files', 'keyboardshortcuts');
+            \OCP\Util::addScript('files', 'operationprogressbar');
+
+            // Load Viewer scripts
+            if (class_exists(LoadViewer::class)) {
+                $this->eventDispatcher->dispatch(LoadViewer::class, new LoadViewer());
+            }
+        }
+
+        // OpenGraph Support: http://ogp.me/
+        \OCP\Util::addHeader('meta', ['property' => "og:title", 'content' => $shareTmpl['filename']]);
+        \OCP\Util::addHeader('meta', ['property' => "og:description", 'content' => $this->defaults->getName() . ($this->defaults->getSlogan() !== '' ? ' - ' . $this->defaults->getSlogan() : '')]);
+        \OCP\Util::addHeader('meta', ['property' => "og:site_name", 'content' => $this->defaults->getName()]);
+        \OCP\Util::addHeader('meta', ['property' => "og:url", 'content' => $shareTmpl['shareUrl']]);
+        \OCP\Util::addHeader('meta', ['property' => "og:type", 'content' => "object"]);
+        \OCP\Util::addHeader('meta', ['property' => "og:image", 'content' => $ogPreview]);
+
+        $event = new GenericEvent(null, ['share' => $share]);
+        $this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts', $event);
+
+        $csp = new \OCP\AppFramework\Http\ContentSecurityPolicy();
+        $csp->addAllowedFrameDomain('\'self\'');
+
+        $response = new PublicTemplateResponse($this->appName, 'public', $shareTmpl);
+        $response->setHeaderTitle($shareTmpl['filename']);
+        if ($shareTmpl['shareOwner'] !== '') {
+            $response->setHeaderDetails($this->l10n->t('shared by %s', [$shareTmpl['shareOwner']]));
+        }
+
+        $isNoneFileDropFolder = $shareIsFolder === false || $share->getPermissions() !== \OCP\Constants::PERMISSION_CREATE;
+
+        if ($isNoneFileDropFolder && !$share->getHideDownload()) {
+            \OCP\Util::addScript('files_sharing', 'public_note');
+
+            $downloadWhite = new SimpleMenuAction('download', $this->l10n->t('Download'), 'icon-download-white', $shareTmpl['downloadURL'], 0);
+            $downloadAllWhite = new SimpleMenuAction('download', $this->l10n->t('Download all files'), 'icon-download-white', $shareTmpl['downloadURL'], 0);
+            $download = new SimpleMenuAction('download', $this->l10n->t('Download'), 'icon-download', $shareTmpl['downloadURL'], 10, $shareTmpl['fileSize']);
+            $downloadAll = new SimpleMenuAction('download', $this->l10n->t('Download all files'), 'icon-download', $shareTmpl['downloadURL'], 10, $shareTmpl['fileSize']);
+            $directLink = new LinkMenuAction($this->l10n->t('Direct link'), 'icon-public', $shareTmpl['previewURL']);
+            $externalShare = new ExternalShareMenuAction($this->l10n->t('Add to your Nextcloud'), 'icon-external', $shareTmpl['owner'], $shareTmpl['shareOwner'], $shareTmpl['filename']);
+
+            $responseComposer = [];
+
+            if ($shareIsFolder) {
+                $responseComposer[] = $downloadAllWhite;
+                $responseComposer[] = $downloadAll;
+            } else {
+                $responseComposer[] = $downloadWhite;
+                $responseComposer[] = $download;
+            }
+            $responseComposer[] = $directLink;
+            if ($this->federatedShareProvider->isOutgoingServer2serverShareEnabled()) {
+                $responseComposer[] = $externalShare;
+            }
+
+            $response->setHeaderActions($responseComposer);
+        }
+
+        $response->setContentSecurityPolicy($csp);
+
+        $this->emitAccessShareHook($share);
+
+        return $response;
+    }
+
+    /**
+     * @PublicPage
+     * @NoCSRFRequired
+     *
+     * @param string $token
+     * @param string $files
+     * @param string $path
+     * @param string $downloadStartSecret
+     * @return void|\OCP\AppFramework\Http\Response
+     * @throws NotFoundException
+     */
+    public function downloadShare($token, $files = null, $path = '', $downloadStartSecret = '') {
+        \OC_User::setIncognitoMode(true);
+
+        $share = $this->shareManager->getShareByToken($token);
+
+        if(!($share->getPermissions() & \OCP\Constants::PERMISSION_READ)) {
+            return new \OCP\AppFramework\Http\DataResponse('Share is read-only');
+        }
+
+        $files_list = null;
+        if (!is_null($files)) { // download selected files
+            $files_list = json_decode($files);
+            // in case we get only a single file
+            if ($files_list === null) {
+                $files_list = [$files];
+            }
+            // Just in case $files is a single int like '1234'
+            if (!is_array($files_list)) {
+                $files_list = [$files_list];
+            }
+        }
+
+        if (!$this->validateShare($share)) {
+            throw new NotFoundException();
+        }
+
+        $userFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
+        $originalSharePath = $userFolder->getRelativePath($share->getNode()->getPath());
+
+
+        // Single file share
+        if ($share->getNode() instanceof \OCP\Files\File) {
+            // Single file download
+            $this->singleFileDownloaded($share, $share->getNode());
+        }
+        // Directory share
+        else {
+            /** @var \OCP\Files\Folder $node */
+            $node = $share->getNode();
+
+            // Try to get the path
+            if ($path !== '') {
+                try {
+                    $node = $node->get($path);
+                } catch (NotFoundException $e) {
+                    $this->emitAccessShareHook($share, 404, 'Share not found');
+                    return new NotFoundResponse();
+                }
+            }
+
+            $originalSharePath = $userFolder->getRelativePath($node->getPath());
+
+            if ($node instanceof \OCP\Files\File) {
+                // Single file download
+                $this->singleFileDownloaded($share, $share->getNode());
+            } else {
+                try {
+                    if (!empty($files_list)) {
+                        $this->fileListDownloaded($share, $files_list, $node);
+                    } else {
+                        // The folder is downloaded
+                        $this->singleFileDownloaded($share, $share->getNode());
+                    }
+                } catch (NotFoundException $e) {
+                    return new NotFoundResponse();
+                }
+            }
+        }
+
+        /* FIXME: We should do this all nicely in OCP */
+        OC_Util::tearDownFS();
+        OC_Util::setupFS($share->getShareOwner());
+
+        /**
+         * this sets a cookie to be able to recognize the start of the download
+         * the content must not be longer than 32 characters and must only contain
+         * alphanumeric characters
+         */
+        if (!empty($downloadStartSecret)
+            && !isset($downloadStartSecret[32])
+            && preg_match('!^[a-zA-Z0-9]+$!', $downloadStartSecret) === 1) {
+
+            // FIXME: set on the response once we use an actual app framework response
+            setcookie('ocDownloadStarted', $downloadStartSecret, time() + 20, '/');
+        }
+
+        $this->emitAccessShareHook($share);
+
+        $server_params = [ 'head' => $this->request->getMethod() === 'HEAD' ];
+
+        /**
+         * Http range requests support
+         */
+        if (isset($_SERVER['HTTP_RANGE'])) {
+            $server_params['range'] = $this->request->getHeader('Range');
+        }
+
+        // download selected files
+        if (!is_null($files) && $files !== '') {
+            // FIXME: The exit is required here because otherwise the AppFramework is trying to add headers as well
+            // after dispatching the request which results in a "Cannot modify header information" notice.
+            OC_Files::get($originalSharePath, $files_list, $server_params);
+            exit();
+        } else {
+            // FIXME: The exit is required here because otherwise the AppFramework is trying to add headers as well
+            // after dispatching the request which results in a "Cannot modify header information" notice.
+            OC_Files::get(dirname($originalSharePath), basename($originalSharePath), $server_params);
+            exit();
+        }
+    }
+
+    /**
+     * create activity for every downloaded file
+     *
+     * @param Share\IShare $share
+     * @param array $files_list
+     * @param \OCP\Files\Folder $node
+     * @throws NotFoundException when trying to download a folder or multiple files of a "hide download" share
+     */
+    protected function fileListDownloaded(Share\IShare $share, array $files_list, \OCP\Files\Folder $node) {
+        if ($share->getHideDownload() && count($files_list) > 1) {
+            throw new NotFoundException('Downloading more than 1 file');
+        }
+
+        foreach ($files_list as $file) {
+            $subNode = $node->get($file);
+            $this->singleFileDownloaded($share, $subNode);
+        }
+
+    }
+
+    /**
+     * create activity if a single file was downloaded from a link share
+     *
+     * @param Share\IShare $share
+     * @throws NotFoundException when trying to download a folder of a "hide download" share
+     */
+    protected function singleFileDownloaded(Share\IShare $share, \OCP\Files\Node $node) {
+        if ($share->getHideDownload() && $node instanceof Folder) {
+            throw new NotFoundException('Downloading a folder');
+        }
+
+        $fileId = $node->getId();
+
+        $userFolder = $this->rootFolder->getUserFolder($share->getSharedBy());
+        $userNodeList = $userFolder->getById($fileId);
+        $userNode = $userNodeList[0];
+        $ownerFolder = $this->rootFolder->getUserFolder($share->getShareOwner());
+        $userPath = $userFolder->getRelativePath($userNode->getPath());
+        $ownerPath = $ownerFolder->getRelativePath($node->getPath());
+
+        $parameters = [$userPath];
+
+        if ($share->getShareType() === \OCP\Share::SHARE_TYPE_EMAIL) {
+            if ($node instanceof \OCP\Files\File) {
+                $subject = Downloads::SUBJECT_SHARED_FILE_BY_EMAIL_DOWNLOADED;
+            } else {
+                $subject = Downloads::SUBJECT_SHARED_FOLDER_BY_EMAIL_DOWNLOADED;
+            }
+            $parameters[] = $share->getSharedWith();
+        } else {
+            if ($node instanceof \OCP\Files\File) {
+                $subject = Downloads::SUBJECT_PUBLIC_SHARED_FILE_DOWNLOADED;
+            } else {
+                $subject = Downloads::SUBJECT_PUBLIC_SHARED_FOLDER_DOWNLOADED;
+            }
+        }
+
+        $this->publishActivity($subject, $parameters, $share->getSharedBy(), $fileId, $userPath);
+
+        if ($share->getShareOwner() !== $share->getSharedBy()) {
+            $parameters[0] = $ownerPath;
+            $this->publishActivity($subject, $parameters, $share->getShareOwner(), $fileId, $ownerPath);
+        }
+    }
+
+    /**
+     * publish activity
+     *
+     * @param string $subject
+     * @param array $parameters
+     * @param string $affectedUser
+     * @param int $fileId
+     * @param string $filePath
+     */
+    protected function publishActivity($subject,
+                                        array $parameters,
+                                        $affectedUser,
+                                        $fileId,
+                                        $filePath) {
+
+        $event = $this->activityManager->generateEvent();
+        $event->setApp('files_sharing')
+            ->setType('public_links')
+            ->setSubject($subject, $parameters)
+            ->setAffectedUser($affectedUser)
+            ->setObject('files', $fileId, $filePath);
+        $this->activityManager->publish($event);
+    }
 
 
 }

Spacing +6 added lines, -6 removed lines

@@ -229,7 +229,7 @@ 
 
 	protected function authSucceeded() {
 		// For share this was always set so it is still used in other apps
-		$this->session->set('public_link_authenticated', (string)$this->share->getId());
+		$this->session->set('public_link_authenticated', (string) $this->share->getId());
 	}
 
 	protected function authFailed() {
@@ -250,7 +250,7 @@ 
 		$itemType = $itemSource = $uidOwner = '';
 		$token = $share;
 		$exception = null;
-		if($share instanceof \OCP\Share\IShare) {
+		if ($share instanceof \OCP\Share\IShare) {
 			try {
 				$token = $share->getToken();
 				$uidOwner = $share->getSharedBy();
@@ -269,7 +269,7 @@ 
 			'errorCode' => $errorCode,
 			'errorMessage' => $errorMessage,
 		]);
-		if(!is_null($exception)) {
+		if (!is_null($exception)) {
 			throw $exception;
 		}
 	}
@@ -483,7 +483,7 @@ 
 
 		// OpenGraph Support: http://ogp.me/
 		\OCP\Util::addHeader('meta', ['property' => "og:title", 'content' => $shareTmpl['filename']]);
-		\OCP\Util::addHeader('meta', ['property' => "og:description", 'content' => $this->defaults->getName() . ($this->defaults->getSlogan() !== '' ? ' - ' . $this->defaults->getSlogan() : '')]);
+		\OCP\Util::addHeader('meta', ['property' => "og:description", 'content' => $this->defaults->getName().($this->defaults->getSlogan() !== '' ? ' - '.$this->defaults->getSlogan() : '')]);
 		\OCP\Util::addHeader('meta', ['property' => "og:site_name", 'content' => $this->defaults->getName()]);
 		\OCP\Util::addHeader('meta', ['property' => "og:url", 'content' => $shareTmpl['shareUrl']]);
 		\OCP\Util::addHeader('meta', ['property' => "og:type", 'content' => "object"]);
@@ -553,7 +553,7 @@ 
 
 		$share = $this->shareManager->getShareByToken($token);
 
-		if(!($share->getPermissions() & \OCP\Constants::PERMISSION_READ)) {
+		if (!($share->getPermissions() & \OCP\Constants::PERMISSION_READ)) {
 			return new \OCP\AppFramework\Http\DataResponse('Share is read-only');
 		}
 
@@ -636,7 +636,7 @@ 
 
 		$this->emitAccessShareHook($share);
 
-		$server_params = [ 'head' => $this->request->getMethod() === 'HEAD' ];
+		$server_params = ['head' => $this->request->getMethod() === 'HEAD'];
 
 		/**
 		 * Http range requests support

apps/files_external/templates/settings.php

Indentation +56 added lines, -56 removed lines

@@ -1,51 +1,51 @@ 
 <?php
-	use \OCA\Files_External\Lib\Backend\Backend;
+    use \OCA\Files_External\Lib\Backend\Backend;
 use \OCA\Files_External\Lib\Auth\AuthMechanism;
 use \OCA\Files_External\Lib\DefinitionParameter;
 use \OCA\Files_External\Service\BackendService;
 
 $canCreateMounts = $_['visibilityType'] === BackendService::VISIBILITY_ADMIN || $_['allowUserMounting'];
 
-	$l->t("Enable encryption");
-	$l->t("Enable previews");
-	$l->t("Enable sharing");
-	$l->t("Check for changes");
-	$l->t("Never");
-	$l->t("Once every direct access");
-	$l->t('Read only');
+    $l->t("Enable encryption");
+    $l->t("Enable previews");
+    $l->t("Enable sharing");
+    $l->t("Check for changes");
+    $l->t("Never");
+    $l->t("Once every direct access");
+    $l->t('Read only');
 
-	script('files_external', [
-		'settings',
-		'templates'
-	]);
-	style('files_external', 'settings');
+    script('files_external', [
+        'settings',
+        'templates'
+    ]);
+    style('files_external', 'settings');
 
-	// load custom JS
-	foreach ($_['backends'] as $backend) {
-		/** @var Backend $backend */
-		$scripts = $backend->getCustomJs();
-		foreach ($scripts as $script) {
-			script('files_external', $script);
-		}
-	}
-	foreach ($_['authMechanisms'] as $authMechanism) {
-		/** @var AuthMechanism $authMechanism */
-		$scripts = $authMechanism->getCustomJs();
-		foreach ($scripts as $script) {
-			script('files_external', $script);
-		}
-	}
+    // load custom JS
+    foreach ($_['backends'] as $backend) {
+        /** @var Backend $backend */
+        $scripts = $backend->getCustomJs();
+        foreach ($scripts as $script) {
+            script('files_external', $script);
+        }
+    }
+    foreach ($_['authMechanisms'] as $authMechanism) {
+        /** @var AuthMechanism $authMechanism */
+        $scripts = $authMechanism->getCustomJs();
+        foreach ($scripts as $script) {
+            script('files_external', $script);
+        }
+    }
 
-	function writeParameterInput($parameter, $options, $classes = []) {
-		$value = '';
-		if (isset($options[$parameter->getName()])) {
-			$value = $options[$parameter->getName()];
-		}
-		$placeholder = $parameter->getText();
-		$is_optional = $parameter->isFlagSet(DefinitionParameter::FLAG_OPTIONAL);
+    function writeParameterInput($parameter, $options, $classes = []) {
+        $value = '';
+        if (isset($options[$parameter->getName()])) {
+            $value = $options[$parameter->getName()];
+        }
+        $placeholder = $parameter->getText();
+        $is_optional = $parameter->isFlagSet(DefinitionParameter::FLAG_OPTIONAL);
 
-		switch ($parameter->getType()) {
-		case DefinitionParameter::VALUE_PASSWORD: ?>
+        switch ($parameter->getType()) {
+        case DefinitionParameter::VALUE_PASSWORD: ?>
 			<?php if ($is_optional) { $classes[] = 'optional'; } ?>
 			<input type="password"
 				<?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
@@ -54,8 +54,8 @@ 
 				placeholder="<?php p($placeholder); ?>"
 			/>
 			<?php
-			break;
-		case DefinitionParameter::VALUE_BOOLEAN: ?>
+            break;
+        case DefinitionParameter::VALUE_BOOLEAN: ?>
 			<?php $checkboxId = uniqid("checkbox_"); ?>
 			<div>
 			<label>
@@ -69,16 +69,16 @@ 
 			</label>
 			</div>
 			<?php
-			break;
-		case DefinitionParameter::VALUE_HIDDEN: ?>
+            break;
+        case DefinitionParameter::VALUE_HIDDEN: ?>
 			<input type="hidden"
 				<?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
 				data-parameter="<?php p($parameter->getName()); ?>"
 				value="<?php p($value); ?>"
 			/>
 			<?php
-			break;
-		default: ?>
+            break;
+        default: ?>
 			<?php if ($is_optional) { $classes[] = 'optional'; } ?>
 			<input type="text"
 				<?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?>
@@ -87,8 +87,8 @@ 
 				placeholder="<?php p($placeholder); ?>"
 			/>
 			<?php
-		}
-	}
+        }
+    }
 ?>
 
 <div id="emptycontent" class="hidden">
@@ -134,13 +134,13 @@ 
 							<?php p($l->t('Add storage')); ?>
 						</option>
 						<?php
-							$sortedBackends = array_filter($_['backends'], function ($backend) use ($_) {
-								return $backend->isVisibleFor($_['visibilityType']);
-							});
-							uasort($sortedBackends, function ($a, $b) {
-								return strcasecmp($a->getText(), $b->getText());
-							});
-						?>
+                            $sortedBackends = array_filter($_['backends'], function ($backend) use ($_) {
+                                return $backend->isVisibleFor($_['visibilityType']);
+                            });
+                            uasort($sortedBackends, function ($a, $b) {
+                                return strcasecmp($a->getText(), $b->getText());
+                            });
+                        ?>
 						<?php foreach ($sortedBackends as $backend): ?>
 							<?php if ($backend->getDeprecateTo()) continue; // ignore deprecated backends?>
 							<option value="<?php p($backend->getIdentifier()); ?>"><?php p($backend->getText()); ?></option>
@@ -172,10 +172,10 @@ 
 
 		<p id="userMountingBackends"<?php if (!$_['allowUserMounting']): ?> class="hidden"<?php endif; ?>>
 			<?php
-				$userBackends = array_filter($_['backends'], function ($backend) {
-					return $backend->isAllowedVisibleFor(BackendService::VISIBILITY_PERSONAL);
-				});
-			?>
+                $userBackends = array_filter($_['backends'], function ($backend) {
+                    return $backend->isAllowedVisibleFor(BackendService::VISIBILITY_PERSONAL);
+                });
+            ?>
 			<?php $i = 0; foreach ($userBackends as $backend): ?>
 				<?php if ($deprecateTo = $backend->getDeprecateTo()): ?>
 					<input type="hidden" id="allowUserMountingBackends<?php p($i); ?>" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" data-deprecate-to="<?php p($deprecateTo->getIdentifier()); ?>" />

Braces +24 added lines, -6 removed lines

@@ -100,7 +100,10 @@ 
 	<h2 class="inlineblock" data-anchor-name="external-storage"><?php p($l->t('External storages')); ?></h2>
 	<a target="_blank" rel="noreferrer" class="icon-info" title="<?php p($l->t('Open documentation'));?>" href="<?php p(link_to_docs('admin-external-storage')); ?>"></a>
 	<p class="settings-hint"><?php p($l->t('External storage enables you to mount external storage services and devices as secondary Nextcloud storage devices. You may also allow users to mount their own external storage services.')); ?></p>
-	<?php if (isset($_['dependencies']) and ($_['dependencies'] !== '') and $canCreateMounts) print_unescaped(''.$_['dependencies'].''); ?>
+	<?php if (isset($_['dependencies']) and ($_['dependencies'] !== '') and $canCreateMounts) {
+    print_unescaped(''.$_['dependencies'].'');
+}
+?>
 	<table id="externalStorage" class="grid" data-admin='<?php print_unescaped(json_encode($_['visibilityType'] === BackendService::VISIBILITY_ADMIN)); ?>'>
 		<thead>
 			<tr>
@@ -109,7 +112,10 @@ 
 				<th><?php p($l->t('External storage')); ?></th>
 				<th><?php p($l->t('Authentication')); ?></th>
 				<th><?php p($l->t('Configuration')); ?></th>
-				<?php if ($_['visibilityType'] === BackendService::VISIBILITY_ADMIN) print_unescaped('<th>'.$l->t('Available for').'</th>'); ?>
+				<?php if ($_['visibilityType'] === BackendService::VISIBILITY_ADMIN) {
+    print_unescaped('<th>'.$l->t('Available for').'</th>');
+}
+?>
 				<th>&nbsp;</th>
 				<th>&nbsp;</th>
 				<th>&nbsp;</th>
@@ -142,7 +148,10 @@ 
 							});
 						?>
 						<?php foreach ($sortedBackends as $backend): ?>
-							<?php if ($backend->getDeprecateTo()) continue; // ignore deprecated backends?>
+							<?php if ($backend->getDeprecateTo()) {
+    continue;
+}
+// ignore deprecated backends?>
 							<option value="<?php p($backend->getIdentifier()); ?>"><?php p($backend->getText()); ?></option>
 						<?php endforeach; ?>
 					</select>
@@ -167,7 +176,10 @@ 
 
 	<?php if ($_['visibilityType'] === BackendService::VISIBILITY_ADMIN): ?>
 		<input type="checkbox" name="allowUserMounting" id="allowUserMounting" class="checkbox"
-			value="1" <?php if ($_['allowUserMounting']) print_unescaped(' checked="checked"'); ?> />
+			value="1" <?php if ($_['allowUserMounting']) {
+    print_unescaped(' checked="checked"');
+}
+?> />
 		<label for="allowUserMounting"><?php p($l->t('Allow users to mount external storage')); ?></label> <span id="userMountingMsg" class="msg"></span>
 
 		<p id="userMountingBackends"<?php if (!$_['allowUserMounting']): ?> class="hidden"<?php endif; ?>>
@@ -179,8 +191,14 @@ 
 			<?php $i = 0; foreach ($userBackends as $backend): ?>
 				<?php if ($deprecateTo = $backend->getDeprecateTo()): ?>
 					<input type="hidden" id="allowUserMountingBackends<?php p($i); ?>" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" data-deprecate-to="<?php p($deprecateTo->getIdentifier()); ?>" />
-				<?php else: ?>
-					<input type="checkbox" id="allowUserMountingBackends<?php p($i); ?>" class="checkbox" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" <?php if ($backend->isVisibleFor(BackendService::VISIBILITY_PERSONAL)) print_unescaped(' checked="checked"'); ?> />
+				<?php else {
+    : ?>
+					<input type="checkbox" id="allowUserMountingBackends<?php p($i);
+}
+?>" class="checkbox" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" <?php if ($backend->isVisibleFor(BackendService::VISIBILITY_PERSONAL)) {
+    print_unescaped(' checked="checked"');
+}
+?> />
 					<label for="allowUserMountingBackends<?php p($i); ?>"><?php p($backend->getText()); ?></label> <br />
 				<?php endif; ?>
 				<?php $i++; ?>

apps/files_external/lib/Lib/Storage/SFTP.php

Indentation +437 added lines, -437 removed lines

@@ -46,441 +46,441 @@
  * provide access to SFTP servers.
  */
 class SFTP extends \OC\Files\Storage\Common {
-	private $host;
-	private $user;
-	private $root;
-	private $port = 22;
-
-	private $auth = [];
-
-	/**
-	 * @var \phpseclib\Net\SFTP
-	 */
-	protected $client;
-
-	/**
-	 * @param string $host protocol://server:port
-	 * @return array [$server, $port]
-	 */
-	private function splitHost($host) {
-		$input = $host;
-		if (strpos($host, '://') === false) {
-			// add a protocol to fix parse_url behavior with ipv6
-			$host = 'http://' . $host;
-		}
-
-		$parsed = parse_url($host);
-		if(is_array($parsed) && isset($parsed['port'])) {
-			return [$parsed['host'], $parsed['port']];
-		} else if (is_array($parsed)) {
-			return [$parsed['host'], 22];
-		} else {
-			return [$input, 22];
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function __construct($params) {
-		// Register sftp://
-		Stream::register();
-
-		$parsedHost =  $this->splitHost($params['host']);
-
-		$this->host = $parsedHost[0];
-		$this->port = $parsedHost[1];
-
-		if (!isset($params['user'])) {
-			throw new \UnexpectedValueException('no authentication parameters specified');
-		}
-		$this->user = $params['user'];
-
-		if (isset($params['public_key_auth'])) {
-			$this->auth[] = $params['public_key_auth'];
-		}
-		if (isset($params['password']) && $params['password'] !== '') {
-			$this->auth[] = $params['password'];
-		}
-
-		if ($this->auth === []) {
-			throw new \UnexpectedValueException('no authentication parameters specified');
-		}
-
-		$this->root
-			= isset($params['root']) ? $this->cleanPath($params['root']) : '/';
-
-		$this->root = '/' . ltrim($this->root, '/');
-		$this->root = rtrim($this->root, '/') . '/';
-	}
-
-	/**
-	 * Returns the connection.
-	 *
-	 * @return \phpseclib\Net\SFTP connected client instance
-	 * @throws \Exception when the connection failed
-	 */
-	public function getConnection() {
-		if (!is_null($this->client)) {
-			return $this->client;
-		}
-
-		$hostKeys = $this->readHostKeys();
-		$this->client = new \phpseclib\Net\SFTP($this->host, $this->port);
-
-		// The SSH Host Key MUST be verified before login().
-		$currentHostKey = $this->client->getServerPublicHostKey();
-		if (array_key_exists($this->host, $hostKeys)) {
-			if ($hostKeys[$this->host] !== $currentHostKey) {
-				throw new \Exception('Host public key does not match known key');
-			}
-		} else {
-			$hostKeys[$this->host] = $currentHostKey;
-			$this->writeHostKeys($hostKeys);
-		}
-
-		$login = false;
-		foreach ($this->auth as $auth) {
-			$login = $this->client->login($this->user, $auth);
-			if ($login === true) {
-				break;
-			}
-		}
-
-		if ($login === false) {
-			throw new \Exception('Login failed');
-		}
-		return $this->client;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function test() {
-		if (
-			!isset($this->host)
-			|| !isset($this->user)
-		) {
-			return false;
-		}
-		return $this->getConnection()->nlist() !== false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getId() {
-		$id = 'sftp::' . $this->user . '@' . $this->host;
-		if ($this->port !== 22) {
-			$id .= ':' . $this->port;
-		}
-		// note: this will double the root slash,
-		// we should not change it to keep compatible with
-		// old storage ids
-		$id .= '/' . $this->root;
-		return $id;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getHost() {
-		return $this->host;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getRoot() {
-		return $this->root;
-	}
-
-	/**
-	 * @return mixed
-	 */
-	public function getUser() {
-		return $this->user;
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	private function absPath($path) {
-		return $this->root . $this->cleanPath($path);
-	}
-
-	/**
-	 * @return string|false
-	 */
-	private function hostKeysPath() {
-		try {
-			$storage_view = \OCP\Files::getStorage('files_external');
-			if ($storage_view) {
-				return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') .
-					$storage_view->getAbsolutePath('') .
-					'ssh_hostKeys';
-			}
-		} catch (\Exception $e) {
-		}
-		return false;
-	}
-
-	/**
-	 * @param $keys
-	 * @return bool
-	 */
-	protected function writeHostKeys($keys) {
-		try {
-			$keyPath = $this->hostKeysPath();
-			if ($keyPath && file_exists($keyPath)) {
-				$fp = fopen($keyPath, 'w');
-				foreach ($keys as $host => $key) {
-					fwrite($fp, $host . '::' . $key . "\n");
-				}
-				fclose($fp);
-				return true;
-			}
-		} catch (\Exception $e) {
-		}
-		return false;
-	}
-
-	/**
-	 * @return array
-	 */
-	protected function readHostKeys() {
-		try {
-			$keyPath = $this->hostKeysPath();
-			if (file_exists($keyPath)) {
-				$hosts = [];
-				$keys = [];
-				$lines = file($keyPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
-				if ($lines) {
-					foreach ($lines as $line) {
-						$hostKeyArray = explode("::", $line, 2);
-						if (count($hostKeyArray) === 2) {
-							$hosts[] = $hostKeyArray[0];
-							$keys[] = $hostKeyArray[1];
-						}
-					}
-					return array_combine($hosts, $keys);
-				}
-			}
-		} catch (\Exception $e) {
-		}
-		return [];
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function mkdir($path) {
-		try {
-			return $this->getConnection()->mkdir($this->absPath($path));
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rmdir($path) {
-		try {
-			$result = $this->getConnection()->delete($this->absPath($path), true);
-			// workaround: stray stat cache entry when deleting empty folders
-			// see https://github.com/phpseclib/phpseclib/issues/706
-			$this->getConnection()->clearStatCache();
-			return $result;
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function opendir($path) {
-		try {
-			$list = $this->getConnection()->nlist($this->absPath($path));
-			if ($list === false) {
-				return false;
-			}
-
-			$id = md5('sftp:' . $path);
-			$dirStream = [];
-			foreach($list as $file) {
-				if ($file !== '.' && $file !== '..') {
-					$dirStream[] = $file;
-				}
-			}
-			return IteratorDirectory::wrap($dirStream);
-		} catch(\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function filetype($path) {
-		try {
-			$stat = $this->getConnection()->stat($this->absPath($path));
-			if ((int) $stat['type'] === NET_SFTP_TYPE_REGULAR) {
-				return 'file';
-			}
-
-			if ((int) $stat['type'] === NET_SFTP_TYPE_DIRECTORY) {
-				return 'dir';
-			}
-		} catch (\Exception $e) {
-
-		}
-		return false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function file_exists($path) {
-		try {
-			return $this->getConnection()->stat($this->absPath($path)) !== false;
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function unlink($path) {
-		try {
-			return $this->getConnection()->delete($this->absPath($path), true);
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function fopen($path, $mode) {
-		try {
-			$absPath = $this->absPath($path);
-			switch($mode) {
-				case 'r':
-				case 'rb':
-					if (!$this->file_exists($path)) {
-						return false;
-					}
-					SFTPReadStream::register();
-					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					$handle = fopen('sftpread://' . trim($absPath, '/'), 'r', false, $context);
-					return RetryWrapper::wrap($handle);
-				case 'w':
-				case 'wb':
-					SFTPWriteStream::register();
-					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					return fopen('sftpwrite://' . trim($absPath, '/'), 'w', false, $context);
-				case 'a':
-				case 'ab':
-				case 'r+':
-				case 'w+':
-				case 'wb+':
-				case 'a+':
-				case 'x':
-				case 'x+':
-				case 'c':
-				case 'c+':
-					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					$handle = fopen($this->constructUrl($path), $mode, false, $context);
-					return RetryWrapper::wrap($handle);
-			}
-		} catch (\Exception $e) {
-		}
-		return false;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function touch($path, $mtime=null) {
-		try {
-			if (!is_null($mtime)) {
-				return false;
-			}
-			if (!$this->file_exists($path)) {
-				$this->getConnection()->put($this->absPath($path), '');
-			} else {
-				return false;
-			}
-		} catch (\Exception $e) {
-			return false;
-		}
-		return true;
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $target
-	 * @throws \Exception
-	 */
-	public function getFile($path, $target) {
-		$this->getConnection()->get($path, $target);
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $target
-	 * @throws \Exception
-	 */
-	public function uploadFile($path, $target) {
-		$this->getConnection()->put($target, $path, NET_SFTP_LOCAL_FILE);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rename($source, $target) {
-		try {
-			if ($this->file_exists($target)) {
-				$this->unlink($target);
-			}
-			return $this->getConnection()->rename(
-				$this->absPath($source),
-				$this->absPath($target)
-			);
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function stat($path) {
-		try {
-			$stat = $this->getConnection()->stat($this->absPath($path));
-
-			$mtime = $stat ? $stat['mtime'] : -1;
-			$size = $stat ? $stat['size'] : 0;
-
-			return ['mtime' => $mtime, 'size' => $size, 'ctime' => -1];
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	public function constructUrl($path) {
-		// Do not pass the password here. We want to use the Net_SFTP object
-		// supplied via stream context or fail. We only supply username and
-		// hostname because this might show up in logs (they are not used).
-		$url = 'sftp://' . urlencode($this->user) . '@' . $this->host . ':' . $this->port . $this->root . $path;
-		return $url;
-	}
+    private $host;
+    private $user;
+    private $root;
+    private $port = 22;
+
+    private $auth = [];
+
+    /**
+     * @var \phpseclib\Net\SFTP
+     */
+    protected $client;
+
+    /**
+     * @param string $host protocol://server:port
+     * @return array [$server, $port]
+     */
+    private function splitHost($host) {
+        $input = $host;
+        if (strpos($host, '://') === false) {
+            // add a protocol to fix parse_url behavior with ipv6
+            $host = 'http://' . $host;
+        }
+
+        $parsed = parse_url($host);
+        if(is_array($parsed) && isset($parsed['port'])) {
+            return [$parsed['host'], $parsed['port']];
+        } else if (is_array($parsed)) {
+            return [$parsed['host'], 22];
+        } else {
+            return [$input, 22];
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($params) {
+        // Register sftp://
+        Stream::register();
+
+        $parsedHost =  $this->splitHost($params['host']);
+
+        $this->host = $parsedHost[0];
+        $this->port = $parsedHost[1];
+
+        if (!isset($params['user'])) {
+            throw new \UnexpectedValueException('no authentication parameters specified');
+        }
+        $this->user = $params['user'];
+
+        if (isset($params['public_key_auth'])) {
+            $this->auth[] = $params['public_key_auth'];
+        }
+        if (isset($params['password']) && $params['password'] !== '') {
+            $this->auth[] = $params['password'];
+        }
+
+        if ($this->auth === []) {
+            throw new \UnexpectedValueException('no authentication parameters specified');
+        }
+
+        $this->root
+            = isset($params['root']) ? $this->cleanPath($params['root']) : '/';
+
+        $this->root = '/' . ltrim($this->root, '/');
+        $this->root = rtrim($this->root, '/') . '/';
+    }
+
+    /**
+     * Returns the connection.
+     *
+     * @return \phpseclib\Net\SFTP connected client instance
+     * @throws \Exception when the connection failed
+     */
+    public function getConnection() {
+        if (!is_null($this->client)) {
+            return $this->client;
+        }
+
+        $hostKeys = $this->readHostKeys();
+        $this->client = new \phpseclib\Net\SFTP($this->host, $this->port);
+
+        // The SSH Host Key MUST be verified before login().
+        $currentHostKey = $this->client->getServerPublicHostKey();
+        if (array_key_exists($this->host, $hostKeys)) {
+            if ($hostKeys[$this->host] !== $currentHostKey) {
+                throw new \Exception('Host public key does not match known key');
+            }
+        } else {
+            $hostKeys[$this->host] = $currentHostKey;
+            $this->writeHostKeys($hostKeys);
+        }
+
+        $login = false;
+        foreach ($this->auth as $auth) {
+            $login = $this->client->login($this->user, $auth);
+            if ($login === true) {
+                break;
+            }
+        }
+
+        if ($login === false) {
+            throw new \Exception('Login failed');
+        }
+        return $this->client;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function test() {
+        if (
+            !isset($this->host)
+            || !isset($this->user)
+        ) {
+            return false;
+        }
+        return $this->getConnection()->nlist() !== false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getId() {
+        $id = 'sftp::' . $this->user . '@' . $this->host;
+        if ($this->port !== 22) {
+            $id .= ':' . $this->port;
+        }
+        // note: this will double the root slash,
+        // we should not change it to keep compatible with
+        // old storage ids
+        $id .= '/' . $this->root;
+        return $id;
+    }
+
+    /**
+     * @return string
+     */
+    public function getHost() {
+        return $this->host;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRoot() {
+        return $this->root;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getUser() {
+        return $this->user;
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    private function absPath($path) {
+        return $this->root . $this->cleanPath($path);
+    }
+
+    /**
+     * @return string|false
+     */
+    private function hostKeysPath() {
+        try {
+            $storage_view = \OCP\Files::getStorage('files_external');
+            if ($storage_view) {
+                return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') .
+                    $storage_view->getAbsolutePath('') .
+                    'ssh_hostKeys';
+            }
+        } catch (\Exception $e) {
+        }
+        return false;
+    }
+
+    /**
+     * @param $keys
+     * @return bool
+     */
+    protected function writeHostKeys($keys) {
+        try {
+            $keyPath = $this->hostKeysPath();
+            if ($keyPath && file_exists($keyPath)) {
+                $fp = fopen($keyPath, 'w');
+                foreach ($keys as $host => $key) {
+                    fwrite($fp, $host . '::' . $key . "\n");
+                }
+                fclose($fp);
+                return true;
+            }
+        } catch (\Exception $e) {
+        }
+        return false;
+    }
+
+    /**
+     * @return array
+     */
+    protected function readHostKeys() {
+        try {
+            $keyPath = $this->hostKeysPath();
+            if (file_exists($keyPath)) {
+                $hosts = [];
+                $keys = [];
+                $lines = file($keyPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+                if ($lines) {
+                    foreach ($lines as $line) {
+                        $hostKeyArray = explode("::", $line, 2);
+                        if (count($hostKeyArray) === 2) {
+                            $hosts[] = $hostKeyArray[0];
+                            $keys[] = $hostKeyArray[1];
+                        }
+                    }
+                    return array_combine($hosts, $keys);
+                }
+            }
+        } catch (\Exception $e) {
+        }
+        return [];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function mkdir($path) {
+        try {
+            return $this->getConnection()->mkdir($this->absPath($path));
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rmdir($path) {
+        try {
+            $result = $this->getConnection()->delete($this->absPath($path), true);
+            // workaround: stray stat cache entry when deleting empty folders
+            // see https://github.com/phpseclib/phpseclib/issues/706
+            $this->getConnection()->clearStatCache();
+            return $result;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function opendir($path) {
+        try {
+            $list = $this->getConnection()->nlist($this->absPath($path));
+            if ($list === false) {
+                return false;
+            }
+
+            $id = md5('sftp:' . $path);
+            $dirStream = [];
+            foreach($list as $file) {
+                if ($file !== '.' && $file !== '..') {
+                    $dirStream[] = $file;
+                }
+            }
+            return IteratorDirectory::wrap($dirStream);
+        } catch(\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function filetype($path) {
+        try {
+            $stat = $this->getConnection()->stat($this->absPath($path));
+            if ((int) $stat['type'] === NET_SFTP_TYPE_REGULAR) {
+                return 'file';
+            }
+
+            if ((int) $stat['type'] === NET_SFTP_TYPE_DIRECTORY) {
+                return 'dir';
+            }
+        } catch (\Exception $e) {
+
+        }
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function file_exists($path) {
+        try {
+            return $this->getConnection()->stat($this->absPath($path)) !== false;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function unlink($path) {
+        try {
+            return $this->getConnection()->delete($this->absPath($path), true);
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fopen($path, $mode) {
+        try {
+            $absPath = $this->absPath($path);
+            switch($mode) {
+                case 'r':
+                case 'rb':
+                    if (!$this->file_exists($path)) {
+                        return false;
+                    }
+                    SFTPReadStream::register();
+                    $context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
+                    $handle = fopen('sftpread://' . trim($absPath, '/'), 'r', false, $context);
+                    return RetryWrapper::wrap($handle);
+                case 'w':
+                case 'wb':
+                    SFTPWriteStream::register();
+                    $context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
+                    return fopen('sftpwrite://' . trim($absPath, '/'), 'w', false, $context);
+                case 'a':
+                case 'ab':
+                case 'r+':
+                case 'w+':
+                case 'wb+':
+                case 'a+':
+                case 'x':
+                case 'x+':
+                case 'c':
+                case 'c+':
+                    $context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
+                    $handle = fopen($this->constructUrl($path), $mode, false, $context);
+                    return RetryWrapper::wrap($handle);
+            }
+        } catch (\Exception $e) {
+        }
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function touch($path, $mtime=null) {
+        try {
+            if (!is_null($mtime)) {
+                return false;
+            }
+            if (!$this->file_exists($path)) {
+                $this->getConnection()->put($this->absPath($path), '');
+            } else {
+                return false;
+            }
+        } catch (\Exception $e) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * @param string $path
+     * @param string $target
+     * @throws \Exception
+     */
+    public function getFile($path, $target) {
+        $this->getConnection()->get($path, $target);
+    }
+
+    /**
+     * @param string $path
+     * @param string $target
+     * @throws \Exception
+     */
+    public function uploadFile($path, $target) {
+        $this->getConnection()->put($target, $path, NET_SFTP_LOCAL_FILE);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rename($source, $target) {
+        try {
+            if ($this->file_exists($target)) {
+                $this->unlink($target);
+            }
+            return $this->getConnection()->rename(
+                $this->absPath($source),
+                $this->absPath($target)
+            );
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function stat($path) {
+        try {
+            $stat = $this->getConnection()->stat($this->absPath($path));
+
+            $mtime = $stat ? $stat['mtime'] : -1;
+            $size = $stat ? $stat['size'] : 0;
+
+            return ['mtime' => $mtime, 'size' => $size, 'ctime' => -1];
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    public function constructUrl($path) {
+        // Do not pass the password here. We want to use the Net_SFTP object
+        // supplied via stream context or fail. We only supply username and
+        // hostname because this might show up in logs (they are not used).
+        $url = 'sftp://' . urlencode($this->user) . '@' . $this->host . ':' . $this->port . $this->root . $path;
+        return $url;
+    }
 }

Spacing +20 added lines, -20 removed lines

@@ -66,11 +66,11 @@ 
 		$input = $host;
 		if (strpos($host, '://') === false) {
 			// add a protocol to fix parse_url behavior with ipv6
-			$host = 'http://' . $host;
+			$host = 'http://'.$host;
 		}
 
 		$parsed = parse_url($host);
-		if(is_array($parsed) && isset($parsed['port'])) {
+		if (is_array($parsed) && isset($parsed['port'])) {
 			return [$parsed['host'], $parsed['port']];
 		} else if (is_array($parsed)) {
 			return [$parsed['host'], 22];
@@ -86,7 +86,7 @@ 
 		// Register sftp://
 		Stream::register();
 
-		$parsedHost =  $this->splitHost($params['host']);
+		$parsedHost = $this->splitHost($params['host']);
 
 		$this->host = $parsedHost[0];
 		$this->port = $parsedHost[1];
@@ -110,8 +110,8 @@ 
 		$this->root
 			= isset($params['root']) ? $this->cleanPath($params['root']) : '/';
 
-		$this->root = '/' . ltrim($this->root, '/');
-		$this->root = rtrim($this->root, '/') . '/';
+		$this->root = '/'.ltrim($this->root, '/');
+		$this->root = rtrim($this->root, '/').'/';
 	}
 
 	/**
@@ -170,14 +170,14 @@ 
 	 * {@inheritdoc}
 	 */
 	public function getId() {
-		$id = 'sftp::' . $this->user . '@' . $this->host;
+		$id = 'sftp::'.$this->user.'@'.$this->host;
 		if ($this->port !== 22) {
-			$id .= ':' . $this->port;
+			$id .= ':'.$this->port;
 		}
 		// note: this will double the root slash,
 		// we should not change it to keep compatible with
 		// old storage ids
-		$id .= '/' . $this->root;
+		$id .= '/'.$this->root;
 		return $id;
 	}
 
@@ -207,7 +207,7 @@ 
 	 * @return string
 	 */
 	private function absPath($path) {
-		return $this->root . $this->cleanPath($path);
+		return $this->root.$this->cleanPath($path);
 	}
 
 	/**
@@ -217,8 +217,8 @@ 
 		try {
 			$storage_view = \OCP\Files::getStorage('files_external');
 			if ($storage_view) {
-				return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') .
-					$storage_view->getAbsolutePath('') .
+				return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').
+					$storage_view->getAbsolutePath('').
 					'ssh_hostKeys';
 			}
 		} catch (\Exception $e) {
@@ -236,7 +236,7 @@ 
 			if ($keyPath && file_exists($keyPath)) {
 				$fp = fopen($keyPath, 'w');
 				foreach ($keys as $host => $key) {
-					fwrite($fp, $host . '::' . $key . "\n");
+					fwrite($fp, $host.'::'.$key."\n");
 				}
 				fclose($fp);
 				return true;
@@ -308,15 +308,15 @@ 
 				return false;
 			}
 
-			$id = md5('sftp:' . $path);
+			$id = md5('sftp:'.$path);
 			$dirStream = [];
-			foreach($list as $file) {
+			foreach ($list as $file) {
 				if ($file !== '.' && $file !== '..') {
 					$dirStream[] = $file;
 				}
 			}
 			return IteratorDirectory::wrap($dirStream);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			return false;
 		}
 	}
@@ -368,7 +368,7 @@ 
 	public function fopen($path, $mode) {
 		try {
 			$absPath = $this->absPath($path);
-			switch($mode) {
+			switch ($mode) {
 				case 'r':
 				case 'rb':
 					if (!$this->file_exists($path)) {
@@ -376,13 +376,13 @@ 
 					}
 					SFTPReadStream::register();
 					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					$handle = fopen('sftpread://' . trim($absPath, '/'), 'r', false, $context);
+					$handle = fopen('sftpread://'.trim($absPath, '/'), 'r', false, $context);
 					return RetryWrapper::wrap($handle);
 				case 'w':
 				case 'wb':
 					SFTPWriteStream::register();
 					$context = stream_context_create(['sftp' => ['session' => $this->getConnection()]]);
-					return fopen('sftpwrite://' . trim($absPath, '/'), 'w', false, $context);
+					return fopen('sftpwrite://'.trim($absPath, '/'), 'w', false, $context);
 				case 'a':
 				case 'ab':
 				case 'r+':
@@ -405,7 +405,7 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function touch($path, $mtime=null) {
+	public function touch($path, $mtime = null) {
 		try {
 			if (!is_null($mtime)) {
 				return false;
@@ -480,7 +480,7 @@ 
 		// Do not pass the password here. We want to use the Net_SFTP object
 		// supplied via stream context or fail. We only supply username and
 		// hostname because this might show up in logs (they are not used).
-		$url = 'sftp://' . urlencode($this->user) . '@' . $this->host . ':' . $this->port . $this->root . $path;
+		$url = 'sftp://'.urlencode($this->user).'@'.$this->host.':'.$this->port.$this->root.$path;
 		return $url;
 	}
 }