nextcloud / server

lib/public/Share/IShare.php

Indentation +304 added lines, -304 removed lines

@@ -37,308 +37,308 @@
  */
 interface IShare {
 
-	/**
-	 * Set the internal id of the share
-	 * It is only allowed to set the internal id of a share once.
-	 * Attempts to override the internal id will result in an IllegalIDChangeException
-	 *
-	 * @param string $id
-	 * @return \OCP\Share\IShare
-	 * @throws IllegalIDChangeException
-	 * @throws \InvalidArgumentException
-	 * @since 9.1.0
-	 */
-	public function setId($id);
-
-	/**
-	 * Get the internal id of the share.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getId();
-
-	/**
-	 * Get the full share id. This is the <providerid>:<internalid>.
-	 * The full id is unique in the system.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 * @throws \UnexpectedValueException If the fullId could not be constructed
-	 */
-	public function getFullId();
-
-	/**
-	 * Set the provider id of the share
-	 * It is only allowed to set the provider id of a share once.
-	 * Attempts to override the provider id will result in an IllegalIDChangeException
-	 *
-	 * @param string $id
-	 * @return \OCP\Share\IShare
-	 * @throws IllegalIDChangeException
-	 * @throws \InvalidArgumentException
-	 * @since 9.1.0
-	 */
-	public function setProviderId($id);
-
-	/**
-	 * Set the node of the file/folder that is shared
-	 *
-	 * @param Node $node
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setNode(Node $node);
-
-	/**
-	 * Get the node of the file/folder that is shared
-	 *
-	 * @return File|Folder
-	 * @since 9.0.0
-	 * @throws NotFoundException
-	 */
-	public function getNode();
-
-	/**
-	 * Set file id for lazy evaluation of the node
-	 * @param int $fileId
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setNodeId($fileId);
-
-	/**
-	 * Get the fileid of the node of this share
-	 * @return int
-	 * @since 9.0.0
-	 * @throws NotFoundException
-	 */
-	public function getNodeId();
-
-	/**
-	 * Set the type of node (file/folder)
-	 *
-	 * @param string $type
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setNodeType($type);
-
-	/**
-	 * Get the type of node (file/folder)
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 * @throws NotFoundException
-	 */
-	public function getNodeType();
-
-	/**
-	 * Set the shareType
-	 *
-	 * @param int $shareType
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setShareType($shareType);
-
-	/**
-	 * Get the shareType
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getShareType();
-
-	/**
-	 * Set the receiver of this share.
-	 *
-	 * @param string $sharedWith
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setSharedWith($sharedWith);
-
-	/**
-	 * Get the receiver of this share.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getSharedWith();
-
-	/**
-	 * Set the permissions.
-	 * See \OCP\Constants::PERMISSION_*
-	 *
-	 * @param int $permissions
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setPermissions($permissions);
-
-	/**
-	 * Get the share permissions
-	 * See \OCP\Constants::PERMISSION_*
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getPermissions();
-
-	/**
-	 * Set the expiration date
-	 *
-	 * @param null|\DateTime $expireDate
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setExpirationDate($expireDate);
-
-	/**
-	 * Get the expiration date
-	 *
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getExpirationDate();
-
-	/**
-	 * Set the sharer of the path.
-	 *
-	 * @param string $sharedBy
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setSharedBy($sharedBy);
-
-	/**
-	 * Get share sharer
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getSharedBy();
-
-	/**
-	 * Set the original share owner (who owns the path that is shared)
-	 *
-	 * @param string $shareOwner
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setShareOwner($shareOwner);
-
-	/**
-	 * Get the original share owner (who owns the path that is shared)
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getShareOwner();
-
-	/**
-	 * Set the password for this share.
-	 * When the share is passed to the share manager to be created
-	 * or updated the password will be hashed.
-	 *
-	 * @param string $password
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setPassword($password);
-
-	/**
-	 * Get the password of this share.
-	 * If this share is obtained via a shareprovider the password is
-	 * hashed.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getPassword();
-
-	/**
-	 * Set the public link token.
-	 *
-	 * @param string $token
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setToken($token);
-
-	/**
-	 * Get the public link token.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getToken();
-
-	/**
-	 * Set the target path of this share relative to the recipients user folder.
-	 *
-	 * @param string $target
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setTarget($target);
-
-	/**
-	 * Get the target path of this share relative to the recipients user folder.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getTarget();
-
-	/**
-	 * Set the time this share was created
-	 *
-	 * @param \DateTime $shareTime
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setShareTime(\DateTime $shareTime);
-
-	/**
-	 * Get the timestamp this share was created
-	 *
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getShareTime();
-
-	/**
-	 * Set if the recipient is informed by mail about the share.
-	 *
-	 * @param bool $mailSend
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 9.0.0
-	 */
-	public function setMailSend($mailSend);
-
-	/**
-	 * Get if the recipient informed by mail about the share.
-	 *
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function getMailSend();
-
-	/**
-	 * Set the cache entry for the shared node
-	 *
-	 * @param ICacheEntry $entry
-	 * @since 11.0.0
-	 */
-	public function setNodeCacheEntry(ICacheEntry $entry);
-
-	/**
-	 * Get the cache entry for the shared node
-	 *
-	 * @return null|ICacheEntry
-	 * @since 11.0.0
-	 */
-	public function getNodeCacheEntry();
+    /**
+     * Set the internal id of the share
+     * It is only allowed to set the internal id of a share once.
+     * Attempts to override the internal id will result in an IllegalIDChangeException
+     *
+     * @param string $id
+     * @return \OCP\Share\IShare
+     * @throws IllegalIDChangeException
+     * @throws \InvalidArgumentException
+     * @since 9.1.0
+     */
+    public function setId($id);
+
+    /**
+     * Get the internal id of the share.
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getId();
+
+    /**
+     * Get the full share id. This is the <providerid>:<internalid>.
+     * The full id is unique in the system.
+     *
+     * @return string
+     * @since 9.0.0
+     * @throws \UnexpectedValueException If the fullId could not be constructed
+     */
+    public function getFullId();
+
+    /**
+     * Set the provider id of the share
+     * It is only allowed to set the provider id of a share once.
+     * Attempts to override the provider id will result in an IllegalIDChangeException
+     *
+     * @param string $id
+     * @return \OCP\Share\IShare
+     * @throws IllegalIDChangeException
+     * @throws \InvalidArgumentException
+     * @since 9.1.0
+     */
+    public function setProviderId($id);
+
+    /**
+     * Set the node of the file/folder that is shared
+     *
+     * @param Node $node
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setNode(Node $node);
+
+    /**
+     * Get the node of the file/folder that is shared
+     *
+     * @return File|Folder
+     * @since 9.0.0
+     * @throws NotFoundException
+     */
+    public function getNode();
+
+    /**
+     * Set file id for lazy evaluation of the node
+     * @param int $fileId
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setNodeId($fileId);
+
+    /**
+     * Get the fileid of the node of this share
+     * @return int
+     * @since 9.0.0
+     * @throws NotFoundException
+     */
+    public function getNodeId();
+
+    /**
+     * Set the type of node (file/folder)
+     *
+     * @param string $type
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setNodeType($type);
+
+    /**
+     * Get the type of node (file/folder)
+     *
+     * @return string
+     * @since 9.0.0
+     * @throws NotFoundException
+     */
+    public function getNodeType();
+
+    /**
+     * Set the shareType
+     *
+     * @param int $shareType
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setShareType($shareType);
+
+    /**
+     * Get the shareType
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getShareType();
+
+    /**
+     * Set the receiver of this share.
+     *
+     * @param string $sharedWith
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setSharedWith($sharedWith);
+
+    /**
+     * Get the receiver of this share.
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getSharedWith();
+
+    /**
+     * Set the permissions.
+     * See \OCP\Constants::PERMISSION_*
+     *
+     * @param int $permissions
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setPermissions($permissions);
+
+    /**
+     * Get the share permissions
+     * See \OCP\Constants::PERMISSION_*
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getPermissions();
+
+    /**
+     * Set the expiration date
+     *
+     * @param null|\DateTime $expireDate
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setExpirationDate($expireDate);
+
+    /**
+     * Get the expiration date
+     *
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getExpirationDate();
+
+    /**
+     * Set the sharer of the path.
+     *
+     * @param string $sharedBy
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setSharedBy($sharedBy);
+
+    /**
+     * Get share sharer
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getSharedBy();
+
+    /**
+     * Set the original share owner (who owns the path that is shared)
+     *
+     * @param string $shareOwner
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setShareOwner($shareOwner);
+
+    /**
+     * Get the original share owner (who owns the path that is shared)
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getShareOwner();
+
+    /**
+     * Set the password for this share.
+     * When the share is passed to the share manager to be created
+     * or updated the password will be hashed.
+     *
+     * @param string $password
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setPassword($password);
+
+    /**
+     * Get the password of this share.
+     * If this share is obtained via a shareprovider the password is
+     * hashed.
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getPassword();
+
+    /**
+     * Set the public link token.
+     *
+     * @param string $token
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setToken($token);
+
+    /**
+     * Get the public link token.
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getToken();
+
+    /**
+     * Set the target path of this share relative to the recipients user folder.
+     *
+     * @param string $target
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setTarget($target);
+
+    /**
+     * Get the target path of this share relative to the recipients user folder.
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getTarget();
+
+    /**
+     * Set the time this share was created
+     *
+     * @param \DateTime $shareTime
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setShareTime(\DateTime $shareTime);
+
+    /**
+     * Get the timestamp this share was created
+     *
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getShareTime();
+
+    /**
+     * Set if the recipient is informed by mail about the share.
+     *
+     * @param bool $mailSend
+     * @return \OCP\Share\IShare The modified object
+     * @since 9.0.0
+     */
+    public function setMailSend($mailSend);
+
+    /**
+     * Get if the recipient informed by mail about the share.
+     *
+     * @return bool
+     * @since 9.0.0
+     */
+    public function getMailSend();
+
+    /**
+     * Set the cache entry for the shared node
+     *
+     * @param ICacheEntry $entry
+     * @since 11.0.0
+     */
+    public function setNodeCacheEntry(ICacheEntry $entry);
+
+    /**
+     * Get the cache entry for the shared node
+     *
+     * @return null|ICacheEntry
+     * @since 11.0.0
+     */
+    public function getNodeCacheEntry();
 }

apps/files_sharing/lib/Capabilities.php

Indentation +80 added lines, -80 removed lines

@@ -32,84 +32,84 @@
  */
 class Capabilities implements ICapability {
 
-	/** @var IConfig */
-	private $config;
-
-	/** @var IAppManager */
-	private $appManager;
-
-	public function __construct(IConfig $config, IAppManager $appManager) {
-		$this->config = $config;
-		$this->appManager = $appManager;
-	}
-
-	/**
-	 * Return this classes capabilities
-	 *
-	 * @return array
-	 */
-	public function getCapabilities() {
-		$res = [];
-
-		if ($this->config->getAppValue('core', 'shareapi_enabled', 'yes') !== 'yes') {
-			$res['api_enabled'] = false;
-			$res['public'] = ['enabled' => false];
-			$res['user'] = ['send_mail' => false];
-			$res['resharing'] = false;
-		} else {
-			$res['api_enabled'] = true;
-
-			$public = [];
-			$public['enabled'] = $this->config->getAppValue('core', 'shareapi_allow_links', 'yes') === 'yes';
-			if ($public['enabled']) {
-				$public['password'] = [];
-				$public['password']['enforced'] = ($this->config->getAppValue('core', 'shareapi_enforce_links_password', 'no') === 'yes');
-
-				$public['expire_date'] = [];
-				$public['expire_date']['enabled'] = $this->config->getAppValue('core', 'shareapi_default_expire_date', 'no') === 'yes';
-				if ($public['expire_date']['enabled']) {
-					$public['expire_date']['days'] = $this->config->getAppValue('core', 'shareapi_expire_after_n_days', '7');
-					$public['expire_date']['enforced'] = $this->config->getAppValue('core', 'shareapi_enforce_expire_date', 'no') === 'yes';
-				}
-
-				$public['send_mail'] = $this->config->getAppValue('core', 'shareapi_allow_public_notification', 'no') === 'yes';
-				$public['upload'] = $this->config->getAppValue('core', 'shareapi_allow_public_upload', 'yes') === 'yes';
-				$public['upload_files_drop'] = $public['upload'];
-			}
-			$res["public"] = $public;
-
-			$res['resharing'] = $this->config->getAppValue('core', 'shareapi_allow_resharing', 'yes') === 'yes';
-
-			$res['user']['send_mail'] = false;
-			$res['user']['expire_date']['enabled'] = true;
-
-			// deprecated in favour of 'group', but we need to keep it for now
-			// in order to stay compatible with older clients
-			$res['group_sharing'] = $this->config->getAppValue('core', 'shareapi_allow_group_sharing', 'yes') === 'yes';
-
-			$res['group'] = [];
-			$res['group']['enabled'] = $this->config->getAppValue('core', 'shareapi_allow_group_sharing', 'yes') === 'yes';
-			$res['group']['expire_date']['enabled'] = true;
-		}
-
-		//Federated sharing
-		$res['federation'] = [
-			'outgoing'  => $this->config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes') === 'yes',
-			'incoming' => $this->config->getAppValue('files_sharing', 'incoming_server2server_share_enabled', 'yes') === 'yes',
-			'expire_date' => ['enabled' => true]
-		];
-
-		if ($this->appManager->isEnabledForUser('sharebymail')) {
-			$res['mailshare'] = [
-				'enabled' => true,
-				'upload_files_drop' => ['enabled' => true],
-				'password' => ['enabled' => true],
-				'expire_date' => ['enabled' => true]
-			];
-		}
-
-		return [
-			'files_sharing' => $res,
-		];
-	}
+    /** @var IConfig */
+    private $config;
+
+    /** @var IAppManager */
+    private $appManager;
+
+    public function __construct(IConfig $config, IAppManager $appManager) {
+        $this->config = $config;
+        $this->appManager = $appManager;
+    }
+
+    /**
+     * Return this classes capabilities
+     *
+     * @return array
+     */
+    public function getCapabilities() {
+        $res = [];
+
+        if ($this->config->getAppValue('core', 'shareapi_enabled', 'yes') !== 'yes') {
+            $res['api_enabled'] = false;
+            $res['public'] = ['enabled' => false];
+            $res['user'] = ['send_mail' => false];
+            $res['resharing'] = false;
+        } else {
+            $res['api_enabled'] = true;
+
+            $public = [];
+            $public['enabled'] = $this->config->getAppValue('core', 'shareapi_allow_links', 'yes') === 'yes';
+            if ($public['enabled']) {
+                $public['password'] = [];
+                $public['password']['enforced'] = ($this->config->getAppValue('core', 'shareapi_enforce_links_password', 'no') === 'yes');
+
+                $public['expire_date'] = [];
+                $public['expire_date']['enabled'] = $this->config->getAppValue('core', 'shareapi_default_expire_date', 'no') === 'yes';
+                if ($public['expire_date']['enabled']) {
+                    $public['expire_date']['days'] = $this->config->getAppValue('core', 'shareapi_expire_after_n_days', '7');
+                    $public['expire_date']['enforced'] = $this->config->getAppValue('core', 'shareapi_enforce_expire_date', 'no') === 'yes';
+                }
+
+                $public['send_mail'] = $this->config->getAppValue('core', 'shareapi_allow_public_notification', 'no') === 'yes';
+                $public['upload'] = $this->config->getAppValue('core', 'shareapi_allow_public_upload', 'yes') === 'yes';
+                $public['upload_files_drop'] = $public['upload'];
+            }
+            $res["public"] = $public;
+
+            $res['resharing'] = $this->config->getAppValue('core', 'shareapi_allow_resharing', 'yes') === 'yes';
+
+            $res['user']['send_mail'] = false;
+            $res['user']['expire_date']['enabled'] = true;
+
+            // deprecated in favour of 'group', but we need to keep it for now
+            // in order to stay compatible with older clients
+            $res['group_sharing'] = $this->config->getAppValue('core', 'shareapi_allow_group_sharing', 'yes') === 'yes';
+
+            $res['group'] = [];
+            $res['group']['enabled'] = $this->config->getAppValue('core', 'shareapi_allow_group_sharing', 'yes') === 'yes';
+            $res['group']['expire_date']['enabled'] = true;
+        }
+
+        //Federated sharing
+        $res['federation'] = [
+            'outgoing'  => $this->config->getAppValue('files_sharing', 'outgoing_server2server_share_enabled', 'yes') === 'yes',
+            'incoming' => $this->config->getAppValue('files_sharing', 'incoming_server2server_share_enabled', 'yes') === 'yes',
+            'expire_date' => ['enabled' => true]
+        ];
+
+        if ($this->appManager->isEnabledForUser('sharebymail')) {
+            $res['mailshare'] = [
+                'enabled' => true,
+                'upload_files_drop' => ['enabled' => true],
+                'password' => ['enabled' => true],
+                'expire_date' => ['enabled' => true]
+            ];
+        }
+
+        return [
+            'files_sharing' => $res,
+        ];
+    }
 }