Wordpress 2.3.2
[autoinstalls/wordpress.git] / wp-includes / wp-db.php
index 790ddcfdee26c13734b01c655e7cd2b05860d424..b37078834847a4ee18c13cbe76c37153178afa9a 100644 (file)
@@ -15,11 +15,12 @@ if (!defined('SAVEQUERIES'))
 
 class wpdb {
 
-       var $show_errors = true;
-       var $num_queries = 0;   
+       var $show_errors = false;
+       var $num_queries = 0;
        var $last_query;
        var $col_info;
        var $queries;
+       var $ready = false;
 
        // Our tables
        var $posts;
@@ -28,24 +29,43 @@ class wpdb {
        var $post2cat;
        var $comments;
        var $links;
-       var $linkcategories;
        var $options;
        var $optiontypes;
        var $optionvalues;
        var $optiongroups;
        var $optiongroup_options;
        var $postmeta;
-
-       // ==================================================================
-       //      DB Constructor - connects to the server and selects a database
-
+       var $usermeta;
+       var $terms;
+       var $term_taxonomy;
+       var $term_relationships;
+
+       var $charset;
+       var $collate;
+
+       /**
+        * Connects to the database server and selects a database
+        * @param string $dbuser
+        * @param string $dbpassword
+        * @param string $dbname
+        * @param string $dbhost
+        */
        function wpdb($dbuser, $dbpassword, $dbname, $dbhost) {
                return $this->__construct($dbuser, $dbpassword, $dbname, $dbhost);
        }
-       
+
        function __construct($dbuser, $dbpassword, $dbname, $dbhost) {
                register_shutdown_function(array(&$this, "__destruct"));
 
+               if ( defined('WP_DEBUG') and WP_DEBUG == true )
+                       $this->show_errors();
+
+               if ( defined('DB_CHARSET') )
+                       $this->charset = DB_CHARSET;
+
+               if ( defined('DB_COLLATE') )
+                       $this->collate = DB_COLLATE;
+
                $this->dbh = @mysql_connect($dbhost, $dbuser, $dbpassword);
                if (!$this->dbh) {
                        $this->bail("
@@ -58,34 +78,47 @@ class wpdb {
 </ul>
 <p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='http://wordpress.org/support/'>WordPress Support Forums</a>.</p>
 ");
+                       return;
                }
 
+               $this->ready = true;
+
+               if ( !empty($this->charset) && version_compare(mysql_get_server_info(), '4.1.0', '>=') )
+                       $this->query("SET NAMES '$this->charset'");
+
                $this->select($dbname);
        }
 
        function __destruct() {
-               return true;            
+               return true;
        }
 
-       // ==================================================================
-       //      Select a DB (if another one needs to be selected)
-
+       /**
+        * Selects a database using the current class's $this->dbh
+        * @param string $db name
+        */
        function select($db) {
                if (!@mysql_select_db($db, $this->dbh)) {
+                       $this->ready = false;
                        $this->bail("
 <h1>Can&#8217;t select database</h1>
 <p>We were able to connect to the database server (which means your username and password is okay) but not able to select the <code>$db</code> database.</p>
 <ul>
 <li>Are you sure it exists?</li>
+<li>Does the user <code>".DB_USER."</code> have permission to use the <code>$db</code> database?</li>
 <li>On some systems the name of your database is prefixed with your username, so it would be like username_wordpress. Could that be the problem?</li>
 </ul>
 <p>If you don't know how to setup a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href='http://wordpress.org/support/'>WordPress Support Forums</a>.</p>");
+                       return;
                }
        }
 
-       // ====================================================================
-       //      Format a string correctly for safe insert under all PHP conditions
-       
+       /**
+        * Escapes content for insertion into the database, for security
+        *
+        * @param string $string
+        * @return string query safe string
+        */
        function escape($string) {
                return addslashes( $string ); // Disable rest for now, causing problems
                if( !$this->dbh || version_compare( phpversion(), '4.3.0' ) == '-1' )
@@ -94,38 +127,68 @@ class wpdb {
                        return mysql_real_escape_string( $string, $this->dbh );
        }
 
+       /**
+        * Escapes content by reference for insertion into the database, for security
+        * @param string $s
+        */
+       function escape_by_ref(&$s) {
+               $s = $this->escape($s);
+       }
+
+       /**
+        * Prepares a SQL query for safe use, using sprintf() syntax
+        */
+       function prepare($args=NULL) {
+               if ( NULL === $args )
+                       return;
+               $args = func_get_args();
+               $query = array_shift($args);
+               $query = str_replace("'%s'", '%s', $query); // in case someone mistakenly already singlequoted it
+               $query = str_replace('"%s"', '%s', $query); // doublequote unquoting
+               $query = str_replace('%s', "'%s'", $query); // quote the strings
+               array_walk($args, array(&$this, 'escape_by_ref'));
+               return @vsprintf($query, $args);
+       }
+
        // ==================================================================
        //      Print SQL/DB error.
 
        function print_error($str = '') {
                global $EZSQL_ERROR;
-               if (!$str) $str = mysql_error();
-               $EZSQL_ERROR[] = 
+               if (!$str) $str = mysql_error($this->dbh);
+               $EZSQL_ERROR[] =
                array ('query' => $this->last_query, 'error_str' => $str);
 
+               $error_str = "WordPress database error $str for query $this->last_query";
+               error_log($error_str, 0);
+
+               // Is error output turned on or not..
+               if ( !$this->show_errors )
+                       return false;
+
                $str = htmlspecialchars($str, ENT_QUOTES);
                $query = htmlspecialchars($this->last_query, ENT_QUOTES);
-               // Is error output turned on or not..
-               if ( $this->show_errors ) {
-                       // If there is an error then take note of it
-                       print "<div id='error'>
-                       <p class='wpdberror'><strong>WordPress database error:</strong> [$str]<br />
-                       <code>$query</code></p>
-                       </div>";
-               } else {
-                       return false;   
-               }
+
+               // If there is an error then take note of it
+               print "<div id='error'>
+               <p class='wpdberror'><strong>WordPress database error:</strong> [$str]<br />
+               <code>$query</code></p>
+               </div>";
        }
 
        // ==================================================================
        //      Turn error handling on or off..
 
-       function show_errors() {
-               $this->show_errors = true;
+       function show_errors( $show = true ) {
+               $errors = $this->show_errors;
+               $this->show_errors = $show;
+               return $errors;
        }
-       
+
        function hide_errors() {
+               $show = $this->show_errors;
                $this->show_errors = false;
+               return $show;
        }
 
        // ==================================================================
@@ -141,6 +204,9 @@ class wpdb {
        //      Basic Query     - see docs for more detail
 
        function query($query) {
+               if ( ! $this->ready )
+                       return false;
+
                // filter the query, if filters are available
                // NOTE: some queries are made before the plugins have been loaded, and thus cannot be filtered with this method
                if ( function_exists('apply_filters') )
@@ -159,7 +225,7 @@ class wpdb {
                // Perform the query via std mysql_query function..
                if (SAVEQUERIES)
                        $this->timer_start();
-               
+
                $this->result = @mysql_query($query, $this->dbh);
                ++$this->num_queries;
 
@@ -167,16 +233,16 @@ class wpdb {
                        $this->queries[] = array( $query, $this->timer_stop() );
 
                // If there is an error then take note of it..
-               if ( mysql_error() ) {
+               if ( mysql_error($this->dbh) ) {
                        $this->print_error();
                        return false;
                }
 
                if ( preg_match("/^\\s*(insert|delete|update|replace) /i",$query) ) {
-                       $this->rows_affected = mysql_affected_rows();
+                       $this->rows_affected = mysql_affected_rows($this->dbh);
                        // Take note of the insert_id
                        if ( preg_match("/^\\s*(insert|replace) /i",$query) ) {
-                               $this->insert_id = mysql_insert_id($this->dbh); 
+                               $this->insert_id = mysql_insert_id($this->dbh);
                        }
                        // Return number of rows affected
                        $return_val = $this->rows_affected;
@@ -196,7 +262,7 @@ class wpdb {
 
                        // Log number of rows the query returned
                        $this->num_rows = $num_rows;
-                       
+
                        // Return number of rows selected
                        $return_val = $this->num_rows;
                }
@@ -204,9 +270,13 @@ class wpdb {
                return $return_val;
        }
 
-       // ==================================================================
-       //      Get one variable from the DB - see docs for more detail
-
+       /**
+        * Get one variable from the database
+        * @param string $query (can be null as well, for caching, see codex)
+        * @param int $x = 0 row num to return
+        * @param int $y = 0 col num to return
+        * @return mixed results
+        */
        function get_var($query=null, $x = 0, $y = 0) {
                $this->func_call = "\$db->get_var(\"$query\",$x,$y)";
                if ( $query )
@@ -221,13 +291,22 @@ class wpdb {
                return (isset($values[$x]) && $values[$x]!=='') ? $values[$x] : null;
        }
 
-       // ==================================================================
-       //      Get one row from the DB - see docs for more detail
-
+       /**
+        * Get one row from the database
+        * @param string $query
+        * @param string $output ARRAY_A | ARRAY_N | OBJECT
+        * @param int $y row num to return
+        * @return mixed results
+        */
        function get_row($query = null, $output = OBJECT, $y = 0) {
                $this->func_call = "\$db->get_row(\"$query\",$output,$y)";
                if ( $query )
                        $this->query($query);
+               else
+                       return null;
+
+               if ( !isset($this->last_result[$y]) )
+                       return null;
 
                if ( $output == OBJECT ) {
                        return $this->last_result[$y] ? $this->last_result[$y] : null;
@@ -240,14 +319,17 @@ class wpdb {
                }
        }
 
-       // ==================================================================
-       //      Function to get 1 column from the cached result set based in X index
-       // se docs for usage and info
-
+       /**
+        * Gets one column from the database
+        * @param string $query (can be null as well, for caching, see codex)
+        * @param int $x col num to return
+        * @return array results
+        */
        function get_col($query = null , $x = 0) {
                if ( $query )
                        $this->query($query);
 
+               $new_array = array();
                // Extract the column values
                for ( $i=0; $i < count($this->last_result); $i++ ) {
                        $new_array[$i] = $this->get_var(null, $x, $i);
@@ -255,14 +337,19 @@ class wpdb {
                return $new_array;
        }
 
-       // ==================================================================
-       // Return the the query as a result set - see docs for more details
-
+       /**
+        * Return an entire result set from the database
+        * @param string $query (can also be null to pull from the cache)
+        * @param string $output ARRAY_A | ARRAY_N | OBJECT
+        * @return mixed results
+        */
        function get_results($query = null, $output = OBJECT) {
                $this->func_call = "\$db->get_results(\"$query\", $output)";
 
                if ( $query )
                        $this->query($query);
+               else
+                       return null;
 
                // Send back array of objects. Each row is an object
                if ( $output == OBJECT ) {
@@ -284,11 +371,12 @@ class wpdb {
                }
        }
 
-
-       // ==================================================================
-       // Function to get column meta data info pertaining to the last query
-       // see docs for more info and usage
-
+       /**
+        * Grabs column metadata from the last query
+        * @param string $info_type one of name, table, def, max_length, not_null, primary_key, multiple_key, unique_key, numeric, blob, type, unsigned, zerofill
+        * @param int $col_offset 0: col name. 1: which table the col's in. 2: col's max length. 3: if the col is numeric. 4: col's type
+        * @return mixed results
+        */
        function get_col_info($info_type = 'name', $col_offset = -1) {
                if ( $this->col_info ) {
                        if ( $col_offset == -1 ) {
@@ -304,14 +392,21 @@ class wpdb {
                }
        }
 
+       /**
+        * Starts the timer, for debugging purposes
+        */
        function timer_start() {
                $mtime = microtime();
                $mtime = explode(' ', $mtime);
                $this->time_start = $mtime[1] + $mtime[0];
                return true;
        }
-       
-       function timer_stop($precision = 3) {
+
+       /**
+        * Stops the debugging timer
+        * @return int total time spent on the query, in milliseconds
+        */
+       function timer_stop() {
                $mtime = microtime();
                $mtime = explode(' ', $mtime);
                $time_end = $mtime[1] + $mtime[0];
@@ -319,62 +414,22 @@ class wpdb {
                return $time_total;
        }
 
+       /**
+        * Wraps fatal errors in a nice header and footer and dies.
+        * @param string $message
+        */
        function bail($message) { // Just wraps errors in a nice header and footer
-       if ( !$this->show_errors )
-               return false;
-       header( 'Content-Type: text/html; charset=utf-8');              
-       echo <<<HEAD
-       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-       <html xmlns="http://www.w3.org/1999/xhtml">
-       <head>
-               <title>WordPress &rsaquo; Error</title>
-               <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-               <style media="screen" type="text/css">
-               <!--
-               html {
-                       background: #eee;
-               }
-               body {
-                       background: #fff;
-                       color: #000;
-                       font-family: Georgia, "Times New Roman", Times, serif;
-                       margin-left: 25%;
-                       margin-right: 25%;
-                       padding: .2em 2em;
-               }
-               
-               h1 {
-                       color: #006;
-                       font-size: 18px;
-                       font-weight: lighter;
-               }
-               
-               h2 {
-                       font-size: 16px;
-               }
-               
-               p, li, dt {
-                       line-height: 140%;
-                       padding-bottom: 2px;
-               }
-       
-               ul, ol {
-                       padding: 5px 5px 5px 20px;
-               }
-               #logo {
-                       margin-bottom: 2em;
+               if ( !$this->show_errors ) {
+                       if ( class_exists('WP_Error') )
+                               $this->error = new WP_Error('500', $message);
+                       else
+                               $this->error = $message;
+                       return false;
                }
-               -->
-               </style>
-       </head>
-       <body>
-       <h1 id="logo"><img alt="WordPress" src="http://static.wordpress.org/logo.png" /></h1>
-HEAD;
-       echo $message;
-       echo "</body></html>";
-       die();
+               wp_die($message);
        }
 }
 
-$wpdb = new wpdb(DB_USER, DB_PASSWORD, DB_NAME, DB_HOST);
-?>
\ No newline at end of file
+if ( ! isset($wpdb) )
+       $wpdb = new wpdb(DB_USER, DB_PASSWORD, DB_NAME, DB_HOST);
+?>