db.php

   1 <?php
   2
   3 #  Copyright (C) 2006 Jason Woofenden
   4 #
   5 #  This program is free software: you can redistribute it and/or modify
   6 #  it under the terms of the GNU General Public License as published by
   7 #  the Free Software Foundation, either version 3 of the License, or
   8 #  (at your option) any later version.
   9 #
  10 #  This program is distributed in the hope that it will be useful,
  11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #  GNU General Public License for more details.
  14 #
  15 #  You should have received a copy of the GNU General Public License
  16 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18
  19 require_once(__DIR__.'/'.'encode.php');
  20 require_once(__DIR__.'/'.'format.php');
  21
  22 # db_connect() -- connect to a mysql database
  23 #
  24 # PARAMETERS:
  25 #
  26 #   database: the name of the database you want to connect to. Defaults to the
  27 #   second-to-last part of the domain name. eg for foo.example.com it would be
  28 #   "example".
  29 #
  30 #   user: username for connecting to the database. Defaults to
  31 #   $GLOBALS['db_username'] or (if that's not set) "www".
  32 #
  33 #   password: password for connecting to the database. Defaults to
  34 #   $GLOBALS['db_password'] or (if that's not set "".
  35 #
  36 # RETURNS:
  37 #
  38 #   the database connection handle. You'll only need this if you want to have
  39 #   multiple databases open at once.
  40
  41 function db_enc_sql($str) {
  42         return mysql_real_escape_string($str, $GLOBALS['wfpl_db_handle'] ? $GLOBALS['wfpl_db_handle'] : null);
  43 }
  44
  45 function db_connect($database = 'auto', $user = 'auto', $pass = 'auto', $host = 'localhost', $encoding = 'utf8') {
  46         if($database == 'auto') {
  47                 if(isset($GLOBALS['db_name'])) {
  48                         $database = $GLOBALS['db_name'];
  49                 } else {
  50                         $host = $_SERVER['SERVER_NAME'];
  51                         $host = explode('.', $host);
  52                         array_pop($host);
  53                         $database = array_pop($host);
  54                         unset($host);
  55                 }
  56         }
  57
  58         if($user == 'auto') {
  59                 if(isset($GLOBALS['db_username'])) {
  60                         $user = $GLOBALS['db_username'];
  61                 } else {
  62                         $user = 'www';
  63                 }
  64         }
  65
  66         if($pass == 'auto') {
  67                 if(isset($GLOBALS['db_password'])) {
  68                         $pass = $GLOBALS['db_password'];
  69                 } else {
  70                         $pass = '';
  71                 }
  72         }
  73
  74         $GLOBALS['wfpl_db_handle'] = mysql_connect($host, $user, $pass);
  75         if(!$GLOBALS['wfpl_db_handle']) {
  76                 die('Could not connect to the database: ' . mysql_error());
  77         }
  78
  79         mysql_set_charset($encoding, $GLOBALS['wfpl_db_handle']);
  80
  81         if(!mysql_select_db($database, $GLOBALS['wfpl_db_handle'])) {
  82                 die("Couldn not access database \"$database\": " . mysql_error($GLOBALS['wfpl_db_handle']));
  83         }
  84
  85         return $GLOBALS['wfpl_db_handle'];
  86 }
  87
  88 # Unless you're doing something unusual like an ALTER TABLE don't call this directly
  89 function db_send_query($sql) {
  90         #echo("Sending query: " . enc_html($sql) . "<br>\n");
  91         $result = mysql_query($sql, $GLOBALS['wfpl_db_handle']);
  92         if(!$result) {
  93                 die(enc_html('DATABASE ERROR: ' . mysql_error($GLOBALS['wfpl_db_handle']) . ' in the following query: ' . $sql));
  94         }
  95
  96         return $result;
  97 }
  98
  99 # All select queries use this to generate the where clause, so they can work
 100 # like printf. Currently three % codes are supported:
 101 #
 102 # %%  put a % in the output
 103 # %i  put an integer in the output (strips non-numeric digits, and puts in 0 if blank)
 104 # %f  put a floating point value in the output (strips non-numeric digits, puts in 0.0 if not valid)
 105 # %"  output double quotes, surrounding the variable which is encoded to be in there.
 106 # %s  output encoded to be in double quotes, but don't output the quotes
 107 # %$  output argument as-is, no encoding. Make sure you quote everything from the user!
 108 #
 109 # complex example: db_get_rows('mytable', 'id', 'where name=%" or company like "%%%s%%"', $name, $company_partial);
 110
 111 function db_printf($str) {
 112         $args = func_get_args();
 113         $args = array_slice($args, 1);
 114         return _db_printf($str, $args);
 115 }
 116
 117 # This function does the work, but takes the parameters in an array
 118 function _db_printf($str, $args) {
 119         $out = '';
 120         while($str) {
 121                 $pos = strpos($str, '%');
 122                 if($pos === false) { # not found
 123                         # we hit the end.
 124                         return $out . $str;
 125                 }
 126                 # move everything up to (but not including) % to the output
 127                 $out .= substr($str, 0, $pos);
 128
 129                 # grab the character after the %
 130                 $chr = substr($str, $pos + 1, 1);
 131
 132                 # remove the stuff we've read from input
 133                 $str = substr($str, $pos + 2);
 134
 135                 if($chr == '"') {
 136                         $out .= '"' . db_enc_sql(array_shift($args)) . '"';
 137                 } elseif($chr == 's') {
 138                         $out .= db_enc_sql(array_shift($args));
 139                 } elseif($chr == 'i') {
 140                         $int = format_int(array_shift($args));
 141                         if($int == '') $int = '0';
 142                         $out .= $int;
 143                 } elseif($chr == 'f') {
 144                         $arg = array_shift($args);
 145                         if(is_numeric($arg)) {
 146                                 $arg = sprintf("%f", $arg);
 147                         }
 148                         $arg = format_decimal($arg);
 149                         if(strlen($arg) < 1) {
 150                                 $arg = '0.0';
 151                         }
 152                         $out .= $arg;
 153                 } elseif($chr == '$') {
 154                         $out .= array_shift($args);
 155                 } else {
 156                         $out .= $chr;
 157                 }
 158         }
 159
 160         return $out;
 161 }
 162
 163
 164 function db_send_get($table, $columns, $where, $args) {
 165         $sql = "SELECT $columns FROM $table";
 166         if($where) {
 167                 $sql .= ' ' . _db_printf($where, $args);
 168         }
 169
 170         return db_send_query($sql);
 171 }
 172
 173
 174 function db_get_rows($table, $columns, $where = '') {
 175         $args = func_get_args();
 176         $args = array_slice($args, 3);
 177         $result = db_send_get($table, $columns, $where, $args);
 178
 179         $rows = array();
 180         while($row = mysql_fetch_row($result)) {
 181                 $rows[] = $row;
 182         }
 183
 184         mysql_free_result($result);
 185
 186         return $rows;
 187 }
 188
 189 # like db_get_rows, but return array of hashes.
 190 function db_get_assocs($table, $columns, $where = '') {
 191         $args = func_get_args();
 192         $args = array_slice($args, 3);
 193         $result = db_send_get($table, $columns, $where, $args);
 194
 195         $rows = array();
 196         while($row = mysql_fetch_assoc($result)) {
 197                 $rows[] = $row;
 198         }
 199
 200         mysql_free_result($result);
 201
 202         return $rows;
 203 }
 204
 205 function db_get_column($table, $columns, $where = '') {
 206         $args = func_get_args();
 207         $args = array_slice($args, 3);
 208         $result = db_send_get($table, $columns, $where, $args);
 209
 210         $column = array();
 211         while($row = mysql_fetch_row($result)) {
 212                 $column[] = $row[0];
 213         }
 214
 215         mysql_free_result($result);
 216
 217         return $column;
 218 }
 219
 220 function db_get_row($table, $columns, $where = '') {
 221         $args = func_get_args();
 222         $args = array_slice($args, 3);
 223         $result = db_send_get($table, $columns, $where, $args);
 224
 225         $row = mysql_fetch_row($result);
 226
 227         mysql_free_result($result);
 228
 229         return $row;
 230 }
 231
 232 # like db_get_row, but return a hash.
 233 function db_get_assoc($table, $columns, $where = '') {
 234         $args = func_get_args();
 235         $args = array_slice($args, 3);
 236         $result = db_send_get($table, $columns, $where, $args);
 237
 238         $row = mysql_fetch_assoc($result);
 239
 240         mysql_free_result($result);
 241
 242         return $row;
 243 }
 244
 245 function db_get_value($table, $columns, $where = '') {
 246         $args = func_get_args();
 247         $args = array_slice($args, 3);
 248         $result = db_send_get($table, $columns, $where, $args);
 249
 250         $value = mysql_fetch_row($result);
 251         if($value !== false) {
 252                 $value = $value[0];
 253         }
 254
 255         mysql_free_result($result);
 256
 257         return $value;
 258 }
 259
 260 function db_count($table, $where = '') {
 261         $args = func_get_args();
 262         array_splice($args, 1, 0, array('count(*)'));
 263         return call_user_func_array('db_get_value', $args);
 264 }
 265
 266 # call either of these ways:
 267 #
 268 # db_insert('people', 'name,company', 'jason', 'widgets ltd');
 269 # or
 270 # db_insert('people', 'name,company', array('jason', 'widgets ltd'));
 271 function db_insert($table, $columns, $values) {
 272         if(!is_array($values)) {
 273                 $values = func_get_args();
 274                 $values = array_slice($values, 2);
 275         }
 276
 277         db_insert_ish('INSERT', $table, $columns, $values);
 278 }
 279
 280 # like db_insert() above, but instead of passing columns and data separately,
 281 # you can pass one array with the column names as keys and the data as values
 282 function db_insert_assoc($table, $data) {
 283         $args = func_get_args();
 284         $args = array_slice($args, 2);
 285         $columns = array();
 286         $values = array();
 287         foreach($data as $key => $value) {
 288                 $columns[] = $key;
 289                 $values[] = $value;
 290         }
 291         array_unshift($args, $table, join(',', $columns), $values);
 292         call_user_func_array('db_insert', $args);
 293 }
 294
 295 # same as above, except uses the "replace" command instead of "insert"
 296 function db_replace($table, $columns, $values) {
 297         if(!is_array($values)) {
 298                 $values = func_get_args();
 299                 $values = array_slice($values, 2);
 300         }
 301
 302         db_insert_ish('REPLACE', $table, $columns, $values);
 303 }
 304
 305 # return the value mysql made up for the auto_increment field (for the last insert)
 306 function db_auto_id() {
 307         return mysql_insert_id($GLOBALS['wfpl_db_handle']);
 308 }
 309
 310
 311 # used to implement db_insert() and db_replace()
 312 function db_insert_ish($command, $table, $columns, $values) {
 313
 314         $sql = '';
 315         foreach($values as $value) {
 316                 if($sql) $sql .= ',';
 317                 $sql .= '"' . db_enc_sql($value) . '"';
 318         }
 319
 320         $sql = "$command INTO $table ($columns) values($sql)";
 321
 322         db_send_query($sql);
 323 }
 324
 325 # to be consistent with the syntax of the other db functions, $values can be an
 326 # array, a single value, or multiple parameters.
 327 #
 328 # as usual the where clause stuff is optional, but it will of course update the
 329 # whole table if you leave it off.
 330 #
 331 # examples:
 332 #
 333 # # name everybody Bruce
 334 # db_update('users', 'name', 'Bruce');
 335 #
 336 # # name user #6 Bruce
 337 # db_update('users', 'name', 'Bruce', 'where id=%i', 6);
 338 #
 339 # # update the whole bit for user #6
 340 # db_update('users', 'name,email,description', 'Bruce', 'bruce@example.com', 'is a cool guy', 'where id=%i', 6);
 341 #
 342 # # update the whole bit for user #6 (passing data as an array)
 343 # $data = array('Bruce', 'bruce@example.com', 'is a cool guy');
 344 # db_update('users', 'name,email,description', $data, 'where id=%i', 6);
 345
 346 # The prototype is really something like this:
 347 # db_update(table, columns, values..., where(optional), where_args...(optional))
 348 function db_update($table, $columns, $values) {
 349         $args = func_get_args();
 350         $args = array_slice($args, 2);
 351         $columns = explode(',', $columns);
 352         $num_fields = count($columns);
 353
 354         if(is_array($values)) {
 355                 $values = array_values($values);
 356                 $args = array_slice($args, 1);
 357         } else {
 358                 $values = array_slice($args, 0, $num_fields);
 359                 $args = array_slice($args, $num_fields);
 360         }
 361
 362         $sql = '';
 363         for($i = 0; $i < $num_fields; ++$i) {
 364                 if($sql != '') {
 365                         $sql .= ', ';
 366                 }
 367                 $sql .= $columns[$i] . ' = "' . db_enc_sql($values[$i]) . '"';
 368         }
 369
 370
 371         $sql = "UPDATE $table SET $sql";
 372
 373         # if there's any more arguments
 374         if($args) {
 375                 $where = $args[0];
 376                 $args = array_slice($args, 1);
 377
 378                 $sql .= ' ';
 379                 # any left for printf arguments?
 380                 if($args) {
 381                         $sql .= _db_printf($where, $args);
 382                 } else {
 383                         $sql .= $where;
 384                 }
 385
 386         }
 387
 388         db_send_query($sql);
 389 }
 390
 391 # like db_update() above, but instead of passing columns and data separately,
 392 # you can pass one array with the column names as keys and the data as values
 393 function db_update_assoc($table, $data) {
 394         $args = func_get_args();
 395         $args = array_slice($args, 2);
 396         $columns = array();
 397         $values = array();
 398         foreach($data as $key => $value) {
 399                 $columns[] = $key;
 400                 $values[] = $value;
 401         }
 402         array_unshift($args, $values);
 403         array_unshift($args, join(',', $columns));
 404         array_unshift($args, $table);
 405         call_user_func_array('db_update', $args);
 406 }
 407
 408 # pass args for printf-style where clause as usual
 409 function db_delete($table, $where = '') {
 410         $sql = "DELETE FROM $table";
 411         if($where) {
 412                 $sql .= ' ';
 413                 $args = func_get_args();
 414                 $args = array_slice($args, 2);
 415                 if($args) {
 416                         $sql .= _db_printf($where, $args);
 417                 } else {
 418                         $sql .= $where;
 419                 }
 420         }
 421
 422         db_send_query($sql);
 423 }
 424
 425
 426 define('DB_ORD_MAX', 2000000000);
 427
 428 function db_reposition_respace($table, $field, $where = '') {
 429         if($where) {
 430                 $andand = " && ($where) ";
 431         }
 432         $ids = db_get_column($table, 'id', "where $field != 0 $andand order by $field");
 433         $c = count($ids);
 434         if(!$c) {
 435                 # should never happen
 436                 return;
 437         }
 438         $inc = floor(DB_ORD_MAX / ($c + 1));
 439         $cur = $inc;
 440         foreach($ids as $id) {
 441                 db_update($table, $field, $cur, 'where id=%i', $id);
 442                 $cur += $inc;
 443         }
 444 }
 445
 446 # this function facilitates letting the user manually sort records (with (int) $field != 0)
 447 #
 448 # When editing a particular row, give the user a pulldown, with 0 -> first, 1 -> second, etc, and pass this integer to db_reposition (3rd parameter). The value "ignored" can be passed, and the row will be given a sort value of 0 and ignored for all sorting.
 449 #
 450 # $pretty is used in error messages to refer to the row, it defaults to whatever you pass for $table.
 451 #
 452 # return value is the "ord" value you should set/insert into your database
 453
 454 function db_reposition($table, $row_id, $new_pos, $field = 'ord', $pretty = 'same as $table', $where = '', $renumbered_already = false) {
 455         if($pretty == 'same as $table') {
 456                 $pretty = $table;
 457         }
 458         if($where) {
 459                 $andand = " && ($where) ";
 460         }
 461
 462         if($new_pos === 'ignored') {
 463                 # not sorted
 464                 return '0';
 465         }
 466
 467         # strategy: calculate $prev_ord and $next_ord. If there's no space between, renumber and recurse
 468         if($new_pos == '0') {
 469                 $row = db_get_row($table, "id,$field", "where $field != 0 $andand order by $field limit 1");
 470                 if($row) {
 471                         list($first_row_id, $first_row_ord) = $row;
 472                         if($first_row_id == $row_id) {
 473                                 # already first
 474                                 return $first_row_ord;
 475                         }
 476                         $next_ord = $first_row_ord;
 477                 } else {
 478                         # this is the only row, put it in the middle
 479                         return '' + floor(DB_ORD_MAX / 2);
 480                 }
 481
 482                 $prev_ord = 0;
 483         } else {
 484                 $new_pos = format_int_0($new_pos);
 485                 $rows = db_get_rows($table, "id,$field", "where $field != 0 $andand order by $field limit %i,2", $new_pos - 1);
 486                 if(!$rows) {
 487                         message("Sorry, couldn't find the $pretty you asked to put this $pretty after. Putting it first instead.");
 488                         return db_reposition($table, $row_id, '0', $field, $pretty, $where);
 489                 } else {
 490                         list($prev_id, $prev_ord) = $rows[0];
 491                         if($prev_id == $row_id) {
 492                                 # after self? this shouldn't happen
 493                                 return $prev_ord;
 494                         }
 495                         if(count($rows) == 1) {
 496                                 # we should be last
 497                                 $next_ord = DB_ORD_MAX;
 498                         } else {
 499                                 list($next_id, $next_ord) = $rows[1];
 500                                 if($next_id == $row_id) {
 501                                         # after prev (already there)
 502                                         return $next_ord;
 503                                 }
 504                         }
 505                 }
 506         }
 507         if($prev_ord + 1 == $next_ord || $prev_ord == $next_ord) { # the latter should never happen
 508                 if($renumbered_already) {
 509                         message("Programmer error in $pretty ordering code. Please tell your website administrator.");
 510                         return '' . rand(2, DB_ORD_MAX - 2); # reasonably unlikely to be the same as some other ord
 511                 }
 512                 db_reposition_respace($table, $field, $where);
 513                 return db_reposition($table, $row_id, $new_pos, $field, $pretty, $where, $renumbered_already = true);
 514         } else {
 515                 return $prev_ord + round(($next_ord - $prev_ord) / 2);
 516         }
 517 }