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 # helper function
 165 function db_send_get($table, $columns, $where, $args) {
 166         $sql = "SELECT $columns FROM $table";
 167         if($where) {
 168                 $sql .= ' ' . _db_printf($where, $args);
 169         }
 170
 171         return db_send_query($sql);
 172 }
 173
 174
 175 # if no results: returs []
 176 function db_get_rows($table, $columns, $where = '') {
 177         $args = func_get_args();
 178         $args = array_slice($args, 3);
 179         $result = db_send_get($table, $columns, $where, $args);
 180
 181         $rows = array();
 182         while($row = mysql_fetch_row($result)) {
 183                 $rows[] = $row;
 184         }
 185
 186         mysql_free_result($result);
 187
 188         return $rows;
 189 }
 190
 191 # like db_get_rows, but return array of hashes.
 192 # if no results: returs []
 193 function db_get_assocs($table, $columns, $where = '') {
 194         $args = func_get_args();
 195         $args = array_slice($args, 3);
 196         $result = db_send_get($table, $columns, $where, $args);
 197
 198         $rows = array();
 199         while($row = mysql_fetch_assoc($result)) {
 200                 $rows[] = $row;
 201         }
 202
 203         mysql_free_result($result);
 204
 205         return $rows;
 206 }
 207
 208 # if no results: returs []
 209 function db_get_column($table, $columns, $where = '') {
 210         $args = func_get_args();
 211         $args = array_slice($args, 3);
 212         $result = db_send_get($table, $columns, $where, $args);
 213
 214         $column = array();
 215         while($row = mysql_fetch_row($result)) {
 216                 $column[] = $row[0];
 217         }
 218
 219         mysql_free_result($result);
 220
 221         return $column;
 222 }
 223
 224 # returns first matching row
 225 # if no results: returns false
 226 function db_get_row($table, $columns, $where = '') {
 227         $args = func_get_args();
 228         $args = array_slice($args, 3);
 229         $result = db_send_get($table, $columns, $where, $args);
 230
 231         $row = mysql_fetch_row($result);
 232
 233         mysql_free_result($result);
 234
 235         return $row;
 236 }
 237
 238 # like db_get_row, but return a hash.
 239 # if no results: returns false
 240 function db_get_assoc($table, $columns, $where = '') {
 241         $args = func_get_args();
 242         $args = array_slice($args, 3);
 243         $result = db_send_get($table, $columns, $where, $args);
 244
 245         $row = mysql_fetch_assoc($result);
 246
 247         mysql_free_result($result);
 248
 249         return $row;
 250 }
 251
 252 # if no results: returns false
 253 function db_get_value($table, $column, $where = '') {
 254         $args = func_get_args();
 255         $args = array_slice($args, 3);
 256         $result = db_send_get($table, $column, $where, $args);
 257
 258         $value = mysql_fetch_row($result);
 259         if($value !== false) {
 260                 $value = $value[0];
 261         }
 262
 263         mysql_free_result($result);
 264
 265         return $value;
 266 }
 267
 268 function db_count($table, $where = '') {
 269         $args = func_get_args();
 270         array_splice($args, 1, 0, array('count(*)'));
 271         return call_user_func_array('db_get_value', $args);
 272 }
 273
 274 # call either of these ways:
 275 #
 276 # db_insert('people', 'name,company', 'jason', 'widgets ltd');
 277 # or
 278 # db_insert('people', 'name,company', array('jason', 'widgets ltd'));
 279 function db_insert($table, $columns, $values) {
 280         if(!is_array($values)) {
 281                 $values = func_get_args();
 282                 $values = array_slice($values, 2);
 283         }
 284
 285         db_insert_ish('INSERT', $table, $columns, $values);
 286 }
 287
 288 # like db_insert() above, but instead of passing columns and data separately,
 289 # you can pass one array with the column names as keys and the data as values
 290 function db_insert_assoc($table, $data) {
 291         $args = func_get_args();
 292         $args = array_slice($args, 2);
 293         $columns = array();
 294         $values = array();
 295         foreach($data as $key => $value) {
 296                 $columns[] = $key;
 297                 $values[] = $value;
 298         }
 299         array_unshift($args, $table, join(',', $columns), $values);
 300         call_user_func_array('db_insert', $args);
 301 }
 302
 303 # same as above, except uses the "replace" command instead of "insert"
 304 function db_replace($table, $columns, $values) {
 305         if(!is_array($values)) {
 306                 $values = func_get_args();
 307                 $values = array_slice($values, 2);
 308         }
 309
 310         db_insert_ish('REPLACE', $table, $columns, $values);
 311 }
 312
 313 # return the value mysql made up for the auto_increment field (for the last insert)
 314 function db_auto_id() {
 315         return mysql_insert_id($GLOBALS['wfpl_db_handle']);
 316 }
 317
 318
 319 # used to implement db_insert() and db_replace()
 320 function db_insert_ish($command, $table, $columns, $values) {
 321
 322         $sql = '';
 323         foreach($values as $value) {
 324                 if($sql) $sql .= ',';
 325                 $sql .= '"' . db_enc_sql($value) . '"';
 326         }
 327
 328         $sql = "$command INTO $table ($columns) values($sql)";
 329
 330         db_send_query($sql);
 331 }
 332
 333 # to be consistent with the syntax of the other db functions, $values can be an
 334 # array, a single value, or multiple parameters.
 335 #
 336 # as usual the where clause stuff is optional, but it will of course update the
 337 # whole table if you leave it off.
 338 #
 339 # examples:
 340 #
 341 # # name everybody Bruce
 342 # db_update('users', 'name', 'Bruce');
 343 #
 344 # # name user #6 Bruce
 345 # db_update('users', 'name', 'Bruce', 'where id=%i', 6);
 346 #
 347 # # update the whole bit for user #6
 348 # db_update('users', 'name,email,description', 'Bruce', 'bruce@example.com', 'is a cool guy', 'where id=%i', 6);
 349 #
 350 # # update the whole bit for user #6 (passing data as an array)
 351 # $data = array('Bruce', 'bruce@example.com', 'is a cool guy');
 352 # db_update('users', 'name,email,description', $data, 'where id=%i', 6);
 353
 354 # The prototype is really something like this:
 355 # db_update(table, columns, values..., where(optional), where_args...(optional))
 356 function db_update($table, $columns, $values) {
 357         $args = func_get_args();
 358         $args = array_slice($args, 2);
 359         $columns = explode(',', $columns);
 360         $num_fields = count($columns);
 361
 362         if(is_array($values)) {
 363                 $values = array_values($values);
 364                 $args = array_slice($args, 1);
 365         } else {
 366                 $values = array_slice($args, 0, $num_fields);
 367                 $args = array_slice($args, $num_fields);
 368         }
 369
 370         $sql = '';
 371         for($i = 0; $i < $num_fields; ++$i) {
 372                 if($sql != '') {
 373                         $sql .= ', ';
 374                 }
 375                 $sql .= $columns[$i] . ' = "' . db_enc_sql($values[$i]) . '"';
 376         }
 377
 378
 379         $sql = "UPDATE $table SET $sql";
 380
 381         # if there's any more arguments
 382         if($args) {
 383                 $where = $args[0];
 384                 $args = array_slice($args, 1);
 385
 386                 $sql .= ' ';
 387                 # any left for printf arguments?
 388                 if($args) {
 389                         $sql .= _db_printf($where, $args);
 390                 } else {
 391                         $sql .= $where;
 392                 }
 393
 394         }
 395
 396         db_send_query($sql);
 397 }
 398
 399 # like db_update() above, but instead of passing columns and data separately,
 400 # you can pass one array with the column names as keys and the data as values
 401 function db_update_assoc($table, $data) {
 402         $args = func_get_args();
 403         $args = array_slice($args, 2);
 404         $columns = array();
 405         $values = array();
 406         foreach($data as $key => $value) {
 407                 $columns[] = $key;
 408                 $values[] = $value;
 409         }
 410         array_unshift($args, $values);
 411         array_unshift($args, join(',', $columns));
 412         array_unshift($args, $table);
 413         call_user_func_array('db_update', $args);
 414 }
 415
 416 # pass args for printf-style where clause as usual
 417 function db_delete($table, $where = '') {
 418         $sql = "DELETE FROM $table";
 419         if($where) {
 420                 $sql .= ' ';
 421                 $args = func_get_args();
 422                 $args = array_slice($args, 2);
 423                 if($args) {
 424                         $sql .= _db_printf($where, $args);
 425                 } else {
 426                         $sql .= $where;
 427                 }
 428         }
 429
 430         db_send_query($sql);
 431 }
 432
 433
 434 define('DB_ORD_MAX', 2000000000);
 435
 436 function db_reposition_respace($table, $field, $where = '') {
 437         if($where) {
 438                 $andand = " && ($where) ";
 439         }
 440         $ids = db_get_column($table, 'id', "where $field != 0 $andand order by $field");
 441         $c = count($ids);
 442         if(!$c) {
 443                 # should never happen
 444                 return;
 445         }
 446         $inc = floor(DB_ORD_MAX / ($c + 1));
 447         $cur = $inc;
 448         foreach($ids as $id) {
 449                 db_update($table, $field, $cur, 'where id=%i', $id);
 450                 $cur += $inc;
 451         }
 452 }
 453
 454 # this function facilitates letting the user manually sort records (with (int) $field != 0)
 455 #
 456 # 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.
 457 #
 458 # $pretty is used in error messages to refer to the row, it defaults to whatever you pass for $table.
 459 #
 460 # return value is the "ord" value you should set/insert into your database
 461
 462 function db_reposition($table, $row_id, $new_pos, $field = 'ord', $pretty = 'same as $table', $where = '', $renumbered_already = false) {
 463         if($pretty == 'same as $table') {
 464                 $pretty = $table;
 465         }
 466         if($where) {
 467                 $andand = " && ($where) ";
 468         }
 469
 470         if($new_pos === 'ignored') {
 471                 # not sorted
 472                 return '0';
 473         }
 474
 475         # strategy: calculate $prev_ord and $next_ord. If there's no space between, renumber and recurse
 476         if($new_pos == '0') {
 477                 $row = db_get_row($table, "id,$field", "where $field != 0 $andand order by $field limit 1");
 478                 if($row) {
 479                         list($first_row_id, $first_row_ord) = $row;
 480                         if($first_row_id == $row_id) {
 481                                 # already first
 482                                 return $first_row_ord;
 483                         }
 484                         $next_ord = $first_row_ord;
 485                 } else {
 486                         # this is the only row, put it in the middle
 487                         return '' + floor(DB_ORD_MAX / 2);
 488                 }
 489
 490                 $prev_ord = 0;
 491         } else {
 492                 $new_pos = format_int_0($new_pos);
 493                 $rows = db_get_rows($table, "id,$field", "where $field != 0 $andand order by $field limit %i,2", $new_pos - 1);
 494                 if(!$rows) {
 495                         message("Sorry, couldn't find the $pretty you asked to put this $pretty after. Putting it first instead.");
 496                         return db_reposition($table, $row_id, '0', $field, $pretty, $where);
 497                 } else {
 498                         list($prev_id, $prev_ord) = $rows[0];
 499                         if($prev_id == $row_id) {
 500                                 # after self? this shouldn't happen
 501                                 return $prev_ord;
 502                         }
 503                         if(count($rows) == 1) {
 504                                 # we should be last
 505                                 $next_ord = DB_ORD_MAX;
 506                         } else {
 507                                 list($next_id, $next_ord) = $rows[1];
 508                                 if($next_id == $row_id) {
 509                                         # after prev (already there)
 510                                         return $next_ord;
 511                                 }
 512                         }
 513                 }
 514         }
 515         if($prev_ord + 1 == $next_ord || $prev_ord == $next_ord) { # the latter should never happen
 516                 if($renumbered_already) {
 517                         message("Programmer error in $pretty ordering code. Please tell your website administrator.");
 518                         return '' . rand(2, DB_ORD_MAX - 2); # reasonably unlikely to be the same as some other ord
 519                 }
 520                 db_reposition_respace($table, $field, $where);
 521                 return db_reposition($table, $row_id, $new_pos, $field, $pretty, $where, $renumbered_already = true);
 522         } else {
 523                 return $prev_ord + round(($next_ord - $prev_ord) / 2);
 524         }
 525 }