Blame view
sources/apps/files_sharing/lib/api.php
18 KB
|
03e52840d
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
<?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 {
/**
|
|
6d9380f96
|
28 |
* get all shares |
|
03e52840d
|
29 30 31 32 33 |
*
* @param array $params option 'file' to limit the result to a specific file/folder
* @return \OC_OCS_Result share information
*/
public static function getAllShares($params) {
|
|
6d9380f96
|
34 35 36 |
if (isset($_GET['shared_with_me']) && $_GET['shared_with_me'] !== 'false') {
return self::getFilesSharedWithMe();
}
|
|
03e52840d
|
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
// 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'];
$params['itemType'] = self::getItemType($_GET['path']);
if ( isset($_GET['reshares']) && $_GET['reshares'] !== 'false' ) {
$params['reshares'] = true;
} else {
$params['reshares'] = false;
}
if (isset($_GET['subfiles']) && $_GET['subfiles'] !== 'false') {
return self::getSharesFromFolder($params);
}
return self::collectShares($params);
}
|
|
6d9380f96
|
54 |
$shares = \OCP\Share::getItemShared('file', null);
|
|
03e52840d
|
55 |
|
|
6d9380f96
|
56 |
if ($shares === false) {
|
|
03e52840d
|
57 58 |
return new \OC_OCS_Result(null, 404, 'could not get shares');
} else {
|
|
6d9380f96
|
59 60 61 62 63 64 65 |
foreach ($shares as &$share) {
if ($share['item_type'] === 'file' && isset($share['path'])) {
$share['mimetype'] = \OC_Helper::getFileNameMimeType($share['path']);
if (\OC::$server->getPreviewManager()->isMimeSupported($share['mimetype'])) {
$share['isPreviewAvailable'] = true;
}
}
|
|
6d9380f96
|
66 67 |
} return new \OC_OCS_Result($shares); |
|
03e52840d
|
68 69 70 71 72 |
} } /** |
|
6d9380f96
|
73 |
* get share information for a given share |
|
03e52840d
|
74 75 76 77 78 79 80 |
*
* @param array $params which contains a 'id'
* @return \OC_OCS_Result share information
*/
public static function getShare($params) {
$s = self::getShareFromId($params['id']);
|
|
837968727
|
81 |
$params['itemSource'] = $s['file_source']; |
|
03e52840d
|
82 83 84 85 86 87 88 |
$params['itemType'] = $s['item_type']; $params['specificShare'] = true; return self::collectShares($params); } /** |
|
6d9380f96
|
89 |
* collect all share information, either of a specific share or all |
|
03e52840d
|
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
* shares for a given path
* @param array $params
* @return \OC_OCS_Result
*/
private static function collectShares($params) {
$itemSource = $params['itemSource'];
$itemType = $params['itemType'];
$getSpecificShare = isset($params['specificShare']) ? $params['specificShare'] : false;
if ($itemSource !== null) {
$shares = \OCP\Share::getItemShared($itemType, $itemSource);
$receivedFrom = \OCP\Share::getItemSharedWithBySource($itemType, $itemSource);
// if a specific share was specified only return this one
if ($getSpecificShare === true) {
foreach ($shares as $share) {
if ($share['id'] === (int) $params['id']) {
$shares = array('element' => $share);
break;
}
}
|
|
837968727
|
111 112 113 114 115 |
} else {
$path = $params['path'];
foreach ($shares as $key => $share) {
$shares[$key]['path'] = $path;
}
|
|
03e52840d
|
116 |
} |
|
837968727
|
117 |
|
|
03e52840d
|
118 119 120 121 122 123 124 |
// include also reshares in the lists. This means that the result
// will contain every user with access to the file.
if (isset($params['reshares']) && $params['reshares'] === true) {
$shares = self::addReshares($shares, $itemSource);
}
if ($receivedFrom) {
|
|
837968727
|
125 126 127 128 |
foreach ($shares as $key => $share) {
$shares[$key]['received_from'] = $receivedFrom['uid_owner'];
$shares[$key]['received_from_displayname'] = \OCP\User::getDisplayName($receivedFrom['uid_owner']);
}
|
|
03e52840d
|
129 130 131 132 133 134 135 136 137 138 139 140 141 |
}
} else {
$shares = null;
}
if ($shares === null || empty($shares)) {
return new \OC_OCS_Result(null, 404, 'share doesn\'t exist');
} else {
return new \OC_OCS_Result($shares);
}
}
/**
|
|
6d9380f96
|
142 |
* add reshares to a array of shares |
|
03e52840d
|
143 144 145 146 147 148 149 150 151 152 153 154 155 |
* @param array $shares array of shares
* @param int $itemSource item source ID
* @return array new shares array which includes reshares
*/
private static function addReshares($shares, $itemSource) {
// if there are no shares than there are also no reshares
$firstShare = reset($shares);
if ($firstShare) {
$path = $firstShare['path'];
} else {
return $shares;
}
|
|
6d9380f96
|
156 |
$select = '`*PREFIX*share`.`id`, `item_type`, `*PREFIX*share`.`parent`, `share_type`, `share_with`, `file_source`, `path` , `*PREFIX*share`.`permissions`, `stime`, `expiration`, `token`, `storage`, `mail_send`, `mail_send`'; |
|
03e52840d
|
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
$getReshares = \OC_DB::prepare('SELECT ' . $select . ' FROM `*PREFIX*share` INNER JOIN `*PREFIX*filecache` ON `file_source` = `*PREFIX*filecache`.`fileid` WHERE `*PREFIX*share`.`file_source` = ? AND `*PREFIX*share`.`item_type` IN (\'file\', \'folder\') AND `uid_owner` != ?');
$reshares = $getReshares->execute(array($itemSource, \OCP\User::getUser()))->fetchAll();
foreach ($reshares as $key => $reshare) {
if (isset($reshare['share_with']) && $reshare['share_with'] !== '') {
$reshares[$key]['share_with_displayname'] = \OCP\User::getDisplayName($reshare['share_with']);
}
// add correct path to the result
$reshares[$key]['path'] = $path;
}
return array_merge($shares, $reshares);
}
/**
|
|
6d9380f96
|
172 |
* get share from all files in a given folder (non-recursive) |
|
03e52840d
|
173 174 175 176 177 178 179 180 |
* @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)) {
|
|
a293d369c
|
181 |
return new \OC_OCS_Result(null, 400, "not a directory"); |
|
03e52840d
|
182 183 184 185 186 187 188 189 190 |
}
$content = $view->getDirectoryContent($path);
$result = array();
foreach ($content as $file) {
// workaround because folders are named 'dir' in this context
$itemType = $file['type'] === 'file' ? 'file' : 'folder';
$share = \OCP\Share::getItemShared($itemType, $file['fileid']);
|
|
a293d369c
|
191 192 |
if($share) {
$receivedFrom = \OCP\Share::getItemSharedWithBySource($itemType, $file['fileid']);
|
|
837968727
|
193 194 |
reset($share); $key = key($share); |
|
a293d369c
|
195 |
if ($receivedFrom) {
|
|
837968727
|
196 197 |
$share[$key]['received_from'] = $receivedFrom['uid_owner']; $share[$key]['received_from_displayname'] = \OCP\User::getDisplayName($receivedFrom['uid_owner']); |
|
a293d369c
|
198 199 |
} $result = array_merge($result, $share); |
|
03e52840d
|
200 201 202 203 204 205 206 |
} } return new \OC_OCS_Result($result); } /** |
|
6d9380f96
|
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
* get files shared with the user
* @return \OC_OCS_Result
*/
private static function getFilesSharedWithMe() {
try {
$shares = \OCP\Share::getItemsSharedWith('file');
foreach ($shares as &$share) {
if ($share['item_type'] === 'file') {
$share['mimetype'] = \OC_Helper::getFileNameMimeType($share['file_target']);
if (\OC::$server->getPreviewManager()->isMimeSupported($share['mimetype'])) {
$share['isPreviewAvailable'] = true;
}
}
}
$result = new \OC_OCS_Result($shares);
} catch (\Exception $e) {
$result = new \OC_OCS_Result(null, 403, $e->getMessage());
}
return $result;
}
/**
* create a new share
|
|
03e52840d
|
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
* @param array $params
* @return \OC_OCS_Result
*/
public static function createShare($params) {
$path = isset($_POST['path']) ? $_POST['path'] : null;
if($path === null) {
return new \OC_OCS_Result(null, 400, "please specify a file or folder 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;
switch($shareType) {
case \OCP\Share::SHARE_TYPE_USER:
$permissions = isset($_POST['permissions']) ? (int)$_POST['permissions'] : 31;
break;
case \OCP\Share::SHARE_TYPE_GROUP:
$permissions = isset($_POST['permissions']) ? (int)$_POST['permissions'] : 31;
break;
case \OCP\Share::SHARE_TYPE_LINK:
//allow password protection
$shareWith = isset($_POST['password']) ? $_POST['password'] : null;
//check public link share
|
|
6d9380f96
|
263 |
$publicUploadEnabled = \OC::$server->getAppConfig()->getValue('core', 'shareapi_allow_public_upload', 'yes');
|
|
a293d369c
|
264 265 |
if(isset($_POST['publicUpload']) && $publicUploadEnabled !== 'yes') {
return new \OC_OCS_Result(null, 403, "public upload disabled by the administrator");
|
|
03e52840d
|
266 267 268 269 270 271 272 |
} $publicUpload = isset($_POST['publicUpload']) ? $_POST['publicUpload'] : 'false'; // read, create, update (7) if public upload is enabled or // read (1) if public upload is disabled $permissions = $publicUpload === 'true' ? 7 : 1; break; default: |
|
a293d369c
|
273 |
return new \OC_OCS_Result(null, 400, "unknown share type"); |
|
03e52840d
|
274 275 276 277 278 279 280 281 282 283 284 |
}
try {
$token = \OCP\Share::shareItem(
$itemType,
$itemSource,
$shareType,
$shareWith,
$permissions
);
} catch (\Exception $e) {
|
|
a293d369c
|
285 |
return new \OC_OCS_Result(null, 403, $e->getMessage()); |
|
03e52840d
|
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
}
if ($token) {
$data = array();
$data['id'] = 'unknown';
$shares = \OCP\Share::getItemShared($itemType, $itemSource);
if(is_string($token)) { //public link share
foreach ($shares as $share) {
if ($share['token'] === $token) {
$data['id'] = $share['id'];
break;
}
}
$url = \OCP\Util::linkToPublic('files&t='.$token);
$data['url'] = $url; // '&' gets encoded to $amp;
$data['token'] = $token;
} else {
foreach ($shares as $share) {
if ($share['share_with'] === $shareWith && $share['share_type'] === $shareType) {
$data['id'] = $share['id'];
break;
}
}
}
return new \OC_OCS_Result($data);
} else {
return new \OC_OCS_Result(null, 404, "couldn't share file");
}
}
/**
* update shares, e.g. password, permissions, etc
* @param array $params shareId 'id' and the parameter we want to update
* currently supported: permissions, password, publicUpload
* @return \OC_OCS_Result
*/
public static function updateShare($params) {
$share = self::getShareFromId($params['id']);
|
|
03e52840d
|
326 |
|
|
837968727
|
327 |
if(!isset($share['file_source'])) {
|
|
03e52840d
|
328 329 330 331 332 333 334 335 336 337 |
return new \OC_OCS_Result(null, 404, "wrong share Id, share doesn't exist.");
}
try {
if(isset($params['_put']['permissions'])) {
return self::updatePermissions($share, $params);
} elseif (isset($params['_put']['password'])) {
return self::updatePassword($share, $params);
} elseif (isset($params['_put']['publicUpload'])) {
return self::updatePublicUpload($share, $params);
|
|
6d9380f96
|
338 339 |
} elseif (isset($params['_put']['expireDate'])) {
return self::updateExpireDate($share, $params);
|
|
03e52840d
|
340 341 |
}
} catch (\Exception $e) {
|
|
6d9380f96
|
342 |
|
|
03e52840d
|
343 344 345 346 347 348 349 350 |
return new \OC_OCS_Result(null, 400, $e->getMessage()); } return new \OC_OCS_Result(null, 400, "Wrong or no update parameter given"); } /** |
|
6d9380f96
|
351 |
* update permissions for a share |
|
03e52840d
|
352 353 354 355 356 357 358 359 360 361 362 |
* @param array $share information about the share
* @param array $params contains 'permissions'
* @return \OC_OCS_Result
*/
private static function updatePermissions($share, $params) {
$itemSource = $share['item_source'];
$itemType = $share['item_type'];
$shareWith = $share['share_with'];
$shareType = $share['share_type'];
$permissions = isset($params['_put']['permissions']) ? (int)$params['_put']['permissions'] : null;
|
|
6d9380f96
|
363 |
$publicUploadStatus = \OC::$server->getAppConfig()->getValue('core', 'shareapi_allow_public_upload', 'yes');
|
|
a293d369c
|
364 |
$publicUploadEnabled = ($publicUploadStatus === 'yes') ? true : false; |
|
03e52840d
|
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
// 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");
}
}
try {
$return = \OCP\Share::setPermissions(
$itemType,
$itemSource,
$shareType,
$shareWith,
$permissions
);
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 404, $e->getMessage());
}
if ($return) {
return new \OC_OCS_Result();
} else {
return new \OC_OCS_Result(null, 404, "couldn't set permissions");
}
}
/**
|
|
6d9380f96
|
394 |
* enable/disable public upload |
|
03e52840d
|
395 396 397 398 399 |
* @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) {
|
|
6d9380f96
|
400 |
$publicUploadEnabled = \OC::$server->getAppConfig()->getValue('core', 'shareapi_allow_public_upload', 'yes');
|
|
a293d369c
|
401 402 |
if($publicUploadEnabled !== 'yes') {
return new \OC_OCS_Result(null, 403, "public upload disabled by the administrator");
|
|
03e52840d
|
403 404 405 406 |
}
if ($share['item_type'] !== 'folder' ||
(int)$share['share_type'] !== \OCP\Share::SHARE_TYPE_LINK ) {
|
|
6d9380f96
|
407 |
return new \OC_OCS_Result(null, 400, "public upload is only possible for public shared folders"); |
|
03e52840d
|
408 409 410 411 412 413 414 415 416 417 418 |
} // read, create, update (7) if public upload is enabled or // read (1) if public upload is disabled $params['_put']['permissions'] = $params['_put']['publicUpload'] === 'true' ? 7 : 1; return self::updatePermissions($share, $params); } /** |
|
6d9380f96
|
419 |
* set expire date for public link share |
|
03e52840d
|
420 |
* @param array $share information about the share |
|
6d9380f96
|
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
* @param array $params contains 'expireDate' which needs to be a well formated date string, e.g DD-MM-YYYY
* @return \OC_OCS_Result
*/
private static function updateExpireDate($share, $params) {
// only public links can have a expire date
if ((int)$share['share_type'] !== \OCP\Share::SHARE_TYPE_LINK ) {
return new \OC_OCS_Result(null, 400, "expire date only exists for public link shares");
}
try {
$expireDateSet = \OCP\Share::setExpirationDate($share['item_type'], $share['item_source'], $params['_put']['expireDate'], (int)$share['stime']);
$result = ($expireDateSet) ? new \OC_OCS_Result() : new \OC_OCS_Result(null, 404, "couldn't set expire date");
} catch (\Exception $e) {
$result = new \OC_OCS_Result(null, 404, $e->getMessage());
}
return $result;
}
/**
* update password for public link share
* @param array $share information about the share
* @param array $params 'password'
|
|
03e52840d
|
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
* @return \OC_OCS_Result
*/
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");
}
$shareWith = isset($params['_put']['password']) ? $params['_put']['password'] : null;
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");
}
|
|
6d9380f96
|
475 476 477 478 479 480 481 482 483 484 485 |
try {
$result = \OCP\Share::shareItem(
$itemType,
$itemSource,
\OCP\Share::SHARE_TYPE_LINK,
$shareWith,
$permissions
);
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 403, $e->getMessage());
}
|
|
03e52840d
|
486 487 488 489 490 491 492 493 |
if($result) {
return new \OC_OCS_Result();
}
return new \OC_OCS_Result(null, 404, "couldn't set password");
}
/**
|
|
6d9380f96
|
494 |
* unshare a file/folder |
|
03e52840d
|
495 496 497 498 499 500 |
* @param array $params contains the shareID 'id' which should be unshared
* @return \OC_OCS_Result
*/
public static function deleteShare($params) {
$share = self::getShareFromId($params['id']);
|
|
837968727
|
501 |
$fileSource = isset($share['file_source']) ? $share['file_source'] : null; |
|
03e52840d
|
502 |
$itemType = isset($share['item_type']) ? $share['item_type'] : null;; |
|
837968727
|
503 |
if($fileSource === null) {
|
|
03e52840d
|
504 505 506 507 508 509 510 511 512 513 514 515 516 |
return new \OC_OCS_Result(null, 404, "wrong share ID, share doesn't exist.");
}
$shareWith = isset($share['share_with']) ? $share['share_with'] : null;
$shareType = isset($share['share_type']) ? (int)$share['share_type'] : null;
if( $shareType === \OCP\Share::SHARE_TYPE_LINK) {
$shareWith = null;
}
try {
$return = \OCP\Share::unshare(
$itemType,
|
|
837968727
|
517 |
$fileSource, |
|
03e52840d
|
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 |
$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);
}
}
/**
|
|
6d9380f96
|
533 |
* get file ID from a given path |
|
03e52840d
|
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 |
* @param string $path
* @return string fileID or null
*/
private static function getFileId($path) {
$view = new \OC\Files\View('/'.\OCP\User::getUser().'/files');
$fileId = null;
$fileInfo = $view->getFileInfo($path);
if ($fileInfo) {
$fileId = $fileInfo['fileid'];
}
return $fileId;
}
/**
|
|
6d9380f96
|
550 |
* get itemType |
|
03e52840d
|
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 |
* @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";
}
return $itemType;
}
/**
|
|
6d9380f96
|
568 |
* get some information from a given share |
|
03e52840d
|
569 570 571 572 |
* @param int $shareID
* @return array with: item_source, share_type, share_with, item_type, permissions
*/
private static function getShareFromId($shareID) {
|
|
6d9380f96
|
573 |
$sql = 'SELECT `file_source`, `item_source`, `share_type`, `share_with`, `item_type`, `permissions`, `stime` FROM `*PREFIX*share` WHERE `id` = ?'; |
|
03e52840d
|
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 |
$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;
}
return null;
}
}
|