3 # Copyright (C) 2006 Jason Woofenden
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.
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.
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/>.
19 require_once(__DIR__.'/'.'encode.php');
20 require_once(__DIR__.'/'.'format.php');
22 # db_connect() -- connect to a mysql database
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
30 # user: username for connecting to the database. Defaults to
31 # $GLOBALS['db_username'] or (if that's not set) "www".
33 # password: password for connecting to the database. Defaults to
34 # $GLOBALS['db_password'] or (if that's not set "".
38 # the database connection handle. You'll only need this if you want to have
39 # multiple databases open at once.
41 function db_enc_sql($str) {
42 return mysqli_real_escape_string(isset($GLOBALS['wfpl_db_handle']) ? $GLOBALS['wfpl_db_handle'] : null, $str);
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'];
50 $host = $_SERVER['SERVER_NAME'];
51 $host = explode('.', $host);
53 $database = array_pop($host);
59 if(isset($GLOBALS['db_username'])) {
60 $user = $GLOBALS['db_username'];
67 if(isset($GLOBALS['db_password'])) {
68 $pass = $GLOBALS['db_password'];
74 $GLOBALS['wfpl_db_handle'] = mysqli_connect($host, $user, $pass);
75 if(!$GLOBALS['wfpl_db_handle']) {
76 die('Could not connect to the database: ' . mysqli_error());
79 mysqli_set_charset($GLOBALS['wfpl_db_handle'], $encoding);
81 if(!mysqli_select_db($GLOBALS['wfpl_db_handle'], $database)) {
82 die("Couldn not access database \"$database\": " . mysqli_error($GLOBALS['wfpl_db_handle']));
85 return $GLOBALS['wfpl_db_handle'];
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 = mysqli_query($GLOBALS['wfpl_db_handle'], $sql);
93 die(enc_html('DATABASE ERROR: ' . mysqli_error($GLOBALS['wfpl_db_handle']) . ' in the following query: ' . $sql));
99 # All select queries use this to generate the where clause, so they can work
100 # like printf. Currently three % codes are supported:
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!
109 # complex example: db_get_rows('mytable', 'id', 'where name=%" or company like "%%%s%%"', $name, $company_partial);
111 function db_printf($str) {
112 $args = func_get_args();
113 $args = array_slice($args, 1);
114 return _db_printf($str, $args);
117 # This function does the work, but takes the parameters in an array
118 function _db_printf($str, $args) {
121 $pos = strpos($str, '%');
122 if($pos === false) { # not found
126 # move everything up to (but not including) % to the output
127 $out .= substr($str, 0, $pos);
129 # grab the character after the %
130 $chr = substr($str, $pos + 1, 1);
132 # remove the stuff we've read from input
133 $str = substr($str, $pos + 2);
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';
143 } elseif($chr == 'f') {
144 $arg = array_shift($args);
145 if(is_numeric($arg)) {
146 $arg = sprintf("%f", $arg);
148 $arg = format_decimal($arg);
149 if(strlen($arg) < 1) {
153 } elseif($chr == '$') {
154 $out .= array_shift($args);
165 function db_send_get($table, $columns, $where, $args) {
166 $sql = "SELECT $columns FROM $table";
168 $sql .= ' ' . _db_printf($where, $args);
171 return db_send_query($sql);
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);
182 while($row = mysqli_fetch_row($result)) {
186 mysqli_free_result($result);
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);
199 while($row = mysqli_fetch_assoc($result)) {
203 mysqli_free_result($result);
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);
215 while($row = mysqli_fetch_row($result)) {
219 mysqli_free_result($result);
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);
231 $row = mysqli_fetch_row($result);
233 mysqli_free_result($result);
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);
245 $row = mysqli_fetch_assoc($result);
247 mysqli_free_result($result);
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);
258 $value = mysqli_fetch_row($result);
259 if($value !== false) {
263 mysqli_free_result($result);
269 function db_count($table, $where = '') {
270 $args = func_get_args();
271 array_splice($args, 1, 0, array('count(*)'));
272 return (int) call_user_func_array('db_get_value', $args);
275 # call either of these ways:
277 # db_insert('people', 'name,company', 'jason', 'widgets ltd');
279 # db_insert('people', 'name,company', array('jason', 'widgets ltd'));
280 function db_insert($table, $columns, $values) {
281 if(!is_array($values)) {
282 $values = func_get_args();
283 $values = array_slice($values, 2);
286 db_insert_ish('INSERT', $table, $columns, $values);
289 # like db_insert() above, but instead of passing columns and data separately,
290 # you can pass one array with the column names as keys and the data as values
291 function db_insert_assoc($table, $data) {
292 $args = func_get_args();
293 $args = array_slice($args, 2);
296 foreach($data as $key => $value) {
300 array_unshift($args, $table, join(',', $columns), $values);
301 call_user_func_array('db_insert', $args);
304 # same as above, except uses the "replace" command instead of "insert"
305 function db_replace($table, $columns, $values) {
306 if(!is_array($values)) {
307 $values = func_get_args();
308 $values = array_slice($values, 2);
311 db_insert_ish('REPLACE', $table, $columns, $values);
314 # return the value mysql made up for the auto_increment field (for the last insert)
315 function db_auto_id() {
316 return mysqli_insert_id($GLOBALS['wfpl_db_handle']);
320 # used to implement db_insert() and db_replace()
321 function db_insert_ish($command, $table, $columns, $values) {
324 foreach($values as $value) {
325 if($sql) $sql .= ',';
326 $sql .= '"' . db_enc_sql($value) . '"';
329 $sql = "$command INTO $table ($columns) values($sql)";
334 # to be consistent with the syntax of the other db functions, $values can be an
335 # array, a single value, or multiple parameters.
337 # as usual the where clause stuff is optional, but it will of course update the
338 # whole table if you leave it off.
342 # # name everybody Bruce
343 # db_update('users', 'name', 'Bruce');
345 # # name user #6 Bruce
346 # db_update('users', 'name', 'Bruce', 'where id=%i', 6);
348 # # update the whole bit for user #6
349 # db_update('users', 'name,email,description', 'Bruce', 'bruce@example.com', 'is a cool guy', 'where id=%i', 6);
351 # # update the whole bit for user #6 (passing data as an array)
352 # $data = array('Bruce', 'bruce@example.com', 'is a cool guy');
353 # db_update('users', 'name,email,description', $data, 'where id=%i', 6);
355 # The prototype is really something like this:
356 # db_update(table, columns, values..., where(optional), where_args...(optional))
357 function db_update($table, $columns, $values) {
358 $args = func_get_args();
359 $args = array_slice($args, 2);
360 $columns = explode(',', $columns);
361 $num_fields = count($columns);
363 if(is_array($values)) {
364 $values = array_values($values);
365 $args = array_slice($args, 1);
367 $values = array_slice($args, 0, $num_fields);
368 $args = array_slice($args, $num_fields);
372 for($i = 0; $i < $num_fields; ++$i) {
376 $sql .= $columns[$i] . ' = "' . db_enc_sql($values[$i]) . '"';
380 $sql = "UPDATE $table SET $sql";
382 # if there's any more arguments
385 $args = array_slice($args, 1);
388 # any left for printf arguments?
390 $sql .= _db_printf($where, $args);
400 # like db_update() above, but instead of passing columns and data separately,
401 # you can pass one array with the column names as keys and the data as values
402 function db_update_assoc($table, $data) {
403 $args = func_get_args();
404 $args = array_slice($args, 2);
407 foreach($data as $key => $value) {
411 array_unshift($args, $values);
412 array_unshift($args, join(',', $columns));
413 array_unshift($args, $table);
414 call_user_func_array('db_update', $args);
417 # pass args for printf-style where clause as usual
418 function db_delete($table, $where = '') {
419 $sql = "DELETE FROM $table";
422 $args = func_get_args();
423 $args = array_slice($args, 2);
425 $sql .= _db_printf($where, $args);
435 define('DB_ORD_MAX', 2000000000);
437 function db_reposition_respace($table, $field, $where = '') {
439 $andand = " && ($where) ";
441 $ids = db_get_column($table, 'id', "where $field != 0 $andand order by $field");
444 # should never happen
447 $inc = floor(DB_ORD_MAX / ($c + 1));
449 foreach($ids as $id) {
450 db_update($table, $field, $cur, 'where id=%i', $id);
455 # this function facilitates letting the user manually sort records (with (int) $field != 0)
457 # 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.
459 # $pretty is used in error messages to refer to the row, it defaults to whatever you pass for $table.
461 # return value is the "ord" value you should set/insert into your database
463 function db_reposition($table, $row_id, $new_pos, $field = 'ord', $pretty = 'same as $table', $where = '', $renumbered_already = false) {
464 if($pretty == 'same as $table') {
468 $andand = " && ($where) ";
471 if($new_pos === 'ignored') {
476 # strategy: calculate $prev_ord and $next_ord. If there's no space between, renumber and recurse
477 if($new_pos == '0') {
478 $row = db_get_row($table, "id,$field", "where $field != 0 $andand order by $field limit 1");
480 list($first_row_id, $first_row_ord) = $row;
481 if($first_row_id == $row_id) {
483 return $first_row_ord;
485 $next_ord = $first_row_ord;
487 # this is the only row, put it in the middle
488 return '' + floor(DB_ORD_MAX / 2);
493 $new_pos = format_int_0($new_pos);
494 $rows = db_get_rows($table, "id,$field", "where $field != 0 $andand order by $field limit %i,2", $new_pos - 1);
496 message("Sorry, couldn't find the $pretty you asked to put this $pretty after. Putting it first instead.");
497 return db_reposition($table, $row_id, '0', $field, $pretty, $where);
499 list($prev_id, $prev_ord) = $rows[0];
500 if($prev_id == $row_id) {
501 # after self? this shouldn't happen
504 if(count($rows) == 1) {
506 $next_ord = DB_ORD_MAX;
508 list($next_id, $next_ord) = $rows[1];
509 if($next_id == $row_id) {
510 # after prev (already there)
516 if($prev_ord + 1 == $next_ord || $prev_ord == $next_ord) { # the latter should never happen
517 if($renumbered_already) {
518 message("Programmer error in $pretty ordering code. Please tell your website administrator.");
519 return '' . rand(2, DB_ORD_MAX - 2); # reasonably unlikely to be the same as some other ord
521 db_reposition_respace($table, $field, $where);
522 return db_reposition($table, $row_id, $new_pos, $field, $pretty, $where, $renumbered_already = true);
524 return $prev_ord + round(($next_ord - $prev_ord) / 2);