summaryrefslogtreecommitdiffstats
path: root/lib/public/AppFramework/Db
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/AppFramework/Db')
-rw-r--r--lib/public/AppFramework/Db/DoesNotExistException.php43
-rw-r--r--lib/public/AppFramework/Db/Entity.php253
-rw-r--r--lib/public/AppFramework/Db/Mapper.php376
-rw-r--r--lib/public/AppFramework/Db/MultipleObjectsReturnedException.php43
4 files changed, 715 insertions, 0 deletions
diff --git a/lib/public/AppFramework/Db/DoesNotExistException.php b/lib/public/AppFramework/Db/DoesNotExistException.php
new file mode 100644
index 00000000000..9682a08d3cf
--- /dev/null
+++ b/lib/public/AppFramework/Db/DoesNotExistException.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * @author Bernhard Posselt <dev@bernhard-posselt.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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 OCP\AppFramework\Db;
+
+
+/**
+ * This is returned or should be returned when a find request does not find an
+ * entry in the database
+ * @since 7.0.0
+ */
+class DoesNotExistException extends \Exception {
+
+ /**
+ * Constructor
+ * @param string $msg the error message
+ * @since 7.0.0
+ */
+ public function __construct($msg){
+ parent::__construct($msg);
+ }
+
+}
diff --git a/lib/public/AppFramework/Db/Entity.php b/lib/public/AppFramework/Db/Entity.php
new file mode 100644
index 00000000000..d7db4d3c5a7
--- /dev/null
+++ b/lib/public/AppFramework/Db/Entity.php
@@ -0,0 +1,253 @@
+<?php
+/**
+ * @author Bernhard Posselt <dev@bernhard-posselt.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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 OCP\AppFramework\Db;
+
+
+/**
+ * @method integer getId()
+ * @method void setId(integer $id)
+ * @since 7.0.0
+ */
+abstract class Entity {
+
+ public $id;
+
+ private $_updatedFields = array();
+ private $_fieldTypes = array('id' => 'integer');
+
+
+ /**
+ * Simple alternative constructor for building entities from a request
+ * @param array $params the array which was obtained via $this->params('key')
+ * in the controller
+ * @return Entity
+ * @since 7.0.0
+ */
+ public static function fromParams(array $params) {
+ $instance = new static();
+
+ foreach($params as $key => $value) {
+ $method = 'set' . ucfirst($key);
+ $instance->$method($value);
+ }
+
+ return $instance;
+ }
+
+
+ /**
+ * Maps the keys of the row array to the attributes
+ * @param array $row the row to map onto the entity
+ * @since 7.0.0
+ */
+ public static function fromRow(array $row){
+ $instance = new static();
+
+ foreach($row as $key => $value){
+ $prop = ucfirst($instance->columnToProperty($key));
+ $setter = 'set' . $prop;
+ $instance->$setter($value);
+ }
+
+ $instance->resetUpdatedFields();
+
+ return $instance;
+ }
+
+
+ /**
+ * @return array with attribute and type
+ * @since 7.0.0
+ */
+ public function getFieldTypes() {
+ return $this->_fieldTypes;
+ }
+
+
+ /**
+ * Marks the entity as clean needed for setting the id after the insertion
+ * @since 7.0.0
+ */
+ public function resetUpdatedFields(){
+ $this->_updatedFields = array();
+ }
+
+ /**
+ * Generic setter for properties
+ * @since 7.0.0
+ */
+ protected function setter($name, $args) {
+ // setters should only work for existing attributes
+ if(property_exists($this, $name)){
+ if($this->$name === $args[0]) {
+ return;
+ }
+ $this->markFieldUpdated($name);
+
+ // if type definition exists, cast to correct type
+ if($args[0] !== null && array_key_exists($name, $this->_fieldTypes)) {
+ settype($args[0], $this->_fieldTypes[$name]);
+ }
+ $this->$name = $args[0];
+
+ } else {
+ throw new \BadFunctionCallException($name .
+ ' is not a valid attribute');
+ }
+ }
+
+ /**
+ * Generic getter for properties
+ * @since 7.0.0
+ */
+ protected function getter($name) {
+ // getters should only work for existing attributes
+ if(property_exists($this, $name)){
+ return $this->$name;
+ } else {
+ throw new \BadFunctionCallException($name .
+ ' is not a valid attribute');
+ }
+ }
+
+
+ /**
+ * Each time a setter is called, push the part after set
+ * into an array: for instance setId will save Id in the
+ * updated fields array so it can be easily used to create the
+ * getter method
+ * @since 7.0.0
+ */
+ public function __call($methodName, $args){
+ $attr = lcfirst( substr($methodName, 3) );
+
+ if(strpos($methodName, 'set') === 0){
+ $this->setter($attr, $args);
+ } elseif(strpos($methodName, 'get') === 0) {
+ return $this->getter($attr);
+ } else {
+ throw new \BadFunctionCallException($methodName .
+ ' does not exist');
+ }
+
+ }
+
+
+ /**
+ * Mark am attribute as updated
+ * @param string $attribute the name of the attribute
+ * @since 7.0.0
+ */
+ protected function markFieldUpdated($attribute){
+ $this->_updatedFields[$attribute] = true;
+ }
+
+
+ /**
+ * Transform a database columnname to a property
+ * @param string $columnName the name of the column
+ * @return string the property name
+ * @since 7.0.0
+ */
+ public function columnToProperty($columnName){
+ $parts = explode('_', $columnName);
+ $property = null;
+
+ foreach($parts as $part){
+ if($property === null){
+ $property = $part;
+ } else {
+ $property .= ucfirst($part);
+ }
+ }
+
+ return $property;
+ }
+
+
+ /**
+ * Transform a property to a database column name
+ * @param string $property the name of the property
+ * @return string the column name
+ * @since 7.0.0
+ */
+ public function propertyToColumn($property){
+ $parts = preg_split('/(?=[A-Z])/', $property);
+ $column = null;
+
+ foreach($parts as $part){
+ if($column === null){
+ $column = $part;
+ } else {
+ $column .= '_' . lcfirst($part);
+ }
+ }
+
+ return $column;
+ }
+
+
+ /**
+ * @return array array of updated fields for update query
+ * @since 7.0.0
+ */
+ public function getUpdatedFields(){
+ return $this->_updatedFields;
+ }
+
+
+ /**
+ * Adds type information for a field so that its automatically casted to
+ * that value once its being returned from the database
+ * @param string $fieldName the name of the attribute
+ * @param string $type the type which will be used to call settype()
+ * @since 7.0.0
+ */
+ protected function addType($fieldName, $type){
+ $this->_fieldTypes[$fieldName] = $type;
+ }
+
+
+ /**
+ * Slugify the value of a given attribute
+ * Warning: This doesn't result in a unique value
+ * @param string $attributeName the name of the attribute, which value should be slugified
+ * @return string slugified value
+ * @since 7.0.0
+ */
+ public function slugify($attributeName){
+ // toSlug should only work for existing attributes
+ if(property_exists($this, $attributeName)){
+ $value = $this->$attributeName;
+ // replace everything except alphanumeric with a single '-'
+ $value = preg_replace('/[^A-Za-z0-9]+/', '-', $value);
+ $value = strtolower($value);
+ // trim '-'
+ return trim($value, '-');
+ } else {
+ throw new \BadFunctionCallException($attributeName .
+ ' is not a valid attribute');
+ }
+ }
+
+}
diff --git a/lib/public/AppFramework/Db/Mapper.php b/lib/public/AppFramework/Db/Mapper.php
new file mode 100644
index 00000000000..2e97b06802a
--- /dev/null
+++ b/lib/public/AppFramework/Db/Mapper.php
@@ -0,0 +1,376 @@
+<?php
+/**
+ * @author Bernhard Posselt <dev@bernhard-posselt.com>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Lukas Reschke <lukas@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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 OCP\AppFramework\Db;
+
+use OCP\IDBConnection;
+use OCP\IDb;
+
+
+/**
+ * Simple parent class for inheriting your data access layer from. This class
+ * may be subject to change in the future
+ * @since 7.0.0
+ */
+abstract class Mapper {
+
+ protected $tableName;
+ protected $entityClass;
+ protected $db;
+
+ /**
+ * @param IDBConnection $db Instance of the Db abstraction layer
+ * @param string $tableName the name of the table. set this to allow entity
+ * @param string $entityClass the name of the entity that the sql should be
+ * mapped to queries without using sql
+ * @since 7.0.0
+ */
+ public function __construct(IDBConnection $db, $tableName, $entityClass=null){
+ $this->db = $db;
+ $this->tableName = '*PREFIX*' . $tableName;
+
+ // if not given set the entity name to the class without the mapper part
+ // cache it here for later use since reflection is slow
+ if($entityClass === null) {
+ $this->entityClass = str_replace('Mapper', '', get_class($this));
+ } else {
+ $this->entityClass = $entityClass;
+ }
+ }
+
+
+ /**
+ * @return string the table name
+ * @since 7.0.0
+ */
+ public function getTableName(){
+ return $this->tableName;
+ }
+
+
+ /**
+ * Deletes an entity from the table
+ * @param Entity $entity the entity that should be deleted
+ * @return Entity the deleted entity
+ * @since 7.0.0 - return value added in 8.1.0
+ */
+ public function delete(Entity $entity){
+ $sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
+ $stmt = $this->execute($sql, [$entity->getId()]);
+ $stmt->closeCursor();
+ return $entity;
+ }
+
+
+ /**
+ * Creates a new entry in the db from an entity
+ * @param Entity $entity the entity that should be created
+ * @return Entity the saved entity with the set id
+ * @since 7.0.0
+ */
+ public function insert(Entity $entity){
+ // get updated fields to save, fields have to be set using a setter to
+ // be saved
+ $properties = $entity->getUpdatedFields();
+ $values = '';
+ $columns = '';
+ $params = [];
+
+ // build the fields
+ $i = 0;
+ foreach($properties as $property => $updated) {
+ $column = $entity->propertyToColumn($property);
+ $getter = 'get' . ucfirst($property);
+
+ $columns .= '`' . $column . '`';
+ $values .= '?';
+
+ // only append colon if there are more entries
+ if($i < count($properties)-1){
+ $columns .= ',';
+ $values .= ',';
+ }
+
+ $params[] = $entity->$getter();
+ $i++;
+
+ }
+
+ $sql = 'INSERT INTO `' . $this->tableName . '`(' .
+ $columns . ') VALUES(' . $values . ')';
+
+ $stmt = $this->execute($sql, $params);
+
+ $entity->setId((int) $this->db->lastInsertId($this->tableName));
+
+ $stmt->closeCursor();
+
+ return $entity;
+ }
+
+
+
+ /**
+ * Updates an entry in the db from an entity
+ * @throws \InvalidArgumentException if entity has no id
+ * @param Entity $entity the entity that should be created
+ * @return Entity the saved entity with the set id
+ * @since 7.0.0 - return value was added in 8.0.0
+ */
+ public function update(Entity $entity){
+ // if entity wasn't changed it makes no sense to run a db query
+ $properties = $entity->getUpdatedFields();
+ if(count($properties) === 0) {
+ return $entity;
+ }
+
+ // entity needs an id
+ $id = $entity->getId();
+ if($id === null){
+ throw new \InvalidArgumentException(
+ 'Entity which should be updated has no id');
+ }
+
+ // get updated fields to save, fields have to be set using a setter to
+ // be saved
+ // do not update the id field
+ unset($properties['id']);
+
+ $columns = '';
+ $params = [];
+
+ // build the fields
+ $i = 0;
+ foreach($properties as $property => $updated) {
+
+ $column = $entity->propertyToColumn($property);
+ $getter = 'get' . ucfirst($property);
+
+ $columns .= '`' . $column . '` = ?';
+
+ // only append colon if there are more entries
+ if($i < count($properties)-1){
+ $columns .= ',';
+ }
+
+ $params[] = $entity->$getter();
+ $i++;
+ }
+
+ $sql = 'UPDATE `' . $this->tableName . '` SET ' .
+ $columns . ' WHERE `id` = ?';
+ $params[] = $id;
+
+ $stmt = $this->execute($sql, $params);
+ $stmt->closeCursor();
+
+ return $entity;
+ }
+
+ /**
+ * Checks if an array is associative
+ * @param array $array
+ * @return bool true if associative
+ * @since 8.1.0
+ */
+ private function isAssocArray(array $array) {
+ return array_values($array) !== $array;
+ }
+
+ /**
+ * Returns the correct PDO constant based on the value type
+ * @param $value
+ * @return int PDO constant
+ * @since 8.1.0
+ */
+ private function getPDOType($value) {
+ switch (gettype($value)) {
+ case 'integer':
+ return \PDO::PARAM_INT;
+ case 'boolean':
+ return \PDO::PARAM_BOOL;
+ default:
+ return \PDO::PARAM_STR;
+ }
+ }
+
+
+ /**
+ * Runs an sql query
+ * @param string $sql the prepare string
+ * @param array $params the params which should replace the ? in the sql query
+ * @param int $limit the maximum number of rows
+ * @param int $offset from which row we want to start
+ * @return \PDOStatement the database query result
+ * @since 7.0.0
+ */
+ protected function execute($sql, array $params=[], $limit=null, $offset=null){
+ if ($this->db instanceof IDb) {
+ $query = $this->db->prepareQuery($sql, $limit, $offset);
+ } else {
+ $query = $this->db->prepare($sql, $limit, $offset);
+ }
+
+ if ($this->isAssocArray($params)) {
+ foreach ($params as $key => $param) {
+ $pdoConstant = $this->getPDOType($param);
+ $query->bindValue($key, $param, $pdoConstant);
+ }
+ } else {
+ $index = 1; // bindParam is 1 indexed
+ foreach ($params as $param) {
+ $pdoConstant = $this->getPDOType($param);
+ $query->bindValue($index, $param, $pdoConstant);
+ $index++;
+ }
+ }
+
+ $result = $query->execute();
+
+ // this is only for backwards compatibility reasons and can be removed
+ // in owncloud 10. IDb returns a StatementWrapper from execute, PDO,
+ // Doctrine and IDbConnection don't so this needs to be done in order
+ // to stay backwards compatible for the things that rely on the
+ // StatementWrapper being returned
+ if ($result instanceof \OC_DB_StatementWrapper) {
+ return $result;
+ }
+
+ return $query;
+ }
+
+
+ /**
+ * Returns an db result and throws exceptions when there are more or less
+ * results
+ * @see findEntity
+ * @param string $sql the sql query
+ * @param array $params the parameters of the sql query
+ * @param int $limit the maximum number of rows
+ * @param int $offset from which row we want to start
+ * @throws DoesNotExistException if the item does not exist
+ * @throws MultipleObjectsReturnedException if more than one item exist
+ * @return array the result as row
+ * @since 7.0.0
+ */
+ protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
+ $stmt = $this->execute($sql, $params, $limit, $offset);
+ $row = $stmt->fetch();
+
+ if($row === false || $row === null){
+ $stmt->closeCursor();
+ $msg = $this->buildDebugMessage(
+ 'Did expect one result but found none when executing', $sql, $params, $limit, $offset
+ );
+ throw new DoesNotExistException($msg);
+ }
+ $row2 = $stmt->fetch();
+ $stmt->closeCursor();
+ //MDB2 returns null, PDO and doctrine false when no row is available
+ if( ! ($row2 === false || $row2 === null )) {
+ $msg = $this->buildDebugMessage(
+ 'Did not expect more than one result when executing', $sql, $params, $limit, $offset
+ );
+ throw new MultipleObjectsReturnedException($msg);
+ } else {
+ return $row;
+ }
+ }
+
+ /**
+ * Builds an error message by prepending the $msg to an error message which
+ * has the parameters
+ * @see findEntity
+ * @param string $sql the sql query
+ * @param array $params the parameters of the sql query
+ * @param int $limit the maximum number of rows
+ * @param int $offset from which row we want to start
+ * @return string formatted error message string
+ * @since 9.1.0
+ */
+ private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
+ return $msg .
+ ': query "' . $sql . '"; ' .
+ 'parameters ' . print_r($params, true) . '; ' .
+ 'limit "' . $limit . '"; '.
+ 'offset "' . $offset . '"';
+ }
+
+
+ /**
+ * Creates an entity from a row. Automatically determines the entity class
+ * from the current mapper name (MyEntityMapper -> MyEntity)
+ * @param array $row the row which should be converted to an entity
+ * @return Entity the entity
+ * @since 7.0.0
+ */
+ protected function mapRowToEntity($row) {
+ return call_user_func($this->entityClass .'::fromRow', $row);
+ }
+
+
+ /**
+ * Runs a sql query and returns an array of entities
+ * @param string $sql the prepare string
+ * @param array $params the params which should replace the ? in the sql query
+ * @param int $limit the maximum number of rows
+ * @param int $offset from which row we want to start
+ * @return array all fetched entities
+ * @since 7.0.0
+ */
+ protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
+ $stmt = $this->execute($sql, $params, $limit, $offset);
+
+ $entities = [];
+
+ while($row = $stmt->fetch()){
+ $entities[] = $this->mapRowToEntity($row);
+ }
+
+ $stmt->closeCursor();
+
+ return $entities;
+ }
+
+
+ /**
+ * Returns an db result and throws exceptions when there are more or less
+ * results
+ * @param string $sql the sql query
+ * @param array $params the parameters of the sql query
+ * @param int $limit the maximum number of rows
+ * @param int $offset from which row we want to start
+ * @throws DoesNotExistException if the item does not exist
+ * @throws MultipleObjectsReturnedException if more than one item exist
+ * @return Entity the entity
+ * @since 7.0.0
+ */
+ protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
+ return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
+ }
+
+
+}
diff --git a/lib/public/AppFramework/Db/MultipleObjectsReturnedException.php b/lib/public/AppFramework/Db/MultipleObjectsReturnedException.php
new file mode 100644
index 00000000000..b9207051826
--- /dev/null
+++ b/lib/public/AppFramework/Db/MultipleObjectsReturnedException.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * @author Bernhard Posselt <dev@bernhard-posselt.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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 OCP\AppFramework\Db;
+
+
+/**
+ * This is returned or should be returned when a find request finds more than one
+ * row
+ * @since 7.0.0
+ */
+class MultipleObjectsReturnedException extends \Exception {
+
+ /**
+ * Constructor
+ * @param string $msg the error message
+ * @since 7.0.0
+ */
+ public function __construct($msg){
+ parent::__construct($msg);
+ }
+
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-30 01:21:46 +0000