Oracle Datasource CakePHP 2.0
php | by: odin88
last edit: Jan, 9th 2012 | jump to bottom
<?php /** * Oracle layer for DBO. * * PHP versions 4 and 5 * * CakePHP(tm) : Rapid Development Framework (http://cakephp.org) * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org) * * Licensed under The MIT License * Redistributions of files must retain the above copyright notice. * * @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org) * @link http://cakephp.org CakePHP(tm) Project * @package cake * @subpackage cake.cake.libs.model.datasources.dbo * @since CakePHP v 1.2.0.4041 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ App::uses('DboSource', 'Model/Datasource'); /** * Oracle layer for DBO. * * Long description for class * * @package cake * @subpackage cake.cake.libs.model.datasources.dbo */ class Oracle extends DboSource { /** * Configuration options * * @var array * @access public */ /** * Alias * * @var string */ var $alias = ''; /** * Sequence names as introspected from the database */ /** * Transaction in progress flag * * @var boolean */ var $__transactionStarted = false; /** * Column definitions * * @var array * @access public */ /** * Connection object * * @var mixed * @access protected */ var $connection; /** * Query limit * * @var int * @access protected */ var $_limit = -1; /** * Query offset * * @var int * @access protected */ var $_offset = 0; /** * Enter description here... * * @var unknown_type * @access protected */ var $_map; /** * Current Row * * @var mixed * @access protected */ var $_currentRow; /** * Number of rows * * @var int * @access protected */ var $_numRows; /** * Query results * * @var mixed * @access protected */ var $_results; /** * Last error issued by oci extension * * @var unknown_type */ var $_error; /** * Base configuration settings for MySQL driver * * @var array */ 'persistent' => true, 'host' => 'localhost', 'login' => 'system', 'password' => '', 'database' => 'cake', 'nls_sort' => '', 'nls_sort' => '' ); /** * Table-sequence map * * @var unknown_type */ /** * Connects to the database using options in the given configuration array. * * @return boolean True if the database could be connected, else false * @access public */ function connect() { $config = $this->config; $this->connected = false; if (!$config['persistent']) { $this->connection = @ocilogon($config['login'], $config['password'], $config['database'], $config['charset']); } else { $this->connection = @ociplogon($config['login'], $config['password'], $config['database'], $config['charset']); } if ($this->connection) { $this->connected = true; $this->execute('ALTER SESSION SET NLS_SORT='.$config['nls_sort']); } $this->execute('ALTER SESSION SET NLS_COMP='.$config['nls_comp']); } $this->execute("ALTER SESSION SET NLS_DATE_FORMAT='YYYY-MM-DD HH24:MI:SS'"); } else { $this->connected = false; $this->_setError(); return false; } return $this->connected; } /** * Keeps track of the most recent Oracle error * */ function _setError($source = null, $clear = false) { if ($source) { $e = ocierror($source); } else { $e = ocierror(); } $this->_error = $e['message']; if ($clear) { $this->_error = null; } } /** * Sets the encoding language of the session * * @param string $lang language constant * @return bool */ function setEncoding($lang) { if (!$this->execute('ALTER SESSION SET NLS_LANGUAGE='.$lang)) { return false; } return true; } /** * Gets the current encoding language * * @return string language constant */ function getEncoding() { $sql = 'SELECT VALUE FROM NLS_SESSION_PARAMETERS WHERE PARAMETER=\'NLS_LANGUAGE\''; if (!$this->execute($sql)) { return false; } if (!$row = $this->fetchRow()) { return false; } return $row[0]['VALUE']; } /** * Disconnects from database. * * @return boolean True if the database could be disconnected, else false * @access public */ function disconnect() { if ($this->connection) { $this->connected = !ocilogoff($this->connection); return !$this->connected; } } /** * Scrape the incoming SQL to create the association map. This is an extremely * experimental method that creates the association maps since Oracle will not tell us. * * @param string $sql * @return false if sql is nor a SELECT * @access protected */ function _scrapeSQL($sql) { $preFrom = $preFrom[0]; $lastTableName = ''; foreach($fields as $key => $value) { if ($value != 'COUNT(*) AS count') { $fields[$key] = $matches[1]; $fields[$key] = $matches[1] . $fields[$key]; $lastTableName = $matches[1]; } } /* if (preg_match('/(([[:alnum:]_]+)\.[[:alnum:]_]+)(\s+AS\s+(\w+))?$/i', $value, $matches)) { $fields[$key] = isset($matches[4]) ? $matches[2] . '.' . $matches[4] : $matches[1]; } */ } } foreach($fields as $f) { $table = $e[0]; } else { $table = 0; $field = $e[0]; } } } /** * Modify a SQL query to limit (and offset) the result set * * @param integer $limit Maximum number of rows to return * @param integer $offset Row to begin returning * @return modified SQL Query * @access public */ function limit($limit = -1, $offset = 0) { $this->_limit = (int) $limit; $this->_offset = (int) $offset; } /** * Returns number of rows in previous resultset. If no previous resultset exists, * this returns false. * * @return integer Number of rows in resultset * @access public */ function lastNumRows() { return $this->_numRows; } /** * Executes given SQL statement. This is an overloaded method. * * @param string $sql SQL statement * @return resource Result resource identifier or null * @access protected */ function _execute($sql) { $this->_statementId = @ociparse($this->connection, $sql); if (!$this->_statementId) { $this->_setError($this->connection); return false; } if ($this->__transactionStarted) { $mode = OCI_DEFAULT; } else { $mode = OCI_COMMIT_ON_SUCCESS; } if (!@ociexecute($this->_statementId, $mode)) { $this->_setError($this->_statementId); return false; } $this->_setError(null, true); switch(ocistatementtype($this->_statementId)) { case 'DESCRIBE': case 'SELECT': $this->_scrapeSQL($sql); break; default: return $this->_statementId; break; } if ($this->_limit >= 1) { ocisetprefetch($this->_statementId, $this->_limit); } else { ocisetprefetch($this->_statementId, 3000); } $this->_numRows = ocifetchstatement($this->_statementId, $this->_results, $this->_offset, $this->_limit, OCI_NUM | OCI_FETCHSTATEMENT_BY_ROW); $this->_currentRow = 0; $this->limit(); return $this->_statementId; } /** * Fetch result row * * @return array * @access public */ function fetchRow() { if ($this->_currentRow >= $this->_numRows) { ocifreestatement($this->_statementId); $this->_map = null; $this->_results = null; $this->_currentRow = null; $this->_numRows = null; return false; } foreach($this->_results[$this->_currentRow] as $index => $field) { $resultRow[0]['count'] = $field; } else { $resultRow[$table][$column] = $this->_results[$this->_currentRow][$index]; } } $this->_currentRow++; return $resultRow; } /** * Fetches the next row from the current result set * * @return unknown */ function fetchResult() { return $this->fetchRow(); } /** * Checks to see if a named sequence exists * * @param string $sequence * @return bool * @access public */ function sequenceExists($sequence) { $sql = "SELECT SEQUENCE_NAME FROM USER_SEQUENCES WHERE SEQUENCE_NAME = '$sequence'"; if (!$this->execute($sql)) { return false; } return $this->fetchRow(); } /** * Creates a database sequence * * @param string $sequence * @return bool * @access public */ function createSequence($sequence) { $sql = "CREATE SEQUENCE $sequence"; return $this->execute($sql); } /** * Create trigger * * @param string $table * @return mixed * @access public */ function createTrigger($table) { $sql = "CREATE OR REPLACE TRIGGER pk_$table" . "_trigger BEFORE INSERT ON $table FOR EACH ROW BEGIN SELECT pk_$table.NEXTVAL INTO :NEW.ID FROM DUAL; END;"; return $this->execute($sql); } /** * Returns an array of tables in the database. If there are no tables, an error is * raised and the application exits. * * @return array tablenames in the database * @access public */ function listSources() { $cache = parent::listSources(); if ($cache != null) { return $cache; } $sql = 'SELECT view_name AS name FROM all_views UNION SELECT table_name AS name FROM all_tables'; if (!$this->execute($sql)) { return false; } while($r = $this->fetchRow()) { } parent::listSources($sources); return $sources; } /** * Returns an array of the fields in given table name. * * @param object instance of a model to inspect * @return array Fields in table. Keys are name and type * @access public */ public function describe(&$model) { $table = $this->fullTableName($model, false); $this->_sequenceMap[$table] = $model->sequence; $this->_sequenceMap[$table] = $model->table . '_seq'; } $cache = parent::describe($model); if ($cache != null) { return $cache; } $sql = 'SELECT COLUMN_NAME, DATA_TYPE, DATA_LENGTH FROM all_tab_columns WHERE table_name = \''; if (!$this->execute($sql)) { return false; } for ($i = 0; $row = $this->fetchRow(); $i++) { 'type'=> $this->column($row[0]['DATA_TYPE']), 'length'=> $row[0]['DATA_LENGTH'] ); } #$this->__cacheDescription($this->fullTableName($model, false), $fields); return $fields; } /** * Deletes all the records in a table and drops all associated auto-increment sequences. * Using DELETE instead of TRUNCATE because it causes locking problems. * * @param mixed $table A string or model class representing the table to be truncated * @param integer $reset If -1, sequences are dropped, if 0 (default), sequences are reset, * and if 1, sequences are not modified * @return boolean SQL TRUNCATE TABLE statement, false if not applicable. * @access public * */ function truncate($table, $reset = 0) { $sql = "SELECT sequence_name FROM all_sequences"; $this->execute($sql); while ($row = $this->fetchRow()) { } } $this->execute('DELETE FROM ' . $this->fullTableName($table)); return true; } if ($reset === 0) { $this->execute("SELECT {$this->_sequenceMap[$table]}.nextval FROM dual"); $row = $this->fetchRow(); $currval = $row[$this->_sequenceMap[$table]]['nextval']; $this->execute("SELECT min_value FROM all_sequences WHERE sequence_name = '{$this->_sequenceMap[$table]}'"); $row = $this->fetchRow(); $min_value = $row[0]['min_value']; if ($min_value == 1) $min_value = 0; $offset = -($currval - $min_value); $this->execute("ALTER SEQUENCE {$this->_sequenceMap[$table]} INCREMENT BY $offset MINVALUE $min_value"); $this->execute("SELECT {$this->_sequenceMap[$table]}.nextval FROM dual"); $this->execute("ALTER SEQUENCE {$this->_sequenceMap[$table]} INCREMENT BY 1"); } else { //$this->execute("DROP SEQUENCE {$this->_sequenceMap[$table]}"); } return true; } /** * Enables, disables, and lists table constraints * * Note: This method could have been written using a subselect for each table, * however the effort Oracle expends to run the constraint introspection is very high. * Therefore, this method caches the result once and loops through the arrays to find * what it needs. It reduced my query time by 50%. YMMV. * * @param string $action * @param string $table * @return mixed boolean true or array of constraints */ function constraint($action, $table) { } $sql = "SELECT table_name, c.constraint_name FROM all_cons_columns cc LEFT JOIN all_indexes i ON (cc.constraint_name = i.index_name) LEFT JOIN all_constraints c ON(c.constraint_name = cc.constraint_name)"; $this->execute($sql); while ($row = $this->fetchRow()) { } } foreach ($this->_keyConstraints as $c) { if ($c[0] == $table) { $relatedKeys[] = $c[1]; } } $sql = "SELECT table_name, constraint_name, r_constraint_name FROM all_constraints"; $this->execute($sql); while ($row = $this->fetchRow()) { $this->_constraints[] = $row[0]; } } foreach ($this->_constraints as $c) { } } foreach ($constraints as $c) { switch ($action) { case 'enable': $this->execute("ALTER TABLE $table ENABLE CONSTRAINT $constraint"); break; case 'disable': $this->execute("ALTER TABLE $table DISABLE CONSTRAINT $constraint"); break; case 'list': return $constraints; break; default: } } return true; } /** * Returns an array of the indexes in given table name. * * @param string $model Name of model to inspect * @return array Fields in table. Keys are column and unique */ function index($model) { $table = $this->fullTableName($model, false); if ($table) { $indexes = $this->query('SELECT cc.table_name, cc.column_name, cc.constraint_name, c.constraint_type, i.index_name, i.uniqueness FROM all_cons_columns cc LEFT JOIN all_indexes i ON(cc.constraint_name = i.index_name) LEFT JOIN all_constraints c ON(c.constraint_name = cc.constraint_name) foreach ($indexes as $i => $idx) { if ($idx['c']['constraint_type'] == 'P') { $key = 'PRIMARY'; } else { continue; } } else { $col[] = $index[$key]['column']; } $index[$key]['column'] = $col; } } } return $index; } /** * Generate a Oracle Alter Table syntax for the given Schema comparison * * @param unknown_type $schema * @return unknown */ function alterSchema($compare, $table = null) { return false; } $out = ''; foreach($compare as $curTable => $types) { if (!$table || $table == $curTable) { $out .= 'ALTER TABLE ' . $this->fullTableName($curTable) . " \n"; foreach($types as $type => $column) { switch($type) { case 'add': foreach($column as $field => $col) { $col['name'] = $field; $alter = 'ADD '.$this->buildColumn($col); $alter .= ' AFTER '. $this->name($col['after']); } $colList[] = $alter; } break; case 'drop': foreach($column as $field => $col) { $col['name'] = $field; $colList[] = 'DROP '.$this->name($field); } break; case 'change': foreach($column as $field => $col) { $col['name'] = $field; } $colList[] = 'CHANGE '. $this->name($field).' '.$this->buildColumn($col); } break; } } } } return $out; } /** * This method should quote Oracle identifiers. Well it doesn't. * It would break all scaffolding and all of Cake's default assumptions. * * @param unknown_type $var * @return unknown * @access public */ function name($name) { if ($field[0] == "_") { $name = "$model.\"$field\""; } } else { if ($name[0] == "_") { $name = "\"$name\""; } } return $name; } /** * Begin a transaction * * @param unknown_type $model * @return boolean True on success, false on fail * (i.e. if the database/model does not support transactions). */ function begin() { $this->__transactionStarted = true; return true; } /** * Rollback a transaction * * @param unknown_type $model * @return boolean True on success, false on fail * (i.e. if the database/model does not support transactions, * or a transaction has not started). */ function rollback() { return ocirollback($this->connection); } /** * Commit a transaction * * @param unknown_type $model * @return boolean True on success, false on fail * (i.e. if the database/model does not support transactions, * or a transaction has not started). */ function commit() { $this->__transactionStarted = false; return ocicommit($this->connection); } /** * Converts database-layer column types to basic types * * @param string $real Real database-layer column type (i.e. "varchar(255)") * @return string Abstract column type (i.e. "string") * @access public */ function column($real) { $col = $real['name']; $col .= '('.$real['limit'].')'; } return $col; } else { } $limit = null; } return $col; } return 'integer'; } return 'integer'; } return 'string'; } return 'text'; } return 'binary'; } return 'float'; } if ($col == 'boolean') { return $col; } return 'text'; } /** * Returns a quoted and escaped string of $data for use in an SQL statement. * * @param string $data String to be prepared for use in an SQL statement * @return string Quoted and escaped * @access public */ function value($data, $column = null, $safe = false) { $parent = parent::value($data, $column, $safe); if ($parent != null) { return $parent; } if ($data === null) { return 'NULL'; } if ($data === '') { return "''"; } switch($column) { case 'date': $data = "TO_DATE('$data', 'YYYY-MM-DD HH24:MI:SS')"; break; case 'integer' : case 'float' : case null : break; } default: $data = "'$data'"; break; } return $data; } /** * Returns the ID generated from the previous INSERT operation. * * @param string * @return integer * @access public */ function lastInsertId($source) { $sequence = $this->_sequenceMap[$source]; $sql = "SELECT $sequence.currval FROM dual"; if (!$this->execute($sql)) { return false; } while($row = $this->fetchRow()) { return $row[$sequence]['currval']; } return false; } /** * Returns a formatted error message from previous database operation. * * @return string Error message with error number * @access public */ function lastError() { return $this->_error; } /** * Returns number of affected rows in previous database operation. If no previous operation exists, this returns false. * * @return int Number of affected rows * @access public */ function lastAffected() { return $this->_statementId ? ocirowcount($this->_statementId): false; } /** * Renders a final SQL statement by putting together the component parts in the correct order * * @param string $type * @param array $data * @return string */ function renderStatement($type, $data) { $aliases = null; case 'select': return "SELECT {$fields} FROM {$table} {$alias} {$joins} {$conditions} {$group} {$order} {$limit}"; break; case 'create': return "INSERT INTO {$table} ({$fields}) VALUES ({$values})"; break; case 'update': $aliases = "{$this->alias}{$alias} "; } return "UPDATE {$table} {$aliases}SET {$fields} {$conditions}"; break; case 'delete': $aliases = "{$this->alias}{$alias} "; } return "DELETE FROM {$table} {$aliases}{$conditions}"; break; case 'schema': } } $columns .= ','; } return "CREATE TABLE {$table} (\n{$columns}{$indexes})"; break; case 'alter': break; } } /** * Enter description here... * * @param Model $model * @param unknown_type $linkModel * @param string $type Association type * @param unknown_type $association * @param unknown_type $assocData * @param unknown_type $queryData * @param unknown_type $external * @param unknown_type $resultSet * @param integer $recursive Number of levels of association * @param array $stack */ function queryAssociation(&$model, &$linkModel, $type, $association, $assocData, &$queryData, $external = false, &$resultSet, $recursive, $stack) { if ($query = $this->generateAssociationQuery($model, $linkModel, $type, $association, $assocData, $queryData, $external, $resultSet)) { if (Configure::read() > 0) { echo '<div style = "font: Verdana bold 12px; color: #FF0000">' . sprintf(__('SQL Error in model %s:', true), $model->alias) . ' '; echo $this->error; } echo '</div>'; } return null; } for ($i = 0; $i < $count; $i++) { if ($in = $this->insertQueryData('{$__cakeID__$}', $resultSet[$i], $association, $assocData, $model, $linkModel, $stack)) { $ins[] = $in; } } foreach ($ins as $i) { $res = $this->fetchAll($q, $model->cacheQueries, $model->alias); } } if ($recursive > 0) { foreach ($linkModel->__associations as $type1) { foreach ($linkModel->{$type1} as $assoc1 => $assocData1) { $deepModel =& $linkModel->{$assoc1}; $tmpStack = $stack; $tmpStack[] = $assoc1; if ($linkModel->useDbConfig === $deepModel->useDbConfig) { $db =& $this; } else { $db =& ConnectionManager::getDataSource($deepModel->useDbConfig); } $db->queryAssociation($linkModel, $deepModel, $type1, $assoc1, $assocData1, $queryData, true, $fetch, $recursive - 1, $tmpStack); } } } } return $this->__mergeHasMany($resultSet, $fetch, $association, $model, $linkModel, $recursive); } elseif ($type === 'hasAndBelongsToMany') { for ($i = 0; $i < $count; $i++) { if ($in = $this->insertQueryData('{$__cakeID__$}', $resultSet[$i], $association, $assocData, $model, $linkModel, $stack)) { $ins[] = $in; } } $foreignKey = $model->hasAndBelongsToMany[$association]['foreignKey']; list($with, $habtmFields) = $model->joinModel($model->hasAndBelongsToMany[$association]['with'], $joinKeys); foreach ($ins as $i) { $q = $this->insertQueryData($q, null, $association, $assocData, $model, $linkModel, $stack); if ($q != false) { $res = $this->fetchAll($q, $model->cacheQueries, $model->alias); } } } } for ($i = 0; $i < $count; $i++) { $row =& $resultSet[$i]; if ($type !== 'hasAndBelongsToMany') { $q = $this->insertQueryData($query, $resultSet[$i], $association, $assocData, $model, $linkModel, $stack); if ($q != false) { $fetch = $this->fetchAll($q, $model->cacheQueries, $model->alias); } else { $fetch = null; } } if ($recursive > 0) { foreach ($linkModel->__associations as $type1) { foreach ($linkModel->{$type1} as $assoc1 => $assocData1) { $deepModel =& $linkModel->{$assoc1}; if (($type1 === 'belongsTo') || ($deepModel->alias === $model->alias && $type === 'belongsTo') || ($deepModel->alias != $model->alias)) { $tmpStack = $stack; $tmpStack[] = $assoc1; if ($linkModel->useDbConfig == $deepModel->useDbConfig) { $db =& $this; } else { $db =& ConnectionManager::getDataSource($deepModel->useDbConfig); } $db->queryAssociation($linkModel, $deepModel, $type1, $assoc1, $assocData1, $queryData, true, $fetch, $recursive - 1, $tmpStack); } } } } if ($type == 'hasAndBelongsToMany') { foreach($fetch as $j => $data) { if ($habtmFieldsCount > 2) { $merge[] = $data; } else { } } } $row[$association] = $merge; } else { $this->__mergeAssociation($resultSet[$i], $merge, $association, $type); } } else { $this->__mergeAssociation($resultSet[$i], $fetch, $association, $type); } $resultSet[$i][$association] = $linkModel->afterfind($resultSet[$i][$association]); } else { $tempArray[0][$association] = false; $this->__mergeAssociation($resultSet[$i], $tempArray, $association, $type); } } } } /** * Generate a "drop table" statement for the given Schema object * * @param object $schema An instance of a subclass of CakeSchema * @param string $table Optional. If specified only the table name given will be generated. * Otherwise, all tables defined in the schema are generated. * @return string */ function dropSchema($schema, $table = null) { return null; } $out = ''; foreach ($schema->tables as $curTable => $columns) { if (!$table || $table == $curTable) { $out .= 'DROP TABLE ' . $this->fullTableName($curTable) . "\n"; } } return $out; } }
130 views




