#
# This file is part of wfpl.
#
-# wfpl is free software; you can redistribute it and/or modify it
-# under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2, or (at your option)
+# wfpl is free software; you can redistribute it and/or modify it under the
+# terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation; either version 2.1 of the License, or (at your option)
# any later version.
#
-# wfpl is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
+# wfpl is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
+# more details.
#
-# You should have received a copy of the GNU General Public License
-# along with wfpl; see the file COPYING. If not, write to the
-# Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-# MA 02111-1307, USA.
+# You should have received a copy of the GNU Lesser General Public License
+# along with wfpl; if not, write to the Free Software Foundation, Inc., 51
+# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
require_once('code/wfpl/encode.php');
require_once('code/wfpl/format.php');
-# db_connect() parameters:
+# db_connect() -- connect to a mysql database
#
-# database: the name of the database you want to connect to. Defaults to the
-# second-to-last part of the domain name. eg for foo.example.com it would be
-# "example".
+# PARAMETERS:
#
-# user: username for connecting to the database. Defaults to
-# $GLOBALS['db_username'] or (if that's not set) "www".
+# database: the name of the database you want to connect to. Defaults to the
+# second-to-last part of the domain name. eg for foo.example.com it would be
+# "example".
+#
+# user: username for connecting to the database. Defaults to
+# $GLOBALS['db_username'] or (if that's not set) "www".
+#
+# password: password for connecting to the database. Defaults to
+# $GLOBALS['db_password'] or (if that's not set "".
#
-# password: password for connecting to the database. Defaults to
-# $GLOBALS['db_password'] or (if that's not set "".
+# RETURNS:
#
-# RETURNS: the database connection handle. You'll only need this if you
-# want to have multiple databases open at once.
+# the database connection handle. You'll only need this if you want to have
+# multiple databases open at once.
function db_connect($database = 'auto', $user = 'auto', $pass = 'auto', $host = 'localhost') {
if($database == 'auto') {
}
if(!mysql_select_db($database, $GLOBALS['wfpl_db_handle'])) {
- die("Couldn not access database \"$database\": " . mysql_error());
+ die("Couldn not access database \"$database\": " . mysql_error($GLOBALS['wfpl_db_handle']));
}
return $GLOBALS['wfpl_db_handle'];
# Unless you're doing something unusual like an ALTER TABLE don't call this directly
function db_send_query($sql) {
#echo("Sending query: " . enc_html($sql) . "<br>\n");
- $result = mysql_query($sql);
+ $result = mysql_query($sql, $GLOBALS['wfpl_db_handle']);
if(!$result) {
- die(enc_html('DATABASE ERROR: ' . mysql_error() . ' in the following query: ' . $sql));
+ die(enc_html('DATABASE ERROR: ' . mysql_error($GLOBALS['wfpl_db_handle']) . ' in the following query: ' . $sql));
}
return $result;
# %" output double quotes, surrounding the variable which is encoded to be in there.
# %s output encoded to be in double quotes, but don't output the quotes
#
-# complex example: db_get_rows('mytable', 'id', 'name=%" or company like "%%%s%%"', $name, $company_partial);
+# complex example: db_get_rows('mytable', 'id', 'where name=%" or company like "%%%s%%"', $name, $company_partial);
function db_printf($str) {
$args = func_get_args();
$args = array_slice($args, 1);
- _db_printf($str, $args);
+ return _db_printf($str, $args);
}
-# This function does the work, but takes the parameters in an array, and backwards.
+# This function does the work, but takes the parameters in an array
function _db_printf($str, $args) {
- $args = array_reverse($args); # because array_pop() takes from the end
$out = '';
while($str) {
$pos = strpos($str, '%');
$str = substr($str, $pos + 2);
if($chr == '"') {
- $out .= '"' . enc_sql(array_pop($args)) . '"';
+ $out .= '"' . enc_sql(array_shift($args)) . '"';
+ } elseif($chr == 's') {
+ $out .= enc_sql(array_shift($args));
} elseif($chr == 'i') {
- $int = format_int(array_pop($args));
+ $int = format_int(array_shift($args));
if($int == '') $int = '0';
$out .= $int;
} else {
}
-function db_send_get($table, $columns, $where = '', $args) {
+function db_send_get($table, $columns, $where, $args) {
$sql = "SELECT $columns FROM $table";
if($where) {
- $sql .= ' WHERE ' . _db_printf($where, $args);
+ $sql .= ' ' . _db_printf($where, $args);
}
return db_send_query($sql);
return $value;
}
+function db_count($table, $where = '') {
+ return db_get_value($table, 'count(*)', $where);
+}
+
# call either of these ways:
#
# db_insert('people', 'name,company', 'jason', 'widgets ltd');
$values = func_get_args();
$values = array_slice($values, 2);
}
+
+ db_insert_ish('INSERT', $table, $columns, $values);
+}
+# same as above, except uses the "replace" command instead of "insert"
+function db_replace($table, $columns, $values) {
+ if(!is_array($values)) {
+ $values = func_get_args();
+ $values = array_slice($values, 2);
+ }
+
+ db_insert_ish('REPLACE', $table, $columns, $values);
+}
+
+# return the value mysql made up for the auto_increment field (for the last insert)
+function db_auto_id() {
+ return mysql_insert_id($GLOBALS['wfpl_db_handle']);
+}
+
+
+# used to implement db_insert() and db_replace()
+function db_insert_ish($command, $table, $columns, $values) {
$sql = '';
foreach($values as $value) {
$sql .= '"' . enc_sql($value) . '"';
}
- $sql = "INSERT INTO $table ($columns) values($sql)";
+ $sql = "$command INTO $table ($columns) values($sql)";
+
+ db_send_query($sql);
+}
+
+# to be consistant with the syntax of the other db functions, $values can be an
+# array, a single value, or multiple parameters.
+#
+# as usual the where clause stuff is optional, but it will ofcourse update the
+# whole table if you leave it off.
+#
+# examples:
+#
+# # name everybody Bruce
+# db_update('users', 'name', 'Bruce');
+#
+# # name user #6 Bruce
+# db_update('users', 'name', 'Bruce', 'where id=%i', 6);
+#
+# # update the whole bit for user #6
+# db_update('users', 'name,email,description', 'Bruce', 'bruce@example.com', 'is a cool guy', 'where id=%i', 6);
+#
+# # update the whole bit for user #6 (passing data as an array)
+# $data = array('Bruce', 'bruce@example.com', 'is a cool guy');
+# db_update('users', 'name,email,description', $data, 'where id=%i', 6);
+
+# The prototype is really something like this:
+# db_update(table, columns, values..., where(optional), where_args...(optional))
+function db_update($table, $columns, $values) {
+ $args = func_get_args();
+ $args = array_slice($args, 2);
+ $columns = explode(',', $columns);
+ $num_fields = count($columns);
+
+ if(is_array($values)) {
+ $args = array_slice($args, 1);
+ } else {
+ $values = array_slice($args, 0, $num_fields);
+ $args = array_slice($args, $num_fields);
+ }
+
+ $sql = '';
+ for($i = 0; $i < $num_fields; ++$i) {
+ if($sql != '') {
+ $sql .= ', ';
+ }
+ $sql .= $columns[$i] . ' = "' . enc_sql($values[$i]) . '"';
+ }
+
+
+ $sql = "UPDATE $table SET $sql";
+
+ # if there's any more arguments
+ if($args) {
+ $where = $args[0];
+ $args = array_slice($args, 1);
+
+ $sql .= ' ';
+ # any left for where claus arguments?
+ if($args) {
+ $sql .= _db_printf($where, $args);
+ } else {
+ $sql .= $where;
+ }
+
+ }
+
+ db_send_query($sql);
+}
+
+# pass args for printf-style where clause as usual
+function db_delete($table, $where = '') {
+ $sql = "DELETE FROM $table";
+ if($where) {
+ $sql .= ' ';
+ $args = func_get_args();
+ $args = array_slice($args, 2);
+ if($args) {
+ $sql .= _db_printf($where, $args);
+ } else {
+ $sql .= $where;
+ }
+ }
db_send_query($sql);
}
Got questions, comments, patches, etc.? Contact Jason Woofenden