nextcloud / server

lib/public/Share/IShare.php

Indentation +522 added lines, -522 removed lines

@@ -43,526 +43,526 @@
  */
 interface IShare {
 
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_USER = 0;
-
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_GROUP = 1;
-
-	/**
-	 * @internal
-	 * @since 18.0.0
-	 */
-	public const TYPE_USERGROUP = 2;
-
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_LINK = 3;
-
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_EMAIL = 4;
-
-	/**
-	 * ToDo Check if it is still in use otherwise remove it
-	 * @since 17.0.0
-	 */
-	// public const TYPE_CONTACT = 5;
-
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_REMOTE = 6;
-
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_CIRCLE = 7;
-
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_GUEST = 8;
-
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_REMOTE_GROUP = 9;
-
-	/**
-	 * @since 17.0.0
-	 */
-	public const TYPE_ROOM = 10;
-
-	/**
-	 * Internal type used by RoomShareProvider
-	 * @since 17.0.0
-	 */
-	// const TYPE_USERROOM = 11;
-
-	/**
-	 * @since 18.0.0
-	 */
-	public const STATUS_PENDING = 0;
-
-	/**
-	 * @since 18.0.0
-	 */
-	public const STATUS_ACCEPTED = 1;
-
-	/**
-	 * @since 18.0.0
-	 */
-	public const STATUS_REJECTED = 2;
-
-	/**
-	 * 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 display name of the receiver of this share.
-	 *
-	 * @param string $displayName
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 14.0.0
-	 */
-	public function setSharedWithDisplayName($displayName);
-
-	/**
-	 * Get the display name of the receiver of this share.
-	 *
-	 * @return string
-	 * @since 14.0.0
-	 */
-	public function getSharedWithDisplayName();
-
-	/**
-	 * Set the avatar of the receiver of this share.
-	 *
-	 * @param string $src
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 14.0.0
-	 */
-	public function setSharedWithAvatar($src);
-
-	/**
-	 * Get the avatar of the receiver of this share.
-	 *
-	 * @return string
-	 * @since 14.0.0
-	 */
-	public function getSharedWithAvatar();
-
-	/**
-	 * 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 accepted status
-	 * See self::STATUS_*
-	 *
-	 * @param int $status
-	 * @return IShare The modified object
-	 * @since 18.0.0
-	 */
-	public function setStatus(int $status): IShare;
-
-	/**
-	 * Get the accepted status
-	 * See self::STATUS_*
-	 *
-	 * @return int
-	 * @since 18.0.0
-	 */
-	public function getStatus(): int;
-
-	/**
-	 * Attach a note to a share
-	 *
-	 * @param string $note
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 14.0.0
-	 */
-	public function setNote($note);
-
-	/**
-	 * Get note attached to a share
-	 *
-	 * @return string
-	 * @since 14.0.0
-	 */
-	public function getNote();
-
-
-	/**
-	 * 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();
-
-	/**
-	 * Is the share expired ?
-	 *
-	 * @return boolean
-	 * @since 18.0.0
-	 */
-	public function isExpired();
-
-	/**
-	 * set a label for a share, some shares, e.g. public links can have a label
-	 *
-	 * @param string $label
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 15.0.0
-	 */
-	public function setLabel($label);
-
-	/**
-	 * get label for the share, some shares, e.g. public links can have a label
-	 *
-	 * @return string
-	 * @since 15.0.0
-	 */
-	public function getLabel();
-
-	/**
-	 * 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 if the recipient can start a conversation with the owner to get the
-	 * password using Nextcloud Talk.
-	 *
-	 * @param bool $sendPasswordByTalk
-	 * @return \OCP\Share\IShare The modified object
-	 * @since 14.0.0
-	 */
-	public function setSendPasswordByTalk(bool $sendPasswordByTalk);
-
-	/**
-	 * Get if the recipient can start a conversation with the owner to get the
-	 * password using Nextcloud Talk.
-	 * The returned value does not take into account other factors, like Talk
-	 * being enabled for the owner of the share or not; it just cover whether
-	 * the option is enabled for the share itself or not.
-	 *
-	 * @return bool
-	 * @since 14.0.0
-	 */
-	public function getSendPasswordByTalk(): bool;
-
-	/**
-	 * 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();
-
-	/**
-	 * Sets a shares hide download state
-	 * This is mainly for public shares. It will signal that the share page should
-	 * hide download buttons etc.
-	 *
-	 * @param bool $hide
-	 * @return IShare
-	 * @since 15.0.0
-	 */
-	public function setHideDownload(bool $hide): IShare;
-
-	/**
-	 * Gets a shares hide download state
-	 * This is mainly for public shares. It will signal that the share page should
-	 * hide download buttons etc.
-	 *
-	 * @return bool
-	 * @since 15.0.0
-	 */
-	public function getHideDownload(): bool;
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_USER = 0;
+
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_GROUP = 1;
+
+    /**
+     * @internal
+     * @since 18.0.0
+     */
+    public const TYPE_USERGROUP = 2;
+
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_LINK = 3;
+
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_EMAIL = 4;
+
+    /**
+     * ToDo Check if it is still in use otherwise remove it
+     * @since 17.0.0
+     */
+    // public const TYPE_CONTACT = 5;
+
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_REMOTE = 6;
+
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_CIRCLE = 7;
+
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_GUEST = 8;
+
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_REMOTE_GROUP = 9;
+
+    /**
+     * @since 17.0.0
+     */
+    public const TYPE_ROOM = 10;
+
+    /**
+     * Internal type used by RoomShareProvider
+     * @since 17.0.0
+     */
+    // const TYPE_USERROOM = 11;
+
+    /**
+     * @since 18.0.0
+     */
+    public const STATUS_PENDING = 0;
+
+    /**
+     * @since 18.0.0
+     */
+    public const STATUS_ACCEPTED = 1;
+
+    /**
+     * @since 18.0.0
+     */
+    public const STATUS_REJECTED = 2;
+
+    /**
+     * 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 display name of the receiver of this share.
+     *
+     * @param string $displayName
+     * @return \OCP\Share\IShare The modified object
+     * @since 14.0.0
+     */
+    public function setSharedWithDisplayName($displayName);
+
+    /**
+     * Get the display name of the receiver of this share.
+     *
+     * @return string
+     * @since 14.0.0
+     */
+    public function getSharedWithDisplayName();
+
+    /**
+     * Set the avatar of the receiver of this share.
+     *
+     * @param string $src
+     * @return \OCP\Share\IShare The modified object
+     * @since 14.0.0
+     */
+    public function setSharedWithAvatar($src);
+
+    /**
+     * Get the avatar of the receiver of this share.
+     *
+     * @return string
+     * @since 14.0.0
+     */
+    public function getSharedWithAvatar();
+
+    /**
+     * 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 accepted status
+     * See self::STATUS_*
+     *
+     * @param int $status
+     * @return IShare The modified object
+     * @since 18.0.0
+     */
+    public function setStatus(int $status): IShare;
+
+    /**
+     * Get the accepted status
+     * See self::STATUS_*
+     *
+     * @return int
+     * @since 18.0.0
+     */
+    public function getStatus(): int;
+
+    /**
+     * Attach a note to a share
+     *
+     * @param string $note
+     * @return \OCP\Share\IShare The modified object
+     * @since 14.0.0
+     */
+    public function setNote($note);
+
+    /**
+     * Get note attached to a share
+     *
+     * @return string
+     * @since 14.0.0
+     */
+    public function getNote();
+
+
+    /**
+     * 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();
+
+    /**
+     * Is the share expired ?
+     *
+     * @return boolean
+     * @since 18.0.0
+     */
+    public function isExpired();
+
+    /**
+     * set a label for a share, some shares, e.g. public links can have a label
+     *
+     * @param string $label
+     * @return \OCP\Share\IShare The modified object
+     * @since 15.0.0
+     */
+    public function setLabel($label);
+
+    /**
+     * get label for the share, some shares, e.g. public links can have a label
+     *
+     * @return string
+     * @since 15.0.0
+     */
+    public function getLabel();
+
+    /**
+     * 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 if the recipient can start a conversation with the owner to get the
+     * password using Nextcloud Talk.
+     *
+     * @param bool $sendPasswordByTalk
+     * @return \OCP\Share\IShare The modified object
+     * @since 14.0.0
+     */
+    public function setSendPasswordByTalk(bool $sendPasswordByTalk);
+
+    /**
+     * Get if the recipient can start a conversation with the owner to get the
+     * password using Nextcloud Talk.
+     * The returned value does not take into account other factors, like Talk
+     * being enabled for the owner of the share or not; it just cover whether
+     * the option is enabled for the share itself or not.
+     *
+     * @return bool
+     * @since 14.0.0
+     */
+    public function getSendPasswordByTalk(): bool;
+
+    /**
+     * 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();
+
+    /**
+     * Sets a shares hide download state
+     * This is mainly for public shares. It will signal that the share page should
+     * hide download buttons etc.
+     *
+     * @param bool $hide
+     * @return IShare
+     * @since 15.0.0
+     */
+    public function setHideDownload(bool $hide): IShare;
+
+    /**
+     * Gets a shares hide download state
+     * This is mainly for public shares. It will signal that the share page should
+     * hide download buttons etc.
+     *
+     * @return bool
+     * @since 15.0.0
+     */
+    public function getHideDownload(): bool;
 }

apps/files_sharing/lib/MountProvider.php

Indentation +200 added lines, -200 removed lines

@@ -40,204 +40,204 @@
 use OCP\Share\IShare;
 
 class MountProvider implements IMountProvider {
-	/**
-	 * @var \OCP\IConfig
-	 */
-	protected $config;
-
-	/**
-	 * @var IManager
-	 */
-	protected $shareManager;
-
-	/**
-	 * @var ILogger
-	 */
-	protected $logger;
-
-	/**
-	 * @param \OCP\IConfig $config
-	 * @param IManager $shareManager
-	 * @param ILogger $logger
-	 */
-	public function __construct(IConfig $config, IManager $shareManager, ILogger $logger) {
-		$this->config = $config;
-		$this->shareManager = $shareManager;
-		$this->logger = $logger;
-	}
-
-
-	/**
-	 * Get all mountpoints applicable for the user and check for shares where we need to update the etags
-	 *
-	 * @param \OCP\IUser $user
-	 * @param \OCP\Files\Storage\IStorageFactory $storageFactory
-	 * @return \OCP\Files\Mount\IMountPoint[]
-	 */
-	public function getMountsForUser(IUser $user, IStorageFactory $storageFactory) {
-		$shares = $this->shareManager->getSharedWith($user->getUID(), \OCP\Share::SHARE_TYPE_USER, null, -1);
-		$shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), \OCP\Share::SHARE_TYPE_GROUP, null, -1));
-		$shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), \OCP\Share::SHARE_TYPE_CIRCLE, null, -1));
-		$shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), \OCP\Share::SHARE_TYPE_ROOM, null, -1));
-
-		// filter out excluded shares and group shares that includes self
-		$shares = array_filter($shares, function (\OCP\Share\IShare $share) use ($user) {
-			return $share->getPermissions() > 0 && $share->getShareOwner() !== $user->getUID();
-		});
-
-		$superShares = $this->buildSuperShares($shares, $user);
-
-		$mounts = [];
-		$view = new View('/' . $user->getUID() . '/files');
-		$ownerViews = [];
-		$sharingDisabledForUser = $this->shareManager->sharingDisabledForUser($user->getUID());
-		$foldersExistCache = new CappedMemoryCache();
-		foreach ($superShares as $share) {
-			try {
-				/** @var \OCP\Share\IShare $parentShare */
-				$parentShare = $share[0];
-
-				if ($parentShare->getStatus() !== IShare::STATUS_ACCEPTED &&
-					($parentShare->getShareType() === IShare::TYPE_GROUP ||
-						$parentShare->getShareType() === IShare::TYPE_USERGROUP ||
-						$parentShare->getShareType() === IShare::TYPE_USER)) {
-					continue;
-				}
-
-				$owner = $parentShare->getShareOwner();
-				if (!isset($ownerViews[$owner])) {
-					$ownerViews[$owner] = new View('/' . $parentShare->getShareOwner() . '/files');
-				}
-				$mount = new SharedMount(
-					'\OCA\Files_Sharing\SharedStorage',
-					$mounts,
-					[
-						'user' => $user->getUID(),
-						// parent share
-						'superShare' => $parentShare,
-						// children/component of the superShare
-						'groupedShares' => $share[1],
-						'ownerView' => $ownerViews[$owner],
-						'sharingDisabledForUser' => $sharingDisabledForUser
-					],
-					$storageFactory,
-					$view,
-					$foldersExistCache
-				);
-				$mounts[$mount->getMountPoint()] = $mount;
-			} catch (\Exception $e) {
-				$this->logger->logException($e);
-				$this->logger->error('Error while trying to create shared mount');
-			}
-		}
-
-		// array_filter removes the null values from the array
-		return array_values(array_filter($mounts));
-	}
-
-	/**
-	 * Groups shares by path (nodeId) and target path
-	 *
-	 * @param \OCP\Share\IShare[] $shares
-	 * @return \OCP\Share\IShare[][] array of grouped shares, each element in the
-	 * array is a group which itself is an array of shares
-	 */
-	private function groupShares(array $shares) {
-		$tmp = [];
-
-		foreach ($shares as $share) {
-			if (!isset($tmp[$share->getNodeId()])) {
-				$tmp[$share->getNodeId()] = [];
-			}
-			$tmp[$share->getNodeId()][] = $share;
-		}
-
-		$result = [];
-		// sort by stime, the super share will be based on the least recent share
-		foreach ($tmp as &$tmp2) {
-			@usort($tmp2, function ($a, $b) {
-				$aTime = $a->getShareTime()->getTimestamp();
-				$bTime = $b->getShareTime()->getTimestamp();
-				if ($aTime === $bTime) {
-					return $a->getId() < $b->getId() ? -1 : 1;
-				}
-				return $aTime < $bTime ? -1 : 1;
-			});
-			$result[] = $tmp2;
-		}
-
-		return array_values($result);
-	}
-
-	/**
-	 * Build super shares (virtual share) by grouping them by node id and target,
-	 * then for each group compute the super share and return it along with the matching
-	 * grouped shares. The most permissive permissions are used based on the permissions
-	 * of all shares within the group.
-	 *
-	 * @param \OCP\Share\IShare[] $allShares
-	 * @param \OCP\IUser $user user
-	 * @return array Tuple of [superShare, groupedShares]
-	 */
-	private function buildSuperShares(array $allShares, \OCP\IUser $user) {
-		$result = [];
-
-		$groupedShares = $this->groupShares($allShares);
-
-		/** @var \OCP\Share\IShare[] $shares */
-		foreach ($groupedShares as $shares) {
-			if (count($shares) === 0) {
-				continue;
-			}
-
-			$superShare = $this->shareManager->newShare();
-
-			// compute super share based on first entry of the group
-			$superShare->setId($shares[0]->getId())
-				->setShareOwner($shares[0]->getShareOwner())
-				->setNodeId($shares[0]->getNodeId())
-				->setShareType($shares[0]->getShareType())
-				->setTarget($shares[0]->getTarget());
-
-			// use most permissive permissions
-			$permissions = 0;
-			$status = IShare::STATUS_PENDING;
-			foreach ($shares as $share) {
-				$permissions |= $share->getPermissions();
-				$status = max($status, $share->getStatus());
-
-				if ($share->getTarget() !== $superShare->getTarget()) {
-					// adjust target, for database consistency
-					$share->setTarget($superShare->getTarget());
-					try {
-						$this->shareManager->moveShare($share, $user->getUID());
-					} catch (\InvalidArgumentException $e) {
-						// ignore as it is not important and we don't want to
-						// block FS setup
-
-						// the subsequent code anyway only uses the target of the
-						// super share
-
-						// such issue can usually happen when dealing with
-						// null groups which usually appear with group backend
-						// caching inconsistencies
-						$this->logger->debug(
-							'Could not adjust share target for share ' . $share->getId() . ' to make it consistent: ' . $e->getMessage(),
-							['app' => 'files_sharing']
-						);
-					}
-				}
-				if (!is_null($share->getNodeCacheEntry())) {
-					$superShare->setNodeCacheEntry($share->getNodeCacheEntry());
-				}
-			}
-
-			$superShare->setPermissions($permissions)
-				->setStatus($status);
-
-			$result[] = [$superShare, $shares];
-		}
-
-		return $result;
-	}
+    /**
+     * @var \OCP\IConfig
+     */
+    protected $config;
+
+    /**
+     * @var IManager
+     */
+    protected $shareManager;
+
+    /**
+     * @var ILogger
+     */
+    protected $logger;
+
+    /**
+     * @param \OCP\IConfig $config
+     * @param IManager $shareManager
+     * @param ILogger $logger
+     */
+    public function __construct(IConfig $config, IManager $shareManager, ILogger $logger) {
+        $this->config = $config;
+        $this->shareManager = $shareManager;
+        $this->logger = $logger;
+    }
+
+
+    /**
+     * Get all mountpoints applicable for the user and check for shares where we need to update the etags
+     *
+     * @param \OCP\IUser $user
+     * @param \OCP\Files\Storage\IStorageFactory $storageFactory
+     * @return \OCP\Files\Mount\IMountPoint[]
+     */
+    public function getMountsForUser(IUser $user, IStorageFactory $storageFactory) {
+        $shares = $this->shareManager->getSharedWith($user->getUID(), \OCP\Share::SHARE_TYPE_USER, null, -1);
+        $shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), \OCP\Share::SHARE_TYPE_GROUP, null, -1));
+        $shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), \OCP\Share::SHARE_TYPE_CIRCLE, null, -1));
+        $shares = array_merge($shares, $this->shareManager->getSharedWith($user->getUID(), \OCP\Share::SHARE_TYPE_ROOM, null, -1));
+
+        // filter out excluded shares and group shares that includes self
+        $shares = array_filter($shares, function (\OCP\Share\IShare $share) use ($user) {
+            return $share->getPermissions() > 0 && $share->getShareOwner() !== $user->getUID();
+        });
+
+        $superShares = $this->buildSuperShares($shares, $user);
+
+        $mounts = [];
+        $view = new View('/' . $user->getUID() . '/files');
+        $ownerViews = [];
+        $sharingDisabledForUser = $this->shareManager->sharingDisabledForUser($user->getUID());
+        $foldersExistCache = new CappedMemoryCache();
+        foreach ($superShares as $share) {
+            try {
+                /** @var \OCP\Share\IShare $parentShare */
+                $parentShare = $share[0];
+
+                if ($parentShare->getStatus() !== IShare::STATUS_ACCEPTED &&
+                    ($parentShare->getShareType() === IShare::TYPE_GROUP ||
+                        $parentShare->getShareType() === IShare::TYPE_USERGROUP ||
+                        $parentShare->getShareType() === IShare::TYPE_USER)) {
+                    continue;
+                }
+
+                $owner = $parentShare->getShareOwner();
+                if (!isset($ownerViews[$owner])) {
+                    $ownerViews[$owner] = new View('/' . $parentShare->getShareOwner() . '/files');
+                }
+                $mount = new SharedMount(
+                    '\OCA\Files_Sharing\SharedStorage',
+                    $mounts,
+                    [
+                        'user' => $user->getUID(),
+                        // parent share
+                        'superShare' => $parentShare,
+                        // children/component of the superShare
+                        'groupedShares' => $share[1],
+                        'ownerView' => $ownerViews[$owner],
+                        'sharingDisabledForUser' => $sharingDisabledForUser
+                    ],
+                    $storageFactory,
+                    $view,
+                    $foldersExistCache
+                );
+                $mounts[$mount->getMountPoint()] = $mount;
+            } catch (\Exception $e) {
+                $this->logger->logException($e);
+                $this->logger->error('Error while trying to create shared mount');
+            }
+        }
+
+        // array_filter removes the null values from the array
+        return array_values(array_filter($mounts));
+    }
+
+    /**
+     * Groups shares by path (nodeId) and target path
+     *
+     * @param \OCP\Share\IShare[] $shares
+     * @return \OCP\Share\IShare[][] array of grouped shares, each element in the
+     * array is a group which itself is an array of shares
+     */
+    private function groupShares(array $shares) {
+        $tmp = [];
+
+        foreach ($shares as $share) {
+            if (!isset($tmp[$share->getNodeId()])) {
+                $tmp[$share->getNodeId()] = [];
+            }
+            $tmp[$share->getNodeId()][] = $share;
+        }
+
+        $result = [];
+        // sort by stime, the super share will be based on the least recent share
+        foreach ($tmp as &$tmp2) {
+            @usort($tmp2, function ($a, $b) {
+                $aTime = $a->getShareTime()->getTimestamp();
+                $bTime = $b->getShareTime()->getTimestamp();
+                if ($aTime === $bTime) {
+                    return $a->getId() < $b->getId() ? -1 : 1;
+                }
+                return $aTime < $bTime ? -1 : 1;
+            });
+            $result[] = $tmp2;
+        }
+
+        return array_values($result);
+    }
+
+    /**
+     * Build super shares (virtual share) by grouping them by node id and target,
+     * then for each group compute the super share and return it along with the matching
+     * grouped shares. The most permissive permissions are used based on the permissions
+     * of all shares within the group.
+     *
+     * @param \OCP\Share\IShare[] $allShares
+     * @param \OCP\IUser $user user
+     * @return array Tuple of [superShare, groupedShares]
+     */
+    private function buildSuperShares(array $allShares, \OCP\IUser $user) {
+        $result = [];
+
+        $groupedShares = $this->groupShares($allShares);
+
+        /** @var \OCP\Share\IShare[] $shares */
+        foreach ($groupedShares as $shares) {
+            if (count($shares) === 0) {
+                continue;
+            }
+
+            $superShare = $this->shareManager->newShare();
+
+            // compute super share based on first entry of the group
+            $superShare->setId($shares[0]->getId())
+                ->setShareOwner($shares[0]->getShareOwner())
+                ->setNodeId($shares[0]->getNodeId())
+                ->setShareType($shares[0]->getShareType())
+                ->setTarget($shares[0]->getTarget());
+
+            // use most permissive permissions
+            $permissions = 0;
+            $status = IShare::STATUS_PENDING;
+            foreach ($shares as $share) {
+                $permissions |= $share->getPermissions();
+                $status = max($status, $share->getStatus());
+
+                if ($share->getTarget() !== $superShare->getTarget()) {
+                    // adjust target, for database consistency
+                    $share->setTarget($superShare->getTarget());
+                    try {
+                        $this->shareManager->moveShare($share, $user->getUID());
+                    } catch (\InvalidArgumentException $e) {
+                        // ignore as it is not important and we don't want to
+                        // block FS setup
+
+                        // the subsequent code anyway only uses the target of the
+                        // super share
+
+                        // such issue can usually happen when dealing with
+                        // null groups which usually appear with group backend
+                        // caching inconsistencies
+                        $this->logger->debug(
+                            'Could not adjust share target for share ' . $share->getId() . ' to make it consistent: ' . $e->getMessage(),
+                            ['app' => 'files_sharing']
+                        );
+                    }
+                }
+                if (!is_null($share->getNodeCacheEntry())) {
+                    $superShare->setNodeCacheEntry($share->getNodeCacheEntry());
+                }
+            }
+
+            $superShare->setPermissions($permissions)
+                ->setStatus($status);
+
+            $result[] = [$superShare, $shares];
+        }
+
+        return $result;
+    }
 }