3 # Copyright (C) 2006 Jason Woofenden
5 # This file is part of wfpl.
7 # wfpl is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU Lesser General Public License as published by the Free
9 # Software Foundation; either version 2.1 of the License, or (at your option)
12 # wfpl is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 # FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
17 # You should have received a copy of the GNU Lesser General Public License
18 # along with wfpl; if not, write to the Free Software Foundation, Inc., 51
19 # Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 require_once('code/wfpl/encode.php');
23 require_once('code/wfpl/format.php');
25 # db_connect() -- connect to a mysql database
29 # database: the name of the database you want to connect to. Defaults to the
30 # second-to-last part of the domain name. eg for foo.example.com it would be
33 # user: username for connecting to the database. Defaults to
34 # $GLOBALS['db_username'] or (if that's not set) "www".
36 # password: password for connecting to the database. Defaults to
37 # $GLOBALS['db_password'] or (if that's not set "".
41 # the database connection handle. You'll only need this if you want to have
42 # multiple databases open at once.
44 function db_connect($database = 'auto', $user = 'auto', $pass = 'auto', $host = 'localhost') {
45 if($database == 'auto') {
46 if(isset($GLOBALS['db_name'])) {
47 $database = $GLOBALS['db_name'];
49 $host = $_SERVER['SERVER_NAME'];
50 $host = explode('.', $host);
52 $database = array_pop($host);
58 if(isset($GLOBALS['db_username'])) {
59 $user = $GLOBALS['db_username'];
66 if(isset($GLOBALS['db_password'])) {
67 $pass = $GLOBALS['db_password'];
73 $GLOBALS['wfpl_db_handle'] = mysql_connect($host, $user, $pass);
74 if(!$GLOBALS['wfpl_db_handle']) {
75 die('Could not connect to the database: ' . mysql_error());
78 if(!mysql_select_db($database, $GLOBALS['wfpl_db_handle'])) {
79 die("Couldn not access database \"$database\": " . mysql_error($GLOBALS['wfpl_db_handle']));
82 return $GLOBALS['wfpl_db_handle'];
85 # Unless you're doing something unusual like an ALTER TABLE don't call this directly
86 function db_send_query($sql) {
87 #echo("Sending query: " . enc_html($sql) . "<br>\n");
88 $result = mysql_query($sql, $GLOBALS['wfpl_db_handle']);
90 die(enc_html('DATABASE ERROR: ' . mysql_error($GLOBALS['wfpl_db_handle']) . ' in the following query: ' . $sql));
96 # All select queries use this to generate the where clause, so they can work
97 # like printf. Currently three % codes are supported:
99 # %% put a % in the output
100 # %i put an integer in the output (strips non-numeric digits, and puts in 0 if blank)
101 # %" output double quotes, surrounding the variable which is encoded to be in there.
102 # %s output encoded to be in double quotes, but don't output the quotes
104 # complex example: db_get_rows('mytable', 'id', 'where name=%" or company like "%%%s%%"', $name, $company_partial);
106 function db_printf($str) {
107 $args = func_get_args();
108 $args = array_slice($args, 1);
109 return _db_printf($str, $args);
112 # This function does the work, but takes the parameters in an array
113 function _db_printf($str, $args) {
116 $pos = strpos($str, '%');
117 if($pos === false) { # not found
121 # move everything up to (but not including) % to the output
122 $out .= substr($str, 0, $pos);
124 # grab the character after the %
125 $chr = substr($str, $pos + 1, 1);
127 # remove the stuff we've read from input
128 $str = substr($str, $pos + 2);
131 $out .= '"' . enc_sql(array_shift($args)) . '"';
132 } elseif($chr == 's') {
133 $out .= enc_sql(array_shift($args));
134 } elseif($chr == 'i') {
135 $int = format_int(array_shift($args));
136 if($int == '') $int = '0';
147 function db_send_get($table, $columns, $where, $args) {
148 $sql = "SELECT $columns FROM $table";
150 $sql .= ' ' . _db_printf($where, $args);
153 return db_send_query($sql);
157 function db_get_rows($table, $columns, $where = '') {
158 $args = func_get_args();
159 $args = array_slice($args, 3);
160 $result = db_send_get($table, $columns, $where, $args);
163 while($row = mysql_fetch_row($result)) {
167 mysql_free_result($result);
172 function db_get_column($table, $columns, $where = '') {
173 $args = func_get_args();
174 $args = array_slice($args, 3);
175 $result = db_send_get($table, $columns, $where, $args);
178 while($row = mysql_fetch_row($result)) {
182 mysql_free_result($result);
187 function db_get_row($table, $columns, $where = '') {
188 $args = func_get_args();
189 $args = array_slice($args, 3);
190 $result = db_send_get($table, $columns, $where, $args);
192 $row = mysql_fetch_row($result);
194 mysql_free_result($result);
199 function db_get_value($table, $columns, $where = '') {
200 $args = func_get_args();
201 $args = array_slice($args, 3);
202 $result = db_send_get($table, $columns, $where, $args);
204 $value = mysql_fetch_row($result);
205 if($value !== false) {
209 mysql_free_result($result);
214 function db_count($table, $where = '') {
215 return db_get_value($table, 'count(*)', $where);
218 # call either of these ways:
220 # db_insert('people', 'name,company', 'jason', 'widgets ltd');
222 # db_insert('people', 'name,company', array('jason', 'widgets ltd'));
223 function db_insert($table, $columns, $values) {
224 if(!is_array($values)) {
225 $values = func_get_args();
226 $values = array_slice($values, 2);
229 db_insert_ish('INSERT', $table, $columns, $values);
231 # same as above, except uses the "replace" command instead of "insert"
232 function db_replace($table, $columns, $values) {
233 if(!is_array($values)) {
234 $values = func_get_args();
235 $values = array_slice($values, 2);
238 db_insert_ish('REPLACE', $table, $columns, $values);
241 # return the value mysql made up for the auto_increment field (for the last insert)
242 function db_auto_id() {
243 return mysql_insert_id($GLOBALS['wfpl_db_handle']);
247 # used to implement db_insert() and db_replace()
248 function db_insert_ish($command, $table, $columns, $values) {
251 foreach($values as $value) {
252 if($sql) $sql .= ',';
253 $sql .= '"' . enc_sql($value) . '"';
256 $sql = "$command INTO $table ($columns) values($sql)";
261 # to be consistant with the syntax of the other db functions, $values can be an
262 # array, a single value, or multiple parameters.
264 # as usual the where clause stuff is optional, but it will ofcourse update the
265 # whole table if you leave it off.
269 # # name everybody Bruce
270 # db_update('users', 'name', 'Bruce');
272 # # name user #6 Bruce
273 # db_update('users', 'name', 'Bruce', 'where id=%i', 6);
275 # # update the whole bit for user #6
276 # db_update('users', 'name,email,description', 'Bruce', 'bruce@example.com', 'is a cool guy', 'where id=%i', 6);
278 # # update the whole bit for user #6 (passing data as an array)
279 # $data = array('Bruce', 'bruce@example.com', 'is a cool guy');
280 # db_update('users', 'name,email,description', $data, 'where id=%i', 6);
282 # The prototype is really something like this:
283 # db_update(table, columns, values..., where(optional), where_args...(optional))
284 function db_update($table, $columns, $values) {
285 $args = func_get_args();
286 $args = array_slice($args, 2);
287 $columns = explode(',', $columns);
288 $num_fields = count($columns);
290 if(is_array($values)) {
291 $args = array_slice($args, 1);
293 $values = array_slice($args, 0, $num_fields);
294 $args = array_slice($args, $num_fields);
298 for($i = 0; $i < $num_fields; ++$i) {
302 $sql .= $columns[$i] . ' = "' . enc_sql($values[$i]) . '"';
306 $sql = "UPDATE $table SET $sql";
308 # if there's any more arguments
311 $args = array_slice($args, 1);
314 # any left for where claus arguments?
316 $sql .= _db_printf($where, $args);
326 # pass args for printf-style where clause as usual
327 function db_delete($table, $where = '') {
328 $sql = "DELETE FROM $table";
331 $args = func_get_args();
332 $args = array_slice($args, 2);
334 $sql .= _db_printf($where, $args);