blob: 3c6f01542dfa2beeada9acef086492e85f297d9d [file] [log] [blame]
Derek Jones0b59f272008-05-13 04:22:33 +00001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard5c3905b2007-03-24 11:08:55 +00002/**
Derek Allardd2df9bc2007-04-15 17:41:17 +00003 * CodeIgniter
Derek Allard5c3905b2007-03-24 11:08:55 +00004 *
5 * An open source application development framework for PHP 4.3.2 or newer
6 *
7 * @package CodeIgniter
Derek Allard3d879d52008-01-18 19:41:32 +00008 * @author ExpressionEngine Dev Team
Rick Ellis9ba2bf22008-09-12 23:34:39 +00009 * @copyright Copyright (c) 2008, EllisLab, Inc.
Derek Jones7a9193a2008-01-21 18:39:20 +000010 * @license http://codeigniter.com/user_guide/license.html
11 * @link http://codeigniter.com
Derek Allard5c3905b2007-03-24 11:08:55 +000012 * @since Version 1.0
13 * @filesource
14 */
15
16// ------------------------------------------------------------------------
17
18/**
19 * ODBC Database Adapter Class
20 *
21 * Note: _DB is an extender class that the app controller
22 * creates dynamically based on whether the active record
23 * class is being used or not.
24 *
25 * @package CodeIgniter
26 * @subpackage Drivers
27 * @category Database
Derek Allard3d879d52008-01-18 19:41:32 +000028 * @author ExpressionEngine Dev Team
Derek Jones7a9193a2008-01-21 18:39:20 +000029 * @link http://codeigniter.com/user_guide/database/
Derek Allard5c3905b2007-03-24 11:08:55 +000030 */
31class CI_DB_odbc_driver extends CI_DB {
32
Rick Ellis5aa8c602008-10-07 01:24:07 +000033 var $dbdriver = 'odbc';
Rick Ellis605a07a2008-10-17 04:07:54 +000034
35 // the character used to excape - not necessary for ODBC
36 var $_escape_char = '';
Rick Ellis5aa8c602008-10-07 01:24:07 +000037
Derek Allard5c3905b2007-03-24 11:08:55 +000038 /**
Derek Allard694b5b82007-12-18 15:58:03 +000039 * The syntax to count rows is slightly different across different
40 * database engines, so this string appears in each driver and is
41 * used for the count_all() and count_all_results() functions.
42 */
Derek Allard39b622d2008-01-16 21:10:09 +000043 var $_count_string = "SELECT COUNT(*) AS ";
44 var $_random_keyword;
45
46
Rick Ellisceb6f0b2008-10-07 00:48:19 +000047 function CI_DB_odbc_driver($params)
Derek Allard39b622d2008-01-16 21:10:09 +000048 {
Rick Ellis5e189cc2008-10-17 04:30:55 +000049 parent::CI_DB($params);
Rick Ellis1e2c33e2008-10-17 08:10:19 +000050
Derek Allardb52bdc42008-01-27 14:58:24 +000051 $this->_random_keyword = ' RND('.time().')'; // database specific random keyword
Derek Allard39b622d2008-01-16 21:10:09 +000052 }
Derek Allard694b5b82007-12-18 15:58:03 +000053
54 /**
Derek Allard5c3905b2007-03-24 11:08:55 +000055 * Non-persistent database connection
56 *
57 * @access private called by the base class
58 * @return resource
59 */
60 function db_connect()
61 {
62 return @odbc_connect($this->hostname, $this->username, $this->password);
63 }
64
65 // --------------------------------------------------------------------
66
67 /**
68 * Persistent database connection
69 *
70 * @access private called by the base class
71 * @return resource
72 */
73 function db_pconnect()
74 {
75 return @odbc_pconnect($this->hostname, $this->username, $this->password);
76 }
77
78 // --------------------------------------------------------------------
79
80 /**
81 * Select the database
82 *
83 * @access private called by the base class
84 * @return resource
85 */
86 function db_select()
87 {
88 // Not needed for ODBC
89 return TRUE;
90 }
91
92 // --------------------------------------------------------------------
93
94 /**
Derek Allard39b622d2008-01-16 21:10:09 +000095 * Set client character set
96 *
97 * @access public
98 * @param string
99 * @param string
100 * @return resource
101 */
102 function db_set_charset($charset, $collation)
103 {
Rick Ellisff734012008-09-30 20:38:12 +0000104 // @todo - add support if needed
Derek Allard39b622d2008-01-16 21:10:09 +0000105 return TRUE;
106 }
107
108 // --------------------------------------------------------------------
109
110 /**
Derek Allard5c3905b2007-03-24 11:08:55 +0000111 * Version number query string
112 *
113 * @access public
114 * @return string
115 */
116 function _version()
117 {
118 return "SELECT version() AS ver";
119 }
120
121 // --------------------------------------------------------------------
122
123 /**
124 * Execute the query
125 *
126 * @access private called by the base class
127 * @param string an SQL query
128 * @return resource
129 */
130 function _execute($sql)
131 {
132 $sql = $this->_prep_query($sql);
133 return @odbc_exec($this->conn_id, $sql);
134 }
135
136 // --------------------------------------------------------------------
137
138 /**
139 * Prep the query
140 *
141 * If needed, each database adapter can prep the query string
142 *
143 * @access private called by execute()
144 * @param string an SQL query
145 * @return string
146 */
147 function _prep_query($sql)
148 {
149 return $sql;
150 }
151
152 // --------------------------------------------------------------------
153
154 /**
155 * Begin Transaction
156 *
157 * @access public
158 * @return bool
159 */
160 function trans_begin($test_mode = FALSE)
161 {
Derek Jones0b59f272008-05-13 04:22:33 +0000162 if ( ! $this->trans_enabled)
Derek Allard5c3905b2007-03-24 11:08:55 +0000163 {
164 return TRUE;
165 }
166
167 // When transactions are nested we only begin/commit/rollback the outermost ones
168 if ($this->_trans_depth > 0)
169 {
170 return TRUE;
171 }
172
173 // Reset the transaction failure flag.
174 // If the $test_mode flag is set to TRUE transactions will be rolled back
175 // even if the queries produce a successful result.
176 $this->_trans_failure = ($test_mode === TRUE) ? TRUE : FALSE;
177
178 return odbc_autocommit($this->conn_id, FALSE);
179 }
180
181 // --------------------------------------------------------------------
182
183 /**
184 * Commit Transaction
185 *
186 * @access public
187 * @return bool
188 */
189 function trans_commit()
190 {
Derek Jones0b59f272008-05-13 04:22:33 +0000191 if ( ! $this->trans_enabled)
Derek Allard5c3905b2007-03-24 11:08:55 +0000192 {
193 return TRUE;
194 }
195
196 // When transactions are nested we only begin/commit/rollback the outermost ones
197 if ($this->_trans_depth > 0)
198 {
199 return TRUE;
200 }
201
202 $ret = odbc_commit($this->conn_id);
203 odbc_autocommit($this->conn_id, TRUE);
204 return $ret;
205 }
206
207 // --------------------------------------------------------------------
208
209 /**
210 * Rollback Transaction
211 *
212 * @access public
213 * @return bool
214 */
215 function trans_rollback()
216 {
Derek Jones0b59f272008-05-13 04:22:33 +0000217 if ( ! $this->trans_enabled)
Derek Allard5c3905b2007-03-24 11:08:55 +0000218 {
219 return TRUE;
220 }
221
222 // When transactions are nested we only begin/commit/rollback the outermost ones
223 if ($this->_trans_depth > 0)
224 {
225 return TRUE;
226 }
227
228 $ret = odbc_rollback($this->conn_id);
229 odbc_autocommit($this->conn_id, TRUE);
230 return $ret;
231 }
232
233 // --------------------------------------------------------------------
234
235 /**
236 * Escape String
237 *
238 * @access public
239 * @param string
240 * @return string
241 */
242 function escape_str($str)
243 {
Rick Ellis06a2e742008-10-07 01:04:15 +0000244 // Access the CI object
Rick Ellisca86a7c2008-10-07 01:16:57 +0000245 $CI =& get_instance();
Rick Ellis06a2e742008-10-07 01:04:15 +0000246
Derek Allard5c3905b2007-03-24 11:08:55 +0000247 // ODBC doesn't require escaping
Rick Ellis06a2e742008-10-07 01:04:15 +0000248 return $CI->_remove_invisible_characters($str);
Derek Allard5c3905b2007-03-24 11:08:55 +0000249 }
250
251 // --------------------------------------------------------------------
252
253 /**
254 * Affected Rows
255 *
256 * @access public
257 * @return integer
258 */
259 function affected_rows()
260 {
261 return @odbc_num_rows($this->conn_id);
262 }
263
264 // --------------------------------------------------------------------
265
266 /**
267 * Insert ID
268 *
269 * @access public
270 * @return integer
271 */
272 function insert_id()
273 {
274 return @odbc_insert_id($this->conn_id);
275 }
276
277 // --------------------------------------------------------------------
278
279 /**
280 * "Count All" query
281 *
282 * Generates a platform-specific query string that counts all records in
283 * the specified database
284 *
285 * @access public
286 * @param string
287 * @return string
288 */
289 function count_all($table = '')
290 {
291 if ($table == '')
292 return '0';
293
Rick Ellis605a07a2008-10-17 04:07:54 +0000294 $query = $this->query($this->_count_string . $this->_protect_identifiers('numrows'). " FROM " . $this->_protect_identifiers($table, TRUE, NULL, FALSE));
Derek Allardf6cd45c2008-01-18 14:31:51 +0000295
Derek Allard5c3905b2007-03-24 11:08:55 +0000296 if ($query->num_rows() == 0)
297 return '0';
298
299 $row = $query->row();
300 return $row->numrows;
301 }
302
303 // --------------------------------------------------------------------
304
305 /**
306 * Show table query
307 *
308 * Generates a platform-specific query string so that the table names can be fetched
309 *
310 * @access private
Derek Allard39b622d2008-01-16 21:10:09 +0000311 * @param boolean
Derek Allard5c3905b2007-03-24 11:08:55 +0000312 * @return string
313 */
Derek Allard39b622d2008-01-16 21:10:09 +0000314 function _list_tables($prefix_limit = FALSE)
Derek Allard5c3905b2007-03-24 11:08:55 +0000315 {
Derek Allard39b622d2008-01-16 21:10:09 +0000316 $sql = "SHOW TABLES FROM `".$this->database."`";
317
318 if ($prefix_limit !== FALSE AND $this->dbprefix != '')
319 {
320 //$sql .= " LIKE '".$this->dbprefix."%'";
321 return FALSE; // not currently supported
322 }
323
324 return $sql;
Derek Allard5c3905b2007-03-24 11:08:55 +0000325 }
326
327 // --------------------------------------------------------------------
328
329 /**
330 * Show column query
331 *
332 * Generates a platform-specific query string so that the column names can be fetched
333 *
334 * @access public
335 * @param string the table name
336 * @return string
337 */
338 function _list_columns($table = '')
339 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000340 return "SHOW COLUMNS FROM ".$table;
Derek Allard5c3905b2007-03-24 11:08:55 +0000341 }
342
343 // --------------------------------------------------------------------
344
345 /**
346 * Field data query
347 *
348 * Generates a platform-specific query so that the column data can be retrieved
349 *
350 * @access public
351 * @param string the table name
352 * @return object
353 */
354 function _field_data($table)
355 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000356 return "SELECT TOP 1 FROM ".$table;
Derek Allard5c3905b2007-03-24 11:08:55 +0000357 }
358
359 // --------------------------------------------------------------------
360
361 /**
362 * The error message string
363 *
364 * @access private
365 * @return string
366 */
367 function _error_message()
368 {
369 return odbc_errormsg($this->conn_id);
370 }
371
372 // --------------------------------------------------------------------
373
374 /**
375 * The error message number
376 *
377 * @access private
378 * @return integer
379 */
380 function _error_number()
381 {
382 return odbc_error($this->conn_id);
383 }
Rick Ellis605a07a2008-10-17 04:07:54 +0000384
Rick Ellis52dc8ca2008-09-30 19:53:52 +0000385 // --------------------------------------------------------------------
386
387 /**
Rick Ellis605a07a2008-10-17 04:07:54 +0000388 * Escape the SQL Identifiers
Rick Ellis52dc8ca2008-09-30 19:53:52 +0000389 *
Rick Ellis605a07a2008-10-17 04:07:54 +0000390 * This function escapes column and table names
Rick Ellis52dc8ca2008-09-30 19:53:52 +0000391 *
392 * @access private
Rick Ellis605a07a2008-10-17 04:07:54 +0000393 * @param string
Rick Ellis52dc8ca2008-09-30 19:53:52 +0000394 * @return string
395 */
Rick Ellis605a07a2008-10-17 04:07:54 +0000396 function _escape_identifiers($item)
Rick Ellis52dc8ca2008-09-30 19:53:52 +0000397 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000398 if ($this->_escape_char == '')
Derek Allard39b622d2008-01-16 21:10:09 +0000399 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000400 return $item;
401 }
Rick Ellisa0e86292008-10-26 22:46:55 +0000402
403 foreach ($this->_reserved_identifiers as $id)
404 {
405 if (strpos($item, '.'.$id) !== FALSE)
406 {
407 $str = $this->_escape_char. str_replace('.', $this->_escape_char.'.', $item);
408
409 // remove duplicates if the user already included the escape
410 return preg_replace('/['.$this->_escape_char.']+/', $this->_escape_char, $str);
411 }
412 }
Rick Ellis605a07a2008-10-17 04:07:54 +0000413
414 if (strpos($item, '.') !== FALSE)
Derek Allard39b622d2008-01-16 21:10:09 +0000415 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000416 $str = $this->_escape_char.str_replace('.', $this->_escape_char.'.'.$this->_escape_char, $item).$this->_escape_char;
Derek Allard61579382008-01-16 22:22:42 +0000417 }
418 else
419 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000420 $str = $this->_escape_char.$item.$this->_escape_char;
Derek Allard39b622d2008-01-16 21:10:09 +0000421 }
Derek Allard39b622d2008-01-16 21:10:09 +0000422
Rick Ellis605a07a2008-10-17 04:07:54 +0000423 // remove duplicates if the user already included the escape
424 return preg_replace('/['.$this->_escape_char.']+/', $this->_escape_char, $str);
Derek Allard39b622d2008-01-16 21:10:09 +0000425 }
426
427 // --------------------------------------------------------------------
428
429 /**
Derek Jonesc6ad0232008-01-29 18:44:54 +0000430 * From Tables
431 *
432 * This function implicitly groups FROM tables so there is no confusion
433 * about operator precedence in harmony with SQL standards
434 *
435 * @access public
436 * @param type
437 * @return type
438 */
439 function _from_tables($tables)
440 {
Derek Jones0b59f272008-05-13 04:22:33 +0000441 if ( ! is_array($tables))
Derek Jonesc6ad0232008-01-29 18:44:54 +0000442 {
443 $tables = array($tables);
444 }
445
446 return '('.implode(', ', $tables).')';
447 }
448
449 // --------------------------------------------------------------------
450
451 /**
Derek Allard5c3905b2007-03-24 11:08:55 +0000452 * Insert statement
453 *
454 * Generates a platform-specific insert string from the supplied data
455 *
456 * @access public
457 * @param string the table name
458 * @param array the insert keys
459 * @param array the insert values
460 * @return string
461 */
462 function _insert($table, $keys, $values)
463 {
Rick Ellis605a07a2008-10-17 04:07:54 +0000464 return "INSERT INTO ".$table." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
Derek Allard5c3905b2007-03-24 11:08:55 +0000465 }
466
467 // --------------------------------------------------------------------
468
469 /**
470 * Update statement
471 *
472 * Generates a platform-specific update string from the supplied data
473 *
474 * @access public
475 * @param string the table name
476 * @param array the update data
477 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000478 * @param array the orderby clause
479 * @param array the limit clause
Derek Allard5c3905b2007-03-24 11:08:55 +0000480 * @return string
481 */
Derek Allard39b622d2008-01-16 21:10:09 +0000482 function _update($table, $values, $where, $orderby = array(), $limit = FALSE)
Derek Allard5c3905b2007-03-24 11:08:55 +0000483 {
484 foreach($values as $key => $val)
485 {
486 $valstr[] = $key." = ".$val;
487 }
Derek Allardda6d2402007-12-19 14:49:29 +0000488
Derek Jones0b59f272008-05-13 04:22:33 +0000489 $limit = ( ! $limit) ? '' : ' LIMIT '.$limit;
Derek Allard39b622d2008-01-16 21:10:09 +0000490
491 $orderby = (count($orderby) >= 1)?' ORDER BY '.implode(", ", $orderby):'';
Derek Allard5c3905b2007-03-24 11:08:55 +0000492
Rick Ellis605a07a2008-10-17 04:07:54 +0000493 $sql = "UPDATE ".$table." SET ".implode(', ', $valstr);
494
Derek Allard32cf7eb2008-02-05 16:03:50 +0000495 $sql .= ($where != '' AND count($where) >=1) ? " WHERE ".implode(" ", $where) : '';
Rick Ellis605a07a2008-10-17 04:07:54 +0000496
Derek Allard32cf7eb2008-02-05 16:03:50 +0000497 $sql .= $orderby.$limit;
498
499 return $sql;
Derek Allard39b622d2008-01-16 21:10:09 +0000500 }
501
502
503 // --------------------------------------------------------------------
504
505 /**
506 * Truncate statement
507 *
508 * Generates a platform-specific truncate string from the supplied data
509 * If the database does not support the truncate() command
510 * This function maps to "DELETE FROM table"
511 *
512 * @access public
513 * @param string the table name
514 * @return string
515 */
516 function _truncate($table)
517 {
518 return $this->_delete($table);
Derek Allard5c3905b2007-03-24 11:08:55 +0000519 }
520
521 // --------------------------------------------------------------------
522
523 /**
524 * Delete statement
525 *
526 * Generates a platform-specific delete string from the supplied data
527 *
528 * @access public
529 * @param string the table name
530 * @param array the where clause
Derek Allard39b622d2008-01-16 21:10:09 +0000531 * @param string the limit clause
Derek Allard5c3905b2007-03-24 11:08:55 +0000532 * @return string
533 */
Derek Allard39b622d2008-01-16 21:10:09 +0000534 function _delete($table, $where = array(), $like = array(), $limit = FALSE)
Derek Allard5c3905b2007-03-24 11:08:55 +0000535 {
Derek Allard39b622d2008-01-16 21:10:09 +0000536 $conditions = '';
537
Derek Jones0b59f272008-05-13 04:22:33 +0000538 if (count($where) > 0 OR count($like) > 0)
Derek Allard39b622d2008-01-16 21:10:09 +0000539 {
540 $conditions = "\nWHERE ";
541 $conditions .= implode("\n", $this->ar_where);
542
543 if (count($where) > 0 && count($like) > 0)
544 {
545 $conditions .= " AND ";
546 }
547 $conditions .= implode("\n", $like);
548 }
549
Derek Jones0b59f272008-05-13 04:22:33 +0000550 $limit = ( ! $limit) ? '' : ' LIMIT '.$limit;
Derek Allarde77d77c2007-12-19 15:01:55 +0000551
Derek Allard39b622d2008-01-16 21:10:09 +0000552 return "DELETE FROM ".$table.$conditions.$limit;
Derek Allard5c3905b2007-03-24 11:08:55 +0000553 }
554
555 // --------------------------------------------------------------------
556
557 /**
558 * Limit string
559 *
560 * Generates a platform-specific LIMIT clause
561 *
562 * @access public
563 * @param string the sql query string
564 * @param integer the number of rows to limit the query to
565 * @param integer the offset value
566 * @return string
567 */
568 function _limit($sql, $limit, $offset)
569 {
570 // Does ODBC doesn't use the LIMIT clause?
571 return $sql;
572 }
573
574 // --------------------------------------------------------------------
575
576 /**
577 * Close DB Connection
578 *
579 * @access public
580 * @param resource
581 * @return void
582 */
583 function _close($conn_id)
584 {
585 @odbc_close($conn_id);
586 }
587
588
589}
590
591
Derek Jones0b59f272008-05-13 04:22:33 +0000592
593/* End of file odbc_driver.php */
Derek Jonesa3ffbbb2008-05-11 18:18:29 +0000594/* Location: ./system/database/drivers/odbc/odbc_driver.php */