helper.php 9 KB
Newer Older
1
2
<?php
/**
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
3
4
5
6
7
8
9
 * @author Björn Schießle <schiessle@owncloud.com>
 * @author Joas Schilling <nickvergessen@owncloud.com>
 * @author Miguel Prokop <miguel.prokop@vtu.com>
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Robin McCorkell <rmccorkell@karoshi.org.uk>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 * @author Vincent Petry <pvince81@owncloud.com>
10
 *
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
11
12
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
13
 *
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
14
15
16
 * 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.
17
 *
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
18
 * This program is distributed in the hope that it will be useful,
19
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
20
21
22
23
24
 * 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/>
25
26
27
28
29
30
31
32
33
 *
 */

namespace OC\Share;

class Helper extends \OC\Share\Constants {

	/**
	 * Generate a unique target for the item
34
35
36
37
38
39
40
	 * @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 $uidOwner User that is the owner of shared item
	 * @param string $suggestedTarget The suggested target originating from a reshare (optional)
	 * @param int $groupParent The id of the parent group share (optional)
41
	 * @throws \Exception
42
43
	 * @return string Item target
	 */
44
	public static function generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner, $suggestedTarget = null, $groupParent = null) {
45
		// FIXME: $uidOwner and $groupParent seems to be unused
46
		$backend = \OC\Share\Share::getBackend($itemType);
47
		if ($shareType === self::SHARE_TYPE_LINK || $shareType === self::SHARE_TYPE_REMOTE) {
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
			if (isset($suggestedTarget)) {
				return $suggestedTarget;
			}
			return $backend->generateTarget($itemSource, false);
		} else {
			if ($itemType == 'file' || $itemType == 'folder') {
				$column = 'file_target';
				$columnSource = 'file_source';
			} else {
				$column = 'item_target';
				$columnSource = 'item_source';
			}
			if ($shareType == self::SHARE_TYPE_USER) {
				// Share with is a user, so set share type to user and groups
				$shareType = self::$shareTypeUserAndGroups;
			}
64
			$exclude = array();
65
66
67
68
69

			$result = \OCP\Share::getItemsSharedWithUser($itemType, $shareWith);
			foreach ($result as $row) {
				if ($row['permissions'] > 0) {
					$exclude[] = $row[$column];
70
71
				}
			}
72
73
74
75
76
77
78
79
80
81
82
83

			// Check if suggested target exists first
			if (!isset($suggestedTarget)) {
				$suggestedTarget = $itemSource;
			}
			if ($shareType == self::SHARE_TYPE_GROUP) {
				$target = $backend->generateTarget($suggestedTarget, false, $exclude);
			} else {
				$target = $backend->generateTarget($suggestedTarget, $shareWith, $exclude);
			}

			return $target;
84
85
86
87
		}
	}

	/**
88
	 * Delete all reshares and group share children of an item
89
90
	 * @param int $parent Id of item to delete
	 * @param bool $excludeParent If true, exclude the parent from the delete (optional)
91
	 * @param string $uidOwner The user that the parent was shared with (optional)
92
	 * @param int $newParent new parent for the childrens
93
	 * @param bool $excludeGroupChildren exclude group children elements
94
	 */
95
	public static function delete($parent, $excludeParent = false, $uidOwner = null, $newParent = null, $excludeGroupChildren = false) {
96
		$ids = array($parent);
97
		$deletedItems = array();
98
		$changeParent = array();
99
100
101
102
103
		$parents = array($parent);
		while (!empty($parents)) {
			$parents = "'".implode("','", $parents)."'";
			// Check the owner on the first search of reshares, useful for
			// finding and deleting the reshares by a single user of a group share
104
			$params = array();
105
			if (count($ids) == 1 && isset($uidOwner)) {
106
107
108
109
110
111
				// FIXME: don't concat $parents, use Docrine's PARAM_INT_ARRAY approach
				$queryString = 'SELECT `id`, `share_with`, `item_type`, `share_type`, ' .
					'`item_target`, `file_target`, `parent` ' .
					'FROM `*PREFIX*share` ' .
					'WHERE `parent` IN ('.$parents.') AND `uid_owner` = ? ';
				$params[] = $uidOwner;
112
			} else {
113
114
115
				$queryString = 'SELECT `id`, `share_with`, `item_type`, `share_type`, ' .
					'`item_target`, `file_target`, `parent`, `uid_owner` ' .
					'FROM `*PREFIX*share` WHERE `parent` IN ('.$parents.') ';
116
			}
117
118
119
120
121
122
			if ($excludeGroupChildren) {
				$queryString .= ' AND `share_type` != ?';
				$params[] = self::$shareTypeGroupUserUnique;
			}
			$query = \OC_DB::prepare($queryString);
			$result = $query->execute($params);
123
124
125
			// Reset parents array, only go through loop again if items are found
			$parents = array();
			while ($item = $result->fetchRow()) {
126
127
128
129
130
131
132
133
134
135
				$tmpItem = array(
					'id' => $item['id'],
					'shareWith' => $item['share_with'],
					'itemTarget' => $item['item_target'],
					'itemType' => $item['item_type'],
					'shareType' => (int)$item['share_type'],
				);
				if (isset($item['file_target'])) {
					$tmpItem['fileTarget'] = $item['file_target'];
				}
136
137
138
139
140
141
142
143
144
145
				// if we have a new parent for the child we remember the child
				// to update the parent, if not we add it to the list of items
				// which should be deleted
				if ($newParent !== null) {
					$changeParent[] = $item['id'];
				} else {
					$deletedItems[] = $tmpItem;
					$ids[] = $item['id'];
					$parents[] = $item['id'];
				}
146
147
148
149
150
			}
		}
		if ($excludeParent) {
			unset($ids[0]);
		}
151
152
153
154
155
156
157

		if (!empty($changeParent)) {
			$idList = "'".implode("','", $changeParent)."'";
			$query = \OC_DB::prepare('UPDATE `*PREFIX*share` SET `parent` = ? WHERE `id` IN ('.$idList.')');
			$query->execute(array($newParent));
		}

158
		if (!empty($ids)) {
159
160
			$idList = "'".implode("','", $ids)."'";
			$query = \OC_DB::prepare('DELETE FROM `*PREFIX*share` WHERE `id` IN ('.$idList.')');
161
162
			$query->execute();
		}
163
164

		return $deletedItems;
165
	}
166
167

	/**
168
	 * get default expire settings defined by the admin
169
170
171
172
	 * @return array contains 'defaultExpireDateSet', 'enforceExpireDate', 'expireAfterDays'
	 */
	public static function getDefaultExpireSetting() {

173
174
		$config = \OC::$server->getConfig();

175
176
177
		$defaultExpireSettings = array('defaultExpireDateSet' => false);

		// get default expire settings
178
		$defaultExpireDate = $config->getAppValue('core', 'shareapi_default_expire_date', 'no');
179
		if ($defaultExpireDate === 'yes') {
180
			$enforceExpireDate = $config->getAppValue('core', 'shareapi_enforce_expire_date', 'no');
181
			$defaultExpireSettings['defaultExpireDateSet'] = true;
182
			$defaultExpireSettings['expireAfterDays'] = (int)($config->getAppValue('core', 'shareapi_expire_after_n_days', '7'));
183
184
185
186
187
188
			$defaultExpireSettings['enforceExpireDate'] = $enforceExpireDate === 'yes' ? true : false;
		}

		return $defaultExpireSettings;
	}

Bjoern Schiessle's avatar
Bjoern Schiessle committed
189
190
191
192
193
194
195
196
197
198
199
200
	public static function calcExpireDate() {
		$expireAfter = \OC\Share\Share::getExpireInterval() * 24 * 60 * 60;
		$expireAt = time() + $expireAfter;
		$date = new \DateTime();
		$date->setTimestamp($expireAt);
		$date->setTime(0, 0, 0);
		//$dateString = $date->format('Y-m-d') . ' 00:00:00';

		return $date;

	}

201
	/**
202
	 * calculate expire date
203
204
205
206
207
208
209
210
	 * @param array $defaultExpireSettings contains 'defaultExpireDateSet', 'enforceExpireDate', 'expireAfterDays'
	 * @param int $creationTime timestamp when the share was created
	 * @param int $userExpireDate expire timestamp set by the user
	 * @return mixed integer timestamp or False
	 */
	public static function calculateExpireDate($defaultExpireSettings, $creationTime, $userExpireDate = null) {

		$expires = false;
211
		$defaultExpires = null;
212

213
		if (!empty($defaultExpireSettings['defaultExpireDateSet'])) {
214
			$defaultExpires = $creationTime + $defaultExpireSettings['expireAfterDays'] * 86400;
215
216
217
218
219
220
		}


		if (isset($userExpireDate)) {
			// if the admin decided to enforce the default expire date then we only take
			// the user defined expire date of it is before the default expire date
221
222
			if ($defaultExpires && !empty($defaultExpireSettings['enforceExpireDate'])) {
				$expires = min($userExpireDate, $defaultExpires);
223
224
225
			} else {
				$expires = $userExpireDate;
			}
226
227
		} else if ($defaultExpires && !empty($defaultExpireSettings['enforceExpireDate'])) {
			$expires = $defaultExpires;
228
229
230
231
		}

		return $expires;
	}
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

	/**
	 * Extracts the necessary remote name from a given link
	 *
	 * Strips away a potential file name, to allow
	 * - user
	 * - user@localhost
	 * - user@http://localhost
	 * - user@http://localhost/
	 * - user@http://localhost/index.php
	 * - user@http://localhost/index.php/s/{shareToken}
	 *
	 * @param string $shareWith
	 * @return string
	 */
	public static function fixRemoteURLInShareWith($shareWith) {
		if (strpos($shareWith, '@')) {
			list($user, $remote) = explode('@', $shareWith, 2);

			$remote = str_replace('\\', '/', $remote);
			if ($fileNamePosition = strpos($remote, '/index.php')) {
				$remote = substr($remote, 0, $fileNamePosition);
			}
			$remote = rtrim($remote, '/');

			$shareWith = $user . '@' . $remote;
		}

		return rtrim($shareWith, '/');
	}
262
}