WordPress.org

Make WordPress Core

Ticket #11644: 11644.code_cleanup_wpdb.4.patch

File 11644.code_cleanup_wpdb.4.patch, 39.6 KB (added by hakre, 10 years ago)

  • wp-db.php

     
    1212/**
    1313 * @since 0.71
    1414 */
    15 define('EZSQL_VERSION', 'WP1.25');
     15define( 'EZSQL_VERSION', 'WP1.25' );
    1616
    1717/**
    1818 * @since 0.71
    1919 */
    20 define('OBJECT', 'OBJECT', true);
     20define( 'OBJECT', 'OBJECT', true );
    2121
    2222/**
    2323 * @since {@internal Version Unknown}}
    2424 */
    25 define('OBJECT_K', 'OBJECT_K', false);
     25define( 'OBJECT_K', 'OBJECT_K', false );
    2626
    2727/**
    2828 * @since 0.71
    2929 */
    30 define('ARRAY_A', 'ARRAY_A', false);
     30define( 'ARRAY_A', 'ARRAY_A', false );
    3131
    3232/**
    3333 * @since 0.71
    3434 */
    35 define('ARRAY_N', 'ARRAY_N', false);
     35define( 'ARRAY_N', 'ARRAY_N', false );
    3636
    3737/**
    3838 * WordPress Database Access Abstraction Object
    … …  
    6565         * Whether to suppress errors during the DB bootstrapping.
    6666         *
    6767         * @access private
    68          * @since {@internal Version Unknown}}
     68         * @since 2.5
    6969         * @var bool
    7070         */
    7171        var $suppress_errors = false;
    … …  
    7373        /**
    7474         * The last error during query.
    7575         *
    76          * @since {@internal Version Unknown}}
     76         * @see get_last_error()
     77         * @since 2.5
     78         * @access private
    7779         * @var string
    7880         */
    7981        var $last_error = '';
    … …  
    8890        var $num_queries = 0;
    8991
    9092        /**
     93         * Amount of rows returned by last query operation
     94         *
     95         * @since 1.2
     96         * @access private
     97         * @var int
     98         */
     99        var $num_rows = 0;
     100
     101        /**
     102         * Number of affected rows by last query operation
     103         *
     104         * @since 0.71
     105         * @access private
     106         * @var integer
     107         */
     108        var $rows_affected = 0;
     109
     110
     111        /**
    91112         * Saved result of the last query made
    92113         *
    93114         * @since 1.2.0
    … …  
    97118        var $last_query;
    98119
    99120        /**
     121         * Saved resultset of the last query made
     122         *
     123         * @since {@internal Version Unknown}
     124         * @access private
     125         * @var array (null if unintialized)
     126         */
     127        var $last_result;
     128
     129        /**
    100130         * Saved info on the table column
    101131         *
    102132         * @since 1.2.0
    … …  
    135165         * @var bool
    136166         */
    137167        var $ready = false;
     168
     169        /**
     170         * {@internal Missing Description}}
     171         *
     172         * @since 3.0
     173         * @access private
     174         * @var unknown_type
     175         */
    138176        var $blogid = 0;
     177
     178        /**
     179         * {@internal Missing Description}}
     180         *
     181         * @since 3.0
     182         * @access private
     183         * @var unknown_type
     184         */
    139185        var $siteid = 0;
    140186
    141187        /**
    … …  
    157203        var $users;
    158204
    159205        /**
     206         * WordPress Categories table
     207         *
     208         * @since 1.5.0
     209         * @deprecated 2.3.0 / db version 5539
     210         * @access public
     211         * @var string
     212         */
     213        var $categories;
     214
     215        /**
     216         * WordPress Post to Category table
     217         *
     218         * @since 1.5.0
     219         * @deprecated 2.3.0 / db version 5539
     220         * @access public
     221         * @var string
     222         */
     223        var $post2cat;
     224       
     225        /**
     226         * WordPress Link to Category table
     227         *
     228         * @since 1.5.0
     229         * @deprecated 2.3.0 / db version 5539
     230         * @access public
     231         * @var string
     232         */
     233        var $link2cat;
     234
     235        /**
    160236         * WordPress Comments table
    161237         *
    162238         * @since 1.5.0
    … …  
    250326
    251327        /**
    252328         * List of deprecated WordPress tables
     329         *
     330         * - categories, post2cat and link2cat are deprecated
     331         *   since 2.3.0 / db version >= 5539.
    253332         *
    254333         * @since 2.9.0
    255334         * @access private
    … …  
    406485         * @param string $dbname MySQL database name
    407486         * @param string $dbhost MySQL database host
    408487         */
    409         function wpdb($dbuser, $dbpassword, $dbname, $dbhost) {
     488        function wpdb( $dbuser, $dbpassword, $dbname, $dbhost ) {
    410489                if( defined( 'WP_USE_MULTIPLE_DB' ) && WP_USE_MULTIPLE_DB )
    411490                        $this->db_connect();
    412                 return $this->__construct($dbuser, $dbpassword, $dbname, $dbhost);
     491                return $this->__construct( $dbuser, $dbpassword, $dbname, $dbhost );
    413492        }
    414493
    415494        /**
    … …  
    426505         * @param string $dbname MySQL database name
    427506         * @param string $dbhost MySQL database host
    428507         */
    429         function __construct($dbuser, $dbpassword, $dbname, $dbhost) {
    430                 register_shutdown_function(array(&$this, "__destruct"));
     508        function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) {
     509                register_shutdown_function( array( &$this, '__destruct' ) ); # prevents the object from unloading
    431510
    432511                if ( WP_DEBUG )
    433512                        $this->show_errors();
    … …  
    442521                        $this->collate = DB_COLLATE;
    443522                }
    444523
    445                 if ( defined('DB_CHARSET') )
     524                if ( defined( 'DB_CHARSET' ) )
    446525                        $this->charset = DB_CHARSET;
    447526
    448527                $this->dbuser = $dbuser;
    449528
    450                 $this->dbh = @mysql_connect($dbhost, $dbuser, $dbpassword, true);
    451                 if (!$this->dbh) {
    452                         $this->bail(sprintf(/*WP_I18N_DB_CONN_ERROR*/"
     529                $this->dbh = @mysql_connect( $dbhost, $dbuser, $dbpassword, true );
     530                if ( !$this->dbh ) {
     531                        $this->bail( sprintf( /*WP_I18N_DB_CONN_ERROR*/"
    453532<h1>Error establishing a database connection</h1>
    454533<p>This either means that the username and password information in your <code>wp-config.php</code> file is incorrect or we can't contact the database server at <code>%s</code>. This could mean your host's database server is down.</p>
    455534<ul>
    … …  
    458537        <li>Are you sure that the database server is running?</li>
    459538</ul>
    460539<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>
    461 "/*/WP_I18N_DB_CONN_ERROR*/, $dbhost), 'db_connect_fail');
     540"/*/WP_I18N_DB_CONN_ERROR*/, $dbhost ), 'db_connect_fail' );
    462541                        return;
    463542                }
    464543
    465544                $this->ready = true;
    466545
    467                 if ( $this->has_cap( 'collation' ) && !empty($this->charset) ) {
    468                         if ( function_exists('mysql_set_charset') ) {
    469                                 mysql_set_charset($this->charset, $this->dbh);
     546                if ( $this->has_cap( 'collation' ) && !empty( $this->charset ) ) {
     547                        if ( function_exists( 'mysql_set_charset' ) ) {
     548                                mysql_set_charset( $this->charset, $this->dbh );
    470549                                $this->real_escape = true;
    471550                        } else {
    472                                 $collation_query = "SET NAMES '{$this->charset}'";
    473                                 if ( !empty($this->collate) )
    474                                         $collation_query .= " COLLATE '{$this->collate}'";
    475                                 $this->query($collation_query);
     551                                $query = $this->prepare( 'SET NAMES %s', $this->charset );
     552                                if ( !empty( $this->collate ) )
     553                                        $query .= $this->prepare( ' COLLATE %s', $this->collate );
     554                                $this->query( $query );
    476555                        }
    477556                }
    478557
    479                 $this->select($dbname, $this->dbh);
     558                $this->select( $dbname, $this->dbh );
    480559        }
    481560
    482561        /**
    483562         * PHP5 style destructor and will run when database object is destroyed.
    484563         *
     564         *
     565         *   Please see {@link __construct() class constructor} and the
     566         *   {@link register_shutdown_function() register_shutdown_function()}. for
     567         *   more details.
     568         *
     569         * @link http://www.php.net/__destruct
     570         * @link http://www.php.net/register_shutdown_function
     571         *
    485572         * @since 2.0.8
    486573         *
    487          * @return bool Always true
     574         * @return bool true
    488575         */
    489576        function __destruct() {
    490577                return true;
    … …  
    503590         */
    504591        function set_prefix( $prefix ) {
    505592
    506                 if ( preg_match('|[^a-z0-9_]|i', $prefix) )
     593                if ( preg_match( '|[^a-z0-9_]|i', $prefix ) )
    507594                        return new WP_Error('invalid_db_prefix', /*WP_I18N_DB_BAD_PREFIX*/'Invalid database prefix'/*/WP_I18N_DB_BAD_PREFIX*/);
    508595
    509596                if ( is_multisite() )
    … …  
    517604                foreach ( $this->tables( 'global' ) as $table )
    518605                        $this->$table = $prefix . $table;
    519606
    520                 if ( defined('VHOST') && empty( $this->blogid ) )
     607                if ( defined( 'VHOST' ) && empty( $this->blogid ) )
    521608                        return $old_prefix;
    522609
    523610                $this->prefix = $this->get_blog_prefix( $this->blogid );
    524611
     612                // @todo (hakre) merge those two operations into one
    525613                foreach ( (array) $this->tables( 'blog' ) as $table )
    526614                        $this->$table = $this->prefix . $table;
    527 
     615                       
    528616                foreach ( (array) $this->tables( 'old' ) as $table )
    529617                        $this->$table = $this->prefix . $table;
    530618
    531                 if ( defined('CUSTOM_USER_TABLE') )
     619                if ( defined( 'CUSTOM_USER_TABLE' ) )
    532620                        $this->users = CUSTOM_USER_TABLE;
    533621
    534                 if ( defined('CUSTOM_USER_META_TABLE') )
     622                if ( defined( 'CUSTOM_USER_META_TABLE' ) )
    535623                        $this->usermeta = CUSTOM_USER_META_TABLE;
    536624
    537625                return $old_prefix;
    538626        }
    539 
    540         function set_blog_id($blog_id, $site_id = '') {
     627       
     628        /**
     629         * blog id setter
     630         *
     631         * {@internal Missing Description}}
     632         *
     633         * @since 3.0
     634         * @access public
     635         * @param string $blog_id
     636         * @param string $site_id (optional)
     637         * @return string previous blog id
     638         */     
     639        function set_blog_id( $blog_id, $site_id = '' ) {
    541640                if ( !empty($site_id) )
    542641                        $this->siteid = $site_id;
    543642
    544                 $old_blog_id = $this->blogid;
     643                $old_blog_id  = $this->blogid;
    545644                $this->blogid = $blog_id;
    546645
    547646                $this->prefix = $this->get_blog_prefix( $this->blogid );
    … …  
    555654                return $old_blog_id;
    556655        }
    557656
     657        /**
     658         * blog prefix getter
     659         *
     660         * {@internal Missing Description}}
     661         *
     662         * @param string $blog_id (optional)
     663         * @return unknown_type
     664         */
    558665        function get_blog_prefix( $blog_id = '' ) {
    559666                if ( is_multisite() && $blog_id ) {
    560667                        if ( defined('MULTISITE') && ( $blog_id == 0 || $blog_id == 1 ) )
    … …  
    569676        /**
    570677         * Returns an array of WordPress tables.
    571678         *
     679         * Scope / Table identifiers:
     680         *
     681         *   - 'all' ........ global and blog tables.
     682         *   - 'global' ..... global tables
     683         *   - 'blog' ....... blog tables
     684         *   - 'old tables' . old (depreacted) tables
     685         *   
     686         * NOTE: This function does not reflect CUSTOM_USER_TABLE (users)
     687         *       and CUSTOM_USER_META_TABLE (usermeta) and will return
     688         *       the standard table names instead.
     689         *
    572690         * @since 3.0.0
    573          * @uses wpdb::tables
    574          * @uses wpdb::old_tables
    575          * @uses wpdb::global_tables
     691         * @uses wpdb::$tables
     692         * @uses wpdb::$old_tables
     693         * @uses wpdb::$global_tables
     694         * @uses wpdb::$ms_tables
    576695         * @uses is_multisite()
    577696         *
    578          * @param string $scope Can be all, global, blog, or old tables. Default all.
    579          *      All returns all global tables and the blog tables for the queried blog.
    580          * @param bool $prefix Whether to include the blog prefix. Default false.
    581          * @param int $blog_id The blog_id to prefix. Defaults to main blog.
     697         * @param string|array $scope (optional) Scope, Default 'all'. You can pass multiple scopes per array
     698         * @param bool $prefix (optional) Whether to include the blog prefix. Default FALSE.
     699         * @param int $blog_id (optional) The blog_id to prefix.
    582700         * @return array Table names.
    583701         */
    584         function tables( $scope = 'all', $prefix = false, $blog_id = 0 ) {
    585                 switch ( $scope ) {
    586                         case 'old' :
    587                                 $tables = $this->old_tables;
    588                                 break;
    589                         case 'blog' :
    590                                 $tables = $this->tables;
    591                                 break;
    592                         case 'global' :
    593                                 $tables = array_merge( $this->global_tables, $this->ms_tables );
    594                                 break;
    595                         case 'all' :
    596                                 $tables = array_merge( $this->global_tables, $this->tables );
    597                                 if ( is_multisite() )
    598                                         $tables = array_merge( $tables, $this->ms_tables );
    599                                 break;
     702        function tables( $scope = 'all', $prefix = false, $blog_id = '' ) {
     703               
     704                if ( is_array( $scope ) ) {
     705                        $tables = array();
     706                        foreach ( $scope as $each )
     707                                $tables = array_merge( $tables, $this->tables($each) );
     708                } else {       
     709                        switch ( $scope ) {
     710                                case 'old' :
     711                                        $tables = $this->old_tables;
     712                                        break;
     713                                case 'blog' :
     714                                        $tables = $this->tables;
     715                                        break;
     716                                case 'global' :
     717                                        $tables = array_merge( $this->global_tables, $this->ms_tables );
     718                                        if ( is_multisite() )
     719                                                $tables = array_merge( $tables, $this->ms_tables );
     720                                        break;
     721                                case 'all' :
     722                                        $tables = $this->tables( array( 'global', 'blog' ) );           
     723                                        break;
     724                        }
    600725                }
    601726
    602                 if ( $prefix ) {
     727                if ( count( $tables ) && $prefix ) {
    603728                        $prefix = $this->get_blog_prefix( $blog_id );
    604                         foreach ( $tables as $k => $table ) {
     729                        foreach ( $tables as $k => $table )
    605730                                $tables[$k] = $prefix . $table;
    606                         }
    607731                }
    608732
    609733                return $tables;
    … …  
    620744         * @param string $db MySQL database name
    621745         * @return null Always null.
    622746         */
    623         function select($db, &$dbh) {
    624                 if (!@mysql_select_db($db, $dbh)) {
     747        function select( $db, &$dbh ) {
     748                if ( !@mysql_select_db( $db, $dbh ) ) {
    625749                        $this->ready = false;
    626                         $this->bail(sprintf(/*WP_I18N_DB_SELECT_DB*/'
     750                        $this->bail( sprintf( /*WP_I18N_DB_SELECT_DB*/'
    627751<h1>Can&#8217;t select database</h1>
    628752<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>%1$s</code> database.</p>
    629753<ul>
    … …  
    631755<li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li>
    632756<li>On some systems the name of your database is prefixed with your username, so it would be like <code>username_%1$s</code>. Could that be the problem?</li>
    633757</ul>
    634 <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>'/*/WP_I18N_DB_SELECT_DB*/, $db, $this->dbuser), 'db_select_fail');
     758<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>'/*/WP_I18N_DB_SELECT_DB*/, $db, $this->dbuser ), 'db_select_fail' );
    635759                        return;
    636760                }
    637761        }
    638762
    639         function _weak_escape($string) {
    640                 return addslashes($string);
     763        /**
     764         * weak escape
     765         *
     766         * an alias to addslashes()
     767         *
     768         * @see addslashes()
     769         *
     770         * @since {@internal Version Unknown}}
     771         * @access private
     772         * @param string $string
     773         * @return string
     774         */
     775        function _weak_escape( $string ) {
     776                return addslashes( $string );
    641777        }
    642778
    643         function _real_escape($string) {
     779        /**
     780         * real escape
     781         *
     782         * escape via mysql_real_escape_string() or addslashes() 
     783         *
     784         * @since  2.8
     785         * @access private
     786         *
     787         * @param  string $string to escape
     788         * @return string escaped
     789         */
     790        function _real_escape( $string ) {
    644791                if ( $this->dbh && $this->real_escape )
    645792                        return mysql_real_escape_string( $string, $this->dbh );
    646793                else
    647794                        return addslashes( $string );
    648795        }
    649796
    650         function _escape($data) {
    651                 if ( is_array($data) ) {
     797        /**
     798         * escape
     799         *
     800         * escape data, uses {@see _real_escape()} and works
     801         * on arrays as well.
     802         *
     803         * @since  2.8
     804         * @access private
     805         *
     806         * @param  string|array $data to escape
     807         * @return string|array escaped
     808         */
     809        function _escape( $data ) {
     810                if ( is_array( $data ) ) {
    652811                        foreach ( (array) $data as $k => $v ) {
    653812                                if ( is_array($v) )
    654813                                        $data[$k] = $this->_escape( $v );
    … …  
    667826         *
    668827         * @since 0.71
    669828         *
    670          * @param string|array $data
    671          * @return string query safe string
     829         * @param  string|array $data to escape
     830         * @return string|array escaped as query safe string
    672831         */
    673         function escape($data) {
    674                 if ( is_array($data) ) {
     832        function escape( $data ) {
     833                if ( is_array( $data ) ) {
    675834                        foreach ( (array) $data as $k => $v ) {
    676                                 if ( is_array($v) )
     835                                if ( is_array( $v ) )
    677836                                        $data[$k] = $this->escape( $v );
    678837                                else
    679838                                        $data[$k] = $this->_weak_escape( $v );
    … …  
    690849         *
    691850         * @since 2.3.0
    692851         *
    693          * @param string $s
     852         * @param  string $string to escape
     853         * @return void
    694854         */
    695         function escape_by_ref(&$string) {
     855        function escape_by_ref( &$string ) {
    696856                $string = $this->_real_escape( $string );
    697857        }
    698858
    699859        /**
    700860         * Prepares a SQL query for safe execution.  Uses sprintf()-like syntax.
    701861         *
     862         * The following directives can be used in the query format string:
     863         *
     864         *   %d (decimal number) 
     865         *   %s (string)
     866         *   %% (literal percentage sign - no argument needed)
     867         *
     868         * Both %d and %s are to be left unquoted in the query string and   
     869         * they need an argument passed for them.
     870         * Literals (%) as parts of the query must be properly written
     871         * as %%.
     872         * 
    702873         * This function only supports a small subset of the sprintf syntax; it only supports %d (decimal number), %s (string).
    703874         * Does not support sign, padding, alignment, width or precision specifiers.
    704875         * Does not support argument numbering/swapping.
    … …  
    709880         *
    710881         * <code>
    711882         * wpdb::prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d", "foo", 1337 )
     883         * wpdb::prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' );
    712884         * </code>
    713885         *
    714886         * @link http://php.net/sprintf Description of syntax.
    715887         * @since 2.3.0
    716888         *
    717889         * @param string $query Query statement with sprintf()-like placeholders
    718          * @param array|mixed $args The array of variables to substitute into the query's placeholders if being called like {@link http://php.net/vsprintf vsprintf()}, or the first variable to substitute into the query's placeholders if being called like {@link http://php.net/sprintf sprintf()}.
     890         * @param mixed $args The array of variables to substitute into the query's placeholders if being called like {@link http://php.net/vsprintf vsprintf()}, or the first variable to substitute into the query's placeholders if being called like {@link http://php.net/sprintf sprintf()}.
    719891         * @param mixed $args,... further variables to substitute into the query's placeholders if being called like {@link http://php.net/sprintf sprintf()}.
    720          * @return null|string Sanitized query string
     892         * @return null|false|string Sanitized query string, null if there is no query, false if there is an error and string if there was something to prepare
    721893         */
    722         function prepare($query = null) { // ( $query, *$args )
     894        function prepare( $query = null ) { // ( $query, *$args )
    723895                if ( is_null( $query ) )
    724896                        return;
     897
    725898                $args = func_get_args();
    726                 array_shift($args);
    727                 // If args were passed as an array (as in vsprintf), move them up
    728                 if ( isset($args[0]) && is_array($args[0]) )
    729                         $args = $args[0];
    730                 $query = str_replace("'%s'", '%s', $query); // in case someone mistakenly already singlequoted it
    731                 $query = str_replace('"%s"', '%s', $query); // doublequote unquoting
    732                 $query = str_replace('%s', "'%s'", $query); // quote the strings
    733                 array_walk($args, array(&$this, 'escape_by_ref'));
    734                 return @vsprintf($query, $args);
     899                array_shift( $args );
     900                if ( isset( $args[0] ) && is_array( $args[0] ) )
     901                        $args = $args[0]; # re-assign args passed as array like in vsprintf
     902
     903                $query = str_replace( "'%s'", '%s', $query ); // in case someone mistakenly already singlequoted it
     904                $query = str_replace( '"%s"', '%s', $query ); // doublequote unquoting
     905                $query = str_replace( '%s', "'%s'", $query ); // quote the strings
     906                array_walk( $args, array( &$this, 'escape_by_ref' ) );
     907                return @vsprintf( $query, $args );
    735908        }
    736909
    737910        /**
    … …  
    743916         * @param string $str The error to display
    744917         * @return bool False if the showing of errors is disabled.
    745918         */
    746         function print_error($str = '') {
     919        function print_error( $str = '' ) {
    747920                global $EZSQL_ERROR;
    748921
    749                 if (!$str) $str = mysql_error($this->dbh);
    750                 $EZSQL_ERROR[] = array ('query' => $this->last_query, 'error_str' => $str);
     922                if ( !$str ) $str = mysql_error( $this->dbh );
     923                $EZSQL_ERROR[] = array( 'query' => $this->last_query, 'error_str' => $str );
    751924
    752925                if ( $this->suppress_errors )
    753926                        return false;
    … …  
    757930                else
    758931                        $error_str = sprintf(/*WP_I18N_DB_QUERY_ERROR*/'WordPress database error %1$s for query %2$s'/*/WP_I18N_DB_QUERY_ERROR*/, $str, $this->last_query);
    759932
    760                 $log_error = true;
    761                 if ( ! function_exists('error_log') )
    762                         $log_error = false;
     933                if ( function_exists( 'error_log' )
     934                     && !( $log_file = @ini_get( 'error_log' ) )
     935                     && ( 'syslog' != $log_file )
     936                     && @is_writable( $log_file ) )
     937                    @error_log( $error_str );
    763938
    764                 $log_file = @ini_get('error_log');
    765                 if ( !empty($log_file) && ('syslog' != $log_file) && !@is_writable($log_file) )
    766                         $log_error = false;
    767 
    768                 if ( $log_error )
    769                         @error_log($error_str, 0);
    770 
    771939                // Is error output turned on or not..
    772940                if ( !$this->show_errors )
    773941                        return false;
    … …  
    778946                        if ( defined( 'ERRORLOGFILE' ) )
    779947                                error_log( $msg, 3, ERRORLOGFILE );
    780948                        if ( defined( 'DIEONDBERROR' ) )
    781                                 die( $msg );
     949                                wp_die( $msg );
    782950                } else {
    783                         $str = htmlspecialchars($str, ENT_QUOTES);
    784                         $query = htmlspecialchars($this->last_query, ENT_QUOTES);
     951                        $str   = htmlspecialchars( $str, ENT_QUOTES );
     952                        $query = htmlspecialchars( $this->last_query, ENT_QUOTES );
    785953
    786954                        print "<div id='error'>
    787955                        <p class='wpdberror'><strong>WordPress database error:</strong> [$str]<br />
    … …  
    799967         * errors.
    800968         *
    801969         * @since 0.71
     970         * @see hide_errors()
    802971         *
    803972         * @param bool $show Whether to show or hide errors
    804973         * @return bool Old value for showing errors.
    … …  
    812981        /**
    813982         * Disables showing of database errors.
    814983         *
     984         * By default database errors are not shown.
     985         *
    815986         * @since 0.71
     987         * @see show_errors()
    816988         *
    817989         * @return bool Whether showing of errors was active or not
    818990         */
    … …  
    825997        /**
    826998         * Whether to suppress database errors.
    827999         *
    828          * @param unknown_type $suppress
    829          * @return unknown
     1000         * By default database errors are suppressed, with a simple
     1001         * call to this function they can be enabled.
     1002         *
     1003         * @since 2.5
     1004         * @see hide_errors()
     1005         * @param bool $suppress (optional) new value, defaults to true
     1006         * @return bool old suppress errors value
    8301007         */
    8311008        function suppress_errors( $suppress = true ) {
    8321009                $errors = $this->suppress_errors;
    833                 $this->suppress_errors = $suppress;
     1010                $this->suppress_errors = (bool) $suppress;
    8341011                return $errors;
    8351012        }
    8361013
    … …  
    8381015         * Kill cached query results.
    8391016         *
    8401017         * @since 0.71
     1018         *
     1019         * @return void
    8411020         */
    8421021        function flush() {
    8431022                $this->last_result = array();
    844                 $this->col_info = null;
    845                 $this->last_query = null;
     1023                $this->col_info    = null;
     1024                $this->last_query  = null;
    8461025        }
    8471026
    8481027        function db_connect( $query = "SELECT" ) {
    … …  
    8651044                }
    8661045
    8671046                $dbhname = "dbh" . $action;
    868                 $this->$dbhname = @mysql_connect( $details[ 'db_host' ], $details[ 'db_user' ], $details[ 'db_password' ] );
     1047                $this->$dbhname = @mysql_connect( $details[ 'db_host' ], $details[ 'db_user' ], $details[ 'db_password' ] );           
    8691048                if (!$this->$dbhname ) {
    870                         $this->bail("
     1049                        $this->bail( sprintf( /*WP_I18N_DB_CONNECT_DB*/'
    8711050<h1>Error establishing a database connection</h1>
    872 <p>This either means that the username and password information in your <code>wp-config.php</code> file is incorrect or we can't contact the database server at <code>{$details['db_host']}</code>. This could mean your host's database server is down.</p>
     1051<p>This either means that the username and password information in your <code>wp-config.php</code> file is incorrect or we can\'t contact the database server at <code>%s</code>. This could mean your host\'s database server is down.</p>
    8731052<ul>
    8741053        <li>Are you sure you have the correct username and password?</li>
    8751054        <li>Are you sure that you have typed the correct hostname?</li>
    8761055        <li>Are you sure that the database server is running?</li>
    8771056</ul>
    878 <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>
    879 ");
     1057<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>'/*/WP_I18N_DB_CONNECT_DB*/, $dbhost) );
    8801058                }
    8811059                $this->select( $details[ 'db_name' ], $this->$dbhname );
    8821060        }
    … …  
    8881066         *
    8891067         * @since 0.71
    8901068         *
    891          * @param string $query
     1069         * @param string $query database query
    8921070         * @return int|false Number of rows affected/selected or false on error
    8931071         */
    894         function query($query) {
     1072        function query( $query ) {
    8951073                if ( ! $this->ready )
    8961074                        return false;
    8971075
    898                 // filter the query, if filters are available
    899                 // NOTE: some queries are made before the plugins have been loaded, and thus cannot be filtered with this method
    900                 if ( function_exists('apply_filters') )
    901                         $query = apply_filters('query', $query);
     1076                if ( function_exists( 'apply_filters' ) )
     1077                        $query = apply_filters( 'query', $query );
    9021078
    903                 // initialise return
     1079                // init return values and object's state
    9041080                $return_val = 0;
    9051081                $this->flush();
    9061082
    … …  
    9101086                // Keep track of the last query for debug..
    9111087                $this->last_query = $query;
    9121088
    913                 // Perform the query via std mysql_query function..
    914                 if ( defined('SAVEQUERIES') && SAVEQUERIES )
     1089                if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES )
    9151090                        $this->timer_start();
    9161091
    9171092                // use $this->dbh for read ops, and $this->dbhwrite for write ops
    … …  
    9391114                        $this->last_db_used = "other/read";
    9401115                }
    9411116
    942                 $this->result = @mysql_query($query, $dbh);
    943                 ++$this->num_queries;
     1117                // Perform the query via std mysql_query function..
     1118                $this->result = @mysql_query( $query, $dbh );
     1119                $this->num_queries++;
    9441120
    9451121                if ( defined('SAVEQUERIES') && SAVEQUERIES )
    9461122                        $this->queries[] = array( $query, $this->timer_stop(), $this->get_caller() );
    9471123
    9481124                // If there is an error then take note of it..
    949                 if ( $this->last_error = mysql_error($dbh) ) {
     1125                if ( $this->last_error = mysql_error( $dbh ) ) {
    9501126                        $this->print_error();
    9511127                        return false;
    9521128                }
    9531129
    954                 if ( preg_match("/^\\s*(insert|delete|update|replace|alter) /i",$query) ) {
    955                         $this->rows_affected = mysql_affected_rows($dbh);
     1130                if ( preg_match( "/^\\s*(insert|delete|update|replace|alter) /i", $query ) ) {
     1131                        $this->rows_affected = mysql_affected_rows( $dbh );
    9561132                        // Take note of the insert_id
    957                         if ( preg_match("/^\\s*(insert|replace) /i",$query) ) {
     1133                        if ( preg_match( "/^\\s*(insert|replace) /i", $query ) ) {
    9581134                                $this->insert_id = mysql_insert_id($dbh);
    9591135                        }
    9601136                        // Return number of rows affected
    9611137                        $return_val = $this->rows_affected;
    9621138                } else {
    9631139                        $i = 0;
    964                         while ($i < @mysql_num_fields($this->result)) {
    965                                 $this->col_info[$i] = @mysql_fetch_field($this->result);
     1140                        while ( $i < @mysql_num_fields( $this->result ) ) {
     1141                                $this->col_info[$i] = @mysql_fetch_field( $this->result );
    9661142                                $i++;
    9671143                        }
    9681144                        $num_rows = 0;
    969                         while ( $row = @mysql_fetch_object($this->result) ) {
     1145                        while ( $row = @mysql_fetch_object( $this->result ) ) {
    9701146                                $this->last_result[$num_rows] = $row;
    9711147                                $num_rows++;
    9721148                        }
    9731149
    974                         @mysql_free_result($this->result);
     1150                        @mysql_free_result( $this->result );
    9751151
    9761152                        // Log number of rows the query returned
     1153                        // and Return number of rows selected
    9771154                        $this->num_rows = $num_rows;
    978 
    979                         // Return number of rows selected
    980                         $return_val = $this->num_rows;
     1155                        $return_val     = $num_rows;
    9811156                }
    9821157
    9831158                return $return_val;
    … …  
    9871162         * Insert a row into a table.
    9881163         *
    9891164         * <code>
     1165         * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ) )
    9901166         * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) )
    9911167         * </code>
    9921168         *
    … …  
    9981174         * @param array|string $format (optional) An array of formats to be mapped to each of the value in $data.  If string, that format will be used for all of the values in $data.  A format is one of '%d', '%s' (decimal number, string).  If omitted, all values in $data will be treated as strings.
    9991175         * @return int|false The number of rows inserted, or false on error.
    10001176         */
    1001         function insert($table, $data, $format = null) {
     1177        function insert( $table, $data, $format = null ) {
    10021178                $formats = $format = (array) $format;
    1003                 $fields = array_keys($data);
     1179                $fields = array_keys( $data );
    10041180                $formatted_fields = array();
    10051181                foreach ( $fields as $field ) {
    1006                         if ( !empty($format) )
    1007                                 $form = ( $form = array_shift($formats) ) ? $form : $format[0];
    1008                         elseif ( isset($this->field_types[$field]) )
     1182                        if ( !empty( $format ) )
     1183                                $form = ( $form = array_shift( $formats ) ) ? $form : $format[0];
     1184                        elseif ( isset( $this->field_types[$field] ) )
    10091185                                $form = $this->field_types[$field];
    10101186                        else
    10111187                                $form = '%s';
    10121188                        $formatted_fields[] = $form;
    10131189                }
    10141190                $sql = "INSERT INTO `$table` (`" . implode( '`,`', $fields ) . "`) VALUES ('" . implode( "','", $formatted_fields ) . "')";
    1015                 return $this->query( $this->prepare( $sql, $data) );
     1191                return $this->query( $this->prepare( $sql, $data ) );
    10161192        }
    10171193
    10181194
    … …  
    10201196         * Update a row in the table
    10211197         *
    10221198         * <code>
     1199         * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ) )
    10231200         * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) )
    10241201         * </code>
    10251202         *
    … …  
    10331210         * @param array|string $format_where (optional) An array of formats to be mapped to each of the values in $where.  If string, that format will be used for all of  the items in $where.  A format is one of '%d', '%s' (decimal number, string).  If omitted, all values in $where will be treated as strings.
    10341211         * @return int|false The number of rows updated, or false on error.
    10351212         */
    1036         function update($table, $data, $where, $format = null, $where_format = null) {
    1037                 if ( !is_array( $where ) )
     1213        function update( $table, $data, $where, $format = null, $where_format = null ) {
     1214                if ( !is_array( $data ) || !is_array( $where ) )
    10381215                        return false;
    10391216
    10401217                $formats = $format = (array) $format;
    10411218                $bits = $wheres = array();
    1042                 foreach ( (array) array_keys($data) as $field ) {
    1043                         if ( !empty($format) )
    1044                                 $form = ( $form = array_shift($formats) ) ? $form : $format[0];
     1219                foreach ( (array) array_keys( $data ) as $field ) {
     1220                        if ( !empty( $format ) )
     1221                                $form = ( $form = array_shift( $formats ) ) ? $form : $format[0];
    10451222                        elseif ( isset($this->field_types[$field]) )
    10461223                                $form = $this->field_types[$field];
    10471224                        else
    … …  
    10501227                }
    10511228
    10521229                $where_formats = $where_format = (array) $where_format;
    1053                 foreach ( (array) array_keys($where) as $field ) {
    1054                         if ( !empty($where_format) )
    1055                                 $form = ( $form = array_shift($where_formats) ) ? $form : $where_format[0];
    1056                         elseif ( isset($this->field_types[$field]) )
     1230                foreach ( (array) array_keys( $where ) as $field ) {
     1231                        if ( !empty( $where_format ) )
     1232                                $form = ( $form = array_shift( $where_formats ) ) ? $form : $where_format[0];
     1233                        elseif ( isset( $this->field_types[$field] ) )
    10571234                                $form = $this->field_types[$field];
    10581235                        else
    10591236                                $form = '%s';
    … …  
    10611238                }
    10621239
    10631240                $sql = "UPDATE `$table` SET " . implode( ', ', $bits ) . ' WHERE ' . implode( ' AND ', $wheres );
    1064                 return $this->query( $this->prepare( $sql, array_merge(array_values($data), array_values($where))) );
     1241                return $this->query( $this->prepare( $sql, array_merge( array_values( $data ), array_values( $where ) ) ) );
    10651242        }
    10661243
    10671244        /**
    … …  
    10731250         *
    10741251         * @since 0.71
    10751252         *
    1076          * @param string|null $query SQL query.  If null, use the result from the previous query.
     1253         * @param string|null $query (optional) SQL query. Defaults to NULL, use the result from the previous query.
    10771254         * @param int $x (optional) Column of value to return.  Indexed from 0.
    10781255         * @param int $y (optional) Row of value to return.  Indexed from 0.
    1079          * @return string Database query result
     1256         * @return string|null Database query result on success (as string), NULL if a value on failure
    10801257         */
    1081         function get_var($query=null, $x = 0, $y = 0) {
    1082                 $this->func_call = "\$db->get_var(\"$query\",$x,$y)";
     1258        function get_var( $query = null, $x = 0, $y = 0 ) {
     1259                $this->func_call = "\$db->get_var(\"$query\", $x, $y)";
    10831260                if ( $query )
    1084                         $this->query($query);
     1261                        $this->query( $query );
    10851262
    10861263                // Extract var out of cached results based x,y vals
    10871264                if ( !empty( $this->last_result[$y] ) ) {
    1088                         $values = array_values(get_object_vars($this->last_result[$y]));
     1265                        $values = array_values( get_object_vars( $this->last_result[$y] ) );
    10891266                }
    10901267
    10911268                // If there is a value return it else return null
    1092                 return (isset($values[$x]) && $values[$x]!=='') ? $values[$x] : null;
     1269                return ( isset( $values[$x] ) && $values[$x] !== '' ) ? $values[$x] : null;
    10931270        }
    10941271
    10951272        /**
    … …  
    11021279         * @param string|null $query SQL query.
    11031280         * @param string $output (optional) one of ARRAY_A | ARRAY_N | OBJECT constants.  Return an associative array (column => value, ...), a numerically indexed array (0 => value, ...) or an object ( ->column = value ), respectively.
    11041281         * @param int $y (optional) Row to return.  Indexed from 0.
    1105          * @return mixed Database query result in format specifed by $output
     1282         * @return mixed Database query result in format specifed by $output or NULL
     1283         * @return void
    11061284         */
    1107         function get_row($query = null, $output = OBJECT, $y = 0) {
     1285        function get_row( $query = null, $output = OBJECT, $y = 0 ) {
    11081286                $this->func_call = "\$db->get_row(\"$query\",$output,$y)";
    11091287                if ( $query )
    1110                         $this->query($query);
     1288                        $this->query( $query );
    11111289                else
    11121290                        return null;
    11131291
    1114                 if ( !isset($this->last_result[$y]) )
     1292                if ( !isset( $this->last_result[$y] ) )
    11151293                        return null;
    11161294
    11171295                if ( $output == OBJECT ) {
    11181296                        return $this->last_result[$y] ? $this->last_result[$y] : null;
    11191297                } elseif ( $output == ARRAY_A ) {
    1120                         return $this->last_result[$y] ? get_object_vars($this->last_result[$y]) : null;
     1298                        return $this->last_result[$y] ? get_object_vars( $this->last_result[$y] ) : null;
    11211299                } elseif ( $output == ARRAY_N ) {
    1122                         return $this->last_result[$y] ? array_values(get_object_vars($this->last_result[$y])) : null;
     1300                        return $this->last_result[$y] ? array_values( get_object_vars( $this->last_result[$y] ) ) : null;
    11231301                } else {
    11241302                        $this->print_error(/*WP_I18N_DB_GETROW_ERROR*/" \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N"/*/WP_I18N_DB_GETROW_ERROR*/);
    11251303                }
    … …  
    11341312         *
    11351313         * @since 0.71
    11361314         *
    1137          * @param string|null $query SQL query. If null, use the result from the previous query.
    1138          * @param int $x Column to return.  Indexed from 0.
     1315         * @param string|null $query (optional) SQL query. If null, use the result from the previous query.
     1316         * @param int $x (optional) Column to return.  Indexed from 0.
    11391317         * @return array Database query result.  Array indexed from 0 by SQL result row number.
    11401318         */
    1141         function get_col($query = null , $x = 0) {
     1319        function get_col( $query = null , $x = 0 ) {
    11421320                if ( $query )
    1143                         $this->query($query);
     1321                        $this->query( $query );
    11441322
    11451323                $new_array = array();
    11461324                // Extract the column values
    1147                 for ( $i=0; $i < count($this->last_result); $i++ ) {
    1148                         $new_array[$i] = $this->get_var(null, $x, $i);
     1325                for ( $i=0; $i < count( $this->last_result ); $i++ ) {
     1326                        $new_array[$i] = $this->get_var( null, $x, $i );
    11491327                }
    11501328                return $new_array;
    11511329        }
    … …  
    11611339         * @param string $output (optional) ane of ARRAY_A | ARRAY_N | OBJECT | OBJECT_K constants.  With one of the first three, return an array of rows indexed from 0 by SQL result row number.  Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively.  With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value.  Duplicate keys are discarded.
    11621340         * @return mixed Database query results
    11631341         */
    1164         function get_results($query = null, $output = OBJECT) {
     1342        function get_results( $query = null, $output = OBJECT ) {
    11651343                $this->func_call = "\$db->get_results(\"$query\", $output)";
    11661344
    11671345                if ( $query )
    1168                         $this->query($query);
     1346                        $this->query( $query );
    11691347                else
    11701348                        return null;
    11711349
    … …  
    12061384         *
    12071385         * @since 0.71
    12081386         *
    1209          * @param string $info_type one of name, table, def, max_length, not_null, primary_key, multiple_key, unique_key, numeric, blob, type, unsigned, zerofill
    1210          * @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
     1387         * @param string $info_type(optional) type one of name, table, def, max_length, not_null, primary_key, multiple_key, unique_key, numeric, blob, type, unsigned, zerofill
     1388         * @param int $col_offset (optional) 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
    12111389         * @return mixed Column Results
    12121390         */
    1213         function get_col_info($info_type = 'name', $col_offset = -1) {
     1391        function get_col_info( $info_type = 'name', $col_offset = -1 ) {
    12141392                if ( $this->col_info ) {
    12151393                        if ( $col_offset == -1 ) {
    1216                                 $i = 0;
     1394                                $i         = 0;
    12171395                                $new_array = array();
    12181396                                foreach( (array) $this->col_info as $col ) {
    12191397                                        $new_array[$i] = $col->{$info_type};
    … …  
    12341412         * @return true
    12351413         */
    12361414        function timer_start() {
    1237                 $mtime = microtime();
    1238                 $mtime = explode(' ', $mtime);
     1415                $mtime            = explode( ' ', microtime() );
    12391416                $this->time_start = $mtime[1] + $mtime[0];
    12401417                return true;
    12411418        }
    … …  
    12481425         * @return int Total time spent on the query, in milliseconds
    12491426         */
    12501427        function timer_stop() {
    1251                 $mtime = microtime();
    1252                 $mtime = explode(' ', $mtime);
    1253                 $time_end = $mtime[1] + $mtime[0];
     1428                $mtime      = explode( ' ', microtime() );
     1429                $time_end   = $mtime[1] + $mtime[0];
    12541430                $time_total = $time_end - $this->time_start;
    12551431                return $time_total;
    12561432        }
    … …  
    12661442         * @param string $error_code (optional) A Computer readable string to identify the error.
    12671443         * @return false|void
    12681444         */
    1269         function bail($message, $error_code = '500') {
     1445        function bail( $message, $error_code = '500' ) {
    12701446                if ( !$this->show_errors ) {
    1271                         if ( class_exists('WP_Error') )
     1447                        if ( class_exists( 'WP_Error' ) )
    12721448                                $this->error = new WP_Error($error_code, $message);
    12731449                        else
    12741450                                $this->error = $message;
    … …  
    12821458         *
    12831459         * @since 2.5.0
    12841460         * @uses $wp_version
     1461         * @uses $required_mysql_version
    12851462         *
    12861463         * @return WP_Error
    12871464         */
    … …  
    12891466                global $wp_version, $required_mysql_version;
    12901467                // Make sure the server has the required MySQL version
    12911468                if ( version_compare($this->db_version(), $required_mysql_version, '<') )
    1292                         return new WP_Error('database_version',sprintf(__('<strong>ERROR</strong>: WordPress %1$s requires MySQL %2$s or higher'), $wp_version, $required_mysql_version));
     1469                        return new WP_Error('database_version', sprintf( __( '<strong>ERROR</strong>: WordPress %1$s requires MySQL %2$s or higher' ), $wp_version, $required_mysql_version ));
    12931470        }
    12941471
    12951472        /**
    … …  
    13061483        }
    13071484
    13081485        /**
    1309          * Generic function to determine if a database supports a particular feature
     1486         * has capability
     1487         *
     1488         * Determine if a database supports a particular feature
     1489         *
     1490         * @since  2.7
     1491         * @see    db_version()
     1492         *
    13101493         * @param string $db_cap the feature
    13111494         * @param false|string|resource $dbh_or_table (not implemented) Which database to test.  False = the currently selected database, string = the database containing the specified table, resource = the database corresponding to the specified mysql resource.
    13121495         * @return bool
    … …  
    13181501                case 'collation' :    // @since 2.5.0
    13191502                case 'group_concat' : // @since 2.7
    13201503                case 'subqueries' :   // @since 2.7
    1321                         return version_compare($version, '4.1', '>=');
     1504                        return version_compare( $version, '4.1', '>=' );
    13221505                        break;
    13231506                endswitch;
    13241507
    … …  
    13361519         * @return string The name of the calling function
    13371520         */
    13381521        function get_caller() {
    1339                 $bt = debug_backtrace();
     1522                $trace  = array_reverse( debug_backtrace() );
    13401523                $caller = array();
    13411524
    1342                 $bt = array_reverse( $bt );
    1343                 foreach ( (array) $bt as $call ) {
     1525                foreach ( $trace as $call ) {
    13441526                        if ( isset( $call['class'] ) && __CLASS__ == $call['class'] )
    1345                                 continue;
     1527                                continue; # filter out function calls of this object's class
     1528
    13461529                        $function = $call['function'];
     1530
    13471531                        if ( isset( $call['class'] ) )
    13481532                                $function = $call['class'] . "->$function";
     1533
    13491534                        $caller[] = $function;
    13501535                }
    1351                 $caller = join( ', ', $caller );
    13521536
    1353                 return $caller;
     1537                return join( ', ', $caller );
    13541538        }
    13551539
    13561540        /**
    1357          * The database version number
    1358          * @param false|string|resource $dbh_or_table (not implemented) Which database to test.  False = the currently selected database, string = the database containing the specified table, resource = the database corresponding to the specified mysql resource.
     1541         * get database version number
     1542         *
     1543         * ADDITIONAL PARAMETER NOTICE
     1544         *
     1545         * there once was a proposed second parameter which has never been
     1546         * implemented. It was describben as "Which database to test" ($dbh_or_table)
     1547         *
     1548         * It would have had three different types:
     1549         *
     1550         *      false    : currently selected database
     1551         *  string   : database containing this table
     1552         *  resource : database by mysql resource
     1553         *
     1554         * regarding that third parameter please see {@see db_version()} as well
     1555         *
     1556         * @since  2.7
     1557         * @see    has_cap()
     1558         *
    13591559         * @return false|string false on failure, version number on success
    13601560         */
    13611561        function db_version() {
    1362                 return preg_replace('/[^0-9.].*/', '', mysql_get_server_info( $this->dbh ));
     1562                return preg_replace( '/[^0-9.].*/', '', mysql_get_server_info( $this->dbh ) );
    13631563        }
    13641564}
    13651565
    … …  
    13711571         */
    13721572        $wpdb = new wpdb(DB_USER, DB_PASSWORD, DB_NAME, DB_HOST);
    13731573}
    1374 ?>
     1574?>
     1575 No newline at end of file