summaryrefslogtreecommitdiffstats
path: root/apps/testing/locking/provisioning.php
blob: 55a1be0caee6a38815771ee90e92e6cfaf3ff02c (plain)
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
71
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
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
<?php
/**
 * @author Joas Schilling <nickvergessen@owncloud.com>
 *
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * 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.
 *
 * This program 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\Testing\Locking;

use OC\Lock\DBLockingProvider;
use OC\Lock\MemcacheLockingProvider;
use OC\User\NoUserException;
use OCP\AppFramework\Http;
use OCP\Files\NotFoundException;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IRequest;
use OCP\Lock\ILockingProvider;
use OCP\Lock\LockedException;

class Provisioning {

	/** @var ILockingProvider */
	protected $lockingProvider;

	/** @var IDBConnection */
	protected $connection;

	/** @var IConfig */
	protected $config;

	/** @var IRequest */
	protected $request;

	/**
	 * @param ILockingProvider $lockingProvider
	 * @param IDBConnection $connection
	 * @param IConfig $config
	 * @param IRequest $request
	 */
	public function __construct(ILockingProvider $lockingProvider, IDBConnection $connection, IConfig $config, IRequest $request) {
		$this->lockingProvider = $lockingProvider;
		$this->connection = $connection;
		$this->config = $config;
		$this->request = $request;
	}

	/**
	 * @return ILockingProvider
	 */
	protected function getLockingProvider() {
		if ($this->lockingProvider instanceof DBLockingProvider) {
			return \OC::$server->query('OCA\Testing\Locking\FakeDBLockingProvider');
		} else {
			throw new \RuntimeException('Lock provisioning is only possible using the DBLockingProvider');
		}
	}

	/**
	 * @param array $parameters
	 * @return int
	 */
	protected function getType($parameters) {
		return isset($parameters['type']) ? (int) $parameters['type'] : 0;
	}

	/**
	 * @param array $parameters
	 * @return int
	 */
	protected function getPath($parameters) {
		$node = \OC::$server->getRootFolder()
			->getUserFolder($parameters['user'])
			->get($this->request->getParam('path'));
		return 'files/' . md5($node->getStorage()->getId() . '::' . trim($node->getInternalPath(), '/'));
	}

	/**
	 * @return \OC_OCS_Result
	 */
	public function isLockingEnabled() {
		try {
			$this->getLockingProvider();
			return new \OC_OCS_Result(null, 100);
		} catch (\RuntimeException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_IMPLEMENTED, $e->getMessage());
		}
	}

	/**
	 * @param array $parameters
	 * @return \OC_OCS_Result
	 */
	public function acquireLock(array $parameters) {
		try {
			$path = $this->getPath($parameters);
		} catch (NoUserException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found');
		} catch (NotFoundException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found');
		}
		$type = $this->getType($parameters);

		$lockingProvider = $this->getLockingProvider();

		try {
			$lockingProvider->acquireLock($path, $type);
			$this->config->setAppValue('testing', 'locking_' . $path, $type);
			return new \OC_OCS_Result(null, 100);
		} catch (LockedException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_LOCKED);
		}
	}

	/**
	 * @param array $parameters
	 * @return \OC_OCS_Result
	 */
	public function changeLock(array $parameters) {
		try {
			$path = $this->getPath($parameters);
		} catch (NoUserException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found');
		} catch (NotFoundException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found');
		}
		$type = $this->getType($parameters);

		$lockingProvider = $this->getLockingProvider();

		try {
			$lockingProvider->changeLock($path, $type);
			$this->config->setAppValue('testing', 'locking_' . $path, $type);
			return new \OC_OCS_Result(null, 100);
		} catch (LockedException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_LOCKED);
		}
	}

	/**
	 * @param array $parameters
	 * @return \OC_OCS_Result
	 */
	public function releaseLock(array $parameters) {
		try {
			$path = $this->getPath($parameters);
		} catch (NoUserException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found');
		} catch (NotFoundException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found');
		}
		$type = $this->getType($parameters);

		$lockingProvider = $this->getLockingProvider();

		try {
			$lockingProvider->releaseLock($path, $type);
			$this->config->deleteAppValue('testing', 'locking_' . $path);
			return new \OC_OCS_Result(null, 100);
		} catch (LockedException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_LOCKED);
		}
	}

	/**
	 * @param array $parameters
	 * @return \OC_OCS_Result
	 */
	public function isLocked(array $parameters) {
		try {
			$path = $this->getPath($parameters);
		} catch (NoUserException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'User not found');
		} catch (NotFoundException $e) {
			return new \OC_OCS_Result(null, Http::STATUS_NOT_FOUND, 'Path not found');
		}
		$type = $this->getType($parameters);

		$lockingProvider = $this->getLockingProvider();

		if ($lockingProvider->isLocked($path, $type)) {
			return new \OC_OCS_Result(null, 100);
		}

		return new \OC_OCS_Result(null, Http::STATUS_LOCKED);
	}

	/**
	 * @param array $parameters
	 * @return \OC_OCS_Result
	 */
	public function releaseAll(array $parameters) {
		$type = $this->getType($parameters);

		$lockingProvider = $this->getLockingProvider();

		foreach ($this->config->getAppKeys('testing') as $lock) {
			if (strpos($lock, 'locking_') === 0) {
				$path = substr($lock, strlen('locking_'));

				if ($type === ILockingProvider::LOCK_EXCLUSIVE && $this->config->getAppValue('testing', $lock) == ILockingProvider::LOCK_EXCLUSIVE) {
					$lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock));
				} else if ($type === ILockingProvider::LOCK_SHARED && $this->config->getAppValue('testing', $lock) == ILockingProvider::LOCK_SHARED) {
					$lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock));
				} else {
					$lockingProvider->releaseLock($path, $this->config->getAppValue('testing', $lock));
				}
			}
		}

		return new \OC_OCS_Result(null, 100);
	}
}