diff options
Diffstat (limited to 'lib/public/share')
| -rw-r--r-- | lib/public/share/imanager.php | 212 | ||||
| -rw-r--r-- | lib/public/share/iproviderfactory.php | 57 | ||||
| -rw-r--r-- | lib/public/share/ishare.php | 264 | ||||
| -rw-r--r-- | lib/public/share/ishareprovider.php | 135 |
4 files changed, 668 insertions, 0 deletions
diff --git a/lib/public/share/imanager.php b/lib/public/share/imanager.php new file mode 100644 index 00000000000..6531c14a857 --- /dev/null +++ b/lib/public/share/imanager.php @@ -0,0 +1,212 @@ +<?php +/** + * @author Roeland Jago Douma <rullzer@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OCP\Share; + +use OCP\IUser; + +use OC\Share20\Exception\ShareNotFound; + +/** + * Interface IManager + * + * @package OCP\Share + * @since 9.0.0 + */ +interface IManager { + + /** + * Create a Share + * + * @param IShare $share + * @return Share The share object + * @since 9.0.0 + */ + public function createShare(IShare $share); + + /** + * Update a share + * + * @param IShare $share + * @return IShare The share object + * @since 9.0.0 + */ + public function updateShare(IShare $share); + + /** + * Delete a share + * + * @param IShare $share + * @throws ShareNotFound + * @since 9.0.0 + */ + public function deleteShare(IShare $share); + + /** + * Unshare a file as the recipient. + * This can be different from a regular delete for example when one of + * the users in a groups deletes that share. But the provider should + * handle this. + * + * @param IShare $share + * @param IUser $recipient + * @since 9.0.0 + */ + public function deleteFromSelf(IShare $share, IUser $recipient); + + /** + * Get shares shared by (initiated) by the provided user. + * + * @param IUser $user + * @param int $shareType + * @param \OCP\Files\File|\OCP\Files\Folder $path + * @param bool $reshares + * @param int $limit The maximum number of returned results, -1 for all results + * @param int $offset + * @return IShare[] + * @since 9.0.0 + */ + public function getSharesBy(IUser $user, $shareType, $path = null, $reshares = false, $limit = 50, $offset = 0); + + /** + * Get shares shared with $user. + * + * @param IUser $user + * @param int $shareType + * @param int $limit The maximum number of shares returned, -1 for all + * @param int $offset + * @return IShare[] + * @since 9.0.0 + */ + public function getSharedWith(IUser $user, $shareType, $limit = 50, $offset = 0); + + /** + * Retrieve a share by the share id + * + * @param string $id + * @return Share + * @throws ShareNotFound + * @since 9.0.0 + */ + public function getShareById($id); + + /** + * Get the share by token possible with password + * + * @param string $token + * @return Share + * @throws ShareNotFound + * @since 9.0.0 + */ + public function getShareByToken($token); + + /** + * Verify the password of a public share + * + * @param IShare $share + * @param string $password + * @return bool + * @since 9.0.0 + */ + public function checkPassword(IShare $share, $password); + + /** + * Instantiates a new share object. This is to be passed to + * createShare. + * + * @return IShare + * @since 9.0.0 + */ + public function newShare(); + + /** + * Is the share API enabled + * + * @return bool + * @since 9.0.0 + */ + public function shareApiEnabled(); + + /** + * Is public link sharing enabled + * + * @return bool + * @since 9.0.0 + */ + public function shareApiAllowLinks(); + + /** + * Is password on public link requires + * + * @return bool + * @since 9.0.0 + */ + public function shareApiLinkEnforcePassword(); + + /** + * Is default expire date enabled + * + * @return bool + * @since 9.0.0 + */ + public function shareApiLinkDefaultExpireDate(); + + /** + * Is default expire date enforced + *` + * @return bool + * @since 9.0.0 + */ + public function shareApiLinkDefaultExpireDateEnforced(); + + /** + * Number of default expire days + * + * @return int + * @since 9.0.0 + */ + public function shareApiLinkDefaultExpireDays(); + + /** + * Allow public upload on link shares + * + * @return bool + * @since 9.0.0 + */ + public function shareApiLinkAllowPublicUpload(); + + /** + * check if user can only share with group members + * @return bool + * @since 9.0.0 + */ + public function shareWithGroupMembersOnly(); + + /** + * Check if sharing is disabled for the given user + * + * @param IUser $user + * @return bool + * @since 9.0.0 + */ + public function sharingDisabledForUser(IUser $user); + +} diff --git a/lib/public/share/iproviderfactory.php b/lib/public/share/iproviderfactory.php new file mode 100644 index 00000000000..3a8baccf33b --- /dev/null +++ b/lib/public/share/iproviderfactory.php @@ -0,0 +1,57 @@ +<?php +/** + * @author Roeland Jago Douma <rullzer@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OCP\Share; + +use OC\Share20\Exception\ProviderException; +use OCP\IServerContainer; + +/** + * Interface IProviderFactory + * + * @package OC\Share20 + * @since 9.0.0 + */ +interface IProviderFactory { + + /** + * IProviderFactory constructor. + * @param IServerContainer $serverContainer + * @since 9.0.0 + */ + public function __construct(IServerContainer $serverContainer); + + /** + * @param string $id + * @return IShareProvider + * @throws ProviderException + * @since 9.0.0 + */ + public function getProvider($id); + + /** + * @param int $shareType + * @return IShareProvider + * @throws ProviderException + * @since 9.0.0 + */ + public function getProviderForType($shareType); +} diff --git a/lib/public/share/ishare.php b/lib/public/share/ishare.php new file mode 100644 index 00000000000..80e7f7f56ef --- /dev/null +++ b/lib/public/share/ishare.php @@ -0,0 +1,264 @@ +<?php +/** + * @author Roeland Jago Douma <rullzer@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OCP\Share; + +use OCP\Files\File; +use OCP\Files\Folder; +use OCP\Files\Node; +use OCP\IUser; +use OCP\IGroup; + +/** + * Interface IShare + * + * @package OCP\Share + * @since 9.0.0 + */ +interface IShare { + + /** + * 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 + */ + public function getFullId(); + + /** + * Set the node of the file/folder that is shared + * + * @param File|Folder $path + * @return \OCP\Share\IShare The modified object + * @since 9.0.0 + */ + public function setNode(Node $path); + + /** + * Get the node of the file/folder that is shared + * + * @return File|Folder + * @since 9.0.0 + */ + public function getNode(); + + /** + * 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 IUser|IGroup + * @return \OCP\Share\IShare The modified object + * @since 9.0.0 + */ + public function setSharedWith($sharedWith); + + /** + * Get the receiver of this share. + * + * @return IUser|IGroup + * @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 \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 IUser $sharedBy + * @return \OCP\Share\IShare The modified object + * @since 9.0.0 + */ + public function setSharedBy($sharedBy); + + /** + * Get share sharer + * + * @return IUser + * @since 9.0.0 + */ + public function getSharedBy(); + + /** + * Set the original share owner (who owns the path that is shared) + * + * @param IUser + * @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 IUser + * @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(); +} diff --git a/lib/public/share/ishareprovider.php b/lib/public/share/ishareprovider.php new file mode 100644 index 00000000000..50964c88dd6 --- /dev/null +++ b/lib/public/share/ishareprovider.php @@ -0,0 +1,135 @@ +<?php +/** + * @author Roeland Jago Douma <rullzer@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OCP\Share; + +use OC\Share20\Exception\ShareNotFound; +use OC\Share20\Exception\BackendError; +use OCP\IUser; + +/** + * Interface IShareProvider + * + * @package OCP\Share + * @since 9.0.0 + */ +interface IShareProvider { + + /** + * Return the identifier of this provider. + * + * @return string Containing only [a-zA-Z0-9] + * @since 9.0.0 + */ + public function identifier(); + + /** + * Create a share + * + * @param \OCP\Share\IShare $share + * @return \OCP\Share\IShare The share object + * @since 9.0.0 + */ + public function create(\OCP\Share\IShare $share); + + /** + * Update a share + * + * @param \OCP\Share\IShare $share + * @return \OCP\Share\IShare The share object + * @since 9.0.0 + */ + public function update(\OCP\Share\IShare $share); + + /** + * Delete a share + * + * @param \OCP\Share\IShare $share + * @since 9.0.0 + */ + public function delete(\OCP\Share\IShare $share); + + /** + * Unshare a file from self as recipient. + * This may require special handling. If a user unshares a group + * share from their self then the original group share should still exist. + * + * @param \OCP\Share\IShare $share + * @param IUser $recipient + * @since 9.0.0 + */ + public function deleteFromSelf(\OCP\Share\IShare $share, IUser $recipient); + + /** + * Get all shares by the given user + * + * @param IUser $user + * @param int $shareType + * @param \OCP\Files\File|\OCP\Files\Folder $node + * @param bool $reshares Also get the shares where $user is the owner instead of just the shares where $user is the initiator + * @param int $limit The maximum number of shares to be returned, -1 for all shares + * @param int $offset + * @return \OCP\Share\I Share[] + * @since 9.0.0 + */ + public function getSharesBy(IUser $user, $shareType, $node, $reshares, $limit, $offset); + + /** + * Get share by id + * + * @param int $id + * @return \OCP\Share\IShare + * @throws ShareNotFound + * @since 9.0.0 + */ + public function getShareById($id); + + /** + * Get shares for a given path + * + * @param \OCP\Files\Node $path + * @return \OCP\Share\IShare[] + * @since 9.0.0 + */ + public function getSharesByPath(\OCP\Files\Node $path); + + /** + * Get shared with the given user + * + * @param IUser $user get shares where this user is the recipient + * @param int $shareType + * @param int $limit The max number of entries returned, -1 for all + * @param int $offset + * @return \OCP\Share\IShare[] + * @since 9.0.0 + */ + public function getSharedWith(IUser $user, $shareType, $limit, $offset); + + /** + * Get a share by token + * + * @param string $token + * @return \OCP\Share\IShare + * @throws ShareNotFound + * @since 9.0.0 + */ + public function getShareByToken($token); +} |