AbstractLockingProvider.php 3.64 KB
Newer Older
1
2
3
4
<?php
/**
 * @author Robin Appelman <icewind@owncloud.com>
 *
Thomas Müller's avatar
Thomas Müller committed
5
 * @copyright Copyright (c) 2016, ownCloud, Inc.
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 * @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 OC\Lock;

use OCP\Lock\ILockingProvider;

Robin Appelman's avatar
Robin Appelman committed
26
27
28
29
/**
 * Base locking provider that keeps track of locks acquired during the current request
 * to release any left over locks at the end of the request
 */
30
abstract class AbstractLockingProvider implements ILockingProvider {
Robin Appelman's avatar
Robin Appelman committed
31
	protected $ttl; // how long until we clear stray locks in seconds
32

33
34
35
36
37
	protected $acquiredLocks = [
		'shared' => [],
		'exclusive' => []
	];

Robin Appelman's avatar
Robin Appelman committed
38
39
40
41
42
43
44
	/**
	 * Check if we've locally acquired a lock
	 *
	 * @param string $path
	 * @param int $type
	 * @return bool
	 */
45
46
47
48
49
50
51
52
	protected function hasAcquiredLock($path, $type) {
		if ($type === self::LOCK_SHARED) {
			return isset($this->acquiredLocks['shared'][$path]) && $this->acquiredLocks['shared'][$path] > 0;
		} else {
			return isset($this->acquiredLocks['exclusive'][$path]) && $this->acquiredLocks['exclusive'][$path] === true;
		}
	}

53
	/**
Robin Appelman's avatar
Robin Appelman committed
54
55
	 * Mark a locally acquired lock
	 *
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
	 * @param string $path
	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
	 */
	protected function markAcquire($path, $type) {
		if ($type === self::LOCK_SHARED) {
			if (!isset($this->acquiredLocks['shared'][$path])) {
				$this->acquiredLocks['shared'][$path] = 0;
			}
			$this->acquiredLocks['shared'][$path]++;
		} else {
			$this->acquiredLocks['exclusive'][$path] = true;
		}
	}

	/**
Robin Appelman's avatar
Robin Appelman committed
71
72
	 * Mark a release of a locally acquired lock
	 *
73
74
75
76
77
78
79
80
81
82
83
84
85
86
	 * @param string $path
	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
	 */
	protected function markRelease($path, $type) {
		if ($type === self::LOCK_SHARED) {
			if (isset($this->acquiredLocks['shared'][$path]) and $this->acquiredLocks['shared'][$path] > 0) {
				$this->acquiredLocks['shared'][$path]--;
			}
		} else if ($type === self::LOCK_EXCLUSIVE) {
			unset($this->acquiredLocks['exclusive'][$path]);
		}
	}

	/**
Robin Appelman's avatar
Robin Appelman committed
87
	 * Change the type of an existing tracked lock
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
	 *
	 * @param string $path
	 * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE
	 */
	protected function markChange($path, $targetType) {
		if ($targetType === self::LOCK_SHARED) {
			unset($this->acquiredLocks['exclusive'][$path]);
			if (!isset($this->acquiredLocks['shared'][$path])) {
				$this->acquiredLocks['shared'][$path] = 0;
			}
			$this->acquiredLocks['shared'][$path]++;
		} else if ($targetType === self::LOCK_EXCLUSIVE) {
			$this->acquiredLocks['exclusive'][$path] = true;
			$this->acquiredLocks['shared'][$path]--;
		}
	}

	/**
Robin Appelman's avatar
Robin Appelman committed
106
	 * release all lock acquired by this instance which were marked using the mark* methods
107
108
109
110
111
112
113
114
115
116
117
118
	 */
	public function releaseAll() {
		foreach ($this->acquiredLocks['shared'] as $path => $count) {
			for ($i = 0; $i < $count; $i++) {
				$this->releaseLock($path, self::LOCK_SHARED);
			}
		}

		foreach ($this->acquiredLocks['exclusive'] as $path => $hasLock) {
			$this->releaseLock($path, self::LOCK_EXCLUSIVE);
		}
	}
119
120
121
122

	protected function getOwnSharedLockCount($path) {
		return isset($this->acquiredLocks['shared'][$path]) ? $this->acquiredLocks['shared'][$path] : 0;
	}
123
}