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