aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/share.php
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-05-19 08:00:09 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-05-19 09:43:33 +0200
commitd666725fa783c21235eec79fa6dbe8ba1881fec3 (patch)
tree98914481ca4218c9af2c04db17c6d8f281b0094d /lib/public/share.php
parent4a94203492e3b475ee26b65d5992796152c645bd (diff)
downloadnextcloud-server-d666725fa783c21235eec79fa6dbe8ba1881fec3.tar.gz
nextcloud-server-d666725fa783c21235eec79fa6dbe8ba1881fec3.zip
Move \OCP to PSR-4
Diffstat (limited to 'lib/public/share.php')
-rw-r--r--lib/public/share.php401
1 files changed, 0 insertions, 401 deletions
diff --git a/lib/public/share.php b/lib/public/share.php
deleted file mode 100644
index 9c62ec703e4..00000000000
--- a/lib/public/share.php
+++ /dev/null
@@ -1,401 +0,0 @@
-<?php
-/**
- * @author Andreas Fischer <bantu@owncloud.com>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Björn Schießle <schiessle@owncloud.com>
- * @author Joas Schilling <nickvergessen@owncloud.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Michael Gapczynski <GapczynskiM@gmail.com>
- * @author Michael Kuhn <suraia@ikkoku.de>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <rullzer@owncloud.com>
- * @author Sam Tuke <mail@samtuke.com>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @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/>
- *
- */
-
-/**
- * Public interface of ownCloud for apps to use.
- * Share Class
- *
- */
-
-// use OCP namespace for all classes that are considered public.
-// This means that they should be used by apps instead of the internal ownCloud classes
-namespace OCP;
-
-/**
- * This class provides the ability for apps to share their content between users.
- * Apps must create a backend class that implements OCP\Share_Backend and register it with this class.
- *
- * It provides the following hooks:
- * - post_shared
- * @since 5.0.0
- */
-class Share extends \OC\Share\Constants {
-
- /**
- * Register a sharing backend class that implements OCP\Share_Backend for an item type
- * @param string $itemType Item type
- * @param string $class Backend class
- * @param string $collectionOf (optional) Depends on item type
- * @param array $supportedFileExtensions (optional) List of supported file extensions if this item type depends on files
- * @return boolean true if backend is registered or false if error
- * @since 5.0.0
- */
- public static function registerBackend($itemType, $class, $collectionOf = null, $supportedFileExtensions = null) {
- return \OC\Share\Share::registerBackend($itemType, $class, $collectionOf, $supportedFileExtensions);
- }
-
- /**
- * Check if the Share API is enabled
- * @return boolean true if enabled or false
- *
- * The Share API is enabled by default if not configured
- * @since 5.0.0
- */
- public static function isEnabled() {
- return \OC\Share\Share::isEnabled();
- }
-
- /**
- * Find which users can access a shared item
- * @param string $path to the file
- * @param string $ownerUser owner of the file
- * @param bool $includeOwner include owner to the list of users with access to the file
- * @param bool $returnUserPaths Return an array with the user => path map
- * @param bool $recursive take parent folders into account
- * @return array
- * @note $path needs to be relative to user data dir, e.g. 'file.txt'
- * not '/admin/files/file.txt'
- * @since 5.0.0 - $recursive was added in 9.0.0
- */
- public static function getUsersSharingFile($path, $ownerUser, $includeOwner = false, $returnUserPaths = false, $recursive = true) {
- return \OC\Share\Share::getUsersSharingFile($path, $ownerUser, $includeOwner, $returnUserPaths, $recursive);
- }
-
- /**
- * Get the items of item type shared with the current user
- * @param string $itemType
- * @param int $format (optional) Format type must be defined by the backend
- * @param mixed $parameters (optional)
- * @param int $limit Number of items to return (optional) Returns all by default
- * @param bool $includeCollections (optional)
- * @return mixed Return depends on format
- * @since 5.0.0
- */
- public static function getItemsSharedWith($itemType, $format = self::FORMAT_NONE,
- $parameters = null, $limit = -1, $includeCollections = false) {
-
- return \OC\Share\Share::getItemsSharedWith($itemType, $format, $parameters, $limit, $includeCollections);
- }
-
- /**
- * Get the items of item type shared with a user
- * @param string $itemType
- * @param string $user for which user we want the shares
- * @param int $format (optional) Format type must be defined by the backend
- * @param mixed $parameters (optional)
- * @param int $limit Number of items to return (optional) Returns all by default
- * @param bool $includeCollections (optional)
- * @return mixed Return depends on format
- * @since 7.0.0
- */
- public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE,
- $parameters = null, $limit = -1, $includeCollections = false) {
-
- return \OC\Share\Share::getItemsSharedWithUser($itemType, $user, $format, $parameters, $limit, $includeCollections);
- }
-
- /**
- * Get the item of item type shared with the current user
- * @param string $itemType
- * @param string $itemTarget
- * @param int $format (optional) Format type must be defined by the backend
- * @param mixed $parameters (optional)
- * @param bool $includeCollections (optional)
- * @return mixed Return depends on format
- * @since 5.0.0
- */
- public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE,
- $parameters = null, $includeCollections = false) {
-
- return \OC\Share\Share::getItemSharedWith($itemType, $itemTarget, $format, $parameters, $includeCollections);
- }
-
- /**
- * Get the item of item type shared with a given user by source
- * @param string $itemType
- * @param string $itemSource
- * @param string $user User to whom the item was shared
- * @param string $owner Owner of the share
- * @return array Return list of items with file_target, permissions and expiration
- * @since 6.0.0 - parameter $owner was added in 8.0.0
- */
- public static function getItemSharedWithUser($itemType, $itemSource, $user, $owner = null) {
- return \OC\Share\Share::getItemSharedWithUser($itemType, $itemSource, $user, $owner);
- }
-
- /**
- * Get the item of item type shared with the current user by source
- * @param string $itemType
- * @param string $itemSource
- * @param int $format (optional) Format type must be defined by the backend
- * @param mixed $parameters
- * @param bool $includeCollections
- * @return array
- * @since 5.0.0
- */
- public static function getItemSharedWithBySource($itemType, $itemSource, $format = self::FORMAT_NONE,
- $parameters = null, $includeCollections = false) {
- return \OC\Share\Share::getItemSharedWithBySource($itemType, $itemSource, $format, $parameters, $includeCollections);
- }
-
- /**
- * Get the item of item type shared by a link
- * @param string $itemType
- * @param string $itemSource
- * @param string $uidOwner Owner of link
- * @return array
- * @since 5.0.0
- */
- public static function getItemSharedWithByLink($itemType, $itemSource, $uidOwner) {
- return \OC\Share\Share::getItemSharedWithByLink($itemType, $itemSource, $uidOwner);
- }
-
- /**
- * Based on the given token the share information will be returned - password protected shares will be verified
- * @param string $token
- * @param bool $checkPasswordProtection
- * @return array|bool false will be returned in case the token is unknown or unauthorized
- * @since 5.0.0 - parameter $checkPasswordProtection was added in 7.0.0
- */
- public static function getShareByToken($token, $checkPasswordProtection = true) {
- return \OC\Share\Share::getShareByToken($token, $checkPasswordProtection);
- }
-
- /**
- * resolves reshares down to the last real share
- * @param array $linkItem
- * @return array file owner
- * @since 6.0.0
- */
- public static function resolveReShare($linkItem) {
- return \OC\Share\Share::resolveReShare($linkItem);
- }
-
-
- /**
- * Get the shared items of item type owned by the current user
- * @param string $itemType
- * @param int $format (optional) Format type must be defined by the backend
- * @param mixed $parameters
- * @param int $limit Number of items to return (optional) Returns all by default
- * @param bool $includeCollections
- * @return mixed Return depends on format
- * @since 5.0.0
- */
- public static function getItemsShared($itemType, $format = self::FORMAT_NONE, $parameters = null,
- $limit = -1, $includeCollections = false) {
-
- return \OC\Share\Share::getItemsShared($itemType, $format, $parameters, $limit, $includeCollections);
- }
-
- /**
- * Get the shared item of item type owned by the current user
- * @param string $itemType
- * @param string $itemSource
- * @param int $format (optional) Format type must be defined by the backend
- * @param mixed $parameters
- * @param bool $includeCollections
- * @return mixed Return depends on format
- * @since 5.0.0
- */
- public static function getItemShared($itemType, $itemSource, $format = self::FORMAT_NONE,
- $parameters = null, $includeCollections = false) {
-
- return \OC\Share\Share::getItemShared($itemType, $itemSource, $format, $parameters, $includeCollections);
- }
-
- /**
- * Get all users an item is shared with
- * @param string $itemType
- * @param string $itemSource
- * @param string $uidOwner
- * @param bool $includeCollections
- * @param bool $checkExpireDate
- * @return array Return array of users
- * @since 5.0.0 - parameter $checkExpireDate was added in 7.0.0
- */
- public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) {
- return \OC\Share\Share::getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections, $checkExpireDate);
- }
-
- /**
- * Share an item with a user, group, or via private link
- * @param string $itemType
- * @param string $itemSource
- * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
- * @param string $shareWith User or group the item is being shared with
- * @param int $permissions CRUDS
- * @param string $itemSourceName
- * @param \DateTime $expirationDate
- * @param bool $passwordChanged
- * @return bool|string Returns true on success or false on failure, Returns token on success for links
- * @throws \OC\HintException when the share type is remote and the shareWith is invalid
- * @throws \Exception
- * @since 5.0.0 - parameter $itemSourceName was added in 6.0.0, parameter $expirationDate was added in 7.0.0, parameter $passwordChanged added in 9.0.0
- */
- public static function shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions, $itemSourceName = null, \DateTime $expirationDate = null, $passwordChanged = null) {
- return \OC\Share\Share::shareItem($itemType, $itemSource, $shareType, $shareWith, $permissions, $itemSourceName, $expirationDate, $passwordChanged);
- }
-
- /**
- * Unshare an item from a user, group, or delete a private link
- * @param string $itemType
- * @param string $itemSource
- * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
- * @param string $shareWith User or group the item is being shared with
- * @param string $owner owner of the share, if null the current user is used
- * @return boolean true on success or false on failure
- * @since 5.0.0 - parameter $owner was added in 8.0.0
- */
- public static function unshare($itemType, $itemSource, $shareType, $shareWith, $owner = null) {
- return \OC\Share\Share::unshare($itemType, $itemSource, $shareType, $shareWith, $owner);
- }
-
- /**
- * Unshare an item from all users, groups, and remove all links
- * @param string $itemType
- * @param string $itemSource
- * @return boolean true on success or false on failure
- * @since 5.0.0
- */
- public static function unshareAll($itemType, $itemSource) {
- return \OC\Share\Share::unshareAll($itemType, $itemSource);
- }
-
- /**
- * Unshare an item shared with the current user
- * @param string $itemType
- * @param string $itemOrigin Item target or source
- * @param boolean $originIsSource true if $itemOrigin is the source, false if $itemOrigin is the target (optional)
- * @return boolean true on success or false on failure
- *
- * Unsharing from self is not allowed for items inside collections
- * @since 5.0.0 - parameter $originIsSource was added in 8.0.0
- */
- public static function unshareFromSelf($itemType, $itemOrigin, $originIsSource = false) {
- return \OC\Share\Share::unshareFromSelf($itemType, $itemOrigin, $originIsSource);
- }
-
- /**
- * sent status if users got informed by mail about share
- * @param string $itemType
- * @param string $itemSource
- * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
- * @param string $recipient with whom was the item shared
- * @param bool $status
- * @since 6.0.0 - parameter $originIsSource was added in 8.0.0
- */
- public static function setSendMailStatus($itemType, $itemSource, $shareType, $recipient, $status) {
- return \OC\Share\Share::setSendMailStatus($itemType, $itemSource, $shareType, $recipient, $status);
- }
-
- /**
- * Set the permissions of an item for a specific user or group
- * @param string $itemType
- * @param string $itemSource
- * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
- * @param string $shareWith User or group the item is being shared with
- * @param int $permissions CRUDS permissions
- * @return boolean true on success or false on failure
- * @since 5.0.0
- */
- public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) {
- return \OC\Share\Share::setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions);
- }
-
- /**
- * Set expiration date for a share
- * @param string $itemType
- * @param string $itemSource
- * @param string $date expiration date
- * @param int $shareTime timestamp from when the file was shared
- * @return boolean
- * @since 5.0.0 - parameter $shareTime was added in 8.0.0
- */
- public static function setExpirationDate($itemType, $itemSource, $date, $shareTime = null) {
- return \OC\Share\Share::setExpirationDate($itemType, $itemSource, $date, $shareTime);
- }
-
- /**
- * Set password for a public link share
- * @param int $shareId
- * @param string $password
- * @return boolean
- * @since 8.1.0
- */
- public static function setPassword($shareId, $password) {
- $userSession = \OC::$server->getUserSession();
- $connection = \OC::$server->getDatabaseConnection();
- $config = \OC::$server->getConfig();
- return \OC\Share\Share::setPassword($userSession, $connection, $config, $shareId, $password);
- }
-
-
- /**
- * Get the backend class for the specified item type
- * @param string $itemType
- * @return Share_Backend
- * @since 5.0.0
- */
- public static function getBackend($itemType) {
- return \OC\Share\Share::getBackend($itemType);
- }
-
- /**
- * Delete all shares with type SHARE_TYPE_LINK
- * @since 6.0.0
- */
- public static function removeAllLinkShares() {
- return \OC\Share\Share::removeAllLinkShares();
- }
-
- /**
- * In case a password protected link is not yet authenticated this function will return false
- *
- * @param array $linkItem
- * @return bool
- * @since 7.0.0
- */
- public static function checkPasswordProtectedShare(array $linkItem) {
- return \OC\Share\Share::checkPasswordProtectedShare($linkItem);
- }
-
- /**
- * Check if resharing is allowed
- *
- * @return boolean true if allowed or false
- * @since 5.0.0
- */
- public static function isResharingAllowed() {
- return \OC\Share\Share::isResharingAllowed();
- }
-}