blob: 792e023a8ee4b4dbebdd2d6b6de70d924d48ee97 [file] [log] [blame]
admin046000b2006-09-24 18:12:07 +00001<?php if (!defined('BASEPATH')) exit('No direct script access allowed');
2/**
3 * Code Igniter
4 *
5 * An open source application development framework for PHP 4.3.2 or newer
6 *
7 * @package CodeIgniter
8 * @author Rick Ellis
9 * @copyright Copyright (c) 2006, pMachine, Inc.
10 * @license http://www.codeignitor.com/user_guide/license.html
11 * @link http://www.codeigniter.com
12 * @since Version 1.0
13 * @filesource
14 */
15
16// ------------------------------------------------------------------------
17
18/**
19 * MySQL 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
28 * @author Rick Ellis
29 * @link http://www.codeigniter.com/user_guide/database/
30 */
31class CI_DB_mysql_driver extends CI_DB {
32
33 /**
34 * Whether to use the MySQL "delete hack" which allows the number
35 * of affected rows to be shown. Uses a preg_replace when enabled,
36 * adding a bit more processing to all queries.
37 */
38 var $delete_hack = TRUE;
39
40 /**
41 * Non-persistent database connection
42 *
43 * @access private called by the base class
44 * @return resource
45 */
46 function db_connect()
47 {
48 return mysql_connect($this->hostname, $this->username, $this->password, TRUE);
49 }
50
51 // --------------------------------------------------------------------
52
53 /**
54 * Persistent database connection
55 *
56 * @access private called by the base class
57 * @return resource
58 */
59 function db_pconnect()
60 {
61 return mysql_pconnect($this->hostname, $this->username, $this->password);
62 }
63
64 // --------------------------------------------------------------------
65
66 /**
67 * Select the database
68 *
69 * @access private called by the base class
70 * @return resource
71 */
72 function db_select()
73 {
74 return @mysql_select_db($this->database, $this->conn_id);
75 }
admin9cd4e8e2006-09-25 23:26:25 +000076
77 // --------------------------------------------------------------------
78
79 /**
80 * Version number query string
81 *
82 * @access public
83 * @return string
84 */
85 function _version()
86 {
87 return "SELECT version() AS ver";
88 }
89
admin046000b2006-09-24 18:12:07 +000090 // --------------------------------------------------------------------
91
92 /**
93 * Execute the query
94 *
95 * @access private called by the base class
96 * @param string an SQL query
97 * @return resource
98 */
99 function _execute($sql)
100 {
101 $sql = $this->_prep_query($sql);
102 return @mysql_query($sql, $this->conn_id);
103 }
104
105 // --------------------------------------------------------------------
106
107 /**
108 * Prep the query
109 *
110 * If needed, each database adapter can prep the query string
111 *
112 * @access private called by execute()
113 * @param string an SQL query
114 * @return string
115 */
116 function _prep_query($sql)
117 {
118 // "DELETE FROM TABLE" returns 0 affected rows This hack modifies
119 // the query so that it returns the number of affected rows
120 if ($this->delete_hack === TRUE)
121 {
122 if (preg_match('/^\s*DELETE\s+FROM\s+(\S+)\s*$/i', $sql))
123 {
124 $sql = preg_replace("/^\s*DELETE\s+FROM\s+(\S+)\s*$/", "DELETE FROM \\1 WHERE 1=1", $sql);
125 }
126 }
127
128 return $sql;
129 }
130
131 // --------------------------------------------------------------------
132
133 /**
134 * Begin Transaction
135 *
136 * @access public
137 * @return bool
138 */
139 function trans_begin($test_mode = FALSE)
140 {
141 if ( ! $this->trans_enabled)
142 {
143 return TRUE;
144 }
145
146 // When transactions are nested we only begin/commit/rollback the outermost ones
147 if ($this->_trans_depth > 0)
148 {
149 return TRUE;
150 }
151
152 // Reset the transaction failure flag.
153 // If the $test_mode flag is set to TRUE transactions will be rolled back
154 // even if the queries produce a successful result.
155 $this->_trans_failure = ($test_mode === TRUE) ? TRUE : FALSE;
156
157 $this->simple_query('SET AUTOCOMMIT=0');
158 $this->simple_query('START TRANSACTION'); // can also be BEGIN or BEGIN WORK
159 return TRUE;
160 }
161
162 // --------------------------------------------------------------------
163
164 /**
165 * Commit Transaction
166 *
167 * @access public
168 * @return bool
169 */
170 function trans_commit()
171 {
172 if ( ! $this->trans_enabled)
173 {
174 return TRUE;
175 }
176
177 // When transactions are nested we only begin/commit/rollback the outermost ones
178 if ($this->_trans_depth > 0)
179 {
180 return TRUE;
181 }
182
183 $this->simple_query('COMMIT');
184 $this->simple_query('SET AUTOCOMMIT=1');
185 return TRUE;
186 }
187
188 // --------------------------------------------------------------------
189
190 /**
191 * Rollback Transaction
192 *
193 * @access public
194 * @return bool
195 */
196 function trans_rollback()
197 {
198 if ( ! $this->trans_enabled)
199 {
200 return TRUE;
201 }
202
203 // When transactions are nested we only begin/commit/rollback the outermost ones
204 if ($this->_trans_depth > 0)
205 {
206 return TRUE;
207 }
208
209 $this->simple_query('ROLLBACK');
210 $this->simple_query('SET AUTOCOMMIT=1');
211 return TRUE;
212 }
213
214 // --------------------------------------------------------------------
215
216 /**
217 * Escape String
218 *
219 * @access public
220 * @param string
221 * @return string
222 */
223 function escape_str($str)
224 {
admin17a890d2006-09-27 20:42:42 +0000225 if (get_magic_quotes_gpc())
226 {
227 return $str;
228 }
229
admin33de9a12006-09-28 06:50:16 +0000230 if (function_exists('mysql_real_escape_string'))
admin17a890d2006-09-27 20:42:42 +0000231 {
admin33de9a12006-09-28 06:50:16 +0000232 return mysql_real_escape_string($str, $this->conn_id);
233 }
234 elseif (function_exists('mysql_escape_string'))
235 {
236 return mysql_escape_string($str);
admin17a890d2006-09-27 20:42:42 +0000237 }
238 else
239 {
240 return addslashes($str);
241 }
admin046000b2006-09-24 18:12:07 +0000242 }
243
244 // --------------------------------------------------------------------
245
246 /**
247 * Affected Rows
248 *
249 * @access public
250 * @return integer
251 */
252 function affected_rows()
253 {
254 return @mysql_affected_rows($this->conn_id);
255 }
256
257 // --------------------------------------------------------------------
258
259 /**
260 * Insert ID
261 *
262 * @access public
263 * @return integer
264 */
265 function insert_id()
266 {
267 return @mysql_insert_id($this->conn_id);
268 }
269
270 // --------------------------------------------------------------------
271
272 /**
273 * "Count All" query
274 *
275 * Generates a platform-specific query string that counts all records in
276 * the specified database
277 *
278 * @access public
279 * @param string
280 * @return string
281 */
282 function count_all($table = '')
283 {
284 if ($table == '')
285 return '0';
286
287 $query = $this->query("SELECT COUNT(*) AS numrows FROM `".$this->dbprefix.$table."`");
288
289 if ($query->num_rows() == 0)
290 return '0';
291
292 $row = $query->row();
293 return $row->numrows;
294 }
295
296 // --------------------------------------------------------------------
297
298 /**
admin9cd4e8e2006-09-25 23:26:25 +0000299 * Show columnn query
300 *
301 * Generates a platform-specific query string so that the column names can be fetched
302 *
303 * @access public
304 * @param string the table name
305 * @return string
306 */
307 function _list_columns($table = '')
308 {
309 return "SHOW COLUMNS FROM ".$this->_escape_table($table);
310 }
311
312 // --------------------------------------------------------------------
313
314 /**
315 * Field data query
316 *
317 * Generates a platform-specific query so that the column data can be retrieved
318 *
319 * @access public
320 * @param string the table name
321 * @return object
322 */
323 function _field_data($table)
324 {
325 return "SELECT * FROM ".$this->_escape_table($table)." LIMIT 1";
326 }
327
328 // --------------------------------------------------------------------
329
330 /**
admin046000b2006-09-24 18:12:07 +0000331 * The error message string
332 *
adminbb1d4392006-09-24 20:14:38 +0000333 * @access private
admin046000b2006-09-24 18:12:07 +0000334 * @return string
335 */
adminbb1d4392006-09-24 20:14:38 +0000336 function _error_message()
admin046000b2006-09-24 18:12:07 +0000337 {
338 return mysql_error($this->conn_id);
339 }
340
341 // --------------------------------------------------------------------
342
343 /**
344 * The error message number
345 *
adminbb1d4392006-09-24 20:14:38 +0000346 * @access private
admin046000b2006-09-24 18:12:07 +0000347 * @return integer
348 */
adminbb1d4392006-09-24 20:14:38 +0000349 function _error_number()
admin046000b2006-09-24 18:12:07 +0000350 {
351 return mysql_errno($this->conn_id);
352 }
353
354 // --------------------------------------------------------------------
355
356 /**
357 * Escape Table Name
358 *
359 * This function adds backticks if the table name has a period
360 * in it. Some DBs will get cranky unless periods are escaped
361 *
adminbb1d4392006-09-24 20:14:38 +0000362 * @access private
admin046000b2006-09-24 18:12:07 +0000363 * @param string the table name
364 * @return string
365 */
adminbb1d4392006-09-24 20:14:38 +0000366 function _escape_table($table)
admin046000b2006-09-24 18:12:07 +0000367 {
368 if (stristr($table, '.'))
369 {
370 $table = preg_replace("/\./", "`.`", $table);
371 }
372
373 return $table;
374 }
adminbb1d4392006-09-24 20:14:38 +0000375
admin046000b2006-09-24 18:12:07 +0000376 // --------------------------------------------------------------------
377
378 /**
379 * Insert statement
380 *
381 * Generates a platform-specific insert string from the supplied data
382 *
383 * @access public
384 * @param string the table name
385 * @param array the insert keys
386 * @param array the insert values
387 * @return string
388 */
389 function _insert($table, $keys, $values)
390 {
adminbb1d4392006-09-24 20:14:38 +0000391 return "INSERT INTO ".$this->_escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
admin046000b2006-09-24 18:12:07 +0000392 }
393
394 // --------------------------------------------------------------------
395
396 /**
397 * Update statement
398 *
399 * Generates a platform-specific update string from the supplied data
400 *
401 * @access public
402 * @param string the table name
403 * @param array the update data
404 * @param array the where clause
405 * @return string
406 */
407 function _update($table, $values, $where)
408 {
409 foreach($values as $key => $val)
410 {
411 $valstr[] = $key." = ".$val;
412 }
413
adminbb1d4392006-09-24 20:14:38 +0000414 return "UPDATE ".$this->_escape_table($table)." SET ".implode(', ', $valstr)." WHERE ".implode(" ", $where);
admin046000b2006-09-24 18:12:07 +0000415 }
416
417 // --------------------------------------------------------------------
418
419 /**
420 * Delete statement
421 *
422 * Generates a platform-specific delete string from the supplied data
423 *
424 * @access public
425 * @param string the table name
426 * @param array the where clause
427 * @return string
428 */
429 function _delete($table, $where)
430 {
adminbb1d4392006-09-24 20:14:38 +0000431 return "DELETE FROM ".$this->_escape_table($table)." WHERE ".implode(" ", $where);
admin046000b2006-09-24 18:12:07 +0000432 }
adminbb1d4392006-09-24 20:14:38 +0000433
434 // --------------------------------------------------------------------
435
436 /**
437 * Limit string
438 *
439 * Generates a platform-specific LIMIT clause
440 *
441 * @access public
442 * @param string the sql query string
443 * @param integer the number of rows to limit the query to
444 * @param integer the offset value
445 * @return string
446 */
447 function _limit($sql, $limit, $offset)
448 {
449 if ($offset == 0)
450 {
451 $offset = '';
452 }
453 else
454 {
455 $offset .= ", ";
456 }
457
458 return $sql."LIMIT ".$offset.$limit;
459 }
460
461 // --------------------------------------------------------------------
462
463 /**
464 * Close DB Connection
465 *
466 * @access public
467 * @param resource
468 * @return void
469 */
470 function _close($conn_id)
471 {
472 mysql_close($conn_id);
473 }
admin046000b2006-09-24 18:12:07 +0000474
admin046000b2006-09-24 18:12:07 +0000475}
476
477?>