nextcloud / server

lib/public/Settings/IIconSection.php

Doc Comments +1 added lines

@@ -33,6 +33,7 @@
 	 *
 	 * @returns string
 	 * @since 12
+	 * @return string
 	 */
 	public function getIcon();
 }

Indentation +8 added lines, -8 removed lines

@@ -27,12 +27,12 @@
  * @since 12
  */
 interface IIconSection extends ISection {
-	/**
-	 * returns the relative path to an 16*16 icon describing the section.
-	 * e.g. '/core/img/places/files.svg'
-	 *
-	 * @returns string
-	 * @since 12
-	 */
-	public function getIcon();
+    /**
+     * returns the relative path to an 16*16 icon describing the section.
+     * e.g. '/core/img/places/files.svg'
+     *
+     * @returns string
+     * @since 12
+     */
+    public function getIcon();
 }

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

Doc Comments +3 added lines

@@ -139,6 +139,9 @@
 		return false;
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public function writeBack($tmpFile, $path) {
 		$this->uploadFile($tmpFile, $path);
 		unlink($tmpFile);

Braces +1 added lines, -2 removed lines

@@ -93,8 +93,7 @@
 	public function unlink($path) {
 		if ($this->is_dir($path)) {
 			return $this->rmdir($path);
-		}
-		else {
+		} else {
 			$url = $this->constructUrl($path);
 			$result = unlink($url);
 			clearstatcache(true, $url);

Indentation +109 added lines, -109 removed lines

@@ -38,122 +38,122 @@
 use Icewind\Streams\RetryWrapper;
 
 class FTP extends StreamWrapper{
-	private $password;
-	private $user;
-	private $host;
-	private $secure;
-	private $root;
+    private $password;
+    private $user;
+    private $host;
+    private $secure;
+    private $root;
 
-	private static $tempFiles=array();
+    private static $tempFiles=array();
 
-	public function __construct($params) {
-		if (isset($params['host']) && isset($params['user']) && isset($params['password'])) {
-			$this->host=$params['host'];
-			$this->user=$params['user'];
-			$this->password=$params['password'];
-			if (isset($params['secure'])) {
-				$this->secure = $params['secure'];
-			} else {
-				$this->secure = false;
-			}
-			$this->root=isset($params['root'])?$params['root']:'/';
-			if ( ! $this->root || $this->root[0]!=='/') {
-				$this->root='/'.$this->root;
-			}
-			if (substr($this->root, -1) !== '/') {
-				$this->root .= '/';
-			}
-		} else {
-			throw new \Exception('Creating FTP storage failed');
-		}
+    public function __construct($params) {
+        if (isset($params['host']) && isset($params['user']) && isset($params['password'])) {
+            $this->host=$params['host'];
+            $this->user=$params['user'];
+            $this->password=$params['password'];
+            if (isset($params['secure'])) {
+                $this->secure = $params['secure'];
+            } else {
+                $this->secure = false;
+            }
+            $this->root=isset($params['root'])?$params['root']:'/';
+            if ( ! $this->root || $this->root[0]!=='/') {
+                $this->root='/'.$this->root;
+            }
+            if (substr($this->root, -1) !== '/') {
+                $this->root .= '/';
+            }
+        } else {
+            throw new \Exception('Creating FTP storage failed');
+        }
 		
-	}
+    }
 
-	public function getId(){
-		return 'ftp::' . $this->user . '@' . $this->host . '/' . $this->root;
-	}
+    public function getId(){
+        return 'ftp::' . $this->user . '@' . $this->host . '/' . $this->root;
+    }
 
-	/**
-	 * construct the ftp url
-	 * @param string $path
-	 * @return string
-	 */
-	public function constructUrl($path) {
-		$url='ftp';
-		if ($this->secure) {
-			$url.='s';
-		}
-		$url.='://'.urlencode($this->user).':'.urlencode($this->password).'@'.$this->host.$this->root.$path;
-		return $url;
-	}
+    /**
+     * construct the ftp url
+     * @param string $path
+     * @return string
+     */
+    public function constructUrl($path) {
+        $url='ftp';
+        if ($this->secure) {
+            $url.='s';
+        }
+        $url.='://'.urlencode($this->user).':'.urlencode($this->password).'@'.$this->host.$this->root.$path;
+        return $url;
+    }
 
-	/**
-	 * Unlinks file or directory
-	 * @param string $path
-	 */
-	public function unlink($path) {
-		if ($this->is_dir($path)) {
-			return $this->rmdir($path);
-		}
-		else {
-			$url = $this->constructUrl($path);
-			$result = unlink($url);
-			clearstatcache(true, $url);
-			return $result;
-		}
-	}
-	public function fopen($path,$mode) {
-		switch($mode) {
-			case 'r':
-			case 'rb':
-			case 'w':
-			case 'wb':
-			case 'a':
-			case 'ab':
-				//these are supported by the wrapper
-				$context = stream_context_create(array('ftp' => array('overwrite' => true)));
-				$handle = fopen($this->constructUrl($path), $mode, false, $context);
-				return RetryWrapper::wrap($handle);
-			case 'r+':
-			case 'w+':
-			case 'wb+':
-			case 'a+':
-			case 'x':
-			case 'x+':
-			case 'c':
-			case 'c+':
-				//emulate these
-				if (strrpos($path, '.')!==false) {
-					$ext=substr($path, strrpos($path, '.'));
-				} else {
-					$ext='';
-				}
-				$tmpFile = \OC::$server->getTempManager()->getTemporaryFile();
-				if ($this->file_exists($path)) {
-					$this->getFile($path, $tmpFile);
-				}
-				$handle = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
-					$this->writeBack($tmpFile, $path);
-				});
-		}
-		return false;
-	}
+    /**
+     * Unlinks file or directory
+     * @param string $path
+     */
+    public function unlink($path) {
+        if ($this->is_dir($path)) {
+            return $this->rmdir($path);
+        }
+        else {
+            $url = $this->constructUrl($path);
+            $result = unlink($url);
+            clearstatcache(true, $url);
+            return $result;
+        }
+    }
+    public function fopen($path,$mode) {
+        switch($mode) {
+            case 'r':
+            case 'rb':
+            case 'w':
+            case 'wb':
+            case 'a':
+            case 'ab':
+                //these are supported by the wrapper
+                $context = stream_context_create(array('ftp' => array('overwrite' => true)));
+                $handle = fopen($this->constructUrl($path), $mode, false, $context);
+                return RetryWrapper::wrap($handle);
+            case 'r+':
+            case 'w+':
+            case 'wb+':
+            case 'a+':
+            case 'x':
+            case 'x+':
+            case 'c':
+            case 'c+':
+                //emulate these
+                if (strrpos($path, '.')!==false) {
+                    $ext=substr($path, strrpos($path, '.'));
+                } else {
+                    $ext='';
+                }
+                $tmpFile = \OC::$server->getTempManager()->getTemporaryFile();
+                if ($this->file_exists($path)) {
+                    $this->getFile($path, $tmpFile);
+                }
+                $handle = fopen($tmpFile, $mode);
+                return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
+                    $this->writeBack($tmpFile, $path);
+                });
+        }
+        return false;
+    }
 
-	public function writeBack($tmpFile, $path) {
-		$this->uploadFile($tmpFile, $path);
-		unlink($tmpFile);
-	}
+    public function writeBack($tmpFile, $path) {
+        $this->uploadFile($tmpFile, $path);
+        unlink($tmpFile);
+    }
 
-	/**
-	 * check if php-ftp is installed
-	 */
-	public static function checkDependencies() {
-		if (function_exists('ftp_login')) {
-			return true;
-		} else {
-			return array('ftp');
-		}
-	}
+    /**
+     * check if php-ftp is installed
+     */
+    public static function checkDependencies() {
+        if (function_exists('ftp_login')) {
+            return true;
+        } else {
+            return array('ftp');
+        }
+    }
 
 }

Spacing +19 added lines, -19 removed lines

@@ -37,28 +37,28 @@ 
 use Icewind\Streams\CallbackWrapper;
 use Icewind\Streams\RetryWrapper;
 
-class FTP extends StreamWrapper{
+class FTP extends StreamWrapper {
 	private $password;
 	private $user;
 	private $host;
 	private $secure;
 	private $root;
 
-	private static $tempFiles=array();
+	private static $tempFiles = array();
 
 	public function __construct($params) {
 		if (isset($params['host']) && isset($params['user']) && isset($params['password'])) {
-			$this->host=$params['host'];
-			$this->user=$params['user'];
-			$this->password=$params['password'];
+			$this->host = $params['host'];
+			$this->user = $params['user'];
+			$this->password = $params['password'];
 			if (isset($params['secure'])) {
 				$this->secure = $params['secure'];
 			} else {
 				$this->secure = false;
 			}
-			$this->root=isset($params['root'])?$params['root']:'/';
-			if ( ! $this->root || $this->root[0]!=='/') {
-				$this->root='/'.$this->root;
+			$this->root = isset($params['root']) ? $params['root'] : '/';
+			if (!$this->root || $this->root[0] !== '/') {
+				$this->root = '/'.$this->root;
 			}
 			if (substr($this->root, -1) !== '/') {
 				$this->root .= '/';
@@ -69,8 +69,8 @@ 
 		
 	}
 
-	public function getId(){
-		return 'ftp::' . $this->user . '@' . $this->host . '/' . $this->root;
+	public function getId() {
+		return 'ftp::'.$this->user.'@'.$this->host.'/'.$this->root;
 	}
 
 	/**
@@ -79,11 +79,11 @@ 
 	 * @return string
 	 */
 	public function constructUrl($path) {
-		$url='ftp';
+		$url = 'ftp';
 		if ($this->secure) {
-			$url.='s';
+			$url .= 's';
 		}
-		$url.='://'.urlencode($this->user).':'.urlencode($this->password).'@'.$this->host.$this->root.$path;
+		$url .= '://'.urlencode($this->user).':'.urlencode($this->password).'@'.$this->host.$this->root.$path;
 		return $url;
 	}
 
@@ -102,8 +102,8 @@ 
 			return $result;
 		}
 	}
-	public function fopen($path,$mode) {
-		switch($mode) {
+	public function fopen($path, $mode) {
+		switch ($mode) {
 			case 'r':
 			case 'rb':
 			case 'w':
@@ -123,17 +123,17 @@ 
 			case 'c':
 			case 'c+':
 				//emulate these
-				if (strrpos($path, '.')!==false) {
-					$ext=substr($path, strrpos($path, '.'));
+				if (strrpos($path, '.') !== false) {
+					$ext = substr($path, strrpos($path, '.'));
 				} else {
-					$ext='';
+					$ext = '';
 				}
 				$tmpFile = \OC::$server->getTempManager()->getTemporaryFile();
 				if ($this->file_exists($path)) {
 					$this->getFile($path, $tmpFile);
 				}
 				$handle = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) {
+				return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) {
 					$this->writeBack($tmpFile, $path);
 				});
 		}

apps/files_sharing/lib/Controller/ShareController.php

Doc Comments +1 added lines, -1 removed lines

@@ -597,7 +597,7 @@
 	 * publish activity
 	 *
 	 * @param string $subject
-	 * @param array $parameters
+	 * @param string[] $parameters
 	 * @param string $affectedUser
 	 * @param int $fileId
 	 * @param string $filePath

Spacing +7 added lines, -7 removed lines

@@ -167,7 +167,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() {
@@ -188,7 +188,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();
@@ -207,7 +207,7 @@ 
 			'errorCode' => $errorCode,
 			'errorMessage' => $errorMessage,
 		]);
-		if(!is_null($exception)) {
+		if (!is_null($exception)) {
 			throw $exception;
 		}
 	}
@@ -327,7 +327,7 @@ 
 		$shareTmpl['previewURL'] = $shareTmpl['downloadURL'];
 		$ogPreview = '';
 		if ($shareTmpl['previewSupported']) {
-			$shareTmpl['previewImage'] = $this->urlGenerator->linkToRouteAbsolute( 'files_sharing.PublicPreview.getPreview',
+			$shareTmpl['previewImage'] = $this->urlGenerator->linkToRouteAbsolute('files_sharing.PublicPreview.getPreview',
 				['x' => 200, 'y' => 200, 'file' => $shareTmpl['directory_path'], 'token' => $shareTmpl['dirToken']]);
 			$ogPreview = $shareTmpl['previewImage'];
 
@@ -375,7 +375,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"]);
@@ -419,7 +419,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');
 		}
 
@@ -497,7 +497,7 @@ 
 
 		$this->emitAccessShareHook($share);
 
-		$server_params = array( 'head' => $this->request->getMethod() === 'HEAD' );
+		$server_params = array('head' => $this->request->getMethod() === 'HEAD');
 
 		/**
 		 * Http range requests support

Indentation +556 added lines, -557 removed lines

@@ -71,565 +71,564 @@
  */
 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 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 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,
-								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->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);
-
-		return new TemplateResponse('core', 'publicshareauth', $templateParameters, 'guest');
-	}
-
-	/**
-	 * 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);
-
-		return new TemplateResponse('core', 'publicshareauth', $templateParameters, 'guest');
-	}
-
-	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) {
-		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();
-		}
-		// We can't get the path of a file share
-		try {
-			if ($share->getNode() 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['displayName'] = $this->userManager->get($share->getShareOwner())->getDisplayName();
-		$shareTmpl['owner'] = $share->getShareOwner();
-		$shareTmpl['filename'] = $share->getNode()->getName();
-		$shareTmpl['directory_path'] = $share->getTarget();
-		$shareTmpl['note'] = $share->getNote();
-		$shareTmpl['mimetype'] = $share->getNode()->getMimetype();
-		$shareTmpl['previewSupported'] = $this->previewManager->isMimeSupported($share->getNode()->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'] = $share->getNode()->getSize();
-		$shareTmpl['fileSize'] = \OCP\Util::humanFileSize($share->getNode()->getSize());
-
-		// Show file list
-		$hideFileList = false;
-		if ($share->getNode() instanceof \OCP\Files\Folder) {
-			/** @var \OCP\Files\Folder $rootFolder */
-			$rootFolder = $share->getNode();
-
-			try {
-				$folderNode = $rootFolder->get($path);
-			} catch (\OCP\Files\NotFoundException $e) {
-				$this->emitAccessShareHook($share, 404, 'Share not found');
-				throw new NotFoundException();
-			}
-
-			$shareTmpl['dir'] = $rootFolder->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 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 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,
+                                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->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);
+
+        return new TemplateResponse('core', 'publicshareauth', $templateParameters, 'guest');
+    }
+
+    /**
+     * 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);
+
+        return new TemplateResponse('core', 'publicshareauth', $templateParameters, 'guest');
+    }
+
+    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) {
+        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();
+        }
+        // We can't get the path of a file share
+        try {
+            if ($share->getNode() 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['displayName'] = $this->userManager->get($share->getShareOwner())->getDisplayName();
+        $shareTmpl['owner'] = $share->getShareOwner();
+        $shareTmpl['filename'] = $share->getNode()->getName();
+        $shareTmpl['directory_path'] = $share->getTarget();
+        $shareTmpl['note'] = $share->getNote();
+        $shareTmpl['mimetype'] = $share->getNode()->getMimetype();
+        $shareTmpl['previewSupported'] = $this->previewManager->isMimeSupported($share->getNode()->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'] = $share->getNode()->getSize();
+        $shareTmpl['fileSize'] = \OCP\Util::humanFileSize($share->getNode()->getSize());
+
+        // Show file list
+        $hideFileList = false;
+        if ($share->getNode() instanceof \OCP\Files\Folder) {
+            /** @var \OCP\Files\Folder $rootFolder */
+            $rootFolder = $share->getNode();
+
+            try {
+                $folderNode = $rootFolder->get($path);
+            } catch (\OCP\Files\NotFoundException $e) {
+                $this->emitAccessShareHook($share, 404, 'Share not found');
+                throw new NotFoundException();
+            }
+
+            $shareTmpl['dir'] = $rootFolder->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', $rootFolder->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');
-			$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();
-		}
-
-		$shareTmpl['hideFileList'] = $hideFileList;
-		$shareTmpl['shareOwner'] = $this->userManager->get($share->getShareOwner())->getDisplayName();
-		$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'];
-		$ogPreview = '';
-		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 ($share->getNode()->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', 'file-upload');
-		\OCP\Util::addStyle('files_sharing', 'publicView');
-		\OCP\Util::addScript('files_sharing', 'public');
-		\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', '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');
-		}
-
-		// 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]);
-
-		$this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts');
-
-		$csp = new \OCP\AppFramework\Http\ContentSecurityPolicy();
-		$csp->addAllowedFrameDomain('\'self\'');
-
-		$response = new PublicTemplateResponse($this->appName, 'public', $shareTmpl);
-		$response->setHeaderTitle($shareTmpl['filename']);
-		$response->setHeaderDetails($this->l10n->t('shared by %s', [$shareTmpl['displayName']]));
-		$response->setHeaderActions([
-			new SimpleMenuAction('download', $this->l10n->t('Download'), 'icon-download-white', $shareTmpl['downloadURL'], 0),
-			new SimpleMenuAction('download', $this->l10n->t('Download'), 'icon-download', $shareTmpl['downloadURL'], 10, $shareTmpl['fileSize']),
-			new LinkMenuAction($this->l10n->t('Direct link'), 'icon-public', $shareTmpl['previewURL']),
-			new ExternalShareMenuAction($this->l10n->t('Add to your Nextcloud'), 'icon-external', $shareTmpl['owner'], $shareTmpl['displayName'], $shareTmpl['filename']),
-		]);
-
-		$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 if (!empty($files_list)) {
-				$this->fileListDownloaded($share, $files_list, $node);
-			} else {
-				// The folder is downloaded
-				$this->singleFileDownloaded($share, $share->getNode());
-			}
-		}
-
-		/* 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 = array( '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
-	 */
-	protected function fileListDownloaded(Share\IShare $share, array $files_list, \OCP\Files\Folder $node) {
-		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
-	 */
-	protected function singleFileDownloaded(Share\IShare $share, \OCP\Files\Node $node) {
-
-		$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', $rootFolder->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');
+            $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();
+        }
+
+        $shareTmpl['hideFileList'] = $hideFileList;
+        $shareTmpl['shareOwner'] = $this->userManager->get($share->getShareOwner())->getDisplayName();
+        $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'];
+        $ogPreview = '';
+        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 ($share->getNode()->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', 'file-upload');
+        \OCP\Util::addStyle('files_sharing', 'publicView');
+        \OCP\Util::addScript('files_sharing', 'public');
+        \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', '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');
+        }
+
+        // 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]);
+
+        $this->eventDispatcher->dispatch('OCA\Files_Sharing::loadAdditionalScripts');
+
+        $csp = new \OCP\AppFramework\Http\ContentSecurityPolicy();
+        $csp->addAllowedFrameDomain('\'self\'');
+
+        $response = new PublicTemplateResponse($this->appName, 'public', $shareTmpl);
+        $response->setHeaderTitle($shareTmpl['filename']);
+        $response->setHeaderDetails($this->l10n->t('shared by %s', [$shareTmpl['displayName']]));
+        $response->setHeaderActions([
+            new SimpleMenuAction('download', $this->l10n->t('Download'), 'icon-download-white', $shareTmpl['downloadURL'], 0),
+            new SimpleMenuAction('download', $this->l10n->t('Download'), 'icon-download', $shareTmpl['downloadURL'], 10, $shareTmpl['fileSize']),
+            new LinkMenuAction($this->l10n->t('Direct link'), 'icon-public', $shareTmpl['previewURL']),
+            new ExternalShareMenuAction($this->l10n->t('Add to your Nextcloud'), 'icon-external', $shareTmpl['owner'], $shareTmpl['displayName'], $shareTmpl['filename']),
+        ]);
+
+        $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 if (!empty($files_list)) {
+                $this->fileListDownloaded($share, $files_list, $node);
+            } else {
+                // The folder is downloaded
+                $this->singleFileDownloaded($share, $share->getNode());
+            }
+        }
+
+        /* 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 = array( '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
+     */
+    protected function fileListDownloaded(Share\IShare $share, array $files_list, \OCP\Files\Folder $node) {
+        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
+     */
+    protected function singleFileDownloaded(Share\IShare $share, \OCP\Files\Node $node) {
+
+        $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);
+    }
 
 
 }

lib/private/Files/Cache/Wrapper/CacheJail.php

Doc Comments +3 added lines

@@ -194,6 +194,9 @@
 		return $this->getCache()->getStatus($this->getSourcePath($file));
 	}
 
+	/**
+	 * @param ICacheEntry[] $results
+	 */
 	private function formatSearchResults($results) {
 		$results = array_filter($results, array($this, 'filterCacheEntry'));
 		$results = array_values($results);

Spacing +3 added lines, -3 removed lines

@@ -58,7 +58,7 @@ 
 		if ($path === '') {
 			return $this->getRoot();
 		} else {
-			return $this->getRoot() . '/' . ltrim($path, '/');
+			return $this->getRoot().'/'.ltrim($path, '/');
 		}
 	}
 
@@ -73,7 +73,7 @@ 
 		$rootLength = strlen($this->getRoot()) + 1;
 		if ($path === $this->getRoot()) {
 			return '';
-		} else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
+		} else if (substr($path, 0, $rootLength) === $this->getRoot().'/') {
 			return substr($path, $rootLength);
 		} else {
 			return null;
@@ -93,7 +93,7 @@ 
 
 	protected function filterCacheEntry($entry) {
 		$rootLength = strlen($this->getRoot()) + 1;
-		return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
+		return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot().'/');
 	}
 
 	/**

Indentation +304 added lines, -304 removed lines

@@ -37,308 +37,308 @@
  * Jail to a subdirectory of the wrapped cache
  */
 class CacheJail extends CacheWrapper {
-	/**
-	 * @var string
-	 */
-	protected $root;
-
-	/**
-	 * @param \OCP\Files\Cache\ICache $cache
-	 * @param string $root
-	 */
-	public function __construct($cache, $root) {
-		parent::__construct($cache);
-		$this->root = $root;
-	}
-
-	protected function getRoot() {
-		return $this->root;
-	}
-
-	protected function getSourcePath($path) {
-		if ($path === '') {
-			return $this->getRoot();
-		} else {
-			return $this->getRoot() . '/' . ltrim($path, '/');
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return null|string the jailed path or null if the path is outside the jail
-	 */
-	protected function getJailedPath($path) {
-		if ($this->getRoot() === '') {
-			return $path;
-		}
-		$rootLength = strlen($this->getRoot()) + 1;
-		if ($path === $this->getRoot()) {
-			return '';
-		} else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
-			return substr($path, $rootLength);
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @param ICacheEntry|array $entry
-	 * @return array
-	 */
-	protected function formatCacheEntry($entry) {
-		if (isset($entry['path'])) {
-			$entry['path'] = $this->getJailedPath($entry['path']);
-		}
-		return $entry;
-	}
-
-	protected function filterCacheEntry($entry) {
-		$rootLength = strlen($this->getRoot()) + 1;
-		return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
-	}
-
-	/**
-	 * get the stored metadata of a file or folder
-	 *
-	 * @param string /int $file
-	 * @return ICacheEntry|false
-	 */
-	public function get($file) {
-		if (is_string($file) or $file == '') {
-			$file = $this->getSourcePath($file);
-		}
-		return parent::get($file);
-	}
-
-	/**
-	 * insert meta data for a new file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 */
-	public function insert($file, array $data) {
-		return $this->getCache()->insert($this->getSourcePath($file), $data);
-	}
-
-	/**
-	 * update the metadata in the cache
-	 *
-	 * @param int $id
-	 * @param array $data
-	 */
-	public function update($id, array $data) {
-		$this->getCache()->update($id, $data);
-	}
-
-	/**
-	 * get the file id for a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getId($file) {
-		return $this->getCache()->getId($this->getSourcePath($file));
-	}
-
-	/**
-	 * get the id of the parent folder of a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getParentId($file) {
-		return $this->getCache()->getParentId($this->getSourcePath($file));
-	}
-
-	/**
-	 * check if a file is available in the cache
-	 *
-	 * @param string $file
-	 * @return bool
-	 */
-	public function inCache($file) {
-		return $this->getCache()->inCache($this->getSourcePath($file));
-	}
-
-	/**
-	 * remove a file or folder from the cache
-	 *
-	 * @param string $file
-	 */
-	public function remove($file) {
-		$this->getCache()->remove($this->getSourcePath($file));
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param string $source
-	 * @param string $target
-	 */
-	public function move($source, $target) {
-		$this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
-	}
-
-	/**
-	 * Get the storage id and path needed for a move
-	 *
-	 * @param string $path
-	 * @return array [$storageId, $internalPath]
-	 */
-	protected function getMoveInfo($path) {
-		return [$this->getNumericStorageId(), $this->getSourcePath($path)];
-	}
-
-	/**
-	 * remove all entries for files that are stored on the storage from the cache
-	 */
-	public function clear() {
-		$this->getCache()->remove($this->getRoot());
-	}
-
-	/**
-	 * @param string $file
-	 *
-	 * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
-	 */
-	public function getStatus($file) {
-		return $this->getCache()->getStatus($this->getSourcePath($file));
-	}
-
-	private function formatSearchResults($results) {
-		$results = array_filter($results, array($this, 'filterCacheEntry'));
-		$results = array_values($results);
-		return array_map(array($this, 'formatCacheEntry'), $results);
-	}
-
-	/**
-	 * search for files matching $pattern
-	 *
-	 * @param string $pattern
-	 * @return array an array of file data
-	 */
-	public function search($pattern) {
-		$results = $this->getCache()->search($pattern);
-		return $this->formatSearchResults($results);
-	}
-
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype
-	 * @return array
-	 */
-	public function searchByMime($mimetype) {
-		$results = $this->getCache()->searchByMime($mimetype);
-		return $this->formatSearchResults($results);
-	}
-
-	public function searchQuery(ISearchQuery $query) {
-		$simpleQuery = new SearchQuery($query->getSearchOperation(), 0, 0, $query->getOrder(), $query->getUser());
-		$results = $this->getCache()->searchQuery($simpleQuery);
-		$results = $this->formatSearchResults($results);
-
-		$limit = $query->getLimit() === 0 ? NULL : $query->getLimit();
-		$results = array_slice($results, $query->getOffset(), $limit);
-
-		return $results;
-	}
-
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string|int $tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return array
-	 */
-	public function searchByTag($tag, $userId) {
-		$results = $this->getCache()->searchByTag($tag, $userId);
-		return $this->formatSearchResults($results);
-	}
-
-	/**
-	 * update the folder size and the size of all parent folders
-	 *
-	 * @param string|boolean $path
-	 * @param array $data (optional) meta data of the folder
-	 */
-	public function correctFolderSize($path, $data = null) {
-		if ($this->getCache() instanceof Cache) {
-			$this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
-		}
-	}
-
-	/**
-	 * get the size of a folder and set it in the cache
-	 *
-	 * @param string $path
-	 * @param array $entry (optional) meta data of the folder
-	 * @return int
-	 */
-	public function calculateFolderSize($path, $entry = null) {
-		if ($this->getCache() instanceof Cache) {
-			return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
-		} else {
-			return 0;
-		}
-
-	}
-
-	/**
-	 * get all file ids on the files on the storage
-	 *
-	 * @return int[]
-	 */
-	public function getAll() {
-		// not supported
-		return array();
-	}
-
-	/**
-	 * find a folder in the cache which has not been fully scanned
-	 *
-	 * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
-	 * likely the folder where we stopped scanning previously
-	 *
-	 * @return string|bool the path of the folder or false when no folder matched
-	 */
-	public function getIncomplete() {
-		// not supported
-		return false;
-	}
-
-	/**
-	 * get the path of a file on this storage by it's id
-	 *
-	 * @param int $id
-	 * @return string|null
-	 */
-	public function getPathById($id) {
-		$path = $this->getCache()->getPathById($id);
-		if ($path === null) {
-			return null;
-		}
-
-		return $this->getJailedPath($path);
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * Note that this should make sure the entries are removed from the source cache
-	 *
-	 * @param \OCP\Files\Cache\ICache $sourceCache
-	 * @param string $sourcePath
-	 * @param string $targetPath
-	 */
-	public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
-		if ($sourceCache === $this) {
-			return $this->move($sourcePath, $targetPath);
-		}
-		return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
-	}
+    /**
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * @param \OCP\Files\Cache\ICache $cache
+     * @param string $root
+     */
+    public function __construct($cache, $root) {
+        parent::__construct($cache);
+        $this->root = $root;
+    }
+
+    protected function getRoot() {
+        return $this->root;
+    }
+
+    protected function getSourcePath($path) {
+        if ($path === '') {
+            return $this->getRoot();
+        } else {
+            return $this->getRoot() . '/' . ltrim($path, '/');
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return null|string the jailed path or null if the path is outside the jail
+     */
+    protected function getJailedPath($path) {
+        if ($this->getRoot() === '') {
+            return $path;
+        }
+        $rootLength = strlen($this->getRoot()) + 1;
+        if ($path === $this->getRoot()) {
+            return '';
+        } else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
+            return substr($path, $rootLength);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @param ICacheEntry|array $entry
+     * @return array
+     */
+    protected function formatCacheEntry($entry) {
+        if (isset($entry['path'])) {
+            $entry['path'] = $this->getJailedPath($entry['path']);
+        }
+        return $entry;
+    }
+
+    protected function filterCacheEntry($entry) {
+        $rootLength = strlen($this->getRoot()) + 1;
+        return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
+    }
+
+    /**
+     * get the stored metadata of a file or folder
+     *
+     * @param string /int $file
+     * @return ICacheEntry|false
+     */
+    public function get($file) {
+        if (is_string($file) or $file == '') {
+            $file = $this->getSourcePath($file);
+        }
+        return parent::get($file);
+    }
+
+    /**
+     * insert meta data for a new file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     */
+    public function insert($file, array $data) {
+        return $this->getCache()->insert($this->getSourcePath($file), $data);
+    }
+
+    /**
+     * update the metadata in the cache
+     *
+     * @param int $id
+     * @param array $data
+     */
+    public function update($id, array $data) {
+        $this->getCache()->update($id, $data);
+    }
+
+    /**
+     * get the file id for a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getId($file) {
+        return $this->getCache()->getId($this->getSourcePath($file));
+    }
+
+    /**
+     * get the id of the parent folder of a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getParentId($file) {
+        return $this->getCache()->getParentId($this->getSourcePath($file));
+    }
+
+    /**
+     * check if a file is available in the cache
+     *
+     * @param string $file
+     * @return bool
+     */
+    public function inCache($file) {
+        return $this->getCache()->inCache($this->getSourcePath($file));
+    }
+
+    /**
+     * remove a file or folder from the cache
+     *
+     * @param string $file
+     */
+    public function remove($file) {
+        $this->getCache()->remove($this->getSourcePath($file));
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param string $source
+     * @param string $target
+     */
+    public function move($source, $target) {
+        $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
+    }
+
+    /**
+     * Get the storage id and path needed for a move
+     *
+     * @param string $path
+     * @return array [$storageId, $internalPath]
+     */
+    protected function getMoveInfo($path) {
+        return [$this->getNumericStorageId(), $this->getSourcePath($path)];
+    }
+
+    /**
+     * remove all entries for files that are stored on the storage from the cache
+     */
+    public function clear() {
+        $this->getCache()->remove($this->getRoot());
+    }
+
+    /**
+     * @param string $file
+     *
+     * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
+     */
+    public function getStatus($file) {
+        return $this->getCache()->getStatus($this->getSourcePath($file));
+    }
+
+    private function formatSearchResults($results) {
+        $results = array_filter($results, array($this, 'filterCacheEntry'));
+        $results = array_values($results);
+        return array_map(array($this, 'formatCacheEntry'), $results);
+    }
+
+    /**
+     * search for files matching $pattern
+     *
+     * @param string $pattern
+     * @return array an array of file data
+     */
+    public function search($pattern) {
+        $results = $this->getCache()->search($pattern);
+        return $this->formatSearchResults($results);
+    }
+
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype
+     * @return array
+     */
+    public function searchByMime($mimetype) {
+        $results = $this->getCache()->searchByMime($mimetype);
+        return $this->formatSearchResults($results);
+    }
+
+    public function searchQuery(ISearchQuery $query) {
+        $simpleQuery = new SearchQuery($query->getSearchOperation(), 0, 0, $query->getOrder(), $query->getUser());
+        $results = $this->getCache()->searchQuery($simpleQuery);
+        $results = $this->formatSearchResults($results);
+
+        $limit = $query->getLimit() === 0 ? NULL : $query->getLimit();
+        $results = array_slice($results, $query->getOffset(), $limit);
+
+        return $results;
+    }
+
+    /**
+     * search for files by mimetype
+     *
+     * @param string|int $tag name or tag id
+     * @param string $userId owner of the tags
+     * @return array
+     */
+    public function searchByTag($tag, $userId) {
+        $results = $this->getCache()->searchByTag($tag, $userId);
+        return $this->formatSearchResults($results);
+    }
+
+    /**
+     * update the folder size and the size of all parent folders
+     *
+     * @param string|boolean $path
+     * @param array $data (optional) meta data of the folder
+     */
+    public function correctFolderSize($path, $data = null) {
+        if ($this->getCache() instanceof Cache) {
+            $this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
+        }
+    }
+
+    /**
+     * get the size of a folder and set it in the cache
+     *
+     * @param string $path
+     * @param array $entry (optional) meta data of the folder
+     * @return int
+     */
+    public function calculateFolderSize($path, $entry = null) {
+        if ($this->getCache() instanceof Cache) {
+            return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
+        } else {
+            return 0;
+        }
+
+    }
+
+    /**
+     * get all file ids on the files on the storage
+     *
+     * @return int[]
+     */
+    public function getAll() {
+        // not supported
+        return array();
+    }
+
+    /**
+     * find a folder in the cache which has not been fully scanned
+     *
+     * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
+     * use the one with the highest id gives the best result with the background scanner, since that is most
+     * likely the folder where we stopped scanning previously
+     *
+     * @return string|bool the path of the folder or false when no folder matched
+     */
+    public function getIncomplete() {
+        // not supported
+        return false;
+    }
+
+    /**
+     * get the path of a file on this storage by it's id
+     *
+     * @param int $id
+     * @return string|null
+     */
+    public function getPathById($id) {
+        $path = $this->getCache()->getPathById($id);
+        if ($path === null) {
+            return null;
+        }
+
+        return $this->getJailedPath($path);
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * Note that this should make sure the entries are removed from the source cache
+     *
+     * @param \OCP\Files\Cache\ICache $sourceCache
+     * @param string $sourcePath
+     * @param string $targetPath
+     */
+    public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
+        if ($sourceCache === $this) {
+            return $this->move($sourcePath, $targetPath);
+        }
+        return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
+    }
 }

lib/private/Group/Manager.php

Doc Comments +1 added lines, -1 removed lines

@@ -156,7 +156,7 @@
 	/**
 	 * @param string $gid
 	 * @param string $displayName
-	 * @return \OCP\IGroup
+	 * @return null|Group
 	 */
 	protected function getGroupObject($gid, $displayName = null) {
 		$backends = array();

Spacing +15 added lines, -15 removed lines

@@ -93,20 +93,20 @@ 
 		$this->logger = $logger;
 		$cachedGroups = & $this->cachedGroups;
 		$cachedUserGroups = & $this->cachedUserGroups;
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postDelete', function($group) use (&$cachedGroups, &$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
 			unset($cachedGroups[$group->getGID()]);
 			$cachedUserGroups = array();
 		});
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postAddUser', function($group) use (&$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
 			$cachedUserGroups = array();
 		});
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
+		$this->listen('\OC\Group', 'postRemoveUser', function($group) use (&$cachedUserGroups) {
 			/**
 			 * @var \OC\Group\Group $group
 			 */
@@ -235,7 +235,7 @@ 
 				if ($aGroup instanceof IGroup) {
 					$groups[$groupId] = $aGroup;
 				} else {
-					$this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
+					$this->logger->debug('Group "'.$groupId.'" was returned by search but not found through direct access', ['app' => 'core']);
 				}
 			}
 			if (!is_null($limit) and $limit <= 0) {
@@ -249,7 +249,7 @@ 
 	 * @param IUser|null $user
 	 * @return \OC\Group\Group[]
 	 */
-	public function getUserGroups(IUser $user= null) {
+	public function getUserGroups(IUser $user = null) {
 		if (!$user instanceof IUser) {
 			return [];
 		}
@@ -273,7 +273,7 @@ 
 					if ($aGroup instanceof IGroup) {
 						$groups[$groupId] = $aGroup;
 					} else {
-						$this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
+						$this->logger->debug('User "'.$uid.'" belongs to deleted group: "'.$groupId.'"', ['app' => 'core']);
 					}
 				}
 			}
@@ -322,32 +322,32 @@ 
 	 */
 	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		$group = $this->get($gid);
-		if(is_null($group)) {
+		if (is_null($group)) {
 			return array();
 		}
 
 		$search = trim($search);
 		$groupUsers = array();
 
-		if(!empty($search)) {
+		if (!empty($search)) {
 			// only user backends have the capability to do a complex search for users
 			$searchOffset = 0;
 			$searchLimit = $limit * 100;
-			if($limit === -1) {
+			if ($limit === -1) {
 				$searchLimit = 500;
 			}
 
 			do {
 				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
-				foreach($filteredUsers as $filteredUser) {
-					if($group->inGroup($filteredUser)) {
-						$groupUsers[]= $filteredUser;
+				foreach ($filteredUsers as $filteredUser) {
+					if ($group->inGroup($filteredUser)) {
+						$groupUsers[] = $filteredUser;
 					}
 				}
 				$searchOffset += $searchLimit;
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
+			} while (count($groupUsers) < $searchLimit + $offset && count($filteredUsers) >= $searchLimit);
 
-			if($limit === -1) {
+			if ($limit === -1) {
 				$groupUsers = array_slice($groupUsers, $offset);
 			} else {
 				$groupUsers = array_slice($groupUsers, $offset, $limit);
@@ -357,7 +357,7 @@ 
 		}
 
 		$matchingUsers = array();
-		foreach($groupUsers as $groupUser) {
+		foreach ($groupUsers as $groupUser) {
 			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
 		}
 		return $matchingUsers;

Indentation +344 added lines, -344 removed lines

@@ -61,348 +61,348 @@
  * @package OC\Group
  */
 class Manager extends PublicEmitter implements IGroupManager {
-	/**
-	 * @var GroupInterface[] $backends
-	 */
-	private $backends = array();
-
-	/**
-	 * @var \OC\User\Manager $userManager
-	 */
-	private $userManager;
-
-	/**
-	 * @var \OC\Group\Group[]
-	 */
-	private $cachedGroups = array();
-
-	/**
-	 * @var \OC\Group\Group[]
-	 */
-	private $cachedUserGroups = array();
-
-	/** @var \OC\SubAdmin */
-	private $subAdmin = null;
-
-	/** @var ILogger */
-	private $logger;
-
-	/**
-	 * @param \OC\User\Manager $userManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(\OC\User\Manager $userManager, ILogger $logger) {
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$cachedGroups = & $this->cachedGroups;
-		$cachedUserGroups = & $this->cachedUserGroups;
-		$this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			unset($cachedGroups[$group->getGID()]);
-			$cachedUserGroups = array();
-		});
-		$this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			$cachedUserGroups = array();
-		});
-		$this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
-			/**
-			 * @var \OC\Group\Group $group
-			 */
-			$cachedUserGroups = array();
-		});
-	}
-
-	/**
-	 * Checks whether a given backend is used
-	 *
-	 * @param string $backendClass Full classname including complete namespace
-	 * @return bool
-	 */
-	public function isBackendUsed($backendClass) {
-		$backendClass = strtolower(ltrim($backendClass, '\\'));
-
-		foreach ($this->backends as $backend) {
-			if (strtolower(get_class($backend)) === $backendClass) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param \OCP\GroupInterface $backend
-	 */
-	public function addBackend($backend) {
-		$this->backends[] = $backend;
-		$this->clearCaches();
-	}
-
-	public function clearBackends() {
-		$this->backends = array();
-		$this->clearCaches();
-	}
-
-	/**
-	 * Get the active backends
-	 * @return \OCP\GroupInterface[]
-	 */
-	public function getBackends() {
-		return $this->backends;
-	}
-
-
-	protected function clearCaches() {
-		$this->cachedGroups = array();
-		$this->cachedUserGroups = array();
-	}
-
-	/**
-	 * @param string $gid
-	 * @return \OC\Group\Group
-	 */
-	public function get($gid) {
-		if (isset($this->cachedGroups[$gid])) {
-			return $this->cachedGroups[$gid];
-		}
-		return $this->getGroupObject($gid);
-	}
-
-	/**
-	 * @param string $gid
-	 * @param string $displayName
-	 * @return \OCP\IGroup
-	 */
-	protected function getGroupObject($gid, $displayName = null) {
-		$backends = array();
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
-				$groupData = $backend->getGroupDetails($gid);
-				if (is_array($groupData) && !empty($groupData)) {
-					// take the display name from the first backend that has a non-null one
-					if (is_null($displayName) && isset($groupData['displayName'])) {
-						$displayName = $groupData['displayName'];
-					}
-					$backends[] = $backend;
-				}
-			} else if ($backend->groupExists($gid)) {
-				$backends[] = $backend;
-			}
-		}
-		if (count($backends) === 0) {
-			return null;
-		}
-		$this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
-		return $this->cachedGroups[$gid];
-	}
-
-	/**
-	 * @param string $gid
-	 * @return bool
-	 */
-	public function groupExists($gid) {
-		return $this->get($gid) instanceof IGroup;
-	}
-
-	/**
-	 * @param string $gid
-	 * @return \OC\Group\Group
-	 */
-	public function createGroup($gid) {
-		if ($gid === '' || $gid === null) {
-			return false;
-		} else if ($group = $this->get($gid)) {
-			return $group;
-		} else {
-			$this->emit('\OC\Group', 'preCreate', array($gid));
-			foreach ($this->backends as $backend) {
-				if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
-					$backend->createGroup($gid);
-					$group = $this->getGroupObject($gid);
-					$this->emit('\OC\Group', 'postCreate', array($group));
-					return $group;
-				}
-			}
-			return null;
-		}
-	}
-
-	/**
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OC\Group\Group[]
-	 */
-	public function search($search, $limit = null, $offset = null) {
-		$groups = array();
-		foreach ($this->backends as $backend) {
-			$groupIds = $backend->getGroups($search, $limit, $offset);
-			foreach ($groupIds as $groupId) {
-				$aGroup = $this->get($groupId);
-				if ($aGroup instanceof IGroup) {
-					$groups[$groupId] = $aGroup;
-				} else {
-					$this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
-				}
-			}
-			if (!is_null($limit) and $limit <= 0) {
-				return array_values($groups);
-			}
-		}
-		return array_values($groups);
-	}
-
-	/**
-	 * @param IUser|null $user
-	 * @return \OC\Group\Group[]
-	 */
-	public function getUserGroups(IUser $user= null) {
-		if (!$user instanceof IUser) {
-			return [];
-		}
-		return $this->getUserIdGroups($user->getUID());
-	}
-
-	/**
-	 * @param string $uid the user id
-	 * @return \OC\Group\Group[]
-	 */
-	public function getUserIdGroups($uid) {
-		if (isset($this->cachedUserGroups[$uid])) {
-			return $this->cachedUserGroups[$uid];
-		}
-		$groups = array();
-		foreach ($this->backends as $backend) {
-			$groupIds = $backend->getUserGroups($uid);
-			if (is_array($groupIds)) {
-				foreach ($groupIds as $groupId) {
-					$aGroup = $this->get($groupId);
-					if ($aGroup instanceof IGroup) {
-						$groups[$groupId] = $aGroup;
-					} else {
-						$this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
-					}
-				}
-			}
-		}
-		$this->cachedUserGroups[$uid] = $groups;
-		return $this->cachedUserGroups[$uid];
-	}
-
-	/**
-	 * Checks if a userId is in the admin group
-	 * @param string $userId
-	 * @return bool if admin
-	 */
-	public function isAdmin($userId) {
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(\OC\Group\Backend::IS_ADMIN) && $backend->isAdmin($userId)) {
-				return true;
-			}
-		}
-		return $this->isInGroup($userId, 'admin');
-	}
-
-	/**
-	 * Checks if a userId is in a group
-	 * @param string $userId
-	 * @param string $group
-	 * @return bool if in group
-	 */
-	public function isInGroup($userId, $group) {
-		return array_key_exists($group, $this->getUserIdGroups($userId));
-	}
-
-	/**
-	 * get a list of group ids for a user
-	 * @param IUser $user
-	 * @return array with group ids
-	 */
-	public function getUserGroupIds(IUser $user) {
-		return array_map(function($value) {
-			return (string) $value;
-		}, array_keys($this->getUserGroups($user)));
-	}
-
-	/**
-	 * get an array of groupid and displayName for a user
-	 * @param IUser $user
-	 * @return array ['displayName' => displayname]
-	 */
-	public function getUserGroupNames(IUser $user) {
-		return array_map(function($group) {
-			return array('displayName' => $group->getDisplayName());
-		}, $this->getUserGroups($user));
-	}
-
-	/**
-	 * get a list of all display names in a group
-	 * @param string $gid
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array an array of display names (value) and user ids (key)
-	 */
-	public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
-		$group = $this->get($gid);
-		if(is_null($group)) {
-			return array();
-		}
-
-		$search = trim($search);
-		$groupUsers = array();
-
-		if(!empty($search)) {
-			// only user backends have the capability to do a complex search for users
-			$searchOffset = 0;
-			$searchLimit = $limit * 100;
-			if($limit === -1) {
-				$searchLimit = 500;
-			}
-
-			do {
-				$filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
-				foreach($filteredUsers as $filteredUser) {
-					if($group->inGroup($filteredUser)) {
-						$groupUsers[]= $filteredUser;
-					}
-				}
-				$searchOffset += $searchLimit;
-			} while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
-
-			if($limit === -1) {
-				$groupUsers = array_slice($groupUsers, $offset);
-			} else {
-				$groupUsers = array_slice($groupUsers, $offset, $limit);
-			}
-		} else {
-			$groupUsers = $group->searchUsers('', $limit, $offset);
-		}
-
-		$matchingUsers = array();
-		foreach($groupUsers as $groupUser) {
-			$matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
-		}
-		return $matchingUsers;
-	}
-
-	/**
-	 * @return \OC\SubAdmin
-	 */
-	public function getSubAdmin() {
-		if (!$this->subAdmin) {
-			$this->subAdmin = new \OC\SubAdmin(
-				$this->userManager,
-				$this,
-				\OC::$server->getDatabaseConnection()
-			);
-		}
-
-		return $this->subAdmin;
-	}
+    /**
+     * @var GroupInterface[] $backends
+     */
+    private $backends = array();
+
+    /**
+     * @var \OC\User\Manager $userManager
+     */
+    private $userManager;
+
+    /**
+     * @var \OC\Group\Group[]
+     */
+    private $cachedGroups = array();
+
+    /**
+     * @var \OC\Group\Group[]
+     */
+    private $cachedUserGroups = array();
+
+    /** @var \OC\SubAdmin */
+    private $subAdmin = null;
+
+    /** @var ILogger */
+    private $logger;
+
+    /**
+     * @param \OC\User\Manager $userManager
+     * @param ILogger $logger
+     */
+    public function __construct(\OC\User\Manager $userManager, ILogger $logger) {
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $cachedGroups = & $this->cachedGroups;
+        $cachedUserGroups = & $this->cachedUserGroups;
+        $this->listen('\OC\Group', 'postDelete', function ($group) use (&$cachedGroups, &$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            unset($cachedGroups[$group->getGID()]);
+            $cachedUserGroups = array();
+        });
+        $this->listen('\OC\Group', 'postAddUser', function ($group) use (&$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            $cachedUserGroups = array();
+        });
+        $this->listen('\OC\Group', 'postRemoveUser', function ($group) use (&$cachedUserGroups) {
+            /**
+             * @var \OC\Group\Group $group
+             */
+            $cachedUserGroups = array();
+        });
+    }
+
+    /**
+     * Checks whether a given backend is used
+     *
+     * @param string $backendClass Full classname including complete namespace
+     * @return bool
+     */
+    public function isBackendUsed($backendClass) {
+        $backendClass = strtolower(ltrim($backendClass, '\\'));
+
+        foreach ($this->backends as $backend) {
+            if (strtolower(get_class($backend)) === $backendClass) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param \OCP\GroupInterface $backend
+     */
+    public function addBackend($backend) {
+        $this->backends[] = $backend;
+        $this->clearCaches();
+    }
+
+    public function clearBackends() {
+        $this->backends = array();
+        $this->clearCaches();
+    }
+
+    /**
+     * Get the active backends
+     * @return \OCP\GroupInterface[]
+     */
+    public function getBackends() {
+        return $this->backends;
+    }
+
+
+    protected function clearCaches() {
+        $this->cachedGroups = array();
+        $this->cachedUserGroups = array();
+    }
+
+    /**
+     * @param string $gid
+     * @return \OC\Group\Group
+     */
+    public function get($gid) {
+        if (isset($this->cachedGroups[$gid])) {
+            return $this->cachedGroups[$gid];
+        }
+        return $this->getGroupObject($gid);
+    }
+
+    /**
+     * @param string $gid
+     * @param string $displayName
+     * @return \OCP\IGroup
+     */
+    protected function getGroupObject($gid, $displayName = null) {
+        $backends = array();
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(\OC\Group\Backend::GROUP_DETAILS)) {
+                $groupData = $backend->getGroupDetails($gid);
+                if (is_array($groupData) && !empty($groupData)) {
+                    // take the display name from the first backend that has a non-null one
+                    if (is_null($displayName) && isset($groupData['displayName'])) {
+                        $displayName = $groupData['displayName'];
+                    }
+                    $backends[] = $backend;
+                }
+            } else if ($backend->groupExists($gid)) {
+                $backends[] = $backend;
+            }
+        }
+        if (count($backends) === 0) {
+            return null;
+        }
+        $this->cachedGroups[$gid] = new Group($gid, $backends, $this->userManager, $this, $displayName);
+        return $this->cachedGroups[$gid];
+    }
+
+    /**
+     * @param string $gid
+     * @return bool
+     */
+    public function groupExists($gid) {
+        return $this->get($gid) instanceof IGroup;
+    }
+
+    /**
+     * @param string $gid
+     * @return \OC\Group\Group
+     */
+    public function createGroup($gid) {
+        if ($gid === '' || $gid === null) {
+            return false;
+        } else if ($group = $this->get($gid)) {
+            return $group;
+        } else {
+            $this->emit('\OC\Group', 'preCreate', array($gid));
+            foreach ($this->backends as $backend) {
+                if ($backend->implementsActions(\OC\Group\Backend::CREATE_GROUP)) {
+                    $backend->createGroup($gid);
+                    $group = $this->getGroupObject($gid);
+                    $this->emit('\OC\Group', 'postCreate', array($group));
+                    return $group;
+                }
+            }
+            return null;
+        }
+    }
+
+    /**
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return \OC\Group\Group[]
+     */
+    public function search($search, $limit = null, $offset = null) {
+        $groups = array();
+        foreach ($this->backends as $backend) {
+            $groupIds = $backend->getGroups($search, $limit, $offset);
+            foreach ($groupIds as $groupId) {
+                $aGroup = $this->get($groupId);
+                if ($aGroup instanceof IGroup) {
+                    $groups[$groupId] = $aGroup;
+                } else {
+                    $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']);
+                }
+            }
+            if (!is_null($limit) and $limit <= 0) {
+                return array_values($groups);
+            }
+        }
+        return array_values($groups);
+    }
+
+    /**
+     * @param IUser|null $user
+     * @return \OC\Group\Group[]
+     */
+    public function getUserGroups(IUser $user= null) {
+        if (!$user instanceof IUser) {
+            return [];
+        }
+        return $this->getUserIdGroups($user->getUID());
+    }
+
+    /**
+     * @param string $uid the user id
+     * @return \OC\Group\Group[]
+     */
+    public function getUserIdGroups($uid) {
+        if (isset($this->cachedUserGroups[$uid])) {
+            return $this->cachedUserGroups[$uid];
+        }
+        $groups = array();
+        foreach ($this->backends as $backend) {
+            $groupIds = $backend->getUserGroups($uid);
+            if (is_array($groupIds)) {
+                foreach ($groupIds as $groupId) {
+                    $aGroup = $this->get($groupId);
+                    if ($aGroup instanceof IGroup) {
+                        $groups[$groupId] = $aGroup;
+                    } else {
+                        $this->logger->debug('User "' . $uid . '" belongs to deleted group: "' . $groupId . '"', ['app' => 'core']);
+                    }
+                }
+            }
+        }
+        $this->cachedUserGroups[$uid] = $groups;
+        return $this->cachedUserGroups[$uid];
+    }
+
+    /**
+     * Checks if a userId is in the admin group
+     * @param string $userId
+     * @return bool if admin
+     */
+    public function isAdmin($userId) {
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(\OC\Group\Backend::IS_ADMIN) && $backend->isAdmin($userId)) {
+                return true;
+            }
+        }
+        return $this->isInGroup($userId, 'admin');
+    }
+
+    /**
+     * Checks if a userId is in a group
+     * @param string $userId
+     * @param string $group
+     * @return bool if in group
+     */
+    public function isInGroup($userId, $group) {
+        return array_key_exists($group, $this->getUserIdGroups($userId));
+    }
+
+    /**
+     * get a list of group ids for a user
+     * @param IUser $user
+     * @return array with group ids
+     */
+    public function getUserGroupIds(IUser $user) {
+        return array_map(function($value) {
+            return (string) $value;
+        }, array_keys($this->getUserGroups($user)));
+    }
+
+    /**
+     * get an array of groupid and displayName for a user
+     * @param IUser $user
+     * @return array ['displayName' => displayname]
+     */
+    public function getUserGroupNames(IUser $user) {
+        return array_map(function($group) {
+            return array('displayName' => $group->getDisplayName());
+        }, $this->getUserGroups($user));
+    }
+
+    /**
+     * get a list of all display names in a group
+     * @param string $gid
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array an array of display names (value) and user ids (key)
+     */
+    public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
+        $group = $this->get($gid);
+        if(is_null($group)) {
+            return array();
+        }
+
+        $search = trim($search);
+        $groupUsers = array();
+
+        if(!empty($search)) {
+            // only user backends have the capability to do a complex search for users
+            $searchOffset = 0;
+            $searchLimit = $limit * 100;
+            if($limit === -1) {
+                $searchLimit = 500;
+            }
+
+            do {
+                $filteredUsers = $this->userManager->searchDisplayName($search, $searchLimit, $searchOffset);
+                foreach($filteredUsers as $filteredUser) {
+                    if($group->inGroup($filteredUser)) {
+                        $groupUsers[]= $filteredUser;
+                    }
+                }
+                $searchOffset += $searchLimit;
+            } while(count($groupUsers) < $searchLimit+$offset && count($filteredUsers) >= $searchLimit);
+
+            if($limit === -1) {
+                $groupUsers = array_slice($groupUsers, $offset);
+            } else {
+                $groupUsers = array_slice($groupUsers, $offset, $limit);
+            }
+        } else {
+            $groupUsers = $group->searchUsers('', $limit, $offset);
+        }
+
+        $matchingUsers = array();
+        foreach($groupUsers as $groupUser) {
+            $matchingUsers[$groupUser->getUID()] = $groupUser->getDisplayName();
+        }
+        return $matchingUsers;
+    }
+
+    /**
+     * @return \OC\SubAdmin
+     */
+    public function getSubAdmin() {
+        if (!$this->subAdmin) {
+            $this->subAdmin = new \OC\SubAdmin(
+                $this->userManager,
+                $this,
+                \OC::$server->getDatabaseConnection()
+            );
+        }
+
+        return $this->subAdmin;
+    }
 }

lib/private/Memcache/APCu.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
 	 * Set a value in the cache if it's not already stored
 	 *
 	 * @param string $key
-	 * @param mixed $value
+	 * @param integer $value
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
 	 * @return bool
 	 */

Spacing +14 added lines, -14 removed lines

@@ -37,7 +37,7 @@ 
 	use CADTrait;
 
 	public function get($key) {
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
+		$result = apcu_fetch($this->getPrefix().$key, $success);
 		if (!$success) {
 			return null;
 		}
@@ -45,24 +45,24 @@ 
 	}
 
 	public function set($key, $value, $ttl = 0) {
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
+		return apcu_store($this->getPrefix().$key, $value, $ttl);
 	}
 
 	public function hasKey($key) {
-		return apcu_exists($this->getPrefix() . $key);
+		return apcu_exists($this->getPrefix().$key);
 	}
 
 	public function remove($key) {
-		return apcu_delete($this->getPrefix() . $key);
+		return apcu_delete($this->getPrefix().$key);
 	}
 
 	public function clear($prefix = '') {
-		$ns = $this->getPrefix() . $prefix;
+		$ns = $this->getPrefix().$prefix;
 		$ns = preg_quote($ns, '/');
-		if(class_exists('\APCIterator')) {
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
+		if (class_exists('\APCIterator')) {
+			$iter = new \APCIterator('user', '/^'.$ns.'/', APC_ITER_KEY);
 		} else {
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
+			$iter = new \APCUIterator('/^'.$ns.'/', APC_ITER_KEY);
 		}
 		return apcu_delete($iter);
 	}
@@ -76,7 +76,7 @@ 
 	 * @return bool
 	 */
 	public function add($key, $value, $ttl = 0) {
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
+		return apcu_add($this->getPrefix().$key, $value, $ttl);
 	}
 
 	/**
@@ -100,8 +100,8 @@ 
 		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
 		 * for details
 		 */
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_inc($this->getPrefix() . $key, $step)
+		return apcu_exists($this->getPrefix().$key)
+			? apcu_inc($this->getPrefix().$key, $step)
 			: false;
 	}
 
@@ -125,8 +125,8 @@ 
 		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
 		 * for details
 		 */
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_dec($this->getPrefix() . $key, $step)
+		return apcu_exists($this->getPrefix().$key)
+			? apcu_dec($this->getPrefix().$key, $step)
 			: false;
 	}
 
@@ -141,7 +141,7 @@ 
 	public function cas($key, $old, $new) {
 		// apc only does cas for ints
 		if (is_int($old) and is_int($new)) {
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
+			return apcu_cas($this->getPrefix().$key, $old, $new);
 		} else {
 			return $this->casEmulated($key, $old, $new);
 		}

Indentation +125 added lines, -125 removed lines

@@ -30,140 +30,140 @@
 use OCP\IMemcache;
 
 class APCu extends Cache implements IMemcache {
-	use CASTrait {
-		cas as casEmulated;
-	}
+    use CASTrait {
+        cas as casEmulated;
+    }
 
-	use CADTrait;
+    use CADTrait;
 
-	public function get($key) {
-		$result = apcu_fetch($this->getPrefix() . $key, $success);
-		if (!$success) {
-			return null;
-		}
-		return $result;
-	}
+    public function get($key) {
+        $result = apcu_fetch($this->getPrefix() . $key, $success);
+        if (!$success) {
+            return null;
+        }
+        return $result;
+    }
 
-	public function set($key, $value, $ttl = 0) {
-		return apcu_store($this->getPrefix() . $key, $value, $ttl);
-	}
+    public function set($key, $value, $ttl = 0) {
+        return apcu_store($this->getPrefix() . $key, $value, $ttl);
+    }
 
-	public function hasKey($key) {
-		return apcu_exists($this->getPrefix() . $key);
-	}
+    public function hasKey($key) {
+        return apcu_exists($this->getPrefix() . $key);
+    }
 
-	public function remove($key) {
-		return apcu_delete($this->getPrefix() . $key);
-	}
+    public function remove($key) {
+        return apcu_delete($this->getPrefix() . $key);
+    }
 
-	public function clear($prefix = '') {
-		$ns = $this->getPrefix() . $prefix;
-		$ns = preg_quote($ns, '/');
-		if(class_exists('\APCIterator')) {
-			$iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
-		} else {
-			$iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
-		}
-		return apcu_delete($iter);
-	}
+    public function clear($prefix = '') {
+        $ns = $this->getPrefix() . $prefix;
+        $ns = preg_quote($ns, '/');
+        if(class_exists('\APCIterator')) {
+            $iter = new \APCIterator('user', '/^' . $ns . '/', APC_ITER_KEY);
+        } else {
+            $iter = new \APCUIterator('/^' . $ns . '/', APC_ITER_KEY);
+        }
+        return apcu_delete($iter);
+    }
 
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 */
-	public function add($key, $value, $ttl = 0) {
-		return apcu_add($this->getPrefix() . $key, $value, $ttl);
-	}
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     */
+    public function add($key, $value, $ttl = 0) {
+        return apcu_add($this->getPrefix() . $key, $value, $ttl);
+    }
 
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$this->add($key, 0);
-		/**
-		 * TODO - hack around a PHP 7 specific issue in APCu
-		 *
-		 * on PHP 7 the apcu_inc method on a non-existing object will increment
-		 * "0" and result in "1" as value - therefore we check for existence
-		 * first
-		 *
-		 * on PHP 5.6 this is not the case
-		 *
-		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
-		 * for details
-		 */
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_inc($this->getPrefix() . $key, $step)
-			: false;
-	}
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $this->add($key, 0);
+        /**
+         * TODO - hack around a PHP 7 specific issue in APCu
+         *
+         * on PHP 7 the apcu_inc method on a non-existing object will increment
+         * "0" and result in "1" as value - therefore we check for existence
+         * first
+         *
+         * on PHP 5.6 this is not the case
+         *
+         * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
+         * for details
+         */
+        return apcu_exists($this->getPrefix() . $key)
+            ? apcu_inc($this->getPrefix() . $key, $step)
+            : false;
+    }
 
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		/**
-		 * TODO - hack around a PHP 7 specific issue in APCu
-		 *
-		 * on PHP 7 the apcu_dec method on a non-existing object will decrement
-		 * "0" and result in "-1" as value - therefore we check for existence
-		 * first
-		 *
-		 * on PHP 5.6 this is not the case
-		 *
-		 * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
-		 * for details
-		 */
-		return apcu_exists($this->getPrefix() . $key)
-			? apcu_dec($this->getPrefix() . $key, $step)
-			: false;
-	}
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        /**
+         * TODO - hack around a PHP 7 specific issue in APCu
+         *
+         * on PHP 7 the apcu_dec method on a non-existing object will decrement
+         * "0" and result in "-1" as value - therefore we check for existence
+         * first
+         *
+         * on PHP 5.6 this is not the case
+         *
+         * see https://github.com/krakjoe/apcu/issues/183#issuecomment-244038221
+         * for details
+         */
+        return apcu_exists($this->getPrefix() . $key)
+            ? apcu_dec($this->getPrefix() . $key, $step)
+            : false;
+    }
 
-	/**
-	 * Compare and set
-	 *
-	 * @param string $key
-	 * @param mixed $old
-	 * @param mixed $new
-	 * @return bool
-	 */
-	public function cas($key, $old, $new) {
-		// apc only does cas for ints
-		if (is_int($old) and is_int($new)) {
-			return apcu_cas($this->getPrefix() . $key, $old, $new);
-		} else {
-			return $this->casEmulated($key, $old, $new);
-		}
-	}
+    /**
+     * Compare and set
+     *
+     * @param string $key
+     * @param mixed $old
+     * @param mixed $new
+     * @return bool
+     */
+    public function cas($key, $old, $new) {
+        // apc only does cas for ints
+        if (is_int($old) and is_int($new)) {
+            return apcu_cas($this->getPrefix() . $key, $old, $new);
+        } else {
+            return $this->casEmulated($key, $old, $new);
+        }
+    }
 
-	/**
-	 * @return bool
-	 */
-	static public function isAvailable() {
-		if (!extension_loaded('apcu')) {
-			return false;
-		} elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) {
-			return false;
-		} elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) {
-			return false;
-		} elseif (
-				version_compare(phpversion('apc') ?: '0.0.0', '4.0.6') === -1 &&
-				version_compare(phpversion('apcu') ?: '0.0.0', '5.1.0') === -1
-		) {
-			return false;
-		} else {
-			return true;
-		}
-	}
+    /**
+     * @return bool
+     */
+    static public function isAvailable() {
+        if (!extension_loaded('apcu')) {
+            return false;
+        } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enabled')) {
+            return false;
+        } elseif (!\OC::$server->getIniWrapper()->getBool('apc.enable_cli') && \OC::$CLI) {
+            return false;
+        } elseif (
+                version_compare(phpversion('apc') ?: '0.0.0', '4.0.6') === -1 &&
+                version_compare(phpversion('apcu') ?: '0.0.0', '5.1.0') === -1
+        ) {
+            return false;
+        } else {
+            return true;
+        }
+    }
 }

lib/private/Memcache/ArrayCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
 	 * Set a value in the cache if it's not already stored
 	 *
 	 * @param string $key
-	 * @param mixed $value
+	 * @param integer $value
 	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
 	 * @return bool
 	 */

Indentation +117 added lines, -117 removed lines

@@ -27,133 +27,133 @@
 use OCP\IMemcache;
 
 class ArrayCache extends Cache implements IMemcache {
-	/** @var array Array with the cached data */
-	protected $cachedData = array();
+    /** @var array Array with the cached data */
+    protected $cachedData = array();
 
-	use CADTrait;
+    use CADTrait;
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function get($key) {
-		if ($this->hasKey($key)) {
-			return $this->cachedData[$key];
-		}
-		return null;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function get($key) {
+        if ($this->hasKey($key)) {
+            return $this->cachedData[$key];
+        }
+        return null;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function set($key, $value, $ttl = 0) {
-		$this->cachedData[$key] = $value;
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function set($key, $value, $ttl = 0) {
+        $this->cachedData[$key] = $value;
+        return true;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function hasKey($key) {
-		return isset($this->cachedData[$key]);
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function hasKey($key) {
+        return isset($this->cachedData[$key]);
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function remove($key) {
-		unset($this->cachedData[$key]);
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    public function remove($key) {
+        unset($this->cachedData[$key]);
+        return true;
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function clear($prefix = '') {
-		if ($prefix === '') {
-			$this->cachedData = [];
-			return true;
-		}
+    /**
+     * {@inheritDoc}
+     */
+    public function clear($prefix = '') {
+        if ($prefix === '') {
+            $this->cachedData = [];
+            return true;
+        }
 
-		foreach ($this->cachedData as $key => $value) {
-			if (strpos($key, $prefix) === 0) {
-				$this->remove($key);
-			}
-		}
-		return true;
-	}
+        foreach ($this->cachedData as $key => $value) {
+            if (strpos($key, $prefix) === 0) {
+                $this->remove($key);
+            }
+        }
+        return true;
+    }
 
-	/**
-	 * Set a value in the cache if it's not already stored
-	 *
-	 * @param string $key
-	 * @param mixed $value
-	 * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
-	 * @return bool
-	 */
-	public function add($key, $value, $ttl = 0) {
-		// since this cache is not shared race conditions aren't an issue
-		if ($this->hasKey($key)) {
-			return false;
-		} else {
-			return $this->set($key, $value, $ttl);
-		}
-	}
+    /**
+     * Set a value in the cache if it's not already stored
+     *
+     * @param string $key
+     * @param mixed $value
+     * @param int $ttl Time To Live in seconds. Defaults to 60*60*24
+     * @return bool
+     */
+    public function add($key, $value, $ttl = 0) {
+        // since this cache is not shared race conditions aren't an issue
+        if ($this->hasKey($key)) {
+            return false;
+        } else {
+            return $this->set($key, $value, $ttl);
+        }
+    }
 
-	/**
-	 * Increase a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function inc($key, $step = 1) {
-		$oldValue = $this->get($key);
-		if (is_int($oldValue)) {
-			$this->set($key, $oldValue + $step);
-			return $oldValue + $step;
-		} else {
-			$success = $this->add($key, $step);
-			return $success ? $step : false;
-		}
-	}
+    /**
+     * Increase a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function inc($key, $step = 1) {
+        $oldValue = $this->get($key);
+        if (is_int($oldValue)) {
+            $this->set($key, $oldValue + $step);
+            return $oldValue + $step;
+        } else {
+            $success = $this->add($key, $step);
+            return $success ? $step : false;
+        }
+    }
 
-	/**
-	 * Decrease a stored number
-	 *
-	 * @param string $key
-	 * @param int $step
-	 * @return int | bool
-	 */
-	public function dec($key, $step = 1) {
-		$oldValue = $this->get($key);
-		if (is_int($oldValue)) {
-			$this->set($key, $oldValue - $step);
-			return $oldValue - $step;
-		} else {
-			return false;
-		}
-	}
+    /**
+     * Decrease a stored number
+     *
+     * @param string $key
+     * @param int $step
+     * @return int | bool
+     */
+    public function dec($key, $step = 1) {
+        $oldValue = $this->get($key);
+        if (is_int($oldValue)) {
+            $this->set($key, $oldValue - $step);
+            return $oldValue - $step;
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * Compare and set
-	 *
-	 * @param string $key
-	 * @param mixed $old
-	 * @param mixed $new
-	 * @return bool
-	 */
-	public function cas($key, $old, $new) {
-		if ($this->get($key) === $old) {
-			return $this->set($key, $new);
-		} else {
-			return false;
-		}
-	}
+    /**
+     * Compare and set
+     *
+     * @param string $key
+     * @param mixed $old
+     * @param mixed $new
+     * @return bool
+     */
+    public function cas($key, $old, $new) {
+        if ($this->get($key) === $old) {
+            return $this->set($key, $new);
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * {@inheritDoc}
-	 */
-	static public function isAvailable() {
-		return true;
-	}
+    /**
+     * {@inheritDoc}
+     */
+    static public function isAvailable() {
+        return true;
+    }
 }

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

Doc Comments +3 added lines

@@ -498,6 +498,9 @@
 		});
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public function notify($path) {
 		$path = '/' . ltrim($path, '/');
 		$shareNotifyHandler = $this->share->notify($this->buildPath($path));

Spacing +13 added lines, -13 removed lines

@@ -95,8 +95,8 @@ 
 		$this->share = $this->server->getShare(trim($params['share'], '/'));
 
 		$this->root = $params['root'] ?? '/';
-		$this->root = '/' . ltrim($this->root, '/');
-		$this->root = rtrim($this->root, '/') . '/';
+		$this->root = '/'.ltrim($this->root, '/');
+		$this->root = rtrim($this->root, '/').'/';
 
 		$this->statCache = new CappedMemoryCache();
 		parent::__construct($params);
@@ -109,7 +109,7 @@ 
 		// FIXME: double slash to keep compatible with the old storage ids,
 		// failure to do so will lead to creation of a new storage id and
 		// loss of shares from the storage
-		return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
+		return 'smb::'.$this->server->getAuth()->getUsername().'@'.$this->server->getHost().'//'.$this->share->getName().'/'.$this->root;
 	}
 
 	/**
@@ -117,7 +117,7 @@ 
 	 * @return string
 	 */
 	protected function buildPath($path) {
-		return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
+		return Filesystem::normalizePath($this->root.'/'.$path, true, false, true);
 	}
 
 	protected function relativePath($fullPath) {
@@ -157,9 +157,9 @@ 
 			$path = $this->buildPath($path);
 			$files = $this->share->dir($path);
 			foreach ($files as $file) {
-				$this->statCache[$path . '/' . $file->getName()] = $file;
+				$this->statCache[$path.'/'.$file->getName()] = $file;
 			}
-			return array_filter($files, function (IFileInfo $file) {
+			return array_filter($files, function(IFileInfo $file) {
 				try {
 					return !$file->isHidden();
 				} catch (ForbiddenException $e) {
@@ -333,7 +333,7 @@ 
 				case 'w':
 				case 'wb':
 					$source = $this->share->write($fullPath);
-					return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
+					return CallBackWrapper::wrap($source, null, null, function() use ($fullPath) {
 						unset($this->statCache[$fullPath]);
 					});
 				case 'a':
@@ -365,7 +365,7 @@ 
 					}
 					$source = fopen($tmpFile, $mode);
 					$share = $this->share;
-					return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
+					return CallbackWrapper::wrap($source, null, null, function() use ($tmpFile, $fullPath, $share) {
 						unset($this->statCache[$fullPath]);
 						$share->put($tmpFile, $fullPath);
 						unlink($tmpFile);
@@ -391,7 +391,7 @@ 
 			$content = $this->share->dir($this->buildPath($path));
 			foreach ($content as $file) {
 				if ($file->isDirectory()) {
-					$this->rmdir($path . '/' . $file->getName());
+					$this->rmdir($path.'/'.$file->getName());
 				} else {
 					$this->share->del($file->getPath());
 				}
@@ -428,7 +428,7 @@ 
 		} catch (ForbiddenException $e) {
 			return false;
 		}
-		$names = array_map(function ($info) {
+		$names = array_map(function($info) {
 			/** @var \Icewind\SMB\IFileInfo $info */
 			return $info->getName();
 		}, $files);
@@ -510,7 +510,7 @@ 
 	 */
 	public static function checkDependencies() {
 		return (
-			(bool)\OC_Helper::findBinaryPath('smbclient')
+			(bool) \OC_Helper::findBinaryPath('smbclient')
 			|| NativeServer::available(new System())
 		) ? true : ['smbclient'];
 	}
@@ -529,7 +529,7 @@ 
 	}
 
 	public function listen($path, callable $callback) {
-		$this->notify($path)->listen(function (IChange $change) use ($callback) {
+		$this->notify($path)->listen(function(IChange $change) use ($callback) {
 			if ($change instanceof IRenameChange) {
 				return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
 			} else {
@@ -539,7 +539,7 @@ 
 	}
 
 	public function notify($path) {
-		$path = '/' . ltrim($path, '/');
+		$path = '/'.ltrim($path, '/');
 		$shareNotifyHandler = $this->share->notify($this->buildPath($path));
 		return new SMBNotifyHandler($shareNotifyHandler, $this->root);
 	}

Indentation +518 added lines, -518 removed lines

@@ -58,522 +58,522 @@
 use OCP\ILogger;
 
 class SMB extends Common implements INotifyStorage {
-	/**
-	 * @var \Icewind\SMB\IServer
-	 */
-	protected $server;
-
-	/**
-	 * @var \Icewind\SMB\IShare
-	 */
-	protected $share;
-
-	/**
-	 * @var string
-	 */
-	protected $root;
-
-	/**
-	 * @var \Icewind\SMB\IFileInfo[]
-	 */
-	protected $statCache;
-
-	public function __construct($params) {
-		if (!isset($params['host'])) {
-			throw new \Exception('Invalid configuration, no host provided');
-		}
-
-		if (isset($params['auth'])) {
-			$auth = $params['auth'];
-		} else if (isset($params['user']) && isset($params['password']) && isset($params['share'])) {
-			list($workgroup, $user) = $this->splitUser($params['user']);
-			$auth = new BasicAuth($user, $workgroup, $params['password']);
-		} else {
-			throw new \Exception('Invalid configuration, no credentials provided');
-		}
-
-		$serverFactory = new ServerFactory();
-		$this->server = $serverFactory->createServer($params['host'], $auth);
-		$this->share = $this->server->getShare(trim($params['share'], '/'));
-
-		$this->root = $params['root'] ?? '/';
-		$this->root = '/' . ltrim($this->root, '/');
-		$this->root = rtrim($this->root, '/') . '/';
-
-		$this->statCache = new CappedMemoryCache();
-		parent::__construct($params);
-	}
-
-	private function splitUser($user) {
-		if (strpos($user, '/')) {
-			return explode('/', $user, 2);
-		} elseif (strpos($user, '\\')) {
-			return explode('\\', $user);
-		} else {
-			return [null, $user];
-		}
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getId() {
-		// FIXME: double slash to keep compatible with the old storage ids,
-		// failure to do so will lead to creation of a new storage id and
-		// loss of shares from the storage
-		return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	protected function buildPath($path) {
-		return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
-	}
-
-	protected function relativePath($fullPath) {
-		if ($fullPath === $this->root) {
-			return '';
-		} else if (substr($fullPath, 0, strlen($this->root)) === $this->root) {
-			return substr($fullPath, strlen($this->root));
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return \Icewind\SMB\IFileInfo
-	 * @throws StorageNotAvailableException
-	 */
-	protected function getFileInfo($path) {
-		try {
-			$path = $this->buildPath($path);
-			if (!isset($this->statCache[$path])) {
-				$this->statCache[$path] = $this->share->stat($path);
-			}
-			return $this->statCache[$path];
-		} catch (ConnectException $e) {
-			\OC::$server->getLogger()->logException($e, ['message' => 'Error while getting file info']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return \Icewind\SMB\IFileInfo[]
-	 * @throws StorageNotAvailableException
-	 */
-	protected function getFolderContents($path) {
-		try {
-			$path = $this->buildPath($path);
-			$files = $this->share->dir($path);
-			foreach ($files as $file) {
-				$this->statCache[$path . '/' . $file->getName()] = $file;
-			}
-			return array_filter($files, function (IFileInfo $file) {
-				try {
-					return !$file->isHidden();
-				} catch (ForbiddenException $e) {
-					return false;
-				} catch (NotFoundException $e) {
-					return false;
-				}
-			});
-		} catch (ConnectException $e) {
-			\OC::$server->getLogger()->logException($e, ['message' => 'Error while getting folder content']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * @param \Icewind\SMB\IFileInfo $info
-	 * @return array
-	 */
-	protected function formatInfo($info) {
-		$result = [
-			'size' => $info->getSize(),
-			'mtime' => $info->getMTime(),
-		];
-		if ($info->isDirectory()) {
-			$result['type'] = 'dir';
-		} else {
-			$result['type'] = 'file';
-		}
-		return $result;
-	}
-
-	/**
-	 * Rename the files. If the source or the target is the root, the rename won't happen.
-	 *
-	 * @param string $source the old name of the path
-	 * @param string $target the new name of the path
-	 * @return bool true if the rename is successful, false otherwise
-	 */
-	public function rename($source, $target, $retry = true) {
-		if ($this->isRootDir($source) || $this->isRootDir($target)) {
-			return false;
-		}
-
-		$absoluteSource = $this->buildPath($source);
-		$absoluteTarget = $this->buildPath($target);
-		try {
-			$result = $this->share->rename($absoluteSource, $absoluteTarget);
-		} catch (AlreadyExistsException $e) {
-			if ($retry) {
-				$this->remove($target);
-				$result = $this->share->rename($absoluteSource, $absoluteTarget, false);
-			} else {
-				\OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
-				return false;
-			}
-		} catch (InvalidArgumentException $e) {
-			if ($retry) {
-				$this->remove($target);
-				$result = $this->share->rename($absoluteSource, $absoluteTarget, false);
-			} else {
-				\OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
-				return false;
-			}
-		} catch (\Exception $e) {
-			\OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
-			return false;
-		}
-		unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]);
-		return $result;
-	}
-
-	public function stat($path) {
-		try {
-			$result = $this->formatInfo($this->getFileInfo($path));
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (NotFoundException $e) {
-			return false;
-		}
-		if ($this->remoteIsShare() && $this->isRootDir($path)) {
-			$result['mtime'] = $this->shareMTime();
-		}
-		return $result;
-	}
-
-	/**
-	 * get the best guess for the modification time of the share
-	 *
-	 * @return int
-	 */
-	private function shareMTime() {
-		$highestMTime = 0;
-		$files = $this->share->dir($this->root);
-		foreach ($files as $fileInfo) {
-			try {
-				if ($fileInfo->getMTime() > $highestMTime) {
-					$highestMTime = $fileInfo->getMTime();
-				}
-			} catch (NotFoundException $e) {
-				// Ignore this, can happen on unavailable DFS shares
-			}
-		}
-		return $highestMTime;
-	}
-
-	/**
-	 * Check if the path is our root dir (not the smb one)
-	 *
-	 * @param string $path the path
-	 * @return bool
-	 */
-	private function isRootDir($path) {
-		return $path === '' || $path === '/' || $path === '.';
-	}
-
-	/**
-	 * Check if our root points to a smb share
-	 *
-	 * @return bool true if our root points to a share false otherwise
-	 */
-	private function remoteIsShare() {
-		return $this->share->getName() && (!$this->root || $this->root === '/');
-	}
-
-	/**
-	 * @param string $path
-	 * @return bool
-	 */
-	public function unlink($path) {
-		if ($this->isRootDir($path)) {
-			return false;
-		}
-
-		try {
-			if ($this->is_dir($path)) {
-				return $this->rmdir($path);
-			} else {
-				$path = $this->buildPath($path);
-				unset($this->statCache[$path]);
-				$this->share->del($path);
-				return true;
-			}
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (ConnectException $e) {
-			\OC::$server->getLogger()->logException($e, ['message' => 'Error while deleting file']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	/**
-	 * check if a file or folder has been updated since $time
-	 *
-	 * @param string $path
-	 * @param int $time
-	 * @return bool
-	 */
-	public function hasUpdated($path, $time) {
-		if (!$path and $this->root === '/') {
-			// mtime doesn't work for shares, but giving the nature of the backend,
-			// doing a full update is still just fast enough
-			return true;
-		} else {
-			$actualTime = $this->filemtime($path);
-			return $actualTime > $time;
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|false
-	 */
-	public function fopen($path, $mode) {
-		$fullPath = $this->buildPath($path);
-		try {
-			switch ($mode) {
-				case 'r':
-				case 'rb':
-					if (!$this->file_exists($path)) {
-						return false;
-					}
-					return $this->share->read($fullPath);
-				case 'w':
-				case 'wb':
-					$source = $this->share->write($fullPath);
-					return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
-						unset($this->statCache[$fullPath]);
-					});
-				case 'a':
-				case 'ab':
-				case 'r+':
-				case 'w+':
-				case 'wb+':
-				case 'a+':
-				case 'x':
-				case 'x+':
-				case 'c':
-				case 'c+':
-					//emulate these
-					if (strrpos($path, '.') !== false) {
-						$ext = substr($path, strrpos($path, '.'));
-					} else {
-						$ext = '';
-					}
-					if ($this->file_exists($path)) {
-						if (!$this->isUpdatable($path)) {
-							return false;
-						}
-						$tmpFile = $this->getCachedFile($path);
-					} else {
-						if (!$this->isCreatable(dirname($path))) {
-							return false;
-						}
-						$tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
-					}
-					$source = fopen($tmpFile, $mode);
-					$share = $this->share;
-					return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
-						unset($this->statCache[$fullPath]);
-						$share->put($tmpFile, $fullPath);
-						unlink($tmpFile);
-					});
-			}
-			return false;
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (ConnectException $e) {
-			\OC::$server->getLogger()->logException($e, ['message' => 'Error while opening file']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	public function rmdir($path) {
-		if ($this->isRootDir($path)) {
-			return false;
-		}
-
-		try {
-			$this->statCache = array();
-			$content = $this->share->dir($this->buildPath($path));
-			foreach ($content as $file) {
-				if ($file->isDirectory()) {
-					$this->rmdir($path . '/' . $file->getName());
-				} else {
-					$this->share->del($file->getPath());
-				}
-			}
-			$this->share->rmdir($this->buildPath($path));
-			return true;
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (ConnectException $e) {
-			\OC::$server->getLogger()->logException($e, ['message' => 'Error while removing folder']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	public function touch($path, $time = null) {
-		try {
-			if (!$this->file_exists($path)) {
-				$fh = $this->share->write($this->buildPath($path));
-				fclose($fh);
-				return true;
-			}
-			return false;
-		} catch (ConnectException $e) {
-			\OC::$server->getLogger()->logException($e, ['message' => 'Error while creating file']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	public function opendir($path) {
-		try {
-			$files = $this->getFolderContents($path);
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-		$names = array_map(function ($info) {
-			/** @var \Icewind\SMB\IFileInfo $info */
-			return $info->getName();
-		}, $files);
-		return IteratorDirectory::wrap($names);
-	}
-
-	public function filetype($path) {
-		try {
-			return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-	}
-
-	public function mkdir($path) {
-		$path = $this->buildPath($path);
-		try {
-			$this->share->mkdir($path);
-			return true;
-		} catch (ConnectException $e) {
-			\OC::$server->getLogger()->logException($e, ['message' => 'Error while creating folder']);
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		} catch (Exception $e) {
-			return false;
-		}
-	}
-
-	public function file_exists($path) {
-		try {
-			$this->getFileInfo($path);
-			return true;
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		} catch (ConnectException $e) {
-			throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
-		}
-	}
-
-	public function isReadable($path) {
-		try {
-			$info = $this->getFileInfo($path);
-			return !$info->isHidden();
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-	}
-
-	public function isUpdatable($path) {
-		try {
-			$info = $this->getFileInfo($path);
-			// following windows behaviour for read-only folders: they can be written into
-			// (https://support.microsoft.com/en-us/kb/326549 - "cause" section)
-			return !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path));
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-	}
-
-	public function isDeletable($path) {
-		try {
-			$info = $this->getFileInfo($path);
-			return !$info->isHidden() && !$info->isReadOnly();
-		} catch (NotFoundException $e) {
-			return false;
-		} catch (ForbiddenException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * check if smbclient is installed
-	 */
-	public static function checkDependencies() {
-		return (
-			(bool)\OC_Helper::findBinaryPath('smbclient')
-			|| NativeServer::available(new System())
-		) ? true : ['smbclient'];
-	}
-
-	/**
-	 * Test a storage for availability
-	 *
-	 * @return bool
-	 */
-	public function test() {
-		try {
-			return parent::test();
-		} catch (Exception $e) {
-			\OC::$server->getLogger()->logException($e);
-			return false;
-		}
-	}
-
-	public function listen($path, callable $callback) {
-		$this->notify($path)->listen(function (IChange $change) use ($callback) {
-			if ($change instanceof IRenameChange) {
-				return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
-			} else {
-				return $callback($change->getType(), $change->getPath());
-			}
-		});
-	}
-
-	public function notify($path) {
-		$path = '/' . ltrim($path, '/');
-		$shareNotifyHandler = $this->share->notify($this->buildPath($path));
-		return new SMBNotifyHandler($shareNotifyHandler, $this->root);
-	}
+    /**
+     * @var \Icewind\SMB\IServer
+     */
+    protected $server;
+
+    /**
+     * @var \Icewind\SMB\IShare
+     */
+    protected $share;
+
+    /**
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * @var \Icewind\SMB\IFileInfo[]
+     */
+    protected $statCache;
+
+    public function __construct($params) {
+        if (!isset($params['host'])) {
+            throw new \Exception('Invalid configuration, no host provided');
+        }
+
+        if (isset($params['auth'])) {
+            $auth = $params['auth'];
+        } else if (isset($params['user']) && isset($params['password']) && isset($params['share'])) {
+            list($workgroup, $user) = $this->splitUser($params['user']);
+            $auth = new BasicAuth($user, $workgroup, $params['password']);
+        } else {
+            throw new \Exception('Invalid configuration, no credentials provided');
+        }
+
+        $serverFactory = new ServerFactory();
+        $this->server = $serverFactory->createServer($params['host'], $auth);
+        $this->share = $this->server->getShare(trim($params['share'], '/'));
+
+        $this->root = $params['root'] ?? '/';
+        $this->root = '/' . ltrim($this->root, '/');
+        $this->root = rtrim($this->root, '/') . '/';
+
+        $this->statCache = new CappedMemoryCache();
+        parent::__construct($params);
+    }
+
+    private function splitUser($user) {
+        if (strpos($user, '/')) {
+            return explode('/', $user, 2);
+        } elseif (strpos($user, '\\')) {
+            return explode('\\', $user);
+        } else {
+            return [null, $user];
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getId() {
+        // FIXME: double slash to keep compatible with the old storage ids,
+        // failure to do so will lead to creation of a new storage id and
+        // loss of shares from the storage
+        return 'smb::' . $this->server->getAuth()->getUsername() . '@' . $this->server->getHost() . '//' . $this->share->getName() . '/' . $this->root;
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    protected function buildPath($path) {
+        return Filesystem::normalizePath($this->root . '/' . $path, true, false, true);
+    }
+
+    protected function relativePath($fullPath) {
+        if ($fullPath === $this->root) {
+            return '';
+        } else if (substr($fullPath, 0, strlen($this->root)) === $this->root) {
+            return substr($fullPath, strlen($this->root));
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return \Icewind\SMB\IFileInfo
+     * @throws StorageNotAvailableException
+     */
+    protected function getFileInfo($path) {
+        try {
+            $path = $this->buildPath($path);
+            if (!isset($this->statCache[$path])) {
+                $this->statCache[$path] = $this->share->stat($path);
+            }
+            return $this->statCache[$path];
+        } catch (ConnectException $e) {
+            \OC::$server->getLogger()->logException($e, ['message' => 'Error while getting file info']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return \Icewind\SMB\IFileInfo[]
+     * @throws StorageNotAvailableException
+     */
+    protected function getFolderContents($path) {
+        try {
+            $path = $this->buildPath($path);
+            $files = $this->share->dir($path);
+            foreach ($files as $file) {
+                $this->statCache[$path . '/' . $file->getName()] = $file;
+            }
+            return array_filter($files, function (IFileInfo $file) {
+                try {
+                    return !$file->isHidden();
+                } catch (ForbiddenException $e) {
+                    return false;
+                } catch (NotFoundException $e) {
+                    return false;
+                }
+            });
+        } catch (ConnectException $e) {
+            \OC::$server->getLogger()->logException($e, ['message' => 'Error while getting folder content']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * @param \Icewind\SMB\IFileInfo $info
+     * @return array
+     */
+    protected function formatInfo($info) {
+        $result = [
+            'size' => $info->getSize(),
+            'mtime' => $info->getMTime(),
+        ];
+        if ($info->isDirectory()) {
+            $result['type'] = 'dir';
+        } else {
+            $result['type'] = 'file';
+        }
+        return $result;
+    }
+
+    /**
+     * Rename the files. If the source or the target is the root, the rename won't happen.
+     *
+     * @param string $source the old name of the path
+     * @param string $target the new name of the path
+     * @return bool true if the rename is successful, false otherwise
+     */
+    public function rename($source, $target, $retry = true) {
+        if ($this->isRootDir($source) || $this->isRootDir($target)) {
+            return false;
+        }
+
+        $absoluteSource = $this->buildPath($source);
+        $absoluteTarget = $this->buildPath($target);
+        try {
+            $result = $this->share->rename($absoluteSource, $absoluteTarget);
+        } catch (AlreadyExistsException $e) {
+            if ($retry) {
+                $this->remove($target);
+                $result = $this->share->rename($absoluteSource, $absoluteTarget, false);
+            } else {
+                \OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
+                return false;
+            }
+        } catch (InvalidArgumentException $e) {
+            if ($retry) {
+                $this->remove($target);
+                $result = $this->share->rename($absoluteSource, $absoluteTarget, false);
+            } else {
+                \OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
+                return false;
+            }
+        } catch (\Exception $e) {
+            \OC::$server->getLogger()->logException($e, ['level' => ILogger::WARN]);
+            return false;
+        }
+        unset($this->statCache[$absoluteSource], $this->statCache[$absoluteTarget]);
+        return $result;
+    }
+
+    public function stat($path) {
+        try {
+            $result = $this->formatInfo($this->getFileInfo($path));
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (NotFoundException $e) {
+            return false;
+        }
+        if ($this->remoteIsShare() && $this->isRootDir($path)) {
+            $result['mtime'] = $this->shareMTime();
+        }
+        return $result;
+    }
+
+    /**
+     * get the best guess for the modification time of the share
+     *
+     * @return int
+     */
+    private function shareMTime() {
+        $highestMTime = 0;
+        $files = $this->share->dir($this->root);
+        foreach ($files as $fileInfo) {
+            try {
+                if ($fileInfo->getMTime() > $highestMTime) {
+                    $highestMTime = $fileInfo->getMTime();
+                }
+            } catch (NotFoundException $e) {
+                // Ignore this, can happen on unavailable DFS shares
+            }
+        }
+        return $highestMTime;
+    }
+
+    /**
+     * Check if the path is our root dir (not the smb one)
+     *
+     * @param string $path the path
+     * @return bool
+     */
+    private function isRootDir($path) {
+        return $path === '' || $path === '/' || $path === '.';
+    }
+
+    /**
+     * Check if our root points to a smb share
+     *
+     * @return bool true if our root points to a share false otherwise
+     */
+    private function remoteIsShare() {
+        return $this->share->getName() && (!$this->root || $this->root === '/');
+    }
+
+    /**
+     * @param string $path
+     * @return bool
+     */
+    public function unlink($path) {
+        if ($this->isRootDir($path)) {
+            return false;
+        }
+
+        try {
+            if ($this->is_dir($path)) {
+                return $this->rmdir($path);
+            } else {
+                $path = $this->buildPath($path);
+                unset($this->statCache[$path]);
+                $this->share->del($path);
+                return true;
+            }
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (ConnectException $e) {
+            \OC::$server->getLogger()->logException($e, ['message' => 'Error while deleting file']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * check if a file or folder has been updated since $time
+     *
+     * @param string $path
+     * @param int $time
+     * @return bool
+     */
+    public function hasUpdated($path, $time) {
+        if (!$path and $this->root === '/') {
+            // mtime doesn't work for shares, but giving the nature of the backend,
+            // doing a full update is still just fast enough
+            return true;
+        } else {
+            $actualTime = $this->filemtime($path);
+            return $actualTime > $time;
+        }
+    }
+
+    /**
+     * @param string $path
+     * @param string $mode
+     * @return resource|false
+     */
+    public function fopen($path, $mode) {
+        $fullPath = $this->buildPath($path);
+        try {
+            switch ($mode) {
+                case 'r':
+                case 'rb':
+                    if (!$this->file_exists($path)) {
+                        return false;
+                    }
+                    return $this->share->read($fullPath);
+                case 'w':
+                case 'wb':
+                    $source = $this->share->write($fullPath);
+                    return CallBackWrapper::wrap($source, null, null, function () use ($fullPath) {
+                        unset($this->statCache[$fullPath]);
+                    });
+                case 'a':
+                case 'ab':
+                case 'r+':
+                case 'w+':
+                case 'wb+':
+                case 'a+':
+                case 'x':
+                case 'x+':
+                case 'c':
+                case 'c+':
+                    //emulate these
+                    if (strrpos($path, '.') !== false) {
+                        $ext = substr($path, strrpos($path, '.'));
+                    } else {
+                        $ext = '';
+                    }
+                    if ($this->file_exists($path)) {
+                        if (!$this->isUpdatable($path)) {
+                            return false;
+                        }
+                        $tmpFile = $this->getCachedFile($path);
+                    } else {
+                        if (!$this->isCreatable(dirname($path))) {
+                            return false;
+                        }
+                        $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext);
+                    }
+                    $source = fopen($tmpFile, $mode);
+                    $share = $this->share;
+                    return CallbackWrapper::wrap($source, null, null, function () use ($tmpFile, $fullPath, $share) {
+                        unset($this->statCache[$fullPath]);
+                        $share->put($tmpFile, $fullPath);
+                        unlink($tmpFile);
+                    });
+            }
+            return false;
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (ConnectException $e) {
+            \OC::$server->getLogger()->logException($e, ['message' => 'Error while opening file']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function rmdir($path) {
+        if ($this->isRootDir($path)) {
+            return false;
+        }
+
+        try {
+            $this->statCache = array();
+            $content = $this->share->dir($this->buildPath($path));
+            foreach ($content as $file) {
+                if ($file->isDirectory()) {
+                    $this->rmdir($path . '/' . $file->getName());
+                } else {
+                    $this->share->del($file->getPath());
+                }
+            }
+            $this->share->rmdir($this->buildPath($path));
+            return true;
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (ConnectException $e) {
+            \OC::$server->getLogger()->logException($e, ['message' => 'Error while removing folder']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function touch($path, $time = null) {
+        try {
+            if (!$this->file_exists($path)) {
+                $fh = $this->share->write($this->buildPath($path));
+                fclose($fh);
+                return true;
+            }
+            return false;
+        } catch (ConnectException $e) {
+            \OC::$server->getLogger()->logException($e, ['message' => 'Error while creating file']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function opendir($path) {
+        try {
+            $files = $this->getFolderContents($path);
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+        $names = array_map(function ($info) {
+            /** @var \Icewind\SMB\IFileInfo $info */
+            return $info->getName();
+        }, $files);
+        return IteratorDirectory::wrap($names);
+    }
+
+    public function filetype($path) {
+        try {
+            return $this->getFileInfo($path)->isDirectory() ? 'dir' : 'file';
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+    }
+
+    public function mkdir($path) {
+        $path = $this->buildPath($path);
+        try {
+            $this->share->mkdir($path);
+            return true;
+        } catch (ConnectException $e) {
+            \OC::$server->getLogger()->logException($e, ['message' => 'Error while creating folder']);
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        } catch (Exception $e) {
+            return false;
+        }
+    }
+
+    public function file_exists($path) {
+        try {
+            $this->getFileInfo($path);
+            return true;
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        } catch (ConnectException $e) {
+            throw new StorageNotAvailableException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function isReadable($path) {
+        try {
+            $info = $this->getFileInfo($path);
+            return !$info->isHidden();
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+    }
+
+    public function isUpdatable($path) {
+        try {
+            $info = $this->getFileInfo($path);
+            // following windows behaviour for read-only folders: they can be written into
+            // (https://support.microsoft.com/en-us/kb/326549 - "cause" section)
+            return !$info->isHidden() && (!$info->isReadOnly() || $this->is_dir($path));
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+    }
+
+    public function isDeletable($path) {
+        try {
+            $info = $this->getFileInfo($path);
+            return !$info->isHidden() && !$info->isReadOnly();
+        } catch (NotFoundException $e) {
+            return false;
+        } catch (ForbiddenException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * check if smbclient is installed
+     */
+    public static function checkDependencies() {
+        return (
+            (bool)\OC_Helper::findBinaryPath('smbclient')
+            || NativeServer::available(new System())
+        ) ? true : ['smbclient'];
+    }
+
+    /**
+     * Test a storage for availability
+     *
+     * @return bool
+     */
+    public function test() {
+        try {
+            return parent::test();
+        } catch (Exception $e) {
+            \OC::$server->getLogger()->logException($e);
+            return false;
+        }
+    }
+
+    public function listen($path, callable $callback) {
+        $this->notify($path)->listen(function (IChange $change) use ($callback) {
+            if ($change instanceof IRenameChange) {
+                return $callback($change->getType(), $change->getPath(), $change->getTargetPath());
+            } else {
+                return $callback($change->getType(), $change->getPath());
+            }
+        });
+    }
+
+    public function notify($path) {
+        $path = '/' . ltrim($path, '/');
+        $shareNotifyHandler = $this->share->notify($this->buildPath($path));
+        return new SMBNotifyHandler($shareNotifyHandler, $this->root);
+    }
 }

lib/public/AppFramework/Http/StreamResponse.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
 	private $filePath;
 
 	/**
-	 * @param string|resource $filePath the path to the file or a file handle which should be streamed
+	 * @param string $filePath the path to the file or a file handle which should be streamed
 	 * @since 8.1.0
 	 */
 	public function __construct ($filePath) {

Indentation +25 added lines, -25 removed lines

@@ -33,33 +33,33 @@
  * @since 8.1.0
  */
 class StreamResponse extends Response implements ICallbackResponse {
-	/** @var string */
-	private $filePath;
+    /** @var string */
+    private $filePath;
 
-	/**
-	 * @param string|resource $filePath the path to the file or a file handle which should be streamed
-	 * @since 8.1.0
-	 */
-	public function __construct ($filePath) {
-		$this->filePath = $filePath;
-	}
+    /**
+     * @param string|resource $filePath the path to the file or a file handle which should be streamed
+     * @since 8.1.0
+     */
+    public function __construct ($filePath) {
+        $this->filePath = $filePath;
+    }
 
 
-	/**
-	 * Streams the file using readfile
-	 *
-	 * @param IOutput $output a small wrapper that handles output
-	 * @since 8.1.0
-	 */
-	public function callback (IOutput $output) {
-		// handle caching
-		if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
-			if (!(is_resource($this->filePath) || file_exists($this->filePath))) {
-				$output->setHttpResponseCode(Http::STATUS_NOT_FOUND);
-			} elseif ($output->setReadfile($this->filePath) === false) {
-				$output->setHttpResponseCode(Http::STATUS_BAD_REQUEST);
-			}
-		}
-	}
+    /**
+     * Streams the file using readfile
+     *
+     * @param IOutput $output a small wrapper that handles output
+     * @since 8.1.0
+     */
+    public function callback (IOutput $output) {
+        // handle caching
+        if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
+            if (!(is_resource($this->filePath) || file_exists($this->filePath))) {
+                $output->setHttpResponseCode(Http::STATUS_NOT_FOUND);
+            } elseif ($output->setReadfile($this->filePath) === false) {
+                $output->setHttpResponseCode(Http::STATUS_BAD_REQUEST);
+            }
+        }
+    }
 
 }

Spacing +2 added lines, -2 removed lines

@@ -40,7 +40,7 @@ 
 	 * @param string|resource $filePath the path to the file or a file handle which should be streamed
 	 * @since 8.1.0
 	 */
-	public function __construct ($filePath) {
+	public function __construct($filePath) {
 		$this->filePath = $filePath;
 	}
 
@@ -51,7 +51,7 @@ 
 	 * @param IOutput $output a small wrapper that handles output
 	 * @since 8.1.0
 	 */
-	public function callback (IOutput $output) {
+	public function callback(IOutput $output) {
 		// handle caching
 		if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) {
 			if (!(is_resource($this->filePath) || file_exists($this->filePath))) {