Blame view

sources/apps/files_sharing/lib/api.php 16.3 KB
03e52840d   Kload   Init
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
  <?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 {
  
  	/**
  	 * @brief get all shares
  	 *
  	 * @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) {
  		// 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);
  		}
  
  		$share = \OCP\Share::getItemShared('file', null);
  
  		if ($share === false) {
  			return new \OC_OCS_Result(null, 404, 'could not get shares');
  		} else {
  			return new \OC_OCS_Result($share);
  		}
  
  	}
  
  	/**
  	 * @brief get share information for a given share
  	 *
  	 * @param array $params which contains a 'id'
  	 * @return \OC_OCS_Result share information
  	 */
  	public static function getShare($params) {
  
  		$s = self::getShareFromId($params['id']);
837968727   Kload   [enh] Upgrade to ...
71
  		$params['itemSource'] = $s['file_source'];
03e52840d   Kload   Init
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
  		$params['itemType'] = $s['item_type'];
  		$params['specificShare'] = true;
  
  		return self::collectShares($params);
  	}
  
  	/**
  	 * @brief collect all share information, either of a specific share or all
  	 *        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   Kload   [enh] Upgrade to ...
101
102
103
104
105
  			} else {
  				$path = $params['path'];
  				foreach ($shares as $key => $share) {
  					$shares[$key]['path'] = $path;
  				}
03e52840d   Kload   Init
106
  			}
837968727   Kload   [enh] Upgrade to ...
107

03e52840d   Kload   Init
108
109
110
111
112
113
114
  			// 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   Kload   [enh] Upgrade to ...
115
116
117
118
  				foreach ($shares as $key => $share) {
  					$shares[$key]['received_from'] = $receivedFrom['uid_owner'];
  					$shares[$key]['received_from_displayname'] = \OCP\User::getDisplayName($receivedFrom['uid_owner']);
  				}
03e52840d   Kload   Init
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
  			}
  		} 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);
  		}
  	}
  
  	/**
  	 * @brief add reshares to a array of shares
  	 * @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;
  		}
31b7f2792   Kload   Upgrade to ownclo...
146
  		$select = '`*PREFIX*share`.`id`, `item_type`, `*PREFIX*share`.`parent`, `share_type`, `share_with`, `file_source`, `path` , `permissions`, `stime`, `expiration`, `token`, `storage`, `mail_send`, `mail_send`';
03e52840d   Kload   Init
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
  		$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);
  	}
  
  	/**
  	 * @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)) {
a293d369c   Kload   Update sources to...
171
  			return new \OC_OCS_Result(null, 400, "not a directory");
03e52840d   Kload   Init
172
173
174
175
176
177
178
179
180
  		}
  
  		$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   Kload   Update sources to...
181
182
  			if($share) {
  				$receivedFrom =  \OCP\Share::getItemSharedWithBySource($itemType, $file['fileid']);
837968727   Kload   [enh] Upgrade to ...
183
184
185
  				reset($share);
  				$key = key($share);
  				$share[$key]['path'] = self::correctPath($share[$key]['path'], $path);
a293d369c   Kload   Update sources to...
186
  				if ($receivedFrom) {
837968727   Kload   [enh] Upgrade to ...
187
188
  					$share[$key]['received_from'] = $receivedFrom['uid_owner'];
  					$share[$key]['received_from_displayname'] = \OCP\User::getDisplayName($receivedFrom['uid_owner']);
a293d369c   Kload   Update sources to...
189
190
  				}
  				$result = array_merge($result, $share);
03e52840d   Kload   Init
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
  			}
  		}
  
  		return new \OC_OCS_Result($result);
  	}
  
  	/**
  	 * @breif create a new share
  	 * @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
  				$publicUploadEnabled = \OC_Appconfig::getValue('core', 'shareapi_allow_public_upload', 'yes');
a293d369c   Kload   Update sources to...
231
232
  				if(isset($_POST['publicUpload']) && $publicUploadEnabled !== 'yes') {
  					return new \OC_OCS_Result(null, 403, "public upload disabled by the administrator");
03e52840d   Kload   Init
233
234
235
236
237
238
239
  				}
  				$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   Kload   Update sources to...
240
  				return new \OC_OCS_Result(null, 400, "unknown share type");
03e52840d   Kload   Init
241
242
243
244
245
246
247
248
249
250
251
  		}
  
  		try	{
  			$token = \OCP\Share::shareItem(
  					$itemType,
  					$itemSource,
  					$shareType,
  					$shareWith,
  					$permissions
  					);
  		} catch (\Exception $e) {
a293d369c   Kload   Update sources to...
252
  			return new \OC_OCS_Result(null, 403, $e->getMessage());
03e52840d   Kload   Init
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
  		}
  
  		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   Kload   Init
293

837968727   Kload   [enh] Upgrade to ...
294
  		if(!isset($share['file_source'])) {
03e52840d   Kload   Init
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
326
327
328
  			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);
  			}
  		} catch (\Exception $e) {
  			return new \OC_OCS_Result(null, 400, $e->getMessage());
  		}
  
  		return new \OC_OCS_Result(null, 400, "Wrong or no update parameter given");
  
  	}
  
  	/**
  	 * @brief update permissions for a share
  	 * @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;
  
  		$publicUploadStatus = \OC_Appconfig::getValue('core', 'shareapi_allow_public_upload', 'yes');
a293d369c   Kload   Update sources to...
329
  		$publicUploadEnabled = ($publicUploadStatus === 'yes') ? true : false;
03e52840d   Kload   Init
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
  
  		// 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");
  		}
  	}
  
  	/**
  	 * @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');
a293d369c   Kload   Update sources to...
367
368
  		if($publicUploadEnabled !== 'yes') {
  			return new \OC_OCS_Result(null, 403, "public upload disabled by the administrator");
03e52840d   Kload   Init
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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
  		}
  
  		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'] === 'true' ? 7 : 1;
  
  		return self::updatePermissions($share, $params);
  
  	}
  
  	/**
  	 * @brief update password for public link share
  	 * @param array $share information about the share
  	 * @param type $params 'password'
  	 * @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");
  		}
  
  		$result = \OCP\Share::shareItem(
  				$itemType,
  				$itemSource,
  				\OCP\Share::SHARE_TYPE_LINK,
  				$shareWith,
  				$permissions
  				);
  		if($result) {
  			return new \OC_OCS_Result();
  		}
  
  		return new \OC_OCS_Result(null, 404, "couldn't set password");
  	}
  
  	/**
  	 * @brief unshare a file/folder
  	 * @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   Kload   [enh] Upgrade to ...
441
  		$fileSource = isset($share['file_source']) ? $share['file_source'] : null;
03e52840d   Kload   Init
442
  		$itemType = isset($share['item_type']) ? $share['item_type'] : null;;
837968727   Kload   [enh] Upgrade to ...
443
  		if($fileSource === null) {
03e52840d   Kload   Init
444
445
446
447
448
449
450
451
452
453
454
455
456
  			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   Kload   [enh] Upgrade to ...
457
  					$fileSource,
03e52840d   Kload   Init
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
  					$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 file ID from a given path
  	 * @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;
  	}
  
  	/**
  	 * @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";
  		}
  
  		return $itemType;
  	}
  
  	/**
  	 * @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) {
837968727   Kload   [enh] Upgrade to ...
513
  		$sql = 'SELECT `file_source`, `item_source`, `share_type`, `share_with`, `item_type`, `permissions` FROM `*PREFIX*share` WHERE `id` = ?';
03e52840d   Kload   Init
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
  		$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;
  
  	}
837968727   Kload   [enh] Upgrade to ...
529
530
531
532
533
534
535
536
537
538
  	/**
  	 * @brief make sure that the path has the correct root
  	 *
  	 * @param string $path path returned from the share API
  	 * @param string $folder current root folder
  	 * @return string the correct path
  	 */
  	protected static function correctPath($path, $folder) {
  		return \OC_Filesystem::normalizePath('/' . $folder . '/' . basename($path));
  	}
03e52840d   Kload   Init
539
  }