grommunio / grommunio-web

plugins/filesbackendDefault/php/class.plugindefault.php

Indentation +51 added lines, -51 removed lines

@@ -7,58 +7,58 @@
  */
 class PluginFilesbackendDefault extends Plugin
 {
-    /**
-     * Constructor.
-     */
-    public function __construct()
-    {
-    }
+	/**
+	 * Constructor.
+	 */
+	public function __construct()
+	{
+	}
 
-    /**
-     * Called to initialize the plugin and register for hooks.
-     */
-    public function init()
-    {
-        $this->registerHook('server.core.settings.init.before');
-    }
+	/**
+	 * Called to initialize the plugin and register for hooks.
+	 */
+	public function init()
+	{
+		$this->registerHook('server.core.settings.init.before');
+	}
 
-    /**
-     * Function is executed when a hook is triggered by the PluginManager.
-     *
-     * @param string $eventID Identifier of the hook
-     * @param array  $data    Reference to the data of the triggered hook
-     */
-    public function execute($eventID, &$data)
-    {
-        switch ($eventID) {
-            case 'server.core.settings.init.before':
-                $this->onBeforeSettingsInit($data);
-                break;
-        }
-    }
+	/**
+	 * Function is executed when a hook is triggered by the PluginManager.
+	 *
+	 * @param string $eventID Identifier of the hook
+	 * @param array  $data    Reference to the data of the triggered hook
+	 */
+	public function execute($eventID, &$data)
+	{
+		switch ($eventID) {
+			case 'server.core.settings.init.before':
+				$this->onBeforeSettingsInit($data);
+				break;
+		}
+	}
 
-    /**
-     * Called when the core Settings class is initialized and ready to accept sysadmin default
-     * settings. Registers the sysadmin defaults for the files backend plugin.
-     *
-     * @param array $data Reference to the data of the triggered hook
-     */
-    public function onBeforeSettingsInit(&$data)
-    {
-        $data['settingsObj']->addSysAdminDefaults([
-            'zarafa' => [
-                'v1' => [
-                    'plugins' => [
-                        'filesbackendDefault' => [
-                            'enable' => true,
-                        ],
-                        // Compatibility alias for pre-existing configurations
-                        'filesbackendOwncloud' => [
-                            'enable' => true,
-                        ],
-                    ],
-                ],
-            ],
-        ]);
-    }
+	/**
+	 * Called when the core Settings class is initialized and ready to accept sysadmin default
+	 * settings. Registers the sysadmin defaults for the files backend plugin.
+	 *
+	 * @param array $data Reference to the data of the triggered hook
+	 */
+	public function onBeforeSettingsInit(&$data)
+	{
+		$data['settingsObj']->addSysAdminDefaults([
+			'zarafa' => [
+				'v1' => [
+					'plugins' => [
+						'filesbackendDefault' => [
+							'enable' => true,
+						],
+						// Compatibility alias for pre-existing configurations
+						'filesbackendOwncloud' => [
+							'enable' => true,
+						],
+					],
+				],
+			],
+		]);
+	}
 }

Braces +4 added lines, -8 removed lines

@@ -10,15 +10,13 @@ 
     /**
      * Constructor.
      */
-    public function __construct()
-    {
+    public function __construct() {
     }
 
     /**
      * Called to initialize the plugin and register for hooks.
      */
-    public function init()
-    {
+    public function init() {
         $this->registerHook('server.core.settings.init.before');
     }
 
@@ -28,8 +26,7 @@ 
      * @param string $eventID Identifier of the hook
      * @param array  $data    Reference to the data of the triggered hook
      */
-    public function execute($eventID, &$data)
-    {
+    public function execute($eventID, &$data) {
         switch ($eventID) {
             case 'server.core.settings.init.before':
                 $this->onBeforeSettingsInit($data);
@@ -43,8 +40,7 @@ 
      *
      * @param array $data Reference to the data of the triggered hook
      */
-    public function onBeforeSettingsInit(&$data)
-    {
+    public function onBeforeSettingsInit(&$data) {
         $data['settingsObj']->addSysAdminDefaults([
             'zarafa' => [
                 'v1' => [

plugins/filesbackendSeafile/php/class.backend.php

Indentation +1034 added lines, -1034 removed lines

@@ -37,1038 +37,1038 @@
  */
 final class Backend extends AbstractBackend implements iFeatureVersionInfo
 {
-    public const LOG_CONTEXT = "SeafileBackend"; // Context for the Logger
-
-    /**
-     * @const string gettext domain
-     */
-    private const GT_DOMAIN = 'plugin_filesbackendSeafile';
-
-    /**
-     * Seafile "usage" number ("bytes") to Grommunio usage display number ("bytes") multiplier.
-     *
-     * 1 megabyte in bytes within Seafile represents 1 mebibyte in bytes for Grommunio
-     *
-     * (Seafile Usage "Bytes" U) / 1000 / 1000 * 1024 * 1024 (1.048576)
-     */
-    private const QUOTA_MULTIPLIER_SEAFILE_TO_GROMMUNIO = 1.048576;
-
-    /**
-     * Error codes
-     *
-     * @see parseErrorCodeToMessage for description
-     * @see Backend::backendException() for Seafile API handling
-     */
-    private const SFA_ERR_UNAUTHORIZED = 401;
-    private const SFA_ERR_FORBIDDEN = 403;
-    private const SFA_ERR_NOTFOUND = 404;
-    private const SFA_ERR_NOTALLOWED = 405;
-    private const SFA_ERR_TIMEOUT = 408;
-    private const SFA_ERR_LOCKED = 423;
-    private const SFA_ERR_FAILED_DEPENDENCY = 423;
-    private const SFA_ERR_INTERNAL = 500;
-    private const SFA_ERR_UNREACHABLE = 800;
-    private const SFA_ERR_TMP = 801;
-    private const SFA_ERR_FEATURES = 802;
-    private const SFA_ERR_NO_CURL = 803;
-    private const SFA_ERR_UNIMPLEMENTED = 804;
-
-    /**
-     * @var ?SeafileApi The Seafile API client.
-     */
-    private ?SeafileApi $seafapi = null;
-
-    /**
-     * Configuration data for the Ext JS metaform.
-     */
-    private array $metaConfig = [];
-
-    /**
-     * Debug flag that mirrors `PLUGIN_FILESBROWSER_LOGLEVEL`.
-     */
-    private bool $debug = false;
-
-    private Config $config;
-
-    private ?SsoBackend $sso = null;
-
-    /**
-     * Backend name used in translations.
-     */
-    private string $backendTransName = '';
-
-    /**
-     * Seafile backend constructor
-     */
-    public function __construct()
-    {
-        // initialization
-        $this->debug = PLUGIN_FILESBROWSER_LOGLEVEL === 'DEBUG';
-
-        $this->config = new Config();
-
-        $this->init_form();
-
-        // set backend description
-        $this->backendDescription = dgettext(self::GT_DOMAIN, "With this backend, you can connect to any Seafile server.");
-
-        // set backend display name
-        $this->backendDisplayName = "Seafile";
-
-        // set backend version
-        $this->backendVersion = "2.0.68";
-
-        // set backend name used in translations
-        $this->backendTransName = dgettext(self::GT_DOMAIN, 'Files ' . $this->backendDisplayName . ' Backend: ');
-    }
-
-    ////////////////////////////////////////////////////////////////////////////
-    /// seafapi backend methods                                              ///
-    ////////////////////////////////////////////////////////////////////////////
-
-    /**
-     * Opens the connection to the Seafile server.
-     *
-     * @throws BackendException if connection is not successful
-     * @return boolean true if action succeeded
-     */
-    public function open()
-    {
-        $url = $this->config->getApiUrl();
-
-        try {
-            $this->sso->open();
-        } catch (Throwable $throwable) {
-            $this->backendException($throwable);
-        }
-
-        try {
-            $this->seafapi = new SeafileApi($url, $this->config->user, $this->config->pass);
-        } catch (Throwable $throwable) {
-            $this->backendException($throwable);
-        }
-
-        return true;
-    }
-
-    /**
-     * This function will read a list of files and folders from the server.
-     *
-     * @param string $dir to get listing from
-     * @param bool $hidefirst skip the first entry (we ignore this for the Seafile backend)
-     * @throws BackendException
-     *
-     * @return array
-     */
-    public function ls($dir, $hidefirst = true)
-    {
-        $timer = new Timer();
-        $this->log("[LS] '$dir'");
-
-        if ('' === trim($dir, '/')) {
-            try {
-                $listing = $this->seafapi->listLibraries();
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-            goto result;
-        }
-
-        $lsDir = $this->splitGrommunioPath($dir);
-        if (null === $lsDir->lib) {
-            // the library does not exist, the listing is short.
-            $listing = [];
-            goto result;
-        }
-
-        try {
-            $listing = $this->seafapi->listItemsInDirectory($lsDir->lib, $lsDir->path ?? '');
-        } catch (Throwable $throwable) {
-            $this->backendException($throwable);
-        }
-
-        result:
-
-        $result = [];
-        $baseDir = rtrim($dir, '/') . '/';
-        foreach ($listing as $node) {
-            if (!isset($this->seafapi::TYPES[$node->type])) {
-                $this->backendException(
-                    new \UnexpectedValueException(sprintf('Unhandled Seafile node-type "%s" (for "%s")', $node->type, $node->name))
-                );
-            }
-            $isDir = isset($this->seafapi::TYPES_DIR_LIKE[$node->type]);
-            $name = rtrim($baseDir . $node->name, '/') . '/';
-            $isDir || $name = rtrim($name, '/');
-            $result[$name] = [
-                'resourcetype' => $isDir ? 'collection' : 'file',
-                'getcontentlength' => $isDir ? null : $node->size,
-                'getlastmodified' => date('r', $node->mtime),
-                'getcontenttype' => null,
-                'quota-used-bytes' => null,
-                'quota-available-bytes' => null,
-            ];
-        }
-
-        $this->log("[LS] done in $timer seconds.");
-        return $result;
-    }
-
-    /**
-     * Creates a new directory on the server.
-     *
-     * @param string $dir
-     * @throws BackendException
-     * @return bool
-     */
-    public function mkcol($dir)
-    {
-        $timer = new Timer();
-        $this->log("[MKCOL] '$dir'");
-
-        if ($this->isLibrary($dir)) {
-            // create library
-            try {
-                $result = $this->seafapi->createLibrary($dir);
-                unset($result);
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-            $success = true;
-        } else {
-            // create directory within library
-            $lib = $this->seafapi->getLibraryFromPath($dir)->id;
-            [, $path] = explode('/', trim($dir, '/'), 2);
-            try {
-                $result = $this->seafapi->createNewDirectory($lib, $path);
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-            $success = 'success' === $result;
-        }
-
-        $this->log("[MKCOL] done in $timer seconds.");
-        return $success;
-    }
-
-    /**
-     * Deletes a files or folder from the backend.
-     *
-     * @param string $path
-     * @throws BackendException
-     * @return bool
-     */
-    public function delete($path)
-    {
-        $timer = new Timer();
-        $this->log("[DELETE] '$path'");
-
-        if ($this->isLibrary($path)) {
-            // delete library
-            try {
-                $this->seafapi->deleteLibraryByName($path);
-                $result = 'success';
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-        } else {
-            // delete file or directory within library
-            $deletePath = $this->splitGrommunioPath($path);
-            try {
-                $result = $this->seafapi->deleteFile($deletePath->lib, $deletePath->path);
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-        }
-
-        $this->log("[DELETE] done in $timer seconds.");
-        return 'success' === $result;
-    }
-
-    /**
-     * Move a file or collection on the backend server (serverside).
-     *
-     * @param string $src_path Source path
-     * @param string $dst_path Destination path
-     * @param bool $overwrite Overwrite file if exists in $dest_path
-     * @throws BackendException
-     * @return bool
-     */
-    public function move($src_path, $dst_path, $overwrite = false)
-    {
-        $timer = new Timer();
-        $this->log("[MOVE] '$src_path' -> '$dst_path'");
-
-        // check if the move operation would move src into itself - error condition
-        if (0 === strpos($dst_path, $src_path . '/')) {
-            $this->backendError(self::SFA_ERR_FORBIDDEN, 'Moving failed');
-        }
-
-        // move library/file/directory is one of in the following order:
-        // 1/5: rename library
-        // 2/5: noop - source and destination are the same
-        // 3/5: rename file/directory
-        // 4/5: move file/directory
-        // 5/5: every other operation (e.g. move library into another library) is not implemented
-
-        $src = $this->splitGrommunioPath($src_path);
-        $dst = $this->splitGrommunioPath($dst_path);
-
-        // 1/5: rename library
-        if ($src->path === null && $dst->path === null) {
-            if ($dst->lib !== null) {
-                // rename to an existing library name (not allowed as not supported)
-                $this->backendError(self::SFA_ERR_NOTALLOWED, 'Moving failed');
-            }
-            try {
-                $this->seafapi->renameLibrary($src->libName, $dst->libName);
-                $result = true;
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-            goto done;
-        }
-
-        $isIntraLibTransaction = $src->libName === $dst->libName;
-
-        // 2/5: noop - src and dst are the same
-        if ($isIntraLibTransaction && $src->path === $dst->path) {
-            // source and destination are the same path, nothing to do
-            $result = 'success';
-            goto done;
-        }
-
-        $dirNames = array_map('dirname', [$src->path, $dst->path]);
-        $pathsHaveSameDirNames = $dirNames[0] === $dirNames[1];
-
-        // 3/5: rename file/directory
-        if ($isIntraLibTransaction && $pathsHaveSameDirNames) {
-            try {
-                $result = $this->seafapi->renameFile($src->lib, $src->path, basename($dst->path));
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-            goto done;
-        }
-
-        // 4/5: move file/directory
-        if (isset($src->path, $dst->lib)) {
-            try {
-                $result = $this->seafapi->moveFile($src->lib, $src->path, $dst->lib, $dirNames[1]);
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-        }
-
-        done:
-
-        // 5/5: every other operation (move library into another library, not implemented)
-        if (!isset($result)) {
-            $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented.');
-        }
-
-        $this->log("[MOVE] done in $timer seconds.");
-        return 'success' === $result;
-    }
-
-    /**
-     * Download a remote file to a buffer variable.
-     *
-     * @param string $path The source path on the server
-     * @param mixed $buffer Buffer for the received data
-     *
-     * @throws BackendException if request is not successful
-     *
-     * @return boolean true if action succeeded
-     */
-    public function get($path, &$buffer)
-    {
-        $timer = new Timer();
-        $this->log("[GET] '$path'");
-
-        $src = $this->splitGrommunioPath($path);
-
-        try {
-            $result = $this->seafapi->downloadFileAsBuffer($src->lib, $src->path);
-        } catch (Throwable $throwable) {
-            $this->backendException($throwable);
-        }
-
-        $success = false !== $result;
-
-        if ($success) {
-            $buffer = $result;
-        }
-
-        $this->log("[GET] done in $timer seconds.");
-        return $success;
-    }
-
-    /**
-     * Download a remote file to a local file.
-     *
-     * @param string $srcpath Source path on server
-     * @param string $localpath Destination path on local filesystem
-     *
-     * @throws BackendException if request is not successful
-     *
-     * @return boolean true if action succeeded
-     */
-    public function get_file($srcpath, $localpath)
-    {
-        $timer = new Timer();
-        $this->log("[GET_FILE] '$srcpath' -> '$localpath'");
-
-        $src = $this->splitGrommunioPath($srcpath);
-
-        try {
-            $result = $this->seafapi->downloadFileToFile($src->lib, $src->path, $localpath);
-        } catch (Throwable $throwable) {
-            $this->backendException($throwable);
-        }
-
-        $this->log("[GET_FILE] done in $timer seconds.");
-        return $result;
-    }
-
-    /**
-     * Puts a file into a collection.
-     *
-     * @param string $path Destination path
-     *
-     * @string mixed $data Any kind of data
-     * @throws BackendException if request is not successful
-     *
-     * @return boolean true if action succeeded
-     */
-    public function put($path, $data)
-    {
-        $timer = new Timer();
-        $this->log(sprintf("[PUT] start: path: %s (%d)", $path, strlen($data)));
-
-        $target = $this->splitGrommunioPath($path);
-
-        try {
-            /** @noinspection PhpUnusedLocalVariableInspection */
-            $result = $this->seafapi->uploadBuffer($target->lib, $target->path, $data);
-        } catch (Throwable $throwable) {
-            $this->backendException($throwable);
-        }
-
-        $this->log("[PUT] done in $timer seconds.");
-        return true;
-    }
-
-    /**
-     * Upload a local file
-     *
-     * @param string $path Destination path on the server
-     * @param string $filename Local filename for the file that should be uploaded
-     *
-     * @throws BackendException if request is not successful
-     *
-     * @return boolean true if action succeeded
-     */
-    public function put_file($path, $filename)
-    {
-        $timer = new Timer();
-        $this->log(sprintf("[PUT_FILE] %s -> %s", $filename, $path));
-
-        // filename can be null if an attachment of draft-email that has not been saved
-        if (empty($filename)) {
-            return false;
-        }
-
-        $target = $this->splitGrommunioPath($path);
-
-        // put file into users default library if no library given
-        if ($target->path === null && $target->libName !== null) {
-            try {
-                $defaultLibrary = $this->seafapi->getDefaultLibrary();
-            } catch (Throwable $throwable) {
-                $this->backendException($throwable);
-            }
-            if (isset($defaultLibrary->repo_id, $defaultLibrary->exists) && true === $defaultLibrary->exists) {
-                $target->path = $target->libName;
-                $target->libName = null;
-                $target->lib = $defaultLibrary->repo_id;
-            }
-        }
-
-        try {
-            /** @noinspection PhpUnusedLocalVariableInspection */
-            $result = $this->seafapi->uploadFile($target->lib, $target->path, $filename);
-        } catch (Throwable $throwable) {
-            $this->backendException($throwable);
-        }
-
-        $this->log("[PUT_FILE] done in $timer seconds.");
-        return true;
-    }
-
-    ////////////////////////////////////////////////////////////////////////////
-    /// non-seafapi backend implementation                                   ///
-    ////////////////////////////////////////////////////////////////////////////
-
-    /**
-     * Initialize backend from $backend_config array
-     *
-     * @param $backend_config
-     * @return void
-     */
-    public function init_backend($backend_config)
-    {
-        $config = $backend_config;
-
-        if ($backend_config["use_zarafa_credentials"]) {
-            // For backward compatibility we will check if the Encryption store exists. If not,
-            // we will fall back to the old way of retrieving the password from the session.
-            if (class_exists('EncryptionStore')) {
-                // Get the username and password from the Encryption store
-                $encryptionStore = EncryptionStore::getInstance();
-                if ($encryptionStore instanceof EncryptionStore) {
-                    $config['user'] = $encryptionStore->get('username');
-                    $config['password'] = $encryptionStore->get('password');
-                }
-            } else {
-                $config['user'] = ConfigUtil::loadSmtpAddress();
-                $password = $_SESSION['password'];
-                if (function_exists('openssl_decrypt')) {
-                    /** @noinspection PhpUndefinedConstantInspection */
-                    $config['password'] = openssl_decrypt($password, "des-ede3-cbc", PASSWORD_KEY, 0, PASSWORD_IV);
-                }
-            }
-        }
-
-        $this->config->importConfigArray($config);
-
-        SsoBackend::bind($this->sso)->initBackend($this->config);
-
-        Logger::debug(self::LOG_CONTEXT, __FUNCTION__ . ' done.');
-    }
-
-    /**
-     * @return false|string
-     * @noinspection PhpMultipleClassDeclarationsInspection Grommunio has a \JsonException shim
-     */
-    public function getFormConfig()
-    {
-        try {
-            $json = json_encode($this->metaConfig, JSON_THROW_ON_ERROR);
-        } catch (JsonException $e) {
-            $this->log(sprintf('[%s]: %s', get_class($e), $e->getMessage()));
-            $json = false;
-        }
-
-        return $json;
-    }
-
-    public function getFormConfigWithData()
-    {
-        return $this->getFormConfig();
-    }
-
-    /**
-     * set debug on (1) or off (0).
-     * produces a lot of debug messages in webservers error log if set to on (1).
-     *
-     * @param boolean $debug enable or disable debugging
-     *
-     * @return void
-     */
-    public function set_debug($debug)
-    {
-        $this->debug = (bool)$debug;
-    }
-
-    ////////////////////////////////////////////////////////////////////////////
-    /// not_used_implemented()                                               ///
-    ////////////////////////////////////////////////////////////////////////////
-
-    /**
-     * Duplicates a folder on the backend server.
-     *
-     * @param string $src_path
-     * @param string $dst_path
-     * @param bool $overwrite
-     * @throws BackendException
-     * @return bool
-     * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
-     */
-    public function copy_coll($src_path, $dst_path, $overwrite = false)
-    {
-        $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
-    }
-
-    /**
-     * Duplicates a file on the backend server.
-     *
-     * @param string $src_path
-     * @param string $dst_path
-     * @param bool $overwrite
-     * @throws BackendException
-     * @return bool
-     * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
-     */
-    public function copy_file($src_path, $dst_path, $overwrite = false)
-    {
-        $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
-    }
-
-    /**
-     * Checks if the given $path exists on the remote server.
-     *
-     * @param string $path
-     * @throws BackendException
-     * @return bool
-     * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
-     */
-    public function exists($path)
-    {
-        $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
-    }
-
-    /**
-     * Gets path information from Seafile server.
-     *
-     * @param string $path
-     * @throws BackendException if request is not successful
-     * @return array directory info
-     */
-    public function gpi($path)
-    {
-        $this->log("[GPI] '$path'");
-        $list = $this->ls(dirname($path), false); // get contents of the parent dir
-
-        if (isset($list[$path])) {
-            return $list[$path];
-        }
-
-        $this->log('[GPI] wrong response from ls');
-        $this->backendError(self::SFA_ERR_FAILED_DEPENDENCY, 'Connection failed');
-    }
-
-    /**
-     * Checks if the given $path is a folder.
-     *
-     * @param string $path
-     * @throws BackendException
-     * @return bool
-     * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
-     */
-    public function is_dir($path)
-    {
-        $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
-    }
-
-    /**
-     * Checks if the given $path is a file.
-     *
-     * @param string $path
-     * @throws BackendException
-     * @return bool
-     * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
-     */
-    public function is_file($path)
-    {
-        $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
-    }
-
-    /////////////////////////////////////////////////////////////
-    // @see iFeatureVersionInfo implementation                 //
-    /////////////////////////////////////////////////////////////
-
-    /**
-     * Return the version string of the server backend.
-     *
-     * @throws BackendException
-     * @return String
-     */
-    public function getServerVersion()
-    {
-        try {
-            return $this->seafapi->getServerVersion();
-        } catch (Throwable $throwable) {
-            $this->backendException($throwable);
-        }
-    }
-
-    /////////////////////////////////////////////////////////////
-    // @see iFeatureQuota implementation                       //
-    /////////////////////////////////////////////////////////////
-
-    /**
-     * @param string $dir
-     * @return float
-     * @noinspection PhpMissingParamTypeInspection
-     * @noinspection PhpUnusedParameterInspection
-     */
-    public function getQuotaBytesUsed($dir)
-    {
-        $return = $this->seafapi->checkAccountInfo();
-
-        return ($return->usage ?? 0) * self::QUOTA_MULTIPLIER_SEAFILE_TO_GROMMUNIO;
-    }
-
-    /**
-     * @param string $dir
-     * @return float|int
-     * @noinspection PhpUnusedParameterInspection
-     * @noinspection PhpMissingParamTypeInspection
-     */
-    public function getQuotaBytesAvailable($dir)
-    {
-        $return = $this->seafapi->checkAccountInfo();
-        $avail = $return->total - $return->usage;
-        if (-2 === (int)$return->total) {
-            return -1;
-        }
-
-        return $avail * self::QUOTA_MULTIPLIER_SEAFILE_TO_GROMMUNIO;
-    }
-
-    /////////////////////////////////////////////////////////////
-    // @internal private helper methods                        //
-    /////////////////////////////////////////////////////////////
-
-    /**
-     * Initialise form fields
-     */
-    private function init_form()
-    {
-        $this->metaConfig = [
-            "success" => true,
-            "metaData" => [
-                "fields" => [
-                    [
-                        "name" => "server_address",
-                        "fieldLabel" => dgettext(self::GT_DOMAIN, 'Server address'),
-                        "editor" => [
-                            "allowBlank" => false,
-                        ],
-                    ],
-                    [
-                        "name" => "server_port",
-                        "fieldLabel" => dgettext(self::GT_DOMAIN, 'Server port'),
-                        "editor" => [
-                            "ref" => "../../portField",
-                            "allowBlank" => false,
-                        ],
-                    ],
-                    [
-                        "name" => "server_ssl",
-                        "fieldLabel" => dgettext(self::GT_DOMAIN, 'Use SSL'),
-                        "editor" => [
-                            "xtype" => "checkbox",
-                            "listeners" => [
-                                "check" => "Zarafa.plugins.files.data.Actions.onCheckSSL" // this javascript function will be called!
-                            ],
-                        ],
-                    ],
-                    [
-                        "name" => "user",
-                        "fieldLabel" => dgettext(self::GT_DOMAIN, 'Username'),
-                        "editor" => [
-                            "ref" => "../../usernameField",
-                        ],
-                    ],
-                    [
-                        "name" => "password",
-                        "fieldLabel" => dgettext(self::GT_DOMAIN, 'Password'),
-                        "editor" => [
-                            "ref" => "../../passwordField",
-                            "inputType" => "password",
-                        ],
-                    ],
-                    [
-                        "name" => "use_zarafa_credentials",
-                        "fieldLabel" => dgettext(self::GT_DOMAIN, 'Use grommunio credentials'),
-                        "editor" => [
-                            "xtype" => "checkbox",
-                            "listeners" => [
-                                "check" => "Zarafa.plugins.files.data.Actions.onCheckCredentials" // this javascript function will be called!
-                            ],
-                        ],
-                    ],
-                ],
-                "formConfig" => [
-                    "labelAlign" => "left",
-                    "columnCount" => 1,
-                    "labelWidth" => 80,
-                    "defaults" => [
-                        "width" => 292,
-                    ],
-                ],
-            ],
-
-            // here we can specify the default values.
-            "data" => [
-                "server_address" => "seafile.example.com",
-                "server_port" => "443",
-                "server_ssl" => "1",
-                "server_path" => "",
-                "use_zarafa_credentials" => "0",
-                "user" => "",
-                "password" => "",
-            ],
-        ];
-    }
-
-    /**
-     * split grommunio path into library and library path
-     *
-     * obtains the seafile library ID (if available, otherwise NULL)
-     *
-     * return protocol: object{
-     *   lib: ?string     # library ID e.g. "ccc60923-8cdf-4cc8-8f71-df86aba3a085"
-     *   path: ?string    # path inside library, always prefixed with "/" if set
-     *   libName: ?string # name of the library
-     * }
-     *
-     * @param string $grommunioPath
-     * @throws Exception
-     * @return object
-     */
-    private function splitGrommunioPath(string $grommunioPath): object
-    {
-        static $libraries;
-        $libraries = $libraries ?? array_column($this->seafapi->listLibraries(), null, 'name');
-
-        [, $libName, $path] = explode('/', $grommunioPath, 3) + [null, null, null];
-        if (null !== $path) {
-            $path = "/$path";
-        }
-        $lib = $libraries[$libName]->id ?? null;
-        return (object)['lib' => $lib, 'path' => $path, 'libName' => $libName];
-    }
-
-    /**
-     * test if a grommunio path is a library only
-     *
-     * @param string $grommunioPath
-     * @return bool
-     */
-    private function isLibrary(string $grommunioPath): bool
-    {
-        return 0 === substr_count(trim($grommunioPath, '/'), '/');
-    }
-
-    /**
-     * Turn a Backend error code into a Backend exception
-     *
-     * @param int $errorCode one of the Backend::SFA_ERR_* codes, e.g. {@see Backend::SFA_ERR_INTERNAL}
-     * @param ?string $title msg-id from the plugin_files domain, e.g. 'PHP-CURL not installed'
-     * @throws BackendException
-     * @return no-return
-     */
-    private function backendError(int $errorCode, string $title = null)
-    {
-        $message = $this->parseErrorCodeToMessage($errorCode);
-        $title = $this->backendTransName;
-        $this->backendErrorThrow($title, $message, $errorCode);
-    }
-
-    /**
-     * Throw a BackendException w/ title, message and code
-     *
-     * @param string $title
-     * @param string $message
-     * @param int $code
-     * @throws BackendException
-     * @return no-return
-     */
-    private function backendErrorThrow(string $title, string $message, int $code = 0)
-    {
-        /** {@see \Files\Backend\Exception} */
-        $exception = new BackendException($message, $code);
-        $exception->setTitle($title);
-        throw $exception;
-    }
-
-    /**
-     * Turn a throwable/exception with the Seafile API into a Backend exception
-     *
-     * @param Throwable $t
-     * @throws BackendException
-     * @return no-return
-     */
-    private function backendException(Throwable $t)
-    {
-        // if it is already a backend exception, throw it.
-        if ($t instanceof BackendException) {
-            throw $t;
-        }
-
-        [$callSite, $inFunc] = debug_backtrace();
-        $logLabel = "$inFunc[function]:$callSite[line]";
-
-        $class = get_class($t);
-        $message = $t->getMessage();
-        $this->log(sprintf('%s: [%s] #%s: %s', $logLabel, $class, $t->getCode(), $message));
-
-        // All SeafileApi exceptions are handled by this
-        if ($t instanceof Exception) {
-            $this->backendExceptionSeafapi($t);
-        }
-
-        $this->backendErrorThrow('Error', "[SEAFILE $logLabel] $class: $message", 500);
-    }
-
-    /**
-     * Turn an Exception into a BackendException
-     *
-     * Enriches message information for grommunio with API error messages
-     * if a Seafile ConnectionException.
-     *
-     * helper for {@see Backend::backendException()}
-     *
-     * @param Exception $exception
-     * @throws BackendException
-     * @return void
-     */
-    private function backendExceptionSeafapi(Exception $exception)
-    {
-        $code = $exception->getCode();
-        $message = $exception->getMessage();
-
-        $apiErrorMessagesHtml = null;
-        if ($exception instanceof Exception\ConnectionException) {
-            $messages = $exception->tryApiErrorMessages();
-            null === $messages || $apiErrorMessagesHtml = implode(
-                    "<br/>\n",
-                    array_map(static function (string $subject) {
-                        return htmlspecialchars($subject, ENT_QUOTES | ENT_HTML5);
-                    }, $messages)
-                ) . "<br/>\n";
-        }
-
-        if (null !== $apiErrorMessagesHtml) {
-            $message .= " - $apiErrorMessagesHtml";
-        }
-
-        $this->backendErrorThrow($this->backendDisplayName . ' Error', $message, $code);
-    }
-
-    /**
-     * a simple php error_log wrapper.
-     *
-     * @param string $err_string error message
-     *
-     * @return void
-     */
-    private function log(string $err_string)
-    {
-        if ($this->debug) {
-            Logger::debug(self::LOG_CONTEXT, $err_string);
-            $this->debugLog($err_string, 2);
-        }
-    }
-
-    /**
-     * This function will return a user-friendly error string.
-     *
-     * Error codes were migrated from WebDav backend.
-     *
-     * @param int $error_code An error code
-     *
-     * @return string user friendly error message
-     */
-    private function parseErrorCodeToMessage(int $error_code)
-    {
-        $error = $error_code;
-
-        switch ($error) {
-            case CURLE_BAD_PASSWORD_ENTERED:
-            case self::SFA_ERR_UNAUTHORIZED:
-                $msg = dgettext(self::GT_DOMAIN, 'Unauthorized. Wrong username or password.');
-                break;
-            case CURLE_SSL_CONNECT_ERROR:
-            case CURLE_COULDNT_RESOLVE_HOST:
-            case CURLE_COULDNT_CONNECT:
-            case CURLE_OPERATION_TIMEOUTED:
-            case self::SFA_ERR_UNREACHABLE:
-                $msg = dgettext(self::GT_DOMAIN, 'Seafile is not reachable. Correct backend address entered?');
-                break;
-            case self::SFA_ERR_FORBIDDEN:
-                $msg = dgettext(self::GT_DOMAIN, 'You don\'t have enough permissions for this operation.');
-                break;
-            case self::SFA_ERR_NOTFOUND:
-                $msg = dgettext(self::GT_DOMAIN, 'File is not available any more.');
-                break;
-            case self::SFA_ERR_TIMEOUT:
-                $msg = dgettext(self::GT_DOMAIN, 'Connection to server timed out. Retry later.');
-                break;
-            case self::SFA_ERR_LOCKED:
-                $msg = dgettext(self::GT_DOMAIN, 'This file is locked by another user.');
-                break;
-            case self::SFA_ERR_FAILED_DEPENDENCY:
-                $msg = dgettext(self::GT_DOMAIN, 'The request failed due to failure of a previous request.');
-                break;
-            case self::SFA_ERR_INTERNAL:
-                $msg = dgettext(self::GT_DOMAIN, 'Seafile-server encountered a problem.');
-                break;
-            case self::SFA_ERR_TMP:
-                $msg = dgettext(self::GT_DOMAIN, 'Could not write to temporary directory. Contact the server administrator.');
-                break;
-            case self::SFA_ERR_FEATURES:
-                $msg = dgettext(self::GT_DOMAIN, 'Could not retrieve list of server features. Contact the server administrator.');
-                break;
-            case self::SFA_ERR_NO_CURL:
-                $msg = dgettext(self::GT_DOMAIN, 'PHP-Curl is not available. Contact your system administrator.');
-                break;
-            case self::SFA_ERR_UNIMPLEMENTED:
-                $msg = dgettext(self::GT_DOMAIN, 'This function is not yet implemented.');
-                break;
-            default:
-                $msg = dgettext(self::GT_DOMAIN, 'Unknown error');
-        }
-
-        return $msg;
-    }
-
-    /////////////////////////////////////////////////////////////
-    // @debug development helper method                        //
-    /////////////////////////////////////////////////////////////
-
-    /**
-     * Log debug message while developing the plugin in dedicated DEBUG.log file
-     *
-     * TODO(tk): remove debugLog, we shall not use it in production.
-     *
-     * @param mixed $message
-     * @param int $backSteps [optional] offset of call point in stacktrace
-     * @return void
-     * @see \Files\Backend\Seafile\Backend::log()
-     */
-    public function debugLog($message, int $backSteps = 0): void
-    {
-        $baseDir = dirname(__DIR__);
-        $debugLogFile = $baseDir . '/DEBUG.log';
-        $backtrace = debug_backtrace();
-        $callPoint = $backtrace[$backSteps];
-        $path = $callPoint['file'];
-        $shortPath = $path;
-        if (0 === strpos($path, $baseDir)) {
-            $shortPath = substr($path, strlen($baseDir));
-        }
-        // TODO(tk): track if the parent function is log() or not, not only the number of back-steps (or check all call points)
-        $callInfoExtra = '';
-        if (1 !== $backSteps) { // this is not a log() call with debug switched on
-            $callInfoExtra = " ($backSteps) " . $backtrace[$backSteps + 1]['type'] . $backtrace[$backSteps + 1]['function'] . '()';
-        }
-        $callInfo = sprintf(' [ %s:%s ]%s', $shortPath, $callPoint['line'], $callInfoExtra);
-
-        if (!is_string($message)) {
-            /** @noinspection JsonEncodingApiUsageInspection */
-            $type = gettype($message);
-            if ('object' === $type && is_callable([$message, '__debugInfo'])) {
-                $message = $message->__debugInfo();
-            }
-            $message = $type . ': ' . json_encode($message, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
-        }
-
-        $message = substr(sprintf('%.3f', $_SERVER['REQUEST_TIME_FLOAT']), -7) . " $message";
-
-        error_log(str_pad($message, 48) . $callInfo . "\n", 3, $debugLogFile);
-    }
+	public const LOG_CONTEXT = "SeafileBackend"; // Context for the Logger
+
+	/**
+	 * @const string gettext domain
+	 */
+	private const GT_DOMAIN = 'plugin_filesbackendSeafile';
+
+	/**
+	 * Seafile "usage" number ("bytes") to Grommunio usage display number ("bytes") multiplier.
+	 *
+	 * 1 megabyte in bytes within Seafile represents 1 mebibyte in bytes for Grommunio
+	 *
+	 * (Seafile Usage "Bytes" U) / 1000 / 1000 * 1024 * 1024 (1.048576)
+	 */
+	private const QUOTA_MULTIPLIER_SEAFILE_TO_GROMMUNIO = 1.048576;
+
+	/**
+	 * Error codes
+	 *
+	 * @see parseErrorCodeToMessage for description
+	 * @see Backend::backendException() for Seafile API handling
+	 */
+	private const SFA_ERR_UNAUTHORIZED = 401;
+	private const SFA_ERR_FORBIDDEN = 403;
+	private const SFA_ERR_NOTFOUND = 404;
+	private const SFA_ERR_NOTALLOWED = 405;
+	private const SFA_ERR_TIMEOUT = 408;
+	private const SFA_ERR_LOCKED = 423;
+	private const SFA_ERR_FAILED_DEPENDENCY = 423;
+	private const SFA_ERR_INTERNAL = 500;
+	private const SFA_ERR_UNREACHABLE = 800;
+	private const SFA_ERR_TMP = 801;
+	private const SFA_ERR_FEATURES = 802;
+	private const SFA_ERR_NO_CURL = 803;
+	private const SFA_ERR_UNIMPLEMENTED = 804;
+
+	/**
+	 * @var ?SeafileApi The Seafile API client.
+	 */
+	private ?SeafileApi $seafapi = null;
+
+	/**
+	 * Configuration data for the Ext JS metaform.
+	 */
+	private array $metaConfig = [];
+
+	/**
+	 * Debug flag that mirrors `PLUGIN_FILESBROWSER_LOGLEVEL`.
+	 */
+	private bool $debug = false;
+
+	private Config $config;
+
+	private ?SsoBackend $sso = null;
+
+	/**
+	 * Backend name used in translations.
+	 */
+	private string $backendTransName = '';
+
+	/**
+	 * Seafile backend constructor
+	 */
+	public function __construct()
+	{
+		// initialization
+		$this->debug = PLUGIN_FILESBROWSER_LOGLEVEL === 'DEBUG';
+
+		$this->config = new Config();
+
+		$this->init_form();
+
+		// set backend description
+		$this->backendDescription = dgettext(self::GT_DOMAIN, "With this backend, you can connect to any Seafile server.");
+
+		// set backend display name
+		$this->backendDisplayName = "Seafile";
+
+		// set backend version
+		$this->backendVersion = "2.0.68";
+
+		// set backend name used in translations
+		$this->backendTransName = dgettext(self::GT_DOMAIN, 'Files ' . $this->backendDisplayName . ' Backend: ');
+	}
+
+	////////////////////////////////////////////////////////////////////////////
+	/// seafapi backend methods                                              ///
+	////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * Opens the connection to the Seafile server.
+	 *
+	 * @throws BackendException if connection is not successful
+	 * @return boolean true if action succeeded
+	 */
+	public function open()
+	{
+		$url = $this->config->getApiUrl();
+
+		try {
+			$this->sso->open();
+		} catch (Throwable $throwable) {
+			$this->backendException($throwable);
+		}
+
+		try {
+			$this->seafapi = new SeafileApi($url, $this->config->user, $this->config->pass);
+		} catch (Throwable $throwable) {
+			$this->backendException($throwable);
+		}
+
+		return true;
+	}
+
+	/**
+	 * This function will read a list of files and folders from the server.
+	 *
+	 * @param string $dir to get listing from
+	 * @param bool $hidefirst skip the first entry (we ignore this for the Seafile backend)
+	 * @throws BackendException
+	 *
+	 * @return array
+	 */
+	public function ls($dir, $hidefirst = true)
+	{
+		$timer = new Timer();
+		$this->log("[LS] '$dir'");
+
+		if ('' === trim($dir, '/')) {
+			try {
+				$listing = $this->seafapi->listLibraries();
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+			goto result;
+		}
+
+		$lsDir = $this->splitGrommunioPath($dir);
+		if (null === $lsDir->lib) {
+			// the library does not exist, the listing is short.
+			$listing = [];
+			goto result;
+		}
+
+		try {
+			$listing = $this->seafapi->listItemsInDirectory($lsDir->lib, $lsDir->path ?? '');
+		} catch (Throwable $throwable) {
+			$this->backendException($throwable);
+		}
+
+		result:
+
+		$result = [];
+		$baseDir = rtrim($dir, '/') . '/';
+		foreach ($listing as $node) {
+			if (!isset($this->seafapi::TYPES[$node->type])) {
+				$this->backendException(
+					new \UnexpectedValueException(sprintf('Unhandled Seafile node-type "%s" (for "%s")', $node->type, $node->name))
+				);
+			}
+			$isDir = isset($this->seafapi::TYPES_DIR_LIKE[$node->type]);
+			$name = rtrim($baseDir . $node->name, '/') . '/';
+			$isDir || $name = rtrim($name, '/');
+			$result[$name] = [
+				'resourcetype' => $isDir ? 'collection' : 'file',
+				'getcontentlength' => $isDir ? null : $node->size,
+				'getlastmodified' => date('r', $node->mtime),
+				'getcontenttype' => null,
+				'quota-used-bytes' => null,
+				'quota-available-bytes' => null,
+			];
+		}
+
+		$this->log("[LS] done in $timer seconds.");
+		return $result;
+	}
+
+	/**
+	 * Creates a new directory on the server.
+	 *
+	 * @param string $dir
+	 * @throws BackendException
+	 * @return bool
+	 */
+	public function mkcol($dir)
+	{
+		$timer = new Timer();
+		$this->log("[MKCOL] '$dir'");
+
+		if ($this->isLibrary($dir)) {
+			// create library
+			try {
+				$result = $this->seafapi->createLibrary($dir);
+				unset($result);
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+			$success = true;
+		} else {
+			// create directory within library
+			$lib = $this->seafapi->getLibraryFromPath($dir)->id;
+			[, $path] = explode('/', trim($dir, '/'), 2);
+			try {
+				$result = $this->seafapi->createNewDirectory($lib, $path);
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+			$success = 'success' === $result;
+		}
+
+		$this->log("[MKCOL] done in $timer seconds.");
+		return $success;
+	}
+
+	/**
+	 * Deletes a files or folder from the backend.
+	 *
+	 * @param string $path
+	 * @throws BackendException
+	 * @return bool
+	 */
+	public function delete($path)
+	{
+		$timer = new Timer();
+		$this->log("[DELETE] '$path'");
+
+		if ($this->isLibrary($path)) {
+			// delete library
+			try {
+				$this->seafapi->deleteLibraryByName($path);
+				$result = 'success';
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+		} else {
+			// delete file or directory within library
+			$deletePath = $this->splitGrommunioPath($path);
+			try {
+				$result = $this->seafapi->deleteFile($deletePath->lib, $deletePath->path);
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+		}
+
+		$this->log("[DELETE] done in $timer seconds.");
+		return 'success' === $result;
+	}
+
+	/**
+	 * Move a file or collection on the backend server (serverside).
+	 *
+	 * @param string $src_path Source path
+	 * @param string $dst_path Destination path
+	 * @param bool $overwrite Overwrite file if exists in $dest_path
+	 * @throws BackendException
+	 * @return bool
+	 */
+	public function move($src_path, $dst_path, $overwrite = false)
+	{
+		$timer = new Timer();
+		$this->log("[MOVE] '$src_path' -> '$dst_path'");
+
+		// check if the move operation would move src into itself - error condition
+		if (0 === strpos($dst_path, $src_path . '/')) {
+			$this->backendError(self::SFA_ERR_FORBIDDEN, 'Moving failed');
+		}
+
+		// move library/file/directory is one of in the following order:
+		// 1/5: rename library
+		// 2/5: noop - source and destination are the same
+		// 3/5: rename file/directory
+		// 4/5: move file/directory
+		// 5/5: every other operation (e.g. move library into another library) is not implemented
+
+		$src = $this->splitGrommunioPath($src_path);
+		$dst = $this->splitGrommunioPath($dst_path);
+
+		// 1/5: rename library
+		if ($src->path === null && $dst->path === null) {
+			if ($dst->lib !== null) {
+				// rename to an existing library name (not allowed as not supported)
+				$this->backendError(self::SFA_ERR_NOTALLOWED, 'Moving failed');
+			}
+			try {
+				$this->seafapi->renameLibrary($src->libName, $dst->libName);
+				$result = true;
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+			goto done;
+		}
+
+		$isIntraLibTransaction = $src->libName === $dst->libName;
+
+		// 2/5: noop - src and dst are the same
+		if ($isIntraLibTransaction && $src->path === $dst->path) {
+			// source and destination are the same path, nothing to do
+			$result = 'success';
+			goto done;
+		}
+
+		$dirNames = array_map('dirname', [$src->path, $dst->path]);
+		$pathsHaveSameDirNames = $dirNames[0] === $dirNames[1];
+
+		// 3/5: rename file/directory
+		if ($isIntraLibTransaction && $pathsHaveSameDirNames) {
+			try {
+				$result = $this->seafapi->renameFile($src->lib, $src->path, basename($dst->path));
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+			goto done;
+		}
+
+		// 4/5: move file/directory
+		if (isset($src->path, $dst->lib)) {
+			try {
+				$result = $this->seafapi->moveFile($src->lib, $src->path, $dst->lib, $dirNames[1]);
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+		}
+
+		done:
+
+		// 5/5: every other operation (move library into another library, not implemented)
+		if (!isset($result)) {
+			$this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented.');
+		}
+
+		$this->log("[MOVE] done in $timer seconds.");
+		return 'success' === $result;
+	}
+
+	/**
+	 * Download a remote file to a buffer variable.
+	 *
+	 * @param string $path The source path on the server
+	 * @param mixed $buffer Buffer for the received data
+	 *
+	 * @throws BackendException if request is not successful
+	 *
+	 * @return boolean true if action succeeded
+	 */
+	public function get($path, &$buffer)
+	{
+		$timer = new Timer();
+		$this->log("[GET] '$path'");
+
+		$src = $this->splitGrommunioPath($path);
+
+		try {
+			$result = $this->seafapi->downloadFileAsBuffer($src->lib, $src->path);
+		} catch (Throwable $throwable) {
+			$this->backendException($throwable);
+		}
+
+		$success = false !== $result;
+
+		if ($success) {
+			$buffer = $result;
+		}
+
+		$this->log("[GET] done in $timer seconds.");
+		return $success;
+	}
+
+	/**
+	 * Download a remote file to a local file.
+	 *
+	 * @param string $srcpath Source path on server
+	 * @param string $localpath Destination path on local filesystem
+	 *
+	 * @throws BackendException if request is not successful
+	 *
+	 * @return boolean true if action succeeded
+	 */
+	public function get_file($srcpath, $localpath)
+	{
+		$timer = new Timer();
+		$this->log("[GET_FILE] '$srcpath' -> '$localpath'");
+
+		$src = $this->splitGrommunioPath($srcpath);
+
+		try {
+			$result = $this->seafapi->downloadFileToFile($src->lib, $src->path, $localpath);
+		} catch (Throwable $throwable) {
+			$this->backendException($throwable);
+		}
+
+		$this->log("[GET_FILE] done in $timer seconds.");
+		return $result;
+	}
+
+	/**
+	 * Puts a file into a collection.
+	 *
+	 * @param string $path Destination path
+	 *
+	 * @string mixed $data Any kind of data
+	 * @throws BackendException if request is not successful
+	 *
+	 * @return boolean true if action succeeded
+	 */
+	public function put($path, $data)
+	{
+		$timer = new Timer();
+		$this->log(sprintf("[PUT] start: path: %s (%d)", $path, strlen($data)));
+
+		$target = $this->splitGrommunioPath($path);
+
+		try {
+			/** @noinspection PhpUnusedLocalVariableInspection */
+			$result = $this->seafapi->uploadBuffer($target->lib, $target->path, $data);
+		} catch (Throwable $throwable) {
+			$this->backendException($throwable);
+		}
+
+		$this->log("[PUT] done in $timer seconds.");
+		return true;
+	}
+
+	/**
+	 * Upload a local file
+	 *
+	 * @param string $path Destination path on the server
+	 * @param string $filename Local filename for the file that should be uploaded
+	 *
+	 * @throws BackendException if request is not successful
+	 *
+	 * @return boolean true if action succeeded
+	 */
+	public function put_file($path, $filename)
+	{
+		$timer = new Timer();
+		$this->log(sprintf("[PUT_FILE] %s -> %s", $filename, $path));
+
+		// filename can be null if an attachment of draft-email that has not been saved
+		if (empty($filename)) {
+			return false;
+		}
+
+		$target = $this->splitGrommunioPath($path);
+
+		// put file into users default library if no library given
+		if ($target->path === null && $target->libName !== null) {
+			try {
+				$defaultLibrary = $this->seafapi->getDefaultLibrary();
+			} catch (Throwable $throwable) {
+				$this->backendException($throwable);
+			}
+			if (isset($defaultLibrary->repo_id, $defaultLibrary->exists) && true === $defaultLibrary->exists) {
+				$target->path = $target->libName;
+				$target->libName = null;
+				$target->lib = $defaultLibrary->repo_id;
+			}
+		}
+
+		try {
+			/** @noinspection PhpUnusedLocalVariableInspection */
+			$result = $this->seafapi->uploadFile($target->lib, $target->path, $filename);
+		} catch (Throwable $throwable) {
+			$this->backendException($throwable);
+		}
+
+		$this->log("[PUT_FILE] done in $timer seconds.");
+		return true;
+	}
+
+	////////////////////////////////////////////////////////////////////////////
+	/// non-seafapi backend implementation                                   ///
+	////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * Initialize backend from $backend_config array
+	 *
+	 * @param $backend_config
+	 * @return void
+	 */
+	public function init_backend($backend_config)
+	{
+		$config = $backend_config;
+
+		if ($backend_config["use_zarafa_credentials"]) {
+			// For backward compatibility we will check if the Encryption store exists. If not,
+			// we will fall back to the old way of retrieving the password from the session.
+			if (class_exists('EncryptionStore')) {
+				// Get the username and password from the Encryption store
+				$encryptionStore = EncryptionStore::getInstance();
+				if ($encryptionStore instanceof EncryptionStore) {
+					$config['user'] = $encryptionStore->get('username');
+					$config['password'] = $encryptionStore->get('password');
+				}
+			} else {
+				$config['user'] = ConfigUtil::loadSmtpAddress();
+				$password = $_SESSION['password'];
+				if (function_exists('openssl_decrypt')) {
+					/** @noinspection PhpUndefinedConstantInspection */
+					$config['password'] = openssl_decrypt($password, "des-ede3-cbc", PASSWORD_KEY, 0, PASSWORD_IV);
+				}
+			}
+		}
+
+		$this->config->importConfigArray($config);
+
+		SsoBackend::bind($this->sso)->initBackend($this->config);
+
+		Logger::debug(self::LOG_CONTEXT, __FUNCTION__ . ' done.');
+	}
+
+	/**
+	 * @return false|string
+	 * @noinspection PhpMultipleClassDeclarationsInspection Grommunio has a \JsonException shim
+	 */
+	public function getFormConfig()
+	{
+		try {
+			$json = json_encode($this->metaConfig, JSON_THROW_ON_ERROR);
+		} catch (JsonException $e) {
+			$this->log(sprintf('[%s]: %s', get_class($e), $e->getMessage()));
+			$json = false;
+		}
+
+		return $json;
+	}
+
+	public function getFormConfigWithData()
+	{
+		return $this->getFormConfig();
+	}
+
+	/**
+	 * set debug on (1) or off (0).
+	 * produces a lot of debug messages in webservers error log if set to on (1).
+	 *
+	 * @param boolean $debug enable or disable debugging
+	 *
+	 * @return void
+	 */
+	public function set_debug($debug)
+	{
+		$this->debug = (bool)$debug;
+	}
+
+	////////////////////////////////////////////////////////////////////////////
+	/// not_used_implemented()                                               ///
+	////////////////////////////////////////////////////////////////////////////
+
+	/**
+	 * Duplicates a folder on the backend server.
+	 *
+	 * @param string $src_path
+	 * @param string $dst_path
+	 * @param bool $overwrite
+	 * @throws BackendException
+	 * @return bool
+	 * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
+	 */
+	public function copy_coll($src_path, $dst_path, $overwrite = false)
+	{
+		$this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
+	}
+
+	/**
+	 * Duplicates a file on the backend server.
+	 *
+	 * @param string $src_path
+	 * @param string $dst_path
+	 * @param bool $overwrite
+	 * @throws BackendException
+	 * @return bool
+	 * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
+	 */
+	public function copy_file($src_path, $dst_path, $overwrite = false)
+	{
+		$this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
+	}
+
+	/**
+	 * Checks if the given $path exists on the remote server.
+	 *
+	 * @param string $path
+	 * @throws BackendException
+	 * @return bool
+	 * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
+	 */
+	public function exists($path)
+	{
+		$this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
+	}
+
+	/**
+	 * Gets path information from Seafile server.
+	 *
+	 * @param string $path
+	 * @throws BackendException if request is not successful
+	 * @return array directory info
+	 */
+	public function gpi($path)
+	{
+		$this->log("[GPI] '$path'");
+		$list = $this->ls(dirname($path), false); // get contents of the parent dir
+
+		if (isset($list[$path])) {
+			return $list[$path];
+		}
+
+		$this->log('[GPI] wrong response from ls');
+		$this->backendError(self::SFA_ERR_FAILED_DEPENDENCY, 'Connection failed');
+	}
+
+	/**
+	 * Checks if the given $path is a folder.
+	 *
+	 * @param string $path
+	 * @throws BackendException
+	 * @return bool
+	 * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
+	 */
+	public function is_dir($path)
+	{
+		$this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
+	}
+
+	/**
+	 * Checks if the given $path is a file.
+	 *
+	 * @param string $path
+	 * @throws BackendException
+	 * @return bool
+	 * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
+	 */
+	public function is_file($path)
+	{
+		$this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
+	}
+
+	/////////////////////////////////////////////////////////////
+	// @see iFeatureVersionInfo implementation                 //
+	/////////////////////////////////////////////////////////////
+
+	/**
+	 * Return the version string of the server backend.
+	 *
+	 * @throws BackendException
+	 * @return String
+	 */
+	public function getServerVersion()
+	{
+		try {
+			return $this->seafapi->getServerVersion();
+		} catch (Throwable $throwable) {
+			$this->backendException($throwable);
+		}
+	}
+
+	/////////////////////////////////////////////////////////////
+	// @see iFeatureQuota implementation                       //
+	/////////////////////////////////////////////////////////////
+
+	/**
+	 * @param string $dir
+	 * @return float
+	 * @noinspection PhpMissingParamTypeInspection
+	 * @noinspection PhpUnusedParameterInspection
+	 */
+	public function getQuotaBytesUsed($dir)
+	{
+		$return = $this->seafapi->checkAccountInfo();
+
+		return ($return->usage ?? 0) * self::QUOTA_MULTIPLIER_SEAFILE_TO_GROMMUNIO;
+	}
+
+	/**
+	 * @param string $dir
+	 * @return float|int
+	 * @noinspection PhpUnusedParameterInspection
+	 * @noinspection PhpMissingParamTypeInspection
+	 */
+	public function getQuotaBytesAvailable($dir)
+	{
+		$return = $this->seafapi->checkAccountInfo();
+		$avail = $return->total - $return->usage;
+		if (-2 === (int)$return->total) {
+			return -1;
+		}
+
+		return $avail * self::QUOTA_MULTIPLIER_SEAFILE_TO_GROMMUNIO;
+	}
+
+	/////////////////////////////////////////////////////////////
+	// @internal private helper methods                        //
+	/////////////////////////////////////////////////////////////
+
+	/**
+	 * Initialise form fields
+	 */
+	private function init_form()
+	{
+		$this->metaConfig = [
+			"success" => true,
+			"metaData" => [
+				"fields" => [
+					[
+						"name" => "server_address",
+						"fieldLabel" => dgettext(self::GT_DOMAIN, 'Server address'),
+						"editor" => [
+							"allowBlank" => false,
+						],
+					],
+					[
+						"name" => "server_port",
+						"fieldLabel" => dgettext(self::GT_DOMAIN, 'Server port'),
+						"editor" => [
+							"ref" => "../../portField",
+							"allowBlank" => false,
+						],
+					],
+					[
+						"name" => "server_ssl",
+						"fieldLabel" => dgettext(self::GT_DOMAIN, 'Use SSL'),
+						"editor" => [
+							"xtype" => "checkbox",
+							"listeners" => [
+								"check" => "Zarafa.plugins.files.data.Actions.onCheckSSL" // this javascript function will be called!
+							],
+						],
+					],
+					[
+						"name" => "user",
+						"fieldLabel" => dgettext(self::GT_DOMAIN, 'Username'),
+						"editor" => [
+							"ref" => "../../usernameField",
+						],
+					],
+					[
+						"name" => "password",
+						"fieldLabel" => dgettext(self::GT_DOMAIN, 'Password'),
+						"editor" => [
+							"ref" => "../../passwordField",
+							"inputType" => "password",
+						],
+					],
+					[
+						"name" => "use_zarafa_credentials",
+						"fieldLabel" => dgettext(self::GT_DOMAIN, 'Use grommunio credentials'),
+						"editor" => [
+							"xtype" => "checkbox",
+							"listeners" => [
+								"check" => "Zarafa.plugins.files.data.Actions.onCheckCredentials" // this javascript function will be called!
+							],
+						],
+					],
+				],
+				"formConfig" => [
+					"labelAlign" => "left",
+					"columnCount" => 1,
+					"labelWidth" => 80,
+					"defaults" => [
+						"width" => 292,
+					],
+				],
+			],
+
+			// here we can specify the default values.
+			"data" => [
+				"server_address" => "seafile.example.com",
+				"server_port" => "443",
+				"server_ssl" => "1",
+				"server_path" => "",
+				"use_zarafa_credentials" => "0",
+				"user" => "",
+				"password" => "",
+			],
+		];
+	}
+
+	/**
+	 * split grommunio path into library and library path
+	 *
+	 * obtains the seafile library ID (if available, otherwise NULL)
+	 *
+	 * return protocol: object{
+	 *   lib: ?string     # library ID e.g. "ccc60923-8cdf-4cc8-8f71-df86aba3a085"
+	 *   path: ?string    # path inside library, always prefixed with "/" if set
+	 *   libName: ?string # name of the library
+	 * }
+	 *
+	 * @param string $grommunioPath
+	 * @throws Exception
+	 * @return object
+	 */
+	private function splitGrommunioPath(string $grommunioPath): object
+	{
+		static $libraries;
+		$libraries = $libraries ?? array_column($this->seafapi->listLibraries(), null, 'name');
+
+		[, $libName, $path] = explode('/', $grommunioPath, 3) + [null, null, null];
+		if (null !== $path) {
+			$path = "/$path";
+		}
+		$lib = $libraries[$libName]->id ?? null;
+		return (object)['lib' => $lib, 'path' => $path, 'libName' => $libName];
+	}
+
+	/**
+	 * test if a grommunio path is a library only
+	 *
+	 * @param string $grommunioPath
+	 * @return bool
+	 */
+	private function isLibrary(string $grommunioPath): bool
+	{
+		return 0 === substr_count(trim($grommunioPath, '/'), '/');
+	}
+
+	/**
+	 * Turn a Backend error code into a Backend exception
+	 *
+	 * @param int $errorCode one of the Backend::SFA_ERR_* codes, e.g. {@see Backend::SFA_ERR_INTERNAL}
+	 * @param ?string $title msg-id from the plugin_files domain, e.g. 'PHP-CURL not installed'
+	 * @throws BackendException
+	 * @return no-return
+	 */
+	private function backendError(int $errorCode, string $title = null)
+	{
+		$message = $this->parseErrorCodeToMessage($errorCode);
+		$title = $this->backendTransName;
+		$this->backendErrorThrow($title, $message, $errorCode);
+	}
+
+	/**
+	 * Throw a BackendException w/ title, message and code
+	 *
+	 * @param string $title
+	 * @param string $message
+	 * @param int $code
+	 * @throws BackendException
+	 * @return no-return
+	 */
+	private function backendErrorThrow(string $title, string $message, int $code = 0)
+	{
+		/** {@see \Files\Backend\Exception} */
+		$exception = new BackendException($message, $code);
+		$exception->setTitle($title);
+		throw $exception;
+	}
+
+	/**
+	 * Turn a throwable/exception with the Seafile API into a Backend exception
+	 *
+	 * @param Throwable $t
+	 * @throws BackendException
+	 * @return no-return
+	 */
+	private function backendException(Throwable $t)
+	{
+		// if it is already a backend exception, throw it.
+		if ($t instanceof BackendException) {
+			throw $t;
+		}
+
+		[$callSite, $inFunc] = debug_backtrace();
+		$logLabel = "$inFunc[function]:$callSite[line]";
+
+		$class = get_class($t);
+		$message = $t->getMessage();
+		$this->log(sprintf('%s: [%s] #%s: %s', $logLabel, $class, $t->getCode(), $message));
+
+		// All SeafileApi exceptions are handled by this
+		if ($t instanceof Exception) {
+			$this->backendExceptionSeafapi($t);
+		}
+
+		$this->backendErrorThrow('Error', "[SEAFILE $logLabel] $class: $message", 500);
+	}
+
+	/**
+	 * Turn an Exception into a BackendException
+	 *
+	 * Enriches message information for grommunio with API error messages
+	 * if a Seafile ConnectionException.
+	 *
+	 * helper for {@see Backend::backendException()}
+	 *
+	 * @param Exception $exception
+	 * @throws BackendException
+	 * @return void
+	 */
+	private function backendExceptionSeafapi(Exception $exception)
+	{
+		$code = $exception->getCode();
+		$message = $exception->getMessage();
+
+		$apiErrorMessagesHtml = null;
+		if ($exception instanceof Exception\ConnectionException) {
+			$messages = $exception->tryApiErrorMessages();
+			null === $messages || $apiErrorMessagesHtml = implode(
+					"<br/>\n",
+					array_map(static function (string $subject) {
+						return htmlspecialchars($subject, ENT_QUOTES | ENT_HTML5);
+					}, $messages)
+				) . "<br/>\n";
+		}
+
+		if (null !== $apiErrorMessagesHtml) {
+			$message .= " - $apiErrorMessagesHtml";
+		}
+
+		$this->backendErrorThrow($this->backendDisplayName . ' Error', $message, $code);
+	}
+
+	/**
+	 * a simple php error_log wrapper.
+	 *
+	 * @param string $err_string error message
+	 *
+	 * @return void
+	 */
+	private function log(string $err_string)
+	{
+		if ($this->debug) {
+			Logger::debug(self::LOG_CONTEXT, $err_string);
+			$this->debugLog($err_string, 2);
+		}
+	}
+
+	/**
+	 * This function will return a user-friendly error string.
+	 *
+	 * Error codes were migrated from WebDav backend.
+	 *
+	 * @param int $error_code An error code
+	 *
+	 * @return string user friendly error message
+	 */
+	private function parseErrorCodeToMessage(int $error_code)
+	{
+		$error = $error_code;
+
+		switch ($error) {
+			case CURLE_BAD_PASSWORD_ENTERED:
+			case self::SFA_ERR_UNAUTHORIZED:
+				$msg = dgettext(self::GT_DOMAIN, 'Unauthorized. Wrong username or password.');
+				break;
+			case CURLE_SSL_CONNECT_ERROR:
+			case CURLE_COULDNT_RESOLVE_HOST:
+			case CURLE_COULDNT_CONNECT:
+			case CURLE_OPERATION_TIMEOUTED:
+			case self::SFA_ERR_UNREACHABLE:
+				$msg = dgettext(self::GT_DOMAIN, 'Seafile is not reachable. Correct backend address entered?');
+				break;
+			case self::SFA_ERR_FORBIDDEN:
+				$msg = dgettext(self::GT_DOMAIN, 'You don\'t have enough permissions for this operation.');
+				break;
+			case self::SFA_ERR_NOTFOUND:
+				$msg = dgettext(self::GT_DOMAIN, 'File is not available any more.');
+				break;
+			case self::SFA_ERR_TIMEOUT:
+				$msg = dgettext(self::GT_DOMAIN, 'Connection to server timed out. Retry later.');
+				break;
+			case self::SFA_ERR_LOCKED:
+				$msg = dgettext(self::GT_DOMAIN, 'This file is locked by another user.');
+				break;
+			case self::SFA_ERR_FAILED_DEPENDENCY:
+				$msg = dgettext(self::GT_DOMAIN, 'The request failed due to failure of a previous request.');
+				break;
+			case self::SFA_ERR_INTERNAL:
+				$msg = dgettext(self::GT_DOMAIN, 'Seafile-server encountered a problem.');
+				break;
+			case self::SFA_ERR_TMP:
+				$msg = dgettext(self::GT_DOMAIN, 'Could not write to temporary directory. Contact the server administrator.');
+				break;
+			case self::SFA_ERR_FEATURES:
+				$msg = dgettext(self::GT_DOMAIN, 'Could not retrieve list of server features. Contact the server administrator.');
+				break;
+			case self::SFA_ERR_NO_CURL:
+				$msg = dgettext(self::GT_DOMAIN, 'PHP-Curl is not available. Contact your system administrator.');
+				break;
+			case self::SFA_ERR_UNIMPLEMENTED:
+				$msg = dgettext(self::GT_DOMAIN, 'This function is not yet implemented.');
+				break;
+			default:
+				$msg = dgettext(self::GT_DOMAIN, 'Unknown error');
+		}
+
+		return $msg;
+	}
+
+	/////////////////////////////////////////////////////////////
+	// @debug development helper method                        //
+	/////////////////////////////////////////////////////////////
+
+	/**
+	 * Log debug message while developing the plugin in dedicated DEBUG.log file
+	 *
+	 * TODO(tk): remove debugLog, we shall not use it in production.
+	 *
+	 * @param mixed $message
+	 * @param int $backSteps [optional] offset of call point in stacktrace
+	 * @return void
+	 * @see \Files\Backend\Seafile\Backend::log()
+	 */
+	public function debugLog($message, int $backSteps = 0): void
+	{
+		$baseDir = dirname(__DIR__);
+		$debugLogFile = $baseDir . '/DEBUG.log';
+		$backtrace = debug_backtrace();
+		$callPoint = $backtrace[$backSteps];
+		$path = $callPoint['file'];
+		$shortPath = $path;
+		if (0 === strpos($path, $baseDir)) {
+			$shortPath = substr($path, strlen($baseDir));
+		}
+		// TODO(tk): track if the parent function is log() or not, not only the number of back-steps (or check all call points)
+		$callInfoExtra = '';
+		if (1 !== $backSteps) { // this is not a log() call with debug switched on
+			$callInfoExtra = " ($backSteps) " . $backtrace[$backSteps + 1]['type'] . $backtrace[$backSteps + 1]['function'] . '()';
+		}
+		$callInfo = sprintf(' [ %s:%s ]%s', $shortPath, $callPoint['line'], $callInfoExtra);
+
+		if (!is_string($message)) {
+			/** @noinspection JsonEncodingApiUsageInspection */
+			$type = gettype($message);
+			if ('object' === $type && is_callable([$message, '__debugInfo'])) {
+				$message = $message->__debugInfo();
+			}
+			$message = $type . ': ' . json_encode($message, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+		}
+
+		$message = substr(sprintf('%.3f', $_SERVER['REQUEST_TIME_FLOAT']), -7) . " $message";
+
+		error_log(str_pad($message, 48) . $callInfo . "\n", 3, $debugLogFile);
+	}
 }

Braces +72 added lines, -81 removed lines

@@ -100,8 +100,7 @@ 
     /**
      * Seafile backend constructor
      */
-    public function __construct()
-    {
+    public function __construct() {
         // initialization
         $this->debug = PLUGIN_FILESBROWSER_LOGLEVEL === 'DEBUG';
 
@@ -132,19 +131,20 @@ 
      * @throws BackendException if connection is not successful
      * @return boolean true if action succeeded
      */
-    public function open()
-    {
+    public function open() {
         $url = $this->config->getApiUrl();
 
         try {
             $this->sso->open();
-        } catch (Throwable $throwable) {
+        }
+        catch (Throwable $throwable) {
             $this->backendException($throwable);
         }
 
         try {
             $this->seafapi = new SeafileApi($url, $this->config->user, $this->config->pass);
-        } catch (Throwable $throwable) {
+        }
+        catch (Throwable $throwable) {
             $this->backendException($throwable);
         }
 
@@ -160,15 +160,15 @@ 
      *
      * @return array
      */
-    public function ls($dir, $hidefirst = true)
-    {
+    public function ls($dir, $hidefirst = true) {
         $timer = new Timer();
         $this->log("[LS] '$dir'");
 
         if ('' === trim($dir, '/')) {
             try {
                 $listing = $this->seafapi->listLibraries();
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
             goto result;
@@ -183,7 +183,8 @@ 
 
         try {
             $listing = $this->seafapi->listItemsInDirectory($lsDir->lib, $lsDir->path ?? '');
-        } catch (Throwable $throwable) {
+        }
+        catch (Throwable $throwable) {
             $this->backendException($throwable);
         }
 
@@ -221,8 +222,7 @@ 
      * @throws BackendException
      * @return bool
      */
-    public function mkcol($dir)
-    {
+    public function mkcol($dir) {
         $timer = new Timer();
         $this->log("[MKCOL] '$dir'");
 
@@ -231,17 +231,20 @@ 
             try {
                 $result = $this->seafapi->createLibrary($dir);
                 unset($result);
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
             $success = true;
-        } else {
+        }
+        else {
             // create directory within library
             $lib = $this->seafapi->getLibraryFromPath($dir)->id;
             [, $path] = explode('/', trim($dir, '/'), 2);
             try {
                 $result = $this->seafapi->createNewDirectory($lib, $path);
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
             $success = 'success' === $result;
@@ -258,8 +261,7 @@ 
      * @throws BackendException
      * @return bool
      */
-    public function delete($path)
-    {
+    public function delete($path) {
         $timer = new Timer();
         $this->log("[DELETE] '$path'");
 
@@ -268,15 +270,18 @@ 
             try {
                 $this->seafapi->deleteLibraryByName($path);
                 $result = 'success';
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
-        } else {
+        }
+        else {
             // delete file or directory within library
             $deletePath = $this->splitGrommunioPath($path);
             try {
                 $result = $this->seafapi->deleteFile($deletePath->lib, $deletePath->path);
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
         }
@@ -294,8 +299,7 @@ 
      * @throws BackendException
      * @return bool
      */
-    public function move($src_path, $dst_path, $overwrite = false)
-    {
+    public function move($src_path, $dst_path, $overwrite = false) {
         $timer = new Timer();
         $this->log("[MOVE] '$src_path' -> '$dst_path'");
 
@@ -323,7 +327,8 @@ 
             try {
                 $this->seafapi->renameLibrary($src->libName, $dst->libName);
                 $result = true;
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
             goto done;
@@ -345,7 +350,8 @@ 
         if ($isIntraLibTransaction && $pathsHaveSameDirNames) {
             try {
                 $result = $this->seafapi->renameFile($src->lib, $src->path, basename($dst->path));
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
             goto done;
@@ -355,7 +361,8 @@ 
         if (isset($src->path, $dst->lib)) {
             try {
                 $result = $this->seafapi->moveFile($src->lib, $src->path, $dst->lib, $dirNames[1]);
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
         }
@@ -381,8 +388,7 @@ 
      *
      * @return boolean true if action succeeded
      */
-    public function get($path, &$buffer)
-    {
+    public function get($path, &$buffer) {
         $timer = new Timer();
         $this->log("[GET] '$path'");
 
@@ -390,7 +396,8 @@ 
 
         try {
             $result = $this->seafapi->downloadFileAsBuffer($src->lib, $src->path);
-        } catch (Throwable $throwable) {
+        }
+        catch (Throwable $throwable) {
             $this->backendException($throwable);
         }
 
@@ -414,8 +421,7 @@ 
      *
      * @return boolean true if action succeeded
      */
-    public function get_file($srcpath, $localpath)
-    {
+    public function get_file($srcpath, $localpath) {
         $timer = new Timer();
         $this->log("[GET_FILE] '$srcpath' -> '$localpath'");
 
@@ -423,7 +429,8 @@ 
 
         try {
             $result = $this->seafapi->downloadFileToFile($src->lib, $src->path, $localpath);
-        } catch (Throwable $throwable) {
+        }
+        catch (Throwable $throwable) {
             $this->backendException($throwable);
         }
 
@@ -441,8 +448,7 @@ 
      *
      * @return boolean true if action succeeded
      */
-    public function put($path, $data)
-    {
+    public function put($path, $data) {
         $timer = new Timer();
         $this->log(sprintf("[PUT] start: path: %s (%d)", $path, strlen($data)));
 
@@ -451,7 +457,8 @@ 
         try {
             /** @noinspection PhpUnusedLocalVariableInspection */
             $result = $this->seafapi->uploadBuffer($target->lib, $target->path, $data);
-        } catch (Throwable $throwable) {
+        }
+        catch (Throwable $throwable) {
             $this->backendException($throwable);
         }
 
@@ -469,8 +476,7 @@ 
      *
      * @return boolean true if action succeeded
      */
-    public function put_file($path, $filename)
-    {
+    public function put_file($path, $filename) {
         $timer = new Timer();
         $this->log(sprintf("[PUT_FILE] %s -> %s", $filename, $path));
 
@@ -485,7 +491,8 @@ 
         if ($target->path === null && $target->libName !== null) {
             try {
                 $defaultLibrary = $this->seafapi->getDefaultLibrary();
-            } catch (Throwable $throwable) {
+            }
+            catch (Throwable $throwable) {
                 $this->backendException($throwable);
             }
             if (isset($defaultLibrary->repo_id, $defaultLibrary->exists) && true === $defaultLibrary->exists) {
@@ -498,7 +505,8 @@ 
         try {
             /** @noinspection PhpUnusedLocalVariableInspection */
             $result = $this->seafapi->uploadFile($target->lib, $target->path, $filename);
-        } catch (Throwable $throwable) {
+        }
+        catch (Throwable $throwable) {
             $this->backendException($throwable);
         }
 
@@ -516,8 +524,7 @@ 
      * @param $backend_config
      * @return void
      */
-    public function init_backend($backend_config)
-    {
+    public function init_backend($backend_config) {
         $config = $backend_config;
 
         if ($backend_config["use_zarafa_credentials"]) {
@@ -530,7 +537,8 @@ 
                     $config['user'] = $encryptionStore->get('username');
                     $config['password'] = $encryptionStore->get('password');
                 }
-            } else {
+            }
+            else {
                 $config['user'] = ConfigUtil::loadSmtpAddress();
                 $password = $_SESSION['password'];
                 if (function_exists('openssl_decrypt')) {
@@ -551,11 +559,11 @@ 
      * @return false|string
      * @noinspection PhpMultipleClassDeclarationsInspection Grommunio has a \JsonException shim
      */
-    public function getFormConfig()
-    {
+    public function getFormConfig() {
         try {
             $json = json_encode($this->metaConfig, JSON_THROW_ON_ERROR);
-        } catch (JsonException $e) {
+        }
+        catch (JsonException $e) {
             $this->log(sprintf('[%s]: %s', get_class($e), $e->getMessage()));
             $json = false;
         }
@@ -563,8 +571,7 @@ 
         return $json;
     }
 
-    public function getFormConfigWithData()
-    {
+    public function getFormConfigWithData() {
         return $this->getFormConfig();
     }
 
@@ -576,8 +583,7 @@ 
      *
      * @return void
      */
-    public function set_debug($debug)
-    {
+    public function set_debug($debug) {
         $this->debug = (bool)$debug;
     }
 
@@ -595,8 +601,7 @@ 
      * @return bool
      * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
      */
-    public function copy_coll($src_path, $dst_path, $overwrite = false)
-    {
+    public function copy_coll($src_path, $dst_path, $overwrite = false) {
         $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
     }
 
@@ -610,8 +615,7 @@ 
      * @return bool
      * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
      */
-    public function copy_file($src_path, $dst_path, $overwrite = false)
-    {
+    public function copy_file($src_path, $dst_path, $overwrite = false) {
         $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
     }
 
@@ -623,8 +627,7 @@ 
      * @return bool
      * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
      */
-    public function exists($path)
-    {
+    public function exists($path) {
         $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
     }
 
@@ -635,8 +638,7 @@ 
      * @throws BackendException if request is not successful
      * @return array directory info
      */
-    public function gpi($path)
-    {
+    public function gpi($path) {
         $this->log("[GPI] '$path'");
         $list = $this->ls(dirname($path), false); // get contents of the parent dir
 
@@ -656,8 +658,7 @@ 
      * @return bool
      * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
      */
-    public function is_dir($path)
-    {
+    public function is_dir($path) {
         $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
     }
 
@@ -669,8 +670,7 @@ 
      * @return bool
      * @noinspection PhpReturnDocTypeMismatchInspection Upstream Interface Issue
      */
-    public function is_file($path)
-    {
+    public function is_file($path) {
         $this->backendError(self::SFA_ERR_UNIMPLEMENTED, 'Not implemented');
     }
 
@@ -684,11 +684,11 @@ 
      * @throws BackendException
      * @return String
      */
-    public function getServerVersion()
-    {
+    public function getServerVersion() {
         try {
             return $this->seafapi->getServerVersion();
-        } catch (Throwable $throwable) {
+        }
+        catch (Throwable $throwable) {
             $this->backendException($throwable);
         }
     }
@@ -703,8 +703,7 @@ 
      * @noinspection PhpMissingParamTypeInspection
      * @noinspection PhpUnusedParameterInspection
      */
-    public function getQuotaBytesUsed($dir)
-    {
+    public function getQuotaBytesUsed($dir) {
         $return = $this->seafapi->checkAccountInfo();
 
         return ($return->usage ?? 0) * self::QUOTA_MULTIPLIER_SEAFILE_TO_GROMMUNIO;
@@ -716,8 +715,7 @@ 
      * @noinspection PhpUnusedParameterInspection
      * @noinspection PhpMissingParamTypeInspection
      */
-    public function getQuotaBytesAvailable($dir)
-    {
+    public function getQuotaBytesAvailable($dir) {
         $return = $this->seafapi->checkAccountInfo();
         $avail = $return->total - $return->usage;
         if (-2 === (int)$return->total) {
@@ -734,8 +732,7 @@ 
     /**
      * Initialise form fields
      */
-    private function init_form()
-    {
+    private function init_form() {
         $this->metaConfig = [
             "success" => true,
             "metaData" => [
@@ -861,8 +858,7 @@ 
      * @throws BackendException
      * @return no-return
      */
-    private function backendError(int $errorCode, string $title = null)
-    {
+    private function backendError(int $errorCode, string $title = null) {
         $message = $this->parseErrorCodeToMessage($errorCode);
         $title = $this->backendTransName;
         $this->backendErrorThrow($title, $message, $errorCode);
@@ -877,8 +873,7 @@ 
      * @throws BackendException
      * @return no-return
      */
-    private function backendErrorThrow(string $title, string $message, int $code = 0)
-    {
+    private function backendErrorThrow(string $title, string $message, int $code = 0) {
         /** {@see \Files\Backend\Exception} */
         $exception = new BackendException($message, $code);
         $exception->setTitle($title);
@@ -892,8 +887,7 @@ 
      * @throws BackendException
      * @return no-return
      */
-    private function backendException(Throwable $t)
-    {
+    private function backendException(Throwable $t) {
         // if it is already a backend exception, throw it.
         if ($t instanceof BackendException) {
             throw $t;
@@ -926,8 +920,7 @@ 
      * @throws BackendException
      * @return void
      */
-    private function backendExceptionSeafapi(Exception $exception)
-    {
+    private function backendExceptionSeafapi(Exception $exception) {
         $code = $exception->getCode();
         $message = $exception->getMessage();
 
@@ -956,8 +949,7 @@ 
      *
      * @return void
      */
-    private function log(string $err_string)
-    {
+    private function log(string $err_string) {
         if ($this->debug) {
             Logger::debug(self::LOG_CONTEXT, $err_string);
             $this->debugLog($err_string, 2);
@@ -973,8 +965,7 @@ 
      *
      * @return string user friendly error message
      */
-    private function parseErrorCodeToMessage(int $error_code)
-    {
+    private function parseErrorCodeToMessage(int $error_code) {
         $error = $error_code;
 
         switch ($error) {

plugins/filesbackendSeafile/php/Model/Config.php

Indentation +154 added lines, -154 removed lines

@@ -19,158 +19,158 @@
  */
 class Config implements ArrayAccess
 {
-    private const DEF = [
-        'server' => 'server_address',
-        'port' => 'server_port',
-        'ssl' => 'server_ssl',
-        'path' => 'server_path',
-        'user' => 'user',
-        'pass' => 'password',
-        'sso_auth_user_token' => 'sso_auth_user_token',
-    ];
-
-    private const SCHEMA = [
-        self::DEF['server'] => [
-            'filter' => FILTER_VALIDATE_DOMAIN,
-            'flags' => FILTER_FLAG_HOSTNAME,
-            'options' => ['default' => 'seafile.example.com'],
-        ],
-        self::DEF['port'] => [
-            'filter' => FILTER_VALIDATE_INT,
-            'options' => ['min_range' => 0, 'max_range' => 65535, 'default' => 443],
-        ],
-        self::DEF['ssl'] => [
-            'filter' => FILTER_VALIDATE_BOOLEAN,
-            'options' => ['default' => true],
-        ],
-        self::DEF['path'] => [
-            'filter' => FILTER_UNSAFE_RAW,
-            'flags' => FILTER_FLAG_STRIP_LOW | FILTER_FLAG_STRIP_HIGH,
-            'options' => ['default' => ''],
-        ],
-        self::DEF['user'] => [
-            'filter' => FILTER_UNSAFE_RAW,
-            'flags' => FILTER_FLAG_STRIP_LOW,
-            'options' => ['default' => ''],
-        ],
-        self::DEF['pass'] => [
-            'filter' => FILTER_DEFAULT,
-            'options' => ['default' => ''],
-        ],
-        self::DEF['sso_auth_user_token'] => [
-            'filter' => FILTER_DEFAULT,
-            'flags' => FILTER_FLAG_EMPTY_STRING_NULL,
-            'options' => ['default' => null],
-        ],
-    ];
-
-    private array $config = [];
-
-    public function __construct(array $config = [])
-    {
-        $this->importConfigArray($config);
-    }
-
-    /**
-     * Get the URL of the Seafile servers REST API
-     *
-     * @return string
-     */
-    public function getApiUrl(): string
-    {
-        $config = $this;
-
-        $ssl = (bool)$config->ssl;
-        $defaultPort = $ssl ? 443 : 80;
-        $port = max(0, min(65535, (int)$config->port)) ?: $defaultPort;
-        $host = rtrim($config->server, '/');
-        $path = ltrim($config->path, '/');
-
-        $url = sprintf('http%s://%s:%d/%s', $ssl ? 's' : '', $host, $port, $path);
-
-        return rtrim($url, '/');
-    }
-
-    /**
-     * read-only properties
-     *
-     * @param string $name
-     * @return mixed
-     *
-     * @noinspection MagicMethodsValidityInspection
-     * @noinspection RedundantSuppression
-     */
-    public function __get(string $name): mixed
-    {
-        if (!isset(self::DEF[$name])) {
-            throw new OutOfBoundsException("Not a property: \"$name\"");
-        }
-        return $this->config[self::DEF[$name]];
-    }
-
-    /**
-     * init configuration data
-     *
-     * set all named properties from associative array, overwriting self with defaults
-     * from the schema.
-     *
-     * @param array $config
-     * @return void
-     */
-    public function importConfigArray(array $config): void
-    {
-        $result = [];
-        foreach (self::SCHEMA as $name => $definition) {
-            $result[$name] =
-                array_key_exists($name, $config)
-                    ? $config[$name]
-                    : $this->config[$name] ?? $definition['options']['default'] ?? null;
-        }
-        $filtered = filter_var_array($result, self::SCHEMA);
-
-        if (!is_array($filtered)) {
-            throw new UnexpectedValueException('Failed to filter Seafile configuration values.');
-        }
-
-        $this->config = $filtered;
-    }
-
-    /**
-     * Hide its internal state from var_dump()
-     *
-     * Note: The xdebug extension may break this behavior.
-     * You should not rely on it if you have debugging extensions installed.
-     *
-     * @return array
-     */
-    public function __debugInfo(): array
-    {
-        $info = $this->config;
-        $info['password'] = is_string($info['password']) ? '*' : null;
-        $info['sso_auth_user_token'] = is_string($info['sso_auth_user_token']) ? '*' : null;
-
-        return $info;
-    }
-
-    /* ArrayAccess implementation */
-
-    public function offsetExists(mixed $offset): bool
-    {
-        return isset($this->config[$offset]);
-    }
-
-    public function offsetGet(mixed $offset): mixed
-    {
-        return $this->config[$offset];
-    }
-
-    public function offsetSet(mixed $offset, mixed $value): void
-    {
-        trigger_error('modification by write is undefined behaviour', E_USER_WARNING);
-    }
-
-    public function offsetUnset(mixed $offset): void
-    {
-        trigger_error('modification by delete is undefined behaviour', E_USER_WARNING);
-    }
+	private const DEF = [
+		'server' => 'server_address',
+		'port' => 'server_port',
+		'ssl' => 'server_ssl',
+		'path' => 'server_path',
+		'user' => 'user',
+		'pass' => 'password',
+		'sso_auth_user_token' => 'sso_auth_user_token',
+	];
+
+	private const SCHEMA = [
+		self::DEF['server'] => [
+			'filter' => FILTER_VALIDATE_DOMAIN,
+			'flags' => FILTER_FLAG_HOSTNAME,
+			'options' => ['default' => 'seafile.example.com'],
+		],
+		self::DEF['port'] => [
+			'filter' => FILTER_VALIDATE_INT,
+			'options' => ['min_range' => 0, 'max_range' => 65535, 'default' => 443],
+		],
+		self::DEF['ssl'] => [
+			'filter' => FILTER_VALIDATE_BOOLEAN,
+			'options' => ['default' => true],
+		],
+		self::DEF['path'] => [
+			'filter' => FILTER_UNSAFE_RAW,
+			'flags' => FILTER_FLAG_STRIP_LOW | FILTER_FLAG_STRIP_HIGH,
+			'options' => ['default' => ''],
+		],
+		self::DEF['user'] => [
+			'filter' => FILTER_UNSAFE_RAW,
+			'flags' => FILTER_FLAG_STRIP_LOW,
+			'options' => ['default' => ''],
+		],
+		self::DEF['pass'] => [
+			'filter' => FILTER_DEFAULT,
+			'options' => ['default' => ''],
+		],
+		self::DEF['sso_auth_user_token'] => [
+			'filter' => FILTER_DEFAULT,
+			'flags' => FILTER_FLAG_EMPTY_STRING_NULL,
+			'options' => ['default' => null],
+		],
+	];
+
+	private array $config = [];
+
+	public function __construct(array $config = [])
+	{
+		$this->importConfigArray($config);
+	}
+
+	/**
+	 * Get the URL of the Seafile servers REST API
+	 *
+	 * @return string
+	 */
+	public function getApiUrl(): string
+	{
+		$config = $this;
+
+		$ssl = (bool)$config->ssl;
+		$defaultPort = $ssl ? 443 : 80;
+		$port = max(0, min(65535, (int)$config->port)) ?: $defaultPort;
+		$host = rtrim($config->server, '/');
+		$path = ltrim($config->path, '/');
+
+		$url = sprintf('http%s://%s:%d/%s', $ssl ? 's' : '', $host, $port, $path);
+
+		return rtrim($url, '/');
+	}
+
+	/**
+	 * read-only properties
+	 *
+	 * @param string $name
+	 * @return mixed
+	 *
+	 * @noinspection MagicMethodsValidityInspection
+	 * @noinspection RedundantSuppression
+	 */
+	public function __get(string $name): mixed
+	{
+		if (!isset(self::DEF[$name])) {
+			throw new OutOfBoundsException("Not a property: \"$name\"");
+		}
+		return $this->config[self::DEF[$name]];
+	}
+
+	/**
+	 * init configuration data
+	 *
+	 * set all named properties from associative array, overwriting self with defaults
+	 * from the schema.
+	 *
+	 * @param array $config
+	 * @return void
+	 */
+	public function importConfigArray(array $config): void
+	{
+		$result = [];
+		foreach (self::SCHEMA as $name => $definition) {
+			$result[$name] =
+				array_key_exists($name, $config)
+					? $config[$name]
+					: $this->config[$name] ?? $definition['options']['default'] ?? null;
+		}
+		$filtered = filter_var_array($result, self::SCHEMA);
+
+		if (!is_array($filtered)) {
+			throw new UnexpectedValueException('Failed to filter Seafile configuration values.');
+		}
+
+		$this->config = $filtered;
+	}
+
+	/**
+	 * Hide its internal state from var_dump()
+	 *
+	 * Note: The xdebug extension may break this behavior.
+	 * You should not rely on it if you have debugging extensions installed.
+	 *
+	 * @return array
+	 */
+	public function __debugInfo(): array
+	{
+		$info = $this->config;
+		$info['password'] = is_string($info['password']) ? '*' : null;
+		$info['sso_auth_user_token'] = is_string($info['sso_auth_user_token']) ? '*' : null;
+
+		return $info;
+	}
+
+	/* ArrayAccess implementation */
+
+	public function offsetExists(mixed $offset): bool
+	{
+		return isset($this->config[$offset]);
+	}
+
+	public function offsetGet(mixed $offset): mixed
+	{
+		return $this->config[$offset];
+	}
+
+	public function offsetSet(mixed $offset, mixed $value): void
+	{
+		trigger_error('modification by write is undefined behaviour', E_USER_WARNING);
+	}
+
+	public function offsetUnset(mixed $offset): void
+	{
+		trigger_error('modification by delete is undefined behaviour', E_USER_WARNING);
+	}
 }

Braces +1 added lines, -2 removed lines

@@ -66,8 +66,7 @@
 
     private array $config = [];
 
-    public function __construct(array $config = [])
-    {
+    public function __construct(array $config = []) {
         $this->importConfigArray($config);
     }
 

plugins/filesbackendSeafile/php/Model/Timer.php

Indentation +10 added lines, -10 removed lines

@@ -9,17 +9,17 @@
  */
 final class Timer
 {
-    private float $start;
+	private float $start;
 
-    public function __construct()
-    {
-        $this->start = microtime(true);
-    }
+	public function __construct()
+	{
+		$this->start = microtime(true);
+	}
 
-    public function __toString(): string
-    {
-        $time = microtime(true) - $this->start;
+	public function __toString(): string
+	{
+		$time = microtime(true) - $this->start;
 
-        return \sprintf('%.3F', $time);
-    }
+		return \sprintf('%.3F', $time);
+	}
 }

Braces +1 added lines, -2 removed lines

@@ -11,8 +11,7 @@
 {
     private float $start;
 
-    public function __construct()
-    {
+    public function __construct() {
         $this->start = microtime(true);
     }
 

plugins/filesbackendSeafile/php/Model/ConfigUtil.php

Indentation +9 added lines, -9 removed lines

@@ -4,13 +4,13 @@
 
 class ConfigUtil
 {
-    /**
-     * Get the users email-address (in Grommunio MAPI-Session)
-     *
-     * @return string
-     */
-    public static function loadSmtpAddress(): string
-    {
-        return $GLOBALS['mapisession']->getSMTPAddress();
-    }
+	/**
+	 * Get the users email-address (in Grommunio MAPI-Session)
+	 *
+	 * @return string
+	 */
+	public static function loadSmtpAddress(): string
+	{
+		return $GLOBALS['mapisession']->getSMTPAddress();
+	}
 }

plugins/filesbackendSeafile/php/Model/SsoBackend.php

Indentation +49 added lines, -49 removed lines

@@ -7,59 +7,59 @@
 
 class SsoBackend
 {
-    /**
-     * @var Config of the Backends files account
-     */
-    private ?Config $backendConfig = null;
+	/**
+	 * @var Config of the Backends files account
+	 */
+	private ?Config $backendConfig = null;
 
-    /**
-     * Bind an SsoBackend
-     *
-     * @param ?SsoBackend $self
-     * @psalm-param-out SsoBackend $self
-     * @return SsoBackend
-     */
-    public static function bind(?SsoBackend &$self = null): SsoBackend
-    {
-        if ($self === null) {
-            $self = new self();
-        }
+	/**
+	 * Bind an SsoBackend
+	 *
+	 * @param ?SsoBackend $self
+	 * @psalm-param-out SsoBackend $self
+	 * @return SsoBackend
+	 */
+	public static function bind(?SsoBackend &$self = null): SsoBackend
+	{
+		if ($self === null) {
+			$self = new self();
+		}
 
-        return $self;
-    }
+		return $self;
+	}
 
-    /**
-     * hook for {@see Backend::init_backend()}
-     *
-     * @param Config $config
-     * @return void
-     */
-    public function initBackend(Config $config): void
-    {
-        if ($this->backendConfig instanceof Config) {
-            throw new \BadMethodCallException('backend is already configured');
-        }
+	/**
+	 * hook for {@see Backend::init_backend()}
+	 *
+	 * @param Config $config
+	 * @return void
+	 */
+	public function initBackend(Config $config): void
+	{
+		if ($this->backendConfig instanceof Config) {
+			throw new \BadMethodCallException('backend is already configured');
+		}
 
-        $this->backendConfig = $config;
-    }
+		$this->backendConfig = $config;
+	}
 
-    /**
-     * hook for {@see Backend::open()}
-     *
-     * @return void
-     */
-    public function open(): void
-    {
-        if (!($this->backendConfig instanceof Config)) {
-            // won't work w/o having the backend config for open()
-            return;
-        }
+	/**
+	 * hook for {@see Backend::open()}
+	 *
+	 * @return void
+	 */
+	public function open(): void
+	{
+		if (!($this->backendConfig instanceof Config)) {
+			// won't work w/o having the backend config for open()
+			return;
+		}
 
-        if (isset($this->backendConfig['sso_auth_user_token'])) {
-            $this->backendConfig->importConfigArray([
-                'user' => SeafileApi::USER_PREFIX_AUTH_TOKEN . ConfigUtil::loadSmtpAddress(),
-                'password' => $this->backendConfig['sso_auth_user_token'],
-            ]);
-        }
-    }
+		if (isset($this->backendConfig['sso_auth_user_token'])) {
+			$this->backendConfig->importConfigArray([
+				'user' => SeafileApi::USER_PREFIX_AUTH_TOKEN . ConfigUtil::loadSmtpAddress(),
+				'password' => $this->backendConfig['sso_auth_user_token'],
+			]);
+		}
+	}
 }

plugins/filesbackendSeafile/php/Model/AccountStoreV1Encoder.php

Indentation +43 added lines, -43 removed lines

@@ -7,48 +7,48 @@
  */
 class AccountStoreV1Encoder
 {
-    /**
-     * Encode an account setting value
-     *
-     * {@see AccountStore::encryptBackendConfigProperty()}
-     *
-     * @param string $value
-     * @return string encoded
-     */
-    public static function encode(string $value): string
-    {
-        $nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
-        $encrypted = sodium_crypto_secretbox($value, $nonce, hex2bin(FILES_ACCOUNTSTORE_V1_SECRET_KEY));
-        return bin2hex($nonce) . bin2hex($encrypted);
-    }
+	/**
+	 * Encode an account setting value
+	 *
+	 * {@see AccountStore::encryptBackendConfigProperty()}
+	 *
+	 * @param string $value
+	 * @return string encoded
+	 */
+	public static function encode(string $value): string
+	{
+		$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
+		$encrypted = sodium_crypto_secretbox($value, $nonce, hex2bin(FILES_ACCOUNTSTORE_V1_SECRET_KEY));
+		return bin2hex($nonce) . bin2hex($encrypted);
+	}
 
-    /**
-     * Decode an encoded account setting value
-     *
-     * {@see AccountStore::decryptBackendConfigProperty()}
-     *
-     * @param string $valueInHex
-     * @return string decoded
-     */
-    public static function decode(string $valueInHex): string
-    {
-        $value = hex2bin($valueInHex);
-        if (!is_string($value)) {
-            throw new \UnexpectedValueException(sprintf('Not an envelope of an encrypted value. Raw binary length of envelope is %d.', strlen($valueInHex)));
-        }
-        $nonce = substr($value, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
-        if (!is_string($nonce) || strlen($nonce) !== SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) {
-            throw new \UnexpectedValueException(sprintf('Not an encrypted value. Raw binary length is %d which is below %d.', strlen($value), SODIUM_CRYPTO_SECRETBOX_NONCEBYTES));
-        }
-        $encrypted = substr($value, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, strlen($value));
-        if (!is_string($encrypted)) {
-            throw new \UnexpectedValueException(sprintf('Not an encrypted value. Raw binary length is %d.', strlen($value)));
-        }
-        $result = sodium_crypto_secretbox_open($encrypted, $nonce, hex2bin(FILES_ACCOUNTSTORE_V1_SECRET_KEY));
-        // Decryption failed, password might have changed
-        if (false === $result) {
-            throw new \UnexpectedValueException("invalid password");
-        }
-        return $result;
-    }
+	/**
+	 * Decode an encoded account setting value
+	 *
+	 * {@see AccountStore::decryptBackendConfigProperty()}
+	 *
+	 * @param string $valueInHex
+	 * @return string decoded
+	 */
+	public static function decode(string $valueInHex): string
+	{
+		$value = hex2bin($valueInHex);
+		if (!is_string($value)) {
+			throw new \UnexpectedValueException(sprintf('Not an envelope of an encrypted value. Raw binary length of envelope is %d.', strlen($valueInHex)));
+		}
+		$nonce = substr($value, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
+		if (!is_string($nonce) || strlen($nonce) !== SODIUM_CRYPTO_SECRETBOX_NONCEBYTES) {
+			throw new \UnexpectedValueException(sprintf('Not an encrypted value. Raw binary length is %d which is below %d.', strlen($value), SODIUM_CRYPTO_SECRETBOX_NONCEBYTES));
+		}
+		$encrypted = substr($value, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, strlen($value));
+		if (!is_string($encrypted)) {
+			throw new \UnexpectedValueException(sprintf('Not an encrypted value. Raw binary length is %d.', strlen($value)));
+		}
+		$result = sodium_crypto_secretbox_open($encrypted, $nonce, hex2bin(FILES_ACCOUNTSTORE_V1_SECRET_KEY));
+		// Decryption failed, password might have changed
+		if (false === $result) {
+			throw new \UnexpectedValueException("invalid password");
+		}
+		return $result;
+	}
 }

plugins/filesbackendSeafile/php/class.pluginseafile.php

Indentation +2 added lines, -2 removed lines

@@ -8,7 +8,7 @@ 
 final class PluginFilesbackendSeafile extends Plugin
 {
 
-    /**
+	/**
 	 * Called to initialize the plugin and register for hooks.
 	 *
 	 * @return void
@@ -30,7 +30,7 @@ 
 			case 'server.core.settings.init.before':
 				$this->onBeforeSettingsInit($data);
 				break;
-            default:
+			default:
 		}
 	}
 

Braces +3 added lines, -6 removed lines

@@ -13,8 +13,7 @@ 
 	 *
 	 * @return void
 	 */
-	public function init()
-	{
+	public function init() {
 		$this->registerHook('server.core.settings.init.before');
 	}
 
@@ -24,8 +23,7 @@ 
 	 * @param String $eventID Identifier of the hook
 	 * @param Array $data Reference to the data of the triggered hook
 	 */
-	public function execute($eventID, &$data)
-	{
+	public function execute($eventID, &$data) {
 		switch ($eventID) {
 			case 'server.core.settings.init.before':
 				$this->onBeforeSettingsInit($data);
@@ -41,8 +39,7 @@ 
 	 * @param Array $data Reference to the data of the triggered hook
 	 * @return void
 	 */
-	public function onBeforeSettingsInit(&$data)
-	{
+	public function onBeforeSettingsInit(&$data) {
 		$data['settingsObj']->addSysAdminDefaults(array(
 			'zarafa' => array(
 				'v1' => array(

plugins/filesbackendSeafile/php/lib/seafapi/SeafileApi.php

Indentation +1583 added lines, -1583 removed lines

@@ -24,1587 +24,1587 @@
  */
 final class SeafileApi
 {
-    public const USER_PREFIX_AUTH_TOKEN = '@auth:token:';
-
-    public const TYPE_DIR = 'dir';
-    public const TYPE_FILE = 'file';
-    public const TYPE_REPO = 'repo';
-    public const TYPE_SREPO = 'srepo';
-    public const TYPE_GREPO = 'grepo';
-
-    public const TYPES = self::TYPES_FILE + self::TYPES_DIR_LIKE;
-    public const TYPES_DIR_LIKE = self::TYPES_DIR + self::TYPES_REPO;
-    public const TYPES_DIR = [self::TYPE_DIR => self::TYPE_DIR];
-    public const TYPES_FILE = [self::TYPE_FILE => self::TYPE_FILE];
-    public const TYPES_REPO = [self::TYPE_REPO => self::TYPE_REPO, self::TYPE_SREPO => self::TYPE_SREPO, self::TYPE_GREPO => self::TYPE_GREPO];
-
-    /**
-     * @const string
-     */
-    public const STRING_SUCCESS = 'success';
-
-    /**
-     * Error codes
-     */
-    public const ERROR_CODE_FEATURES = 802;
-    public const ERROR_CODE_NO_CURL = 803;
-    public const ERROR_CODE_FILE_IO = 808;
-
-    /**
-     * default curl options
-     */
-    private const CURL_OPTION_DEFAULTS = [
-        CURLOPT_AUTOREFERER => true,
-        CURLOPT_TIMEOUT => 10,
-        CURLOPT_RETURNTRANSFER => true,
-        CURLOPT_FOLLOWLOCATION => false,
-    ];
-
-    /**
-     * @var array shared curl options between all requests
-     */
-    private array $curlSharedOptions = self::CURL_OPTION_DEFAULTS;
-
-    /**
-     * jsonDecode accept flags
-     *
-     * @see jsonDecode
-     */
-    private const JSON_DECODE_ACCEPT_MASK = 31;                         # 1 1111 accept bitmask (five bits with the msb flags)
-    private const JSON_DECODE_ACCEPT_JSON = 16;                         # 1 0000 JSON text
-    private const JSON_DECODE_ACCEPT_DEFAULT = 23;                      # 1 0111 default: string, array or object
-    private const JSON_DECODE_ACCEPT_OBJECT = 17;                       # 1 0001 object
-    private const JSON_DECODE_ACCEPT_ARRAY = 18;                        # 1 0010 array
-    private const JSON_DECODE_ACCEPT_STRING = 20;                       # 1 0100 string
-    private const JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS = 24;             # 1 1000 array with only objects (incl. none)
-    private const JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT = 25;          # 1 1001 array with one single object, return that item
-    private const JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT_NULLABLE = 26; # 1 1010 array with one single object, return that item, or empty array, return null
-    private const JSON_DECODE_ACCEPT_SUCCESS_STRING = 28;               # 1 1100 string "success"
-    private const JSON_DECODE_ACCEPT_SUCCESS_OBJECT = 29;               # 1 1101 object with single "success" property and value true
-
-    /**
-     * @const string ASCII upper-case characters part of a hexit
-     */
-    private const HEX_ALPHA_UPPER = 'ABCDEF';
-
-    /**
-     * @const string ASCII lower-case characters part of a hexit
-     */
-    private const HEX_ALPHA_LOWER = 'abcdef';
-
-    /**
-     * @var string Server base URL
-     */
-    private string $baseurl;
-
-    /**
-     * @var string Username
-     */
-    private string $user;
-
-    /**
-     * @var string Password
-     */
-    private string $pass;
-
-    private ?CurlHandle $handle = null;
-
-    /**
-     * @var string
-     */
-    private string $token = '';
-
-    /**
-     * constructor
-     *
-     * @param string $baseurl
-     * @param string $user
-     * @param string $pass
-     * @param string|null $otp
-     */
-    public function __construct(string $baseurl, string $user, string $pass, string $otp = null)
-    {
-        if (!(function_exists('curl_version'))) {
-            throw new ConnectionException('PHP-CURL not installed', self::ERROR_CODE_NO_CURL);
-        }
-
-        $this->baseurl = $baseurl;
-        $this->user = $user;
-        $this->pass = $pass;
-        // trigger_error(sprintf("ctor: %s:%s", $user, $pass), E_USER_NOTICE);
-
-        $this->setTokenByUsernameAndPassword($otp);
-    }
-
-    /**
-     * ping (with authentication)
-     *
-     * @link https://download.seafile.com/published/web-api/home.md#user-content-Quick%20Start
-     *
-     * @return string "pong"
-     */
-    public function ping(): string
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/ping/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_STRING,
-        );
-    }
-
-    /**
-     * get server version
-     *
-     * @throws Exception
-     * @return string
-     */
-    public function getServerVersion(): string
-    {
-        $serverInfo = $this->getServerInformation();
-        if (
-            !is_string($serverInfo->version ?? null)
-            || !is_array($serverInfo->features ?? null)
-        ) {
-            throw new InvalidResponseException('We could not retrieve list of server features.', self::ERROR_CODE_FEATURES);
-        }
-
-        $isSeafilePro = in_array('seafile-pro', $serverInfo->features, true);
-        $edition = $isSeafilePro ? 'Professional' : 'Community';
-
-        return "$serverInfo->version ($edition)";
-    }
-
-    /**
-     * get server information
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/server-info.md#user-content-Get%20Server%20Information
-     *
-     * @throws Exception
-     * @return object
-     */
-    public function getServerInformation(): object
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/server-info/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * check account info
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/account.md#user-content-Check%20Account%20Info
-     * @return object
-     */
-    public function checkAccountInfo(): object
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/account/info/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]]
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * list seafile server libraries
-     *
-     * that are all libraries a user can access.
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-List%20Libraries
-     *
-     * @throws Exception
-     * @return object[]
-     */
-    public function listLibraries(): array
-    {
-        return $this->listLibrariesCached(true);
-    }
-
-    /**
-     * get default library
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Get%20Default%20Library
-     *
-     * @return object{exists: bool, repo_id: string}
-     */
-    public function getDefaultLibrary(): object
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/default-repo/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * create a library
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Create%20Library
-     *
-     * @param string $name of library
-     * @return object
-     */
-    public function createLibrary(string $name): object
-    {
-        $name = trim($name, "/");
-
-        return $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api2/repos/",
-                ['name' => $name],
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * name a library
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Rename%20Library
-     */
-    public function nameLibrary(string $lib, string $name): void
-    {
-        $lib = $this->verifyLib($lib);
-        $fields = ['repo_name' => $name];
-        $_ = $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api2/repos/$lib/?op=rename",
-                $fields,
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_SUCCESS_STRING,
-        );
-        unset($_);
-    }
-
-    /**
-     * rename a library
-     *
-     * do nothing if the library can not be found
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Rename%20Library
-     *
-     * @param string $oldName
-     * @param string $newName
-     * @return void
-     */
-    public function renameLibrary(string $oldName, string $newName): void
-    {
-        $lib = $this->getLibraryIdByLibraryName($oldName);
-        if (null === $lib) {
-            return; // no library to rename
-        }
-
-        $this->nameLibrary($lib, $newName);
-    }
-
-    /**
-     * delete a library by name
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Delete%20Library
-     *
-     * @param string $name
-     * @return void
-     */
-    public function deleteLibraryByName(string $name): void
-    {
-        $id = $this->getLibraryIdByLibraryName($name);
-        if (null === $id) {
-            return; // library already gone
-        }
-
-        $this->deleteLibraryById($id);
-    }
-
-    /**
-     * delete a library by id
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Delete%20Library
-     *
-     * @param string $id
-     * @return void
-     */
-    public function deleteLibraryById(string $id): void
-    {
-        $lib = $this->verifyLib($id);
-
-        $_ = $this->jsonDecode(
-            $this->delete(
-                "$this->baseurl/api2/repos/$lib/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_SUCCESS_STRING,
-        );
-        unset($_);
-    }
-
-    /**
-     * get library info array from path
-     *
-     * @param string $libNamedPath with the library name as first component
-     * @throws Exception
-     * @throws InvalidResponseException
-     * @return object with 'id' and 'name' of library, both NULL if not found
-     */
-    public function getLibraryFromPath(string $libNamedPath): object
-    {
-        $libraries = $this->listLibrariesCached();
-        $libraries = array_column($libraries, null, 'name');
-
-        $name = explode('/', ltrim($this->normalizePath($libNamedPath), '/'), 2)[0];
-
-        return (object)[
-            'id' => $libraries[$name]->id ?? null,
-            'name' => $libraries[$name]->name ?? null,
-        ];
-    }
-
-    /**
-     * list all share links
-     *
-     * all folder/file download share links in all libraries created by user.
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-List%20all%20Share%20Links
-     *
-     * @return object[]
-     * @throws Exception
-     * @throws InvalidResponseException
-     * @noinspection PhpUnused
-     */
-    public function listAllShareLinks(): array
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/share-links/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
-        );
-    }
-
-    /**
-     * Create Share Link
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-Create%20Share%20Link
-     *
-     * @param string $lib
-     * @param string $path
-     * @param ?string $password [optional]
-     * @param ?int|DateTimeInterface $expire [optional] number of days to expire (int) or DateTime to expire
-     * @param ?array $permissions [optional] see seafile api docs
-     * @return object
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidResponseException
-     */
-    public function createShareLink(string $lib, string $path, string $password = null, $expire = null, array $permissions = null): object
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-
-        $fields = [
-            'repo_id' => $lib,
-            'path' => $path,
-        ];
-        if (null !== $password) {
-            $fields['password'] = $password;
-        }
-        if (null !== $expire) {
-            $expireTime = $expire;
-            if (is_int($expire)) {
-                $expireDays = max(1, min(365, (int)$expire));
-                $expireTime = (new DateTimeImmutable())->add(
-                    new \DateInterval("P{$expireDays}D")
-                );
-            }
-            if (!$expireTime instanceof DateTimeInterface) {
-                throw new InvalidArgumentException('Expire type mismatch: ' . gettype($expireTime));
-            }
-            $fields['expiration_time'] = $expireTime->format(\DATE_ATOM);
-        }
-        if (null !== $permissions) {
-            try {
-                $fields['permissions'] = json_encode($permissions, JSON_THROW_ON_ERROR);
-            } /** @noinspection PhpMultipleClassDeclarationsInspection */ catch (JsonException $ex) {
-                throw new InvalidArgumentException('permissions');
-            }
-        }
-
-        return $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api/v2.1/share-links/",
-                $fields,
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * List Share Links of a Library
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-List%20all%20Share%20Links
-     *
-     * @param ?string $lib [optional] library id (guid), default/null for all libraries
-     * @throws Exception
-     * @return object[]
-     */
-    public function listShareLinksOfALibrary(string $lib = null): array
-    {
-        $lib = $this->verifyLib($lib ?? '', true);
-
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/share-links/?repo_id=$lib",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
-        );
-    }
-
-    /**
-     * check password (of a share link by token)
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1-admin/share-links.md#user-content-Check%20Password
-     *
-     * @param string $token of share link
-     * @param string $password in plain
-     * @return object
-     * @throws Exception
-     * @throws InvalidResponseException
-     * @noinspection PhpUnused
-     */
-    public function checkShareLinkPassword(string $token, string $password): object
-    {
-        $tokenEncoded = rawurlencode($token);
-
-        return $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api/v2.1/admin/share-links/$tokenEncoded/check-password/",
-                ['password' => $password],
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT,
-        );
-    }
-
-    /**
-     * share Link of a folder (or file)
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-List%20Share%20Link%20of%20a%20Folder%20(File)
-     *
-     * @param string $lib
-     * @param string $path
-     * @return object the share link
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidResponseException
-     * @noinspection PhpUnused
-     */
-    public function listShareLinksOfAFolder(string $lib, string $path): ?object
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/share-links/?repo_id=$lib&path=$pathEncoded",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT_NULLABLE,
-        );
-    }
-
-    /**
-     * Delete Share Link
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-Delete%20Share%20Link
-     *
-     * @param string $token
-     * @throws Exception
-     * @return object success {"success": true}
-     */
-    public function deleteShareLink(string $token): object
-    {
-        $token = $this->verifyToken($token);
-
-        return $this->jsonDecode(
-            $this->delete(
-                "$this->baseurl/api/v2.1/share-links/$token/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT,
-        );
-    }
-
-    /**
-     * search user
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/user-search.md#user-content-Search%20User
-     *
-     * @param string $search
-     * @throws Exception
-     * @return object
-     */
-    public function searchUser(string $search): object
-    {
-        $searchEncoded = rawurlencode($search);
-
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/search-user/?q=$searchEncoded",
-                [CURLOPT_HTTPHEADER => ['Authorization: Token ' . $this->token]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * list groups for user sharing
-     *
-     * @throws Exception
-     * @throws InvalidResponseException
-     * @return array|object|string
-     * @link (undocumented)
-     *
-     */
-    public function shareableGroups(): array
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/shareable-groups/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
-        );
-    }
-
-    /**
-     * Share a Library to Group
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-Share%20a%20Library%20to%20Group
-     *
-     * @param string $lib
-     * @param string $path
-     * @param int|int[] $group
-     * @param string|null $permission [optional] r, rw, admin (default: r)
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @return array
-     */
-    public function shareLibraryPathToGroup(string $lib, string $path, $group, string $permission = null)
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        $fields = [
-            'share_type' => 'group',
-            'group_id' => $group,
-            'permission' => $permission ?? 'r',
-        ];
-        return $this->jsonDecode(
-            $this->put(
-                "$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded",
-                $fields,
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * Share a Library to User
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-Share%20a%20Library%20to%20User
-     *
-     * @param string $lib
-     * @param string $path
-     * @param string $user
-     * @param string|null $permission [optional] r, rw, admin (default: r)
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @return array
-     */
-    public function shareLibraryPathToUser(string $lib, string $path, string $user, string $permission = null)
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        $fields = [
-            'share_type' => 'user',
-            'username' => $user,
-            'permission' => $permission ?? 'r',
-        ];
-        return $this->jsonDecode(
-            $this->put(
-                "$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded",
-                $fields,
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            // either array of objects -or- failure object
-            self::JSON_DECODE_ACCEPT_ARRAY | self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * Unshare a Library to Group
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-Unshare%20a%20Library%20from%20Group
-     *
-     * @param string $lib
-     * @param string $path
-     * @param int $group
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @return object
-     */
-    public function unshareLibraryPathToGroup(string $lib, string $path, int $group): object
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        return $this->jsonDecode(
-            $this->delete(
-                "$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded&share_type=group&group_id=$group",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT,
-        );
-    }
-
-    /**
-     * Unshare a Library to User
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-Unshare%20a%20Library%20from%20User
-     *
-     * @param string $lib
-     * @param string $path
-     * @param string|string[] $user
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @return object
-     */
-    public function unshareLibraryPathToUser(string $lib, string $path, $user): object
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-        $userEncoded = rawurlencode($user);
-
-        return $this->jsonDecode(
-            $this->delete(
-                "$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded&share_type=user&username=$userEncoded",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT,
-        );
-    }
-
-    /**
-     * list user shares for a library path
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-List%20Shared%20Users%20of%20a%20Library
-     *
-     * @param string $lib
-     * @param string $path
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidResponseException
-     * @return array<int, object>
-     */
-    public function listSharesOfLibraryPath(string $lib, string $path): array
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
-        );
-    }
-
-    /**
-     * create a new directory
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/directories.md#user-content-Create%20New%20Directory
-     *
-     * @param string $lib library id (guid)
-     * @param string $path of the directory to create (e.g.: "/path/to/new-directory", leading and trailing slashes can be omitted)
-     * @throws InvalidArgumentException|Exception
-     * @return string|object the common "success" or the object with error_msg property
-     */
-    public function createNewDirectory(string $lib, string $path)
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        return $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api2/repos/$lib/dir/?p=$pathEncoded",
-                ['operation' => 'mkdir'],
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_STRING | self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * delete a file
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/file.md#user-content-Delete%20File
-     *
-     * @param string $lib library id (guid)
-     * @param string $path of the fle to delete (e.g.: "/path/to/file-to-delete", leading and trailing slashes can be omitted)
-     * @throws InvalidArgumentException|Exception
-     * @return string|object the common "success" or the known object with error_msg property
-     */
-    public function deleteFile(string $lib, string $path)
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        return $this->jsonDecode(
-            $this->delete(
-                "$this->baseurl/api2/repos/$lib/file/?p=$pathEncoded",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_STRING | self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * get a file download URL
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/file.md#user-content-Download%20File
-     *
-     * @param string $lib
-     * @param string $path
-     * @return string download URL (http/s)
-     * @throws InvalidArgumentException|Exception
-     */
-    public function downloadFile(string $lib, string $path): string
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/repos/$lib/file/?p=$pathEncoded",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_STRING,
-        );
-    }
-
-    /**
-     * download a file
-     *
-     * get file contents of a file in a library
-     *
-     * @param string $lib
-     * @param string $path
-     * @throws InvalidArgumentException|Exception
-     * @return string|false on failure
-     */
-    public function downloadFileAsBuffer(string $lib, string $path)
-    {
-        $url = $this->downloadFile($lib, $path);
-
-        return $this->get($url);
-    }
-
-    /**
-     * download a file to a local file
-     *
-     * @param string $lib
-     * @param string $path
-     * @param string $localPath path to a file - existing or not - on the local file-system
-     * @throws InvalidArgumentException|Exception
-     * @return bool success/failure
-     */
-    public function downloadFileToFile(string $lib, string $path, string $localPath): bool
-    {
-        $handle = fopen($localPath, 'wb');
-        if (false === $handle) {
-            throw new Exception('failed to open local path for writing', self::ERROR_CODE_FILE_IO);
-        }
-
-        try {
-            $result = $this->downloadFileToStream($lib, $path, $handle);
-        } finally {
-            $close = fclose($handle);
-        }
-
-        if (!$close) {
-            throw new Exception('failed to close local path handle', self::ERROR_CODE_FILE_IO);
-        }
-
-        return $result;
-    }
-
-    /**
-     * download a file to a stream handle
-     *
-     * @param string $lib
-     * @param string $path
-     * @param resource $handle stream handle
-     * @throws InvalidArgumentException|Exception
-     * @return bool success/failure
-     */
-    public function downloadFileToStream(string $lib, string $path, $handle): bool
-    {
-        $url = $this->downloadFile($lib, $path);
-
-        return $this->get($url, [CURLOPT_RETURNTRANSFER => true, CURLOPT_FILE => $handle]);
-    }
-
-    /**
-     * list items in directory
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/directories.md#user-content-List%20Items%20in%20Directory
-     *
-     * @param string $lib
-     * @param string $path
-     * @return array
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidResponseException
-     */
-    public function listItemsInDirectory(string $lib, string $path): array
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        $result = $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/repos/$lib/dir/?p=$pathEncoded",
-                [CURLOPT_HTTPHEADER => ['Authorization: Token ' . $this->token]],
-            ),
-        );
-
-        if (is_object($result)) {
-            // likely a folder not found.
-            $result = [];
-        }
-
-        return $result;
-    }
-
-    /**
-     * move a file
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/file.md#user-content-Move%20File
-     *
-     * @param string $lib
-     * @param string $path
-     * @param string $dstLib
-     * @param string $dstDir
-     * @return object
-     * @throws InvalidArgumentException|Exception
-     */
-    public function moveFile(string $lib, string $path, string $dstLib, string $dstDir): object
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-        $dstLib = $this->verifyLib($dstLib);
-        $dstDir = $this->normalizePath($dstDir);
-
-        return $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api2/repos/$lib/file/?p=$pathEncoded",
-                ['operation' => 'move', 'dst_repo' => $dstLib, 'dst_dir' => $dstDir],
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * rename a file
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/file.md#user-content-Move%20File
-     *
-     * @param string $lib library id (guid)
-     * @param string $path of the file to rename (e.g. "/path/to/file-to-rename")
-     * @param string $newName new basename for the basename of $path (e.g. "new-file-name")
-     * @return string|object the common "success" or the known object with error_msg property
-     * @throws Exception
-     */
-    public function renameFile(string $lib, string $path, string $newName)
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        $pathEncoded = rawurlencode($path);
-
-        return $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api2/repos/$lib/file/?p=$pathEncoded",
-                ['operation' => 'rename', 'newname' => $newName],
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_STRING | self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * simplified file upload routine for string buffer
-     *
-     * @param string $lib
-     * @param string $path
-     * @param string $buffer
-     * @throws InvalidArgumentException
-     * @throws Exception
-     * @return object
-     */
-    public function uploadBuffer(string $lib, string $path, string $buffer): object
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-
-        $parentDir = dirname($path);
-        $uploadLink = $this->uploadGetLink($lib, $parentDir);
-        $fileName = basename($path);
-
-        return $this->uploadFileBuffer($uploadLink, $parentDir, '', $buffer, $fileName);
-    }
-
-    /**
-     * simplified file upload routine for standard file
-     *
-     * @param string $lib
-     * @param string $path path in seafile to upload the file as
-     * @param string $file path of file to upload
-     * @throws InvalidArgumentException
-     * @throws Exception
-     * @return object
-     */
-    public function uploadFile(string $lib, string $path, string $file): object
-    {
-        $lib = $this->verifyLib($lib);
-        $path = $this->normalizePath($path);
-        if (!is_file($file) && !is_readable($file)) {
-            throw new InvalidArgumentException(sprintf('Not a readable file: %s', $file));
-        }
-
-        $parentDir = dirname($path);
-        $uploadLink = $this->uploadGetLink($lib, $parentDir);
-        $fileName = basename($path);
-
-        return $this->uploadFilePath($uploadLink, $parentDir, '', $file, $fileName);
-    }
-
-    /**
-     * upload string buffer as a file
-     *
-     * same as {@see SeafileApi::uploadFile()} with the option to upload without a
-     * concrete file on the system. the temporary file to upload is created
-     * from the string buffer.
-     *
-     * @param string $uploadLink from {@see uploadGetLink}
-     * @param string $parentDir the parent directory to upload the file to
-     * @param string $relativePath the name of the file, subdirectories possible (e.g. uploading a folder)
-     * @param string $buffer file contents to upload as string (not the file-name)
-     * @param string $fileName to use as basename for the data
-     * @param bool $replace
-     * @throws Exception
-     * @return object
-     */
-    public function uploadFileBuffer(
-        string $uploadLink, string $parentDir, string $relativePath,
-        string $buffer, string $fileName = 'upload.dat', bool $replace = false
-    ): object
-    {
-        $tmpHandle = tmpfile();
-        if (false === $tmpHandle) {
-            throw new Exception('Upload data rejected: Unable to open temporary stream.');
-        }
-
-        $meta = stream_get_meta_data($tmpHandle);
-        $tmpFile = $meta['uri'];
-        if (!is_file($tmpFile)) {
-            fclose($tmpHandle);
-            throw new Exception('Upload data rejected: No file with temporary stream.');
-        }
-
-        $bytes = fwrite($tmpHandle, $buffer);
-        if (false === $bytes) {
-            fclose($tmpHandle);
-            throw new Exception('Upload data rejected: Failed to write to temporary stream.');
-        }
-
-        $diff = strlen($buffer) - $bytes;
-        if ($diff !== 0) {
-            fclose($tmpHandle);
-            throw new Exception(sprintf("Upload data rejected: Unexpected difference writing to temporary stream: %d bytes", $diff));
-        }
-
-        $result = rewind($tmpHandle);
-        if (false === $result) {
-            fclose($tmpHandle);
-            throw new Exception('Upload data rejected: Failed to rewind temporary stream.');
-        }
-
-        $result = $this->uploadFilePath($uploadLink, $parentDir, $relativePath, $tmpFile, $fileName, $replace);
-        fclose($tmpHandle);
-
-        return $result;
-    }
-
-    /**
-     * upload file
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/file-upload.md#user-content-Upload%20File
-     *
-     * @param string $uploadLink from {@see uploadGetLink}
-     * @param string $parentDir the parent directory to upload a file to
-     * @param string $relativePath to place the file in under $uploadPath (can include subdirectories)
-     * @param string $path path of the file to upload
-     * @param ?string $fileName to use as basename for the file (the name used in Seafile)
-     * @param bool $replace
-     * @return object
-     * @throws Exception
-     */
-    public function uploadFilePath(
-        string $uploadLink, string $parentDir, string $relativePath,
-        string $path, string $fileName = null, bool $replace = false
-    ): object
-    {
-        $parentDir = $this->normalizePath($parentDir);
-        $relativePath = ltrim('/', $this->normalizePath($relativePath));
-        $fileName = $fileName ?? basename($path);
-
-        $fields = [
-            'file' => new CURLFile($path, 'application/octet-stream', $fileName),
-            'parent_dir' => $parentDir,
-            'relative_path' => $relativePath,
-            'replace' => $replace ? '1' : '0',
-        ];
-
-        return $this->jsonDecode(
-            $this->post(
-                "$uploadLink?ret-json=1",
-                $fields,
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT,
-        );
-    }
-
-    /**
-     * get file upload link
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/file-upload.md#user-content-Get%20Upload%20Link
-     *
-     * @param string $lib
-     * @param string $uploadDir the directory to upload file(s) to
-     * @return string upload link (https?://...)
-     * @throws InvalidArgumentException|Exception
-     */
-    public function uploadGetLink(string $lib, string $uploadDir): string
-    {
-        $lib = $this->verifyLib($lib);
-        $uploadDir = $this->normalizePath($uploadDir);
-        $pathEncoded = rawurlencode($uploadDir);
-
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/repos/$lib/upload-link/?p=$pathEncoded",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_STRING,
-        );
-    }
-
-    public function generateUserAuthToken(string $email): object
-    {
-        return $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api/v2.1/admin/generate-user-auth-token/",
-                ['email' => $email],
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    public function getUserActivity(string $email, int $page = 1, int $perPage = 25): object
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/admin/user-activities/?user=$email&page=$page&per_page=$perPage",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-    }
-
-    /**
-     * set authorization token
-     *
-     * @param string $token
-     * @return void
-     */
-    public function setToken(string $token): void
-    {
-        $this->token = $token;
-    }
-
-    public function listDevices(): array
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/devices/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-        );
-    }
-
-    public function listStarredItems(): object
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/starred-items/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-        );
-    }
-
-    public function listGroups(): object
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/groups/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-        );
-    }
-
-    public function listInvitations(): array
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/invitations/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-        );
-    }
-
-    /**
-     * @param string $start e.g. date('Y-m-d', time() - 7776000 ); // 3 months
-     * @param string $end e.g. date('Y-m-d', time());
-     *
-     * @return array
-     */
-    public function getLoginLog(string $start, string $end): array
-    {
-        $start = rawurlencode($start);
-        $end = rawurlencode($end);
-
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/admin/logs/login/?start=$start&end=$end",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-        );
-    }
-
-    public function listUploadLinks(): array
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/upload-links/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-        );
-    }
-
-    public function listRepoApiTokens(string $lib): object
-    {
-        $lib = $this->verifyLib($lib);
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api/v2.1/repos/$lib/repo-api-tokens/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-        );
-    }
-
-    /**
-     * internal api implementation to get library by name
-     *
-     * @param string $name
-     * @throws Exception
-     * @return ?string id (guid) of the library, null if library does not exist
-     */
-    private function getLibraryIdByLibraryName(string $name): ?string
-    {
-        $name = explode('/', $this->normalizePath($name), 2)[1];
-
-        $libraries = $this->listLibrariesCached();
-        $libraries = array_column($libraries, null, 'name');
-        return $libraries[$name]->id ?? null;
-    }
-
-    /**
-     * List libraries a user can access.
-     *
-     * internal api implementation for {@see listLibrariesCached()} and {@see listLibraries()}
-     *
-     * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-List%20Libraries
-     *
-     * @throws Exception
-     * @return object[]
-     */
-    private function listLibrariesDo(): array
-    {
-        return $this->jsonDecode(
-            $this->get(
-                "$this->baseurl/api2/repos/",
-                [CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
-            ),
-            self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
-        );
-    }
-
-    /**
-     * like {@see listLibraries()} but cached.
-     *
-     * @param bool $invalidate
-     * @throws Exception
-     * @throws InvalidResponseException
-     * @return void
-     */
-    private function listLibrariesCached(bool $invalidate = false): array
-    {
-        static $librariesCache;
-
-        return $librariesCache = ($invalidate ? null : $librariesCache) ?? $this->listLibrariesDo();
-    }
-
-    /**
-     * normalize path
-     *
-     * normalizes the path component separator <slash> "/" <U002F> U+002F SOLIDUS
-     * with first character being the slash, no consecutive slashes within the
-     * path and no terminating slash.
-     *
-     * @param string $path
-     * @return string
-     */
-    private function normalizePath(string $path): string
-    {
-        $buffer = rtrim($path, '/');
-        $buffer = preg_replace('~/{2,}~', '/', $buffer);
-        '' === $buffer && $buffer = '/';
-        '/' === $buffer[0] || $buffer = "/$buffer";
-
-        return $buffer;
-    }
-
-    /**
-     * verify library id
-     *
-     * verifies the format of a library id. can be used in URLs
-     * afterwards. case normalization to lowercase.
-     *
-     * example library id strings:
-     *  - 21b941c2-5411-4372-a514-00b62ab99ef2 (from the docs)
-     *  - 79144b25-f772-42b6-a1c0-60e6359f5884 (from a server)
-     *
-     * @param string $lib
-     * @param bool $allowEmpty
-     * @return string library id
-     */
-    private function verifyLib(string $lib, bool $allowEmpty = false): string
-    {
-        if ($allowEmpty && ('' === $lib)) {
-            return $lib;
-        }
-
-        $buffer = strtr($lib, self::HEX_ALPHA_UPPER, self::HEX_ALPHA_LOWER);
-        $format = '%04x%04x-%04x-%04x-%04x-%04x%04x%04x';
-        $values = sscanf($buffer, $format);
-        $result = vsprintf($format, $values);
-
-        if ($buffer !== $result) {
-            throw new InvalidArgumentException(sprintf('Not a library id: "%s"', $lib));
-        }
-
-        return $result;
-    }
-
-    /**
-     * verify share link token
-     *
-     * verifies the format of a share link token. can be used in URLs
-     * afterwards. case normalization to lowercase.
-     *
-     * @param string $token e.g. "0a29ff44dc0b4b56be74"
-     * @return string
-     */
-    private function verifyToken(string $token): string
-    {
-        $buffer = strtr($token, self::HEX_ALPHA_UPPER, self::HEX_ALPHA_LOWER);
-        $format = '%04x%04x%04x%04x%04x';
-        $values = sscanf($buffer, $format);
-        $result = vsprintf($format, $values);
-
-        if ($buffer !== $result) {
-            throw new InvalidArgumentException(sprintf('Not a token: "%s"', $token));
-        }
-
-        return $result;
-    }
-
-    /**
-     * authenticate class against seafile api
-     *
-     * @link https://download.seafile.com/published/web-api/home.md#user-content-Quick%20Start
-     *
-     * @param string|null $otp (optional) Seafile OTP (if user uses OTP access)
-     * @return void
-     */
-    private function setTokenByUsernameAndPassword(string $otp = null): void
-    {
-        // @auth:token:<email> : password is auth token
-        if (0 === strpos($this->user, $needle = self::USER_PREFIX_AUTH_TOKEN)) {
-            $this->user = \substr($this->user, strlen($needle)) ?: '';
-            $this->token = $this->pass;
-            if ('pong' !== $this->ping()) {
-                throw new ConnectionException('token authentication failure');
-            }
-            return;
-        }
-
-        $data = $this->jsonDecode(
-            $this->post(
-                "$this->baseurl/api2/auth-token/",
-                ['username' => $this->user, 'password' => $this->pass],
-                $otp ? [CURLOPT_HTTPHEADER => ["X-SEAFILE-OTP: $otp"]] : [],
-            ),
-            self::JSON_DECODE_ACCEPT_OBJECT,
-        );
-        $this->token = (string)$data->token;
-    }
-
-    /**
-     * http request with get method
-     *
-     * @param string $url
-     * @param array $curlOptions
-     * @return bool|string
-     */
-    private function get(string $url, array $curlOptions = [])
-    {
-        $curlOptions += $this->curlSharedOptions;
-
-        return $this->curlExec($url, $curlOptions);
-    }
-
-    /**
-     * http request with post method
-     *
-     * @param string $url
-     * @param array $fields
-     * @param array $curlOptions
-     * @return bool|string
-     */
-    private function post(string $url, array $fields = [], array $curlOptions = [])
-    {
-        $curlOptions += $this->curlSharedOptions;
-        $curlOptions[CURLOPT_POST] = true;
-        $curlOptions[CURLOPT_POSTFIELDS] = $fields;
-
-        return $this->curlExec($url, $curlOptions);
-    }
-
-    /**
-     * http request with put method
-     *
-     * @param string $url
-     * @param array $fields
-     * @param array $curlOptions
-     * @return bool|string
-     */
-    public function put(string $url, array $fields = [], array $curlOptions = [])
-    {
-        $curlOptions += $this->curlSharedOptions;
-        $curlOptions[CURLOPT_CUSTOMREQUEST] = 'PUT';
-        $curlOptions[CURLOPT_POSTFIELDS] = $fields;
-
-        return $this->curlExec($url, $curlOptions);
-    }
-
-    /**
-     * http request with delete method
-     *
-     * @param string $url
-     * @param array $curlOptions
-     * @return bool|string
-     */
-    public function delete(string $url, array $curlOptions = [])
-    {
-
-        $curlOptions += $this->curlSharedOptions;
-        $curlOptions[CURLOPT_CUSTOMREQUEST] = 'DELETE';
-
-        return $this->curlExec($url, $curlOptions);
-    }
-
-    /**
-     * json decode handler
-     *
-     * decode json with structural acceptance
-     *
-     * @param string $jsonText
-     * @param int $flags decode accept flag
-     * @throws InvalidResponseException
-     * @return string|object|array
-     */
-    private function jsonDecode(string $jsonText, int $flags = self::JSON_DECODE_ACCEPT_DEFAULT)
-    {
-        $accept = $flags & self::JSON_DECODE_ACCEPT_MASK;
-        if (0 === $accept) {
-            return $jsonText;
-        }
-
-        try {
-            $result = json_decode($jsonText, false, 512, JSON_THROW_ON_ERROR);
-        } /** @noinspection PhpMultipleClassDeclarationsInspection */ catch (JsonException $e) {
-            throw JsonDecodeException::create(sprintf('json decode error of %s', JsonDecodeException::shorten($jsonText)), $jsonText, $e);
-        }
-
-        if (self::JSON_DECODE_ACCEPT_JSON === $accept) {
-            return $result;
-        }
-
-        if (self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS === $accept) {
-            if (is_array($result) && $result === array_filter($result, 'is_object')) {
-                return $result;
-            }
-            throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
-        }
-
-        if (self::JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT_NULLABLE === $accept) {
-            if (is_array($result)
-                && (
-                    (count($result) === 1 && is_object($result[0] ?? null))
-                    || (count($result) === 0)
-                )
-            ) {
-                return $result[0] ?? null;
-            }
-            throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
-        }
-
-        if (self::JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT === $accept) {
-            if (is_array($result) && is_object($result[0] ?? null) && count($result) === 1) {
-                return $result[0];
-            }
-            throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
-        }
-
-        if (self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT === $accept) {
-            if (is_object($result) && (array)$result === ['success' => true]) {
-                return $result;
-            }
-            throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
-        }
-
-        if (self::JSON_DECODE_ACCEPT_SUCCESS_STRING === $accept) {
-            if (self::STRING_SUCCESS === $result) {
-                return $result;
-            }
-            throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
-        }
-
-        if (is_string($result) && (self::JSON_DECODE_ACCEPT_STRING !== ($accept & self::JSON_DECODE_ACCEPT_STRING))) {
-            throw JsonDecodeException::create(sprintf('json decode type %s not accepted; of %s', gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
-        }
-
-        if (is_array($result) && (self::JSON_DECODE_ACCEPT_ARRAY !== ($accept & self::JSON_DECODE_ACCEPT_ARRAY))) {
-            throw JsonDecodeException::create(sprintf('json decode type %s not accepted; of %s', gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
-        }
-
-        if (is_object($result) && (self::JSON_DECODE_ACCEPT_OBJECT !== ($accept & self::JSON_DECODE_ACCEPT_OBJECT))) {
-            throw JsonDecodeException::create(sprintf('json decode type %s not accepted; of %s', gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
-        }
-
-        return $result;
-    }
-
-
-    /**
-     * execute curl with url and options
-     *
-     * @param string $url
-     * @param array $options
-     * @return bool|string
-     */
-    private function curlExec(string $url, array $options)
-    {
-        $handle = curl_init($url);
-        if (!($handle instanceof CurlHandle)) {
-            throw new ConnectionException('Unable to initialise cURL session.', self::ERROR_CODE_NO_CURL);
-        }
-
-        $this->handle = $handle;
-
-        if (!curl_setopt_array($this->handle, $options)) {
-            throw new Exception("Error setting cURL request options.");
-        }
-        $result = curl_exec($this->handle);
-        $this->curlExecHandleResult($result);
-        curl_close($this->handle);
-
-        return $result;
-    }
-
-    /**
-     * internal handling of curl_exec() return
-     *
-     * {@see curlExec()}
-     *
-     * @param bool|string $curlResult return value from curl_exec();
-     * @throws ConnectionException
-     * @return void
-     */
-    private function curlExecHandleResult($curlResult): void
-    {
-        if (empty($curlResult)) {
-            throw new ConnectionException(curl_error($this->handle), -1);
-        }
-
-        $code = (int)curl_getinfo($this->handle)['http_code'];
-
-        $codeIsInErrorRange = $code >= 400 && $code <= 600;
-        $codeIsNotInNonErrorCodes = !in_array($code, [200, 201, 202, 203, 204, 205, 206, 207, 301], true);
-
-        if ($codeIsInErrorRange || $codeIsNotInNonErrorCodes) {
-            ConnectionException::throwCurlResult($code, $curlResult);
-        }
-    }
+	public const USER_PREFIX_AUTH_TOKEN = '@auth:token:';
+
+	public const TYPE_DIR = 'dir';
+	public const TYPE_FILE = 'file';
+	public const TYPE_REPO = 'repo';
+	public const TYPE_SREPO = 'srepo';
+	public const TYPE_GREPO = 'grepo';
+
+	public const TYPES = self::TYPES_FILE + self::TYPES_DIR_LIKE;
+	public const TYPES_DIR_LIKE = self::TYPES_DIR + self::TYPES_REPO;
+	public const TYPES_DIR = [self::TYPE_DIR => self::TYPE_DIR];
+	public const TYPES_FILE = [self::TYPE_FILE => self::TYPE_FILE];
+	public const TYPES_REPO = [self::TYPE_REPO => self::TYPE_REPO, self::TYPE_SREPO => self::TYPE_SREPO, self::TYPE_GREPO => self::TYPE_GREPO];
+
+	/**
+	 * @const string
+	 */
+	public const STRING_SUCCESS = 'success';
+
+	/**
+	 * Error codes
+	 */
+	public const ERROR_CODE_FEATURES = 802;
+	public const ERROR_CODE_NO_CURL = 803;
+	public const ERROR_CODE_FILE_IO = 808;
+
+	/**
+	 * default curl options
+	 */
+	private const CURL_OPTION_DEFAULTS = [
+		CURLOPT_AUTOREFERER => true,
+		CURLOPT_TIMEOUT => 10,
+		CURLOPT_RETURNTRANSFER => true,
+		CURLOPT_FOLLOWLOCATION => false,
+	];
+
+	/**
+	 * @var array shared curl options between all requests
+	 */
+	private array $curlSharedOptions = self::CURL_OPTION_DEFAULTS;
+
+	/**
+	 * jsonDecode accept flags
+	 *
+	 * @see jsonDecode
+	 */
+	private const JSON_DECODE_ACCEPT_MASK = 31;                         # 1 1111 accept bitmask (five bits with the msb flags)
+	private const JSON_DECODE_ACCEPT_JSON = 16;                         # 1 0000 JSON text
+	private const JSON_DECODE_ACCEPT_DEFAULT = 23;                      # 1 0111 default: string, array or object
+	private const JSON_DECODE_ACCEPT_OBJECT = 17;                       # 1 0001 object
+	private const JSON_DECODE_ACCEPT_ARRAY = 18;                        # 1 0010 array
+	private const JSON_DECODE_ACCEPT_STRING = 20;                       # 1 0100 string
+	private const JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS = 24;             # 1 1000 array with only objects (incl. none)
+	private const JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT = 25;          # 1 1001 array with one single object, return that item
+	private const JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT_NULLABLE = 26; # 1 1010 array with one single object, return that item, or empty array, return null
+	private const JSON_DECODE_ACCEPT_SUCCESS_STRING = 28;               # 1 1100 string "success"
+	private const JSON_DECODE_ACCEPT_SUCCESS_OBJECT = 29;               # 1 1101 object with single "success" property and value true
+
+	/**
+	 * @const string ASCII upper-case characters part of a hexit
+	 */
+	private const HEX_ALPHA_UPPER = 'ABCDEF';
+
+	/**
+	 * @const string ASCII lower-case characters part of a hexit
+	 */
+	private const HEX_ALPHA_LOWER = 'abcdef';
+
+	/**
+	 * @var string Server base URL
+	 */
+	private string $baseurl;
+
+	/**
+	 * @var string Username
+	 */
+	private string $user;
+
+	/**
+	 * @var string Password
+	 */
+	private string $pass;
+
+	private ?CurlHandle $handle = null;
+
+	/**
+	 * @var string
+	 */
+	private string $token = '';
+
+	/**
+	 * constructor
+	 *
+	 * @param string $baseurl
+	 * @param string $user
+	 * @param string $pass
+	 * @param string|null $otp
+	 */
+	public function __construct(string $baseurl, string $user, string $pass, string $otp = null)
+	{
+		if (!(function_exists('curl_version'))) {
+			throw new ConnectionException('PHP-CURL not installed', self::ERROR_CODE_NO_CURL);
+		}
+
+		$this->baseurl = $baseurl;
+		$this->user = $user;
+		$this->pass = $pass;
+		// trigger_error(sprintf("ctor: %s:%s", $user, $pass), E_USER_NOTICE);
+
+		$this->setTokenByUsernameAndPassword($otp);
+	}
+
+	/**
+	 * ping (with authentication)
+	 *
+	 * @link https://download.seafile.com/published/web-api/home.md#user-content-Quick%20Start
+	 *
+	 * @return string "pong"
+	 */
+	public function ping(): string
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/ping/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_STRING,
+		);
+	}
+
+	/**
+	 * get server version
+	 *
+	 * @throws Exception
+	 * @return string
+	 */
+	public function getServerVersion(): string
+	{
+		$serverInfo = $this->getServerInformation();
+		if (
+			!is_string($serverInfo->version ?? null)
+			|| !is_array($serverInfo->features ?? null)
+		) {
+			throw new InvalidResponseException('We could not retrieve list of server features.', self::ERROR_CODE_FEATURES);
+		}
+
+		$isSeafilePro = in_array('seafile-pro', $serverInfo->features, true);
+		$edition = $isSeafilePro ? 'Professional' : 'Community';
+
+		return "$serverInfo->version ($edition)";
+	}
+
+	/**
+	 * get server information
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/server-info.md#user-content-Get%20Server%20Information
+	 *
+	 * @throws Exception
+	 * @return object
+	 */
+	public function getServerInformation(): object
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/server-info/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * check account info
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/account.md#user-content-Check%20Account%20Info
+	 * @return object
+	 */
+	public function checkAccountInfo(): object
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/account/info/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]]
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * list seafile server libraries
+	 *
+	 * that are all libraries a user can access.
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-List%20Libraries
+	 *
+	 * @throws Exception
+	 * @return object[]
+	 */
+	public function listLibraries(): array
+	{
+		return $this->listLibrariesCached(true);
+	}
+
+	/**
+	 * get default library
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Get%20Default%20Library
+	 *
+	 * @return object{exists: bool, repo_id: string}
+	 */
+	public function getDefaultLibrary(): object
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/default-repo/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * create a library
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Create%20Library
+	 *
+	 * @param string $name of library
+	 * @return object
+	 */
+	public function createLibrary(string $name): object
+	{
+		$name = trim($name, "/");
+
+		return $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api2/repos/",
+				['name' => $name],
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * name a library
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Rename%20Library
+	 */
+	public function nameLibrary(string $lib, string $name): void
+	{
+		$lib = $this->verifyLib($lib);
+		$fields = ['repo_name' => $name];
+		$_ = $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api2/repos/$lib/?op=rename",
+				$fields,
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_SUCCESS_STRING,
+		);
+		unset($_);
+	}
+
+	/**
+	 * rename a library
+	 *
+	 * do nothing if the library can not be found
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Rename%20Library
+	 *
+	 * @param string $oldName
+	 * @param string $newName
+	 * @return void
+	 */
+	public function renameLibrary(string $oldName, string $newName): void
+	{
+		$lib = $this->getLibraryIdByLibraryName($oldName);
+		if (null === $lib) {
+			return; // no library to rename
+		}
+
+		$this->nameLibrary($lib, $newName);
+	}
+
+	/**
+	 * delete a library by name
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Delete%20Library
+	 *
+	 * @param string $name
+	 * @return void
+	 */
+	public function deleteLibraryByName(string $name): void
+	{
+		$id = $this->getLibraryIdByLibraryName($name);
+		if (null === $id) {
+			return; // library already gone
+		}
+
+		$this->deleteLibraryById($id);
+	}
+
+	/**
+	 * delete a library by id
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-Delete%20Library
+	 *
+	 * @param string $id
+	 * @return void
+	 */
+	public function deleteLibraryById(string $id): void
+	{
+		$lib = $this->verifyLib($id);
+
+		$_ = $this->jsonDecode(
+			$this->delete(
+				"$this->baseurl/api2/repos/$lib/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_SUCCESS_STRING,
+		);
+		unset($_);
+	}
+
+	/**
+	 * get library info array from path
+	 *
+	 * @param string $libNamedPath with the library name as first component
+	 * @throws Exception
+	 * @throws InvalidResponseException
+	 * @return object with 'id' and 'name' of library, both NULL if not found
+	 */
+	public function getLibraryFromPath(string $libNamedPath): object
+	{
+		$libraries = $this->listLibrariesCached();
+		$libraries = array_column($libraries, null, 'name');
+
+		$name = explode('/', ltrim($this->normalizePath($libNamedPath), '/'), 2)[0];
+
+		return (object)[
+			'id' => $libraries[$name]->id ?? null,
+			'name' => $libraries[$name]->name ?? null,
+		];
+	}
+
+	/**
+	 * list all share links
+	 *
+	 * all folder/file download share links in all libraries created by user.
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-List%20all%20Share%20Links
+	 *
+	 * @return object[]
+	 * @throws Exception
+	 * @throws InvalidResponseException
+	 * @noinspection PhpUnused
+	 */
+	public function listAllShareLinks(): array
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/share-links/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
+		);
+	}
+
+	/**
+	 * Create Share Link
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-Create%20Share%20Link
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param ?string $password [optional]
+	 * @param ?int|DateTimeInterface $expire [optional] number of days to expire (int) or DateTime to expire
+	 * @param ?array $permissions [optional] see seafile api docs
+	 * @return object
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidResponseException
+	 */
+	public function createShareLink(string $lib, string $path, string $password = null, $expire = null, array $permissions = null): object
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+
+		$fields = [
+			'repo_id' => $lib,
+			'path' => $path,
+		];
+		if (null !== $password) {
+			$fields['password'] = $password;
+		}
+		if (null !== $expire) {
+			$expireTime = $expire;
+			if (is_int($expire)) {
+				$expireDays = max(1, min(365, (int)$expire));
+				$expireTime = (new DateTimeImmutable())->add(
+					new \DateInterval("P{$expireDays}D")
+				);
+			}
+			if (!$expireTime instanceof DateTimeInterface) {
+				throw new InvalidArgumentException('Expire type mismatch: ' . gettype($expireTime));
+			}
+			$fields['expiration_time'] = $expireTime->format(\DATE_ATOM);
+		}
+		if (null !== $permissions) {
+			try {
+				$fields['permissions'] = json_encode($permissions, JSON_THROW_ON_ERROR);
+			} /** @noinspection PhpMultipleClassDeclarationsInspection */ catch (JsonException $ex) {
+				throw new InvalidArgumentException('permissions');
+			}
+		}
+
+		return $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api/v2.1/share-links/",
+				$fields,
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * List Share Links of a Library
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-List%20all%20Share%20Links
+	 *
+	 * @param ?string $lib [optional] library id (guid), default/null for all libraries
+	 * @throws Exception
+	 * @return object[]
+	 */
+	public function listShareLinksOfALibrary(string $lib = null): array
+	{
+		$lib = $this->verifyLib($lib ?? '', true);
+
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/share-links/?repo_id=$lib",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
+		);
+	}
+
+	/**
+	 * check password (of a share link by token)
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1-admin/share-links.md#user-content-Check%20Password
+	 *
+	 * @param string $token of share link
+	 * @param string $password in plain
+	 * @return object
+	 * @throws Exception
+	 * @throws InvalidResponseException
+	 * @noinspection PhpUnused
+	 */
+	public function checkShareLinkPassword(string $token, string $password): object
+	{
+		$tokenEncoded = rawurlencode($token);
+
+		return $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api/v2.1/admin/share-links/$tokenEncoded/check-password/",
+				['password' => $password],
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT,
+		);
+	}
+
+	/**
+	 * share Link of a folder (or file)
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-List%20Share%20Link%20of%20a%20Folder%20(File)
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @return object the share link
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidResponseException
+	 * @noinspection PhpUnused
+	 */
+	public function listShareLinksOfAFolder(string $lib, string $path): ?object
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/share-links/?repo_id=$lib&path=$pathEncoded",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT_NULLABLE,
+		);
+	}
+
+	/**
+	 * Delete Share Link
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share-links.md#user-content-Delete%20Share%20Link
+	 *
+	 * @param string $token
+	 * @throws Exception
+	 * @return object success {"success": true}
+	 */
+	public function deleteShareLink(string $token): object
+	{
+		$token = $this->verifyToken($token);
+
+		return $this->jsonDecode(
+			$this->delete(
+				"$this->baseurl/api/v2.1/share-links/$token/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT,
+		);
+	}
+
+	/**
+	 * search user
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/user-search.md#user-content-Search%20User
+	 *
+	 * @param string $search
+	 * @throws Exception
+	 * @return object
+	 */
+	public function searchUser(string $search): object
+	{
+		$searchEncoded = rawurlencode($search);
+
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/search-user/?q=$searchEncoded",
+				[CURLOPT_HTTPHEADER => ['Authorization: Token ' . $this->token]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * list groups for user sharing
+	 *
+	 * @throws Exception
+	 * @throws InvalidResponseException
+	 * @return array|object|string
+	 * @link (undocumented)
+	 *
+	 */
+	public function shareableGroups(): array
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/shareable-groups/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
+		);
+	}
+
+	/**
+	 * Share a Library to Group
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-Share%20a%20Library%20to%20Group
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param int|int[] $group
+	 * @param string|null $permission [optional] r, rw, admin (default: r)
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @return array
+	 */
+	public function shareLibraryPathToGroup(string $lib, string $path, $group, string $permission = null)
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		$fields = [
+			'share_type' => 'group',
+			'group_id' => $group,
+			'permission' => $permission ?? 'r',
+		];
+		return $this->jsonDecode(
+			$this->put(
+				"$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded",
+				$fields,
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * Share a Library to User
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-Share%20a%20Library%20to%20User
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param string $user
+	 * @param string|null $permission [optional] r, rw, admin (default: r)
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @return array
+	 */
+	public function shareLibraryPathToUser(string $lib, string $path, string $user, string $permission = null)
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		$fields = [
+			'share_type' => 'user',
+			'username' => $user,
+			'permission' => $permission ?? 'r',
+		];
+		return $this->jsonDecode(
+			$this->put(
+				"$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded",
+				$fields,
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			// either array of objects -or- failure object
+			self::JSON_DECODE_ACCEPT_ARRAY | self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * Unshare a Library to Group
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-Unshare%20a%20Library%20from%20Group
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param int $group
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @return object
+	 */
+	public function unshareLibraryPathToGroup(string $lib, string $path, int $group): object
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		return $this->jsonDecode(
+			$this->delete(
+				"$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded&share_type=group&group_id=$group",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT,
+		);
+	}
+
+	/**
+	 * Unshare a Library to User
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-Unshare%20a%20Library%20from%20User
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param string|string[] $user
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @return object
+	 */
+	public function unshareLibraryPathToUser(string $lib, string $path, $user): object
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+		$userEncoded = rawurlencode($user);
+
+		return $this->jsonDecode(
+			$this->delete(
+				"$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded&share_type=user&username=$userEncoded",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT,
+		);
+	}
+
+	/**
+	 * list user shares for a library path
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/share.md#user-content-List%20Shared%20Users%20of%20a%20Library
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidResponseException
+	 * @return array<int, object>
+	 */
+	public function listSharesOfLibraryPath(string $lib, string $path): array
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/repos/$lib/dir/shared_items/?p=$pathEncoded",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
+		);
+	}
+
+	/**
+	 * create a new directory
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/directories.md#user-content-Create%20New%20Directory
+	 *
+	 * @param string $lib library id (guid)
+	 * @param string $path of the directory to create (e.g.: "/path/to/new-directory", leading and trailing slashes can be omitted)
+	 * @throws InvalidArgumentException|Exception
+	 * @return string|object the common "success" or the object with error_msg property
+	 */
+	public function createNewDirectory(string $lib, string $path)
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		return $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api2/repos/$lib/dir/?p=$pathEncoded",
+				['operation' => 'mkdir'],
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_STRING | self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * delete a file
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/file.md#user-content-Delete%20File
+	 *
+	 * @param string $lib library id (guid)
+	 * @param string $path of the fle to delete (e.g.: "/path/to/file-to-delete", leading and trailing slashes can be omitted)
+	 * @throws InvalidArgumentException|Exception
+	 * @return string|object the common "success" or the known object with error_msg property
+	 */
+	public function deleteFile(string $lib, string $path)
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		return $this->jsonDecode(
+			$this->delete(
+				"$this->baseurl/api2/repos/$lib/file/?p=$pathEncoded",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_STRING | self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * get a file download URL
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/file.md#user-content-Download%20File
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @return string download URL (http/s)
+	 * @throws InvalidArgumentException|Exception
+	 */
+	public function downloadFile(string $lib, string $path): string
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/repos/$lib/file/?p=$pathEncoded",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_STRING,
+		);
+	}
+
+	/**
+	 * download a file
+	 *
+	 * get file contents of a file in a library
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @throws InvalidArgumentException|Exception
+	 * @return string|false on failure
+	 */
+	public function downloadFileAsBuffer(string $lib, string $path)
+	{
+		$url = $this->downloadFile($lib, $path);
+
+		return $this->get($url);
+	}
+
+	/**
+	 * download a file to a local file
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param string $localPath path to a file - existing or not - on the local file-system
+	 * @throws InvalidArgumentException|Exception
+	 * @return bool success/failure
+	 */
+	public function downloadFileToFile(string $lib, string $path, string $localPath): bool
+	{
+		$handle = fopen($localPath, 'wb');
+		if (false === $handle) {
+			throw new Exception('failed to open local path for writing', self::ERROR_CODE_FILE_IO);
+		}
+
+		try {
+			$result = $this->downloadFileToStream($lib, $path, $handle);
+		} finally {
+			$close = fclose($handle);
+		}
+
+		if (!$close) {
+			throw new Exception('failed to close local path handle', self::ERROR_CODE_FILE_IO);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * download a file to a stream handle
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param resource $handle stream handle
+	 * @throws InvalidArgumentException|Exception
+	 * @return bool success/failure
+	 */
+	public function downloadFileToStream(string $lib, string $path, $handle): bool
+	{
+		$url = $this->downloadFile($lib, $path);
+
+		return $this->get($url, [CURLOPT_RETURNTRANSFER => true, CURLOPT_FILE => $handle]);
+	}
+
+	/**
+	 * list items in directory
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/directories.md#user-content-List%20Items%20in%20Directory
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @return array
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidResponseException
+	 */
+	public function listItemsInDirectory(string $lib, string $path): array
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		$result = $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/repos/$lib/dir/?p=$pathEncoded",
+				[CURLOPT_HTTPHEADER => ['Authorization: Token ' . $this->token]],
+			),
+		);
+
+		if (is_object($result)) {
+			// likely a folder not found.
+			$result = [];
+		}
+
+		return $result;
+	}
+
+	/**
+	 * move a file
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/file.md#user-content-Move%20File
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param string $dstLib
+	 * @param string $dstDir
+	 * @return object
+	 * @throws InvalidArgumentException|Exception
+	 */
+	public function moveFile(string $lib, string $path, string $dstLib, string $dstDir): object
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+		$dstLib = $this->verifyLib($dstLib);
+		$dstDir = $this->normalizePath($dstDir);
+
+		return $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api2/repos/$lib/file/?p=$pathEncoded",
+				['operation' => 'move', 'dst_repo' => $dstLib, 'dst_dir' => $dstDir],
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * rename a file
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/file.md#user-content-Move%20File
+	 *
+	 * @param string $lib library id (guid)
+	 * @param string $path of the file to rename (e.g. "/path/to/file-to-rename")
+	 * @param string $newName new basename for the basename of $path (e.g. "new-file-name")
+	 * @return string|object the common "success" or the known object with error_msg property
+	 * @throws Exception
+	 */
+	public function renameFile(string $lib, string $path, string $newName)
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		$pathEncoded = rawurlencode($path);
+
+		return $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api2/repos/$lib/file/?p=$pathEncoded",
+				['operation' => 'rename', 'newname' => $newName],
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_STRING | self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * simplified file upload routine for string buffer
+	 *
+	 * @param string $lib
+	 * @param string $path
+	 * @param string $buffer
+	 * @throws InvalidArgumentException
+	 * @throws Exception
+	 * @return object
+	 */
+	public function uploadBuffer(string $lib, string $path, string $buffer): object
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+
+		$parentDir = dirname($path);
+		$uploadLink = $this->uploadGetLink($lib, $parentDir);
+		$fileName = basename($path);
+
+		return $this->uploadFileBuffer($uploadLink, $parentDir, '', $buffer, $fileName);
+	}
+
+	/**
+	 * simplified file upload routine for standard file
+	 *
+	 * @param string $lib
+	 * @param string $path path in seafile to upload the file as
+	 * @param string $file path of file to upload
+	 * @throws InvalidArgumentException
+	 * @throws Exception
+	 * @return object
+	 */
+	public function uploadFile(string $lib, string $path, string $file): object
+	{
+		$lib = $this->verifyLib($lib);
+		$path = $this->normalizePath($path);
+		if (!is_file($file) && !is_readable($file)) {
+			throw new InvalidArgumentException(sprintf('Not a readable file: %s', $file));
+		}
+
+		$parentDir = dirname($path);
+		$uploadLink = $this->uploadGetLink($lib, $parentDir);
+		$fileName = basename($path);
+
+		return $this->uploadFilePath($uploadLink, $parentDir, '', $file, $fileName);
+	}
+
+	/**
+	 * upload string buffer as a file
+	 *
+	 * same as {@see SeafileApi::uploadFile()} with the option to upload without a
+	 * concrete file on the system. the temporary file to upload is created
+	 * from the string buffer.
+	 *
+	 * @param string $uploadLink from {@see uploadGetLink}
+	 * @param string $parentDir the parent directory to upload the file to
+	 * @param string $relativePath the name of the file, subdirectories possible (e.g. uploading a folder)
+	 * @param string $buffer file contents to upload as string (not the file-name)
+	 * @param string $fileName to use as basename for the data
+	 * @param bool $replace
+	 * @throws Exception
+	 * @return object
+	 */
+	public function uploadFileBuffer(
+		string $uploadLink, string $parentDir, string $relativePath,
+		string $buffer, string $fileName = 'upload.dat', bool $replace = false
+	): object
+	{
+		$tmpHandle = tmpfile();
+		if (false === $tmpHandle) {
+			throw new Exception('Upload data rejected: Unable to open temporary stream.');
+		}
+
+		$meta = stream_get_meta_data($tmpHandle);
+		$tmpFile = $meta['uri'];
+		if (!is_file($tmpFile)) {
+			fclose($tmpHandle);
+			throw new Exception('Upload data rejected: No file with temporary stream.');
+		}
+
+		$bytes = fwrite($tmpHandle, $buffer);
+		if (false === $bytes) {
+			fclose($tmpHandle);
+			throw new Exception('Upload data rejected: Failed to write to temporary stream.');
+		}
+
+		$diff = strlen($buffer) - $bytes;
+		if ($diff !== 0) {
+			fclose($tmpHandle);
+			throw new Exception(sprintf("Upload data rejected: Unexpected difference writing to temporary stream: %d bytes", $diff));
+		}
+
+		$result = rewind($tmpHandle);
+		if (false === $result) {
+			fclose($tmpHandle);
+			throw new Exception('Upload data rejected: Failed to rewind temporary stream.');
+		}
+
+		$result = $this->uploadFilePath($uploadLink, $parentDir, $relativePath, $tmpFile, $fileName, $replace);
+		fclose($tmpHandle);
+
+		return $result;
+	}
+
+	/**
+	 * upload file
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/file-upload.md#user-content-Upload%20File
+	 *
+	 * @param string $uploadLink from {@see uploadGetLink}
+	 * @param string $parentDir the parent directory to upload a file to
+	 * @param string $relativePath to place the file in under $uploadPath (can include subdirectories)
+	 * @param string $path path of the file to upload
+	 * @param ?string $fileName to use as basename for the file (the name used in Seafile)
+	 * @param bool $replace
+	 * @return object
+	 * @throws Exception
+	 */
+	public function uploadFilePath(
+		string $uploadLink, string $parentDir, string $relativePath,
+		string $path, string $fileName = null, bool $replace = false
+	): object
+	{
+		$parentDir = $this->normalizePath($parentDir);
+		$relativePath = ltrim('/', $this->normalizePath($relativePath));
+		$fileName = $fileName ?? basename($path);
+
+		$fields = [
+			'file' => new CURLFile($path, 'application/octet-stream', $fileName),
+			'parent_dir' => $parentDir,
+			'relative_path' => $relativePath,
+			'replace' => $replace ? '1' : '0',
+		];
+
+		return $this->jsonDecode(
+			$this->post(
+				"$uploadLink?ret-json=1",
+				$fields,
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT,
+		);
+	}
+
+	/**
+	 * get file upload link
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/file-upload.md#user-content-Get%20Upload%20Link
+	 *
+	 * @param string $lib
+	 * @param string $uploadDir the directory to upload file(s) to
+	 * @return string upload link (https?://...)
+	 * @throws InvalidArgumentException|Exception
+	 */
+	public function uploadGetLink(string $lib, string $uploadDir): string
+	{
+		$lib = $this->verifyLib($lib);
+		$uploadDir = $this->normalizePath($uploadDir);
+		$pathEncoded = rawurlencode($uploadDir);
+
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/repos/$lib/upload-link/?p=$pathEncoded",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_STRING,
+		);
+	}
+
+	public function generateUserAuthToken(string $email): object
+	{
+		return $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api/v2.1/admin/generate-user-auth-token/",
+				['email' => $email],
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	public function getUserActivity(string $email, int $page = 1, int $perPage = 25): object
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/admin/user-activities/?user=$email&page=$page&per_page=$perPage",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+	}
+
+	/**
+	 * set authorization token
+	 *
+	 * @param string $token
+	 * @return void
+	 */
+	public function setToken(string $token): void
+	{
+		$this->token = $token;
+	}
+
+	public function listDevices(): array
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/devices/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+		);
+	}
+
+	public function listStarredItems(): object
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/starred-items/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+		);
+	}
+
+	public function listGroups(): object
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/groups/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+		);
+	}
+
+	public function listInvitations(): array
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/invitations/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+		);
+	}
+
+	/**
+	 * @param string $start e.g. date('Y-m-d', time() - 7776000 ); // 3 months
+	 * @param string $end e.g. date('Y-m-d', time());
+	 *
+	 * @return array
+	 */
+	public function getLoginLog(string $start, string $end): array
+	{
+		$start = rawurlencode($start);
+		$end = rawurlencode($end);
+
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/admin/logs/login/?start=$start&end=$end",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+		);
+	}
+
+	public function listUploadLinks(): array
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/upload-links/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+		);
+	}
+
+	public function listRepoApiTokens(string $lib): object
+	{
+		$lib = $this->verifyLib($lib);
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api/v2.1/repos/$lib/repo-api-tokens/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+		);
+	}
+
+	/**
+	 * internal api implementation to get library by name
+	 *
+	 * @param string $name
+	 * @throws Exception
+	 * @return ?string id (guid) of the library, null if library does not exist
+	 */
+	private function getLibraryIdByLibraryName(string $name): ?string
+	{
+		$name = explode('/', $this->normalizePath($name), 2)[1];
+
+		$libraries = $this->listLibrariesCached();
+		$libraries = array_column($libraries, null, 'name');
+		return $libraries[$name]->id ?? null;
+	}
+
+	/**
+	 * List libraries a user can access.
+	 *
+	 * internal api implementation for {@see listLibrariesCached()} and {@see listLibraries()}
+	 *
+	 * @link https://download.seafile.com/published/web-api/v2.1/libraries.md#user-content-List%20Libraries
+	 *
+	 * @throws Exception
+	 * @return object[]
+	 */
+	private function listLibrariesDo(): array
+	{
+		return $this->jsonDecode(
+			$this->get(
+				"$this->baseurl/api2/repos/",
+				[CURLOPT_HTTPHEADER => ["Authorization: Token $this->token"]],
+			),
+			self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS,
+		);
+	}
+
+	/**
+	 * like {@see listLibraries()} but cached.
+	 *
+	 * @param bool $invalidate
+	 * @throws Exception
+	 * @throws InvalidResponseException
+	 * @return void
+	 */
+	private function listLibrariesCached(bool $invalidate = false): array
+	{
+		static $librariesCache;
+
+		return $librariesCache = ($invalidate ? null : $librariesCache) ?? $this->listLibrariesDo();
+	}
+
+	/**
+	 * normalize path
+	 *
+	 * normalizes the path component separator <slash> "/" <U002F> U+002F SOLIDUS
+	 * with first character being the slash, no consecutive slashes within the
+	 * path and no terminating slash.
+	 *
+	 * @param string $path
+	 * @return string
+	 */
+	private function normalizePath(string $path): string
+	{
+		$buffer = rtrim($path, '/');
+		$buffer = preg_replace('~/{2,}~', '/', $buffer);
+		'' === $buffer && $buffer = '/';
+		'/' === $buffer[0] || $buffer = "/$buffer";
+
+		return $buffer;
+	}
+
+	/**
+	 * verify library id
+	 *
+	 * verifies the format of a library id. can be used in URLs
+	 * afterwards. case normalization to lowercase.
+	 *
+	 * example library id strings:
+	 *  - 21b941c2-5411-4372-a514-00b62ab99ef2 (from the docs)
+	 *  - 79144b25-f772-42b6-a1c0-60e6359f5884 (from a server)
+	 *
+	 * @param string $lib
+	 * @param bool $allowEmpty
+	 * @return string library id
+	 */
+	private function verifyLib(string $lib, bool $allowEmpty = false): string
+	{
+		if ($allowEmpty && ('' === $lib)) {
+			return $lib;
+		}
+
+		$buffer = strtr($lib, self::HEX_ALPHA_UPPER, self::HEX_ALPHA_LOWER);
+		$format = '%04x%04x-%04x-%04x-%04x-%04x%04x%04x';
+		$values = sscanf($buffer, $format);
+		$result = vsprintf($format, $values);
+
+		if ($buffer !== $result) {
+			throw new InvalidArgumentException(sprintf('Not a library id: "%s"', $lib));
+		}
+
+		return $result;
+	}
+
+	/**
+	 * verify share link token
+	 *
+	 * verifies the format of a share link token. can be used in URLs
+	 * afterwards. case normalization to lowercase.
+	 *
+	 * @param string $token e.g. "0a29ff44dc0b4b56be74"
+	 * @return string
+	 */
+	private function verifyToken(string $token): string
+	{
+		$buffer = strtr($token, self::HEX_ALPHA_UPPER, self::HEX_ALPHA_LOWER);
+		$format = '%04x%04x%04x%04x%04x';
+		$values = sscanf($buffer, $format);
+		$result = vsprintf($format, $values);
+
+		if ($buffer !== $result) {
+			throw new InvalidArgumentException(sprintf('Not a token: "%s"', $token));
+		}
+
+		return $result;
+	}
+
+	/**
+	 * authenticate class against seafile api
+	 *
+	 * @link https://download.seafile.com/published/web-api/home.md#user-content-Quick%20Start
+	 *
+	 * @param string|null $otp (optional) Seafile OTP (if user uses OTP access)
+	 * @return void
+	 */
+	private function setTokenByUsernameAndPassword(string $otp = null): void
+	{
+		// @auth:token:<email> : password is auth token
+		if (0 === strpos($this->user, $needle = self::USER_PREFIX_AUTH_TOKEN)) {
+			$this->user = \substr($this->user, strlen($needle)) ?: '';
+			$this->token = $this->pass;
+			if ('pong' !== $this->ping()) {
+				throw new ConnectionException('token authentication failure');
+			}
+			return;
+		}
+
+		$data = $this->jsonDecode(
+			$this->post(
+				"$this->baseurl/api2/auth-token/",
+				['username' => $this->user, 'password' => $this->pass],
+				$otp ? [CURLOPT_HTTPHEADER => ["X-SEAFILE-OTP: $otp"]] : [],
+			),
+			self::JSON_DECODE_ACCEPT_OBJECT,
+		);
+		$this->token = (string)$data->token;
+	}
+
+	/**
+	 * http request with get method
+	 *
+	 * @param string $url
+	 * @param array $curlOptions
+	 * @return bool|string
+	 */
+	private function get(string $url, array $curlOptions = [])
+	{
+		$curlOptions += $this->curlSharedOptions;
+
+		return $this->curlExec($url, $curlOptions);
+	}
+
+	/**
+	 * http request with post method
+	 *
+	 * @param string $url
+	 * @param array $fields
+	 * @param array $curlOptions
+	 * @return bool|string
+	 */
+	private function post(string $url, array $fields = [], array $curlOptions = [])
+	{
+		$curlOptions += $this->curlSharedOptions;
+		$curlOptions[CURLOPT_POST] = true;
+		$curlOptions[CURLOPT_POSTFIELDS] = $fields;
+
+		return $this->curlExec($url, $curlOptions);
+	}
+
+	/**
+	 * http request with put method
+	 *
+	 * @param string $url
+	 * @param array $fields
+	 * @param array $curlOptions
+	 * @return bool|string
+	 */
+	public function put(string $url, array $fields = [], array $curlOptions = [])
+	{
+		$curlOptions += $this->curlSharedOptions;
+		$curlOptions[CURLOPT_CUSTOMREQUEST] = 'PUT';
+		$curlOptions[CURLOPT_POSTFIELDS] = $fields;
+
+		return $this->curlExec($url, $curlOptions);
+	}
+
+	/**
+	 * http request with delete method
+	 *
+	 * @param string $url
+	 * @param array $curlOptions
+	 * @return bool|string
+	 */
+	public function delete(string $url, array $curlOptions = [])
+	{
+
+		$curlOptions += $this->curlSharedOptions;
+		$curlOptions[CURLOPT_CUSTOMREQUEST] = 'DELETE';
+
+		return $this->curlExec($url, $curlOptions);
+	}
+
+	/**
+	 * json decode handler
+	 *
+	 * decode json with structural acceptance
+	 *
+	 * @param string $jsonText
+	 * @param int $flags decode accept flag
+	 * @throws InvalidResponseException
+	 * @return string|object|array
+	 */
+	private function jsonDecode(string $jsonText, int $flags = self::JSON_DECODE_ACCEPT_DEFAULT)
+	{
+		$accept = $flags & self::JSON_DECODE_ACCEPT_MASK;
+		if (0 === $accept) {
+			return $jsonText;
+		}
+
+		try {
+			$result = json_decode($jsonText, false, 512, JSON_THROW_ON_ERROR);
+		} /** @noinspection PhpMultipleClassDeclarationsInspection */ catch (JsonException $e) {
+			throw JsonDecodeException::create(sprintf('json decode error of %s', JsonDecodeException::shorten($jsonText)), $jsonText, $e);
+		}
+
+		if (self::JSON_DECODE_ACCEPT_JSON === $accept) {
+			return $result;
+		}
+
+		if (self::JSON_DECODE_ACCEPT_ARRAY_OF_OBJECTS === $accept) {
+			if (is_array($result) && $result === array_filter($result, 'is_object')) {
+				return $result;
+			}
+			throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
+		}
+
+		if (self::JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT_NULLABLE === $accept) {
+			if (is_array($result)
+				&& (
+					(count($result) === 1 && is_object($result[0] ?? null))
+					|| (count($result) === 0)
+				)
+			) {
+				return $result[0] ?? null;
+			}
+			throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
+		}
+
+		if (self::JSON_DECODE_ACCEPT_ARRAY_SINGLE_OBJECT === $accept) {
+			if (is_array($result) && is_object($result[0] ?? null) && count($result) === 1) {
+				return $result[0];
+			}
+			throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
+		}
+
+		if (self::JSON_DECODE_ACCEPT_SUCCESS_OBJECT === $accept) {
+			if (is_object($result) && (array)$result === ['success' => true]) {
+				return $result;
+			}
+			throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
+		}
+
+		if (self::JSON_DECODE_ACCEPT_SUCCESS_STRING === $accept) {
+			if (self::STRING_SUCCESS === $result) {
+				return $result;
+			}
+			throw JsonDecodeException::create(sprintf('json decode accept %5d error [%s] of %s', decbin($accept), gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
+		}
+
+		if (is_string($result) && (self::JSON_DECODE_ACCEPT_STRING !== ($accept & self::JSON_DECODE_ACCEPT_STRING))) {
+			throw JsonDecodeException::create(sprintf('json decode type %s not accepted; of %s', gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
+		}
+
+		if (is_array($result) && (self::JSON_DECODE_ACCEPT_ARRAY !== ($accept & self::JSON_DECODE_ACCEPT_ARRAY))) {
+			throw JsonDecodeException::create(sprintf('json decode type %s not accepted; of %s', gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
+		}
+
+		if (is_object($result) && (self::JSON_DECODE_ACCEPT_OBJECT !== ($accept & self::JSON_DECODE_ACCEPT_OBJECT))) {
+			throw JsonDecodeException::create(sprintf('json decode type %s not accepted; of %s', gettype($result), JsonDecodeException::shorten($jsonText)), $jsonText);
+		}
+
+		return $result;
+	}
+
+
+	/**
+	 * execute curl with url and options
+	 *
+	 * @param string $url
+	 * @param array $options
+	 * @return bool|string
+	 */
+	private function curlExec(string $url, array $options)
+	{
+		$handle = curl_init($url);
+		if (!($handle instanceof CurlHandle)) {
+			throw new ConnectionException('Unable to initialise cURL session.', self::ERROR_CODE_NO_CURL);
+		}
+
+		$this->handle = $handle;
+
+		if (!curl_setopt_array($this->handle, $options)) {
+			throw new Exception("Error setting cURL request options.");
+		}
+		$result = curl_exec($this->handle);
+		$this->curlExecHandleResult($result);
+		curl_close($this->handle);
+
+		return $result;
+	}
+
+	/**
+	 * internal handling of curl_exec() return
+	 *
+	 * {@see curlExec()}
+	 *
+	 * @param bool|string $curlResult return value from curl_exec();
+	 * @throws ConnectionException
+	 * @return void
+	 */
+	private function curlExecHandleResult($curlResult): void
+	{
+		if (empty($curlResult)) {
+			throw new ConnectionException(curl_error($this->handle), -1);
+		}
+
+		$code = (int)curl_getinfo($this->handle)['http_code'];
+
+		$codeIsInErrorRange = $code >= 400 && $code <= 600;
+		$codeIsNotInNonErrorCodes = !in_array($code, [200, 201, 202, 203, 204, 205, 206, 207, 301], true);
+
+		if ($codeIsInErrorRange || $codeIsNotInNonErrorCodes) {
+			ConnectionException::throwCurlResult($code, $curlResult);
+		}
+	}
 }

Braces +15 added lines, -27 removed lines

@@ -122,8 +122,7 @@ 
      * @param string $pass
      * @param string|null $otp
      */
-    public function __construct(string $baseurl, string $user, string $pass, string $otp = null)
-    {
+    public function __construct(string $baseurl, string $user, string $pass, string $otp = null) {
         if (!(function_exists('curl_version'))) {
             throw new ConnectionException('PHP-CURL not installed', self::ERROR_CODE_NO_CURL);
         }
@@ -603,8 +602,7 @@ 
      * @throws InvalidArgumentException
      * @return array
      */
-    public function shareLibraryPathToGroup(string $lib, string $path, $group, string $permission = null)
-    {
+    public function shareLibraryPathToGroup(string $lib, string $path, $group, string $permission = null) {
         $lib = $this->verifyLib($lib);
         $path = $this->normalizePath($path);
         $pathEncoded = rawurlencode($path);
@@ -637,8 +635,7 @@ 
      * @throws InvalidArgumentException
      * @return array
      */
-    public function shareLibraryPathToUser(string $lib, string $path, string $user, string $permission = null)
-    {
+    public function shareLibraryPathToUser(string $lib, string $path, string $user, string $permission = null) {
         $lib = $this->verifyLib($lib);
         $path = $this->normalizePath($path);
         $pathEncoded = rawurlencode($path);
@@ -751,8 +748,7 @@ 
      * @throws InvalidArgumentException|Exception
      * @return string|object the common "success" or the object with error_msg property
      */
-    public function createNewDirectory(string $lib, string $path)
-    {
+    public function createNewDirectory(string $lib, string $path) {
         $lib = $this->verifyLib($lib);
         $path = $this->normalizePath($path);
         $pathEncoded = rawurlencode($path);
@@ -777,8 +773,7 @@ 
      * @throws InvalidArgumentException|Exception
      * @return string|object the common "success" or the known object with error_msg property
      */
-    public function deleteFile(string $lib, string $path)
-    {
+    public function deleteFile(string $lib, string $path) {
         $lib = $this->verifyLib($lib);
         $path = $this->normalizePath($path);
         $pathEncoded = rawurlencode($path);
@@ -827,8 +822,7 @@ 
      * @throws InvalidArgumentException|Exception
      * @return string|false on failure
      */
-    public function downloadFileAsBuffer(string $lib, string $path)
-    {
+    public function downloadFileAsBuffer(string $lib, string $path) {
         $url = $this->downloadFile($lib, $path);
 
         return $this->get($url);
@@ -852,7 +846,8 @@ 
 
         try {
             $result = $this->downloadFileToStream($lib, $path, $handle);
-        } finally {
+        }
+        finally {
             $close = fclose($handle);
         }
 
@@ -953,8 +948,7 @@ 
      * @return string|object the common "success" or the known object with error_msg property
      * @throws Exception
      */
-    public function renameFile(string $lib, string $path, string $newName)
-    {
+    public function renameFile(string $lib, string $path, string $newName) {
         $lib = $this->verifyLib($lib);
         $path = $this->normalizePath($path);
         $pathEncoded = rawurlencode($path);
@@ -1417,8 +1411,7 @@ 
      * @param array $curlOptions
      * @return bool|string
      */
-    private function get(string $url, array $curlOptions = [])
-    {
+    private function get(string $url, array $curlOptions = []) {
         $curlOptions += $this->curlSharedOptions;
 
         return $this->curlExec($url, $curlOptions);
@@ -1432,8 +1425,7 @@ 
      * @param array $curlOptions
      * @return bool|string
      */
-    private function post(string $url, array $fields = [], array $curlOptions = [])
-    {
+    private function post(string $url, array $fields = [], array $curlOptions = []) {
         $curlOptions += $this->curlSharedOptions;
         $curlOptions[CURLOPT_POST] = true;
         $curlOptions[CURLOPT_POSTFIELDS] = $fields;
@@ -1449,8 +1441,7 @@ 
      * @param array $curlOptions
      * @return bool|string
      */
-    public function put(string $url, array $fields = [], array $curlOptions = [])
-    {
+    public function put(string $url, array $fields = [], array $curlOptions = []) {
         $curlOptions += $this->curlSharedOptions;
         $curlOptions[CURLOPT_CUSTOMREQUEST] = 'PUT';
         $curlOptions[CURLOPT_POSTFIELDS] = $fields;
@@ -1465,8 +1456,7 @@ 
      * @param array $curlOptions
      * @return bool|string
      */
-    public function delete(string $url, array $curlOptions = [])
-    {
+    public function delete(string $url, array $curlOptions = []) {
 
         $curlOptions += $this->curlSharedOptions;
         $curlOptions[CURLOPT_CUSTOMREQUEST] = 'DELETE';
@@ -1484,8 +1474,7 @@ 
      * @throws InvalidResponseException
      * @return string|object|array
      */
-    private function jsonDecode(string $jsonText, int $flags = self::JSON_DECODE_ACCEPT_DEFAULT)
-    {
+    private function jsonDecode(string $jsonText, int $flags = self::JSON_DECODE_ACCEPT_DEFAULT) {
         $accept = $flags & self::JSON_DECODE_ACCEPT_MASK;
         if (0 === $accept) {
             return $jsonText;
@@ -1564,8 +1553,7 @@ 
      * @param array $options
      * @return bool|string
      */
-    private function curlExec(string $url, array $options)
-    {
+    private function curlExec(string $url, array $options) {
         $handle = curl_init($url);
         if (!($handle instanceof CurlHandle)) {
             throw new ConnectionException('Unable to initialise cURL session.', self::ERROR_CODE_NO_CURL);