JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
db_printf()'s %s, dwt_append(), states pulldown, tem_top_subs()
[wfpl.git] / db.php
diff --git a/db.php b/db.php
index 4cb4a61..3e4f725 100644 (file)
--- a/db.php
+++ b/db.php
@@ -4,39 +4,42 @@
 #
 #  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') {
@@ -98,15 +101,15 @@ function db_send_query($sql) {
 # %"  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 = '';
@@ -127,6 +130,8 @@ function _db_printf($str, $args) {
 
                if($chr == '"') {
                        $out .= '"' . enc_sql(array_pop($args)) . '"';
+               } elseif($chr == 's') {
+                       $out .= enc_sql(array_pop($args));
                } elseif($chr == 'i') {
                        $int = format_int(array_pop($args));
                        if($int == '') $int = '0';
@@ -143,7 +148,7 @@ function _db_printf($str, $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);
@@ -262,17 +267,17 @@ function db_insert_ish($command, $table, $columns, $values) {
 # db_update('users', 'name', 'Bruce');
 #
 # # name user #6 Bruce
-# db_update('users', 'name', 'Bruce', 'id= %"', 6);
+# 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', 'id= %"', 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, 'id= %"', 6);
+# 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
+# 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);
@@ -302,7 +307,7 @@ function db_update($table, $columns, $values) {
                $where = $args[0];
                $args = array_slice($args, 1);
 
-               $sql .= ' WHERE ';
+               $sql .= ' ';
                # any left for where claus arguments?
                if($args) {
                        $sql .= _db_printf($where, $args);
@@ -319,7 +324,7 @@ function db_update($table, $columns, $values) {
 function db_delete($table, $where = '') {
        $sql = "DELETE FROM $table";
        if($where) {
-               $sql .= ' WHERE ';
+               $sql .= ' ';
                $args = func_get_args();
                $args = array_slice($args, 2);
                if($args) {