nextcloud / server

apps/files_external/lib/AppInfo/Application.php

Indentation +103 added lines, -103 removed lines

@@ -52,108 +52,108 @@
  */
 class Application extends App implements IBackendProvider, IAuthMechanismProvider {
 
-	public function __construct(array $urlParams = array()) {
-		parent::__construct('files_external', $urlParams);
-
-		$container = $this->getContainer();
-
-		$container->registerService('OCP\Files\Config\IUserMountCache', function (IAppContainer $c) {
-			return $c->getServer()->query('UserMountCache');
-		});
-
-		$backendService = $container->query('OCA\\Files_External\\Service\\BackendService');
-		$backendService->registerBackendProvider($this);
-		$backendService->registerAuthMechanismProvider($this);
-
-		// force-load auth mechanisms since some will register hooks
-		// TODO: obsolete these and use the TokenProvider to get the user's password from the session
-		$this->getAuthMechanisms();
-
-		// app developers: do NOT depend on this! it will disappear with oC 9.0!
-		\OC::$server->getEventDispatcher()->dispatch(
-			'OCA\\Files_External::loadAdditionalBackends'
-		);
-	}
-
-	/**
-	 * Register settings templates
-	 */
-	public function registerSettings() {
-		$container = $this->getContainer();
-		$userSession = $container->getServer()->getUserSession();
-		if (!$userSession->isLoggedIn()) {
-			return;
-		}
-		$backendService = $container->query('OCA\\Files_External\\Service\\BackendService');
-
-		/** @var \OCA\Files_External\Service\UserGlobalStoragesService $userGlobalStoragesService */
-		$userGlobalStoragesService = $container->query('OCA\Files_External\Service\UserGlobalStoragesService');
-		if (count($userGlobalStoragesService->getStorages()) > 0 || $backendService->isUserMountingAllowed()) {
-			\OCP\App::registerPersonal('files_external', 'personal');
-		}
-	}
-
-	/**
-	 * @{inheritdoc}
-	 */
-	public function getBackends() {
-		$container = $this->getContainer();
-
-		$backends = [
-			$container->query(Local::class),
-			$container->query(FTP::class),
-			$container->query(DAV::class),
-			$container->query(OwnCloud::class),
-			$container->query(SFTP::class),
-			$container->query(AmazonS3::class),
-			$container->query(Dropbox::class),
-			$container->query(Google::class),
-			$container->query(Swift::class),
-			$container->query(SFTP_Key::class),
-			$container->query(SMB::class),
-			$container->query(SMB_OC::class),
-			$container->query(SharePoint::class),
-		];
-
-		return $backends;
-	}
-
-	/**
-	 * @{inheritdoc}
-	 */
-	public function getAuthMechanisms() {
-		$container = $this->getContainer();
-
-		return [
-			// AuthMechanism::SCHEME_NULL mechanism
-			$container->query('OCA\Files_External\Lib\Auth\NullMechanism'),
-
-			// AuthMechanism::SCHEME_BUILTIN mechanism
-			$container->query('OCA\Files_External\Lib\Auth\Builtin'),
-
-			// AuthMechanism::SCHEME_PASSWORD mechanisms
-			$container->query('OCA\Files_External\Lib\Auth\Password\Password'),
-			$container->query('OCA\Files_External\Lib\Auth\Password\SessionCredentials'),
-			$container->query('OCA\Files_External\Lib\Auth\Password\LoginCredentials'),
-			$container->query('OCA\Files_External\Lib\Auth\Password\UserProvided'),
-			$container->query('OCA\Files_External\Lib\Auth\Password\GlobalAuth'),
-
-			// AuthMechanism::SCHEME_OAUTH1 mechanisms
-			$container->query('OCA\Files_External\Lib\Auth\OAuth1\OAuth1'),
-
-			// AuthMechanism::SCHEME_OAUTH2 mechanisms
-			$container->query('OCA\Files_External\Lib\Auth\OAuth2\OAuth2'),
-
-			// AuthMechanism::SCHEME_PUBLICKEY mechanisms
-			$container->query('OCA\Files_External\Lib\Auth\PublicKey\RSA'),
-
-			// AuthMechanism::SCHEME_OPENSTACK mechanisms
-			$container->query('OCA\Files_External\Lib\Auth\OpenStack\OpenStack'),
-			$container->query('OCA\Files_External\Lib\Auth\OpenStack\Rackspace'),
-
-			// Specialized mechanisms
-			$container->query('OCA\Files_External\Lib\Auth\AmazonS3\AccessKey'),
-		];
-	}
+    public function __construct(array $urlParams = array()) {
+        parent::__construct('files_external', $urlParams);
+
+        $container = $this->getContainer();
+
+        $container->registerService('OCP\Files\Config\IUserMountCache', function (IAppContainer $c) {
+            return $c->getServer()->query('UserMountCache');
+        });
+
+        $backendService = $container->query('OCA\\Files_External\\Service\\BackendService');
+        $backendService->registerBackendProvider($this);
+        $backendService->registerAuthMechanismProvider($this);
+
+        // force-load auth mechanisms since some will register hooks
+        // TODO: obsolete these and use the TokenProvider to get the user's password from the session
+        $this->getAuthMechanisms();
+
+        // app developers: do NOT depend on this! it will disappear with oC 9.0!
+        \OC::$server->getEventDispatcher()->dispatch(
+            'OCA\\Files_External::loadAdditionalBackends'
+        );
+    }
+
+    /**
+     * Register settings templates
+     */
+    public function registerSettings() {
+        $container = $this->getContainer();
+        $userSession = $container->getServer()->getUserSession();
+        if (!$userSession->isLoggedIn()) {
+            return;
+        }
+        $backendService = $container->query('OCA\\Files_External\\Service\\BackendService');
+
+        /** @var \OCA\Files_External\Service\UserGlobalStoragesService $userGlobalStoragesService */
+        $userGlobalStoragesService = $container->query('OCA\Files_External\Service\UserGlobalStoragesService');
+        if (count($userGlobalStoragesService->getStorages()) > 0 || $backendService->isUserMountingAllowed()) {
+            \OCP\App::registerPersonal('files_external', 'personal');
+        }
+    }
+
+    /**
+     * @{inheritdoc}
+     */
+    public function getBackends() {
+        $container = $this->getContainer();
+
+        $backends = [
+            $container->query(Local::class),
+            $container->query(FTP::class),
+            $container->query(DAV::class),
+            $container->query(OwnCloud::class),
+            $container->query(SFTP::class),
+            $container->query(AmazonS3::class),
+            $container->query(Dropbox::class),
+            $container->query(Google::class),
+            $container->query(Swift::class),
+            $container->query(SFTP_Key::class),
+            $container->query(SMB::class),
+            $container->query(SMB_OC::class),
+            $container->query(SharePoint::class),
+        ];
+
+        return $backends;
+    }
+
+    /**
+     * @{inheritdoc}
+     */
+    public function getAuthMechanisms() {
+        $container = $this->getContainer();
+
+        return [
+            // AuthMechanism::SCHEME_NULL mechanism
+            $container->query('OCA\Files_External\Lib\Auth\NullMechanism'),
+
+            // AuthMechanism::SCHEME_BUILTIN mechanism
+            $container->query('OCA\Files_External\Lib\Auth\Builtin'),
+
+            // AuthMechanism::SCHEME_PASSWORD mechanisms
+            $container->query('OCA\Files_External\Lib\Auth\Password\Password'),
+            $container->query('OCA\Files_External\Lib\Auth\Password\SessionCredentials'),
+            $container->query('OCA\Files_External\Lib\Auth\Password\LoginCredentials'),
+            $container->query('OCA\Files_External\Lib\Auth\Password\UserProvided'),
+            $container->query('OCA\Files_External\Lib\Auth\Password\GlobalAuth'),
+
+            // AuthMechanism::SCHEME_OAUTH1 mechanisms
+            $container->query('OCA\Files_External\Lib\Auth\OAuth1\OAuth1'),
+
+            // AuthMechanism::SCHEME_OAUTH2 mechanisms
+            $container->query('OCA\Files_External\Lib\Auth\OAuth2\OAuth2'),
+
+            // AuthMechanism::SCHEME_PUBLICKEY mechanisms
+            $container->query('OCA\Files_External\Lib\Auth\PublicKey\RSA'),
+
+            // AuthMechanism::SCHEME_OPENSTACK mechanisms
+            $container->query('OCA\Files_External\Lib\Auth\OpenStack\OpenStack'),
+            $container->query('OCA\Files_External\Lib\Auth\OpenStack\Rackspace'),
+
+            // Specialized mechanisms
+            $container->query('OCA\Files_External\Lib\Auth\AmazonS3\AccessKey'),
+        ];
+    }
 
 }

apps/files_external/lib/Lib/Backend/SharePoint.php

Indentation +13 added lines, -13 removed lines

@@ -32,18 +32,18 @@
 
 class SharePoint extends Backend {
 
-	public function __construct(IL10N $l, Password $legacyAuth) {
-		$this
-			->setIdentifier('sharepoint')
-			->setStorageClass(SharePointStorage::class)
-			->setText($l->t('SharePoint'))
-			->addParameters([
-				(new DefinitionParameter('host', $l->t('Host'))),
-				(new DefinitionParameter('documentLibrary', $l->t('Document Library'))),
-			])
-			->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
-			->setLegacyAuthMechanism($legacyAuth)
-		;
-	}
+    public function __construct(IL10N $l, Password $legacyAuth) {
+        $this
+            ->setIdentifier('sharepoint')
+            ->setStorageClass(SharePointStorage::class)
+            ->setText($l->t('SharePoint'))
+            ->addParameters([
+                (new DefinitionParameter('host', $l->t('Host'))),
+                (new DefinitionParameter('documentLibrary', $l->t('Document Library'))),
+            ])
+            ->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
+            ->setLegacyAuthMechanism($legacyAuth)
+        ;
+    }
 
 }

apps/files_external/lib/Lib/SharePoint/ContextsFactory.php

Indentation +6 added lines, -6 removed lines

@@ -30,12 +30,12 @@
 
 class ContextsFactory {
 
-	public function getAuthContext($user, $password) {
-		return new NetworkCredentialContext($user, $password);
-	}
+    public function getAuthContext($user, $password) {
+        return new NetworkCredentialContext($user, $password);
+    }
 
-	public function getClientContext($server, IAuthenticationContext $authContext) {
-		return new ClientContext($server, $authContext);
-	}
+    public function getClientContext($server, IAuthenticationContext $authContext) {
+        return new ClientContext($server, $authContext);
+    }
 
 }

apps/files_external/lib/Lib/SharePoint/SharePointClientFactory.php

Indentation +15 added lines, -15 removed lines

@@ -24,19 +24,19 @@
 namespace OCA\Files_External\Lib\SharePoint;
 
 class SharePointClientFactory {
-	/**
-	 * @param ContextsFactory $contextsFactory
-	 * @param string $sharePointUrl
-	 * @param array $credentials
-	 * @param string $documentLibraryTitle
-	 * @return SharePointClient
-	 */
-	public function getClient(
-		ContextsFactory $contextsFactory,
-		$sharePointUrl,
-		array $credentials,
-		$documentLibraryTitle)
-	{
-		return new SharePointClient($contextsFactory, $sharePointUrl, $credentials, $documentLibraryTitle);
-	}
+    /**
+     * @param ContextsFactory $contextsFactory
+     * @param string $sharePointUrl
+     * @param array $credentials
+     * @param string $documentLibraryTitle
+     * @return SharePointClient
+     */
+    public function getClient(
+        ContextsFactory $contextsFactory,
+        $sharePointUrl,
+        array $credentials,
+        $documentLibraryTitle)
+    {
+        return new SharePointClient($contextsFactory, $sharePointUrl, $credentials, $documentLibraryTitle);
+    }
 }

apps/files_external/lib/Lib/SharePoint/SharePointClient.php

Doc Comments +9 added lines, -5 removed lines

@@ -56,6 +56,10 @@ 
 	/** @var  string */
 	private $documentLibraryTitle;
 
+	/**
+	 * @param string $sharePointUrl
+	 * @param string $documentLibraryTitle
+	 */
 	public function __construct(ContextsFactory $contextsFactory, $sharePointUrl, array $credentials, $documentLibraryTitle) {
 		$this->contextsFactory = $contextsFactory;
 		$this->sharePointUrl = $sharePointUrl;
@@ -116,7 +120,7 @@ 
 	 * adds a folder on the given server path
 	 *
 	 * @param string $relativeServerPath
-	 * @return Folder
+	 * @return string
 	 * @throws \Exception
 	 */
 	public function createFolder($relativeServerPath) {
@@ -137,7 +141,7 @@ 
 	/**
 	 * downloads a file by passing it directly into a file resource
 	 *
-	 * @param $relativeServerPath
+	 * @param string $relativeServerPath
 	 * @param resource $fp a file resource open for writing
 	 * @return \Office365\PHP\Client\Runtime\OData\ODataPayload
 	 * @throws \Exception
@@ -203,9 +207,9 @@ 
 	 * needs to reimplement adding-file-tp-sp-logic quite some… perhaps upload an
 	 * empty file and continue with overwriteFileViaStream?
 	 *
-	 * @param $relativeServerPath
-	 * @param $content
-	 * @return File
+	 * @param string $relativeServerPath
+	 * @param string $content
+	 * @return string
 	 * @throws \Exception
 	 */
 	public function uploadNewFile($relativeServerPath, $content) {

Indentation +382 added lines, -382 removed lines

@@ -35,386 +35,386 @@
 use Office365\PHP\Client\SharePoint\SPList;
 
 class SharePointClient {
-	/** @var  ClientContext */
-	protected $context;
-
-	/** @var  AuthenticationContext */
-	protected $authContext;
-
-	/** @var  SPList */
-	protected $documentLibrary;
-
-	/** @var ContextsFactory */
-	private $contextsFactory;
-
-	/** @var  string */
-	private $sharePointUrl;
-
-	/** @var string[] */
-	private $credentials;
-
-	/** @var  string */
-	private $documentLibraryTitle;
-
-	public function __construct(ContextsFactory $contextsFactory, $sharePointUrl, array $credentials, $documentLibraryTitle) {
-		$this->contextsFactory = $contextsFactory;
-		$this->sharePointUrl = $sharePointUrl;
-		$this->credentials = $credentials;
-		$this->documentLibraryTitle = $documentLibraryTitle;
-	}
-
-	/**
-	 * @param string $path
-	 * @param array $properties
-	 * @return File|Folder
-	 * @throws \Exception
-	 */
-	public function fetchFileOrFolder($path, array $properties = null) {
-		$fetchFileFunc = function ($path, $props) { return $this->fetchFile($path, $props);};
-		$fetchFolderFunc = function ($path, $props) { return $this->fetchFolder($path, $props);};
-		$fetchers = [ $fetchFileFunc, $fetchFolderFunc ];
-		if(strpos($path, '.') === false) {
-			$fetchers = array_reverse($fetchers);
-		}
-
-		foreach ($fetchers as $fetchFunction) {
-			try {
-				$instance = call_user_func_array($fetchFunction, [$path, $properties]);
-				return $instance;
-			} catch (\Exception $e) {
-				if(preg_match('/^The file \/.* does not exist\.$/', $e->getMessage()) !== 1
-					&& $e->getMessage() !== 'Unknown Error'
-					&& $e->getMessage() !== 'File Not Found.'
-				) {
-					$this->resetClientContext();
-					# Unexpected Exception, pass it on
-					throw $e;
-				}
-			}
-			$this->resetClientContext();
-		}
-
-		# Nothing succeeded, quit with not found
-		throw new NotFoundException('File or Folder not found');
-	}
-
-	public function fetchFile($relativeServerPath, array $properties = null) {
-		$this->ensureConnection();
-		$file = $this->context->getWeb()->getFileByServerRelativeUrl($relativeServerPath);
-		$this->loadAndExecute($file, $properties);
-		return $file;
-	}
-
-	public function fetchFolder($relativeServerPath, array $properties = null) {
-		$this->ensureConnection();
-		$folder = $this->context->getWeb()->getFolderByServerRelativeUrl($relativeServerPath);
-		$this->loadAndExecute($folder, $properties);
-		return $folder;
-	}
-
-	/**
-	 * adds a folder on the given server path
-	 *
-	 * @param string $relativeServerPath
-	 * @return Folder
-	 * @throws \Exception
-	 */
-	public function createFolder($relativeServerPath) {
-		$this->ensureConnection();
-
-		$parentFolder = $this->context->getWeb()->getFolderByServerRelativeUrl(dirname($relativeServerPath));
-		$folder = $parentFolder->getFolders()->add(basename($relativeServerPath));
-
-		try {
-			$this->context->executeQuery();
-			return $folder;
-		} catch (\Exception $e) {
-			$this->resetClientContext();
-			throw $e;
-		}
-	}
-
-	/**
-	 * downloads a file by passing it directly into a file resource
-	 *
-	 * @param $relativeServerPath
-	 * @param resource $fp a file resource open for writing
-	 * @return \Office365\PHP\Client\Runtime\OData\ODataPayload
-	 * @throws \Exception
-	 */
-	public function getFileViaStream($relativeServerPath, $fp) {
-		if(!is_resource($fp)) {
-			throw new \InvalidArgumentException('file resource expected');
-		}
-		$relativeServerPath = rawurlencode($relativeServerPath);
-		$url = $this->context->getServiceRootUrl() .
-			"web/getfilebyserverrelativeurl('$relativeServerPath')/\$value";
-		$options = new RequestOptions($url);
-		$options->StreamHandle = $fp;
-
-		try {
-			$ok = $this->context->executeQueryDirect($options);
-		} catch(\Exception $e) {
-			$this->resetClientContext();
-			throw $e;
-		}
-		return $ok;
-	}
-
-	/**
-	 * fetches the file content (aka download)
-	 *
-	 * @param $relativeServerPath
-	 * @return string the file content
-	 */
-	public function getFile($relativeServerPath) {
-		return File::openBinary($this->context, $relativeServerPath);
-	}
-
-	/**
-	 * @param string $relativeServerPath
-	 * @param resource $fp
-	 * @param string $localPath - we need to pass the file size for the content length header
-	 * @return bool
-	 * @throws \Exception
-	 */
-	public function overwriteFileViaStream($relativeServerPath, $fp, $localPath) {
-		$serverRelativeUrl = rawurlencode($relativeServerPath);
-		$url = $this->context->getServiceRootUrl() . "web/getfilebyserverrelativeurl('$serverRelativeUrl')/\$value";
-		$request = new RequestOptions($url);
-		$request->Method = 'POST'; // yes, POST
-		$request->addCustomHeader('X-HTTP-Method','PUT'); // yes, PUT
-		$this->context->ensureFormDigest($request);
-		//FIXME: Proper StreamHandle handling is not upstream, yet
-		$request->StreamHandle = $fp;
-		$request->addCustomHeader("content-length", filesize($localPath));
-
-		try {
-			$ok = $this->context->executeQueryDirect($request);
-		} catch(\Exception $e) {
-			$this->resetClientContext();
-			throw $e;
-		}
-		return $ok !== false;
-	}
-
-	/**
-	 * FIXME: use StreamHandle as in  overwriteFileViaStream for uploading a file
-	 * needs to reimplement adding-file-tp-sp-logic quite some… perhaps upload an
-	 * empty file and continue with overwriteFileViaStream?
-	 *
-	 * @param $relativeServerPath
-	 * @param $content
-	 * @return File
-	 * @throws \Exception
-	 */
-	public function uploadNewFile($relativeServerPath, $content) {
-		$parentFolder = $this->context->getWeb()->getFolderByServerRelativeUrl(dirname($relativeServerPath));
-		$fileCollection = $parentFolder->getFiles();
-
-		$info = new FileCreationInformation();
-		$info->Content = $content;
-		$info->Url = basename($relativeServerPath);
-		$file = $fileCollection->add($info);
-		try {
-			$this->context->executeQuery();
-			return $file;
-		} catch(\Exception $e) {
-			$this->resetClientContext();
-			throw $e;
-		}
-	}
-
-	/**
-	 * moves a file or a folder to the given destination
-	 *
-	 * @param string $oldPath
-	 * @param string $newPath
-	 * @return bool
-	 * @throws \Exception
-	 */
-	public function rename($oldPath, $newPath) {
-		$this->ensureConnection();
-
-		try {
-			$item = $this->fetchFileOrFolder($oldPath);
-			if($item instanceof File) {
-				$this->renameFile($item, $newPath);
-			} else if($item instanceof Folder) {
-				$this->renameFolder($item, $newPath);
-			} else {
-				return false;
-			}
-			return true;
-		} catch (\Exception $e) {
-			$this->resetClientContext();
-			throw $e;
-		}
-	}
-
-	/**
-	 * renames a folder
-	 *
-	 * @param Folder $folder
-	 * @param string $newPath
-	 */
-	private function renameFolder(Folder $folder, $newPath) {
-		$folder->rename(basename($newPath));
-		$this->context->executeQuery();
-	}
-
-	/**
-	 * moves a file
-	 *
-	 * @param File $file
-	 * @param string $newPath
-	 */
-	private function renameFile(File $file, $newPath) {
-		$newPath = rawurlencode($newPath);
-		$file->moveTo($newPath, 0);
-		$this->context->executeQuery();
-		#$req = $this->debugGetLastRequest();
-	}
-
-	private function debugGetLastRequest() {
-		$requestHistory = Requests::getHistory();
-		$request = array_pop($requestHistory);
-		return $request;
-	}
-
-	public function delete(ClientObject $item) {
-		$this->ensureConnection();
-		try {
-			if ($item instanceof File) {
-				$this->deleteFile($item);
-			} else if ($item instanceof Folder) {
-				$this->deleteFolder($item);
-			}
-		} catch(\Exception $e) {
-			$this->resetClientContext();
-			throw $e;
-		}
-	}
-
-	/**
-	 * deletes the given file on SP
-	 *
-	 * @param File $file
-	 * @throws \Exception
-	 */
-	public function deleteFile(File $file) {
-		$file->recycle();
-		$this->context->executeQuery();
-	}
-
-	public function deleteFolder(Folder $folder) {
-		$folder->deleteObject();
-		$this->context->executeQuery();
-	}
-
-	/**
-	 * @param $relativeServerPath
-	 * @param null $properties
-	 * @param Folder $folder
-	 * @return ClientObjectCollection[]
-	 */
-	public function fetchFolderContents($relativeServerPath, $properties = null, Folder $folder = null) {
-		$this->ensureConnection();
-		if($folder === null) {
-			$folder = $this->context->getWeb()->getFolderByServerRelativeUrl($relativeServerPath);
-		}
-
-		$folderCollection = $folder->getFolders();
-		$fileCollection = $folder->getFiles();
-		$this->context->load($folderCollection, $properties);
-		$this->context->load($fileCollection, $properties);
-		$this->context->executeQuery();
-
-		$collections = ['folders' => $folderCollection, 'files' => $fileCollection];
-
-		return $collections;
-	}
-
-	public function isHidden(ClientObject $file) {
-		// ClientObject itself does not have getListItemAllFields but is
-		// the common denominator of File and Folder
-		if(!$file instanceof File && !$file instanceof Folder) {
-			throw new \InvalidArgumentException('File or Folder expected');
-		}
-		if($file instanceof File) {
-			// it's expensive, we only check folders
-			return false;
-		}
-		$fields = $file->getListItemAllFields();
-		if($fields->getProperties() === []) {
-			$this->loadAndExecute($fields, ['Id', 'Hidden']);
-		}
-		$id = $fields->getProperty('Id');
-		$hidden = $fields->getProperty('Hidden'); // TODO: get someone to test this in SP 2013
-		if($hidden === false || $id !== null) {
-			// avoids listing hidden "Forms" folder (and its contents).
-			// Have not found a different mechanism to detect whether
-			// a file or folder is hidden. There used to be a Hidden
-			// field, but seems to have gone (since SP 2016?).
-			return false;
-		}
-		return true;
-	}
-
-	public function loadAndExecute(ClientObject $object, array $properties = null) {
-		$this->context->load($object, $properties);
-		$this->context->executeQuery();
-	}
-
-	/**
-	 * @return SPList
-	 * @throws NotFoundException
-	 */
-	private function getDocumentLibrary() {
-		if(!is_null($this->documentLibrary)) {
-			return $this->documentLibrary;
-		}
-
-		$lists = $this->context->getWeb()->getLists()->filter('Title eq \'' . $this->documentLibraryTitle . '\'')->top(1);
-		$this->context->load($lists)->executeQuery();
-		if ($lists->getCount() === 1 && $lists->getData()[0] instanceof SPList) {
-			$this->documentLibrary = $lists->getData()[0];
-			return $this->documentLibrary;
-		}
-
-		throw new NotFoundException('List not found');
-	}
-
-	/**
-	 * Set up necessary contexts for authentication and access to SharePoint
-	 *
-	 * @throws \InvalidArgumentException
-	 */
-	private function ensureConnection() {
-		if($this->context instanceof ClientContext) {
-			return;
-		}
-
-		if(!is_string($this->credentials['user']) || empty($this->credentials['user'])) {
-			throw new \InvalidArgumentException('No user given');
-		}
-		if(!is_string($this->credentials['password']) || empty($this->credentials['password'])) {
-			throw new \InvalidArgumentException('No password given');
-		}
-		$this->authContext = $this->contextsFactory->getAuthContext($this->credentials['user'], $this->credentials['password']);
-		$this->authContext->AuthType = CURLAUTH_NTLM;		# Basic auth does not work somehow…
-		$this->context = $this->contextsFactory->getClientContext($this->sharePointUrl, $this->authContext);
-		# Auth is not triggered yet. This will happen when something is requested from SharePoint (on demand), e.g.:
-	}
-
-	/**
-	 * resets the sharepoint client context
-	 *
-	 * Usually executed, when a query resulted into an exception. The faulty
-	 * query is not removed by default.
-	 */
-	private function resetClientContext() {
-		//FIXME: resetQueries method did not go upstream yet
-		$this->context->getPendingRequest()->resetQueries();
-	}
+    /** @var  ClientContext */
+    protected $context;
+
+    /** @var  AuthenticationContext */
+    protected $authContext;
+
+    /** @var  SPList */
+    protected $documentLibrary;
+
+    /** @var ContextsFactory */
+    private $contextsFactory;
+
+    /** @var  string */
+    private $sharePointUrl;
+
+    /** @var string[] */
+    private $credentials;
+
+    /** @var  string */
+    private $documentLibraryTitle;
+
+    public function __construct(ContextsFactory $contextsFactory, $sharePointUrl, array $credentials, $documentLibraryTitle) {
+        $this->contextsFactory = $contextsFactory;
+        $this->sharePointUrl = $sharePointUrl;
+        $this->credentials = $credentials;
+        $this->documentLibraryTitle = $documentLibraryTitle;
+    }
+
+    /**
+     * @param string $path
+     * @param array $properties
+     * @return File|Folder
+     * @throws \Exception
+     */
+    public function fetchFileOrFolder($path, array $properties = null) {
+        $fetchFileFunc = function ($path, $props) { return $this->fetchFile($path, $props);};
+        $fetchFolderFunc = function ($path, $props) { return $this->fetchFolder($path, $props);};
+        $fetchers = [ $fetchFileFunc, $fetchFolderFunc ];
+        if(strpos($path, '.') === false) {
+            $fetchers = array_reverse($fetchers);
+        }
+
+        foreach ($fetchers as $fetchFunction) {
+            try {
+                $instance = call_user_func_array($fetchFunction, [$path, $properties]);
+                return $instance;
+            } catch (\Exception $e) {
+                if(preg_match('/^The file \/.* does not exist\.$/', $e->getMessage()) !== 1
+                    && $e->getMessage() !== 'Unknown Error'
+                    && $e->getMessage() !== 'File Not Found.'
+                ) {
+                    $this->resetClientContext();
+                    # Unexpected Exception, pass it on
+                    throw $e;
+                }
+            }
+            $this->resetClientContext();
+        }
+
+        # Nothing succeeded, quit with not found
+        throw new NotFoundException('File or Folder not found');
+    }
+
+    public function fetchFile($relativeServerPath, array $properties = null) {
+        $this->ensureConnection();
+        $file = $this->context->getWeb()->getFileByServerRelativeUrl($relativeServerPath);
+        $this->loadAndExecute($file, $properties);
+        return $file;
+    }
+
+    public function fetchFolder($relativeServerPath, array $properties = null) {
+        $this->ensureConnection();
+        $folder = $this->context->getWeb()->getFolderByServerRelativeUrl($relativeServerPath);
+        $this->loadAndExecute($folder, $properties);
+        return $folder;
+    }
+
+    /**
+     * adds a folder on the given server path
+     *
+     * @param string $relativeServerPath
+     * @return Folder
+     * @throws \Exception
+     */
+    public function createFolder($relativeServerPath) {
+        $this->ensureConnection();
+
+        $parentFolder = $this->context->getWeb()->getFolderByServerRelativeUrl(dirname($relativeServerPath));
+        $folder = $parentFolder->getFolders()->add(basename($relativeServerPath));
+
+        try {
+            $this->context->executeQuery();
+            return $folder;
+        } catch (\Exception $e) {
+            $this->resetClientContext();
+            throw $e;
+        }
+    }
+
+    /**
+     * downloads a file by passing it directly into a file resource
+     *
+     * @param $relativeServerPath
+     * @param resource $fp a file resource open for writing
+     * @return \Office365\PHP\Client\Runtime\OData\ODataPayload
+     * @throws \Exception
+     */
+    public function getFileViaStream($relativeServerPath, $fp) {
+        if(!is_resource($fp)) {
+            throw new \InvalidArgumentException('file resource expected');
+        }
+        $relativeServerPath = rawurlencode($relativeServerPath);
+        $url = $this->context->getServiceRootUrl() .
+            "web/getfilebyserverrelativeurl('$relativeServerPath')/\$value";
+        $options = new RequestOptions($url);
+        $options->StreamHandle = $fp;
+
+        try {
+            $ok = $this->context->executeQueryDirect($options);
+        } catch(\Exception $e) {
+            $this->resetClientContext();
+            throw $e;
+        }
+        return $ok;
+    }
+
+    /**
+     * fetches the file content (aka download)
+     *
+     * @param $relativeServerPath
+     * @return string the file content
+     */
+    public function getFile($relativeServerPath) {
+        return File::openBinary($this->context, $relativeServerPath);
+    }
+
+    /**
+     * @param string $relativeServerPath
+     * @param resource $fp
+     * @param string $localPath - we need to pass the file size for the content length header
+     * @return bool
+     * @throws \Exception
+     */
+    public function overwriteFileViaStream($relativeServerPath, $fp, $localPath) {
+        $serverRelativeUrl = rawurlencode($relativeServerPath);
+        $url = $this->context->getServiceRootUrl() . "web/getfilebyserverrelativeurl('$serverRelativeUrl')/\$value";
+        $request = new RequestOptions($url);
+        $request->Method = 'POST'; // yes, POST
+        $request->addCustomHeader('X-HTTP-Method','PUT'); // yes, PUT
+        $this->context->ensureFormDigest($request);
+        //FIXME: Proper StreamHandle handling is not upstream, yet
+        $request->StreamHandle = $fp;
+        $request->addCustomHeader("content-length", filesize($localPath));
+
+        try {
+            $ok = $this->context->executeQueryDirect($request);
+        } catch(\Exception $e) {
+            $this->resetClientContext();
+            throw $e;
+        }
+        return $ok !== false;
+    }
+
+    /**
+     * FIXME: use StreamHandle as in  overwriteFileViaStream for uploading a file
+     * needs to reimplement adding-file-tp-sp-logic quite some… perhaps upload an
+     * empty file and continue with overwriteFileViaStream?
+     *
+     * @param $relativeServerPath
+     * @param $content
+     * @return File
+     * @throws \Exception
+     */
+    public function uploadNewFile($relativeServerPath, $content) {
+        $parentFolder = $this->context->getWeb()->getFolderByServerRelativeUrl(dirname($relativeServerPath));
+        $fileCollection = $parentFolder->getFiles();
+
+        $info = new FileCreationInformation();
+        $info->Content = $content;
+        $info->Url = basename($relativeServerPath);
+        $file = $fileCollection->add($info);
+        try {
+            $this->context->executeQuery();
+            return $file;
+        } catch(\Exception $e) {
+            $this->resetClientContext();
+            throw $e;
+        }
+    }
+
+    /**
+     * moves a file or a folder to the given destination
+     *
+     * @param string $oldPath
+     * @param string $newPath
+     * @return bool
+     * @throws \Exception
+     */
+    public function rename($oldPath, $newPath) {
+        $this->ensureConnection();
+
+        try {
+            $item = $this->fetchFileOrFolder($oldPath);
+            if($item instanceof File) {
+                $this->renameFile($item, $newPath);
+            } else if($item instanceof Folder) {
+                $this->renameFolder($item, $newPath);
+            } else {
+                return false;
+            }
+            return true;
+        } catch (\Exception $e) {
+            $this->resetClientContext();
+            throw $e;
+        }
+    }
+
+    /**
+     * renames a folder
+     *
+     * @param Folder $folder
+     * @param string $newPath
+     */
+    private function renameFolder(Folder $folder, $newPath) {
+        $folder->rename(basename($newPath));
+        $this->context->executeQuery();
+    }
+
+    /**
+     * moves a file
+     *
+     * @param File $file
+     * @param string $newPath
+     */
+    private function renameFile(File $file, $newPath) {
+        $newPath = rawurlencode($newPath);
+        $file->moveTo($newPath, 0);
+        $this->context->executeQuery();
+        #$req = $this->debugGetLastRequest();
+    }
+
+    private function debugGetLastRequest() {
+        $requestHistory = Requests::getHistory();
+        $request = array_pop($requestHistory);
+        return $request;
+    }
+
+    public function delete(ClientObject $item) {
+        $this->ensureConnection();
+        try {
+            if ($item instanceof File) {
+                $this->deleteFile($item);
+            } else if ($item instanceof Folder) {
+                $this->deleteFolder($item);
+            }
+        } catch(\Exception $e) {
+            $this->resetClientContext();
+            throw $e;
+        }
+    }
+
+    /**
+     * deletes the given file on SP
+     *
+     * @param File $file
+     * @throws \Exception
+     */
+    public function deleteFile(File $file) {
+        $file->recycle();
+        $this->context->executeQuery();
+    }
+
+    public function deleteFolder(Folder $folder) {
+        $folder->deleteObject();
+        $this->context->executeQuery();
+    }
+
+    /**
+     * @param $relativeServerPath
+     * @param null $properties
+     * @param Folder $folder
+     * @return ClientObjectCollection[]
+     */
+    public function fetchFolderContents($relativeServerPath, $properties = null, Folder $folder = null) {
+        $this->ensureConnection();
+        if($folder === null) {
+            $folder = $this->context->getWeb()->getFolderByServerRelativeUrl($relativeServerPath);
+        }
+
+        $folderCollection = $folder->getFolders();
+        $fileCollection = $folder->getFiles();
+        $this->context->load($folderCollection, $properties);
+        $this->context->load($fileCollection, $properties);
+        $this->context->executeQuery();
+
+        $collections = ['folders' => $folderCollection, 'files' => $fileCollection];
+
+        return $collections;
+    }
+
+    public function isHidden(ClientObject $file) {
+        // ClientObject itself does not have getListItemAllFields but is
+        // the common denominator of File and Folder
+        if(!$file instanceof File && !$file instanceof Folder) {
+            throw new \InvalidArgumentException('File or Folder expected');
+        }
+        if($file instanceof File) {
+            // it's expensive, we only check folders
+            return false;
+        }
+        $fields = $file->getListItemAllFields();
+        if($fields->getProperties() === []) {
+            $this->loadAndExecute($fields, ['Id', 'Hidden']);
+        }
+        $id = $fields->getProperty('Id');
+        $hidden = $fields->getProperty('Hidden'); // TODO: get someone to test this in SP 2013
+        if($hidden === false || $id !== null) {
+            // avoids listing hidden "Forms" folder (and its contents).
+            // Have not found a different mechanism to detect whether
+            // a file or folder is hidden. There used to be a Hidden
+            // field, but seems to have gone (since SP 2016?).
+            return false;
+        }
+        return true;
+    }
+
+    public function loadAndExecute(ClientObject $object, array $properties = null) {
+        $this->context->load($object, $properties);
+        $this->context->executeQuery();
+    }
+
+    /**
+     * @return SPList
+     * @throws NotFoundException
+     */
+    private function getDocumentLibrary() {
+        if(!is_null($this->documentLibrary)) {
+            return $this->documentLibrary;
+        }
+
+        $lists = $this->context->getWeb()->getLists()->filter('Title eq \'' . $this->documentLibraryTitle . '\'')->top(1);
+        $this->context->load($lists)->executeQuery();
+        if ($lists->getCount() === 1 && $lists->getData()[0] instanceof SPList) {
+            $this->documentLibrary = $lists->getData()[0];
+            return $this->documentLibrary;
+        }
+
+        throw new NotFoundException('List not found');
+    }
+
+    /**
+     * Set up necessary contexts for authentication and access to SharePoint
+     *
+     * @throws \InvalidArgumentException
+     */
+    private function ensureConnection() {
+        if($this->context instanceof ClientContext) {
+            return;
+        }
+
+        if(!is_string($this->credentials['user']) || empty($this->credentials['user'])) {
+            throw new \InvalidArgumentException('No user given');
+        }
+        if(!is_string($this->credentials['password']) || empty($this->credentials['password'])) {
+            throw new \InvalidArgumentException('No password given');
+        }
+        $this->authContext = $this->contextsFactory->getAuthContext($this->credentials['user'], $this->credentials['password']);
+        $this->authContext->AuthType = CURLAUTH_NTLM;		# Basic auth does not work somehow…
+        $this->context = $this->contextsFactory->getClientContext($this->sharePointUrl, $this->authContext);
+        # Auth is not triggered yet. This will happen when something is requested from SharePoint (on demand), e.g.:
+    }
+
+    /**
+     * resets the sharepoint client context
+     *
+     * Usually executed, when a query resulted into an exception. The faulty
+     * query is not removed by default.
+     */
+    private function resetClientContext() {
+        //FIXME: resetQueries method did not go upstream yet
+        $this->context->getPendingRequest()->resetQueries();
+    }
 }

Spacing +26 added lines, -26 removed lines

@@ -70,10 +70,10 @@ 
 	 * @throws \Exception
 	 */
 	public function fetchFileOrFolder($path, array $properties = null) {
-		$fetchFileFunc = function ($path, $props) { return $this->fetchFile($path, $props);};
-		$fetchFolderFunc = function ($path, $props) { return $this->fetchFolder($path, $props);};
-		$fetchers = [ $fetchFileFunc, $fetchFolderFunc ];
-		if(strpos($path, '.') === false) {
+		$fetchFileFunc = function($path, $props) { return $this->fetchFile($path, $props); };
+		$fetchFolderFunc = function($path, $props) { return $this->fetchFolder($path, $props); };
+		$fetchers = [$fetchFileFunc, $fetchFolderFunc];
+		if (strpos($path, '.') === false) {
 			$fetchers = array_reverse($fetchers);
 		}
 
@@ -82,7 +82,7 @@ 
 				$instance = call_user_func_array($fetchFunction, [$path, $properties]);
 				return $instance;
 			} catch (\Exception $e) {
-				if(preg_match('/^The file \/.* does not exist\.$/', $e->getMessage()) !== 1
+				if (preg_match('/^The file \/.* does not exist\.$/', $e->getMessage()) !== 1
 					&& $e->getMessage() !== 'Unknown Error'
 					&& $e->getMessage() !== 'File Not Found.'
 				) {
@@ -143,18 +143,18 @@ 
 	 * @throws \Exception
 	 */
 	public function getFileViaStream($relativeServerPath, $fp) {
-		if(!is_resource($fp)) {
+		if (!is_resource($fp)) {
 			throw new \InvalidArgumentException('file resource expected');
 		}
 		$relativeServerPath = rawurlencode($relativeServerPath);
-		$url = $this->context->getServiceRootUrl() .
+		$url = $this->context->getServiceRootUrl().
 			"web/getfilebyserverrelativeurl('$relativeServerPath')/\$value";
 		$options = new RequestOptions($url);
 		$options->StreamHandle = $fp;
 
 		try {
 			$ok = $this->context->executeQueryDirect($options);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			$this->resetClientContext();
 			throw $e;
 		}
@@ -180,10 +180,10 @@ 
 	 */
 	public function overwriteFileViaStream($relativeServerPath, $fp, $localPath) {
 		$serverRelativeUrl = rawurlencode($relativeServerPath);
-		$url = $this->context->getServiceRootUrl() . "web/getfilebyserverrelativeurl('$serverRelativeUrl')/\$value";
+		$url = $this->context->getServiceRootUrl()."web/getfilebyserverrelativeurl('$serverRelativeUrl')/\$value";
 		$request = new RequestOptions($url);
 		$request->Method = 'POST'; // yes, POST
-		$request->addCustomHeader('X-HTTP-Method','PUT'); // yes, PUT
+		$request->addCustomHeader('X-HTTP-Method', 'PUT'); // yes, PUT
 		$this->context->ensureFormDigest($request);
 		//FIXME: Proper StreamHandle handling is not upstream, yet
 		$request->StreamHandle = $fp;
@@ -191,7 +191,7 @@ 
 
 		try {
 			$ok = $this->context->executeQueryDirect($request);
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			$this->resetClientContext();
 			throw $e;
 		}
@@ -219,7 +219,7 @@ 
 		try {
 			$this->context->executeQuery();
 			return $file;
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			$this->resetClientContext();
 			throw $e;
 		}
@@ -238,9 +238,9 @@ 
 
 		try {
 			$item = $this->fetchFileOrFolder($oldPath);
-			if($item instanceof File) {
+			if ($item instanceof File) {
 				$this->renameFile($item, $newPath);
-			} else if($item instanceof Folder) {
+			} else if ($item instanceof Folder) {
 				$this->renameFolder($item, $newPath);
 			} else {
 				return false;
@@ -290,7 +290,7 @@ 
 			} else if ($item instanceof Folder) {
 				$this->deleteFolder($item);
 			}
-		} catch(\Exception $e) {
+		} catch (\Exception $e) {
 			$this->resetClientContext();
 			throw $e;
 		}
@@ -320,7 +320,7 @@ 
 	 */
 	public function fetchFolderContents($relativeServerPath, $properties = null, Folder $folder = null) {
 		$this->ensureConnection();
-		if($folder === null) {
+		if ($folder === null) {
 			$folder = $this->context->getWeb()->getFolderByServerRelativeUrl($relativeServerPath);
 		}
 
@@ -338,20 +338,20 @@ 
 	public function isHidden(ClientObject $file) {
 		// ClientObject itself does not have getListItemAllFields but is
 		// the common denominator of File and Folder
-		if(!$file instanceof File && !$file instanceof Folder) {
+		if (!$file instanceof File && !$file instanceof Folder) {
 			throw new \InvalidArgumentException('File or Folder expected');
 		}
-		if($file instanceof File) {
+		if ($file instanceof File) {
 			// it's expensive, we only check folders
 			return false;
 		}
 		$fields = $file->getListItemAllFields();
-		if($fields->getProperties() === []) {
+		if ($fields->getProperties() === []) {
 			$this->loadAndExecute($fields, ['Id', 'Hidden']);
 		}
 		$id = $fields->getProperty('Id');
 		$hidden = $fields->getProperty('Hidden'); // TODO: get someone to test this in SP 2013
-		if($hidden === false || $id !== null) {
+		if ($hidden === false || $id !== null) {
 			// avoids listing hidden "Forms" folder (and its contents).
 			// Have not found a different mechanism to detect whether
 			// a file or folder is hidden. There used to be a Hidden
@@ -371,11 +371,11 @@ 
 	 * @throws NotFoundException
 	 */
 	private function getDocumentLibrary() {
-		if(!is_null($this->documentLibrary)) {
+		if (!is_null($this->documentLibrary)) {
 			return $this->documentLibrary;
 		}
 
-		$lists = $this->context->getWeb()->getLists()->filter('Title eq \'' . $this->documentLibraryTitle . '\'')->top(1);
+		$lists = $this->context->getWeb()->getLists()->filter('Title eq \''.$this->documentLibraryTitle.'\'')->top(1);
 		$this->context->load($lists)->executeQuery();
 		if ($lists->getCount() === 1 && $lists->getData()[0] instanceof SPList) {
 			$this->documentLibrary = $lists->getData()[0];
@@ -391,18 +391,18 @@ 
 	 * @throws \InvalidArgumentException
 	 */
 	private function ensureConnection() {
-		if($this->context instanceof ClientContext) {
+		if ($this->context instanceof ClientContext) {
 			return;
 		}
 
-		if(!is_string($this->credentials['user']) || empty($this->credentials['user'])) {
+		if (!is_string($this->credentials['user']) || empty($this->credentials['user'])) {
 			throw new \InvalidArgumentException('No user given');
 		}
-		if(!is_string($this->credentials['password']) || empty($this->credentials['password'])) {
+		if (!is_string($this->credentials['password']) || empty($this->credentials['password'])) {
 			throw new \InvalidArgumentException('No password given');
 		}
 		$this->authContext = $this->contextsFactory->getAuthContext($this->credentials['user'], $this->credentials['password']);
-		$this->authContext->AuthType = CURLAUTH_NTLM;		# Basic auth does not work somehow…
+		$this->authContext->AuthType = CURLAUTH_NTLM; # Basic auth does not work somehow…
 		$this->context = $this->contextsFactory->getClientContext($this->sharePointUrl, $this->authContext);
 		# Auth is not triggered yet. This will happen when something is requested from SharePoint (on demand), e.g.:
 	}

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

Doc Comments +5 added lines, -2 removed lines

@@ -381,6 +381,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $path
+	 */
 	public function writeBack($tmpFile, $path) {
 		$serverUrl = $this->formatPath($path);
 		$content = file_get_contents($tmpFile);
@@ -458,7 +461,7 @@ 
 	}
 
 	/**
-	 * @param $serverUrl
+	 * @param string $serverUrl
 	 * @return ClientObjectCollection[]
 	 */
 	private function getFolderContents($serverUrl) {
@@ -490,7 +493,7 @@ 
 	}
 
 	/**
-	 * @param $serverUrl
+	 * @param string $serverUrl
 	 * @return File|Folder
 	 * @throws NotFoundException
 	 */

Indentation +497 added lines, -497 removed lines

@@ -39,502 +39,502 @@
 use Office365\PHP\Client\SharePoint\ListItem;
 
 class SharePoint extends Common {
-	const SP_PROPERTY_SIZE = 'Length';
-	const SP_PROPERTY_MTIME = 'TimeLastModified';
-	const SP_PROPERTY_URL = 'ServerRelativeUrl';
-
-	/** @var  string */
-	protected $server;
-
-	/** @var  string */
-	protected $documentLibrary;
-
-	/** @var  string */
-	protected $authUser;
-
-	/** @var  string */
-	protected $authPwd;
-
-	/** @var  SharePointClient */
-	protected $spClient;
-
-	/** @var  CappedMemoryCache */
-	protected $fileCache;
-
-	/** @var ContextsFactory */
-	private $contextsFactory;
-
-	/** @var ITempManager */
-	private $tempManager;
-
-	public function __construct($parameters) {
-		$this->server = $parameters['host'];
-		$this->documentLibrary = $parameters['documentLibrary'];
-
-		if(strpos($this->documentLibrary, '"') !== false) {
-			// they are, amongst others, not allowed and we use it in the filter
-			// cf. https://support.microsoft.com/en-us/kb/2933738
-			// TODO: verify, it talks about files and folders mostly
-			throw new \InvalidArgumentException('Illegal character in Document Library Name');
-		}
-
-		if(!isset($parameters['user']) || !isset($parameters['password'])) {
-			throw new \UnexpectedValueException('No user or password given');
-		}
-		$this->authUser = $parameters['user'];
-		$this->authPwd  = $parameters['password'];
-
-		$this->fixDI($parameters);
-	}
-
-	/**
-	 * Get the identifier for the storage,
-	 * the returned id should be the same for every storage object that is created with the same parameters
-	 * and two storage objects with the same id should refer to two storages that display the same files.
-	 *
-	 * @return string
-	 * @since 6.0.0
-	 */
-	public function getId() {
-		return 'SharePoint::' . $this->server . '::' . $this->documentLibrary . '::' . $this->authUser;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.mkdir.php
-	 * implementations need to implement a recursive mkdir
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function mkdir($path) {
-		$serverUrl = $this->formatPath($path);
-		try {
-			$folder = $this->spClient->createFolder($serverUrl);
-			$this->fileCache->set($serverUrl, [
-				'instance' => $folder,
-				'children' => [
-					'folders' => $folder->getFolders(),
-					'files' => $folder->getFiles()
-				]
-			]);
-			return true;
-		} catch (\Exception $e) {
-			$this->fileCache->remove($serverUrl);
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.rmdir.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function rmdir($path) {
-		$serverUrl = $this->formatPath($path);
-		try {
-			$folder = $this->getFileOrFolder($serverUrl);
-			$this->spClient->delete($folder);
-			$this->fileCache->set($serverUrl, false);
-			return true;
-		} catch (\Exception $e) {
-			$this->fileCache->remove($serverUrl);
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.opendir.php
-	 *
-	 * @param string $path
-	 * @return resource|false
-	 * @since 6.0.0
-	 */
-	public function opendir($path) {
-		try {
-			$serverUrl = $this->formatPath($path);
-			//$collections = $this->spClient->fetchFolderContents($serverUrl, ['Name', 'ListItemAllFields']);	// does not work for some reason :(
-			$collections = $this->getFolderContents($serverUrl);
-			$files = [];
-
-			foreach ($collections as $collection) {
-				/** @var File[]|Folder[] $items */
-				$items = $collection->getData();
-				foreach ($items as $item) {
-					/** @var ListItem $fields */
-					if(!$this->spClient->isHidden($item)) {
-						$files[] = $item->getProperty('Name');
-					}
-				}
-			}
-
-			return IteratorDirectory::wrap($files);
-		} catch (NotFoundException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.stat.php
-	 * only the following keys are required in the result: size and mtime
-	 *
-	 * @param string $path
-	 * @return array|false
-	 * @since 6.0.0
-	 */
-	public function stat($path) {
-		$serverUrl = $this->formatPath($path);
-		try {
-			$file = $this->getFileOrFolder($serverUrl);
-		} catch (\Exception $e) {
-			return false;
-		}
-
-		$size = $file->getProperty(self::SP_PROPERTY_SIZE) ?: FileInfo::SPACE_UNKNOWN;
-		$mtimeValue = $file->getProperty(self::SP_PROPERTY_MTIME);
-		$mtime = $mtimeValue ? new \DateTime($mtimeValue) : null;
-
-		$stat = [
-			// int64, size in bytes, excluding the size of any Web Parts that are used in the file.
-			'size'  => $size,
-			'mtime' => $mtime->getTimestamp(),
-			// no property in SP 2013 & 2016, other storages do the same  :speak_no_evil:
-			'atime' => time(),
-		];
-
-		if(!is_null($stat['mtime'])) {
-			return $stat;
-		}
-
-		// If we do not get a mtime from SP, we treat it as an error
-		// thus returning false, according to PHP documentation on stat()
-		return false;
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.filetype.php
-	 *
-	 * @param string $path
-	 * @return false|string
-	 * @throws \Exception
-	 * @since 6.0.0
-	 */
-	public function filetype($path) {
-		try {
-			$serverUrl = $this->formatPath($path);
-			$object = $this->getFileOrFolder($serverUrl);
-		} catch (NotFoundException $e) {
-			return false;
-		}
-		if($object instanceof File) {
-			return 'file';
-		} else if($object instanceof Folder) {
-			return 'dir';
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.file_exists.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function file_exists($path) {
-		try {
-			$serverUrl = $this->formatPath($path);
-			// alternative approach is to use a CAML query instead of querying
-			// for file and folder. It is not necessarily faster, though.
-			// Would need evaluation of typical use cases (I assume most often
-			// existing files are checked) and measurements.
-			$this->getFileOrFolder($serverUrl);
-			return true;
-		} catch (NotFoundException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.unlink.php
-	 *
-	 * @param string $path
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function unlink($path) {
-		// file methods get called twice at least, returning true
-		if(!$this->file_exists($path)) {
-			return true;
-		}
-		try {
-			$serverUrl = $this->formatPath($path);
-			$this->spClient->delete($this->getFileOrFolder($serverUrl));
-			$this->fileCache->set($serverUrl, false);
-			return true;
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	public function rename($path1, $path2) {
-		$oldPath = $this->formatPath($path1);
-		$newPath = $this->formatPath($path2);
-
-		try {
-			$item = $this->getFileOrFolder($newPath);
-			$this->spClient->delete($item);
-			$this->fileCache->remove($newPath);
-		} catch(NotFoundException $e) {
-			// noop
-		}
-
-		try {
-			$isRenamed = $this->spClient->rename($oldPath, $newPath);
-			if($isRenamed) {
-				$entry = $this->fileCache->get($oldPath);
-				$this->fileCache->remove($newPath);
-				if($entry !== false) {
-					$this->fileCache->set($newPath, $entry);
-				}
-				$this->fileCache->remove($oldPath);
-			}
-			return $isRenamed;
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.fopen.php
-	 *
-	 * @param string $path
-	 * @param string $mode
-	 * @return resource|false
-	 * @since 6.0.0
-	 */
-	public function fopen($path, $mode) {
-		$serverUrl = $this->formatPath($path);
-
-		switch ($mode) {
-			case 'a':
-			case 'ab':
-			case 'a+':
-				// no native support
-				return false;
-			case 'r':
-			case 'rb':
-				$tmpFile = $this->tempManager->getTemporaryFile();
-
-				$fp = fopen($tmpFile, 'w+');
-				if(!$this->spClient->getFileViaStream($serverUrl, $fp)) {
-					fclose($fp);
-					return false;
-				}
-				fseek($fp, 0);
-				return $fp;
-				break;
-			case 'r+':
-			case 'rb+':
-			case 'r+b':
-				// fseek 0
-			case 'w':
-			case 'w+':
-			case 'wb':
-			case 'wb+':
-			case 'w+b':
-				// truncate
-				// fseek 0
-			case 'x':
-			case 'x+':
-			case 'xb':
-			case 'xb+':
-			case 'x+b':
-				// fseek 0
-			case 'c':
-			case 'cb':
-			case 'c+':
-			case 'cb+':
-			case 'c+b':
-				//fseek 0
-				if($mode[0] === 'x' && $this->file_exists($path)) {
-					return false;
-				}
-				$tmpFile = $this->tempManager->getTemporaryFile();
-				if($mode[0] !== 'w' && $this->file_exists($path)) {
-					$content = $this->fopen($path, 'r');
-					if($content === false) {
-						// should not happen, but let's be safe
-						return false;
-					}
-					$this->file_put_contents($tmpFile, $content);
-				}
-				$fp = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($fp, null, null, function () use ($path, $tmpFile) {
-					$this->writeBack($tmpFile, $path);
-				});
-
-		}
-		return false;
-	}
-
-	public function writeBack($tmpFile, $path) {
-		$serverUrl = $this->formatPath($path);
-		$content = file_get_contents($tmpFile);
-		$fp = fopen($tmpFile, 'r');
-
-		try {
-			if ($this->file_exists($path)) {
-				$this->spClient->overwriteFileViaStream($serverUrl, $fp, $tmpFile);
-				fclose($fp);
-				$this->fileCache->remove($serverUrl);
-			} else {
-				$file = $this->spClient->uploadNewFile($serverUrl, $content);
-				$this->fileCache->set($serverUrl, ['instance' => $file]);
-			}
-		} catch (\Exception $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * see http://php.net/manual/en/function.touch.php
-	 * If the backend does not support the operation, false should be returned
-	 *
-	 * @param string $path
-	 * @param int $mtime
-	 * @return bool
-	 * @since 6.0.0
-	 */
-	public function touch($path, $mtime = null) {
-		// TODO: Implement touch() method.
-		return true;
-	}
-
-
-	/**
-	 * work around dependency injection issues so we can test this class properly
-	 *
-	 * @param array $parameters
-	 */
-	private function fixDI(array $parameters) {
-		if(isset($parameters['contextFactory'])
-			&& $parameters['contextFactory'] instanceof ContextsFactory)
-		{
-			$this->contextsFactory = $parameters['contextFactory'];
-		} else {
-			$this->contextsFactory = new ContextsFactory();
-		}
-
-		if(isset($parameters['sharePointClientFactory'])
-			&& $parameters['sharePointClientFactory'] instanceof SharePointClientFactory)
-		{
-			$spcFactory = $parameters['sharePointClientFactory'];
-		} else {
-			$spcFactory = new SharePointClientFactory();
-		}
-		$this->spClient = $spcFactory->getClient(
-			$this->contextsFactory,
-			$this->server,
-			[ 'user' => $this->authUser, 'password' => $this->authPwd],
-			$this->documentLibrary
-		);
-
-		if(isset($parameters['cappedMemoryCache'])) {
-			$this->fileCache = $parameters['cappedMemoryCache'];
-		} else {
-			// there's no API to get such
-			$this->fileCache = new CappedMemoryCache();
-		}
-
-		if(isset($parameters['tempManager'])) {
-			$this->tempManager = $parameters['tempManager'];
-		} else {
-			$this->tempManager = \OC::$server->getTempManager();
-		}
-	}
-
-	/**
-	 * @param $serverUrl
-	 * @return ClientObjectCollection[]
-	 */
-	private function getFolderContents($serverUrl) {
-		$entry = $this->fileCache->get($serverUrl);
-		if($entry === null || !isset($entry['children'])) {
-			$folder = isset($entry['instance']) ? $entry['instance'] : null;
-			$contents = $this->spClient->fetchFolderContents($serverUrl, null, $folder);
-			$cacheItem = $entry ?: [];
-			$cacheItem['children'] = $contents;
-			$this->fileCache->set($serverUrl, $cacheItem);
-
-			// cache children instances
-			foreach ($contents as $collection) {
-				foreach ($collection->getData() as $item) {
-					/** @var  File|Folder $item */
-					$url = $item->getProperty(self::SP_PROPERTY_URL);
-					$itemEntry = $this->fileCache->get($url);
-					$itemEntry = $itemEntry ?: [];
-					if(!isset($itemEntry['instance'])) {
-						$itemEntry['instance'] = $item;
-						$this->fileCache->set($url, $itemEntry);
-					}
-				}
-			}
-		} else {
-			$contents = $entry['children'];
-		}
-		return $contents;
-	}
-
-	/**
-	 * @param $serverUrl
-	 * @return File|Folder
-	 * @throws NotFoundException
-	 */
-	private function getFileOrFolder($serverUrl) {
-		$entry = $this->fileCache->get($serverUrl);
-		if($entry === false) {
-			throw new NotFoundException('File or Folder not found');
-		} else if($entry === null || !isset($entry['instance'])) {
-			try {
-				$file = $this->spClient->fetchFileOrFolder($serverUrl, [self::SP_PROPERTY_SIZE, self::SP_PROPERTY_MTIME]);
-			} catch (NotFoundException $e) {
-				$this->fileCache->set($serverUrl, false);
-				throw $e;
-			}
-			$cacheItem = $entry ?: [];
-			$cacheItem['instance'] = $file;
-			$this->fileCache->set($serverUrl, $cacheItem);
-		} else {
-			$file = $entry['instance'];
-		}
-		return $file;
-	}
-
-	/**
-	 * creates the relative server "url" out of the provided path
-	 *
-	 * @param $path
-	 * @return string
-	 */
-	private function formatPath($path) {
-		$path = trim($path, '/');
-		$serverUrl = '/' . $this->documentLibrary;
-		if($path !== '') {
-			$serverUrl .= '/' . $path;
-		}
-
-		$pathParts = explode('/', $serverUrl);
-		$filename = array_pop($pathParts);
-		if($filename === '.') {
-			// remove /. from the end of the path
-			$serverUrl = mb_substr($serverUrl, 0, mb_strlen($serverUrl) - 2);
-		}
-
-		return $serverUrl;
-	}
+    const SP_PROPERTY_SIZE = 'Length';
+    const SP_PROPERTY_MTIME = 'TimeLastModified';
+    const SP_PROPERTY_URL = 'ServerRelativeUrl';
+
+    /** @var  string */
+    protected $server;
+
+    /** @var  string */
+    protected $documentLibrary;
+
+    /** @var  string */
+    protected $authUser;
+
+    /** @var  string */
+    protected $authPwd;
+
+    /** @var  SharePointClient */
+    protected $spClient;
+
+    /** @var  CappedMemoryCache */
+    protected $fileCache;
+
+    /** @var ContextsFactory */
+    private $contextsFactory;
+
+    /** @var ITempManager */
+    private $tempManager;
+
+    public function __construct($parameters) {
+        $this->server = $parameters['host'];
+        $this->documentLibrary = $parameters['documentLibrary'];
+
+        if(strpos($this->documentLibrary, '"') !== false) {
+            // they are, amongst others, not allowed and we use it in the filter
+            // cf. https://support.microsoft.com/en-us/kb/2933738
+            // TODO: verify, it talks about files and folders mostly
+            throw new \InvalidArgumentException('Illegal character in Document Library Name');
+        }
+
+        if(!isset($parameters['user']) || !isset($parameters['password'])) {
+            throw new \UnexpectedValueException('No user or password given');
+        }
+        $this->authUser = $parameters['user'];
+        $this->authPwd  = $parameters['password'];
+
+        $this->fixDI($parameters);
+    }
+
+    /**
+     * Get the identifier for the storage,
+     * the returned id should be the same for every storage object that is created with the same parameters
+     * and two storage objects with the same id should refer to two storages that display the same files.
+     *
+     * @return string
+     * @since 6.0.0
+     */
+    public function getId() {
+        return 'SharePoint::' . $this->server . '::' . $this->documentLibrary . '::' . $this->authUser;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.mkdir.php
+     * implementations need to implement a recursive mkdir
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function mkdir($path) {
+        $serverUrl = $this->formatPath($path);
+        try {
+            $folder = $this->spClient->createFolder($serverUrl);
+            $this->fileCache->set($serverUrl, [
+                'instance' => $folder,
+                'children' => [
+                    'folders' => $folder->getFolders(),
+                    'files' => $folder->getFiles()
+                ]
+            ]);
+            return true;
+        } catch (\Exception $e) {
+            $this->fileCache->remove($serverUrl);
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.rmdir.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function rmdir($path) {
+        $serverUrl = $this->formatPath($path);
+        try {
+            $folder = $this->getFileOrFolder($serverUrl);
+            $this->spClient->delete($folder);
+            $this->fileCache->set($serverUrl, false);
+            return true;
+        } catch (\Exception $e) {
+            $this->fileCache->remove($serverUrl);
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.opendir.php
+     *
+     * @param string $path
+     * @return resource|false
+     * @since 6.0.0
+     */
+    public function opendir($path) {
+        try {
+            $serverUrl = $this->formatPath($path);
+            //$collections = $this->spClient->fetchFolderContents($serverUrl, ['Name', 'ListItemAllFields']);	// does not work for some reason :(
+            $collections = $this->getFolderContents($serverUrl);
+            $files = [];
+
+            foreach ($collections as $collection) {
+                /** @var File[]|Folder[] $items */
+                $items = $collection->getData();
+                foreach ($items as $item) {
+                    /** @var ListItem $fields */
+                    if(!$this->spClient->isHidden($item)) {
+                        $files[] = $item->getProperty('Name');
+                    }
+                }
+            }
+
+            return IteratorDirectory::wrap($files);
+        } catch (NotFoundException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.stat.php
+     * only the following keys are required in the result: size and mtime
+     *
+     * @param string $path
+     * @return array|false
+     * @since 6.0.0
+     */
+    public function stat($path) {
+        $serverUrl = $this->formatPath($path);
+        try {
+            $file = $this->getFileOrFolder($serverUrl);
+        } catch (\Exception $e) {
+            return false;
+        }
+
+        $size = $file->getProperty(self::SP_PROPERTY_SIZE) ?: FileInfo::SPACE_UNKNOWN;
+        $mtimeValue = $file->getProperty(self::SP_PROPERTY_MTIME);
+        $mtime = $mtimeValue ? new \DateTime($mtimeValue) : null;
+
+        $stat = [
+            // int64, size in bytes, excluding the size of any Web Parts that are used in the file.
+            'size'  => $size,
+            'mtime' => $mtime->getTimestamp(),
+            // no property in SP 2013 & 2016, other storages do the same  :speak_no_evil:
+            'atime' => time(),
+        ];
+
+        if(!is_null($stat['mtime'])) {
+            return $stat;
+        }
+
+        // If we do not get a mtime from SP, we treat it as an error
+        // thus returning false, according to PHP documentation on stat()
+        return false;
+    }
+
+    /**
+     * see http://php.net/manual/en/function.filetype.php
+     *
+     * @param string $path
+     * @return false|string
+     * @throws \Exception
+     * @since 6.0.0
+     */
+    public function filetype($path) {
+        try {
+            $serverUrl = $this->formatPath($path);
+            $object = $this->getFileOrFolder($serverUrl);
+        } catch (NotFoundException $e) {
+            return false;
+        }
+        if($object instanceof File) {
+            return 'file';
+        } else if($object instanceof Folder) {
+            return 'dir';
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.file_exists.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function file_exists($path) {
+        try {
+            $serverUrl = $this->formatPath($path);
+            // alternative approach is to use a CAML query instead of querying
+            // for file and folder. It is not necessarily faster, though.
+            // Would need evaluation of typical use cases (I assume most often
+            // existing files are checked) and measurements.
+            $this->getFileOrFolder($serverUrl);
+            return true;
+        } catch (NotFoundException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.unlink.php
+     *
+     * @param string $path
+     * @return bool
+     * @since 6.0.0
+     */
+    public function unlink($path) {
+        // file methods get called twice at least, returning true
+        if(!$this->file_exists($path)) {
+            return true;
+        }
+        try {
+            $serverUrl = $this->formatPath($path);
+            $this->spClient->delete($this->getFileOrFolder($serverUrl));
+            $this->fileCache->set($serverUrl, false);
+            return true;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    public function rename($path1, $path2) {
+        $oldPath = $this->formatPath($path1);
+        $newPath = $this->formatPath($path2);
+
+        try {
+            $item = $this->getFileOrFolder($newPath);
+            $this->spClient->delete($item);
+            $this->fileCache->remove($newPath);
+        } catch(NotFoundException $e) {
+            // noop
+        }
+
+        try {
+            $isRenamed = $this->spClient->rename($oldPath, $newPath);
+            if($isRenamed) {
+                $entry = $this->fileCache->get($oldPath);
+                $this->fileCache->remove($newPath);
+                if($entry !== false) {
+                    $this->fileCache->set($newPath, $entry);
+                }
+                $this->fileCache->remove($oldPath);
+            }
+            return $isRenamed;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.fopen.php
+     *
+     * @param string $path
+     * @param string $mode
+     * @return resource|false
+     * @since 6.0.0
+     */
+    public function fopen($path, $mode) {
+        $serverUrl = $this->formatPath($path);
+
+        switch ($mode) {
+            case 'a':
+            case 'ab':
+            case 'a+':
+                // no native support
+                return false;
+            case 'r':
+            case 'rb':
+                $tmpFile = $this->tempManager->getTemporaryFile();
+
+                $fp = fopen($tmpFile, 'w+');
+                if(!$this->spClient->getFileViaStream($serverUrl, $fp)) {
+                    fclose($fp);
+                    return false;
+                }
+                fseek($fp, 0);
+                return $fp;
+                break;
+            case 'r+':
+            case 'rb+':
+            case 'r+b':
+                // fseek 0
+            case 'w':
+            case 'w+':
+            case 'wb':
+            case 'wb+':
+            case 'w+b':
+                // truncate
+                // fseek 0
+            case 'x':
+            case 'x+':
+            case 'xb':
+            case 'xb+':
+            case 'x+b':
+                // fseek 0
+            case 'c':
+            case 'cb':
+            case 'c+':
+            case 'cb+':
+            case 'c+b':
+                //fseek 0
+                if($mode[0] === 'x' && $this->file_exists($path)) {
+                    return false;
+                }
+                $tmpFile = $this->tempManager->getTemporaryFile();
+                if($mode[0] !== 'w' && $this->file_exists($path)) {
+                    $content = $this->fopen($path, 'r');
+                    if($content === false) {
+                        // should not happen, but let's be safe
+                        return false;
+                    }
+                    $this->file_put_contents($tmpFile, $content);
+                }
+                $fp = fopen($tmpFile, $mode);
+                return CallbackWrapper::wrap($fp, null, null, function () use ($path, $tmpFile) {
+                    $this->writeBack($tmpFile, $path);
+                });
+
+        }
+        return false;
+    }
+
+    public function writeBack($tmpFile, $path) {
+        $serverUrl = $this->formatPath($path);
+        $content = file_get_contents($tmpFile);
+        $fp = fopen($tmpFile, 'r');
+
+        try {
+            if ($this->file_exists($path)) {
+                $this->spClient->overwriteFileViaStream($serverUrl, $fp, $tmpFile);
+                fclose($fp);
+                $this->fileCache->remove($serverUrl);
+            } else {
+                $file = $this->spClient->uploadNewFile($serverUrl, $content);
+                $this->fileCache->set($serverUrl, ['instance' => $file]);
+            }
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * see http://php.net/manual/en/function.touch.php
+     * If the backend does not support the operation, false should be returned
+     *
+     * @param string $path
+     * @param int $mtime
+     * @return bool
+     * @since 6.0.0
+     */
+    public function touch($path, $mtime = null) {
+        // TODO: Implement touch() method.
+        return true;
+    }
+
+
+    /**
+     * work around dependency injection issues so we can test this class properly
+     *
+     * @param array $parameters
+     */
+    private function fixDI(array $parameters) {
+        if(isset($parameters['contextFactory'])
+            && $parameters['contextFactory'] instanceof ContextsFactory)
+        {
+            $this->contextsFactory = $parameters['contextFactory'];
+        } else {
+            $this->contextsFactory = new ContextsFactory();
+        }
+
+        if(isset($parameters['sharePointClientFactory'])
+            && $parameters['sharePointClientFactory'] instanceof SharePointClientFactory)
+        {
+            $spcFactory = $parameters['sharePointClientFactory'];
+        } else {
+            $spcFactory = new SharePointClientFactory();
+        }
+        $this->spClient = $spcFactory->getClient(
+            $this->contextsFactory,
+            $this->server,
+            [ 'user' => $this->authUser, 'password' => $this->authPwd],
+            $this->documentLibrary
+        );
+
+        if(isset($parameters['cappedMemoryCache'])) {
+            $this->fileCache = $parameters['cappedMemoryCache'];
+        } else {
+            // there's no API to get such
+            $this->fileCache = new CappedMemoryCache();
+        }
+
+        if(isset($parameters['tempManager'])) {
+            $this->tempManager = $parameters['tempManager'];
+        } else {
+            $this->tempManager = \OC::$server->getTempManager();
+        }
+    }
+
+    /**
+     * @param $serverUrl
+     * @return ClientObjectCollection[]
+     */
+    private function getFolderContents($serverUrl) {
+        $entry = $this->fileCache->get($serverUrl);
+        if($entry === null || !isset($entry['children'])) {
+            $folder = isset($entry['instance']) ? $entry['instance'] : null;
+            $contents = $this->spClient->fetchFolderContents($serverUrl, null, $folder);
+            $cacheItem = $entry ?: [];
+            $cacheItem['children'] = $contents;
+            $this->fileCache->set($serverUrl, $cacheItem);
+
+            // cache children instances
+            foreach ($contents as $collection) {
+                foreach ($collection->getData() as $item) {
+                    /** @var  File|Folder $item */
+                    $url = $item->getProperty(self::SP_PROPERTY_URL);
+                    $itemEntry = $this->fileCache->get($url);
+                    $itemEntry = $itemEntry ?: [];
+                    if(!isset($itemEntry['instance'])) {
+                        $itemEntry['instance'] = $item;
+                        $this->fileCache->set($url, $itemEntry);
+                    }
+                }
+            }
+        } else {
+            $contents = $entry['children'];
+        }
+        return $contents;
+    }
+
+    /**
+     * @param $serverUrl
+     * @return File|Folder
+     * @throws NotFoundException
+     */
+    private function getFileOrFolder($serverUrl) {
+        $entry = $this->fileCache->get($serverUrl);
+        if($entry === false) {
+            throw new NotFoundException('File or Folder not found');
+        } else if($entry === null || !isset($entry['instance'])) {
+            try {
+                $file = $this->spClient->fetchFileOrFolder($serverUrl, [self::SP_PROPERTY_SIZE, self::SP_PROPERTY_MTIME]);
+            } catch (NotFoundException $e) {
+                $this->fileCache->set($serverUrl, false);
+                throw $e;
+            }
+            $cacheItem = $entry ?: [];
+            $cacheItem['instance'] = $file;
+            $this->fileCache->set($serverUrl, $cacheItem);
+        } else {
+            $file = $entry['instance'];
+        }
+        return $file;
+    }
+
+    /**
+     * creates the relative server "url" out of the provided path
+     *
+     * @param $path
+     * @return string
+     */
+    private function formatPath($path) {
+        $path = trim($path, '/');
+        $serverUrl = '/' . $this->documentLibrary;
+        if($path !== '') {
+            $serverUrl .= '/' . $path;
+        }
+
+        $pathParts = explode('/', $serverUrl);
+        $filename = array_pop($pathParts);
+        if($filename === '.') {
+            // remove /. from the end of the path
+            $serverUrl = mb_substr($serverUrl, 0, mb_strlen($serverUrl) - 2);
+        }
+
+        return $serverUrl;
+    }
 
 }

Spacing +29 added lines, -29 removed lines

@@ -71,14 +71,14 @@ 
 		$this->server = $parameters['host'];
 		$this->documentLibrary = $parameters['documentLibrary'];
 
-		if(strpos($this->documentLibrary, '"') !== false) {
+		if (strpos($this->documentLibrary, '"') !== false) {
 			// they are, amongst others, not allowed and we use it in the filter
 			// cf. https://support.microsoft.com/en-us/kb/2933738
 			// TODO: verify, it talks about files and folders mostly
 			throw new \InvalidArgumentException('Illegal character in Document Library Name');
 		}
 
-		if(!isset($parameters['user']) || !isset($parameters['password'])) {
+		if (!isset($parameters['user']) || !isset($parameters['password'])) {
 			throw new \UnexpectedValueException('No user or password given');
 		}
 		$this->authUser = $parameters['user'];
@@ -96,7 +96,7 @@ 
 	 * @since 6.0.0
 	 */
 	public function getId() {
-		return 'SharePoint::' . $this->server . '::' . $this->documentLibrary . '::' . $this->authUser;
+		return 'SharePoint::'.$this->server.'::'.$this->documentLibrary.'::'.$this->authUser;
 	}
 
 	/**
@@ -164,7 +164,7 @@ 
 				$items = $collection->getData();
 				foreach ($items as $item) {
 					/** @var ListItem $fields */
-					if(!$this->spClient->isHidden($item)) {
+					if (!$this->spClient->isHidden($item)) {
 						$files[] = $item->getProperty('Name');
 					}
 				}
@@ -204,7 +204,7 @@ 
 			'atime' => time(),
 		];
 
-		if(!is_null($stat['mtime'])) {
+		if (!is_null($stat['mtime'])) {
 			return $stat;
 		}
 
@@ -228,9 +228,9 @@ 
 		} catch (NotFoundException $e) {
 			return false;
 		}
-		if($object instanceof File) {
+		if ($object instanceof File) {
 			return 'file';
-		} else if($object instanceof Folder) {
+		} else if ($object instanceof Folder) {
 			return 'dir';
 		} else {
 			return false;
@@ -267,7 +267,7 @@ 
 	 */
 	public function unlink($path) {
 		// file methods get called twice at least, returning true
-		if(!$this->file_exists($path)) {
+		if (!$this->file_exists($path)) {
 			return true;
 		}
 		try {
@@ -288,16 +288,16 @@ 
 			$item = $this->getFileOrFolder($newPath);
 			$this->spClient->delete($item);
 			$this->fileCache->remove($newPath);
-		} catch(NotFoundException $e) {
+		} catch (NotFoundException $e) {
 			// noop
 		}
 
 		try {
 			$isRenamed = $this->spClient->rename($oldPath, $newPath);
-			if($isRenamed) {
+			if ($isRenamed) {
 				$entry = $this->fileCache->get($oldPath);
 				$this->fileCache->remove($newPath);
-				if($entry !== false) {
+				if ($entry !== false) {
 					$this->fileCache->set($newPath, $entry);
 				}
 				$this->fileCache->remove($oldPath);
@@ -330,7 +330,7 @@ 
 				$tmpFile = $this->tempManager->getTemporaryFile();
 
 				$fp = fopen($tmpFile, 'w+');
-				if(!$this->spClient->getFileViaStream($serverUrl, $fp)) {
+				if (!$this->spClient->getFileViaStream($serverUrl, $fp)) {
 					fclose($fp);
 					return false;
 				}
@@ -360,20 +360,20 @@ 
 			case 'cb+':
 			case 'c+b':
 				//fseek 0
-				if($mode[0] === 'x' && $this->file_exists($path)) {
+				if ($mode[0] === 'x' && $this->file_exists($path)) {
 					return false;
 				}
 				$tmpFile = $this->tempManager->getTemporaryFile();
-				if($mode[0] !== 'w' && $this->file_exists($path)) {
+				if ($mode[0] !== 'w' && $this->file_exists($path)) {
 					$content = $this->fopen($path, 'r');
-					if($content === false) {
+					if ($content === false) {
 						// should not happen, but let's be safe
 						return false;
 					}
 					$this->file_put_contents($tmpFile, $content);
 				}
 				$fp = fopen($tmpFile, $mode);
-				return CallbackWrapper::wrap($fp, null, null, function () use ($path, $tmpFile) {
+				return CallbackWrapper::wrap($fp, null, null, function() use ($path, $tmpFile) {
 					$this->writeBack($tmpFile, $path);
 				});
 
@@ -421,7 +421,7 @@ 
 	 * @param array $parameters
 	 */
 	private function fixDI(array $parameters) {
-		if(isset($parameters['contextFactory'])
+		if (isset($parameters['contextFactory'])
 			&& $parameters['contextFactory'] instanceof ContextsFactory)
 		{
 			$this->contextsFactory = $parameters['contextFactory'];
@@ -429,7 +429,7 @@ 
 			$this->contextsFactory = new ContextsFactory();
 		}
 
-		if(isset($parameters['sharePointClientFactory'])
+		if (isset($parameters['sharePointClientFactory'])
 			&& $parameters['sharePointClientFactory'] instanceof SharePointClientFactory)
 		{
 			$spcFactory = $parameters['sharePointClientFactory'];
@@ -439,18 +439,18 @@ 
 		$this->spClient = $spcFactory->getClient(
 			$this->contextsFactory,
 			$this->server,
-			[ 'user' => $this->authUser, 'password' => $this->authPwd],
+			['user' => $this->authUser, 'password' => $this->authPwd],
 			$this->documentLibrary
 		);
 
-		if(isset($parameters['cappedMemoryCache'])) {
+		if (isset($parameters['cappedMemoryCache'])) {
 			$this->fileCache = $parameters['cappedMemoryCache'];
 		} else {
 			// there's no API to get such
 			$this->fileCache = new CappedMemoryCache();
 		}
 
-		if(isset($parameters['tempManager'])) {
+		if (isset($parameters['tempManager'])) {
 			$this->tempManager = $parameters['tempManager'];
 		} else {
 			$this->tempManager = \OC::$server->getTempManager();
@@ -463,7 +463,7 @@ 
 	 */
 	private function getFolderContents($serverUrl) {
 		$entry = $this->fileCache->get($serverUrl);
-		if($entry === null || !isset($entry['children'])) {
+		if ($entry === null || !isset($entry['children'])) {
 			$folder = isset($entry['instance']) ? $entry['instance'] : null;
 			$contents = $this->spClient->fetchFolderContents($serverUrl, null, $folder);
 			$cacheItem = $entry ?: [];
@@ -477,7 +477,7 @@ 
 					$url = $item->getProperty(self::SP_PROPERTY_URL);
 					$itemEntry = $this->fileCache->get($url);
 					$itemEntry = $itemEntry ?: [];
-					if(!isset($itemEntry['instance'])) {
+					if (!isset($itemEntry['instance'])) {
 						$itemEntry['instance'] = $item;
 						$this->fileCache->set($url, $itemEntry);
 					}
@@ -496,9 +496,9 @@ 
 	 */
 	private function getFileOrFolder($serverUrl) {
 		$entry = $this->fileCache->get($serverUrl);
-		if($entry === false) {
+		if ($entry === false) {
 			throw new NotFoundException('File or Folder not found');
-		} else if($entry === null || !isset($entry['instance'])) {
+		} else if ($entry === null || !isset($entry['instance'])) {
 			try {
 				$file = $this->spClient->fetchFileOrFolder($serverUrl, [self::SP_PROPERTY_SIZE, self::SP_PROPERTY_MTIME]);
 			} catch (NotFoundException $e) {
@@ -522,14 +522,14 @@ 
 	 */
 	private function formatPath($path) {
 		$path = trim($path, '/');
-		$serverUrl = '/' . $this->documentLibrary;
-		if($path !== '') {
-			$serverUrl .= '/' . $path;
+		$serverUrl = '/'.$this->documentLibrary;
+		if ($path !== '') {
+			$serverUrl .= '/'.$path;
 		}
 
 		$pathParts = explode('/', $serverUrl);
 		$filename = array_pop($pathParts);
-		if($filename === '.') {
+		if ($filename === '.') {
 			// remove /. from the end of the path
 			$serverUrl = mb_substr($serverUrl, 0, mb_strlen($serverUrl) - 2);
 		}