blob: 32a9e750925007035cc244ef1884ede446a2b54e [file] [log] [blame]
Andrey Andreevbd44d5a2012-03-20 22:59:29 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Timothy Warren80ab8162011-08-22 18:26:12 -04002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Timothy Warren80ab8162011-08-22 18:26:12 -04006 *
Timothy Warrend1a5ba22011-10-21 04:45:28 -04007 * NOTICE OF LICENSE
Andrey Andreevbd44d5a2012-03-20 22:59:29 +02008 *
Timothy Warrend1a5ba22011-10-21 04:45:28 -04009 * Licensed under the Open Software License version 3.0
Andrey Andreevbd44d5a2012-03-20 22:59:29 +020010 *
Timothy Warrend1a5ba22011-10-21 04:45:28 -040011 * 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 *
Timothy Warren80ab8162011-08-22 18:26:12 -040019 * @package CodeIgniter
Timothy Warrend1a5ba22011-10-21 04:45:28 -040020 * @author EllisLab Dev Team
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Timothy Warrend1a5ba22011-10-21 04:45:28 -040022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Timothy Warren80ab8162011-08-22 18:26:12 -040023 * @link http://codeigniter.com
Timothy Warren018af7a2011-09-07 12:07:35 -040024 * @since Version 2.1.0
Timothy Warren80ab8162011-08-22 18:26:12 -040025 * @filesource
26 */
27
Timothy Warren80ab8162011-08-22 18:26:12 -040028/**
Timothy Warren02615962011-08-24 08:21:36 -040029 * PDO Database Adapter Class
Timothy Warren80ab8162011-08-22 18:26:12 -040030 *
31 * Note: _DB is an extender class that the app controller
Jamie Rumbelow7efad202012-02-19 12:37:00 +000032 * creates dynamically based on whether the query builder
Timothy Warren80ab8162011-08-22 18:26:12 -040033 * class is being used or not.
34 *
35 * @package CodeIgniter
36 * @subpackage Drivers
37 * @category Database
Timothy Warrend1a5ba22011-10-21 04:45:28 -040038 * @author EllisLab Dev Team
Timothy Warren80ab8162011-08-22 18:26:12 -040039 * @link http://codeigniter.com/user_guide/database/
40 */
41class CI_DB_pdo_driver extends CI_DB {
42
Andrey Andreevbd44d5a2012-03-20 22:59:29 +020043 public $dbdriver = 'pdo';
Timothy Warren80ab8162011-08-22 18:26:12 -040044
Andrey Andreev50293052012-06-25 17:48:49 +030045 // The character used to escaping
Andrey Andreev5663b1e2012-06-24 00:28:42 +030046 protected $_escape_char = '"';
Taufan Aditya18209332012-02-09 16:07:27 +070047
Andrey Andreevbd44d5a2012-03-20 22:59:29 +020048 protected $_random_keyword;
Taufan Aditya18209332012-02-09 16:07:27 +070049
Andrey Andreev44107772012-06-25 18:38:34 +030050 public $trans_enabled = FALSE;
Andrey Andreev6b4bffa2012-06-25 02:29:20 +030051
Andrey Andreevfbba54e2012-06-23 20:26:31 +030052 // need to track the PDO options
Andrey Andreevbd44d5a2012-03-20 22:59:29 +020053 public $options = array();
Timothy Warren80ab8162011-08-22 18:26:12 -040054
Andrey Andreev50293052012-06-25 17:48:49 +030055 /**
56 * Constructor
57 *
58 * Validates the DSN string and/or detects the subdriver
59 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +030060 * @param array $params
Andrey Andreev50293052012-06-25 17:48:49 +030061 * @return void
62 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +020063 public function __construct($params)
Timothy Warren80ab8162011-08-22 18:26:12 -040064 {
Timothy Warrenb5a43b02011-10-04 17:26:04 -040065 parent::__construct($params);
Taufan Aditya18209332012-02-09 16:07:27 +070066
Alex Bilbie48a2baf2012-06-02 11:09:54 +010067 if (preg_match('/([^;]+):/', $this->dsn, $match) && count($match) === 2)
Taufan Aditya18209332012-02-09 16:07:27 +070068 {
69 // If there is a minimum valid dsn string pattern found, we're done
Taufan Adityafdd6ad02012-02-10 13:10:27 +070070 // This is for general PDO users, who tend to have a full DSN string.
Andrey Andreev7151e802012-06-25 00:47:41 +030071 $this->subdriver = $match[1];
Andrey Andreev50293052012-06-25 17:48:49 +030072 return;
Taufan Aditya18209332012-02-09 16:07:27 +070073 }
Andrey Andreev50293052012-06-25 17:48:49 +030074 // Legacy support for DSN specified in the hostname field
75 elseif (preg_match('/([^;]+):/', $this->hostname, $match) && count($match) === 2)
Taufan Aditya18209332012-02-09 16:07:27 +070076 {
Andrey Andreev50293052012-06-25 17:48:49 +030077 $this->dsn = $this->hostname;
78 $this->hostname = NULL;
79 $this->subdriver = $match[1];
80 return;
Taufan Aditya18209332012-02-09 16:07:27 +070081 }
Andrey Andreev50293052012-06-25 17:48:49 +030082 elseif (in_array($this->subdriver, array('mssql', 'sybase'), TRUE))
Andrey Andreev7151e802012-06-25 00:47:41 +030083 {
84 $this->subdriver = 'dblib';
85 }
Andrey Andreev6b4bffa2012-06-25 02:29:20 +030086 elseif ($this->subdriver === '4D')
87 {
88 $this->subdriver = '4d';
89 }
Andrey Andreev50293052012-06-25 17:48:49 +030090 elseif ( ! in_array($this->subdriver, array('4d', 'cubrid', 'dblib', 'firebird', 'ibm', 'informix', 'mysql', 'oci', 'odbc', 'sqlite', 'sqlsrv'), TRUE))
Timothy Warrenc7ba6642011-09-14 12:25:14 -040091 {
Andrey Andreev50293052012-06-25 17:48:49 +030092 log_message('error', 'PDO: Invalid or non-existent subdriver');
Timothy Warren80ab8162011-08-22 18:26:12 -040093
Andrey Andreev50293052012-06-25 17:48:49 +030094 if ($this->db_debug)
Timothy Warren25dc7552012-02-13 14:12:35 -050095 {
Andrey Andreev50293052012-06-25 17:48:49 +030096 show_error('Invalid or non-existent PDO subdriver');
Taufan Aditya18209332012-02-09 16:07:27 +070097 }
Andrey Andreevd42cc462012-06-24 23:52:40 +030098 }
Andrey Andreev50293052012-06-25 17:48:49 +030099
100 $this->dsn = NULL;
Taufan Aditya18209332012-02-09 16:07:27 +0700101 }
102
Andrey Andreev2387ed32012-04-07 00:11:14 +0300103 // --------------------------------------------------------------------
104
Taufan Aditya18209332012-02-09 16:07:27 +0700105 /**
Timothy Warren80ab8162011-08-22 18:26:12 -0400106 * Non-persistent database connection
107 *
Andrey Andreev2387ed32012-04-07 00:11:14 +0300108 * @param bool
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200109 * @return object
Taufan Aditya18209332012-02-09 16:07:27 +0700110 */
Andrey Andreev3b0130d2012-06-24 21:41:42 +0300111 public function db_connect($persistent = FALSE)
Taufan Aditya18209332012-02-09 16:07:27 +0700112 {
Andrey Andreev3b0130d2012-06-24 21:41:42 +0300113 $this->options[PDO::ATTR_PERSISTENT] = $persistent;
Andrey Andreev2387ed32012-04-07 00:11:14 +0300114
Taufan Aditya18209332012-02-09 16:07:27 +0700115 // Connecting...
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200116 try
Taufan Aditya18209332012-02-09 16:07:27 +0700117 {
Andrey Andreevf00b9f02012-07-02 14:40:49 +0300118 return @new PDO($this->dsn, $this->username, $this->password, $this->options);
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200119 }
120 catch (PDOException $e)
Taufan Aditya18209332012-02-09 16:07:27 +0700121 {
122 if ($this->db_debug && empty($this->failover))
123 {
124 $this->display_error($e->getMessage(), '', TRUE);
125 }
126
127 return FALSE;
128 }
Timothy Warren80ab8162011-08-22 18:26:12 -0400129 }
130
131 // --------------------------------------------------------------------
132
133 /**
Andrey Andreev3b0130d2012-06-24 21:41:42 +0300134 * Persistent database connection
135 *
136 * @return object
137 */
138 public function db_pconnect()
139 {
140 return $this->db_connect(TRUE);
141 }
142
143 // --------------------------------------------------------------------
144
145 /**
Andrey Andreev08856b82012-03-03 03:19:28 +0200146 * Database version number
Timothy Warren80ab8162011-08-22 18:26:12 -0400147 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400148 * @return string
149 */
Andrey Andreev08856b82012-03-03 03:19:28 +0200150 public function version()
Timothy Warren80ab8162011-08-22 18:26:12 -0400151 {
Andrey Andreev9e3a83a2012-07-05 21:57:41 +0300152 if (isset($this->data_cache['version']))
153 {
154 return $this->data_cache['version'];
155 }
156
157 // Not all subdrivers support the getAttribute() method
158 try
159 {
160 return $this->data_cache['version'] = $this->conn_id->getAttribute(PDO::ATTR_SERVER_VERSION);
161 }
162 catch (PDOException $e)
163 {
164 return parent::version();
165 }
Timothy Warren80ab8162011-08-22 18:26:12 -0400166 }
167
168 // --------------------------------------------------------------------
169
170 /**
171 * Execute the query
172 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400173 * @param string an SQL query
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200174 * @return mixed
Timothy Warren80ab8162011-08-22 18:26:12 -0400175 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200176 protected function _execute($sql)
Timothy Warren80ab8162011-08-22 18:26:12 -0400177 {
Andrey Andreev2387ed32012-04-07 00:11:14 +0300178 return $this->conn_id->query($sql);
Timothy Warren80ab8162011-08-22 18:26:12 -0400179 }
180
181 // --------------------------------------------------------------------
182
183 /**
Timothy Warren80ab8162011-08-22 18:26:12 -0400184 * Begin Transaction
185 *
Andrey Andreev5fd3ae82012-10-24 14:55:35 +0300186 * @param bool $test_mode = FALSE
Timothy Warren80ab8162011-08-22 18:26:12 -0400187 * @return bool
188 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200189 public function trans_begin($test_mode = FALSE)
Timothy Warren80ab8162011-08-22 18:26:12 -0400190 {
Timothy Warren80ab8162011-08-22 18:26:12 -0400191 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreev80144bf2012-04-06 22:19:26 +0300192 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Timothy Warren80ab8162011-08-22 18:26:12 -0400193 {
194 return TRUE;
195 }
196
197 // Reset the transaction failure flag.
198 // If the $test_mode flag is set to TRUE transactions will be rolled back
199 // even if the queries produce a successful result.
Andrey Andreev2387ed32012-04-07 00:11:14 +0300200 $this->_trans_failure = ($test_mode === TRUE);
Timothy Warren80ab8162011-08-22 18:26:12 -0400201
Timothy Warrenab347582011-08-23 12:29:29 -0400202 return $this->conn_id->beginTransaction();
Timothy Warren80ab8162011-08-22 18:26:12 -0400203 }
204
205 // --------------------------------------------------------------------
206
207 /**
208 * Commit Transaction
209 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400210 * @return bool
211 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200212 public function trans_commit()
Timothy Warren80ab8162011-08-22 18:26:12 -0400213 {
Timothy Warren80ab8162011-08-22 18:26:12 -0400214 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreev80144bf2012-04-06 22:19:26 +0300215 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Timothy Warren80ab8162011-08-22 18:26:12 -0400216 {
217 return TRUE;
218 }
219
Andrey Andreev80144bf2012-04-06 22:19:26 +0300220 return $this->conn_id->commit();
Timothy Warren80ab8162011-08-22 18:26:12 -0400221 }
222
223 // --------------------------------------------------------------------
224
225 /**
226 * Rollback Transaction
227 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400228 * @return bool
229 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200230 public function trans_rollback()
Timothy Warren80ab8162011-08-22 18:26:12 -0400231 {
Timothy Warren80ab8162011-08-22 18:26:12 -0400232 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreev80144bf2012-04-06 22:19:26 +0300233 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Timothy Warren80ab8162011-08-22 18:26:12 -0400234 {
235 return TRUE;
236 }
237
Andrey Andreev80144bf2012-04-06 22:19:26 +0300238 return $this->conn_id->rollBack();
Timothy Warren80ab8162011-08-22 18:26:12 -0400239 }
240
241 // --------------------------------------------------------------------
242
243 /**
244 * Escape String
245 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400246 * @param string
247 * @param bool whether or not the string will be used in a LIKE condition
248 * @return string
249 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200250 public function escape_str($str, $like = FALSE)
Timothy Warren80ab8162011-08-22 18:26:12 -0400251 {
252 if (is_array($str))
253 {
254 foreach ($str as $key => $val)
255 {
256 $str[$key] = $this->escape_str($val, $like);
257 }
258
259 return $str;
260 }
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200261
Andrey Andreev2387ed32012-04-07 00:11:14 +0300262 // Escape the string
Timothy Warren47663972011-10-05 16:44:50 -0400263 $str = $this->conn_id->quote($str);
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200264
Andrey Andreev2387ed32012-04-07 00:11:14 +0300265 // If there are duplicated quotes, trim them away
Andrey Andreev263d2eb2012-06-25 18:17:14 +0300266 if ($str[0] === "'")
Timothy Warrenec193322011-10-07 09:53:35 -0400267 {
268 $str = substr($str, 1, -1);
269 }
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200270
Timothy Warren80ab8162011-08-22 18:26:12 -0400271 // escape LIKE condition wildcards
272 if ($like === TRUE)
273 {
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200274 return str_replace(array($this->_like_escape_chr, '%', '_'),
275 array($this->_like_escape_chr.$this->_like_escape_chr, $this->_like_escape_chr.'%', $this->_like_escape_chr.'_'),
276 $str);
Timothy Warren80ab8162011-08-22 18:26:12 -0400277 }
278
279 return $str;
280 }
281
282 // --------------------------------------------------------------------
283
284 /**
285 * Affected Rows
286 *
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200287 * @return int
Timothy Warren80ab8162011-08-22 18:26:12 -0400288 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200289 public function affected_rows()
Timothy Warren80ab8162011-08-22 18:26:12 -0400290 {
Andrey Andreev2387ed32012-04-07 00:11:14 +0300291 return is_object($this->result_id) ? $this->result_id->rowCount() : 0;
Timothy Warren80ab8162011-08-22 18:26:12 -0400292 }
293
294 // --------------------------------------------------------------------
295
296 /**
297 * Insert ID
Andrey Andreeva39d6992012-03-01 19:11:39 +0200298 *
Andrey Andreev2387ed32012-04-07 00:11:14 +0300299 * @param string
Andrey Andreeva39d6992012-03-01 19:11:39 +0200300 * @return int
Timothy Warren80ab8162011-08-22 18:26:12 -0400301 */
Andrey Andreeva39d6992012-03-01 19:11:39 +0200302 public function insert_id($name = NULL)
Timothy Warren80ab8162011-08-22 18:26:12 -0400303 {
Andrey Andreeva39d6992012-03-01 19:11:39 +0200304 return $this->conn_id->lastInsertId($name);
Timothy Warren80ab8162011-08-22 18:26:12 -0400305 }
306
307 // --------------------------------------------------------------------
308
309 /**
Timothy Warren80ab8162011-08-22 18:26:12 -0400310 * Field data query
311 *
312 * Generates a platform-specific query so that the column data can be retrieved
313 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400314 * @param string the table name
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200315 * @return string
Timothy Warren80ab8162011-08-22 18:26:12 -0400316 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200317 protected function _field_data($table)
Timothy Warren80ab8162011-08-22 18:26:12 -0400318 {
Andrey Andreev50293052012-06-25 17:48:49 +0300319 return 'SELECT TOP 1 * FROM '.$this->protect_identifiers($table);
Timothy Warren80ab8162011-08-22 18:26:12 -0400320 }
321
322 // --------------------------------------------------------------------
323
324 /**
Andrey Andreev4be5de12012-03-02 15:45:41 +0200325 * Error
Timothy Warren80ab8162011-08-22 18:26:12 -0400326 *
Andrey Andreev4be5de12012-03-02 15:45:41 +0200327 * Returns an array containing code and message of the last
328 * database error that has occured.
Timothy Warren80ab8162011-08-22 18:26:12 -0400329 *
Andrey Andreev4be5de12012-03-02 15:45:41 +0200330 * @return array
Timothy Warren80ab8162011-08-22 18:26:12 -0400331 */
Andrey Andreev4be5de12012-03-02 15:45:41 +0200332 public function error()
Timothy Warren80ab8162011-08-22 18:26:12 -0400333 {
Andrey Andreev4be5de12012-03-02 15:45:41 +0200334 $error = array('code' => '00000', 'message' => '');
335 $pdo_error = $this->conn_id->errorInfo();
336
337 if (empty($pdo_error[0]))
338 {
339 return $error;
340 }
341
342 $error['code'] = isset($pdo_error[1]) ? $pdo_error[0].'/'.$pdo_error[1] : $pdo_error[0];
343 if (isset($pdo_error[2]))
344 {
345 $error['message'] = $pdo_error[2];
346 }
347
348 return $error;
Timothy Warren80ab8162011-08-22 18:26:12 -0400349 }
350
351 // --------------------------------------------------------------------
352
353 /**
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400354 * Update_Batch statement
355 *
356 * Generates a platform-specific batch update string from the supplied data
357 *
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400358 * @param string the table name
359 * @param array the update data
Andrey Andreevb0478652012-07-18 15:34:46 +0300360 * @param string the where key
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400361 * @return string
362 */
Andrey Andreevb0478652012-07-18 15:34:46 +0300363 protected function _update_batch($table, $values, $index)
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400364 {
Andrey Andreevdf8894f2012-06-25 16:18:50 +0300365 $ids = array();
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400366 foreach ($values as $key => $val)
367 {
368 $ids[] = $val[$index];
369
370 foreach (array_keys($val) as $field)
371 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100372 if ($field !== $index)
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400373 {
374 $final[$field][] = 'WHEN '.$index.' = '.$val[$index].' THEN '.$val[$field];
375 }
376 }
377 }
378
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400379 $cases = '';
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400380 foreach ($final as $k => $v)
381 {
382 $cases .= $k.' = CASE '."\n";
Taufan Aditya18209332012-02-09 16:07:27 +0700383
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400384 foreach ($v as $row)
385 {
386 $cases .= $row."\n";
387 }
388
389 $cases .= 'ELSE '.$k.' END, ';
390 }
391
Andrey Andreevb0478652012-07-18 15:34:46 +0300392 $this->where($index.' IN('.implode(',', $ids).')', NULL, FALSE);
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400393
Andrey Andreevd40459d2012-07-18 16:46:39 +0300394 return 'UPDATE '.$table.' SET '.substr($cases, 0, -2).$this->_compile_wh('qb_where');
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400395 }
Timothy Warren80ab8162011-08-22 18:26:12 -0400396
Andrey Andreeve61b19f2012-06-25 18:11:39 +0300397 // --------------------------------------------------------------------
398
399 /**
400 * Truncate statement
401 *
402 * Generates a platform-specific truncate string from the supplied data
403 *
404 * If the database does not support the truncate() command,
405 * then this method maps to 'DELETE FROM table'
406 *
407 * @param string the table name
408 * @return string
409 */
410 protected function _truncate($table)
411 {
412 return 'TRUNCATE TABLE '.$table;
413 }
414
Timothy Warren80ab8162011-08-22 18:26:12 -0400415}
416
Timothy Warren80ab8162011-08-22 18:26:12 -0400417/* End of file pdo_driver.php */
Andrey Andreevf00b9f02012-07-02 14:40:49 +0300418/* Location: ./system/database/drivers/pdo/pdo_driver.php */