ocs api for file sharing

This commit is contained in:
Bjoern Schiessle 2013-09-16 17:04:49 +02:00
parent 3861c9bce1
commit 14437ffd15
2 changed files with 84 additions and 61 deletions

View File

@ -4,10 +4,9 @@ function() {
require_once __DIR__ . '/../ajax/publicpreview.php';
});
//TODO: SET: unshare
//TODO: SET: expire date
//TODO: SET: mail notification
//TODO: SET: can upload
// OCS API
//TODO: SET: mail notification, waiting for PR #4689 to be accepted
OC_API::register('get',
'/apps/files_sharing/api/share/{path}',
@ -41,25 +40,10 @@ OC_API::register('post',
array('path' => ''),
array('path' => '.+'));
/*
OC_API::register('get',
'/apps/files_sharing/api/permission/{path}',
array('\OCA\Files\Share\Api', 'getShare'),
OC_API::register('post',
'/apps/files_sharing/api/unshare/{path}',
array('\OCA\Files\Share\Api', 'setUnshare'),
'files_sharing',
OC_API::USER_AUTH,
array('path' => ''));
OC_API::register('get',
'/apps/files_sharing/api/expire/{path}',
array('\OCA\Files\Share\Api', 'getShare'),
'files_sharing',
OC_API::USER_AUTH,
array('path' => ''));
OC_API::register('get',
'/apps/files_sharing/api/notify/{path}',
array('\OCA\Files\Share\Api', 'getShare'),
'files_sharing',
OC_API::USER_AUTH,
array('path' => ''));
*/
array('path' => ''),
array('path' => '.+'));

View File

@ -50,7 +50,8 @@ class Api {
/**
* @brief share file with a user/group, path to file is encoded in URL
*
* @param array $params with following parameters 'shareWith', 'shareType'
* @param array $params with following parameters 'shareWith', 'shareType', 'path'
* optional 'publicUpload' and 'password' for public shares
* @return \OC_OCS_Result result of share operation
*/
public static function setShare($params) {
@ -69,32 +70,29 @@ class Api {
switch($shareType) {
case \OCP\Share::SHARE_TYPE_USER:
$permission = 31;
if (!\OCP\User::userExists($shareWith)) {
return new \OC_OCS_Result(null, 404, "user doesn't exist");
}
break;
case \OCP\Share::SHARE_TYPE_GROUP:
$permission = 31;
if (!\OC_Group::groupExists($shareWith)) {
return new \OC_OCS_Result(null, 404, "group doesn't exist");
}
break;
case \OCP\Share::SHARE_TYPE_LINK:
$permission = 1;
$shareWith = null;
//allow password protection
$shareWith = isset($_POST['password']) ? $_POST['password'] : null;
$publicUpload = isset($_POST['publicUpload']) ? $_POST['publicUpload'] : 'no';
$permission = self::getPublicLinkSharePermissions($publicUpload);
break;
default:
return new \OC_OCS_Result(null, 404, "unknown share type");
}
$token = \OCP\Share::shareItem(
try {
$token = \OCP\Share::shareItem(
$itemType,
$itemSource,
$shareType,
$shareWith,
$permission
);
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 404, $e->getMessage());
}
if ($token) {
$data = null;
@ -127,32 +125,18 @@ class Api {
$shareType = isset($_POST['shareType']) ? (int)$_POST['shareType'] : null;
$permission = isset($_POST['permission']) ? (int)$_POST['permission'] : null;
switch($shareType) {
case \OCP\Share::SHARE_TYPE_USER:
if (!\OCP\User::userExists($shareWith)) {
return new \OC_OCS_Result(null, 404, "user doesn't exist");
}
break;
case \OCP\Share::SHARE_TYPE_GROUP:
if (!\OC_Group::groupExists($shareWith)) {
return new \OC_OCS_Result(null, 404, "group doesn't exist");
}
break;
case \OCP\Share::SHARE_TYPE_LINK:
break;
default:
return new \OC_OCS_Result(null, 404, "unknown share type");
try {
$return = \OCP\Share::setPermissions(
$itemType,
$itemSource,
$shareType,
$shareWith,
$permission
);
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 404, $e->getMessage());
}
$return = \OCP\Share::setPermissions(
$itemType,
$itemSource,
$shareType,
$shareWith,
$permission
);
if ($return) {
return new \OC_OCS_Result();
} else {
@ -187,8 +171,63 @@ class Api {
$msg = "Failed, please check the expire date, expected format 'DD-MM-YYYY'.";
return new \OC_OCS_Result(null, 404, $msg);
}
}
/**
* @brief unshare a file/folder
* @param array $params with following parameters 'shareWith', 'shareType', 'path'
* @return \OC_OCS_Result
*/
public static function setUnshare($params) {
$path = $params['path'];
$itemSource = self::getFileId($path);
$itemType = self::getItemType($path);
if($itemSource === null) {
return new \OC_OCS_Result(null, 404, "wrong path, file/folder doesn't exist.");
}
$shareWith = isset($_POST['shareWith']) ? $_POST['shareWith'] : null;
$shareType = isset($_POST['shareType']) ? (int)$_POST['shareType'] : null;
if( $shareType == \OCP\Share::SHARE_TYPE_LINK) {
$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);
}
}
/**
* @brief get public link share permissions to allow/forbid public uploads
* @param string $publicUpload 'yes' or 'no'
* @return int permissions read (1) or create,update,read (7)
*/
private static function getPublicLinkSharePermissions($publicUpload) {
$publicUploadEnabled = \OC_Appconfig::getValue('core', 'shareapi_allow_public_upload', 'yes');
if(\OC_App::isEnabled('files_encryption') ||
$publicUploadEnabled !== 'yes' ||
$publicUpload === 'no') {
return 1; // read
} else {
return 7; // create, update, read
}
}
/**