db.php

   1 <?php
   2
   3 #  Copyright (C) 2006 Jason Woofenden
   4 #
   5 #  This file is part of wfpl.
   6 #
   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)
  10 #  any later version.
  11 #
  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
  15 #  more details.
  16 #
  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
  20
  21
  22 require_once('code/wfpl/encode.php');
  23 require_once('code/wfpl/format.php');
  24
  25 # db_connect() -- connect to a mysql database
  26 #
  27 # PARAMETERS:
  28 #
  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
  31 #   "example".
  32 #
  33 #   user: username for connecting to the database. Defaults to
  34 #   $GLOBALS['db_username'] or (if that's not set) "www".
  35 #
  36 #   password: password for connecting to the database. Defaults to
  37 #   $GLOBALS['db_password'] or (if that's not set "".
  38 #
  39 # RETURNS:
  40 #
  41 #   the database connection handle. You'll only need this if you want to have
  42 #   multiple databases open at once.
  43
  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'];
  48                 } else {
  49                         $host = $_SERVER['SERVER_NAME'];
  50                         $host = explode('.', $host);
  51                         array_pop($host);
  52                         $database = array_pop($host);
  53                         unset($host);
  54                 }
  55         }
  56
  57         if($user == 'auto') {
  58                 if(isset($GLOBALS['db_username'])) {
  59                         $user = $GLOBALS['db_username'];
  60                 } else {
  61                         $user = 'www';
  62                 }
  63         }
  64
  65         if($pass == 'auto') {
  66                 if(isset($GLOBALS['db_password'])) {
  67                         $pass = $GLOBALS['db_password'];
  68                 } else {
  69                         $pass = '';
  70                 }
  71         }
  72
  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());
  76         }
  77
  78         if(!mysql_select_db($database, $GLOBALS['wfpl_db_handle'])) {
  79                 die("Couldn not access database \"$database\": " . mysql_error($GLOBALS['wfpl_db_handle']));
  80         }
  81
  82         return $GLOBALS['wfpl_db_handle'];
  83 }
  84
  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']);
  89         if(!$result) {
  90                 die(enc_html('DATABASE ERROR: ' . mysql_error($GLOBALS['wfpl_db_handle']) . ' in the following query: ' . $sql));
  91         }
  92
  93         return $result;
  94 }
  95
  96 # All select queries use this to generate the where clause, so they can work
  97 # like printf. Currently three % codes are supported:
  98 #
  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
 103 #
 104 # complex example: db_get_rows('mytable', 'id', 'where name=%" or company like "%%%s%%"', $name, $company_partial);
 105
 106 function db_printf($str) {
 107         $args = func_get_args();
 108         $args = array_slice($args, 1);
 109         return _db_printf($str, $args);
 110 }
 111
 112 # This function does the work, but takes the parameters in an array
 113 function _db_printf($str, $args) {
 114         $args = array_reverse($args); # because array_pop() takes from the end
 115         $out = '';
 116         while($str) {
 117                 $pos = strpos($str, '%');
 118                 if($pos === false) { # not found
 119                         # we hit the end.
 120                         return $out . $str;
 121                 }
 122                 # move everything up to (but not including) % to the output
 123                 $out .= substr($str, 0, $pos);
 124
 125                 # grab the character after the %
 126                 $chr = substr($str, $pos + 1, 1);
 127
 128                 # remove the stuff we've read from input
 129                 $str = substr($str, $pos + 2);
 130
 131                 if($chr == '"') {
 132                         $out .= '"' . enc_sql(array_pop($args)) . '"';
 133                 } elseif($chr == 's') {
 134                         $out .= enc_sql(array_pop($args));
 135                 } elseif($chr == 'i') {
 136                         $int = format_int(array_pop($args));
 137                         if($int == '') $int = '0';
 138                         $out .= $int;
 139                 } else {
 140                         $out .= $chr;
 141                 }
 142         }
 143
 144         return $out;
 145 }
 146
 147
 148 function db_send_get($table, $columns, $where, $args) {
 149         $sql = "SELECT $columns FROM $table";
 150         if($where) {
 151                 $sql .= ' ' . _db_printf($where, $args);
 152         }
 153
 154         return db_send_query($sql);
 155 }
 156
 157
 158 function db_get_rows($table, $columns, $where = '') {
 159         $args = func_get_args();
 160         $args = array_slice($args, 3);
 161         $result = db_send_get($table, $columns, $where, $args);
 162
 163         $rows = array();
 164         while($row = mysql_fetch_row($result)) {
 165                 $rows[] = $row;
 166         }
 167
 168         mysql_free_result($result);
 169
 170         return $rows;
 171 }
 172
 173 function db_get_column($table, $columns, $where = '') {
 174         $args = func_get_args();
 175         $args = array_slice($args, 3);
 176         $result = db_send_get($table, $columns, $where, $args);
 177
 178         $column = array();
 179         while($row = mysql_fetch_row($result)) {
 180                 $column[] = $row[0];
 181         }
 182
 183         mysql_free_result($result);
 184
 185         return $column;
 186 }
 187
 188 function db_get_row($table, $columns, $where = '') {
 189         $args = func_get_args();
 190         $args = array_slice($args, 3);
 191         $result = db_send_get($table, $columns, $where, $args);
 192
 193         $row = mysql_fetch_row($result);
 194
 195         mysql_free_result($result);
 196
 197         return $row;
 198 }
 199
 200 function db_get_value($table, $columns, $where = '') {
 201         $args = func_get_args();
 202         $args = array_slice($args, 3);
 203         $result = db_send_get($table, $columns, $where, $args);
 204
 205         $value = mysql_fetch_row($result);
 206         if($value !== false) {
 207                 $value = $value[0];
 208         }
 209
 210         mysql_free_result($result);
 211
 212         return $value;
 213 }
 214
 215 # call either of these ways:
 216 #
 217 # db_insert('people', 'name,company', 'jason', 'widgets ltd');
 218 # or
 219 # db_insert('people', 'name,company', array('jason', 'widgets ltd'));
 220 function db_insert($table, $columns, $values) {
 221         if(!is_array($values)) {
 222                 $values = func_get_args();
 223                 $values = array_slice($values, 2);
 224         }
 225
 226         db_insert_ish('INSERT', $table, $columns, $values);
 227 }
 228 # same as above, except uses the "replace" command instead of "insert"
 229 function db_replace($table, $columns, $values) {
 230         if(!is_array($values)) {
 231                 $values = func_get_args();
 232                 $values = array_slice($values, 2);
 233         }
 234
 235         db_insert_ish('REPLACE', $table, $columns, $values);
 236 }
 237
 238 # return the value mysql made up for the auto_increment field (for the last insert)
 239 function db_auto_id() {
 240         return mysql_insert_id($GLOBALS['wfpl_db_handle']);
 241 }
 242
 243
 244 # used to implement db_insert() and db_replace()
 245 function db_insert_ish($command, $table, $columns, $values) {
 246
 247         $sql = '';
 248         foreach($values as $value) {
 249                 if($sql) $sql .= ',';
 250                 $sql .= '"' . enc_sql($value) . '"';
 251         }
 252
 253         $sql = "$command INTO $table ($columns) values($sql)";
 254
 255         db_send_query($sql);
 256 }
 257
 258 # to be consistant with the syntax of the other db functions, $values can be an
 259 # array, a single value, or multiple parameters.
 260 #
 261 # as usual the where clause stuff is optional, but it will ofcourse update the
 262 # whole table if you leave it off.
 263 #
 264 # examples:
 265 #
 266 # # name everybody Bruce
 267 # db_update('users', 'name', 'Bruce');
 268 #
 269 # # name user #6 Bruce
 270 # db_update('users', 'name', 'Bruce', 'where id=%i', 6);
 271 #
 272 # # update the whole bit for user #6
 273 # db_update('users', 'name,email,description', 'Bruce', 'bruce@example.com', 'is a cool guy', 'where id=%i', 6);
 274 #
 275 # # update the whole bit for user #6 (passing data as an array)
 276 # $data = array('Bruce', 'bruce@example.com', 'is a cool guy');
 277 # db_update('users', 'name,email,description', $data, 'where id=%i', 6);
 278
 279 # The prototype is really something like this:
 280 # db_update(table, columns, values..., where(optional), where_args...(optional))
 281 function db_update($table, $columns, $values) {
 282         $args = func_get_args();
 283         $args = array_slice($args, 2);
 284         $columns = explode(',', $columns);
 285         $num_fields = count($columns);
 286
 287         if(is_array($values)) {
 288                 $args = array_slice($args, 1);
 289         } else {
 290                 $values = array_slice($args, 0, $num_fields);
 291                 $args = array_slice($args, $num_fields);
 292         }
 293
 294         $sql = '';
 295         for($i = 0; $i < $num_fields; ++$i) {
 296                 if($sql != '') {
 297                         $sql .= ', ';
 298                 }
 299                 $sql .= $columns[$i] . ' = "' . enc_sql($values[$i]) . '"';
 300         }
 301
 302
 303         $sql = "UPDATE $table SET $sql";
 304
 305         # if there's any more arguments
 306         if($args) {
 307                 $where = $args[0];
 308                 $args = array_slice($args, 1);
 309
 310                 $sql .= ' ';
 311                 # any left for where claus arguments?
 312                 if($args) {
 313                         $sql .= _db_printf($where, $args);
 314                 } else {
 315                         $sql .= $where;
 316                 }
 317
 318         }
 319
 320         db_send_query($sql);
 321 }
 322
 323 # pass args for printf-style where clause as usual
 324 function db_delete($table, $where = '') {
 325         $sql = "DELETE FROM $table";
 326         if($where) {
 327                 $sql .= ' ';
 328                 $args = func_get_args();
 329                 $args = array_slice($args, 2);
 330                 if($args) {
 331                         $sql .= _db_printf($where, $args);
 332                 } else {
 333                         $sql .= $where;
 334                 }
 335         }
 336
 337         db_send_query($sql);
 338 }
 339
 340 ?>