blob: bfd53ba59081412b2cb7185d193ce323f92b2d7b [file] [log] [blame]
Andrey Andreevb76029d2012-01-26 15:13:19 +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 Andreevb76029d2012-01-26 15:13:19 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreevb76029d2012-01-26 15:13:19 +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 * ODBC Database Adapter Class
30 *
31 * Note: _DB is an extender class that the app controller
32 * creates dynamically based on whether the active record
33 * class is being used or not.
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 */
41class CI_DB_odbc_driver extends CI_DB {
42
Andrey Andreevb76029d2012-01-26 15:13:19 +020043 public $dbdriver = 'odbc';
Barry Mienydd671972010-10-04 16:33:58 +020044
Derek Allard2067d1a2008-11-13 22:59:24 +000045 // the character used to excape - not necessary for ODBC
Andrey Andreevb76029d2012-01-26 15:13:19 +020046 protected $_escape_char = '';
Barry Mienydd671972010-10-04 16:33:58 +020047
Derek Jonese4ed5832009-02-20 21:44:59 +000048 // clause and character used for LIKE escape sequences
Andrey Andreev5f356bf2012-03-20 14:32:27 +020049 protected $_like_escape_str = " {escape '%s'} ";
Andrey Andreevb76029d2012-01-26 15:13:19 +020050 protected $_like_escape_chr = '!';
Barry Mienydd671972010-10-04 16:33:58 +020051
Derek Allard2067d1a2008-11-13 22:59:24 +000052 /**
53 * The syntax to count rows is slightly different across different
54 * database engines, so this string appears in each driver and is
55 * used for the count_all() and count_all_results() functions.
56 */
Andrey Andreevb76029d2012-01-26 15:13:19 +020057 protected $_count_string = 'SELECT COUNT(*) AS ';
58 protected $_random_keyword;
Derek Allard2067d1a2008-11-13 22:59:24 +000059
Andrey Andreev5f356bf2012-03-20 14:32:27 +020060 public function __construct($params)
Derek Allard2067d1a2008-11-13 22:59:24 +000061 {
Timothy Warrena2097a02011-10-10 10:10:46 -040062 parent::__construct($params);
Barry Mienydd671972010-10-04 16:33:58 +020063
Derek Allard2067d1a2008-11-13 22:59:24 +000064 $this->_random_keyword = ' RND('.time().')'; // database specific random keyword
Andrey Andreev46f6dbc2012-02-13 01:39:53 +020065
66 // Legacy support for DSN in the hostname field
67 if ($this->dsn == '')
68 {
69 $this->dsn = $this->hostname;
70 }
Derek Allard2067d1a2008-11-13 22:59:24 +000071 }
72
73 /**
74 * Non-persistent database connection
75 *
Derek Allard2067d1a2008-11-13 22:59:24 +000076 * @return resource
Barry Mienydd671972010-10-04 16:33:58 +020077 */
Andrey Andreevb76029d2012-01-26 15:13:19 +020078 public function db_connect()
Derek Allard2067d1a2008-11-13 22:59:24 +000079 {
Andrey Andreev46f6dbc2012-02-13 01:39:53 +020080 return @odbc_connect($this->dsn, $this->username, $this->password);
Derek Allard2067d1a2008-11-13 22:59:24 +000081 }
Barry Mienydd671972010-10-04 16:33:58 +020082
Derek Allard2067d1a2008-11-13 22:59:24 +000083 // --------------------------------------------------------------------
84
85 /**
86 * Persistent database connection
87 *
Derek Allard2067d1a2008-11-13 22:59:24 +000088 * @return resource
Barry Mienydd671972010-10-04 16:33:58 +020089 */
Andrey Andreevb76029d2012-01-26 15:13:19 +020090 public function db_pconnect()
Derek Allard2067d1a2008-11-13 22:59:24 +000091 {
Andrey Andreev46f6dbc2012-02-13 01:39:53 +020092 return @odbc_pconnect($this->dsn, $this->username, $this->password);
Derek Allard2067d1a2008-11-13 22:59:24 +000093 }
Barry Mienydd671972010-10-04 16:33:58 +020094
Derek Allard2067d1a2008-11-13 22:59:24 +000095 // --------------------------------------------------------------------
96
97 /**
Derek Allard2067d1a2008-11-13 22:59:24 +000098 * Execute the query
99 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000100 * @param string an SQL query
101 * @return resource
Barry Mienydd671972010-10-04 16:33:58 +0200102 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200103 protected function _execute($sql)
Derek Allard2067d1a2008-11-13 22:59:24 +0000104 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000105 return @odbc_exec($this->conn_id, $sql);
Derek Allard2067d1a2008-11-13 22:59:24 +0000106 }
107
108 // --------------------------------------------------------------------
109
110 /**
111 * Begin Transaction
112 *
Barry Mienydd671972010-10-04 16:33:58 +0200113 * @return bool
114 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200115 public function trans_begin($test_mode = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000116 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000117 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreevb76029d2012-01-26 15:13:19 +0200118 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000119 {
120 return TRUE;
121 }
122
123 // Reset the transaction failure flag.
124 // If the $test_mode flag is set to TRUE transactions will be rolled back
125 // even if the queries produce a successful result.
Andrey Andreevb76029d2012-01-26 15:13:19 +0200126 $this->_trans_failure = ($test_mode === TRUE);
Derek Allard2067d1a2008-11-13 22:59:24 +0000127
128 return odbc_autocommit($this->conn_id, FALSE);
129 }
130
131 // --------------------------------------------------------------------
132
133 /**
134 * Commit Transaction
135 *
Barry Mienydd671972010-10-04 16:33:58 +0200136 * @return bool
137 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200138 public function trans_commit()
Derek Allard2067d1a2008-11-13 22:59:24 +0000139 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000140 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreevb76029d2012-01-26 15:13:19 +0200141 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000142 {
143 return TRUE;
144 }
145
146 $ret = odbc_commit($this->conn_id);
147 odbc_autocommit($this->conn_id, TRUE);
148 return $ret;
149 }
150
151 // --------------------------------------------------------------------
152
153 /**
154 * Rollback Transaction
155 *
Barry Mienydd671972010-10-04 16:33:58 +0200156 * @return bool
157 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200158 public function trans_rollback()
Derek Allard2067d1a2008-11-13 22:59:24 +0000159 {
Derek Allard2067d1a2008-11-13 22:59:24 +0000160 // When transactions are nested we only begin/commit/rollback the outermost ones
Andrey Andreevb76029d2012-01-26 15:13:19 +0200161 if ( ! $this->trans_enabled OR $this->_trans_depth > 0)
Derek Allard2067d1a2008-11-13 22:59:24 +0000162 {
163 return TRUE;
164 }
165
166 $ret = odbc_rollback($this->conn_id);
167 odbc_autocommit($this->conn_id, TRUE);
168 return $ret;
169 }
170
171 // --------------------------------------------------------------------
172
173 /**
174 * Escape String
175 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000176 * @param string
Derek Jonese4ed5832009-02-20 21:44:59 +0000177 * @param bool whether or not the string will be used in a LIKE condition
Derek Allard2067d1a2008-11-13 22:59:24 +0000178 * @return string
179 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200180 public function escape_str($str, $like = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000181 {
Derek Jonese4ed5832009-02-20 21:44:59 +0000182 if (is_array($str))
183 {
Pascal Krietec3a4a8d2011-02-14 13:40:08 -0500184 foreach ($str as $key => $val)
Barry Mienydd671972010-10-04 16:33:58 +0200185 {
Derek Jonese4ed5832009-02-20 21:44:59 +0000186 $str[$key] = $this->escape_str($val, $like);
Barry Mienydd671972010-10-04 16:33:58 +0200187 }
188
189 return $str;
190 }
191
Greg Aker757dda62010-04-14 19:06:19 -0500192 $str = remove_invisible_characters($str);
Barry Mienydd671972010-10-04 16:33:58 +0200193
Derek Jonese4ed5832009-02-20 21:44:59 +0000194 // escape LIKE condition wildcards
195 if ($like === TRUE)
196 {
Andrey Andreev5e18e892012-03-09 14:25:00 +0200197 return str_replace(array($this->_like_escape_chr, '%', '_'),
198 array($this->_like_escape_chr.$this->_like_escape_chr, $this->_like_escape_chr.'%', $this->_like_escape_chr.'_'),
Andrey Andreevb76029d2012-01-26 15:13:19 +0200199 $str);
Derek Jonese4ed5832009-02-20 21:44:59 +0000200 }
Barry Mienydd671972010-10-04 16:33:58 +0200201
Derek Jonese4ed5832009-02-20 21:44:59 +0000202 return $str;
Derek Allard2067d1a2008-11-13 22:59:24 +0000203 }
Barry Mienydd671972010-10-04 16:33:58 +0200204
Derek Allard2067d1a2008-11-13 22:59:24 +0000205 // --------------------------------------------------------------------
206
207 /**
208 * Affected Rows
209 *
Andrey Andreevb76029d2012-01-26 15:13:19 +0200210 * @return int
Derek Allard2067d1a2008-11-13 22:59:24 +0000211 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200212 public function affected_rows()
Derek Allard2067d1a2008-11-13 22:59:24 +0000213 {
214 return @odbc_num_rows($this->conn_id);
215 }
Barry Mienydd671972010-10-04 16:33:58 +0200216
Derek Allard2067d1a2008-11-13 22:59:24 +0000217 // --------------------------------------------------------------------
218
219 /**
220 * Insert ID
221 *
Andrey Andreev8af76662012-03-05 14:33:41 +0200222 * @return bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000223 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200224 public function insert_id()
Derek Allard2067d1a2008-11-13 22:59:24 +0000225 {
Andrey Andreev8af76662012-03-05 14:33:41 +0200226 return ($this->db->db_debug) ? $this->db->display_error('db_unsuported_feature') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +0000227 }
228
229 // --------------------------------------------------------------------
230
231 /**
232 * "Count All" query
233 *
234 * Generates a platform-specific query string that counts all records in
235 * the specified database
236 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000237 * @param string
Andrey Andreevb76029d2012-01-26 15:13:19 +0200238 * @return int
Derek Allard2067d1a2008-11-13 22:59:24 +0000239 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200240 public function count_all($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000241 {
242 if ($table == '')
Derek Allarde37ab382009-02-03 16:13:57 +0000243 {
244 return 0;
245 }
246
Andrey Andreev97715482012-03-09 14:21:54 +0200247 $query = $this->query($this->_count_string.$this->protect_identifiers('numrows').' FROM '.$this->protect_identifiers($table, TRUE, NULL, FALSE));
Derek Allard2067d1a2008-11-13 22:59:24 +0000248 if ($query->num_rows() == 0)
Derek Allarde37ab382009-02-03 16:13:57 +0000249 {
250 return 0;
251 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000252
Andrey Andreevb76029d2012-01-26 15:13:19 +0200253 $query = $query->row();
Greg Aker90248ab2011-08-20 14:23:14 -0500254 $this->_reset_select();
Andrey Andreevb76029d2012-01-26 15:13:19 +0200255 return (int) $query->numrows;
Derek Allard2067d1a2008-11-13 22:59:24 +0000256 }
257
258 // --------------------------------------------------------------------
259
260 /**
261 * Show table query
262 *
263 * Generates a platform-specific query string so that the table names can be fetched
264 *
Andrey Andreev5f356bf2012-03-20 14:32:27 +0200265 * @param bool
Derek Allard2067d1a2008-11-13 22:59:24 +0000266 * @return string
267 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200268 protected function _list_tables($prefix_limit = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000269 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200270 $sql = 'SHOW TABLES FROM `'.$this->database.'`';
Derek Allard2067d1a2008-11-13 22:59:24 +0000271
Andrey Andreevb76029d2012-01-26 15:13:19 +0200272 if ($prefix_limit !== FALSE && $this->dbprefix != '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000273 {
Greg Aker0d424892010-01-26 02:14:44 +0000274 //$sql .= " LIKE '".$this->escape_like_str($this->dbprefix)."%' ".sprintf($this->_like_escape_str, $this->_like_escape_chr);
Derek Allard2067d1a2008-11-13 22:59:24 +0000275 return FALSE; // not currently supported
276 }
Barry Mienydd671972010-10-04 16:33:58 +0200277
Derek Allard2067d1a2008-11-13 22:59:24 +0000278 return $sql;
279 }
Barry Mienydd671972010-10-04 16:33:58 +0200280
Derek Allard2067d1a2008-11-13 22:59:24 +0000281 // --------------------------------------------------------------------
282
283 /**
284 * Show column query
285 *
286 * Generates a platform-specific query string so that the column names can be fetched
287 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000288 * @param string the table name
289 * @return string
290 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200291 protected function _list_columns($table = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000292 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200293 return 'SHOW COLUMNS FROM '.$table;
Derek Allard2067d1a2008-11-13 22:59:24 +0000294 }
295
296 // --------------------------------------------------------------------
297
298 /**
299 * Field data query
300 *
301 * Generates a platform-specific query so that the column data can be retrieved
302 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000303 * @param string the table name
Andrey Andreevb76029d2012-01-26 15:13:19 +0200304 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000305 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200306 protected function _field_data($table)
Derek Allard2067d1a2008-11-13 22:59:24 +0000307 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200308 return 'SELECT TOP 1 FROM '.$table;
Derek Allard2067d1a2008-11-13 22:59:24 +0000309 }
310
311 // --------------------------------------------------------------------
312
313 /**
Andrey Andreev4be5de12012-03-02 15:45:41 +0200314 * Error
Derek Allard2067d1a2008-11-13 22:59:24 +0000315 *
Andrey Andreev4be5de12012-03-02 15:45:41 +0200316 * Returns an array containing code and message of the last
317 * database error that has occured.
Derek Allard2067d1a2008-11-13 22:59:24 +0000318 *
Andrey Andreev4be5de12012-03-02 15:45:41 +0200319 * @return array
Derek Allard2067d1a2008-11-13 22:59:24 +0000320 */
Andrey Andreev4be5de12012-03-02 15:45:41 +0200321 public function error()
Derek Allard2067d1a2008-11-13 22:59:24 +0000322 {
Andrey Andreev4be5de12012-03-02 15:45:41 +0200323 return array('code' => odbc_error($this->conn_id), 'message' => odbc_errormsg($this->conn_id));
Derek Allard2067d1a2008-11-13 22:59:24 +0000324 }
325
326 // --------------------------------------------------------------------
327
328 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000329 * From Tables
330 *
331 * This function implicitly groups FROM tables so there is no confusion
332 * about operator precedence in harmony with SQL standards
333 *
Andrey Andreev5f356bf2012-03-20 14:32:27 +0200334 * @param array
Andrey Andreevb76029d2012-01-26 15:13:19 +0200335 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000336 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200337 protected function _from_tables($tables)
Derek Allard2067d1a2008-11-13 22:59:24 +0000338 {
339 if ( ! is_array($tables))
340 {
341 $tables = array($tables);
342 }
Barry Mienydd671972010-10-04 16:33:58 +0200343
Derek Allard2067d1a2008-11-13 22:59:24 +0000344 return '('.implode(', ', $tables).')';
345 }
346
347 // --------------------------------------------------------------------
Barry Mienydd671972010-10-04 16:33:58 +0200348
Derek Allard2067d1a2008-11-13 22:59:24 +0000349 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000350 * Truncate statement
351 *
352 * Generates a platform-specific truncate string from the supplied data
Andrey Andreeva6fe36e2012-04-05 16:00:32 +0300353 *
354 * If the database does not support the truncate() command,
355 * then this method maps to 'DELETE FROM table'
Derek Allard2067d1a2008-11-13 22:59:24 +0000356 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000357 * @param string the table name
358 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200359 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200360 protected function _truncate($table)
Derek Allard2067d1a2008-11-13 22:59:24 +0000361 {
Andrey Andreeva6fe36e2012-04-05 16:00:32 +0300362 return 'DELETE FROM '.$table;
Derek Allard2067d1a2008-11-13 22:59:24 +0000363 }
Barry Mienydd671972010-10-04 16:33:58 +0200364
Derek Allard2067d1a2008-11-13 22:59:24 +0000365 // --------------------------------------------------------------------
366
367 /**
368 * Delete statement
369 *
370 * Generates a platform-specific delete string from the supplied data
371 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000372 * @param string the table name
373 * @param array the where clause
374 * @param string the limit clause
375 * @return string
Barry Mienydd671972010-10-04 16:33:58 +0200376 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200377 protected function _delete($table, $where = array(), $like = array(), $limit = FALSE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000378 {
379 $conditions = '';
380
381 if (count($where) > 0 OR count($like) > 0)
382 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200383 $conditions = "\nWHERE ".implode("\n", $this->ar_where);
Derek Allard2067d1a2008-11-13 22:59:24 +0000384
385 if (count($where) > 0 && count($like) > 0)
386 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200387 $conditions .= ' AND ';
Derek Allard2067d1a2008-11-13 22:59:24 +0000388 }
389 $conditions .= implode("\n", $like);
390 }
391
Andrey Andreevb76029d2012-01-26 15:13:19 +0200392 return 'DELETE FROM '.$table.$conditions.( ! $limit ? '' : ' LIMIT '.$limit);
Derek Allard2067d1a2008-11-13 22:59:24 +0000393 }
394
395 // --------------------------------------------------------------------
396
397 /**
398 * Limit string
399 *
400 * Generates a platform-specific LIMIT clause
401 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000402 * @param string the sql query string
Andrey Andreevb76029d2012-01-26 15:13:19 +0200403 * @param int the number of rows to limit the query to
404 * @param int the offset value
Derek Allard2067d1a2008-11-13 22:59:24 +0000405 * @return string
406 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200407 protected function _limit($sql, $limit, $offset)
Derek Allard2067d1a2008-11-13 22:59:24 +0000408 {
Andrey Andreevb76029d2012-01-26 15:13:19 +0200409 return $sql.($offset == 0 ? '' : $offset.', ').$limit;
Derek Allard2067d1a2008-11-13 22:59:24 +0000410 }
411
412 // --------------------------------------------------------------------
413
414 /**
415 * Close DB Connection
416 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000417 * @param resource
418 * @return void
419 */
Andrey Andreevb76029d2012-01-26 15:13:19 +0200420 protected function _close($conn_id)
Derek Allard2067d1a2008-11-13 22:59:24 +0000421 {
422 @odbc_close($conn_id);
423 }
424
Derek Allard2067d1a2008-11-13 22:59:24 +0000425}
426
Derek Allard2067d1a2008-11-13 22:59:24 +0000427/* End of file odbc_driver.php */
Andrey Andreev19aee032012-03-20 15:31:42 +0200428/* Location: ./system/database/drivers/odbc/odbc_driver.php */