2 /***************************************************************************
3 * Copyright (C) 2003-2010 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
22 class PlDBBadValueException
extends PlException
24 public function __construct($value, PlDBTableField
$field, $reason)
26 parent
::__construct('Erreur lors de l\'accès à la base de données',
27 'Illegal value '. (is_null($value) ?
'(null)' : '(\'' . $value . '\')')
28 . ' for field (\'' . $field->table
->table
. '.' . $field->name
. '\'): '
33 class PlDBNoSuchFieldException
extends PlException
35 public function __construct($field, PlDBTable
$table)
37 parent
::__construct('Erreur lors de l\'accès à la base de données',
38 'No such field ' . $field . ' in table ' . $table->table
);
42 class PlDBNoSuchKeyException
extends PlException
44 public function __construct($key, PlDBTable
$table)
46 parent
::__construct('Erreur lors de l\'accès à la base de données',
47 'No such key ' . $key . ' in table ' . $table->table
);
52 class PlDBIncompleteEntryDescription
extends PlException
54 public function __construct($field, PlDBTable
$table)
56 parent
::__construct('Erreur lors de l\'accès à la base de données',
57 'The field ' . $field . ' is required to describe an entry in table '
71 public $typeParameters;
75 public $autoIncrement;
80 public function __construct(array $column)
82 $this->name
= $column['Field'];
83 $this->typeParameters
= explode(' ', str_replace(array('(', ')', ',', '\''), ' ',
85 $this->type
= array_shift($this->typeParameters
);
86 if ($this->type
== 'enum' ||
$this->type
== 'set') {
87 $this->typeParameters
= new PlFlagSet(implode(',', $this->typeParameters
));
88 } else if (ctype_digit($this->typeParameters
[0])) {
89 $this->typeLength
= intval($this->typeParameters
[0]);
90 array_shift($this->typeParameters
);
92 $this->allowNull
= ($column['Null'] === 'YES');
93 $this->autoIncrement
= (strpos($column['Extra'], 'auto_increment') !== false
);
94 $this->inPrimaryKey
= ($column['Key'] == 'PRI');
97 $this->defaultValue
= $this->format($column['Default']);
98 } catch (PlDBBadValueException
$e) {
99 $this->defaultValue
= null
;
103 public function registerFormatter($class)
105 $this->formatter
= $class;
108 public function registerValidator($class)
110 $this->validator
= $class;
113 public function format($value, $badNullFallbackToDefault = false
)
115 if (is_null($value)) {
116 if ($this->allowNull ||
$this->autoIncrement
) {
119 if ($badNullFallbackToDefault) {
120 return $this->defaultValue
;
122 throw new PlDBBadValueException($value, $this, 'null not allowed');
124 if (!is_null($this->validator
)) {
125 $class = $this->validator
;
126 new $class($this, $value);
128 if (!is_null($this->formatter
)) {
129 $class = $this->formatter
;
130 $value = new $class($this, $value);
131 } else if ($this->type
== 'enum') {
132 if (!$this->typeParameters
->hasFlag($value)) {
133 throw new PlDBBadValueException($value, $this, 'invalid value for enum ' . $this->typeParameters
->flags());
136 } else if ($this->type
== 'set') {
137 $value = new PlFlagSet($value);
138 foreach ($value as $flag) {
139 if (!$this->typeParameters
->hasFlag($flag)) {
140 throw new PlDBBadValueException($value, $this, 'invalid flag for set ' . $this->typeParameters
->flags());
144 } else if (ends_with($this->type
, 'int')) {
145 if (!is_int($value) && !ctype_digit($value)) {
146 throw new PlDBBadValueException($value, $this, 'value is not an integer');
148 $value = intval($value);
149 if (count($this->typeParameters
) > 0 && $this->typeParameters
[0] == 'unsigned') {
151 throw new PlDBBadValueException($value, $this, 'value is negative in an unsigned field');
154 /* TODO: Check bounds */
156 } else if (ends_with($this->type
, 'char')) {
157 if (strlen($value) > $this->typeLength
) {
158 throw new PlDBBadValueException($value, $this, 'value is expected to be at most ' . $this->typeLength
. ' characters long, ' . strlen($value) . ' given');
161 } else if (starts_with($this->type
, 'date') ||
$this->type
== 'timestamp') {
162 return new DateFieldFormatter($this, $value);
168 interface PlDBTableFieldValidator
170 public function __construct(PlDBTableField
$field, $value);
173 interface PlDBTableFieldFormatter
extends PlDBTableFieldValidator
, XDBFormat
177 class DateFieldFormatter
implements PlDBTableFieldFormatter
180 private $storageFormat;
182 public function __construct(PlDBTableField
$field, $date)
184 $this->datetime
= make_datetime($date);
185 if (is_null($this->datetime
)) {
186 throw new PlDBBadValueException($date, $field, 'value is expected to be a date/time, ' . $date . ' given');
188 if ($field->type
== 'date') {
189 $this->storageFormat
= 'Y-m-d';
190 } else if ($field->type
== 'datetime') {
191 $this->storageFormat
= 'Y-m-d H:i:s';
193 $this->storageFormat
= 'U';
197 public function format()
199 return XDB
::escape($this->datetime
->format($this->storageFormat
));
202 public function date($format)
204 return $this->datetime
->format($format);
208 class JSonFieldFormatter
implements PlDBTableFieldFormatter
, ArrayAccess
212 public function __construct(PlDBTableField
$field, $data)
214 if (strpos($field->type
, 'text') === false
) {
215 throw new PlDBBadValueException($data, $field, 'json formatting requires a text field');
218 if (is_string($data)) {
219 $this->data
= json_decode($data, true
);
220 } else if (is_object($data)) {
221 $this->data
= json_decode(json_encode($data), true
);
222 } else if (is_array($data)) {
226 if (is_null($this->data
)) {
227 throw new PlDBBadValueException($data, $field, 'cannot interpret data as json: ' . $data);
231 public function format()
233 return XDB
::escape(json_encode($this->data
));
236 public function offsetExists($offset)
238 return isset($this->data
[$offset]);
241 public function offsetGet($offset)
243 return $this->data
[$offset];
246 public function offsetSet($offset, $value)
248 $this->data
[$offset] = $value;
251 public function offsetUnset($offset)
253 unset($this->data
[$offset]);
258 /** This class aims at providing a simple interface to interact with a single
259 * table of a database. It is implemented as a wrapper around XDB.
263 const PRIMARY_KEY
= 'PRIMARY';
270 private $multipleKeys;
271 private $mutableFields;
273 public function __construct($table)
275 $this->table
= $table;
279 private function parseSchema(PlIterator
$schema, PlIterator
$keys)
281 $this->schema
= array();
282 $this->primaryKey
= array();
283 $this->uniqueKeys
= array();
284 $this->multipleKeys
= array();
285 $this->mutableFields
= array();
286 while ($column = $schema->next()) {
287 $field = new PlDBTableField($column);
288 $this->schema
[$field->name
] = $field;
289 if (!$field->inPrimaryKey
) {
290 $this->mutableFields
[] = $field->name
;
293 while ($column = $keys->next()) {
294 $name = $column['Key_name'];
295 $multiple = intval($column['Non_unique']) != 0;
296 $field = $column['Column_name'];
298 if (!isset($this->multipleKeys
[$name])) {
299 $this->multipleKeys
[$name] = array();
301 $this->multipleKeys
[$name][] = $field;
302 } else if ($name == self
::PRIMARY_KEY
) {
303 $this->primaryKey
[] = $field;
305 if (!isset($this->uniqueKeys
[$name])) {
306 $this->uniqueKeys
[$name] = array();
308 $this->uniqueKeys
[$name][] = $field;
314 private function schema()
316 if (!$this->schema
) {
317 $schema = XDB
::iterator('DESCRIBE ' . $this->table
);
318 $keys = XDB
::iterator('SHOW INDEX FROM ' . $this->table
);
319 $this->parseSchema($schema, $keys);
321 return $this->schema
;
324 private function field($field)
326 $schema = $this->schema();
327 if (!isset($schema[$field])) {
328 throw new PlDBNoSuchFieldException($field, $this);
330 return $schema[$field];
333 public function formatField($field, $value)
335 return $this->field($field)->format($value);
338 public function registerFieldFormatter($field, $class)
340 return $this->field($field)->registerFormatter($class);
343 public function registerFieldValidator($field, $class)
345 return $this->field($field)->registerValidator($class);
349 public function defaultValue($field)
351 return $this->field($field)->defaultValue
;
354 private function hasKeyField(PlDBTableEntry
$entry, array $fields)
356 foreach ($fields as $field) {
357 if (isset($entry->$field)) {
364 private function keyFields($keyName)
366 if ($keyName == self
::PRIMARY_KEY
) {
367 return $this->primaryKey
;
368 } else if (isset($this->uniqueKeys
[$keyName])) {
369 return $this->uniqueKeys
[$keyName];
370 } else if (isset($this->multipleKeys
[$keyName])) {
371 return $this->multipleKeys
[$keyName];
373 throw new PlDBNoSuchKeyException($keyName, $this);
376 private function bestKeyFields(PlDBTableEntry
$entry, $allowMultiple)
378 if ($this->hasKeyField($entry, $this->primaryKey
)) {
379 return $this->primaryKey
;
381 foreach ($this->uniqueKeys
as $fields) {
382 if ($this->hasKeyField($entry, $fields)) {
386 if ($allowMultiple) {
387 foreach ($this->multipleKeys
as $fields) {
388 if ($this->hasKeyField($entry, $fields)) {
393 return $this->primaryKey
;
396 public function key(PlDBTableEntry
$entry, array $keyFields)
399 foreach ($keyFields as $field) {
400 if (!isset($entry->$field)) {
401 throw new PlDBIncompleteEntryDescription($field, $this);
403 $key[] = XDB
::escape($this->$field);
406 return implode('-', $key);
409 public function primaryKey(PlDBTableEntry
$entry)
411 return $this->key($this->keyFields(self
::PRIMARY_KEY
));
414 private function buildKeyCondition(PlDBTableEntry
$entry, array $keyFields, $allowIncomplete)
416 $condition = array();
417 foreach ($keyFields as $field) {
418 if (!isset($entry->$field)) {
419 if (!$allowIncomplete) {
420 throw new PlDBIncompleteEntryDescription($field, $this);
423 $condition[] = XDB
::format($field . ' = {?}', $entry->$field);
426 return implode(' AND ', $condition);
429 public function fetchEntry(PlDBTableEntry
$entry)
431 $result = XDB
::rawFetchOneAssoc('SELECT *
432 FROM ' . $this->table
. '
433 WHERE ' . $this->buildKeyCondition($entry,
434 $this->bestKeyFields($entry, false
),
439 return $entry->fillFromDBData($result);
442 public function iterateOnCondition(PlDBTableEntry
$entry, $condition, $sortField)
444 if (empty($sortField)) {
445 $sortField = $this->primaryKey
;
447 if (!is_array($sortField)) {
448 $sortField = array($sortField);
450 $sort = ' ORDER BY ' . implode(', ', $sortField);
451 $it = XDB
::rawIterator('SELECT *
452 FROM ' . $this->table
. '
453 WHERE ' . $condition . '
455 return PlIteratorUtils
::map($it, array($entry, 'cloneAndFillFromDBData'));
458 public function iterateOnEntry(PlDBTableEntry
$entry, $sortField)
460 return $this->iterateOnCondition($entry,
461 $this->buildKeyCondition($entry,
462 $this->bestKeyFields($entry, true
),
467 const SAVE_INSERT_MISSING
= 0x01;
468 const SAVE_UPDATE_EXISTING
= 0x02;
469 const SAVE_IGNORE_DUPLICATE
= 0x04;
470 public function saveEntry(PlDBTableEntry
$entry, $flags)
472 $flags &= (self
::SAVE_INSERT_MISSING | self
::SAVE_UPDATE_EXISTING | self
::SAVE_IGNORE_DUPLICATE
);
473 Platal
::assert($flags != 0, "Hey, the flags ($flags) here are so stupid, don't know what to do");
474 if ($flags == self
::SAVE_UPDATE_EXISTING
) {
476 foreach ($this->mutableFields
as $field) {
477 if ($entry->hasChanged($field)) {
478 $values[] = XDB
::format($field . ' = {?}', $entry->$field);
481 if (count($values) > 0) {
482 XDB
::rawExecute('UPDATE ' . $this->table
. '
483 SET ' . implode(', ', $values) . '
484 WHERE ' . $this->buildKeyCondition($entry,
485 $this->keyFields(self
::PRIMARY_KEY
),
490 foreach ($this->schema
as $field=>$type) {
491 if ($entry->hasChanged($field)) {
492 $values[$field] = XDB
::escape($entry->$field);
495 if (count($values) > 0) {
496 $query = $this->table
. ' (' . implode(', ', array_keys($values)) . ')
497 VALUES (' . implode(', ', $values) . ')';
498 if (($flags & self
::SAVE_UPDATE_EXISTING
)) {
500 foreach ($this->mutableFields
as $field) {
501 if (isset($values[$field])) {
502 $update[] = "$field = VALUES($field)";
505 if (count($update) > 0) {
506 $query = 'INSERT ' . $query;
507 $query .= "\n ON DUPLICATE KEY UPDATE " . implode(', ', $update);
509 $query = 'INSERT IGNORE ' . $query;
511 } else if (($flags & self
::SAVE_IGNORE_DUPLICATE
)) {
512 $query = 'INSERT IGNORE ' . $query;
514 $query = 'INSERT ' . $query;
516 XDB
::rawExecute($query);
517 $id = XDB
::insertId();
519 foreach ($this->primaryKey
as $field) {
520 if ($this->schema
[$field]->autoIncrement
) {
521 $entry->$field = $id;
530 public function deleteEntry(PlDBTableEntry
$entry, $allowIncomplete)
532 XDB
::rawExecute('DELETE FROM ' . $this->table
. '
533 WHERE ' . $this->buildKeyCondition($entry,
534 $this->bestKeyFields($entry, $allowIncomplete),
538 public static function get($name)
540 return new PlDBTable($name);
544 class PlDBTableEntry
extends PlAbstractIterable
548 private $fetched = false
;
551 private $data = array();
553 public function __construct($table, $autoFetch = false
)
555 if ($table instanceof PlDBTable
) {
556 $this->table
= $table;
558 $this->table
= PlCache
::getGlobal('pldbtable_' . $table, array('PlDBTable', 'get'), array($table));
560 $this->autoFetch
= $autoFetch;
561 $this->changed
= new PlFlagSet();
564 /** Register a custom formatter for a field.
566 * A formatter can be used to perform on-the-fly conversion from db storage to a user-friendly format.
567 * For example, if you have a textual field that contain json, you can use a JSonFieldFormatter on this
568 * field to perform automatic decoding when reading from the database (or when assigning the field)
569 * and automatic json_encoding when storing the object back to the db.
571 protected function registerFieldFormatter($field, $formatterClass)
573 $this->table
->registerFieldFormatter($field, $formatterClass);
576 /** Register a custom validator for a field.
578 * A validator perform a pre-filter on the value of a field. As opposed to the formatters, it does
579 * not affects how the value is stored in the database.
581 protected function registerFieldValidator($field, $validatorClass)
583 $this->table
->registerFieldValidator($field, $validatorClass);
586 /** This hook is called when the entry is going to be updated in the db.
588 * A typical usecase is a class that stores low-level representation of
589 * an object in db and perform a conversion between this low-level representation
590 * and a higher-level representation.
592 * @return true in case of success
594 protected function preSave()
599 /** This hook is called when the entry has been save in the database.
601 * It can be used to perform post-actions on save like storing extra data
602 * in database or sending a notification.
604 protected function postSave()
608 /** This hook is called when the entry is going to be deleted from the db.
610 * Default behavior is to call preSave().
612 * @return true in case of success.
614 protected function preDelete()
616 return $this->preSave();
619 /** This hook is called when the entry has just been fetched from the db.
621 * This is the counterpart of @ref preSave and a typical use-case is the conversion
622 * from a high-level representation of the objet to a representation suitable for
623 * storage in the database.
625 * @return true in case of success.
627 protected function postFetch()
632 public function __get($field)
634 if (isset($this->data
[$field])) {
635 return $this->data
[$field];
636 } else if (!$this->fetched
&& $this->autoFetch
) {
638 if (isset($this->data
[$field])) {
639 return $this->data
[$field];
642 return $this->table
->defaultValue($field);
645 public function __set($field, $value)
647 $this->data
[$field] = $this->table
->formatField($field, $value);
648 $this->changed
->addFlag($field);
651 public function __isset($field)
653 return isset($this->data
[$field]);
656 public function primaryKey()
658 $this->table
->primaryKey($this);
661 public function hasChanged($field)
663 return $this->changed
->hasFlag($field);
666 public function fillFromArray(array $data)
668 foreach ($data as $field => $value) {
669 $this->$field = $value;
673 public function fillFromDBData(array $data)
675 $this->fillFromArray($data);
676 $this->changed
->clear();
677 return $this->postFetch();
680 public function copy(PlDBTableEntry
$other)
682 Platal
::assert($this->table
== $other->table
,
683 "Trying to fill an entry of table {$this->table->table} with content of {$other->table->table}.");
684 $this->changed
= $other->changed
;
685 $this->fetched
= $other->fetched
;
686 $this->data
= $other->data
;
689 public function cloneAndFillFromDBData(array $data)
691 $clone = clone $this;
692 $clone->fillFromDBData($data);
696 public function fetch()
698 return $this->table
->fetchEntry($this);
701 public function iterate($sortField = null
)
703 return $this->table
->iterateOnEntry($this, $sortField);
706 public function iterateOnCondition($condition, $sortField = null
)
708 return $this->table
->iterateOnCondition($this, $condition, $sortField);
711 public function save($flags)
713 if (!$this->preSave()) {
716 $this->table
->saveEntry($this, $flags);
717 $this->changed
->clear();
722 public function update($insertMissing = false
)
724 $flags = PlDBTable
::SAVE_UPDATE_EXISTING
;
725 if ($insertMissing) {
726 $flags = PlDBTable
::SAVE_INSERT_MISSING
;
728 return $this->save($flags);
731 public function insert($allowUpdate = false
)
733 $flags = PlDBTable
::SAVE_INSERT_MISSING
;
735 $flags |
= PlDBTable
::SAVE_UPDATE_EXISTING
;
737 return $this->save($flags);
740 public function delete()
742 if (!$this->preDelete()) {
745 return $this->table
->deleteEntry($this, true
);
749 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: