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
228
229
230
231
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
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
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.com>.
*/
/**
* Offline locking of records comes in handy where you need to make sure that
* a time-consuming task on a record or many records, which is spread over several
* page requests can't be interfered by other users.
*
* @link www.phpdoctrine.com
* @author Roman Borschel <roman@code-factory.org>
* @author Pierre Minnieur <pm@pierre-minnieur.de>
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @since 1.0
* @package Doctrine
* @category Object Relational Mapping
* @version $Revision$
*/
class Doctrine_Locking_Manager_Pessimistic
{
/**
* The conn that is used by the locking manager
*
* @var Doctrine_Connection object
*/
private $conn;
/**
* The database table name for the lock tracking
*/
private $_lockTable = 'doctrine_lock_tracking';
/**
* Constructs a new locking manager object
*
* When the CREATE_TABLES attribute of the connection on which the manager
* is supposed to work on is set to true, the locking table is created.
*
* @param Doctrine_Connection $conn The database connection to use
*/
public function __construct(Doctrine_Connection $conn)
{
$this->conn = $conn;
if ($this->conn->getAttribute(Doctrine::ATTR_EXPORT) & Doctrine::EXPORT_TABLES) {
$columns = array();
$columns['object_type'] = array('type' => 'string',
'length' => 50,
'notnull' => true,
'primary' => true);
$columns['object_key'] = array('type' => 'string',
'length' => 250,
'notnull' => true,
'primary' => true);
$columns['user_ident'] = array('type' => 'string',
'length' => 50,
'notnull' => true);
$columns['timestamp_obtained'] = array('type' => 'integer',
'length' => 10,
'notnull' => true);
$options = array('primary' => array('object_type', 'object_key'));
try {
$this->conn->export->createTable($this->_lockTable, $columns, $options);
} catch(Exception $e) {
}
}
}
/**
* Obtains a lock on a {@link Doctrine_Record}
*
* @param Doctrine_Record $record The record that has to be locked
* @param mixed $userIdent A unique identifier of the locking user
* @return boolean TRUE if the locking was successful, FALSE if another user
* holds a lock on this record
* @throws Doctrine_Locking_Exception If the locking failed due to database errors
*/
public function getLock(Doctrine_Record $record, $userIdent)
{
$objectType = $record->getTable()->getComponentName();
$key = $record->obtainIdentifier();
$gotLock = false;
$time = time();
if (is_array($key)) {
// Composite key
$key = implode('|', $key);
}
try {
$dbh = $this->conn->getDbh();
$dbh->beginTransaction();
$stmt = $dbh->prepare('INSERT INTO ' . $this->_lockTable
. ' (object_type, object_key, user_ident, timestamp_obtained)'
. ' VALUES (:object_type, :object_key, :user_ident, :ts_obtained)');
$stmt->bindParam(':object_type', $objectType);
$stmt->bindParam(':object_key', $key);
$stmt->bindParam(':user_ident', $userIdent);
$stmt->bindParam(':ts_obtained', $time);
try {
$stmt->execute();
$gotLock = true;
// we catch an Exception here instead of PDOException since we might also be catching Doctrine_Exception
} catch(Exception $pkviolation) {
// PK violation occured => existing lock!
}
if ( ! $gotLock) {
$lockingUserIdent = $this->_getLockingUserIdent($objectType, $key);
if ($lockingUserIdent !== null && $lockingUserIdent == $userIdent) {
$gotLock = true; // The requesting user already has a lock
// Update timestamp
$stmt = $dbh->prepare('UPDATE ' . $this->_lockTable
. ' SET timestamp_obtained = :ts'
. ' WHERE object_type = :object_type AND'
. ' object_key = :object_key AND'
. ' user_ident = :user_ident');
$stmt->bindParam(':ts', $time);
$stmt->bindParam(':object_type', $objectType);
$stmt->bindParam(':object_key', $key);
$stmt->bindParam(':user_ident', $lockingUserIdent);
$stmt->execute();
}
}
$dbh->commit();
} catch (Exception $pdoe) {
$dbh->rollback();
throw new Doctrine_Locking_Exception($pdoe->getMessage());
}
return $gotLock;
}
/**
* Releases a lock on a {@link Doctrine_Record}
*
* @param Doctrine_Record $record The record for which the lock has to be released
* @param mixed $userIdent The unique identifier of the locking user
* @return boolean TRUE if a lock was released, FALSE if no lock was released
* @throws Doctrine_Locking_Exception If the release procedure failed due to database errors
*/
public function releaseLock(Doctrine_Record $record, $userIdent)
{
$objectType = $record->getTable()->getComponentName();
$key = $record->obtainIdentifier();
if (is_array($key)) {
// Composite key
$key = implode('|', $key);
}
try {
$dbh = $this->conn->getDbh();
$stmt = $dbh->prepare("DELETE FROM $this->_lockTable WHERE
object_type = :object_type AND
object_key = :object_key AND
user_ident = :user_ident");
$stmt->bindParam(':object_type', $objectType);
$stmt->bindParam(':object_key', $key);
$stmt->bindParam(':user_ident', $userIdent);
$stmt->execute();
$count = $stmt->rowCount();
return ($count > 0);
} catch (PDOException $pdoe) {
throw new Doctrine_Locking_Exception($pdoe->getMessage());
}
}
/**
* Gets the unique user identifier of a lock
*
* @param string $objectType The type of the object (component name)
* @param mixed $key The unique key of the object
* @return mixed The unique user identifier for the specified lock
* @throws Doctrine_Locking_Exception If the query failed due to database errors
*/
private function _getLockingUserIdent($objectType, $key)
{
if (is_array($key)) {
// Composite key
$key = implode('|', $key);
}
try {
$dbh = $this->conn->getDbh();
$stmt = $dbh->prepare('SELECT user_ident FROM ' . $this->_lockTable
. ' WHERE object_type = :object_type AND object_key = :object_key');
$stmt->bindParam(':object_type', $objectType);
$stmt->bindParam(':object_key', $key);
$success = $stmt->execute();
if (!$success) {
throw new Doctrine_Locking_Exception("Failed to determine locking user");
}
$userIdent = $stmt->fetchColumn();
} catch (PDOException $pdoe) {
throw new Doctrine_Locking_Exception($pdoe->getMessage());
}
return $userIdent;
}
/**
* Gets the identifier that identifies the owner of the lock on the given
* record.
*
* @param Doctrine_Record $lockedRecord The record.
* @return mixed The unique user identifier that identifies the owner of the lock.
*/
public function getLockOwner($lockedRecord)
{
$objectType = $lockedRecord->getTable()->getComponentName();
$key = $lockedRecord->obtainIdentifier();
return $this->_getLockingUserIdent($objectType, $key);
}
/**
* Releases locks older than a defined amount of seconds
*
* When called without parameters all locks older than 15 minutes are released.
*
* @param integer $age The maximum valid age of locks in seconds
* @param string $objectType The type of the object (component name)
* @param mixed $userIdent The unique identifier of the locking user
* @return integer The number of locks that have been released
* @throws Doctrine_Locking_Exception If the release process failed due to database errors
*/
public function releaseAgedLocks($age = 900, $objectType = null, $userIdent = null)
{
$age = time() - $age;
try {
$dbh = $this->conn->getDbh();
$stmt = $dbh->prepare('DELETE FROM ' . $this->_lockTable . ' WHERE timestamp_obtained < :age');
$stmt->bindParam(':age', $age);
$query = 'DELETE FROM ' . $this->_lockTable . ' WHERE timestamp_obtained < :age';
if ($objectType) {
$query .= ' AND object_type = :object_type';
}
if ($userIdent) {
$query .= ' AND user_ident = :user_ident';
}
$stmt = $dbh->prepare($query);
$stmt->bindParam(':age', $age);
if ($objectType) {
$stmt->bindParam(':object_type', $objectType);
}
if ($userIdent) {
$stmt->bindParam(':user_ident', $userIdent);
}
$stmt->execute();
$count = $stmt->rowCount();
return $count;
} catch (PDOException $pdoe) {
throw new Doctrine_Locking_Exception($pdoe->getMessage());
}
}
}