nextcloud/apps/files_sharing/lib/api.php

468 lines
13 KiB
PHP
Raw Normal View History

2013-09-04 19:25:15 +04:00
<?php
/**
* ownCloud
*
* @author Bjoern Schiessle
* @copyright 2013 Bjoern Schiessle schiessle@owncloud.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Files\Share;
class Api {
2013-09-17 13:53:06 +04:00
/**
* @brief get all shares
*
2013-09-17 17:27:10 +04:00
* @param array $params option 'file' to limit the result to a specific file/folder
2013-09-17 13:53:06 +04:00
* @return \OC_OCS_Result share information
*/
public static function getAllShares($params) {
2013-09-17 13:53:06 +04:00
2013-09-17 17:27:10 +04:00
// if a file is specified, get the share for this file
if (isset($_GET['path'])) {
$params['itemSource'] = self::getFileId($_GET['path']);
$params['path'] = $_GET['path'];
if (isset($_GET['subfiles']) && $_GET['subfiles'] === 'yes') {
return self::getSharesFromFolder($params);
}
2013-09-17 17:27:10 +04:00
return self::getShare($params);
}
2013-09-17 13:53:06 +04:00
$share = \OCP\Share::getItemShared('file', null);
if ($share === false) {
return new \OC_OCS_Result(null, 404, 'could not get shares');
2013-09-17 13:53:06 +04:00
} else {
return new \OC_OCS_Result($share);
2013-09-17 13:53:06 +04:00
}
2013-09-17 13:53:06 +04:00
}
2013-09-04 19:25:15 +04:00
/**
2013-09-17 17:27:10 +04:00
* @brief get share information for a given share
2013-09-04 19:25:15 +04:00
*
2013-09-17 17:27:10 +04:00
* @param array $params which contains a 'id'
2013-09-04 19:25:15 +04:00
* @return \OC_OCS_Result share information
*/
public static function getShare($params) {
2013-09-17 17:27:10 +04:00
// either the $params already contains a itemSource if we come from
// getAllShare() or we need to translate the shareID to a itemSource
if(isset($params['itemSource'])) {
$itemSource = $params['itemSource'];
$getSpecificShare = true;
2013-09-06 12:49:21 +04:00
} else {
2013-09-17 17:27:10 +04:00
$s = self::getShareFromId($params['id']);
$itemSource = $s['item_source'];
$getSpecificShare = false;
2013-09-06 12:49:21 +04:00
}
2013-09-17 17:27:10 +04:00
if ($itemSource !== null) {
$shares = \OCP\Share::getItemShared('file', $itemSource);
// if a specific share was specified only return this one
if ($getSpecificShare === false) {
2013-09-17 17:27:10 +04:00
foreach ($shares as $share) {
if ($share['id'] === (int)$params['id']) {
$shares = array('element' => $share);
break;
}
}
}
} else {
$shares = null;
}
if ($shares === null || empty($shares)) {
return new \OC_OCS_Result(null, 404, 'share doesn\'t exist');
2013-09-06 12:49:21 +04:00
} else {
2013-09-17 17:27:10 +04:00
return new \OC_OCS_Result($shares);
2013-09-06 12:49:21 +04:00
}
}
/**
* @brief get share from all files in a given folder (non-recursive)
* @param array $params contains 'path' to the folder
* @return \OC_OCS_Result
*/
private static function getSharesFromFolder($params) {
$path = $params['path'];
$view = new \OC\Files\View('/'.\OCP\User::getUser().'/files');
if(!$view->is_dir($path)) {
return new \OC_OCS_Result(null, 404, "not a directory");
}
$content = $view->getDirectoryContent($path);
$result = array();
foreach ($content as $file) {
$share = \OCP\Share::getItemShared('file', $file['fileid']);
if ($share) {
$share['filename'] = $file['name'];
$result[] = $share;
}
}
return new \OC_OCS_Result($result);
}
2013-09-06 12:49:21 +04:00
/**
2013-09-17 13:53:06 +04:00
* @breif create a new share
* @param array $params
2013-09-17 13:53:06 +04:00
* @return \OC_OCS_Result
2013-09-06 12:49:21 +04:00
*/
2013-09-17 13:53:06 +04:00
public static function createShare($params) {
$path = isset($_POST['path']) ? $_POST['path'] : null;
if($path === null) {
2013-09-17 17:27:10 +04:00
return new \OC_OCS_Result(null, 400, "please specify a file or folder path");
2013-09-17 13:53:06 +04:00
}
2013-09-06 12:49:21 +04:00
$itemSource = self::getFileId($path);
$itemType = self::getItemType($path);
2013-09-06 18:00:01 +04:00
if($itemSource === null) {
return new \OC_OCS_Result(null, 404, "wrong path, file/folder doesn't exist.");
}
2013-09-06 12:49:21 +04:00
$shareWith = isset($_POST['shareWith']) ? $_POST['shareWith'] : null;
$shareType = isset($_POST['shareType']) ? (int)$_POST['shareType'] : null;
2013-09-06 18:00:01 +04:00
switch($shareType) {
case \OCP\Share::SHARE_TYPE_USER:
2013-09-17 13:53:06 +04:00
$permissions = isset($_POST['permissions']) ? (int)$_POST['permissions'] : 31;
2013-09-06 18:00:01 +04:00
break;
case \OCP\Share::SHARE_TYPE_GROUP:
2013-09-17 13:53:06 +04:00
$permissions = isset($_POST['permissions']) ? (int)$_POST['permissions'] : 31;
2013-09-06 18:00:01 +04:00
break;
case \OCP\Share::SHARE_TYPE_LINK:
2013-09-16 19:04:49 +04:00
//allow password protection
$shareWith = isset($_POST['password']) ? $_POST['password'] : null;
//check public link share
$publicUploadEnabled = \OC_Appconfig::getValue('core', 'shareapi_allow_public_upload', 'yes');
$encryptionEnabled = \OC_App::isEnabled('files_encryption');
if(isset($_POST['publicUpload']) &&
($encryptionEnabled || $publicUploadEnabled !== 'yes')) {
return new \OC_OCS_Result(null, 404, "public upload disabled by the administrator");
}
2013-09-16 19:04:49 +04:00
$publicUpload = isset($_POST['publicUpload']) ? $_POST['publicUpload'] : 'no';
// read, create, update (7) if public upload is enabled or
// read (1) if public upload is disabled
2013-09-17 13:53:06 +04:00
$permissions = $publicUpload === 'yes' ? 7 : 1;
2013-09-06 18:00:01 +04:00
break;
default:
return new \OC_OCS_Result(null, 404, "unknown share type");
2013-09-06 12:49:21 +04:00
}
2013-09-16 19:04:49 +04:00
try {
$token = \OCP\Share::shareItem(
2013-09-06 12:49:21 +04:00
$itemType,
$itemSource,
$shareType,
$shareWith,
2013-09-17 13:53:06 +04:00
$permissions
2013-09-06 12:49:21 +04:00
);
2013-09-16 19:04:49 +04:00
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 404, $e->getMessage());
}
2013-09-06 12:49:21 +04:00
if ($token) {
$data = array();
$data['id'] = 'unknown';
2013-09-17 17:27:10 +04:00
$shares = \OCP\Share::getItemShared('file', $itemSource);
2013-09-06 12:49:21 +04:00
if(is_string($token)) { //public link share
2013-09-17 17:27:10 +04:00
foreach ($shares as $share) {
if ($share['token'] === $token) {
$data['id'] = $share['id'];
2013-09-17 17:27:10 +04:00
break;
}
}
2013-09-06 12:49:21 +04:00
$url = \OCP\Util::linkToPublic('files&t='.$token);
$data['url'] = $url; // '&' gets encoded to $amp;
$data['token'] = $token;
2013-09-17 17:27:10 +04:00
} else {
foreach ($shares as $share) {
if ($share['share_with'] === $shareWith && $share['share_type'] === $shareType) {
$data['id'] = $share['id'];
2013-09-17 17:27:10 +04:00
break;
}
}
2013-09-06 12:49:21 +04:00
}
return new \OC_OCS_Result($data);
} else {
2013-09-06 18:00:01 +04:00
return new \OC_OCS_Result(null, 404, "couldn't share file");
2013-09-06 12:49:21 +04:00
}
}
2013-09-17 13:53:06 +04:00
2013-09-06 18:00:01 +04:00
/**
2013-09-17 17:27:10 +04:00
* update shares, e.g. password, permissions, etc
* @param array $params shareId 'id' and the parameter we want to update
* currently supported: permissions, password, publicUpload
2013-09-06 18:00:01 +04:00
* @return \OC_OCS_Result
*/
2013-09-17 13:53:06 +04:00
public static function updateShare($params) {
2013-09-17 17:27:10 +04:00
$share = self::getShareFromId($params['id']);
$itemSource = isset($share['item_source']) ? $share['item_source'] : null;
2013-09-06 18:00:01 +04:00
if($itemSource === null) {
2013-09-17 17:27:10 +04:00
return new \OC_OCS_Result(null, 404, "wrong share Id, share doesn't exist.");
2013-09-06 18:00:01 +04:00
}
2013-09-17 13:53:06 +04:00
try {
if(isset($params['_put']['permissions'])) {
2013-09-17 17:27:10 +04:00
return self::updatePermissions($share, $params);
2013-09-17 13:53:06 +04:00
} elseif (isset($params['_put']['password'])) {
2013-09-17 17:27:10 +04:00
return self::updatePassword($share, $params);
} elseif (isset($params['_put']['publicUpload'])) {
return self::updatePublicUpload($share, $params);
2013-09-17 13:53:06 +04:00
}
} catch (\Exception $e) {
2013-09-17 17:27:10 +04:00
return new \OC_OCS_Result(null, 400, $e->getMessage());
2013-09-17 13:53:06 +04:00
}
2013-09-17 17:27:10 +04:00
return new \OC_OCS_Result(null, 400, "Wrong or no update parameter given");
2013-09-17 13:53:06 +04:00
}
/**
* @brief update permissions for a share
2013-09-17 17:27:10 +04:00
* @param array $share information about the share
* @param array $params contains 'permissions'
2013-09-17 13:53:06 +04:00
* @return \OC_OCS_Result
*/
2013-09-17 17:27:10 +04:00
private static function updatePermissions($share, $params) {
2013-09-17 13:53:06 +04:00
2013-09-17 17:27:10 +04:00
$itemSource = $share['item_source'];
$itemType = $share['item_type'];
$shareWith = $share['share_with'];
$shareType = $share['share_type'];
2013-09-17 13:53:06 +04:00
$permissions = isset($params['_put']['permissions']) ? (int)$params['_put']['permissions'] : null;
2013-09-06 18:00:01 +04:00
2013-09-17 17:27:10 +04:00
$publicUploadStatus = \OC_Appconfig::getValue('core', 'shareapi_allow_public_upload', 'yes');
$encryptionEnabled = \OC_App::isEnabled('files_encryption');
$publicUploadEnabled = false;
if(!$encryptionEnabled && $publicUploadStatus === 'yes') {
$publicUploadEnabled = true;
}
// only change permissions for public shares if public upload is enabled
// and we want to set permissions to 1 (read only) or 7 (allow upload)
if ( (int)$shareType === \OCP\Share::SHARE_TYPE_LINK ) {
if ($publicUploadEnabled === false || ($permissions !== 7 && $permissions !== 1)) {
return new \OC_OCS_Result(null, 400, "can't change permission for public link share");
}
}
2013-09-16 19:04:49 +04:00
try {
$return = \OCP\Share::setPermissions(
$itemType,
$itemSource,
$shareType,
$shareWith,
2013-09-17 13:53:06 +04:00
$permissions
2013-09-16 19:04:49 +04:00
);
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 404, $e->getMessage());
2013-09-06 18:00:01 +04:00
}
if ($return) {
return new \OC_OCS_Result();
} else {
return new \OC_OCS_Result(null, 404, "couldn't set permissions");
}
}
2013-09-17 17:27:10 +04:00
/**
* @brief enable/disable public upload
* @param array $share information about the share
* @param array $params contains 'publicUpload' which can be 'yes' or 'no'
* @return \OC_OCS_Result
*/
private static function updatePublicUpload($share, $params) {
$publicUploadEnabled = \OC_Appconfig::getValue('core', 'shareapi_allow_public_upload', 'yes');
$encryptionEnabled = \OC_App::isEnabled('files_encryption');
if($encryptionEnabled || $publicUploadEnabled !== 'yes') {
return new \OC_OCS_Result(null, 404, "public upload disabled by the administrator");
}
if ($share['item_type'] !== 'folder' ||
(int)$share['share_type'] !== \OCP\Share::SHARE_TYPE_LINK ) {
return new \OC_OCS_Result(null, 404, "public upload is only possible for public shared folders");
}
// read, create, update (7) if public upload is enabled or
// read (1) if public upload is disabled
$params['_put']['permissions'] = $params['_put']['publicUpload'] === 'yes' ? 7 : 1;
return self::updatePermissions($share, $params);
}
2013-09-06 18:00:01 +04:00
/**
2013-09-17 13:53:06 +04:00
* @brief update password for public link share
2013-09-17 17:27:10 +04:00
* @param array $share information about the share
2013-09-17 13:53:06 +04:00
* @param type $params 'password'
2013-09-06 18:00:01 +04:00
* @return \OC_OCS_Result
*/
2013-09-17 17:27:10 +04:00
private static function updatePassword($share, $params) {
$itemSource = $share['item_source'];
$itemType = $share['item_type'];
if( (int)$share['share_type'] !== \OCP\Share::SHARE_TYPE_LINK) {
return new \OC_OCS_Result(null, 400, "password protection is only supported for public shares");
}
2013-09-17 13:53:06 +04:00
$shareWith = isset($params['_put']['password']) ? $params['_put']['password'] : null;
2013-09-06 18:00:01 +04:00
2013-09-17 13:53:06 +04:00
if($shareWith === '') {
$shareWith = null;
}
$items = \OCP\Share::getItemShared($itemType, $itemSource);
$checkExists = false;
foreach ($items as $item) {
if($item['share_type'] === \OCP\Share::SHARE_TYPE_LINK) {
$checkExists = true;
$permissions = $item['permissions'];
}
}
if (!$checkExists) {
return new \OC_OCS_Result(null, 404, "share doesn't exists, can't change password");
}
2013-09-18 12:11:20 +04:00
2013-09-17 13:53:06 +04:00
$result = \OCP\Share::shareItem(
$itemType,
$itemSource,
\OCP\Share::SHARE_TYPE_LINK,
$shareWith,
$permissions
);
if($result) {
return new \OC_OCS_Result();
2013-09-06 18:00:01 +04:00
}
2013-09-17 13:53:06 +04:00
return new \OC_OCS_Result(null, 404, "couldn't set password");
}
2013-09-16 19:04:49 +04:00
/**
* @brief unshare a file/folder
2013-09-17 17:27:10 +04:00
* @param array $params contains the shareID 'id' which should be unshared
2013-09-16 19:04:49 +04:00
* @return \OC_OCS_Result
*/
2013-09-17 13:53:06 +04:00
public static function deleteShare($params) {
2013-09-17 17:27:10 +04:00
$share = self::getShareFromId($params['id']);
$itemSource = isset($share['item_source']) ? $share['item_source'] : null;
$itemType = isset($share['item_type']) ? $share['item_type'] : null;;
2013-09-06 18:00:01 +04:00
2013-09-16 19:04:49 +04:00
if($itemSource === null) {
2013-09-17 17:27:10 +04:00
return new \OC_OCS_Result(null, 404, "wrong share ID, share doesn't exist.");
2013-09-16 19:04:49 +04:00
}
2013-09-17 17:27:10 +04:00
$shareWith = isset($share['share_with']) ? $share['share_with'] : null;
$shareType = isset($share['share_type']) ? (int)$share['share_type'] : null;
2013-09-16 19:04:49 +04:00
2013-09-17 17:27:10 +04:00
if( $shareType === \OCP\Share::SHARE_TYPE_LINK) {
2013-09-16 19:04:49 +04:00
$shareWith = null;
}
try {
$return = \OCP\Share::unshare(
$itemType,
$itemSource,
$shareType,
$shareWith);
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 404, $e->getMessage());
}
if ($return) {
return new \OC_OCS_Result();
} else {
$msg = "Unshare Failed";
return new \OC_OCS_Result(null, 404, $msg);
}
}
2013-09-06 12:49:21 +04:00
/**
* @brief get file ID from a given path
* @param string $path
* @return string fileID or null
*/
private static function getFileId($path) {
2013-09-04 19:25:15 +04:00
$view = new \OC\Files\View('/'.\OCP\User::getUser().'/files');
2013-09-06 12:49:21 +04:00
$fileId = null;
2013-09-04 19:25:15 +04:00
$fileInfo = $view->getFileInfo($path);
if ($fileInfo) {
2013-09-06 12:49:21 +04:00
$fileId = $fileInfo['fileid'];
}
return $fileId;
}
/**
* @brief get itemType
* @param string $path
* @return string type 'file', 'folder' or null of file/folder doesn't exists
*/
private static function getItemType($path) {
$view = new \OC\Files\View('/'.\OCP\User::getUser().'/files');
$itemType = null;
if ($view->is_dir($path)) {
$itemType = "folder";
} elseif ($view->is_file($path)) {
$itemType = "file";
2013-09-04 19:25:15 +04:00
}
2013-09-06 12:49:21 +04:00
return $itemType;
2013-09-04 19:25:15 +04:00
}
2013-09-17 17:27:10 +04:00
/**
* @brief get some information from a given share
* @param int $shareID
* @return array with: item_source, share_type, share_with, item_type, permissions
*/
private static function getShareFromId($shareID) {
$sql = 'SELECT `item_source`, `share_type`, `share_with`, `item_type`, `permissions` FROM `*PREFIX*share` WHERE `id` = ?';
$args = array($shareID);
$query = \OCP\DB::prepare($sql);
$result = $query->execute($args);
if (\OCP\DB::isError($result)) {
\OCP\Util::writeLog('files_sharing', \OC_DB::getErrorMessage($result), \OCP\Util::ERROR);
return null;
}
if ($share = $result->fetchRow()) {
return $share;
2013-09-17 17:27:10 +04:00
}
return null;
2013-09-17 17:27:10 +04:00
}
}