blob: 1fece5cf7a9b7925b885da0cac5a338b4b662bf8 [file] [log] [blame]
Andrey Andreev4c202602012-03-06 20:34:52 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreev4c202602012-03-06 20:34:52 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev4c202602012-03-06 20:34:52 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
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 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
27
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * Database Driver Class
30 *
31 * This is the platform-independent base DB implementation class.
32 * This class will not be called directly. Rather, the adapter
33 * class for the specific database will extend and instantiate it.
34 *
35 * @package CodeIgniter
36 * @subpackage Drivers
37 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050038 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000039 * @link http://codeigniter.com/user_guide/database/
40 */
Timothy Warren7eeda532012-03-19 16:01:55 -040041abstract class CI_DB_driver {
Derek Allard2067d1a2008-11-13 22:59:24 +000042
Andrey Andreev738f5342012-03-06 20:43:40 +020043 public $dsn;
Andrey Andreevd1add432012-03-06 20:26:01 +020044 public $username;
45 public $password;
46 public $hostname;
47 public $database;
48 public $dbdriver = 'mysql';
49 public $dbprefix = '';
50 public $char_set = 'utf8';
51 public $dbcollat = 'utf8_general_ci';
52 public $autoinit = TRUE; // Whether to automatically initialize the DB
53 public $swap_pre = '';
54 public $port = '';
55 public $pconnect = FALSE;
56 public $conn_id = FALSE;
57 public $result_id = FALSE;
58 public $db_debug = FALSE;
59 public $benchmark = 0;
60 public $query_count = 0;
61 public $bind_marker = '?';
62 public $save_queries = TRUE;
63 public $queries = array();
64 public $query_times = array();
65 public $data_cache = array();
Derek Allard2067d1a2008-11-13 22:59:24 +000066
Andrey Andreevd1add432012-03-06 20:26:01 +020067 public $trans_enabled = TRUE;
68 public $trans_strict = TRUE;
69 protected $_trans_depth = 0;
70 protected $_trans_status = TRUE; // Used with transactions to determine if a rollback should occur
Derek Allard2067d1a2008-11-13 22:59:24 +000071
Andrey Andreevd1add432012-03-06 20:26:01 +020072 public $cache_on = FALSE;
73 public $cachedir = '';
74 public $cache_autodel = FALSE;
75 public $CACHE; // The cache class object
Barry Mienydd671972010-10-04 16:33:58 +020076
Jamie Rumbelowbcee50f2012-03-08 13:00:15 +000077 protected $_protect_identifiers = TRUE;
Andrey Andreevd1add432012-03-06 20:26:01 +020078 protected $_reserved_identifiers = array('*'); // Identifiers that should NOT be escaped
79
Timothy Warrene45518d2012-03-06 07:38:00 -050080 public function __construct($params)
Derek Allard2067d1a2008-11-13 22:59:24 +000081 {
82 if (is_array($params))
83 {
84 foreach ($params as $key => $val)
85 {
86 $this->$key = $val;
87 }
88 }
89
90 log_message('debug', 'Database Driver Class Initialized');
91 }
Barry Mienydd671972010-10-04 16:33:58 +020092
Gints Murans89f77ee2012-05-23 00:23:50 +030093 // --------------------------------------------------------------------
Root36237d82012-05-21 18:30:00 -040094
Derek Allard2067d1a2008-11-13 22:59:24 +000095 /**
96 * Initialize Database Settings
97 *
Andrey Andreev82e8ac12012-02-22 19:35:34 +020098 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +020099 */
Andrey Andreev82e8ac12012-02-22 19:35:34 +0200100 public function initialize()
Derek Allard2067d1a2008-11-13 22:59:24 +0000101 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200102 /* If an established connection is available, then there's
103 * no need to connect and select the database.
104 *
105 * Depending on the database driver, conn_id can be either
106 * boolean TRUE, a resource or an object.
107 */
108 if ($this->conn_id)
Derek Allard2067d1a2008-11-13 22:59:24 +0000109 {
110 return TRUE;
111 }
Barry Mienydd671972010-10-04 16:33:58 +0200112
Derek Allard2067d1a2008-11-13 22:59:24 +0000113 // ----------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200114
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 // Connect to the database and set the connection ID
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100116 $this->conn_id = ($this->pconnect === FALSE) ? $this->db_connect() : $this->db_pconnect();
Derek Allard2067d1a2008-11-13 22:59:24 +0000117
Andrey Andreev82e8ac12012-02-22 19:35:34 +0200118 // No connection resource? Check if there is a failover else throw an error
Derek Allard2067d1a2008-11-13 22:59:24 +0000119 if ( ! $this->conn_id)
120 {
Felix Balfoort5d581b62011-11-29 15:53:01 +0100121 // Check if there is a failover set
122 if ( ! empty($this->failover) && is_array($this->failover))
Derek Allard2067d1a2008-11-13 22:59:24 +0000123 {
Felix Balfoort5d581b62011-11-29 15:53:01 +0100124 // Go over all the failovers
125 foreach ($this->failover as $failover)
126 {
127 // Replace the current settings with those of the failover
128 foreach ($failover as $key => $val)
129 {
130 $this->$key = $val;
131 }
132
133 // Try to connect
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100134 $this->conn_id = ($this->pconnect === FALSE) ? $this->db_connect() : $this->db_pconnect();
Felix Balfoort5d581b62011-11-29 15:53:01 +0100135
136 // If a connection is made break the foreach loop
137 if ($this->conn_id)
138 {
139 break;
140 }
141 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000142 }
Felix Balfoort5d581b62011-11-29 15:53:01 +0100143
144 // We still don't have a connection?
145 if ( ! $this->conn_id)
146 {
147 log_message('error', 'Unable to connect to the database');
148
149 if ($this->db_debug)
150 {
151 $this->display_error('db_unable_to_connect');
152 }
153 return FALSE;
154 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000155 }
156
157 // ----------------------------------------------------------------
158
159 // Select the DB... assuming a database name is specified in the config file
Andrey Andreev82e8ac12012-02-22 19:35:34 +0200160 if ($this->database !== '' && ! $this->db_select())
Derek Allard2067d1a2008-11-13 22:59:24 +0000161 {
Andrey Andreev82e8ac12012-02-22 19:35:34 +0200162 log_message('error', 'Unable to select database: '.$this->database);
Barry Mienydd671972010-10-04 16:33:58 +0200163
Andrey Andreev82e8ac12012-02-22 19:35:34 +0200164 if ($this->db_debug)
Derek Allard2067d1a2008-11-13 22:59:24 +0000165 {
Andrey Andreev82e8ac12012-02-22 19:35:34 +0200166 $this->display_error('db_unable_to_select', $this->database);
Derek Allard2067d1a2008-11-13 22:59:24 +0000167 }
Andrey Andreev82e8ac12012-02-22 19:35:34 +0200168 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000169 }
170
Andrey Andreev82e8ac12012-02-22 19:35:34 +0200171 // Now we set the character set and that's all
Andrey Andreev95bd1d12012-03-12 16:22:28 +0200172 return $this->db_set_charset($this->char_set);
Derek Allard2067d1a2008-11-13 22:59:24 +0000173 }
Barry Mienydd671972010-10-04 16:33:58 +0200174
Derek Allard2067d1a2008-11-13 22:59:24 +0000175 // --------------------------------------------------------------------
176
177 /**
Andrey Andreev2cae1932012-03-23 16:08:41 +0200178 * Reconnect
179 *
180 * Keep / reestablish the db connection if no queries have been
181 * sent for a length of time exceeding the server's idle timeout.
182 *
183 * This is just a dummy method to allow drivers without such
184 * functionality to not declare it, while others will override it.
185 *
186 * @return void
187 */
188 public function reconnect()
189 {
190 }
191
192 // --------------------------------------------------------------------
193
194 /**
Andrey Andreevbee66442012-03-28 15:28:19 +0300195 * Select database
196 *
197 * This is just a dummy method to allow drivers without such
198 * functionality to not declare it, while others will override it.
199 *
200 * @return bool
201 */
202 public function db_select()
203 {
204 return TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000205 }
206
207 // --------------------------------------------------------------------
208
209 /**
210 * Set client character set
211 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000212 * @param string
Andrey Andreev063f5962012-02-27 12:20:52 +0200213 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000214 */
Andrey Andreev95bd1d12012-03-12 16:22:28 +0200215 public function db_set_charset($charset)
Derek Allard2067d1a2008-11-13 22:59:24 +0000216 {
Andrey Andreev95bd1d12012-03-12 16:22:28 +0200217 if (method_exists($this, '_db_set_charset') && ! $this->_db_set_charset($charset))
Derek Allard2067d1a2008-11-13 22:59:24 +0000218 {
Andrey Andreev063f5962012-02-27 12:20:52 +0200219 log_message('error', 'Unable to set database connection charset: '.$charset);
Barry Mienydd671972010-10-04 16:33:58 +0200220
Derek Allard2067d1a2008-11-13 22:59:24 +0000221 if ($this->db_debug)
222 {
Andrey Andreev063f5962012-02-27 12:20:52 +0200223 $this->display_error('db_unable_to_set_charset', $charset);
Derek Allard2067d1a2008-11-13 22:59:24 +0000224 }
Barry Mienydd671972010-10-04 16:33:58 +0200225
Derek Allard2067d1a2008-11-13 22:59:24 +0000226 return FALSE;
227 }
Barry Mienydd671972010-10-04 16:33:58 +0200228
Derek Allard2067d1a2008-11-13 22:59:24 +0000229 return TRUE;
230 }
Barry Mienydd671972010-10-04 16:33:58 +0200231
Derek Allard2067d1a2008-11-13 22:59:24 +0000232 // --------------------------------------------------------------------
233
234 /**
235 * The name of the platform in use (mysql, mssql, etc...)
236 *
Barry Mienydd671972010-10-04 16:33:58 +0200237 * @return string
238 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500239 public function platform()
Derek Allard2067d1a2008-11-13 22:59:24 +0000240 {
241 return $this->dbdriver;
242 }
243
244 // --------------------------------------------------------------------
245
246 /**
Andrey Andreev08856b82012-03-03 03:19:28 +0200247 * Database version number
Derek Allard2067d1a2008-11-13 22:59:24 +0000248 *
Andrey Andreev08856b82012-03-03 03:19:28 +0200249 * Returns a string containing the version of the database being used.
250 * Most drivers will override this method.
251 *
Barry Mienydd671972010-10-04 16:33:58 +0200252 * @return string
253 */
Andrey Andreev08856b82012-03-03 03:19:28 +0200254 public function version()
Derek Allard2067d1a2008-11-13 22:59:24 +0000255 {
Andrey Andreev08856b82012-03-03 03:19:28 +0200256 if (isset($this->data_cache['version']))
257 {
258 return $this->data_cache['version'];
259 }
260
Derek Allard2067d1a2008-11-13 22:59:24 +0000261 if (FALSE === ($sql = $this->_version()))
262 {
Andrey Andreev08856b82012-03-03 03:19:28 +0200263 return ($this->db_debug) ? $this->display_error('db_unsupported_function') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000264 }
Derek Allard3683f772009-12-16 17:32:33 +0000265
Andrey Andreev08856b82012-03-03 03:19:28 +0200266 $query = $this->query($sql);
267 $query = $query->row();
268 return $this->data_cache['version'] = $query->ver;
269 }
Derek Allard3683f772009-12-16 17:32:33 +0000270
Andrey Andreev08856b82012-03-03 03:19:28 +0200271 // --------------------------------------------------------------------
272
273 /**
274 * Version number query string
275 *
276 * @return string
277 */
278 protected function _version()
279 {
280 return 'SELECT VERSION() AS ver';
Derek Allard2067d1a2008-11-13 22:59:24 +0000281 }
Barry Mienydd671972010-10-04 16:33:58 +0200282
Derek Allard2067d1a2008-11-13 22:59:24 +0000283 // --------------------------------------------------------------------
284
285 /**
286 * Execute the query
287 *
288 * Accepts an SQL string as input and returns a result object upon
Andrey Andreev4c202602012-03-06 20:34:52 +0200289 * successful execution of a "read" type query. Returns boolean TRUE
Derek Allard2067d1a2008-11-13 22:59:24 +0000290 * upon successful execution of a "write" type query. Returns boolean
291 * FALSE upon failure, and if the $db_debug variable is set to TRUE
292 * will raise an error.
293 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000294 * @param string An SQL query string
295 * @param array An array of binding data
Barry Mienydd671972010-10-04 16:33:58 +0200296 * @return mixed
297 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500298 public function query($sql, $binds = FALSE, $return_object = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000299 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100300 if ($sql === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000301 {
Niklas Nilssond2018ee2011-08-30 13:39:42 +0200302 log_message('error', 'Invalid query: '.$sql);
303
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200304 return ($this->db_debug) ? $this->display_error('db_invalid_query') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000305 }
306
307 // Verify table prefix and replace if necessary
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100308 if ($this->dbprefix !== '' && $this->swap_pre !== '' && $this->dbprefix !== $this->swap_pre)
Derek Jonese7792202010-03-02 17:24:46 -0600309 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200310 $sql = preg_replace('/(\W)'.$this->swap_pre.'(\S+?)/', '\\1'.$this->dbprefix.'\\2', $sql);
Derek Allard2067d1a2008-11-13 22:59:24 +0000311 }
Derek Jonese7792202010-03-02 17:24:46 -0600312
Ryan Dialef7474c2012-03-01 16:11:36 -0500313 // Compile binds if needed
314 if ($binds !== FALSE)
315 {
316 $sql = $this->compile_binds($sql, $binds);
317 }
318
Andrey Andreev4c202602012-03-06 20:34:52 +0200319 // Is query caching enabled? If the query is a "read type"
Derek Allard2067d1a2008-11-13 22:59:24 +0000320 // we will load the caching class and return the previously
321 // cached query if it exists
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100322 if ($this->cache_on === TRUE && stripos($sql, 'SELECT') !== FALSE && $this->_cache_init())
Derek Allard2067d1a2008-11-13 22:59:24 +0000323 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200324 $this->load_rdriver();
325 if (FALSE !== ($cache = $this->CACHE->read($sql)))
Derek Allard2067d1a2008-11-13 22:59:24 +0000326 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200327 return $cache;
Derek Allard2067d1a2008-11-13 22:59:24 +0000328 }
329 }
Barry Mienydd671972010-10-04 16:33:58 +0200330
Derek Jones37f4b9c2011-07-01 17:56:50 -0500331 // Save the query for debugging
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100332 if ($this->save_queries === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000333 {
334 $this->queries[] = $sql;
335 }
Barry Mienydd671972010-10-04 16:33:58 +0200336
Derek Allard2067d1a2008-11-13 22:59:24 +0000337 // Start the Query Timer
dixyab3cab52012-04-21 00:58:00 +0200338 $time_start = microtime(TRUE);
Barry Mienydd671972010-10-04 16:33:58 +0200339
Derek Allard2067d1a2008-11-13 22:59:24 +0000340 // Run the Query
341 if (FALSE === ($this->result_id = $this->simple_query($sql)))
342 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100343 if ($this->save_queries === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000344 {
345 $this->query_times[] = 0;
346 }
Barry Mienydd671972010-10-04 16:33:58 +0200347
Derek Allard2067d1a2008-11-13 22:59:24 +0000348 // This will trigger a rollback if transactions are being used
349 $this->_trans_status = FALSE;
350
Andrey Andreev4be5de12012-03-02 15:45:41 +0200351 // Grab the error now, as we might run some additional queries before displaying the error
352 $error = $this->error();
Niklas Nilssond2018ee2011-08-30 13:39:42 +0200353
354 // Log errors
Andrey Andreev4be5de12012-03-02 15:45:41 +0200355 log_message('error', 'Query error: '.$error['message']);
Niklas Nilssond2018ee2011-08-30 13:39:42 +0200356
Derek Allard2067d1a2008-11-13 22:59:24 +0000357 if ($this->db_debug)
358 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000359 // We call this function in order to roll-back queries
Andrey Andreev4be5de12012-03-02 15:45:41 +0200360 // if transactions are enabled. If we don't call this here
Barry Mienydd671972010-10-04 16:33:58 +0200361 // the error message will trigger an exit, causing the
Derek Allard2067d1a2008-11-13 22:59:24 +0000362 // transactions to remain in limbo.
363 $this->trans_complete();
364
Niklas Nilssond2018ee2011-08-30 13:39:42 +0200365 // Display errors
Andrey Andreev27984582012-03-03 04:43:10 +0200366 return $this->display_error(array('Error Number: '.$error['code'], $error['message'], $sql));
Derek Allard2067d1a2008-11-13 22:59:24 +0000367 }
Barry Mienydd671972010-10-04 16:33:58 +0200368
Derek Allard2067d1a2008-11-13 22:59:24 +0000369 return FALSE;
370 }
Barry Mienydd671972010-10-04 16:33:58 +0200371
Derek Allard2067d1a2008-11-13 22:59:24 +0000372 // Stop and aggregate the query time results
dixyab3cab52012-04-21 00:58:00 +0200373 $time_end = microtime(TRUE);
374 $this->benchmark += $time_end - $time_start;
Derek Allard2067d1a2008-11-13 22:59:24 +0000375
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100376 if ($this->save_queries === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000377 {
dixyab3cab52012-04-21 00:58:00 +0200378 $this->query_times[] = $time_end - $time_start;
Derek Allard2067d1a2008-11-13 22:59:24 +0000379 }
Barry Mienydd671972010-10-04 16:33:58 +0200380
Derek Allard2067d1a2008-11-13 22:59:24 +0000381 // Increment the query counter
382 $this->query_count++;
Barry Mienydd671972010-10-04 16:33:58 +0200383
Derek Allard2067d1a2008-11-13 22:59:24 +0000384 // Was the query a "write" type?
385 // If so we'll simply return true
386 if ($this->is_write_type($sql) === TRUE)
387 {
388 // If caching is enabled we'll auto-cleanup any
389 // existing files related to this particular URI
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100390 if ($this->cache_on === TRUE && $this->cache_autodel === TRUE && $this->_cache_init())
Derek Allard2067d1a2008-11-13 22:59:24 +0000391 {
392 $this->CACHE->delete();
393 }
Barry Mienydd671972010-10-04 16:33:58 +0200394
Derek Allard2067d1a2008-11-13 22:59:24 +0000395 return TRUE;
396 }
Barry Mienydd671972010-10-04 16:33:58 +0200397
Derek Allard2067d1a2008-11-13 22:59:24 +0000398 // Return TRUE if we don't need to create a result object
399 // Currently only the Oracle driver uses this when stored
400 // procedures are used
401 if ($return_object !== TRUE)
402 {
403 return TRUE;
404 }
Barry Mienydd671972010-10-04 16:33:58 +0200405
406 // Load and instantiate the result driver
Andrey Andreev57bdeb62012-03-05 15:59:16 +0200407 $driver = $this->load_rdriver();
408 $RES = new $driver($this);
Barry Mienydd671972010-10-04 16:33:58 +0200409
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200410 // Is query caching enabled? If so, we'll serialize the
Derek Allard2067d1a2008-11-13 22:59:24 +0000411 // result object and save it to a cache file.
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100412 if ($this->cache_on === TRUE && $this->_cache_init())
Derek Allard2067d1a2008-11-13 22:59:24 +0000413 {
414 // We'll create a new instance of the result object
415 // only without the platform specific driver since
416 // we can't use it with cached data (the query result
417 // resource ID won't be any good once we've cached the
418 // result object, so we'll have to compile the data
419 // and save it)
420 $CR = new CI_DB_result();
Derek Allard2067d1a2008-11-13 22:59:24 +0000421 $CR->result_object = $RES->result_object();
422 $CR->result_array = $RES->result_array();
Andrey Andreev24abcb92012-01-05 20:40:15 +0200423 $CR->num_rows = $RES->num_rows();
Barry Mienydd671972010-10-04 16:33:58 +0200424
Derek Allard2067d1a2008-11-13 22:59:24 +0000425 // Reset these since cached objects can not utilize resource IDs.
426 $CR->conn_id = NULL;
427 $CR->result_id = NULL;
428
429 $this->CACHE->write($sql, $CR);
430 }
Barry Mienydd671972010-10-04 16:33:58 +0200431
Derek Allard2067d1a2008-11-13 22:59:24 +0000432 return $RES;
433 }
434
435 // --------------------------------------------------------------------
436
437 /**
438 * Load the result drivers
439 *
Barry Mienydd671972010-10-04 16:33:58 +0200440 * @return string the name of the result class
441 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500442 public function load_rdriver()
Derek Allard2067d1a2008-11-13 22:59:24 +0000443 {
444 $driver = 'CI_DB_'.$this->dbdriver.'_result';
445
446 if ( ! class_exists($driver))
447 {
Greg Aker3a746652011-04-19 10:59:47 -0500448 include_once(BASEPATH.'database/DB_result.php');
449 include_once(BASEPATH.'database/drivers/'.$this->dbdriver.'/'.$this->dbdriver.'_result.php');
Derek Allard2067d1a2008-11-13 22:59:24 +0000450 }
Barry Mienydd671972010-10-04 16:33:58 +0200451
Derek Allard2067d1a2008-11-13 22:59:24 +0000452 return $driver;
453 }
Barry Mienydd671972010-10-04 16:33:58 +0200454
Derek Allard2067d1a2008-11-13 22:59:24 +0000455 // --------------------------------------------------------------------
456
457 /**
458 * Simple Query
Andrey Andreev4c202602012-03-06 20:34:52 +0200459 * This is a simplified version of the query() function. Internally
Derek Allard2067d1a2008-11-13 22:59:24 +0000460 * we only use it when running transaction commands since they do
461 * not require all the features of the main query() function.
462 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000463 * @param string the sql query
Barry Mienydd671972010-10-04 16:33:58 +0200464 * @return mixed
465 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500466 public function simple_query($sql)
Derek Allard2067d1a2008-11-13 22:59:24 +0000467 {
468 if ( ! $this->conn_id)
469 {
470 $this->initialize();
471 }
472
473 return $this->_execute($sql);
474 }
Barry Mienydd671972010-10-04 16:33:58 +0200475
Derek Allard2067d1a2008-11-13 22:59:24 +0000476 // --------------------------------------------------------------------
477
478 /**
479 * Disable Transactions
480 * This permits transactions to be disabled at run-time.
481 *
Barry Mienydd671972010-10-04 16:33:58 +0200482 * @return void
483 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500484 public function trans_off()
Derek Allard2067d1a2008-11-13 22:59:24 +0000485 {
486 $this->trans_enabled = FALSE;
487 }
488
489 // --------------------------------------------------------------------
490
491 /**
492 * Enable/disable Transaction Strict Mode
493 * When strict mode is enabled, if you are running multiple groups of
494 * transactions, if one group fails all groups will be rolled back.
495 * If strict mode is disabled, each group is treated autonomously, meaning
496 * a failure of one group will not affect any others
497 *
Barry Mienydd671972010-10-04 16:33:58 +0200498 * @return void
499 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500500 public function trans_strict($mode = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000501 {
502 $this->trans_strict = is_bool($mode) ? $mode : TRUE;
503 }
Barry Mienydd671972010-10-04 16:33:58 +0200504
Derek Allard2067d1a2008-11-13 22:59:24 +0000505 // --------------------------------------------------------------------
506
507 /**
508 * Start Transaction
509 *
Barry Mienydd671972010-10-04 16:33:58 +0200510 * @return void
511 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500512 public function trans_start($test_mode = FALSE)
Barry Mienydd671972010-10-04 16:33:58 +0200513 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000514 if ( ! $this->trans_enabled)
515 {
516 return FALSE;
517 }
518
519 // When transactions are nested we only begin/commit/rollback the outermost ones
520 if ($this->_trans_depth > 0)
521 {
522 $this->_trans_depth += 1;
523 return;
524 }
Barry Mienydd671972010-10-04 16:33:58 +0200525
Derek Allard2067d1a2008-11-13 22:59:24 +0000526 $this->trans_begin($test_mode);
Jacob Terry07fcedf2011-11-22 11:21:36 -0500527 $this->_trans_depth += 1;
Derek Allard2067d1a2008-11-13 22:59:24 +0000528 }
529
530 // --------------------------------------------------------------------
531
532 /**
533 * Complete Transaction
534 *
Barry Mienydd671972010-10-04 16:33:58 +0200535 * @return bool
536 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500537 public function trans_complete()
Derek Allard2067d1a2008-11-13 22:59:24 +0000538 {
539 if ( ! $this->trans_enabled)
540 {
541 return FALSE;
542 }
Barry Mienydd671972010-10-04 16:33:58 +0200543
Derek Allard2067d1a2008-11-13 22:59:24 +0000544 // When transactions are nested we only begin/commit/rollback the outermost ones
545 if ($this->_trans_depth > 1)
546 {
547 $this->_trans_depth -= 1;
548 return TRUE;
549 }
Jacob Terry07fcedf2011-11-22 11:21:36 -0500550 else
551 {
552 $this->_trans_depth = 0;
553 }
Barry Mienydd671972010-10-04 16:33:58 +0200554
Derek Allard2067d1a2008-11-13 22:59:24 +0000555 // The query() function will set this flag to FALSE in the event that a query failed
556 if ($this->_trans_status === FALSE)
557 {
558 $this->trans_rollback();
Barry Mienydd671972010-10-04 16:33:58 +0200559
Derek Allard2067d1a2008-11-13 22:59:24 +0000560 // If we are NOT running in strict mode, we will reset
561 // the _trans_status flag so that subsequent groups of transactions
562 // will be permitted.
563 if ($this->trans_strict === FALSE)
564 {
565 $this->_trans_status = TRUE;
566 }
567
568 log_message('debug', 'DB Transaction Failure');
569 return FALSE;
570 }
Barry Mienydd671972010-10-04 16:33:58 +0200571
Derek Allard2067d1a2008-11-13 22:59:24 +0000572 $this->trans_commit();
573 return TRUE;
574 }
575
576 // --------------------------------------------------------------------
577
578 /**
579 * Lets you retrieve the transaction flag to determine if it has failed
580 *
Barry Mienydd671972010-10-04 16:33:58 +0200581 * @return bool
582 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500583 public function trans_status()
Derek Allard2067d1a2008-11-13 22:59:24 +0000584 {
585 return $this->_trans_status;
586 }
587
588 // --------------------------------------------------------------------
589
590 /**
591 * Compile Bindings
592 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000593 * @param string the sql statement
594 * @param array an array of bind data
Barry Mienydd671972010-10-04 16:33:58 +0200595 * @return string
596 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500597 public function compile_binds($sql, $binds)
Derek Allard2067d1a2008-11-13 22:59:24 +0000598 {
Andrey Andreev10cbdf02012-06-13 13:32:30 +0300599 if (empty($binds) OR empty($this->bind_marker) OR strpos($sql, $this->bind_marker) === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000600 {
601 return $sql;
602 }
Andrey Andreev4e9538f2012-06-12 14:16:53 +0300603 elseif ( ! is_array($binds))
Derek Allard2067d1a2008-11-13 22:59:24 +0000604 {
Andrey Andreev10cbdf02012-06-13 13:32:30 +0300605 $binds = array($this->escape($binds));
606 $bind_count = 1;
Derek Allard2067d1a2008-11-13 22:59:24 +0000607 }
Andrey Andreev4e9538f2012-06-12 14:16:53 +0300608 else
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200609 {
Andrey Andreev4e9538f2012-06-12 14:16:53 +0300610 // Make sure we're using numeric keys
611 $binds = array_values($binds);
Andrey Andreev10cbdf02012-06-13 13:32:30 +0300612 $bind_count = count($binds);
613
614 // Escape the bind values
615 for ($i = 0; $i < $bind_count; $i++)
616 {
617 $binds[$i] = $this->escape($binds[$i]);
618 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000619 }
620
Andrey Andreev10cbdf02012-06-13 13:32:30 +0300621 // Make sure not to replace a chunk inside a string that happens to match the bind marker
622 if ($c = preg_match_all("/'[^']*'/i", $sql, $matches))
Derek Allard2067d1a2008-11-13 22:59:24 +0000623 {
Andrey Andreev10cbdf02012-06-13 13:32:30 +0300624 $ml = strlen($this->bind_marker);
625 $c = preg_match_all('/'.preg_quote($this->bind_marker).'/i',
626 str_replace($matches[0],
627 str_replace($this->bind_marker, str_repeat(' ', $ml), $matches[0]),
628 $sql, $c),
629 $matches, PREG_OFFSET_CAPTURE);
630
631 // Bind values' count must match the count of markers in the query
632 if ($bind_count !== $c)
633 {
634 return $sql;
635 }
636
637 do
638 {
639 $c--;
640 $sql = substr_replace($sql, $binds[$c], $matches[0][$c][1], $ml);
641 }
642 while ($c !== 0);
643 }
644 elseif (substr_count($sql, $this->bind_marker) === count($binds))
645 {
646 return str_replace($this->bind_marker, $binds, $sql, $bind_count);
Derek Allard2067d1a2008-11-13 22:59:24 +0000647 }
648
Andrey Andreev4e9538f2012-06-12 14:16:53 +0300649 return $sql;
Derek Allard2067d1a2008-11-13 22:59:24 +0000650 }
Barry Mienydd671972010-10-04 16:33:58 +0200651
Derek Allard2067d1a2008-11-13 22:59:24 +0000652 // --------------------------------------------------------------------
653
654 /**
655 * Determines if a query is a "write" type.
656 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000657 * @param string An SQL query string
Andrey Andreev67f71a42012-03-01 16:18:42 +0200658 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +0200659 */
Andrey Andreev67f71a42012-03-01 16:18:42 +0200660 public function is_write_type($sql)
Derek Allard2067d1a2008-11-13 22:59:24 +0000661 {
Andrey Andreevb457a402012-04-09 16:11:56 +0300662 return (bool) preg_match('/^\s*"?(SET|INSERT|UPDATE|DELETE|REPLACE|CREATE|DROP|TRUNCATE|LOAD DATA|COPY|ALTER|RENAME|GRANT|REVOKE|LOCK|UNLOCK|REINDEX)\s+/i', $sql);
Derek Allard2067d1a2008-11-13 22:59:24 +0000663 }
Barry Mienydd671972010-10-04 16:33:58 +0200664
Derek Allard2067d1a2008-11-13 22:59:24 +0000665 // --------------------------------------------------------------------
666
667 /**
668 * Calculate the aggregate query elapsed time
669 *
Andrey Andreev4c202602012-03-06 20:34:52 +0200670 * @param int The number of decimal places
671 * @return int
Barry Mienydd671972010-10-04 16:33:58 +0200672 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500673 public function elapsed_time($decimals = 6)
Derek Allard2067d1a2008-11-13 22:59:24 +0000674 {
675 return number_format($this->benchmark, $decimals);
676 }
Barry Mienydd671972010-10-04 16:33:58 +0200677
Derek Allard2067d1a2008-11-13 22:59:24 +0000678 // --------------------------------------------------------------------
679
680 /**
681 * Returns the total number of queries
682 *
Andrey Andreev4c202602012-03-06 20:34:52 +0200683 * @return int
Barry Mienydd671972010-10-04 16:33:58 +0200684 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500685 public function total_queries()
Derek Allard2067d1a2008-11-13 22:59:24 +0000686 {
687 return $this->query_count;
688 }
Barry Mienydd671972010-10-04 16:33:58 +0200689
Derek Allard2067d1a2008-11-13 22:59:24 +0000690 // --------------------------------------------------------------------
691
692 /**
693 * Returns the last query that was executed
694 *
Andrey Andreev4c202602012-03-06 20:34:52 +0200695 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200696 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500697 public function last_query()
Derek Allard2067d1a2008-11-13 22:59:24 +0000698 {
699 return end($this->queries);
700 }
701
702 // --------------------------------------------------------------------
703
704 /**
705 * "Smart" Escape String
706 *
707 * Escapes data based on type
708 * Sets boolean and null types
709 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000710 * @param string
Barry Mienydd671972010-10-04 16:33:58 +0200711 * @return mixed
712 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500713 public function escape($str)
Barry Mienydd671972010-10-04 16:33:58 +0200714 {
Joel Kallman10aa8e62012-03-09 14:54:53 -0500715 if (is_string($str) OR method_exists($str, '__toString'))
Derek Allard2067d1a2008-11-13 22:59:24 +0000716 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200717 return "'".$this->escape_str($str)."'";
Derek Jonesa377bdd2009-02-11 18:55:24 +0000718 }
719 elseif (is_bool($str))
720 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200721 return ($str === FALSE) ? 0 : 1;
Derek Jonesa377bdd2009-02-11 18:55:24 +0000722 }
723 elseif (is_null($str))
724 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200725 return 'NULL';
Derek Jonesa377bdd2009-02-11 18:55:24 +0000726 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000727
728 return $str;
729 }
730
731 // --------------------------------------------------------------------
Derek Jonese7792202010-03-02 17:24:46 -0600732
Derek Jonese4ed5832009-02-20 21:44:59 +0000733 /**
Derek Jonesbdc7fb92009-02-20 21:55:10 +0000734 * Escape LIKE String
Derek Jonese4ed5832009-02-20 21:44:59 +0000735 *
736 * Calls the individual driver for platform
737 * specific escaping for LIKE conditions
Barry Mienydd671972010-10-04 16:33:58 +0200738 *
Derek Jonese4ed5832009-02-20 21:44:59 +0000739 * @param string
740 * @return mixed
741 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500742 public function escape_like_str($str)
Barry Mienydd671972010-10-04 16:33:58 +0200743 {
744 return $this->escape_str($str, TRUE);
Derek Jonese4ed5832009-02-20 21:44:59 +0000745 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000746
Derek Jonese4ed5832009-02-20 21:44:59 +0000747 // --------------------------------------------------------------------
Derek Jonese7792202010-03-02 17:24:46 -0600748
Derek Allard2067d1a2008-11-13 22:59:24 +0000749 /**
750 * Primary
751 *
Andrey Andreev4c202602012-03-06 20:34:52 +0200752 * Retrieves the primary key. It assumes that the row in the first
Derek Allard2067d1a2008-11-13 22:59:24 +0000753 * position is the primary key
754 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000755 * @param string the table name
Barry Mienydd671972010-10-04 16:33:58 +0200756 * @return string
757 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500758 public function primary($table = '')
Barry Mienydd671972010-10-04 16:33:58 +0200759 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000760 $fields = $this->list_fields($table);
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200761 return is_array($fields) ? current($fields) : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000762 }
763
764 // --------------------------------------------------------------------
765
766 /**
Andrey Andreev16bb9bd2012-05-26 18:21:14 +0300767 * "Count All" query
768 *
769 * Generates a platform-specific query string that counts all records in
770 * the specified database
771 *
772 * @param string
773 * @return int
774 */
775 public function count_all($table = '')
776 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100777 if ($table === '')
Andrey Andreev16bb9bd2012-05-26 18:21:14 +0300778 {
779 return 0;
780 }
781
782 $query = $this->query($this->_count_string.$this->escape_identifiers('numrows').' FROM '.$this->protect_identifiers($table, TRUE, NULL, FALSE));
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100783 if ($query->num_rows() === 0)
Andrey Andreev16bb9bd2012-05-26 18:21:14 +0300784 {
785 return 0;
786 }
787
788 $query = $query->row();
789 $this->_reset_select();
790 return (int) $query->numrows;
791 }
792
793 // --------------------------------------------------------------------
794
795 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000796 * Returns an array of table names
797 *
Barry Mienydd671972010-10-04 16:33:58 +0200798 * @return array
799 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500800 public function list_tables($constrain_by_prefix = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000801 {
802 // Is there a cached result?
803 if (isset($this->data_cache['table_names']))
804 {
805 return $this->data_cache['table_names'];
806 }
Barry Mienydd671972010-10-04 16:33:58 +0200807
Derek Allard2067d1a2008-11-13 22:59:24 +0000808 if (FALSE === ($sql = $this->_list_tables($constrain_by_prefix)))
809 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200810 return ($this->db_debug) ? $this->display_error('db_unsupported_function') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000811 }
812
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200813 $this->data_cache['table_names'] = array();
Derek Allard2067d1a2008-11-13 22:59:24 +0000814 $query = $this->query($sql);
Barry Mienydd671972010-10-04 16:33:58 +0200815
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200816 foreach ($query->result_array() as $row)
Derek Allard2067d1a2008-11-13 22:59:24 +0000817 {
Andrey Andreev12567e82012-01-25 22:50:33 +0200818 // Do we know from which column to get the table name?
819 if ( ! isset($key))
Derek Allard2067d1a2008-11-13 22:59:24 +0000820 {
Andrey Andreev6781a5f2012-03-28 14:50:51 +0300821 if (isset($row['table_name']))
Andrey Andreev12567e82012-01-25 22:50:33 +0200822 {
823 $key = 'table_name';
824 }
Andrey Andreev6781a5f2012-03-28 14:50:51 +0300825 elseif (isset($row['TABLE_NAME']))
Andrey Andreev12567e82012-01-25 22:50:33 +0200826 {
827 $key = 'TABLE_NAME';
828 }
829 else
830 {
831 /* We have no other choice but to just get the first element's key.
832 * Due to array_shift() accepting it's argument by reference, if
833 * E_STRICT is on, this would trigger a warning. So we'll have to
834 * assign it first.
835 */
836 $key = array_keys($row);
837 $key = array_shift($key);
838 }
Taufan Aditya18209332012-02-09 16:07:27 +0700839 }
840
Andrey Andreev12567e82012-01-25 22:50:33 +0200841 $this->data_cache['table_names'][] = $row[$key];
Derek Allard2067d1a2008-11-13 22:59:24 +0000842 }
843
Derek Allard2067d1a2008-11-13 22:59:24 +0000844 return $this->data_cache['table_names'];
845 }
Barry Mienydd671972010-10-04 16:33:58 +0200846
Derek Allard2067d1a2008-11-13 22:59:24 +0000847 // --------------------------------------------------------------------
848
849 /**
850 * Determine if a particular table exists
Timothy Warrene45518d2012-03-06 07:38:00 -0500851 *
Andrey Andreev4c202602012-03-06 20:34:52 +0200852 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000853 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500854 public function table_exists($table_name)
Barry Mienydd671972010-10-04 16:33:58 +0200855 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200856 return in_array($this->protect_identifiers($table_name, TRUE, FALSE, FALSE), $this->list_tables());
Derek Allard2067d1a2008-11-13 22:59:24 +0000857 }
Barry Mienydd671972010-10-04 16:33:58 +0200858
Derek Allard2067d1a2008-11-13 22:59:24 +0000859 // --------------------------------------------------------------------
860
861 /**
862 * Fetch MySQL Field Names
863 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000864 * @param string the table name
Barry Mienydd671972010-10-04 16:33:58 +0200865 * @return array
Derek Allard2067d1a2008-11-13 22:59:24 +0000866 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500867 public function list_fields($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000868 {
869 // Is there a cached result?
870 if (isset($this->data_cache['field_names'][$table]))
871 {
872 return $this->data_cache['field_names'][$table];
873 }
Barry Mienydd671972010-10-04 16:33:58 +0200874
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100875 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000876 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200877 return ($this->db_debug) ? $this->display_error('db_field_param_missing') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000878 }
Barry Mienydd671972010-10-04 16:33:58 +0200879
Greg Aker1edde302010-01-26 00:17:01 +0000880 if (FALSE === ($sql = $this->_list_columns($table)))
Derek Allard2067d1a2008-11-13 22:59:24 +0000881 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200882 return ($this->db_debug) ? $this->display_error('db_unsupported_function') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000883 }
Barry Mienydd671972010-10-04 16:33:58 +0200884
Derek Allard2067d1a2008-11-13 22:59:24 +0000885 $query = $this->query($sql);
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200886 $this->data_cache['field_names'][$table] = array();
Barry Mienydd671972010-10-04 16:33:58 +0200887
Pascal Krietec3a4a8d2011-02-14 13:40:08 -0500888 foreach ($query->result_array() as $row)
Derek Allard2067d1a2008-11-13 22:59:24 +0000889 {
Andrey Andreev12567e82012-01-25 22:50:33 +0200890 // Do we know from where to get the column's name?
891 if ( ! isset($key))
Derek Allard2067d1a2008-11-13 22:59:24 +0000892 {
Andrey Andreev6781a5f2012-03-28 14:50:51 +0300893 if (isset($row['column_name']))
Andrey Andreev12567e82012-01-25 22:50:33 +0200894 {
895 $key = 'column_name';
896 }
Andrey Andreev6781a5f2012-03-28 14:50:51 +0300897 elseif (isset($row['COLUMN_NAME']))
Andrey Andreev12567e82012-01-25 22:50:33 +0200898 {
899 $key = 'COLUMN_NAME';
900 }
901 else
902 {
903 /* We have no other choice but to just get the first element's key.
904 * Due to array_shift() accepting it's argument by reference, if
905 * E_STRICT is on, this would trigger a warning. So we'll have to
906 * assign it first.
907 */
908 $key = array_keys($row);
909 $key = array_shift($key);
910 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000911 }
Andrey Andreev12567e82012-01-25 22:50:33 +0200912
913 $this->data_cache['field_names'][$table][] = $row[$key];
Derek Allard2067d1a2008-11-13 22:59:24 +0000914 }
Barry Mienydd671972010-10-04 16:33:58 +0200915
Derek Allard2067d1a2008-11-13 22:59:24 +0000916 return $this->data_cache['field_names'][$table];
917 }
918
919 // --------------------------------------------------------------------
920
921 /**
922 * Determine if a particular field exists
Timothy Warrene45518d2012-03-06 07:38:00 -0500923 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000924 * @param string
925 * @param string
Andrey Andreev4c202602012-03-06 20:34:52 +0200926 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000927 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500928 public function field_exists($field_name, $table_name)
Barry Mienydd671972010-10-04 16:33:58 +0200929 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200930 return in_array($field_name, $this->list_fields($table_name));
Derek Allard2067d1a2008-11-13 22:59:24 +0000931 }
Barry Mienydd671972010-10-04 16:33:58 +0200932
Derek Allard2067d1a2008-11-13 22:59:24 +0000933 // --------------------------------------------------------------------
934
935 /**
936 * Returns an object with field data
937 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000938 * @param string the table name
Barry Mienydd671972010-10-04 16:33:58 +0200939 * @return object
940 */
Timothy Warrene45518d2012-03-06 07:38:00 -0500941 public function field_data($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000942 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100943 if ($table === '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000944 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +0200945 return ($this->db_debug) ? $this->display_error('db_field_param_missing') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000946 }
Barry Mienydd671972010-10-04 16:33:58 +0200947
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200948 $query = $this->query($this->_field_data($this->protect_identifiers($table, TRUE, NULL, FALSE)));
Derek Allard2067d1a2008-11-13 22:59:24 +0000949 return $query->field_data();
Barry Mienydd671972010-10-04 16:33:58 +0200950 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000951
952 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200953
Derek Allard2067d1a2008-11-13 22:59:24 +0000954 /**
Andrey Andreevea09a8a2012-04-06 20:50:07 +0300955 * Escape the SQL Identifiers
956 *
957 * This function escapes column and table names
958 *
Andrey Andreev9637b402012-06-08 15:39:24 +0300959 * @param mixed
960 * @return mixed
Andrey Andreevea09a8a2012-04-06 20:50:07 +0300961 */
962 public function escape_identifiers($item)
963 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100964 if ($this->_escape_char === '')
Andrey Andreevea09a8a2012-04-06 20:50:07 +0300965 {
966 return $item;
967 }
Andrey Andreev9637b402012-06-08 15:39:24 +0300968 elseif (is_array($item))
969 {
970 foreach ($item as $key => $value)
971 {
972 $item[$key] = $this->escape_identifiers($value);
973 }
974
975 return $item;
976 }
Andrey Andreevea09a8a2012-04-06 20:50:07 +0300977
Andrey Andreev082ee2b2012-06-08 15:26:34 +0300978 static $preg_ec = array();
979
980 if (empty($preg_ec))
981 {
982 if (is_array($this->_escape_char))
983 {
984 $preg_ec = array(preg_quote($this->_escape_char[0]), preg_quote($this->_escape_char[1]));
985 }
986 else
987 {
988 $preg_ec[0] = $preg_ec[1] = preg_quote($this->_escape_char);
989 }
990 }
991
Andrey Andreevea09a8a2012-04-06 20:50:07 +0300992 foreach ($this->_reserved_identifiers as $id)
993 {
994 if (strpos($item, '.'.$id) !== FALSE)
995 {
Andrey Andreeva593c692012-06-08 17:50:26 +0300996 return preg_replace('/'.$preg_ec[0].'?([^'.$preg_ec[1].'\.]+)'.$preg_ec[1].'?\./i', $preg_ec[0].'$1'.$preg_ec[1].'.', $item);
Andrey Andreevea09a8a2012-04-06 20:50:07 +0300997 }
998 }
999
Andrey Andreev082ee2b2012-06-08 15:26:34 +03001000 return preg_replace('/'.$preg_ec[0].'?([^'.$preg_ec[1].'\.]+)'.$preg_ec[1].'?(\.)?/i', $preg_ec[0].'$1'.$preg_ec[1].'$2', $item);
Andrey Andreevea09a8a2012-04-06 20:50:07 +03001001 }
1002
1003 // --------------------------------------------------------------------
1004
1005 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001006 * Generate an insert string
1007 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001008 * @param string the table upon which the query will be performed
1009 * @param array an associative array data of key/values
Barry Mienydd671972010-10-04 16:33:58 +02001010 * @return string
1011 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001012 public function insert_string($table, $data)
Derek Allard2067d1a2008-11-13 22:59:24 +00001013 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001014 $fields = $values = array();
Barry Mienydd671972010-10-04 16:33:58 +02001015
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05001016 foreach ($data as $key => $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001017 {
Andrey Andreevea09a8a2012-04-06 20:50:07 +03001018 $fields[] = $this->escape_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +00001019 $values[] = $this->escape($val);
1020 }
Barry Mienydd671972010-10-04 16:33:58 +02001021
Andrey Andreev032e7ea2012-03-06 19:48:35 +02001022 return $this->_insert($this->protect_identifiers($table, TRUE, NULL, FALSE), $fields, $values);
Barry Mienydd671972010-10-04 16:33:58 +02001023 }
1024
Derek Allard2067d1a2008-11-13 22:59:24 +00001025 // --------------------------------------------------------------------
1026
1027 /**
1028 * Generate an update string
1029 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001030 * @param string the table upon which the query will be performed
1031 * @param array an associative array data of key/values
1032 * @param mixed the "where" statement
Barry Mienydd671972010-10-04 16:33:58 +02001033 * @return string
1034 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001035 public function update_string($table, $data, $where)
Derek Allard2067d1a2008-11-13 22:59:24 +00001036 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001037 if ($where === '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001038 {
Andrey Andreev4c202602012-03-06 20:34:52 +02001039 return FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001040 }
Barry Mienydd671972010-10-04 16:33:58 +02001041
Derek Allard2067d1a2008-11-13 22:59:24 +00001042 $fields = array();
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05001043 foreach ($data as $key => $val)
Derek Allard2067d1a2008-11-13 22:59:24 +00001044 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +02001045 $fields[$this->protect_identifiers($key)] = $this->escape($val);
Derek Allard2067d1a2008-11-13 22:59:24 +00001046 }
1047
1048 if ( ! is_array($where))
1049 {
1050 $dest = array($where);
1051 }
1052 else
1053 {
1054 $dest = array();
1055 foreach ($where as $key => $val)
1056 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001057 $prefix = (count($dest) === 0) ? '' : ' AND ';
Andrey Andreev032e7ea2012-03-06 19:48:35 +02001058 $key = $this->protect_identifiers($key);
Barry Mienydd671972010-10-04 16:33:58 +02001059
Derek Allard2067d1a2008-11-13 22:59:24 +00001060 if ($val !== '')
1061 {
1062 if ( ! $this->_has_operator($key))
1063 {
1064 $key .= ' =';
1065 }
Barry Mienydd671972010-10-04 16:33:58 +02001066
Derek Allard2067d1a2008-11-13 22:59:24 +00001067 $val = ' '.$this->escape($val);
1068 }
Barry Mienydd671972010-10-04 16:33:58 +02001069
Derek Allard2067d1a2008-11-13 22:59:24 +00001070 $dest[] = $prefix.$key.$val;
1071 }
Barry Mienydd671972010-10-04 16:33:58 +02001072 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001073
Andrey Andreev032e7ea2012-03-06 19:48:35 +02001074 return $this->_update($this->protect_identifiers($table, TRUE, NULL, FALSE), $fields, $dest);
Barry Mienydd671972010-10-04 16:33:58 +02001075 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001076
1077 // --------------------------------------------------------------------
1078
1079 /**
1080 * Tests whether the string has an SQL operator
1081 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001082 * @param string
1083 * @return bool
1084 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001085 protected function _has_operator($str)
Derek Allard2067d1a2008-11-13 22:59:24 +00001086 {
Andrey Andreevd454f0e2012-06-10 14:51:04 +03001087 return (bool) preg_match('/(\s|<|>|!|=|IS NULL|IS NOT NULL|BETWEEN)/i', trim($str));
Derek Allard2067d1a2008-11-13 22:59:24 +00001088 }
1089
1090 // --------------------------------------------------------------------
1091
1092 /**
1093 * Enables a native PHP function to be run, using a platform agnostic wrapper.
1094 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001095 * @param string the function name
1096 * @param mixed any parameters needed by the function
Barry Mienydd671972010-10-04 16:33:58 +02001097 * @return mixed
1098 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001099 public function call_function($function)
Derek Allard2067d1a2008-11-13 22:59:24 +00001100 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001101 $driver = ($this->dbdriver === 'postgre') ? 'pg_' : $this->dbdriver.'_';
Barry Mienydd671972010-10-04 16:33:58 +02001102
Derek Allard2067d1a2008-11-13 22:59:24 +00001103 if (FALSE === strpos($driver, $function))
1104 {
1105 $function = $driver.$function;
1106 }
Barry Mienydd671972010-10-04 16:33:58 +02001107
Derek Allard2067d1a2008-11-13 22:59:24 +00001108 if ( ! function_exists($function))
1109 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001110 return ($this->db_debug) ? $this->display_error('db_unsupported_function') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001111 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001112
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001113 return (func_num_args() > 1)
1114 ? call_user_func_array($function, array_splice(func_get_args(), 1))
1115 : call_user_func($function);
Derek Allard2067d1a2008-11-13 22:59:24 +00001116 }
1117
1118 // --------------------------------------------------------------------
1119
1120 /**
1121 * Set Cache Directory Path
1122 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001123 * @param string the path to the cache directory
1124 * @return void
Barry Mienydd671972010-10-04 16:33:58 +02001125 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001126 public function cache_set_path($path = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001127 {
1128 $this->cachedir = $path;
1129 }
1130
1131 // --------------------------------------------------------------------
1132
1133 /**
1134 * Enable Query Caching
1135 *
Andrey Andreev4c202602012-03-06 20:34:52 +02001136 * @return bool cache_on value
Barry Mienydd671972010-10-04 16:33:58 +02001137 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001138 public function cache_on()
Derek Allard2067d1a2008-11-13 22:59:24 +00001139 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001140 return $this->cache_on = TRUE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001141 }
1142
1143 // --------------------------------------------------------------------
1144
1145 /**
1146 * Disable Query Caching
1147 *
Andrey Andreev4c202602012-03-06 20:34:52 +02001148 * @return bool cache_on value
Barry Mienydd671972010-10-04 16:33:58 +02001149 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001150 public function cache_off()
Derek Allard2067d1a2008-11-13 22:59:24 +00001151 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001152 return $this->cache_on = FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001153 }
Barry Mienydd671972010-10-04 16:33:58 +02001154
Derek Allard2067d1a2008-11-13 22:59:24 +00001155
1156 // --------------------------------------------------------------------
1157
1158 /**
1159 * Delete the cache files associated with a particular URI
1160 *
Andrey Andreev4c202602012-03-06 20:34:52 +02001161 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001162 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001163 public function cache_delete($segment_one = '', $segment_two = '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001164 {
Andrey Andreev043f2602012-03-06 20:16:42 +02001165 return ($this->_cache_init())
1166 ? $this->CACHE->delete($segment_one, $segment_two)
1167 : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001168 }
1169
1170 // --------------------------------------------------------------------
1171
1172 /**
1173 * Delete All cache files
1174 *
Andrey Andreev4c202602012-03-06 20:34:52 +02001175 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001176 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001177 public function cache_delete_all()
Derek Allard2067d1a2008-11-13 22:59:24 +00001178 {
Andrey Andreev043f2602012-03-06 20:16:42 +02001179 return ($this->_cache_init())
1180 ? $this->CACHE->delete_all()
1181 : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001182 }
1183
1184 // --------------------------------------------------------------------
1185
1186 /**
1187 * Initialize the Cache Class
1188 *
Andrey Andreev4c202602012-03-06 20:34:52 +02001189 * @return bool
Barry Mienydd671972010-10-04 16:33:58 +02001190 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001191 protected function _cache_init()
Derek Allard2067d1a2008-11-13 22:59:24 +00001192 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001193 if (class_exists('CI_DB_Cache'))
Derek Allard2067d1a2008-11-13 22:59:24 +00001194 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001195 if (is_object($this->CACHE))
Derek Allarde37ab382009-02-03 16:13:57 +00001196 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001197 return TRUE;
Derek Allarde37ab382009-02-03 16:13:57 +00001198 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001199 }
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001200 elseif ( ! @include_once(BASEPATH.'database/DB_cache.php'))
1201 {
1202 return $this->cache_off();
1203 }
Derek Allarde37ab382009-02-03 16:13:57 +00001204
Derek Allard2067d1a2008-11-13 22:59:24 +00001205 $this->CACHE = new CI_DB_Cache($this); // pass db object to support multiple db connections and returned db objects
1206 return TRUE;
1207 }
1208
1209 // --------------------------------------------------------------------
1210
1211 /**
1212 * Close DB Connection
1213 *
Barry Mienydd671972010-10-04 16:33:58 +02001214 * @return void
1215 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001216 public function close()
Derek Allard2067d1a2008-11-13 22:59:24 +00001217 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001218 if ($this->conn_id)
Derek Allard2067d1a2008-11-13 22:59:24 +00001219 {
Andrey Andreev79922c02012-05-23 12:27:17 +03001220 $this->_close();
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001221 $this->conn_id = FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +00001222 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001223 }
Barry Mienydd671972010-10-04 16:33:58 +02001224
Derek Allard2067d1a2008-11-13 22:59:24 +00001225 // --------------------------------------------------------------------
1226
1227 /**
Andrey Andreev79922c02012-05-23 12:27:17 +03001228 * Close DB Connection
1229 *
1230 * This method would be overriden by most of the drivers.
1231 *
1232 * @return void
1233 */
1234 protected function _close()
1235 {
1236 $this->conn_id = FALSE;
1237 }
1238
1239 // --------------------------------------------------------------------
1240
1241 /**
Derek Allard2067d1a2008-11-13 22:59:24 +00001242 * Display an error message
1243 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001244 * @param string the error message
1245 * @param string any "swap" values
Andrey Andreev4c202602012-03-06 20:34:52 +02001246 * @param bool whether to localize the message
Barry Mienydd671972010-10-04 16:33:58 +02001247 * @return string sends the application/error_db.php template
1248 */
Timothy Warrene45518d2012-03-06 07:38:00 -05001249 public function display_error($error = '', $swap = '', $native = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001250 {
Derek Jonese7792202010-03-02 17:24:46 -06001251 $LANG =& load_class('Lang', 'core');
Derek Allard2067d1a2008-11-13 22:59:24 +00001252 $LANG->load('db');
1253
1254 $heading = $LANG->line('db_error_heading');
1255
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001256 if ($native === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001257 {
Andrey Andreev85a99cc2011-09-24 17:17:37 +03001258 $message = (array) $error;
Derek Allard2067d1a2008-11-13 22:59:24 +00001259 }
1260 else
1261 {
1262 $message = ( ! is_array($error)) ? array(str_replace('%s', $swap, $LANG->line($error))) : $error;
1263 }
Barry Mienydd671972010-10-04 16:33:58 +02001264
Pascal Kriete60f8c392010-08-25 18:03:28 +02001265 // Find the most likely culprit of the error by going through
1266 // the backtrace until the source file is no longer in the
1267 // database folder.
Pascal Kriete60f8c392010-08-25 18:03:28 +02001268 $trace = debug_backtrace();
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05001269 foreach ($trace as $call)
Pascal Kriete60f8c392010-08-25 18:03:28 +02001270 {
1271 if (isset($call['file']) && strpos($call['file'], BASEPATH.'database') === FALSE)
1272 {
1273 // Found it - use a relative path for safety
1274 $message[] = 'Filename: '.str_replace(array(BASEPATH, APPPATH), '', $call['file']);
1275 $message[] = 'Line Number: '.$call['line'];
Pascal Kriete60f8c392010-08-25 18:03:28 +02001276 break;
1277 }
1278 }
Barry Mienydd671972010-10-04 16:33:58 +02001279
Derek Jonese7792202010-03-02 17:24:46 -06001280 $error =& load_class('Exceptions', 'core');
Derek Allard2067d1a2008-11-13 22:59:24 +00001281 echo $error->show_error($heading, $message, 'error_db');
1282 exit;
1283 }
1284
1285 // --------------------------------------------------------------------
1286
1287 /**
1288 * Protect Identifiers
1289 *
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001290 * This function is used extensively by the Query Builder class, and by
Barry Mienydd671972010-10-04 16:33:58 +02001291 * a couple functions in this class.
Derek Allard2067d1a2008-11-13 22:59:24 +00001292 * It takes a column or table name (optionally with an alias) and inserts
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001293 * the table prefix onto it. Some logic is necessary in order to deal with
Andrey Andreev4c202602012-03-06 20:34:52 +02001294 * column names that include the path. Consider a query like this:
Derek Allard2067d1a2008-11-13 22:59:24 +00001295 *
1296 * SELECT * FROM hostname.database.table.column AS c FROM hostname.database.table
1297 *
1298 * Or a query with aliasing:
1299 *
1300 * SELECT m.member_id, m.member_name FROM members AS m
1301 *
1302 * Since the column name can include up to four segments (host, DB, table, column)
1303 * or also have an alias prefix, we need to do a bit of work to figure this out and
1304 * insert the table prefix (if it exists) in the proper position, and escape only
1305 * the correct identifiers.
1306 *
Derek Allard2067d1a2008-11-13 22:59:24 +00001307 * @param string
1308 * @param bool
1309 * @param mixed
1310 * @param bool
1311 * @return string
Barry Mienydd671972010-10-04 16:33:58 +02001312 */
Andrey Andreev032e7ea2012-03-06 19:48:35 +02001313 public function protect_identifiers($item, $prefix_single = FALSE, $protect_identifiers = NULL, $field_exists = TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001314 {
1315 if ( ! is_bool($protect_identifiers))
1316 {
Jamie Rumbelow0cd8c792012-03-08 12:52:24 +00001317 $protect_identifiers = $this->_protect_identifiers;
Derek Allard2067d1a2008-11-13 22:59:24 +00001318 }
Derek Allarde37ab382009-02-03 16:13:57 +00001319
1320 if (is_array($item))
1321 {
1322 $escaped_array = array();
Pascal Krietec3a4a8d2011-02-14 13:40:08 -05001323 foreach ($item as $k => $v)
Derek Allarde37ab382009-02-03 16:13:57 +00001324 {
Andrey Andreevbf940582012-06-10 07:05:05 +03001325 $escaped_array[$this->protect_identifiers($k)] = $this->protect_identifiers($v, $prefix_single, $protect_identifiers, $field_exists);
Derek Allarde37ab382009-02-03 16:13:57 +00001326 }
1327
1328 return $escaped_array;
1329 }
1330
Derek Allard911d3e02008-12-15 14:08:35 +00001331 // This is basically a bug fix for queries that use MAX, MIN, etc.
Barry Mienydd671972010-10-04 16:33:58 +02001332 // If a parenthesis is found we know that we do not need to
Andrey Andreev4c202602012-03-06 20:34:52 +02001333 // escape the data or add a prefix. There's probably a more graceful
Derek Allard911d3e02008-12-15 14:08:35 +00001334 // way to deal with this, but I'm not thinking of it -- Rick
1335 if (strpos($item, '(') !== FALSE)
1336 {
Andrey Andreev4db16322012-06-10 15:12:02 +03001337 return $item;
Derek Allard911d3e02008-12-15 14:08:35 +00001338 }
1339
Andrey Andreevbf940582012-06-10 07:05:05 +03001340 // Convert tabs or multiple spaces into single spaces
1341 $item = preg_replace('/\s+/', ' ', $item);
1342
1343 static $preg_ec = array();
1344
1345 if (empty($preg_ec))
1346 {
1347 if (is_array($this->_escape_char))
1348 {
1349 $preg_ec = array(preg_quote($this->_escape_char[0]), preg_quote($this->_escape_char[1]));
1350 }
1351 else
1352 {
1353 $preg_ec[0] = $preg_ec[1] = preg_quote($this->_escape_char);
1354 }
1355 }
1356
1357 // If the item has an alias declaration we remove it and set it aside.
1358 // Basically we remove everything to the right of the first space
Andrey Andreevb30426d2012-06-10 14:08:29 +03001359 preg_match('/^(('.$preg_ec[0].'[^'.$preg_ec[1].']+'.$preg_ec[1].')|([^'.$preg_ec[0].'][^\s]+))( AS)*(.+)*$/i', $item, $matches);
Andrey Andreevbf940582012-06-10 07:05:05 +03001360
1361 if (isset($matches[4]))
1362 {
1363 $item = $matches[1];
1364
1365 // Escape the alias, if needed
1366 if ($protect_identifiers === TRUE)
1367 {
1368 $alias = empty($matches[5])
1369 ? ' '.$this->escape_identifiers(ltrim($matches[4]))
1370 : $matches[4].' '.$this->escape_identifiers(ltrim($matches[5]));
1371 }
1372 else
1373 {
1374 $alias = $matches[4].$matches[5];
1375 }
1376 }
1377 else
1378 {
1379 $alias = '';
1380 }
1381
Derek Allard2067d1a2008-11-13 22:59:24 +00001382 // Break the string apart if it contains periods, then insert the table prefix
1383 // in the correct location, assuming the period doesn't indicate that we're dealing
1384 // with an alias. While we're at it, we will escape the components
1385 if (strpos($item, '.') !== FALSE)
1386 {
1387 $parts = explode('.', $item);
Barry Mienydd671972010-10-04 16:33:58 +02001388
Derek Allard2067d1a2008-11-13 22:59:24 +00001389 // Does the first segment of the exploded item match
Andrey Andreev4c202602012-03-06 20:34:52 +02001390 // one of the aliases previously identified? If so,
Derek Allard2067d1a2008-11-13 22:59:24 +00001391 // we have nothing more to do other than escape the item
Jamie Rumbelow7efad202012-02-19 12:37:00 +00001392 if (in_array($parts[0], $this->qb_aliased_tables))
Derek Allard911d3e02008-12-15 14:08:35 +00001393 {
Derek Allard2067d1a2008-11-13 22:59:24 +00001394 if ($protect_identifiers === TRUE)
1395 {
1396 foreach ($parts as $key => $val)
1397 {
1398 if ( ! in_array($val, $this->_reserved_identifiers))
1399 {
Andrey Andreevea09a8a2012-04-06 20:50:07 +03001400 $parts[$key] = $this->escape_identifiers($val);
Derek Allard2067d1a2008-11-13 22:59:24 +00001401 }
1402 }
Barry Mienydd671972010-10-04 16:33:58 +02001403
Derek Allard2067d1a2008-11-13 22:59:24 +00001404 $item = implode('.', $parts);
Barry Mienydd671972010-10-04 16:33:58 +02001405 }
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001406
Derek Allard2067d1a2008-11-13 22:59:24 +00001407 return $item.$alias;
1408 }
Barry Mienydd671972010-10-04 16:33:58 +02001409
Andrey Andreev4c202602012-03-06 20:34:52 +02001410 // Is there a table prefix defined in the config file? If not, no need to do anything
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001411 if ($this->dbprefix !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001412 {
1413 // We now add the table prefix based on some logic.
1414 // Do we have 4 segments (hostname.database.table.column)?
1415 // If so, we add the table prefix to the column name in the 3rd segment.
1416 if (isset($parts[3]))
1417 {
1418 $i = 2;
1419 }
1420 // Do we have 3 segments (database.table.column)?
1421 // If so, we add the table prefix to the column name in 2nd position
1422 elseif (isset($parts[2]))
1423 {
1424 $i = 1;
1425 }
1426 // Do we have 2 segments (table.column)?
1427 // If so, we add the table prefix to the column name in 1st segment
1428 else
1429 {
1430 $i = 0;
1431 }
Barry Mienydd671972010-10-04 16:33:58 +02001432
Derek Allard2067d1a2008-11-13 22:59:24 +00001433 // This flag is set when the supplied $item does not contain a field name.
1434 // This can happen when this function is being called from a JOIN.
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001435 if ($field_exists === FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +00001436 {
1437 $i++;
1438 }
Barry Mienydd671972010-10-04 16:33:58 +02001439
Derek Jones55acc8b2009-07-11 03:38:13 +00001440 // Verify table prefix and replace if necessary
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001441 if ($this->swap_pre !== '' && strpos($parts[$i], $this->swap_pre) === 0)
Derek Jones55acc8b2009-07-11 03:38:13 +00001442 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001443 $parts[$i] = preg_replace('/^'.$this->swap_pre.'(\S+?)/', $this->dbprefix.'\\1', $parts[$i]);
Derek Jones55acc8b2009-07-11 03:38:13 +00001444 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001445 // We only add the table prefix if it does not already exist
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001446 elseif (strpos($parts[$i], $this->dbprefix) !== 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001447 {
1448 $parts[$i] = $this->dbprefix.$parts[$i];
1449 }
Barry Mienydd671972010-10-04 16:33:58 +02001450
Derek Allard2067d1a2008-11-13 22:59:24 +00001451 // Put the parts back together
1452 $item = implode('.', $parts);
1453 }
Barry Mienydd671972010-10-04 16:33:58 +02001454
Derek Allard2067d1a2008-11-13 22:59:24 +00001455 if ($protect_identifiers === TRUE)
1456 {
Andrey Andreevea09a8a2012-04-06 20:50:07 +03001457 $item = $this->escape_identifiers($item);
Derek Allard2067d1a2008-11-13 22:59:24 +00001458 }
Barry Mienydd671972010-10-04 16:33:58 +02001459
Derek Allard2067d1a2008-11-13 22:59:24 +00001460 return $item.$alias;
1461 }
1462
Andrey Andreev4c202602012-03-06 20:34:52 +02001463 // Is there a table prefix? If not, no need to insert it
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001464 if ($this->dbprefix !== '')
Derek Allard2067d1a2008-11-13 22:59:24 +00001465 {
Derek Jones55acc8b2009-07-11 03:38:13 +00001466 // Verify table prefix and replace if necessary
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001467 if ($this->swap_pre !== '' && strpos($item, $this->swap_pre) === 0)
Derek Jones55acc8b2009-07-11 03:38:13 +00001468 {
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001469 $item = preg_replace('/^'.$this->swap_pre.'(\S+?)/', $this->dbprefix.'\\1', $item);
Derek Jones55acc8b2009-07-11 03:38:13 +00001470 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001471 // Do we prefix an item with no segments?
Alex Bilbie48a2baf2012-06-02 11:09:54 +01001472 elseif ($prefix_single === TRUE && strpos($item, $this->dbprefix) !== 0)
Derek Allard2067d1a2008-11-13 22:59:24 +00001473 {
1474 $item = $this->dbprefix.$item;
Barry Mienydd671972010-10-04 16:33:58 +02001475 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001476 }
1477
Andrey Andreevaf5d5582012-01-25 21:34:47 +02001478 if ($protect_identifiers === TRUE && ! in_array($item, $this->_reserved_identifiers))
Derek Allard2067d1a2008-11-13 22:59:24 +00001479 {
Andrey Andreevea09a8a2012-04-06 20:50:07 +03001480 $item = $this->escape_identifiers($item);
Derek Allard2067d1a2008-11-13 22:59:24 +00001481 }
Barry Mienydd671972010-10-04 16:33:58 +02001482
Derek Allard2067d1a2008-11-13 22:59:24 +00001483 return $item.$alias;
1484 }
Andrey Andreev4c202602012-03-06 20:34:52 +02001485
Túbal Martín511f2252011-11-24 14:43:45 +01001486 // --------------------------------------------------------------------
Derek Allard2067d1a2008-11-13 22:59:24 +00001487
Túbal Martín511f2252011-11-24 14:43:45 +01001488 /**
Jamie Rumbelow17c1bed2012-03-06 21:30:38 +00001489 * Dummy method that allows Query Builder class to be disabled
Andrey Andreev16bb9bd2012-05-26 18:21:14 +03001490 * and keep count_all() working.
Túbal Martín511f2252011-11-24 14:43:45 +01001491 *
Túbal Martín511f2252011-11-24 14:43:45 +01001492 * @return void
1493 */
1494 protected function _reset_select()
1495 {
Túbal Martín511f2252011-11-24 14:43:45 +01001496 }
Derek Allard2067d1a2008-11-13 22:59:24 +00001497
1498}
1499
Derek Allard2067d1a2008-11-13 22:59:24 +00001500/* End of file DB_driver.php */
Andrey Andreev79922c02012-05-23 12:27:17 +03001501/* Location: ./system/database/DB_driver.php */