blob: d4f322d5f65f8fa30604dd0c8a5ab4548fed1ea4 [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
230 if (function_exists('mysql_escape_string'))
231 {
232 return mysql_real_escape_string($str);
233 }
234 else
235 {
236 return addslashes($str);
237 }
admin046000b2006-09-24 18:12:07 +0000238 }
239
240 // --------------------------------------------------------------------
241
242 /**
243 * Affected Rows
244 *
245 * @access public
246 * @return integer
247 */
248 function affected_rows()
249 {
250 return @mysql_affected_rows($this->conn_id);
251 }
252
253 // --------------------------------------------------------------------
254
255 /**
256 * Insert ID
257 *
258 * @access public
259 * @return integer
260 */
261 function insert_id()
262 {
263 return @mysql_insert_id($this->conn_id);
264 }
265
266 // --------------------------------------------------------------------
267
268 /**
269 * "Count All" query
270 *
271 * Generates a platform-specific query string that counts all records in
272 * the specified database
273 *
274 * @access public
275 * @param string
276 * @return string
277 */
278 function count_all($table = '')
279 {
280 if ($table == '')
281 return '0';
282
283 $query = $this->query("SELECT COUNT(*) AS numrows FROM `".$this->dbprefix.$table."`");
284
285 if ($query->num_rows() == 0)
286 return '0';
287
288 $row = $query->row();
289 return $row->numrows;
290 }
291
292 // --------------------------------------------------------------------
293
294 /**
admin9cd4e8e2006-09-25 23:26:25 +0000295 * Show columnn query
296 *
297 * Generates a platform-specific query string so that the column names can be fetched
298 *
299 * @access public
300 * @param string the table name
301 * @return string
302 */
303 function _list_columns($table = '')
304 {
305 return "SHOW COLUMNS FROM ".$this->_escape_table($table);
306 }
307
308 // --------------------------------------------------------------------
309
310 /**
311 * Field data query
312 *
313 * Generates a platform-specific query so that the column data can be retrieved
314 *
315 * @access public
316 * @param string the table name
317 * @return object
318 */
319 function _field_data($table)
320 {
321 return "SELECT * FROM ".$this->_escape_table($table)." LIMIT 1";
322 }
323
324 // --------------------------------------------------------------------
325
326 /**
admin046000b2006-09-24 18:12:07 +0000327 * The error message string
328 *
adminbb1d4392006-09-24 20:14:38 +0000329 * @access private
admin046000b2006-09-24 18:12:07 +0000330 * @return string
331 */
adminbb1d4392006-09-24 20:14:38 +0000332 function _error_message()
admin046000b2006-09-24 18:12:07 +0000333 {
334 return mysql_error($this->conn_id);
335 }
336
337 // --------------------------------------------------------------------
338
339 /**
340 * The error message number
341 *
adminbb1d4392006-09-24 20:14:38 +0000342 * @access private
admin046000b2006-09-24 18:12:07 +0000343 * @return integer
344 */
adminbb1d4392006-09-24 20:14:38 +0000345 function _error_number()
admin046000b2006-09-24 18:12:07 +0000346 {
347 return mysql_errno($this->conn_id);
348 }
349
350 // --------------------------------------------------------------------
351
352 /**
353 * Escape Table Name
354 *
355 * This function adds backticks if the table name has a period
356 * in it. Some DBs will get cranky unless periods are escaped
357 *
adminbb1d4392006-09-24 20:14:38 +0000358 * @access private
admin046000b2006-09-24 18:12:07 +0000359 * @param string the table name
360 * @return string
361 */
adminbb1d4392006-09-24 20:14:38 +0000362 function _escape_table($table)
admin046000b2006-09-24 18:12:07 +0000363 {
364 if (stristr($table, '.'))
365 {
366 $table = preg_replace("/\./", "`.`", $table);
367 }
368
369 return $table;
370 }
adminbb1d4392006-09-24 20:14:38 +0000371
admin046000b2006-09-24 18:12:07 +0000372 // --------------------------------------------------------------------
373
374 /**
375 * Insert statement
376 *
377 * Generates a platform-specific insert string from the supplied data
378 *
379 * @access public
380 * @param string the table name
381 * @param array the insert keys
382 * @param array the insert values
383 * @return string
384 */
385 function _insert($table, $keys, $values)
386 {
adminbb1d4392006-09-24 20:14:38 +0000387 return "INSERT INTO ".$this->_escape_table($table)." (".implode(', ', $keys).") VALUES (".implode(', ', $values).")";
admin046000b2006-09-24 18:12:07 +0000388 }
389
390 // --------------------------------------------------------------------
391
392 /**
393 * Update statement
394 *
395 * Generates a platform-specific update string from the supplied data
396 *
397 * @access public
398 * @param string the table name
399 * @param array the update data
400 * @param array the where clause
401 * @return string
402 */
403 function _update($table, $values, $where)
404 {
405 foreach($values as $key => $val)
406 {
407 $valstr[] = $key." = ".$val;
408 }
409
adminbb1d4392006-09-24 20:14:38 +0000410 return "UPDATE ".$this->_escape_table($table)." SET ".implode(', ', $valstr)." WHERE ".implode(" ", $where);
admin046000b2006-09-24 18:12:07 +0000411 }
412
413 // --------------------------------------------------------------------
414
415 /**
416 * Delete statement
417 *
418 * Generates a platform-specific delete string from the supplied data
419 *
420 * @access public
421 * @param string the table name
422 * @param array the where clause
423 * @return string
424 */
425 function _delete($table, $where)
426 {
adminbb1d4392006-09-24 20:14:38 +0000427 return "DELETE FROM ".$this->_escape_table($table)." WHERE ".implode(" ", $where);
admin046000b2006-09-24 18:12:07 +0000428 }
adminbb1d4392006-09-24 20:14:38 +0000429
430 // --------------------------------------------------------------------
431
432 /**
433 * Limit string
434 *
435 * Generates a platform-specific LIMIT clause
436 *
437 * @access public
438 * @param string the sql query string
439 * @param integer the number of rows to limit the query to
440 * @param integer the offset value
441 * @return string
442 */
443 function _limit($sql, $limit, $offset)
444 {
445 if ($offset == 0)
446 {
447 $offset = '';
448 }
449 else
450 {
451 $offset .= ", ";
452 }
453
454 return $sql."LIMIT ".$offset.$limit;
455 }
456
457 // --------------------------------------------------------------------
458
459 /**
460 * Close DB Connection
461 *
462 * @access public
463 * @param resource
464 * @return void
465 */
466 function _close($conn_id)
467 {
468 mysql_close($conn_id);
469 }
admin046000b2006-09-24 18:12:07 +0000470
admin046000b2006-09-24 18:12:07 +0000471}
472
473?>