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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
|
<?php
namespace MediaWiki\Extensions\OAuth\Backend;
use MediaWiki\Logger\LoggerFactory;
use Wikimedia\Rdbms\DBConnRef;
use Wikimedia\Rdbms\DBError;
use Wikimedia\Rdbms\DBReadOnlyError;
/**
* (c) Aaron Schulz 2013, GPL
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
/**
* Representation of a Data Access Object
*/
abstract class MWOAuthDAO implements \IDBAccessObject {
private $daoOrigin = 'new'; // string; object construction origin
private $daoPending = true; // bool; whether fields changed or the field is new
/** @var \Psr\Log\LoggerInterface */
protected $logger;
/**
* @throws \LogicException
*/
final protected function __construct() {
$fields = array_keys( static::getFieldPermissionChecks() );
if ( array_diff( $fields, $this->getFieldNames() ) ) {
throw new \LogicException( "Invalid field(s) defined in access check methods." );
}
$this->logger = LoggerFactory::getInstance( 'OAuth' );
}
/**
* @param array $values (field => value) map
* @return static
*/
final public static function newFromArray( array $values ) {
$class = static::getConsumerClass( $values );
$consumer = new $class();
// Make sure oauth_version is set - for backwards compat
$values['oauth_version'] = $values['oauth_version'] ?? Consumer::OAUTH_VERSION_1;
$consumer->loadFromValues( $values );
return $consumer;
}
/**
* Determine and return the correct consumer class
*
* @param array $data
* @return string
*/
protected static function getConsumerClass( array $data ) {
return static::class;
}
/**
* @param DBConnRef $db
* @param array|\stdClass $row
* @return static
*/
final public static function newFromRow( DBConnRef $db, $row ) {
$class = static::getConsumerClass( (array)$row );
$consumer = new $class();
$consumer->loadFromRow( $db, $row );
return $consumer;
}
/**
* @param DBConnRef $db
* @param int $id
* @param int $flags MWOAuthDAO::READ_* bitfield
* @return static|bool Returns false if not found
* @throws DBError
*/
final public static function newFromId( DBConnRef $db, $id, $flags = 0 ) {
$row = $db->selectRow( static::getTable(),
array_values( static::getFieldColumnMap() ),
[ static::getIdColumn() => (int)$id ],
__METHOD__,
( $flags & self::READ_LOCKING ) ? [ 'FOR UPDATE' ] : []
);
if ( $row ) {
$class = static::getConsumerClass( (array)$row );
$consumer = new $class();
$consumer->loadFromRow( $db, $row );
return $consumer;
} else {
return false;
}
}
/**
* Get the value of a field
*
* @param string $name
* @return mixed
* @throws \LogicException
*/
final public function get( $name ) {
if ( !static::hasField( $name ) ) {
throw new \LogicException( "Object has no '$name' field." );
}
return $this->$name;
}
/**
* Set the value of a field
*
* @param string $name
* @param mixed $value
* @return mixed The old value
* @throws \Exception
*/
final public function setField( $name, $value ) {
$old = $this->setFields( [ $name => $value ] );
return $old[$name];
}
/**
* Set the values for a set of fields
*
* @param array $values (field => value) map
* @throws \LogicException
* @return array Map of old values
*/
final public function setFields( array $values ) {
$old = [];
foreach ( $values as $name => $value ) {
if ( !static::hasField( $name ) ) {
throw new \LogicException( "Object has no '$name' field." );
}
$old[$name] = $this->$name;
$this->$name = $value;
if ( $old[$name] !== $value ) {
$this->daoPending = true;
}
}
$this->normalizeValues();
return $old;
}
/**
* @return array
*/
final public function getFieldNames() {
return array_keys( static::getFieldColumnMap() );
}
/**
* @param DBConnRef $dbw
* @return bool
* @throws DBReadOnlyError
*/
public function save( DBConnRef $dbw ) {
$uniqueId = $this->getIdValue();
$idColumn = static::getIdColumn();
if ( !empty( $dbw->daoReadOnly ) ) {
throw new DBReadOnlyError( $dbw, get_class() . ": tried to save while db is read-only" );
}
if ( $this->daoOrigin === 'db' ) {
if ( $this->daoPending ) {
$this->logger->debug( get_class( $this ) . ': performing DB update; object changed.' );
$dbw->update(
static::getTable(),
$this->getRowArray( $dbw ),
[ $idColumn => $uniqueId ],
__METHOD__
);
$this->daoPending = false;
return $dbw->affectedRows() > 0;
} else {
$this->logger->debug( get_class( $this ) . ': skipping DB update; object unchanged.' );
return false; // short-circuit
}
} else {
$this->logger->debug( get_class( $this ) . ': performing DB update; new object.' );
$afield = static::getAutoIncrField();
$acolumn = $afield !== null ? static::getColumn( $afield ) : null;
$row = $this->getRowArray( $dbw );
if ( $acolumn !== null && $row[$acolumn] === null ) {
// auto-increment field should be omitted, not set null, for
// auto-incrementing behavior
unset( $row[$acolumn] );
}
$dbw->insert(
static::getTable(),
$row,
__METHOD__
);
if ( $afield !== null ) { // update field for auto-increment field
$this->$afield = $dbw->insertId();
}
$this->daoPending = false;
return true;
}
}
/**
* @param DBConnRef $dbw
* @return bool
* @throws DBReadOnlyError
*/
public function delete( DBConnRef $dbw ) {
$uniqueId = $this->getIdValue();
$idColumn = static::getIdColumn();
if ( !empty( $dbw->daoReadOnly ) ) {
throw new DBReadOnlyError( $dbw, get_class() . ": tried to delete while db is read-only" );
}
if ( $this->daoOrigin === 'db' ) {
$dbw->delete(
static::getTable(),
[ $idColumn => $uniqueId ],
__METHOD__
);
$this->daoPending = true;
return $dbw->affectedRows() > 0;
} else {
return false;
}
}
/**
* Get the schema information for this object type
*
* This should return an associative array with:
* - idField : a field with an int/hex UNIQUE identifier
* - autoIncrField : a field that auto-increments in the DB (or NULL if none)
* - table : a table name
* - fieldColumnMap : a map of field names to column names
*
* @throws \MWException
* @return array
*/
protected static function getSchema() {
// Note: declaring this abstract raises E_STRICT
throw new \MWException( "getSchema() not defined in " . get_class() );
}
/**
* Get the access control check methods for this object type
*
* This returns a map of field names to method names.
* The methods check if a context user has access to the field,
* returning true if they do and a Message object otherwise.
* The methods take (field name, \IContextSource) as arguments.
*
* @see MWOAuthDAO::userCanAccess()
* @see MWOAuthDAOAccessControl
*
* @throws \LogicException Subclasses must override
* @return array Map of (field name => name of method that checks access)
*/
protected static function getFieldPermissionChecks() {
// Note: declaring this abstract raises E_STRICT
throw new \LogicException( "getFieldPermissionChecks() not defined in " . get_class() );
}
/**
* @return string
*/
final protected static function getTable() {
$schema = static::getSchema();
return $schema['table'];
}
/**
* @return array
*/
final protected static function getFieldColumnMap() {
$schema = static::getSchema();
return $schema['fieldColumnMap'];
}
/**
* @param string $field
* @return string
*/
final protected static function getColumn( $field ) {
$schema = static::getSchema();
return $schema['fieldColumnMap'][$field];
}
/**
* @param string $field
* @return bool
*/
final protected static function hasField( $field ) {
$schema = static::getSchema();
return isset( $schema['fieldColumnMap'][$field] );
}
/**
* @return string|null
*/
final protected static function getAutoIncrField() {
$schema = static::getSchema();
return $schema['autoIncrField'] ?? null;
}
/**
* @return string
*/
final protected static function getIdColumn() {
$schema = static::getSchema();
return $schema['fieldColumnMap'][$schema['idField']];
}
/**
* @return int|string
*/
final protected function getIdValue() {
$schema = static::getSchema();
$field = $schema['idField'];
return $this->$field;
}
/**
* @param array $values
* @throws \MWException
*/
final protected function loadFromValues( array $values ) {
foreach ( static::getFieldColumnMap() as $field => $column ) {
if ( !array_key_exists( $field, $values ) ) {
throw new \MWException( get_class( $this ) . " requires '$field' field." );
}
$this->$field = $values[$field];
}
$this->normalizeValues();
$this->daoOrigin = 'new';
$this->daoPending = true;
}
/**
* Subclasses should make this normalize fields (e.g. timestamps)
*
* @return void
*/
abstract protected function normalizeValues();
/**
* @param DBConnRef $db
* @param \stdClass|array $row
* @return void
*/
final protected function loadFromRow( DBConnRef $db, $row ) {
$row = $this->decodeRow( $db, (array)$row );
$values = [];
foreach ( static::getFieldColumnMap() as $field => $column ) {
$values[$field] = $row[$column];
}
$this->loadFromValues( $values );
$this->daoOrigin = 'db';
$this->daoPending = false;
}
/**
* Subclasses should make this to encode DB fields (e.g. timestamps).
* This must also flatten any PHP data structures into flat values.
*
* @param DBConnRef $db
* @param array $row
* @return array
*/
abstract protected function encodeRow( DBConnRef $db, $row );
/**
* Subclasses should make this to decode DB fields (e.g. timestamps).
* This can also expand some flat values (e.g. JSON) into PHP data structures.
* Note: this does not need to handle what normalizeValues() already does.
*
* @param DBConnRef $db
* @param array $row
* @return array
*/
abstract protected function decodeRow( DBConnRef $db, $row );
/**
* @param DBConnRef $db
* @return array
*/
final protected function getRowArray( DBConnRef $db ) {
$row = [];
foreach ( static::getFieldColumnMap() as $field => $column ) {
$row[$column] = $this->$field;
}
return $this->encodeRow( $db, $row );
}
/**
* Check if a user (from the context) can view a field
*
* @see MWOAuthDAO::userCanAccess()
* @see MWOAuthDAOAccessControl
*
* @param string $name
* @param \IContextSource $context
* @return \Message|true Returns on success or a Message if the user lacks access
*/
final public function userCanAccess( $name, \IContextSource $context ) {
$map = static::getFieldPermissionChecks();
if ( isset( $map[$name] ) ) {
$method = $map[$name];
return $this->$method( $name, $context );
} else {
return true;
}
}
/**
* Get the current conflict token value for a user
*
* @param \IContextSource $context
* @return string Hex token
*/
final public function getChangeToken( \IContextSource $context ) {
$map = [];
foreach ( $this->getFieldNames() as $field ) {
if ( $this->userCanAccess( $field, $context ) ) {
$map[$field] = $this->$field;
} else {
$map[$field] = null; // don't convey this information
}
}
return hash_hmac(
'sha1',
serialize( $map ),
"{$context->getUser()->getId()}#{$this->getIdValue()}"
);
}
/**
* Compare an old change token to the current one
*
* @param \IContextSource $context
* @param string $oldToken
* @return bool Whether the current is unchanged
*/
final public function checkChangeToken( \IContextSource $context, $oldToken ) {
return ( $this->getChangeToken( $context ) === $oldToken );
}
/**
* Update whether this object should be written to the data store
* @param bool $pending set to true to mark this object as needing to write its data
*/
public function setPending( $pending ) {
$this->daoPending = $pending;
}
/**
* Update the origin of this object
* @param string $source source of the object
* 'new': Treat this as a new object to the datastore (insert on save)
* 'db': Treat this as already in the datastore (update on save)
*/
public function updateOrigin( $source ) {
$this->daoOrigin = $source;
}
}
|