blob: d18720ed238324408ec2049c3742c73e1760f1ac [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
48 // clause and character used for LIKE escape sequences
Andrey Andreeve9f20952012-04-06 19:30:41 +030049 protected $_like_escape_str = " ESCAPE '%s' ";
50 protected $_like_escape_chr = '!';
Timothy Warren80ab8162011-08-22 18:26:12 -040051
52 /**
53 * The syntax to count rows is slightly different across different
54 * database engines, so this string appears in each driver and is
Timothy Warren667c9fe2012-03-19 19:06:34 -040055 * used for the count_all() and count_all_results() functions.
Timothy Warren80ab8162011-08-22 18:26:12 -040056 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +020057 protected $_count_string = 'SELECT COUNT(*) AS ';
58 protected $_random_keyword;
Taufan Aditya18209332012-02-09 16:07:27 +070059
Andrey Andreev6b4bffa2012-06-25 02:29:20 +030060 protected $trans_enabled = FALSE;
61
Andrey Andreevfbba54e2012-06-23 20:26:31 +030062 // need to track the PDO options
Andrey Andreevbd44d5a2012-03-20 22:59:29 +020063 public $options = array();
Timothy Warren80ab8162011-08-22 18:26:12 -040064
Andrey Andreev50293052012-06-25 17:48:49 +030065 /**
66 * Constructor
67 *
68 * Validates the DSN string and/or detects the subdriver
69 *
70 * @param array
71 * @return void
72 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +020073 public function __construct($params)
Timothy Warren80ab8162011-08-22 18:26:12 -040074 {
Timothy Warrenb5a43b02011-10-04 17:26:04 -040075 parent::__construct($params);
Taufan Aditya18209332012-02-09 16:07:27 +070076
Alex Bilbie48a2baf2012-06-02 11:09:54 +010077 if (preg_match('/([^;]+):/', $this->dsn, $match) && count($match) === 2)
Taufan Aditya18209332012-02-09 16:07:27 +070078 {
79 // If there is a minimum valid dsn string pattern found, we're done
Taufan Adityafdd6ad02012-02-10 13:10:27 +070080 // This is for general PDO users, who tend to have a full DSN string.
Andrey Andreev7151e802012-06-25 00:47:41 +030081 $this->subdriver = $match[1];
Andrey Andreev50293052012-06-25 17:48:49 +030082 return;
Taufan Aditya18209332012-02-09 16:07:27 +070083 }
Andrey Andreev50293052012-06-25 17:48:49 +030084 // Legacy support for DSN specified in the hostname field
85 elseif (preg_match('/([^;]+):/', $this->hostname, $match) && count($match) === 2)
Taufan Aditya18209332012-02-09 16:07:27 +070086 {
Andrey Andreev50293052012-06-25 17:48:49 +030087 $this->dsn = $this->hostname;
88 $this->hostname = NULL;
89 $this->subdriver = $match[1];
90 return;
Taufan Aditya18209332012-02-09 16:07:27 +070091 }
Andrey Andreev50293052012-06-25 17:48:49 +030092 elseif (in_array($this->subdriver, array('mssql', 'sybase'), TRUE))
Andrey Andreev7151e802012-06-25 00:47:41 +030093 {
94 $this->subdriver = 'dblib';
95 }
Andrey Andreev6b4bffa2012-06-25 02:29:20 +030096 elseif ($this->subdriver === '4D')
97 {
98 $this->subdriver = '4d';
99 }
Andrey Andreev50293052012-06-25 17:48:49 +0300100 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 -0400101 {
Andrey Andreev50293052012-06-25 17:48:49 +0300102 log_message('error', 'PDO: Invalid or non-existent subdriver');
Timothy Warren80ab8162011-08-22 18:26:12 -0400103
Andrey Andreev50293052012-06-25 17:48:49 +0300104 if ($this->db_debug)
Timothy Warren25dc7552012-02-13 14:12:35 -0500105 {
Andrey Andreev50293052012-06-25 17:48:49 +0300106 show_error('Invalid or non-existent PDO subdriver');
Taufan Aditya18209332012-02-09 16:07:27 +0700107 }
108
Andrey Andreev50293052012-06-25 17:48:49 +0300109 throw new Exception('Invalid or non-existent PDO subdriver');
Andrey Andreevd42cc462012-06-24 23:52:40 +0300110 }
Andrey Andreev50293052012-06-25 17:48:49 +0300111
112 $this->dsn = NULL;
Taufan Aditya18209332012-02-09 16:07:27 +0700113 }
114
Andrey Andreev2387ed32012-04-07 00:11:14 +0300115 // --------------------------------------------------------------------
116
Taufan Aditya18209332012-02-09 16:07:27 +0700117 /**
Timothy Warren80ab8162011-08-22 18:26:12 -0400118 * Non-persistent database connection
119 *
Andrey Andreev2387ed32012-04-07 00:11:14 +0300120 * @param bool
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200121 * @return object
Taufan Aditya18209332012-02-09 16:07:27 +0700122 */
Andrey Andreev3b0130d2012-06-24 21:41:42 +0300123 public function db_connect($persistent = FALSE)
Taufan Aditya18209332012-02-09 16:07:27 +0700124 {
Andrey Andreev2387ed32012-04-07 00:11:14 +0300125 $this->options[PDO::ATTR_ERRMODE] = PDO::ERRMODE_SILENT;
Andrey Andreev3b0130d2012-06-24 21:41:42 +0300126 $this->options[PDO::ATTR_PERSISTENT] = $persistent;
Andrey Andreev2387ed32012-04-07 00:11:14 +0300127
Taufan Aditya18209332012-02-09 16:07:27 +0700128 // Connecting...
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200129 try
Taufan Aditya18209332012-02-09 16:07:27 +0700130 {
Andrey Andreev2387ed32012-04-07 00:11:14 +0300131 return new PDO($this->dsn, $this->username, $this->password, $this->options);
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200132 }
133 catch (PDOException $e)
Taufan Aditya18209332012-02-09 16:07:27 +0700134 {
135 if ($this->db_debug && empty($this->failover))
136 {
137 $this->display_error($e->getMessage(), '', TRUE);
138 }
139
140 return FALSE;
141 }
Timothy Warren80ab8162011-08-22 18:26:12 -0400142 }
143
144 // --------------------------------------------------------------------
145
146 /**
Andrey Andreev3b0130d2012-06-24 21:41:42 +0300147 * Persistent database connection
148 *
149 * @return object
150 */
151 public function db_pconnect()
152 {
153 return $this->db_connect(TRUE);
154 }
155
156 // --------------------------------------------------------------------
157
158 /**
Andrey Andreev08856b82012-03-03 03:19:28 +0200159 * Database version number
Timothy Warren80ab8162011-08-22 18:26:12 -0400160 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400161 * @return string
162 */
Andrey Andreev08856b82012-03-03 03:19:28 +0200163 public function version()
Timothy Warren80ab8162011-08-22 18:26:12 -0400164 {
Andrey Andreev08856b82012-03-03 03:19:28 +0200165 return isset($this->data_cache['version'])
166 ? $this->data_cache['version']
167 : $this->data_cache['version'] = $this->conn_id->getAttribute(PDO::ATTR_SERVER_VERSION);
Timothy Warren80ab8162011-08-22 18:26:12 -0400168 }
169
170 // --------------------------------------------------------------------
171
172 /**
173 * Execute the query
174 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400175 * @param string an SQL query
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200176 * @return mixed
Timothy Warren80ab8162011-08-22 18:26:12 -0400177 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200178 protected function _execute($sql)
Timothy Warren80ab8162011-08-22 18:26:12 -0400179 {
Andrey Andreev2387ed32012-04-07 00:11:14 +0300180 return $this->conn_id->query($sql);
Timothy Warren80ab8162011-08-22 18:26:12 -0400181 }
182
183 // --------------------------------------------------------------------
184
185 /**
Timothy Warren80ab8162011-08-22 18:26:12 -0400186 * Begin Transaction
187 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400188 * @return bool
189 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200190 public function trans_begin($test_mode = FALSE)
Timothy Warren80ab8162011-08-22 18:26:12 -0400191 {
Timothy Warren80ab8162011-08-22 18:26:12 -0400192 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreev80144bf2012-04-06 22:19:26 +0300193 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Timothy Warren80ab8162011-08-22 18:26:12 -0400194 {
195 return TRUE;
196 }
197
198 // Reset the transaction failure flag.
199 // If the $test_mode flag is set to TRUE transactions will be rolled back
200 // even if the queries produce a successful result.
Andrey Andreev2387ed32012-04-07 00:11:14 +0300201 $this->_trans_failure = ($test_mode === TRUE);
Timothy Warren80ab8162011-08-22 18:26:12 -0400202
Timothy Warrenab347582011-08-23 12:29:29 -0400203 return $this->conn_id->beginTransaction();
Timothy Warren80ab8162011-08-22 18:26:12 -0400204 }
205
206 // --------------------------------------------------------------------
207
208 /**
209 * Commit Transaction
210 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400211 * @return bool
212 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200213 public function trans_commit()
Timothy Warren80ab8162011-08-22 18:26:12 -0400214 {
Timothy Warren80ab8162011-08-22 18:26:12 -0400215 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreev80144bf2012-04-06 22:19:26 +0300216 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Timothy Warren80ab8162011-08-22 18:26:12 -0400217 {
218 return TRUE;
219 }
220
Andrey Andreev80144bf2012-04-06 22:19:26 +0300221 return $this->conn_id->commit();
Timothy Warren80ab8162011-08-22 18:26:12 -0400222 }
223
224 // --------------------------------------------------------------------
225
226 /**
227 * Rollback Transaction
228 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400229 * @return bool
230 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200231 public function trans_rollback()
Timothy Warren80ab8162011-08-22 18:26:12 -0400232 {
Timothy Warren80ab8162011-08-22 18:26:12 -0400233 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreev80144bf2012-04-06 22:19:26 +0300234 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Timothy Warren80ab8162011-08-22 18:26:12 -0400235 {
236 return TRUE;
237 }
238
Andrey Andreev80144bf2012-04-06 22:19:26 +0300239 return $this->conn_id->rollBack();
Timothy Warren80ab8162011-08-22 18:26:12 -0400240 }
241
242 // --------------------------------------------------------------------
243
244 /**
245 * Escape String
246 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400247 * @param string
248 * @param bool whether or not the string will be used in a LIKE condition
249 * @return string
250 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200251 public function escape_str($str, $like = FALSE)
Timothy Warren80ab8162011-08-22 18:26:12 -0400252 {
253 if (is_array($str))
254 {
255 foreach ($str as $key => $val)
256 {
257 $str[$key] = $this->escape_str($val, $like);
258 }
259
260 return $str;
261 }
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200262
Andrey Andreev2387ed32012-04-07 00:11:14 +0300263 // Escape the string
Timothy Warren47663972011-10-05 16:44:50 -0400264 $str = $this->conn_id->quote($str);
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200265
Andrey Andreev2387ed32012-04-07 00:11:14 +0300266 // If there are duplicated quotes, trim them away
Andrey Andreev263d2eb2012-06-25 18:17:14 +0300267 if ($str[0] === "'")
Timothy Warrenec193322011-10-07 09:53:35 -0400268 {
269 $str = substr($str, 1, -1);
270 }
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200271
Timothy Warren80ab8162011-08-22 18:26:12 -0400272 // escape LIKE condition wildcards
273 if ($like === TRUE)
274 {
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200275 return str_replace(array($this->_like_escape_chr, '%', '_'),
276 array($this->_like_escape_chr.$this->_like_escape_chr, $this->_like_escape_chr.'%', $this->_like_escape_chr.'_'),
277 $str);
Timothy Warren80ab8162011-08-22 18:26:12 -0400278 }
279
280 return $str;
281 }
282
283 // --------------------------------------------------------------------
284
285 /**
286 * Affected Rows
287 *
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200288 * @return int
Timothy Warren80ab8162011-08-22 18:26:12 -0400289 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200290 public function affected_rows()
Timothy Warren80ab8162011-08-22 18:26:12 -0400291 {
Andrey Andreev2387ed32012-04-07 00:11:14 +0300292 return is_object($this->result_id) ? $this->result_id->rowCount() : 0;
Timothy Warren80ab8162011-08-22 18:26:12 -0400293 }
294
295 // --------------------------------------------------------------------
296
297 /**
298 * Insert ID
Andrey Andreeva39d6992012-03-01 19:11:39 +0200299 *
Andrey Andreev2387ed32012-04-07 00:11:14 +0300300 * @param string
Andrey Andreeva39d6992012-03-01 19:11:39 +0200301 * @return int
Timothy Warren80ab8162011-08-22 18:26:12 -0400302 */
Andrey Andreeva39d6992012-03-01 19:11:39 +0200303 public function insert_id($name = NULL)
Timothy Warren80ab8162011-08-22 18:26:12 -0400304 {
Andrey Andreeva39d6992012-03-01 19:11:39 +0200305 return $this->conn_id->lastInsertId($name);
Timothy Warren80ab8162011-08-22 18:26:12 -0400306 }
307
308 // --------------------------------------------------------------------
309
310 /**
Timothy Warren80ab8162011-08-22 18:26:12 -0400311 * Field data query
312 *
313 * Generates a platform-specific query so that the column data can be retrieved
314 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400315 * @param string the table name
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200316 * @return string
Timothy Warren80ab8162011-08-22 18:26:12 -0400317 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200318 protected function _field_data($table)
Timothy Warren80ab8162011-08-22 18:26:12 -0400319 {
Andrey Andreev50293052012-06-25 17:48:49 +0300320 return 'SELECT TOP 1 * FROM '.$this->protect_identifiers($table);
Timothy Warren80ab8162011-08-22 18:26:12 -0400321 }
322
323 // --------------------------------------------------------------------
324
325 /**
Andrey Andreev4be5de12012-03-02 15:45:41 +0200326 * Error
Timothy Warren80ab8162011-08-22 18:26:12 -0400327 *
Andrey Andreev4be5de12012-03-02 15:45:41 +0200328 * Returns an array containing code and message of the last
329 * database error that has occured.
Timothy Warren80ab8162011-08-22 18:26:12 -0400330 *
Andrey Andreev4be5de12012-03-02 15:45:41 +0200331 * @return array
Timothy Warren80ab8162011-08-22 18:26:12 -0400332 */
Andrey Andreev4be5de12012-03-02 15:45:41 +0200333 public function error()
Timothy Warren80ab8162011-08-22 18:26:12 -0400334 {
Andrey Andreev4be5de12012-03-02 15:45:41 +0200335 $error = array('code' => '00000', 'message' => '');
336 $pdo_error = $this->conn_id->errorInfo();
337
338 if (empty($pdo_error[0]))
339 {
340 return $error;
341 }
342
343 $error['code'] = isset($pdo_error[1]) ? $pdo_error[0].'/'.$pdo_error[1] : $pdo_error[0];
344 if (isset($pdo_error[2]))
345 {
346 $error['message'] = $pdo_error[2];
347 }
348
349 return $error;
Timothy Warren80ab8162011-08-22 18:26:12 -0400350 }
351
352 // --------------------------------------------------------------------
353
354 /**
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400355 * Update_Batch statement
356 *
357 * Generates a platform-specific batch update string from the supplied data
358 *
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400359 * @param string the table name
360 * @param array the update data
361 * @param array the where clause
362 * @return string
363 */
Andrey Andreevbd44d5a2012-03-20 22:59:29 +0200364 protected function _update_batch($table, $values, $index, $where = NULL)
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400365 {
Andrey Andreevdf8894f2012-06-25 16:18:50 +0300366 $ids = array();
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100367 $where = ($where !== '' && count($where) >=1) ? implode(" ", $where).' AND ' : '';
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400368
369 foreach ($values as $key => $val)
370 {
371 $ids[] = $val[$index];
372
373 foreach (array_keys($val) as $field)
374 {
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100375 if ($field !== $index)
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400376 {
377 $final[$field][] = 'WHEN '.$index.' = '.$val[$index].' THEN '.$val[$field];
378 }
379 }
380 }
381
Andrey Andreeve9f20952012-04-06 19:30:41 +0300382 $sql = 'UPDATE '.$table.' SET ';
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400383 $cases = '';
384
385 foreach ($final as $k => $v)
386 {
387 $cases .= $k.' = CASE '."\n";
Taufan Aditya18209332012-02-09 16:07:27 +0700388
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400389 foreach ($v as $row)
390 {
391 $cases .= $row."\n";
392 }
393
394 $cases .= 'ELSE '.$k.' END, ';
395 }
396
397 $sql .= substr($cases, 0, -2);
Timothy Warrenb5a43b02011-10-04 17:26:04 -0400398 $sql .= ' WHERE '.$where.$index.' IN ('.implode(',', $ids).')';
399
400 return $sql;
401 }
Timothy Warren80ab8162011-08-22 18:26:12 -0400402
Andrey Andreeve61b19f2012-06-25 18:11:39 +0300403 // --------------------------------------------------------------------
404
405 /**
406 * Truncate statement
407 *
408 * Generates a platform-specific truncate string from the supplied data
409 *
410 * If the database does not support the truncate() command,
411 * then this method maps to 'DELETE FROM table'
412 *
413 * @param string the table name
414 * @return string
415 */
416 protected function _truncate($table)
417 {
418 return 'TRUNCATE TABLE '.$table;
419 }
420
Timothy Warren80ab8162011-08-22 18:26:12 -0400421}
422
Timothy Warren80ab8162011-08-22 18:26:12 -0400423/* End of file pdo_driver.php */
Andrey Andreev79922c02012-05-23 12:27:17 +0300424/* Location: ./system/database/drivers/pdo/pdo_driver.php */