| // +----------------------------------------------------------------------+ // // $Id$ // /** * MDB2 SQLite driver * * @package MDB2 * @category Database * @author Lukas Smith */ class MDB2_Driver_sqlite extends MDB2_Driver_Common { // {{{ properties var $escape_quotes = "'"; var $_lasterror = ''; // }}} // {{{ constructor /** * Constructor */ function __construct() { parent::__construct(); $this->phptype = 'sqlite'; $this->dbsyntax = 'sqlite'; $this->supported['sequences'] = true; $this->supported['indexes'] = true; $this->supported['affected_rows'] = true; $this->supported['summary_functions'] = true; $this->supported['order_by_text'] = true; $this->supported['current_id'] = true; $this->supported['limit_queries'] = true; $this->supported['LOBs'] = true; $this->supported['replace'] = true; $this->supported['transactions'] = true; $this->supported['sub_selects'] = true; $this->supported['auto_increment'] = true; $this->options['base_transaction_name'] = '___php_MDB2_sqlite_auto_commit_off'; $this->options['fixed_float'] = 0; $this->options['database_path'] = ''; $this->options['database_extension'] = ''; } // }}} // {{{ errorInfo() /** * This method is used to collect information about an error * * @param integer $error * @return array * @access public */ function errorInfo($error = null) { $native_code = null; if ($this->connection) { $native_code = @sqlite_last_error($this->connection); } $native_msg = @sqlite_error_string($native_code); if (is_null($error)) { static $error_regexps; if (empty($error_regexps)) { $error_regexps = array( '/^no such table:/' => MDB2_ERROR_NOSUCHTABLE, '/^no such index:/' => MDB2_ERROR_NOT_FOUND, '/^(table|index) .* already exists$/' => MDB2_ERROR_ALREADY_EXISTS, '/PRIMARY KEY must be unique/i' => MDB2_ERROR_CONSTRAINT, '/is not unique/' => MDB2_ERROR_CONSTRAINT, '/columns .* are not unique/i' => MDB2_ERROR_CONSTRAINT, '/uniqueness constraint failed/' => MDB2_ERROR_CONSTRAINT, '/may not be NULL/' => MDB2_ERROR_CONSTRAINT_NOT_NULL, '/^no such column:/' => MDB2_ERROR_NOSUCHFIELD, '/column not present in both tables/i' => MDB2_ERROR_NOSUCHFIELD, '/^near ".*": syntax error$/' => MDB2_ERROR_SYNTAX, '/[0-9]+ values for [0-9]+ columns/i' => MDB2_ERROR_VALUE_COUNT_ON_ROW, ); } foreach ($error_regexps as $regexp => $code) { if (preg_match($regexp, $this->_lasterror)) { $error = $code; break; } } } return array($error, $native_code, $native_msg); } // }}} // {{{ escape() /** * Quotes a string so it can be safely used in a query. It will quote * the text so it can safely be used within a query. * * @param string $text the input string to quote * @return string quoted string * @access public */ function escape($text) { return @sqlite_escape_string($text); } // }}} // {{{ beginTransaction() /** * Start a transaction. * * @return mixed MDB2_OK on success, a MDB2 error on failure * @access public */ function beginTransaction() { $this->debug('starting transaction', 'beginTransaction'); if ($this->in_transaction) { return MDB2_OK; //nothing to do } if (!$this->destructor_registered && $this->opened_persistent) { $this->destructor_registered = true; register_shutdown_function('MDB2_closeOpenTransactions'); } $query = 'BEGIN TRANSACTION '.$this->options['base_transaction_name']; $result = $this->_doQuery($query, true); if (PEAR::isError($result)) { return $result; } $this->in_transaction = true; return MDB2_OK; } // }}} // {{{ commit() /** * Commit the database changes done during a transaction that is in * progress. * * @return mixed MDB2_OK on success, a MDB2 error on failure * @access public */ function commit() { $this->debug('commit transaction', 'commit'); if (!$this->in_transaction) { return $this->raiseError(MDB2_ERROR, null, null, 'commit: transaction changes are being auto committed'); } $query = 'COMMIT TRANSACTION '.$this->options['base_transaction_name']; $result = $this->_doQuery($query, true); if (PEAR::isError($result)) { return $result; } $this->in_transaction = false; return MDB2_OK; } // }}} // {{{ rollback() /** * Cancel any database changes done during a transaction that is in * progress. * * @return mixed MDB2_OK on success, a MDB2 error on failure * @access public */ function rollback() { $this->debug('rolling back transaction', 'rollback'); if (!$this->in_transaction) { return $this->raiseError(MDB2_ERROR, null, null, 'rollback: transactions can not be rolled back when changes are auto committed'); } $query = 'ROLLBACK TRANSACTION '.$this->options['base_transaction_name']; $result = $this->_doQuery($query, true); if (PEAR::isError($result)) { return $result; } $this->in_transaction = false; return MDB2_OK; } // }}} // {{{ getDatabaseFile() /** * Builds the string with path+dbname+extension * * @return string full database path+file * @access protected */ function _getDatabaseFile($database_name) { if ($database_name == '') { return $database_name; } return $this->options['database_path'].$database_name.$this->options['database_extension']; } // }}} // {{{ connect() /** * Connect to the database * * @return true on success, MDB2 Error Object on failure **/ function connect() { $database_file = $this->_getDatabaseFile($this->database_name); if (is_resource($this->connection)) { if (count(array_diff($this->connected_dsn, $this->dsn)) == 0 && $this->connected_database_name == $database_file && $this->opened_persistent == $this->options['persistent'] ) { return MDB2_OK; } $this->disconnect(false); } if (!PEAR::loadExtension($this->phptype)) { return $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null, 'connect: extension '.$this->phptype.' is not compiled into PHP'); } if (!empty($this->database_name)) { if (!file_exists($database_file)) { if (!touch($database_file)) { return $this->raiseError(MDB2_ERROR_NOT_FOUND); } if (!isset($this->dsn['mode']) || !is_numeric($this->dsn['mode']) ) { $mode = 0644; } else { $mode = octdec($this->dsn['mode']); } if (!chmod($database_file, $mode)) { return $this->raiseError(MDB2_ERROR_NOT_FOUND); } if (!file_exists($database_file)) { return $this->raiseError(MDB2_ERROR_NOT_FOUND); } } if (!is_file($database_file)) { return $this->raiseError(MDB2_ERROR_INVALID); } if (!is_readable($database_file)) { return $this->raiseError(MDB2_ERROR_ACCESS_VIOLATION); } $connect_function = ($this->options['persistent'] ? 'sqlite_popen' : 'sqlite_open'); $php_errormsg = ''; @ini_set('track_errors', true); $connection = @$connect_function($database_file); @ini_restore('track_errors'); $this->_lasterror = isset($php_errormsg) ? $php_errormsg : ''; if (!$connection) { return $this->raiseError(MDB2_ERROR_CONNECT_FAILED); } $this->connection = $connection; $this->connected_dsn = $this->dsn; $this->connected_database_name = $database_file; $this->opened_persistent = $this->getoption('persistent'); $this->dbsyntax = $this->dsn['dbsyntax'] ? $this->dsn['dbsyntax'] : $this->phptype; } return MDB2_OK; } // }}} // {{{ disconnect() /** * Log out and disconnect from the database. * * @return mixed true on success, false if not connected and error * object on error * @access public */ function disconnect($force = true) { if (is_resource($this->connection)) { if (!$this->opened_persistent || $force) { @sqlite_close($this->connection); } $this->connection = 0; } return MDB2_OK; } // }}} // {{{ _doQuery() /** * Execute a query * @param string $query query * @param boolean $isManip if the query is a manipulation query * @param resource $connection * @param string $database_name * @return result or error object * @access protected */ function _doQuery($query, $isManip = false, $connection = null, $database_name = null) { $this->last_query = $query; $this->debug($query, 'query'); if ($this->options['disable_query']) { if ($isManip) { return MDB2_OK; } return null; } if (is_null($connection)) { $error = $this->connect(); if (PEAR::isError($error)) { return $error; } $connection = $this->connection; } $function = $this->options['result_buffering'] ? 'sqlite_query' : 'sqlite_unbuffered_query'; $php_errormsg = ''; ini_set('track_errors', true); $result = @$function($query.';', $connection); ini_restore('track_errors'); $this->_lasterror = isset($php_errormsg) ? $php_errormsg : ''; if (!$result) { return $this->raiseError(); } if ($isManip) { return @sqlite_changes($connection); } return $result; } // }}} // {{{ _modifyQuery() /** * Changes a query string for various DBMS specific reasons * * @param string $query query to modify * @return the new (modified) query * @access protected */ function _modifyQuery($query, $isManip, $limit, $offset) { if ($this->options['portability'] & MDB2_PORTABILITY_DELETE_COUNT) { if (preg_match('/^\s*DELETE\s+FROM\s+(\S+)\s*$/i', $query)) { $query = preg_replace('/^\s*DELETE\s+FROM\s+(\S+)\s*$/', 'DELETE FROM \1 WHERE 1=1', $query); } } if ($limit > 0 && !preg_match('/LIMIT\s*\d(\s*(,|OFFSET)\s*\d+)?/i', $query) ) { $query = rtrim($query); if (substr($query, -1) == ';') { $query = substr($query, 0, -1); } if ($isManip) { $query .= " LIMIT $limit"; } else { $query .= " LIMIT $offset,$limit"; } } return $query; } // }}} // {{{ replace() /** * Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT * query, except that if there is already a row in the table with the same * key field values, the REPLACE query just updates its values instead of * inserting a new row. * * The REPLACE type of query does not make part of the SQL standards. Since * practically only SQLite implements it natively, this type of query is * emulated through this method for other DBMS using standard types of * queries inside a transaction to assure the atomicity of the operation. * * @access public * * @param string $table name of the table on which the REPLACE query will * be executed. * @param array $fields associative array that describes the fields and the * values that will be inserted or updated in the specified table. The * indexes of the array are the names of all the fields of the table. The * values of the array are also associative arrays that describe the * values and other properties of the table fields. * * Here follows a list of field properties that need to be specified: * * value: * Value to be assigned to the specified field. This value may be * of specified in database independent type format as this * function can perform the necessary datatype conversions. * * Default: * this property is required unless the Null property * is set to 1. * * type * Name of the type of the field. Currently, all types Metabase * are supported except for clob and blob. * * Default: no type conversion * * null * Boolean property that indicates that the value for this field * should be set to null. * * The default value for fields missing in INSERT queries may be * specified the definition of a table. Often, the default value * is already null, but since the REPLACE may be emulated using * an UPDATE query, make sure that all fields of the table are * listed in this function argument array. * * Default: 0 * * key * Boolean property that indicates that this field should be * handled as a primary key or at least as part of the compound * unique index of the table that will determine the row that will * updated if it exists or inserted a new row otherwise. * * This function will fail if no key field is specified or if the * value of a key field is set to null because fields that are * part of unique index they may not be null. * * Default: 0 * * @return mixed MDB2_OK on success, a MDB2 error on failure */ function replace($table, $fields) { $count = count($fields); $query = $values = ''; $keys = $colnum = 0; for (reset($fields); $colnum < $count; next($fields), $colnum++) { $name = key($fields); if ($colnum > 0) { $query .= ','; $values .= ','; } $query .= $name; if (isset($fields[$name]['null']) && $fields[$name]['null']) { $value = 'NULL'; } else { $value = $this->quote($fields[$name]['value'], $fields[$name]['type']); } $values .= $value; if (isset($fields[$name]['key']) && $fields[$name]['key']) { if ($value === 'NULL') { return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null, 'replace: key value '.$name.' may not be NULL'); } $keys++; } } if ($keys == 0) { return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null, 'replace: not specified which fields are keys'); } $query = "REPLACE INTO $table ($query) VALUES ($values)"; $this->last_query = $query; $this->debug($query, 'query'); return $this->_doQuery($query, true); } // }}} // {{{ nextID() /** * returns the next free id of a sequence * * @param string $seq_name name of the sequence * @param boolean $ondemand when true the seqence is * automatic created, if it * not exists * * @return mixed MDB2 Error Object or id * @access public */ function nextID($seq_name, $ondemand = true) { $sequence_name = $this->getSequenceName($seq_name); $query = "INSERT INTO $sequence_name (".$this->options['seqcol_name'].") VALUES (NULL)"; $this->expectError(MDB2_ERROR_NOSUCHTABLE); $result = $this->_doQuery($query, true); $this->popExpect(); if (PEAR::isError($result)) { if ($ondemand && $result->getCode() == MDB2_ERROR_NOSUCHTABLE) { $this->loadModule('Manager'); // Since we are creating the sequence on demand // we know the first id = 1 so initialize the // sequence at 2 $result = $this->manager->createSequence($seq_name, 2); if (PEAR::isError($result)) { return $this->raiseError(MDB2_ERROR, null, null, 'nextID: on demand sequence '.$seq_name.' could not be created'); } else { // First ID of a newly created sequence is 1 return 1; } } return $result; } $value = @sqlite_last_insert_rowid($this->connection); if (is_numeric($value) && PEAR::isError($this->_doQuery("DELETE FROM $sequence_name WHERE ".$this->options['seqcol_name']." < $value", true)) ) { $this->warnings[] = 'nextID: could not delete previous sequence table values from '.$seq_name; } return $value; } // }}} // {{{ getAfterID() /** * returns the autoincrement ID if supported or $id * * @param mixed $id value as returned by getBeforeId() * @param string $table name of the table into which a new row was inserted * @return mixed MDB2 Error Object or id * @access public */ function getAfterID($id, $table) { $this->loadModule('Native'); return $this->native->getInsertID(); } // }}} // {{{ currID() /** * returns the current id of a sequence * * @param string $seq_name name of the sequence * @return mixed MDB2 Error Object or id * @access public */ function currID($seq_name) { $sequence_name = $this->getSequenceName($seq_name); return $this->queryOne("SELECT MAX(".$this->options['seqcol_name'].") FROM $sequence_name", 'integer'); } } class MDB2_Result_sqlite extends MDB2_Result_Common { // }}} // {{{ fetchRow() /** * Fetch a row and insert the data into an existing array. * * @param int $fetchmode how the array data should be indexed * @param int $rownum number of the row where the data can be found * @return int data array on success, a MDB2 error on failure * @access public */ function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null) { if (!is_null($rownum)) { $seek = $this->seek($rownum); if (PEAR::isError($seek)) { return $seek; } } if ($fetchmode == MDB2_FETCHMODE_DEFAULT) { $fetchmode = $this->db->fetchmode; } if ($fetchmode & MDB2_FETCHMODE_ASSOC) { $row = @sqlite_fetch_array($this->result, SQLITE_ASSOC); if (is_array($row) && $this->db->options['portability'] & MDB2_PORTABILITY_LOWERCASE ) { $row = array_change_key_case($row, CASE_LOWER); } } else { $row = @sqlite_fetch_array($this->result, SQLITE_NUM); } if (!$row) { if (is_null($this->result)) { return $this->db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null, 'fetchRow: resultset has already been freed'); } return null; } if ($this->db->options['portability'] & MDB2_PORTABILITY_EMPTY_TO_NULL) { $this->db->_convertEmptyArrayValuesToNull($row); } if (isset($this->values)) { $this->_assignBindColumns($row); } if (isset($this->types)) { $row = $this->db->datatype->convertResultRow($this->types, $row); } if ($fetchmode === MDB2_FETCHMODE_OBJECT) { $object_class = $this->db->options['fetch_class']; if ($object_class == 'stdClass') { $row = (object) $row; } else { $row = &new $object_class($row); } } ++$this->rownum; return $row; } // }}} // {{{ _getColumnNames() /** * Retrieve the names of columns returned by the DBMS in a query result. * * @return mixed an associative array variable * that will hold the names of columns. The * indexes of the array are the column names * mapped to lower case and the values are the * respective numbers of the columns starting * from 0. Some DBMS may not return any * columns when the result set does not * contain any rows. * * a MDB2 error on failure * @access private */ function _getColumnNames() { $columns = array(); $numcols = $this->numCols(); if (PEAR::isError($numcols)) { return $numcols; } for ($column = 0; $column < $numcols; $column++) { $column_name = @sqlite_field_name($this->result, $column); $columns[$column_name] = $column; } if ($this->db->options['portability'] & MDB2_PORTABILITY_LOWERCASE) { $columns = array_change_key_case($columns, CASE_LOWER); } return $columns; } // }}} // {{{ numCols() /** * Count the number of columns returned by the DBMS in a query result. * * @access public * @return mixed integer value with the number of columns, a MDB2 error * on failure */ function numCols() { $cols = @sqlite_num_fields($this->result); if (is_null($cols)) { if (is_null($this->result)) { return $this->db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null, 'numCols: resultset has already been freed'); } return $this->db->raiseError(); } return $cols; } } class MDB2_BufferedResult_sqlite extends MDB2_Result_sqlite { // {{{ seek() /** * seek to a specific row in a result set * * @param int $rownum number of the row where the data can be found * @return mixed MDB2_OK on success, a MDB2 error on failure * @access public */ function seek($rownum = 0) { if (!@sqlite_seek($this->result, $rownum)) { if (is_null($this->result)) { return $this->db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null, 'seek: resultset has already been freed'); } return $this->db->raiseError(MDB2_ERROR_INVALID, null, null, 'seek: tried to seek to an invalid row number ('.$rownum.')'); } $this->rownum = $rownum - 1; return MDB2_OK; } // }}} // {{{ valid() /** * check if the end of the result set has been reached * * @return mixed true or false on sucess, a MDB2 error on failure * @access public */ function valid() { $numrows = $this->numRows(); if (PEAR::isError($numrows)) { return $numrows; } return $this->rownum < ($numrows - 1); } // }}} // {{{ numRows() /** * returns the number of rows in a result object * * @return mixed MDB2 Error Object or the number of rows * @access public */ function numRows() { $rows = @sqlite_num_rows($this->result); if (is_null($rows)) { if (is_null($this->result)) { return $this->db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null, 'numRows: resultset has already been freed'); } return $this->raiseError(); } return $rows; } } class MDB2_Statement_sqlite extends MDB2_Statement_Common { } ?>