Andrey Andreev | c5536aa | 2012-11-01 17:33:58 +0200 | [diff] [blame] | 1 | <?php |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 2 | /** |
| 3 | * CodeIgniter |
| 4 | * |
Andrey Andreev | a6fe36e | 2012-04-05 16:00:32 +0300 | [diff] [blame] | 5 | * An open source application development framework for PHP 5.2.4 or newer |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 6 | * |
| 7 | * NOTICE OF LICENSE |
| 8 | * |
| 9 | * Licensed under the Open Software License version 3.0 |
| 10 | * |
| 11 | * This source file is subject to the Open Software License (OSL 3.0) that is |
Andrey Andreev | f20fb98 | 2012-01-24 15:26:01 +0200 | [diff] [blame] | 12 | * bundled with this package in the files license.txt / license.rst. It is |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 13 | * also available through the world wide web at this URL: |
| 14 | * http://opensource.org/licenses/OSL-3.0 |
| 15 | * If you did not receive a copy of the license and are unable to obtain it |
| 16 | * through the world wide web, please send an email to |
| 17 | * licensing@ellislab.com so we can send you a copy immediately. |
| 18 | * |
Andrey Andreev | 17ceeae | 2012-04-05 15:38:30 +0300 | [diff] [blame] | 19 | * @package CodeIgniter |
| 20 | * @author EllisLab Dev Team |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 21 | * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/) |
Andrey Andreev | 17ceeae | 2012-04-05 15:38:30 +0300 | [diff] [blame] | 22 | * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) |
| 23 | * @link http://codeigniter.com |
| 24 | * @since Version 1.0 |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 25 | * @filesource |
| 26 | */ |
Andrey Andreev | c5536aa | 2012-11-01 17:33:58 +0200 | [diff] [blame] | 27 | defined('BASEPATH') OR exit('No direct script access allowed'); |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 28 | |
| 29 | /** |
| 30 | * SQLite3 Database Adapter Class |
| 31 | * |
| 32 | * Note: _DB is an extender class that the app controller |
Jamie Rumbelow | ffe7a0a | 2012-04-26 13:48:18 +0100 | [diff] [blame] | 33 | * creates dynamically based on whether the query builder |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 34 | * class is being used or not. |
| 35 | * |
Andrey Andreev | 17ceeae | 2012-04-05 15:38:30 +0300 | [diff] [blame] | 36 | * @package CodeIgniter |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 37 | * @subpackage Drivers |
| 38 | * @category Database |
Andrey Andreev | 17ceeae | 2012-04-05 15:38:30 +0300 | [diff] [blame] | 39 | * @author Andrey Andreev |
| 40 | * @link http://codeigniter.com/user_guide/database/ |
| 41 | * @since Version 3.0 |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 42 | */ |
| 43 | class CI_DB_sqlite3_driver extends CI_DB { |
| 44 | |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 45 | /** |
| 46 | * Database driver |
| 47 | * |
| 48 | * @var string |
| 49 | */ |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 50 | public $dbdriver = 'sqlite3'; |
| 51 | |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 52 | // -------------------------------------------------------------------- |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 53 | |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 54 | /** |
| 55 | * ORDER BY random keyword |
| 56 | * |
Andrey Andreev | 98e46cf | 2012-11-13 03:01:42 +0200 | [diff] [blame^] | 57 | * @var array |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 58 | */ |
Andrey Andreev | 98e46cf | 2012-11-13 03:01:42 +0200 | [diff] [blame^] | 59 | protected $_random_keyword = array('RANDOM()', 'RANDOM()'); |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 60 | |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 61 | // -------------------------------------------------------------------- |
| 62 | |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 63 | /** |
| 64 | * Non-persistent database connection |
| 65 | * |
| 66 | * @return object type SQLite3 |
| 67 | */ |
| 68 | public function db_connect() |
| 69 | { |
| 70 | try |
| 71 | { |
| 72 | return ( ! $this->password) |
| 73 | ? new SQLite3($this->database) |
| 74 | : new SQLite3($this->database, SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $this->password); |
| 75 | } |
| 76 | catch (Exception $e) |
| 77 | { |
| 78 | return FALSE; |
| 79 | } |
| 80 | } |
| 81 | |
| 82 | // -------------------------------------------------------------------- |
| 83 | |
| 84 | /** |
| 85 | * Persistent database connection |
| 86 | * |
| 87 | * @return object type SQLite3 |
| 88 | */ |
| 89 | public function db_pconnect() |
| 90 | { |
| 91 | log_message('debug', 'SQLite3 doesn\'t support persistent connections'); |
Andrey Andreev | 9d533ae | 2012-06-04 15:56:56 +0300 | [diff] [blame] | 92 | return $this->db_connect(); |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | // -------------------------------------------------------------------- |
| 96 | |
| 97 | /** |
Andrey Andreev | 80e34f9 | 2012-03-03 03:25:23 +0200 | [diff] [blame] | 98 | * Database version number |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 99 | * |
| 100 | * @return string |
| 101 | */ |
Andrey Andreev | 80e34f9 | 2012-03-03 03:25:23 +0200 | [diff] [blame] | 102 | public function version() |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 103 | { |
Andrey Andreev | 80e34f9 | 2012-03-03 03:25:23 +0200 | [diff] [blame] | 104 | if (isset($this->data_cache['version'])) |
| 105 | { |
| 106 | return $this->data_cache['version']; |
| 107 | } |
| 108 | |
Andrey Andreev | fc11dcc | 2012-06-04 16:39:19 +0300 | [diff] [blame] | 109 | $version = SQLite3::version(); |
Andrey Andreev | 80e34f9 | 2012-03-03 03:25:23 +0200 | [diff] [blame] | 110 | return $this->data_cache['version'] = $version['versionString']; |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | // -------------------------------------------------------------------- |
| 114 | |
| 115 | /** |
| 116 | * Execute the query |
| 117 | * |
Andrey Andreev | 5fd3ae8 | 2012-10-24 14:55:35 +0300 | [diff] [blame] | 118 | * @todo Implement use of SQLite3::querySingle(), if needed |
| 119 | * @param string $sql |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 120 | * @return mixed SQLite3Result object or bool |
| 121 | */ |
| 122 | protected function _execute($sql) |
| 123 | { |
Andrey Andreev | a92c7cd | 2012-03-02 13:51:22 +0200 | [diff] [blame] | 124 | return $this->is_write_type($sql) |
| 125 | ? $this->conn_id->exec($sql) |
| 126 | : $this->conn_id->query($sql); |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | // -------------------------------------------------------------------- |
| 130 | |
| 131 | /** |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 132 | * Begin Transaction |
| 133 | * |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 134 | * @param bool $test_mode |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 135 | * @return bool |
| 136 | */ |
| 137 | public function trans_begin($test_mode = FALSE) |
| 138 | { |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 139 | // When transactions are nested we only begin/commit/rollback the outermost ones |
Andrey Andreev | 72d7a6e | 2012-01-19 16:02:32 +0200 | [diff] [blame] | 140 | if ( ! $this->trans_enabled OR $this->_trans_depth > 0) |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 141 | { |
| 142 | return TRUE; |
| 143 | } |
| 144 | |
| 145 | // Reset the transaction failure flag. |
| 146 | // If the $test_mode flag is set to TRUE transactions will be rolled back |
| 147 | // even if the queries produce a successful result. |
| 148 | $this->_trans_failure = ($test_mode === TRUE); |
| 149 | |
| 150 | return $this->conn_id->exec('BEGIN TRANSACTION'); |
| 151 | } |
| 152 | |
| 153 | // -------------------------------------------------------------------- |
| 154 | |
| 155 | /** |
| 156 | * Commit Transaction |
| 157 | * |
| 158 | * @return bool |
| 159 | */ |
| 160 | public function trans_commit() |
| 161 | { |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 162 | // When transactions are nested we only begin/commit/rollback the outermost ones |
Andrey Andreev | 72d7a6e | 2012-01-19 16:02:32 +0200 | [diff] [blame] | 163 | if ( ! $this->trans_enabled OR $this->_trans_depth > 0) |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 164 | { |
| 165 | return TRUE; |
| 166 | } |
| 167 | |
| 168 | return $this->conn_id->exec('END TRANSACTION'); |
| 169 | } |
| 170 | |
| 171 | // -------------------------------------------------------------------- |
| 172 | |
| 173 | /** |
| 174 | * Rollback Transaction |
| 175 | * |
| 176 | * @return bool |
| 177 | */ |
| 178 | public function trans_rollback() |
| 179 | { |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 180 | // When transactions are nested we only begin/commit/rollback the outermost ones |
Andrey Andreev | 72d7a6e | 2012-01-19 16:02:32 +0200 | [diff] [blame] | 181 | if ( ! $this->trans_enabled OR $this->_trans_depth > 0) |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 182 | { |
| 183 | return TRUE; |
| 184 | } |
| 185 | |
| 186 | return $this->conn_id->exec('ROLLBACK'); |
| 187 | } |
| 188 | |
| 189 | // -------------------------------------------------------------------- |
| 190 | |
| 191 | /** |
| 192 | * Escape String |
| 193 | * |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 194 | * @param string $str |
| 195 | * @param bool $like Whether or not the string will be used in a LIKE condition |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 196 | * @return string |
| 197 | */ |
| 198 | public function escape_str($str, $like = FALSE) |
| 199 | { |
| 200 | if (is_array($str)) |
| 201 | { |
| 202 | foreach ($str as $key => $val) |
| 203 | { |
| 204 | $str[$key] = $this->escape_str($val, $like); |
| 205 | } |
| 206 | |
| 207 | return $str; |
| 208 | } |
| 209 | |
| 210 | $str = $this->conn_id->escapeString(remove_invisible_characters($str)); |
| 211 | |
| 212 | // escape LIKE condition wildcards |
| 213 | if ($like === TRUE) |
| 214 | { |
Andrey Andreev | dc3de15 | 2012-03-12 15:41:49 +0200 | [diff] [blame] | 215 | return str_replace(array($this->_like_escape_chr, '%', '_'), |
| 216 | array($this->_like_escape_chr.$this->_like_escape_chr, $this->_like_escape_chr.'%', $this->_like_escape_chr.'_'), |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 217 | $str); |
| 218 | } |
| 219 | |
| 220 | return $str; |
| 221 | } |
| 222 | |
| 223 | // -------------------------------------------------------------------- |
| 224 | |
| 225 | /** |
| 226 | * Affected Rows |
| 227 | * |
| 228 | * @return int |
| 229 | */ |
| 230 | public function affected_rows() |
| 231 | { |
| 232 | return $this->conn_id->changes(); |
| 233 | } |
| 234 | |
| 235 | // -------------------------------------------------------------------- |
| 236 | |
| 237 | /** |
| 238 | * Insert ID |
| 239 | * |
| 240 | * @return int |
| 241 | */ |
| 242 | public function insert_id() |
| 243 | { |
| 244 | return $this->conn_id->lastInsertRowID(); |
| 245 | } |
| 246 | |
| 247 | // -------------------------------------------------------------------- |
| 248 | |
| 249 | /** |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 250 | * Show table query |
| 251 | * |
| 252 | * Generates a platform-specific query string so that the table names can be fetched |
| 253 | * |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 254 | * @param bool $prefix_limit |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 255 | * @return string |
| 256 | */ |
| 257 | protected function _list_tables($prefix_limit = FALSE) |
| 258 | { |
| 259 | return 'SELECT "NAME" FROM "SQLITE_MASTER" WHERE "TYPE" = \'table\'' |
| 260 | .(($prefix_limit !== FALSE && $this->dbprefix != '') |
| 261 | ? ' AND "NAME" LIKE \''.$this->escape_like_str($this->dbprefix).'%\' '.sprintf($this->_like_escape_str, $this->_like_escape_chr) |
| 262 | : ''); |
| 263 | } |
| 264 | |
| 265 | // -------------------------------------------------------------------- |
| 266 | |
| 267 | /** |
| 268 | * Show column query |
| 269 | * |
| 270 | * Generates a platform-specific query string so that the column names can be fetched |
| 271 | * |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 272 | * @param string $table |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 273 | * @return string |
| 274 | */ |
| 275 | protected function _list_columns($table = '') |
| 276 | { |
| 277 | // Not supported |
| 278 | return FALSE; |
| 279 | } |
| 280 | |
| 281 | // -------------------------------------------------------------------- |
| 282 | |
| 283 | /** |
| 284 | * Field data query |
| 285 | * |
| 286 | * Generates a platform-specific query so that the column data can be retrieved |
| 287 | * |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 288 | * @param string $table |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 289 | * @return string |
| 290 | */ |
| 291 | protected function _field_data($table) |
| 292 | { |
| 293 | return 'SELECT * FROM '.$table.' LIMIT 0,1'; |
| 294 | } |
| 295 | |
| 296 | // -------------------------------------------------------------------- |
| 297 | |
| 298 | /** |
Andrey Andreev | ebbfefa | 2012-10-05 17:46:47 +0300 | [diff] [blame] | 299 | * Error |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 300 | * |
Andrey Andreev | ebbfefa | 2012-10-05 17:46:47 +0300 | [diff] [blame] | 301 | * Returns an array containing code and message of the last |
| 302 | * database error that has occured. |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 303 | * |
Andrey Andreev | ebbfefa | 2012-10-05 17:46:47 +0300 | [diff] [blame] | 304 | * @return array |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 305 | */ |
Andrey Andreev | ebbfefa | 2012-10-05 17:46:47 +0300 | [diff] [blame] | 306 | public function error() |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 307 | { |
Andrey Andreev | ebbfefa | 2012-10-05 17:46:47 +0300 | [diff] [blame] | 308 | return array('code' => $this->conn_id->lastErrorCode(), 'message' => $this->conn_id->lastErrorMsg()); |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 309 | } |
| 310 | |
| 311 | // -------------------------------------------------------------------- |
| 312 | |
| 313 | /** |
Andrey Andreev | 17ceeae | 2012-04-05 15:38:30 +0300 | [diff] [blame] | 314 | * Replace statement |
| 315 | * |
| 316 | * Generates a platform-specific replace string from the supplied data |
| 317 | * |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 318 | * @param string $table Table name |
| 319 | * @param array $keys INSERT keys |
| 320 | * @param array $values INSERT values |
Andrey Andreev | 17ceeae | 2012-04-05 15:38:30 +0300 | [diff] [blame] | 321 | * @return string |
| 322 | */ |
| 323 | protected function _replace($table, $keys, $values) |
| 324 | { |
| 325 | return 'INSERT OR '.parent::_replace($table, $keys, $values); |
| 326 | } |
| 327 | |
| 328 | // -------------------------------------------------------------------- |
| 329 | |
| 330 | /** |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 331 | * Truncate statement |
| 332 | * |
| 333 | * Generates a platform-specific truncate string from the supplied data |
Andrey Andreev | a6fe36e | 2012-04-05 16:00:32 +0300 | [diff] [blame] | 334 | * |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 335 | * If the database does not support the TRUNCATE statement, |
Andrey Andreev | a6fe36e | 2012-04-05 16:00:32 +0300 | [diff] [blame] | 336 | * then this method maps to 'DELETE FROM table' |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 337 | * |
Andrey Andreev | a24e52e | 2012-11-02 03:54:12 +0200 | [diff] [blame] | 338 | * @param string $table |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 339 | * @return string |
| 340 | */ |
| 341 | protected function _truncate($table) |
| 342 | { |
Andrey Andreev | a6fe36e | 2012-04-05 16:00:32 +0300 | [diff] [blame] | 343 | return 'DELETE FROM '.$table; |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 344 | } |
| 345 | |
| 346 | // -------------------------------------------------------------------- |
| 347 | |
| 348 | /** |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 349 | * Close DB Connection |
| 350 | * |
| 351 | * @return void |
| 352 | */ |
Andrey Andreev | 79922c0 | 2012-05-23 12:27:17 +0300 | [diff] [blame] | 353 | protected function _close() |
Andrey Andreev | 8ae24c5 | 2012-01-16 13:05:23 +0200 | [diff] [blame] | 354 | { |
| 355 | $this->conn_id->close(); |
| 356 | } |
| 357 | |
| 358 | } |
| 359 | |
| 360 | /* End of file sqlite3_driver.php */ |
Andrey Andreev | f944d3b | 2012-03-20 22:12:55 +0200 | [diff] [blame] | 361 | /* Location: ./system/database/drivers/sqlite3/sqlite3_driver.php */ |