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
|
<?php
declare(strict_types=1);
namespace Sabre\DAV\Locks\Backend;
use Sabre\DAV\Locks\LockInfo;
/**
* This Locks backend stores all locking information in a single file.
*
* Note that this is not nearly as robust as a database. If you are considering
* using this backend, keep in mind that the PDO backend can work with SqLite,
* which is designed to be a good file-based database.
*
* It literally solves the problem this class solves as well, but much better.
*
* @copyright Copyright (C) fruux GmbH (https://fruux.com/)
* @author Evert Pot (http://evertpot.com/)
* @license http://sabre.io/license/ Modified BSD License
*/
class File extends AbstractBackend
{
/**
* The storage file.
*
* @var string
*/
private $locksFile;
/**
* Constructor.
*
* @param string $locksFile path to file
*/
public function __construct($locksFile)
{
$this->locksFile = $locksFile;
}
/**
* Returns a list of Sabre\DAV\Locks\LockInfo objects.
*
* This method should return all the locks for a particular uri, including
* locks that might be set on a parent uri.
*
* If returnChildLocks is set to true, this method should also look for
* any locks in the subtree of the uri for locks.
*
* @param string $uri
* @param bool $returnChildLocks
*
* @return array
*/
public function getLocks($uri, $returnChildLocks)
{
$newLocks = [];
$locks = $this->getData();
foreach ($locks as $lock) {
if ($lock->uri === $uri ||
//deep locks on parents
(0 != $lock->depth && 0 === strpos($uri, $lock->uri.'/')) ||
// locks on children
($returnChildLocks && (0 === strpos($lock->uri, $uri.'/')))) {
$newLocks[] = $lock;
}
}
// Checking if we can remove any of these locks
foreach ($newLocks as $k => $lock) {
if (time() > $lock->timeout + $lock->created) {
unset($newLocks[$k]);
}
}
return $newLocks;
}
/**
* Locks a uri.
*
* @param string $uri
*
* @return bool
*/
public function lock($uri, LockInfo $lockInfo)
{
// We're making the lock timeout 30 minutes
$lockInfo->timeout = 1800;
$lockInfo->created = time();
$lockInfo->uri = $uri;
$locks = $this->getData();
foreach ($locks as $k => $lock) {
if (
($lock->token == $lockInfo->token) ||
(time() > $lock->timeout + $lock->created)
) {
unset($locks[$k]);
}
}
$locks[] = $lockInfo;
$this->putData($locks);
return true;
}
/**
* Removes a lock from a uri.
*
* @param string $uri
*
* @return bool
*/
public function unlock($uri, LockInfo $lockInfo)
{
$locks = $this->getData();
foreach ($locks as $k => $lock) {
if ($lock->token == $lockInfo->token) {
unset($locks[$k]);
$this->putData($locks);
return true;
}
}
return false;
}
/**
* Loads the lockdata from the filesystem.
*
* @return array
*/
protected function getData()
{
if (!file_exists($this->locksFile)) {
return [];
}
// opening up the file, and creating a shared lock
$handle = fopen($this->locksFile, 'r');
flock($handle, LOCK_SH);
// Reading data until the eof
$data = stream_get_contents($handle);
// We're all good
flock($handle, LOCK_UN);
fclose($handle);
// Unserializing and checking if the resource file contains data for this file
$data = unserialize($data);
if (!$data) {
return [];
}
return $data;
}
/**
* Saves the lockdata.
*/
protected function putData(array $newData)
{
// opening up the file, and creating an exclusive lock
$handle = fopen($this->locksFile, 'a+');
flock($handle, LOCK_EX);
// We can only truncate and rewind once the lock is acquired.
ftruncate($handle, 0);
rewind($handle);
fwrite($handle, serialize($newData));
flock($handle, LOCK_UN);
fclose($handle);
}
}
|
