blob: 38febca29ae2c3f8c68fe7b52d9c968f075986b8 [file] [log] [blame]
Derek Allardd2df9bc2007-04-15 17:41:17 +00001<?php if (!defined('BASEPATH')) exit('No direct script access allowed');
2/**
3 * CodeIgniter
4 *
5 * An open source application development framework for PHP 4.3.2 or newer
6 *
7 * @package CodeIgniter
Derek Allard3d879d52008-01-18 19:41:32 +00008 * @author ExpressionEngine Dev Team
Derek Allardd2df9bc2007-04-15 17:41:17 +00009 * @copyright Copyright (c) 2006, EllisLab, Inc.
Derek Jones7a9193a2008-01-21 18:39:20 +000010 * @license http://codeigniter.com/user_guide/license.html
11 * @link http://codeigniter.com
Derek Allardd2df9bc2007-04-15 17:41:17 +000012 * @since Version 1.0
13 * @filesource
14 */
15
16// ------------------------------------------------------------------------
17
18
19
20/**
21 * SQLite Database Adapter Class
22 *
23 * Note: _DB is an extender class that the app controller
24 * creates dynamically based on whether the active record
25 * class is being used or not.
26 *
27 * @package CodeIgniter
28 * @subpackage Drivers
29 * @category Database
Derek Allard3d879d52008-01-18 19:41:32 +000030 * @author ExpressionEngine Dev Team
Derek Jones7a9193a2008-01-21 18:39:20 +000031 * @link http://codeigniter.com/user_guide/database/
Derek Allardd2df9bc2007-04-15 17:41:17 +000032 */
33class CI_DB_sqlite_driver extends CI_DB {
34
35 /**
Derek Allard694b5b82007-12-18 15:58:03 +000036 * The syntax to count rows is slightly different across different
37 * database engines, so this string appears in each driver and is
38 * used for the count_all() and count_all_results() functions.
39 */
Derek Allard39b622d2008-01-16 21:10:09 +000040 var $_count_string = "SELECT COUNT(*) AS ";
Derek Allard6ddb5a12007-12-18 17:22:50 +000041 var $_random_keyword = ' Random()'; // database specific random keyword
Derek Allard694b5b82007-12-18 15:58:03 +000042
43 /**
Derek Allardd2df9bc2007-04-15 17:41:17 +000044 * Non-persistent database connection
45 *
46 * @access private called by the base class
47 * @return resource
48 */
49 function db_connect()
50 {
51 if ( ! $conn_id = @sqlite_open($this->database, 0666, $error))
52 {
53 log_message('error', $error);
54
55 if ($this->db_debug)
56 {
57 $this->display_error($error, '', TRUE);
58 }
59
60 return FALSE;
61 }
62
63 return $conn_id;
64 }
65
66 // --------------------------------------------------------------------
67
68 /**
69 * Persistent database connection
70 *
71 * @access private called by the base class
72 * @return resource
73 */
74 function db_pconnect()
75 {
76 if ( ! $conn_id = @sqlite_popen($this->database, 0666, $error))
77 {
78 log_message('error', $error);
79
80 if ($this->db_debug)
81 {
82 $this->display_error($error, '', TRUE);
83 }
84
85 return FALSE;
86 }
87
88 return $conn_id;
89 }
90
91 // --------------------------------------------------------------------
92
93 /**
94 * Select the database
95 *
96 * @access private called by the base class
97 * @return resource
98 */
99 function db_select()
100 {
101 return TRUE;
102 }
103
104 // --------------------------------------------------------------------
105
106 /**
Derek Allard39b622d2008-01-16 21:10:09 +0000107 * Set client character set
108 *
109 * @access public
110 * @param string
111 * @param string
112 * @return resource
113 */
114 function db_set_charset($charset, $collation)
115 {
116 // TODO - add support if needed
117 return TRUE;
118 }
119
120 // --------------------------------------------------------------------
121
122 /**
Derek Allardd2df9bc2007-04-15 17:41:17 +0000123 * Version number query string
124 *
125 * @access public
126 * @return string
127 */
128 function _version()
129 {
130 return sqlite_libversion();
131 }
132
133 // --------------------------------------------------------------------
134
135 /**
136 * Execute the query
137 *
138 * @access private called by the base class
139 * @param string an SQL query
140 * @return resource
141 */
142 function _execute($sql)
143 {
144 $sql = $this->_prep_query($sql);
145 return @sqlite_query($this->conn_id, $sql);
146 }
147
148 // --------------------------------------------------------------------
149
150 /**
151 * Prep the query
152 *
153 * If needed, each database adapter can prep the query string
154 *
155 * @access private called by execute()
156 * @param string an SQL query
157 * @return string
158 */
159 function _prep_query($sql)
160 {
161 return $sql;
162 }
163
164 // --------------------------------------------------------------------
165
166 /**
167 * Begin Transaction
168 *
169 * @access public
170 * @return bool
171 */
172 function trans_begin($test_mode = FALSE)
173 {
174 if ( ! $this->trans_enabled)
175 {
176 return TRUE;
177 }
178
179 // When transactions are nested we only begin/commit/rollback the outermost ones
180 if ($this->_trans_depth > 0)
181 {
182 return TRUE;
183 }
184
185 // Reset the transaction failure flag.
186 // If the $test_mode flag is set to TRUE transactions will be rolled back
187 // even if the queries produce a successful result.
188 $this->_trans_failure = ($test_mode === TRUE) ? TRUE : FALSE;
189
190 $this->simple_query('BEGIN TRANSACTION');
191 return TRUE;
192 }
193
194 // --------------------------------------------------------------------
195
196 /**
197 * Commit Transaction
198 *
199 * @access public
200 * @return bool
201 */
202 function trans_commit()
203 {
204 if ( ! $this->trans_enabled)
205 {
206 return TRUE;
207 }
208
209 // When transactions are nested we only begin/commit/rollback the outermost ones
210 if ($this->_trans_depth > 0)
211 {
212 return TRUE;
213 }
214
215 $this->simple_query('COMMIT');
216 return TRUE;
217 }
218
219 // --------------------------------------------------------------------
220
221 /**
222 * Rollback Transaction
223 *
224 * @access public
225 * @return bool
226 */
227 function trans_rollback()
228 {
229 if ( ! $this->trans_enabled)
230 {
231 return TRUE;
232 }
233
234 // When transactions are nested we only begin/commit/rollback the outermost ones
235 if ($this->_trans_depth > 0)
236 {
237 return TRUE;
238 }
239
240 $this->simple_query('ROLLBACK');
241 return TRUE;
242 }
243
244 // --------------------------------------------------------------------
245
246 /**
247 * Escape String
248 *
249 * @access public
250 * @param string
251 * @return string
252 */
253 function escape_str($str)
254 {
255 return sqlite_escape_string($str);
256 }
257
258 // --------------------------------------------------------------------
259
260 /**
261 * Affected Rows
262 *
263 * @access public
264 * @return integer
265 */
266 function affected_rows()
267 {
268 return sqlite_changes($this->conn_id);
269 }
270
271 // --------------------------------------------------------------------
272
273 /**
274 * Insert ID
275 *
276 * @access public
277 * @return integer
278 */
279 function insert_id()
280 {
281 return @sqlite_last_insert_rowid($this->conn_id);
282 }
283
284 // --------------------------------------------------------------------
285
286 /**
287 * "Count All" query
288 *
289 * Generates a platform-specific query string that counts all records in
290 * the specified database
291 *
292 * @access public
293 * @param string
294 * @return string
295 */
296 function count_all($table = '')
297 {
298 if ($table == '')
299 return '0';
300
Derek Allardf6cd45c2008-01-18 14:31:51 +0000301 $query = $this->query($this->_count_string . $this->_protect_identifiers('numrows'). " FROM " . $this->_protect_identifiers($this->dbprefix.$table));
Derek Allardd2df9bc2007-04-15 17:41:17 +0000302
303 if ($query->num_rows() == 0)
304 return '0';
305
306 $row = $query->row();
307 return $row->numrows;
308 }
309
310 // --------------------------------------------------------------------
311
312 /**
313 * List table query
314 *
315 * Generates a platform-specific query string so that the table names can be fetched
316 *
317 * @access private
Derek Allard39b622d2008-01-16 21:10:09 +0000318 * @param boolean
Derek Allardd2df9bc2007-04-15 17:41:17 +0000319 * @return string
320 */
Derek Allard39b622d2008-01-16 21:10:09 +0000321 function _list_tables($prefix_limit = FALSE)
Derek Allardd2df9bc2007-04-15 17:41:17 +0000322 {
Derek Allard39b622d2008-01-16 21:10:09 +0000323 $sql = "SELECT name from sqlite_master WHERE type='table'";
324
325 if ($prefix_limit !== FALSE AND $this->dbprefix != '')
326 {
327 $sql .= " AND 'name' LIKE '".$this->dbprefix."%'";
328 }
329 return $sql;
Derek Allardd2df9bc2007-04-15 17:41:17 +0000330 }
331
332 // --------------------------------------------------------------------
333
334 /**
335 * Show column query
336 *
337 * Generates a platform-specific query string so that the column names can be fetched
338 *
339 * @access public
340 * @param string the table name
341 * @return string
342 */
343 function _list_columns($table = '')
344 {
345 // Not supported
346 return FALSE;
347 }
348
349 // --------------------------------------------------------------------
350
351 /**
352 * Field data query
353 *
354 * Generates a platform-specific query so that the column data can be retrieved
355 *
356 * @access public
357 * @param string the table name
358 * @return object
359 */
360 function _field_data($table)
361 {
362 return "SELECT * FROM ".$this->_escape_table($table)." LIMIT 1";
363 }
364
365 // --------------------------------------------------------------------
366
367 /**
368 * The error message string
369 *
370 * @access private
371 * @return string
372 */
373 function _error_message()
374 {
375 return sqlite_error_string(sqlite_last_error($this->conn_id));
376 }
377
378 // --------------------------------------------------------------------
379
380 /**
381 * The error message number
382 *
383 * @access private
384 * @return integer
385 */
386 function _error_number()
387 {
388 return sqlite_last_error($this->conn_id);
389 }
390
391 // --------------------------------------------------------------------
392
393 /**
394 * Escape Table Name
395 *
396 * This function adds backticks if the table name has a period
397 * in it. Some DBs will get cranky unless periods are escaped
398 *
399 * @access private
400 * @param string the table name
401 * @return string
402 */
403 function _escape_table($table)
404 {
405 if (stristr($table, '.'))
406 {
407 $table = preg_replace("/\./", "`.`", $table);
408 }
409
410 return $table;
411 }
412
413 // --------------------------------------------------------------------
414
415 /**
Derek Allard39b622d2008-01-16 21:10:09 +0000416 * Protect Identifiers
417 *
418 * This function adds backticks if appropriate based on db type
419 *
420 * @access private
421 * @param mixed the item to escape
422 * @param boolean only affect the first word
423 * @return mixed the item with backticks
424 */
425 function _protect_identifiers($item, $first_word_only = FALSE)
426 {
427 if (is_array($item))
428 {
429 $escaped_array = array();
430
431 foreach($item as $k=>$v)
432 {
433 $escaped_array[$this->_protect_identifiers($k)] = $this->_protect_identifiers($v, $first_word_only);
434 }
435
436 return $escaped_array;
437 }
438
439 // This function may get "item1 item2" as a string, and so
440 // we may need "`item1` `item2`" and not "`item1 item2`"
Derek Allard61579382008-01-16 22:22:42 +0000441 if (ctype_alnum($item) === FALSE)
Derek Allard39b622d2008-01-16 21:10:09 +0000442 {
443 // This function may get "field >= 1", and need it to return "`field` >= 1"
Derek Allard61579382008-01-16 22:22:42 +0000444 $lbound = ($first_word_only === TRUE) ? '' : '|\s|\(';
Derek Allard39b622d2008-01-16 21:10:09 +0000445
Derek Allard61579382008-01-16 22:22:42 +0000446 $item = preg_replace('/(^'.$lbound.')([\w\d\-\_]+?)(\s|\)|$)/iS', '$1`$2`$3', $item);
447 }
448 else
449 {
450 return "`{$item}`";
Derek Allard39b622d2008-01-16 21:10:09 +0000451 }
452
453 $exceptions = array('AS', '/', '-', '%', '+', '*');
454
455 foreach ($exceptions as $exception)
456 {
Derek Allard61579382008-01-16 22:22:42 +0000457
Derek Allard39b622d2008-01-16 21:10:09 +0000458 if (stristr($item, " `{$exception}` ") !== FALSE)
459 {
460 $item = preg_replace('/ `('.preg_quote($exception).')` /i', ' $1 ', $item);
461 }
462 }
Derek Allard39b622d2008-01-16 21:10:09 +0000463 return $item;
464 }
465
466 // --------------------------------------------------------------------
467
468 /**
Derek Jonesc6ad0232008-01-29 18:44:54 +0000469 * From Tables
470 *
471 * This function implicitly groups FROM tables so there is no confusion
472 * about operator precedence in harmony with SQL standards
473 *
474 * @access public
475 * @param type
476 * @return type
477 */
478 function _from_tables($tables)
479 {
480 if (! is_array($tables))
481 {
482 $tables = array($tables);
483 }
484
485 return '('.implode(', ', $tables).')';
486 }
487
488 // --------------------------------------------------------------------
489
490 /**
Derek Allardd2df9bc2007-04-15 17:41:17 +0000491 * Insert statement
492 *
493 * Generates a platform-specific insert string from the supplied data
494 *
495 * @access public
496 * @param string the table name
497 * @param array the insert keys
498 * @param array the insert values
499 * @return string
500 */
501 function _insert($table, $keys, $values)
502 {
503 return "INSERT INTO ".$this->_escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
504 }
505
506 // --------------------------------------------------------------------
507
508 /**
509 * Update statement
510 *
511 * Generates a platform-specific update string from the supplied data
512 *
513 * @access public
514 * @param string the table name
515 * @param array the update data
516 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000517 * @param array the orderby clause
518 * @param array the limit clause
Derek Allardd2df9bc2007-04-15 17:41:17 +0000519 * @return string
520 */
Derek Allard39b622d2008-01-16 21:10:09 +0000521 function _update($table, $values, $where, $orderby = array(), $limit = FALSE)
Derek Allardd2df9bc2007-04-15 17:41:17 +0000522 {
523 foreach($values as $key => $val)
524 {
525 $valstr[] = $key." = ".$val;
526 }
Derek Allardda6d2402007-12-19 14:49:29 +0000527
528 $limit = (!$limit) ? '' : ' LIMIT '.$limit;
Derek Allard39b622d2008-01-16 21:10:09 +0000529
530 $orderby = (count($orderby) >= 1)?' ORDER BY '.implode(", ", $orderby):'';
Derek Allardd2df9bc2007-04-15 17:41:17 +0000531
Derek Allard39b622d2008-01-16 21:10:09 +0000532 return "UPDATE ".$this->_escape_table($table)." SET ".implode(', ', $valstr)." WHERE ".implode(" ", $where).$orderby.$limit;
533 }
534
535
536 // --------------------------------------------------------------------
537
538 /**
539 * Truncate statement
540 *
541 * Generates a platform-specific truncate string from the supplied data
542 * If the database does not support the truncate() command
543 * This function maps to "DELETE FROM table"
544 *
545 * @access public
546 * @param string the table name
547 * @return string
548 */
549 function _truncate($table)
550 {
551 return $this->_delete($table);
Derek Allardd2df9bc2007-04-15 17:41:17 +0000552 }
553
554 // --------------------------------------------------------------------
555
556 /**
557 * Delete statement
558 *
559 * Generates a platform-specific delete string from the supplied data
560 *
561 * @access public
562 * @param string the table name
563 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000564 * @param string the limit clause
Derek Allardd2df9bc2007-04-15 17:41:17 +0000565 * @return string
566 */
Derek Allard39b622d2008-01-16 21:10:09 +0000567 function _delete($table, $where = array(), $like = array(), $limit = FALSE)
Derek Allardd2df9bc2007-04-15 17:41:17 +0000568 {
Derek Allard39b622d2008-01-16 21:10:09 +0000569 $conditions = '';
570
571 if (count($where) > 0 || count($like) > 0)
572 {
573 $conditions = "\nWHERE ";
574 $conditions .= implode("\n", $this->ar_where);
575
576 if (count($where) > 0 && count($like) > 0)
577 {
578 $conditions .= " AND ";
579 }
580 $conditions .= implode("\n", $like);
581 }
582
Derek Allarde77d77c2007-12-19 15:01:55 +0000583 $limit = (!$limit) ? '' : ' LIMIT '.$limit;
584
Derek Allard39b622d2008-01-16 21:10:09 +0000585 return "DELETE FROM ".$table.$conditions.$limit;
Derek Allardd2df9bc2007-04-15 17:41:17 +0000586 }
Derek Allard39b622d2008-01-16 21:10:09 +0000587
Derek Allardd2df9bc2007-04-15 17:41:17 +0000588 // --------------------------------------------------------------------
589
590 /**
591 * Limit string
592 *
593 * Generates a platform-specific LIMIT clause
594 *
595 * @access public
596 * @param string the sql query string
597 * @param integer the number of rows to limit the query to
598 * @param integer the offset value
599 * @return string
600 */
601 function _limit($sql, $limit, $offset)
602 {
603 if ($offset == 0)
604 {
605 $offset = '';
606 }
607 else
608 {
609 $offset .= ", ";
610 }
611
612 return $sql."LIMIT ".$offset.$limit;
613 }
614
615 // --------------------------------------------------------------------
616
617 /**
618 * Close DB Connection
619 *
620 * @access public
621 * @param resource
622 * @return void
623 */
624 function _close($conn_id)
625 {
626 @sqlite_close($conn_id);
627 }
628
629
630}
631
admin46537622006-09-24 18:13:49 +0000632?>