X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/11be8dc178e77d0b46189bbd8e33a216a9b90942..88550bc3400cc7c035ff590ecb007c7938041ded:/wp-includes/wp-db.php diff --git a/wp-includes/wp-db.php b/wp-includes/wp-db.php index ccd3a6ef..76c41d8b 100644 --- a/wp-includes/wp-db.php +++ b/wp-includes/wp-db.php @@ -12,48 +12,50 @@ /** * @since 0.71 */ -define('EZSQL_VERSION', 'WP1.25'); +define( 'EZSQL_VERSION', 'WP1.25' ); /** * @since 0.71 */ -define('OBJECT', 'OBJECT', true); +define( 'OBJECT', 'OBJECT' ); +define( 'object', 'OBJECT' ); // Back compat. /** - * @since {@internal Version Unknown}} + * @since 2.5.0 */ -define('OBJECT_K', 'OBJECT_K', false); +define( 'OBJECT_K', 'OBJECT_K' ); /** * @since 0.71 */ -define('ARRAY_A', 'ARRAY_A', false); +define( 'ARRAY_A', 'ARRAY_A' ); /** * @since 0.71 */ -define('ARRAY_N', 'ARRAY_N', false); +define( 'ARRAY_N', 'ARRAY_N' ); /** * WordPress Database Access Abstraction Object * * It is possible to replace this class with your own * by setting the $wpdb global variable in wp-content/db.php - * file with your class. You can name it wpdb also, since - * this file will not be included, if the other file is - * available. + * file to your class. The wpdb class will still be included, + * so you can extend it or simply use your own. * * @link http://codex.wordpress.org/Function_Reference/wpdb_Class * * @package WordPress * @subpackage Database * @since 0.71 - * @final */ class wpdb { /** - * Whether to show SQL/DB errors + * Whether to show SQL/DB errors. + * + * Default behavior is to show errors if both WP_DEBUG and WP_DEBUG_DISPLAY + * evaluated to true. * * @since 0.71 * @access private @@ -65,7 +67,7 @@ class wpdb { * Whether to suppress errors during the DB bootstrapping. * * @access private - * @since {@internal Version Unknown}} + * @since 2.5.0 * @var bool */ var $suppress_errors = false; @@ -73,10 +75,10 @@ class wpdb { /** * The last error during query. * - * @since {@internal Version Unknown}} + * @since 2.5.0 * @var string */ - var $last_error = ''; + public $last_error = ''; /** * Amount of queries made @@ -88,22 +90,104 @@ class wpdb { var $num_queries = 0; /** - * Saved result of the last query made + * Count of rows returned by previous query * - * @since 1.2.0 + * @since 0.71 + * @access private + * @var int + */ + var $num_rows = 0; + + /** + * Count of affected rows by previous query + * + * @since 0.71 + * @access private + * @var int + */ + var $rows_affected = 0; + + /** + * The ID generated for an AUTO_INCREMENT column by the previous query (usually INSERT). + * + * @since 0.71 + * @access public + * @var int + */ + var $insert_id = 0; + + /** + * Last query made + * + * @since 0.71 * @access private * @var array */ var $last_query; /** - * Saved info on the table column + * Results of the last query made * - * @since 1.2.0 + * @since 0.71 + * @access private + * @var array|null + */ + var $last_result; + + /** + * MySQL result, which is either a resource or boolean. + * + * @since 0.71 + * @access protected + * @var mixed + */ + protected $result; + + /** + * Cached column info, for sanity checking data before inserting + * + * @since 4.2.0 + * @access protected + * @var array + */ + protected $col_meta = array(); + + /** + * Calculated character sets on tables + * + * @since 4.2.0 + * @access protected + * @var array + */ + protected $table_charset = array(); + + /** + * Whether text fields in the current query need to be sanity checked. + * + * @since 4.2.0 + * @access protected + * @var bool + */ + protected $check_current_query = true; + + /** + * Flag to ensure we don't run into recursion problems when checking the collation. + * + * @since 4.2.0 * @access private + * @see wpdb::check_safe_collation() + * @var boolean + */ + private $checking_collation = false; + + /** + * Saved info on the table column + * + * @since 0.71 + * @access protected * @var array */ - var $col_info; + protected $col_info; /** * Saved queries that were executed @@ -114,6 +198,16 @@ class wpdb { */ var $queries; + /** + * The number of times to retry reconnecting before dying. + * + * @since 3.9.0 + * @access protected + * @see wpdb::check_connection() + * @var int + */ + protected $reconnect_retries = 5; + /** * WordPress table prefix * @@ -121,65 +215,109 @@ class wpdb { * in a single database. The second reason is for possible * security precautions. * - * @since 0.71 + * @since 2.5.0 * @access private * @var string */ var $prefix = ''; + /** + * WordPress base table prefix. + * + * @since 3.0.0 + * @access public + * @var string + */ + public $base_prefix; + /** * Whether the database queries are ready to start executing. * - * @since 2.5.0 + * @since 2.3.2 * @access private * @var bool */ var $ready = false; /** - * WordPress Posts table + * {@internal Missing Description}} * - * @since 1.5.0 + * @since 3.0.0 * @access public - * @var string + * @var int */ - var $posts; + public $blogid = 0; /** - * WordPress Users table + * {@internal Missing Description}} * - * @since 1.5.0 + * @since 3.0.0 * @access public - * @var string + * @var int */ - var $users; + public $siteid = 0; /** - * WordPress Categories table + * List of WordPress per-blog tables * - * @since 1.5.0 - * @access public - * @var string + * @since 2.5.0 + * @access private + * @see wpdb::tables() + * @var array + */ + var $tables = array( 'posts', 'comments', 'links', 'options', 'postmeta', + 'terms', 'term_taxonomy', 'term_relationships', 'commentmeta' ); + + /** + * List of deprecated WordPress tables + * + * categories, post2cat, and link2cat were deprecated in 2.3.0, db version 5539 + * + * @since 2.9.0 + * @access private + * @see wpdb::tables() + * @var array + */ + var $old_tables = array( 'categories', 'post2cat', 'link2cat' ); + + /** + * List of WordPress global tables + * + * @since 3.0.0 + * @access private + * @see wpdb::tables() + * @var array + */ + var $global_tables = array( 'users', 'usermeta' ); + + /** + * List of Multisite global tables + * + * @since 3.0.0 + * @access private + * @see wpdb::tables() + * @var array */ - var $categories; + var $ms_global_tables = array( 'blogs', 'signups', 'site', 'sitemeta', + 'sitecategories', 'registration_log', 'blog_versions' ); /** - * WordPress Post to Category table + * WordPress Comments table * * @since 1.5.0 * @access public * @var string */ - var $post2cat; + public $comments; /** - * WordPress Comments table + * WordPress Comment Metadata table * - * @since 1.5.0 + * @since 2.9.0 * @access public * @var string */ - var $comments; + public $commentmeta; /** * WordPress Links table @@ -188,7 +326,7 @@ class wpdb { * @access public * @var string */ - var $links; + public $links; /** * WordPress Options table @@ -197,25 +335,25 @@ class wpdb { * @access public * @var string */ - var $options; + public $options; /** * WordPress Post Metadata table * - * @since {@internal Version Unknown}} + * @since 1.5.0 * @access public * @var string */ - var $postmeta; + public $postmeta; /** - * WordPress User Metadata table + * WordPress Posts table * - * @since 2.3.0 + * @since 1.5.0 * @access public * @var string */ - var $usermeta; + public $posts; /** * WordPress Terms table @@ -224,7 +362,16 @@ class wpdb { * @access public * @var string */ - var $terms; + public $terms; + + /** + * WordPress Term Relationships table + * + * @since 2.3.0 + * @access public + * @var string + */ + public $term_relationships; /** * WordPress Term Taxonomy table @@ -233,26 +380,108 @@ class wpdb { * @access public * @var string */ - var $term_taxonomy; + public $term_taxonomy; + + /* + * Global and Multisite tables + */ /** - * WordPress Term Relationships table + * WordPress User Metadata table * * @since 2.3.0 * @access public * @var string */ - var $term_relationships; + public $usermeta; + + /** + * WordPress Users table + * + * @since 1.5.0 + * @access public + * @var string + */ + public $users; /** - * List of WordPress tables + * Multisite Blogs table * - * @since {@internal Version Unknown}} - * @access private + * @since 3.0.0 + * @access public + * @var string + */ + public $blogs; + + /** + * Multisite Blog Versions table + * + * @since 3.0.0 + * @access public + * @var string + */ + public $blog_versions; + + /** + * Multisite Registration Log table + * + * @since 3.0.0 + * @access public + * @var string + */ + public $registration_log; + + /** + * Multisite Signups table + * + * @since 3.0.0 + * @access public + * @var string + */ + public $signups; + + /** + * Multisite Sites table + * + * @since 3.0.0 + * @access public + * @var string + */ + public $site; + + /** + * Multisite Sitewide Terms table + * + * @since 3.0.0 + * @access public + * @var string + */ + public $sitecategories; + + /** + * Multisite Site Metadata table + * + * @since 3.0.0 + * @access public + * @var string + */ + public $sitemeta; + + /** + * Format specifiers for DB columns. Columns not listed here default to %s. Initialized during WP load. + * + * Keys are column names, values are format types: 'ID' => '%d' + * + * @since 2.8.0 + * @see wpdb::prepare() + * @see wpdb::insert() + * @see wpdb::update() + * @see wpdb::delete() + * @see wp_set_wpdb_vars() + * @access public * @var array */ - var $tables = array('users', 'usermeta', 'posts', 'categories', 'post2cat', 'comments', 'links', 'link2cat', 'options', - 'postmeta', 'terms', 'term_taxonomy', 'term_relationships'); + public $field_types = array(); /** * Database table columns charset @@ -261,7 +490,7 @@ class wpdb { * @access public * @var string */ - var $charset; + public $charset; /** * Database table columns collate @@ -270,24 +499,103 @@ class wpdb { * @access public * @var string */ - var $collate; + public $collate; /** - * Connects to the database server and selects a database + * Database Username + * + * @since 2.9.0 + * @access protected + * @var string + */ + protected $dbuser; + + /** + * Database Password + * + * @since 3.1.0 + * @access protected + * @var string + */ + protected $dbpassword; + + /** + * Database Name + * + * @since 3.1.0 + * @access protected + * @var string + */ + protected $dbname; + + /** + * Database Host * - * PHP4 compatibility layer for calling the PHP5 constructor. + * @since 3.1.0 + * @access protected + * @var string + */ + protected $dbhost; + + /** + * Database Handle * - * @uses wpdb::__construct() Passes parameters and returns result * @since 0.71 + * @access protected + * @var string + */ + protected $dbh; + + /** + * A textual description of the last query/get_row/get_var call * - * @param string $dbuser MySQL database user - * @param string $dbpassword MySQL database password - * @param string $dbname MySQL database name - * @param string $dbhost MySQL database host + * @since 3.0.0 + * @access public + * @var string */ - function wpdb($dbuser, $dbpassword, $dbname, $dbhost) { - return $this->__construct($dbuser, $dbpassword, $dbname, $dbhost); - } + public $func_call; + + /** + * Whether MySQL is used as the database engine. + * + * Set in WPDB::db_connect() to true, by default. This is used when checking + * against the required MySQL version for WordPress. Normally, a replacement + * database drop-in (db.php) will skip these checks, but setting this to true + * will force the checks to occur. + * + * @since 3.3.0 + * @access public + * @var bool + */ + public $is_mysql = null; + + /** + * A list of incompatible SQL modes. + * + * @since 3.9.0 + * @access protected + * @var array + */ + protected $incompatible_modes = array( 'NO_ZERO_DATE', 'ONLY_FULL_GROUP_BY', + 'STRICT_TRANS_TABLES', 'STRICT_ALL_TABLES', 'TRADITIONAL' ); + + /** + * Whether to use mysqli over mysql. + * + * @since 3.9.0 + * @access private + * @var bool + */ + private $use_mysqli = false; + + /** + * Whether we've managed to successfully connect at some point + * + * @since 3.9.0 + * @access private + * @var bool + */ + private $has_connected = false; /** * Connects to the database server and selects a database @@ -296,6 +604,7 @@ class wpdb { * the actual setting up of the class properties and connection * to the database. * + * @link https://core.trac.wordpress.org/ticket/3354 * @since 2.0.8 * * @param string $dbuser MySQL database user @@ -303,93 +612,398 @@ class wpdb { * @param string $dbname MySQL database name * @param string $dbhost MySQL database host */ - function __construct($dbuser, $dbpassword, $dbname, $dbhost) { - register_shutdown_function(array(&$this, "__destruct")); + public function __construct( $dbuser, $dbpassword, $dbname, $dbhost ) { + register_shutdown_function( array( $this, '__destruct' ) ); - if ( defined('WP_DEBUG') and WP_DEBUG == true ) + if ( WP_DEBUG && WP_DEBUG_DISPLAY ) $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, true); - if (!$this->dbh) { - $this->bail(sprintf(/*WP_I18N_DB_CONN_ERROR*/" -
This either means that the username and password information in your wp-config.php
file is incorrect or we can't contact the database server at %s
. This could mean your host's database server is down.
If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the WordPress Support Forums.
-"/*/WP_I18N_DB_CONN_ERROR*/, $dbhost)); - return; + /* Use ext/mysqli if it exists and: + * - WP_USE_EXT_MYSQL is defined as false, or + * - We are a development version of WordPress, or + * - We are running PHP 5.5 or greater, or + * - ext/mysql is not loaded. + */ + if ( function_exists( 'mysqli_connect' ) ) { + if ( defined( 'WP_USE_EXT_MYSQL' ) ) { + $this->use_mysqli = ! WP_USE_EXT_MYSQL; + } elseif ( version_compare( phpversion(), '5.5', '>=' ) || ! function_exists( 'mysql_connect' ) ) { + $this->use_mysqli = true; + } elseif ( false !== strpos( $GLOBALS['wp_version'], '-' ) ) { + $this->use_mysqli = true; + } } - $this->ready = true; + $this->init_charset(); - if ( $this->has_cap( 'collation' ) ) { - $collation_query = ''; - if ( !empty($this->charset) ) { - $collation_query = "SET NAMES '{$this->charset}'"; - if (!empty($this->collate) ) - $collation_query .= " COLLATE '{$this->collate}'"; - } - - if ( !empty($collation_query) ) - $this->query($collation_query); + $this->dbuser = $dbuser; + $this->dbpassword = $dbpassword; + $this->dbname = $dbname; + $this->dbhost = $dbhost; + // wp-config.php creation will manually connect when ready. + if ( defined( 'WP_SETUP_CONFIG' ) ) { + return; } - $this->select($dbname); + $this->db_connect(); } /** * PHP5 style destructor and will run when database object is destroyed. * + * @see wpdb::__construct() * @since 2.0.8 - * - * @return bool Always true + * @return bool true */ - function __destruct() { + public function __destruct() { return true; } /** - * Sets the table prefix for the WordPress tables. - * - * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to - * override the WordPress users and usersmeta tables. + * PHP5 style magic getter, used to lazy-load expensive data. * - * @since 2.5.0 + * @since 3.5.0 + * + * @param string $name The private member to get, and optionally process + * @return mixed The private member + */ + public function __get( $name ) { + if ( 'col_info' === $name ) + $this->load_col_info(); + + return $this->$name; + } + + /** + * Magic function, for backwards compatibility. + * + * @since 3.5.0 + * + * @param string $name The private member to set + * @param mixed $value The value to set + */ + public function __set( $name, $value ) { + $protected_members = array( + 'col_meta', + 'table_charset', + 'check_current_query', + ); + if ( in_array( $name, $protected_members, true ) ) { + return; + } + $this->$name = $value; + } + + /** + * Magic function, for backwards compatibility. + * + * @since 3.5.0 + * + * @param string $name The private member to check + * + * @return bool If the member is set or not + */ + public function __isset( $name ) { + return isset( $this->$name ); + } + + /** + * Magic function, for backwards compatibility. + * + * @since 3.5.0 + * + * @param string $name The private member to unset + */ + public function __unset( $name ) { + unset( $this->$name ); + } + + /** + * Set $this->charset and $this->collate + * + * @since 3.1.0 + */ + public function init_charset() { + if ( function_exists('is_multisite') && is_multisite() ) { + $this->charset = 'utf8'; + if ( defined( 'DB_COLLATE' ) && DB_COLLATE ) + $this->collate = DB_COLLATE; + else + $this->collate = 'utf8_general_ci'; + } elseif ( defined( 'DB_COLLATE' ) ) { + $this->collate = DB_COLLATE; + } + + if ( defined( 'DB_CHARSET' ) ) + $this->charset = DB_CHARSET; + } + + /** + * Sets the connection's character set. + * + * @since 3.1.0 + * + * @param resource $dbh The resource given by mysql_connect + * @param string $charset Optional. The character set. Default null. + * @param string $collate Optional. The collation. Default null. + */ + public function set_charset( $dbh, $charset = null, $collate = null ) { + if ( ! isset( $charset ) ) + $charset = $this->charset; + if ( ! isset( $collate ) ) + $collate = $this->collate; + if ( $this->has_cap( 'collation' ) && ! empty( $charset ) ) { + if ( $this->use_mysqli ) { + if ( function_exists( 'mysqli_set_charset' ) && $this->has_cap( 'set_charset' ) ) { + mysqli_set_charset( $dbh, $charset ); + } else { + $query = $this->prepare( 'SET NAMES %s', $charset ); + if ( ! empty( $collate ) ) + $query .= $this->prepare( ' COLLATE %s', $collate ); + mysqli_query( $dbh, $query ); + } + } else { + if ( function_exists( 'mysql_set_charset' ) && $this->has_cap( 'set_charset' ) ) { + mysql_set_charset( $charset, $dbh ); + } else { + $query = $this->prepare( 'SET NAMES %s', $charset ); + if ( ! empty( $collate ) ) + $query .= $this->prepare( ' COLLATE %s', $collate ); + mysql_query( $query, $dbh ); + } + } + } + } + + /** + * Change the current SQL mode, and ensure its WordPress compatibility. + * + * If no modes are passed, it will ensure the current MySQL server + * modes are compatible. + * + * @since 3.9.0 + * + * @param array $modes Optional. A list of SQL modes to set. + */ + public function set_sql_mode( $modes = array() ) { + if ( empty( $modes ) ) { + if ( $this->use_mysqli ) { + $res = mysqli_query( $this->dbh, 'SELECT @@SESSION.sql_mode' ); + } else { + $res = mysql_query( 'SELECT @@SESSION.sql_mode', $this->dbh ); + } + + if ( empty( $res ) ) { + return; + } + + if ( $this->use_mysqli ) { + $modes_array = mysqli_fetch_array( $res ); + if ( empty( $modes_array[0] ) ) { + return; + } + $modes_str = $modes_array[0]; + } else { + $modes_str = mysql_result( $res, 0 ); + } + + if ( empty( $modes_str ) ) { + return; + } + + $modes = explode( ',', $modes_str ); + } + + $modes = array_change_key_case( $modes, CASE_UPPER ); + + /** + * Filter the list of incompatible SQL modes to exclude. + * + * @since 3.9.0 + * + * @param array $incompatible_modes An array of incompatible modes. + */ + $incompatible_modes = (array) apply_filters( 'incompatible_sql_modes', $this->incompatible_modes ); + + foreach( $modes as $i => $mode ) { + if ( in_array( $mode, $incompatible_modes ) ) { + unset( $modes[ $i ] ); + } + } + + $modes_str = implode( ',', $modes ); + + if ( $this->use_mysqli ) { + mysqli_query( $this->dbh, "SET SESSION sql_mode='$modes_str'" ); + } else { + mysql_query( "SET SESSION sql_mode='$modes_str'", $this->dbh ); + } + } + + /** + * Sets the table prefix for the WordPress tables. + * + * @since 2.5.0 * * @param string $prefix Alphanumeric name for the new prefix. - * @return string Old prefix + * @param bool $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not. + * @return string|WP_Error Old prefix or WP_Error on error */ - function set_prefix($prefix) { + public function set_prefix( $prefix, $set_table_names = true ) { + + if ( preg_match( '|[^a-z0-9_]|i', $prefix ) ) + return new WP_Error('invalid_db_prefix', 'Invalid database prefix' ); - if ( preg_match('|[^a-z0-9_]|i', $prefix) ) - return new WP_Error('invalid_db_prefix', /*WP_I18N_DB_BAD_PREFIX*/'Invalid database prefix'/*/WP_I18N_DB_BAD_PREFIX*/); + $old_prefix = is_multisite() ? '' : $prefix; - $old_prefix = $this->prefix; - $this->prefix = $prefix; + if ( isset( $this->base_prefix ) ) + $old_prefix = $this->base_prefix; - foreach ( (array) $this->tables as $table ) - $this->$table = $this->prefix . $table; + $this->base_prefix = $prefix; - if ( defined('CUSTOM_USER_TABLE') ) - $this->users = CUSTOM_USER_TABLE; + if ( $set_table_names ) { + foreach ( $this->tables( 'global' ) as $table => $prefixed_table ) + $this->$table = $prefixed_table; - if ( defined('CUSTOM_USER_META_TABLE') ) - $this->usermeta = CUSTOM_USER_META_TABLE; + if ( is_multisite() && empty( $this->blogid ) ) + return $old_prefix; + $this->prefix = $this->get_blog_prefix(); + + foreach ( $this->tables( 'blog' ) as $table => $prefixed_table ) + $this->$table = $prefixed_table; + + foreach ( $this->tables( 'old' ) as $table => $prefixed_table ) + $this->$table = $prefixed_table; + } return $old_prefix; } + /** + * Sets blog id. + * + * @since 3.0.0 + * @access public + * @param int $blog_id + * @param int $site_id Optional. + * @return int previous blog id + */ + public function set_blog_id( $blog_id, $site_id = 0 ) { + if ( ! empty( $site_id ) ) + $this->siteid = $site_id; + + $old_blog_id = $this->blogid; + $this->blogid = $blog_id; + + $this->prefix = $this->get_blog_prefix(); + + foreach ( $this->tables( 'blog' ) as $table => $prefixed_table ) + $this->$table = $prefixed_table; + + foreach ( $this->tables( 'old' ) as $table => $prefixed_table ) + $this->$table = $prefixed_table; + + return $old_blog_id; + } + + /** + * Gets blog prefix. + * + * @since 3.0.0 + * @param int $blog_id Optional. + * @return string Blog prefix. + */ + public function get_blog_prefix( $blog_id = null ) { + if ( is_multisite() ) { + if ( null === $blog_id ) + $blog_id = $this->blogid; + $blog_id = (int) $blog_id; + if ( defined( 'MULTISITE' ) && ( 0 == $blog_id || 1 == $blog_id ) ) + return $this->base_prefix; + else + return $this->base_prefix . $blog_id . '_'; + } else { + return $this->base_prefix; + } + } + + /** + * Returns an array of WordPress tables. + * + * Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to + * override the WordPress users and usermeta tables that would otherwise + * be determined by the prefix. + * + * The scope argument can take one of the following: + * + * 'all' - returns 'all' and 'global' tables. No old tables are returned. + * 'blog' - returns the blog-level tables for the queried blog. + * 'global' - returns the global tables for the installation, returning multisite tables only if running multisite. + * 'ms_global' - returns the multisite global tables, regardless if current installation is multisite. + * 'old' - returns tables which are deprecated. + * + * @since 3.0.0 + * @uses wpdb::$tables + * @uses wpdb::$old_tables + * @uses wpdb::$global_tables + * @uses wpdb::$ms_global_tables + * + * @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all. + * @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog + * prefix is requested, then the custom users and usermeta tables will be mapped. + * @param int $blog_id Optional. The blog_id to prefix. Defaults to wpdb::$blogid. Used only when prefix is requested. + * @return array Table names. When a prefix is requested, the key is the unprefixed table name. + */ + public function tables( $scope = 'all', $prefix = true, $blog_id = 0 ) { + switch ( $scope ) { + case 'all' : + $tables = array_merge( $this->global_tables, $this->tables ); + if ( is_multisite() ) + $tables = array_merge( $tables, $this->ms_global_tables ); + break; + case 'blog' : + $tables = $this->tables; + break; + case 'global' : + $tables = $this->global_tables; + if ( is_multisite() ) + $tables = array_merge( $tables, $this->ms_global_tables ); + break; + case 'ms_global' : + $tables = $this->ms_global_tables; + break; + case 'old' : + $tables = $this->old_tables; + break; + default : + return array(); + } + + if ( $prefix ) { + if ( ! $blog_id ) + $blog_id = $this->blogid; + $blog_prefix = $this->get_blog_prefix( $blog_id ); + $base_prefix = $this->base_prefix; + $global_tables = array_merge( $this->global_tables, $this->ms_global_tables ); + foreach ( $tables as $k => $table ) { + if ( in_array( $table, $global_tables ) ) + $tables[ $table ] = $base_prefix . $table; + else + $tables[ $table ] = $blog_prefix . $table; + unset( $tables[ $k ] ); + } + + if ( isset( $tables['users'] ) && defined( 'CUSTOM_USER_TABLE' ) ) + $tables['users'] = CUSTOM_USER_TABLE; + + if ( isset( $tables['usermeta'] ) && defined( 'CUSTOM_USER_META_TABLE' ) ) + $tables['usermeta'] = CUSTOM_USER_META_TABLE; + } + + return $tables; + } + /** * Selects a database using the current database connection. * @@ -399,423 +1013,1710 @@ class wpdb { * @since 0.71 * * @param string $db MySQL database name + * @param resource $dbh Optional link identifier. * @return null Always null. */ - function select($db) { - if (!@mysql_select_db($db, $this->dbh)) { + public function select( $db, $dbh = null ) { + if ( is_null($dbh) ) + $dbh = $this->dbh; + + if ( $this->use_mysqli ) { + $success = @mysqli_select_db( $dbh, $db ); + } else { + $success = @mysql_select_db( $db, $dbh ); + } + if ( ! $success ) { $this->ready = false; - $this->bail(sprintf(/*WP_I18N_DB_SELECT_DB*/' -We were able to connect to the database server (which means your username and password is okay) but not able to select the %1$s
database.
%2$s
have permission to use the %1$s
database?username_%1$s
. Could that be the problem?If you don\'t know how to setup a database you should contact your host. If all else fails you may find help at the WordPress Support Forums.
'/*/WP_I18N_DB_SELECT_DB*/, $db, DB_USER)); +If you don\'t know how to set up a database you should contact your host. If all else fails you may find help at the WordPress Support Forums.
' ), htmlspecialchars( $db, ENT_QUOTES ), htmlspecialchars( $this->dbuser, ENT_QUOTES ) ), 'db_select_fail' ); + } return; } } /** - * Escapes content for insertion into the database, for security + * Do not use, deprecated. * - * @since 0.71 + * Use esc_sql() or wpdb::prepare() instead. + * + * @since 2.8.0 + * @deprecated 3.6.0 + * @see wpdb::prepare + * @see esc_sql() + * @access private * * @param string $string - * @return string query safe string + * @return string */ - function escape($string) { + function _weak_escape( $string ) { + if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) ) + _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' ); return addslashes( $string ); - // Disable rest for now, causing problems - /* - if( !$this->dbh || version_compare( phpversion(), '4.3.0' ) == '-1' ) - return mysql_escape_string( $string ); + } + + /** + * Real escape, using mysqli_real_escape_string() or mysql_real_escape_string() + * + * @see mysqli_real_escape_string() + * @see mysql_real_escape_string() + * @since 2.8.0 + * @access private + * + * @param string $string to escape + * @return string escaped + */ + function _real_escape( $string ) { + if ( $this->dbh ) { + if ( $this->use_mysqli ) { + return mysqli_real_escape_string( $this->dbh, $string ); + } else { + return mysql_real_escape_string( $string, $this->dbh ); + } + } + + $class = get_class( $this ); + if ( function_exists( '__' ) ) { + _doing_it_wrong( $class, sprintf( __( '%s must set a database connection for use with escaping.' ), $class ), E_USER_NOTICE ); + } else { + _doing_it_wrong( $class, sprintf( '%s must set a database connection for use with escaping.', $class ), E_USER_NOTICE ); + } + return addslashes( $string ); + } + + /** + * Escape data. Works on arrays. + * + * @uses wpdb::_real_escape() + * @since 2.8.0 + * @access private + * + * @param string|array $data + * @return string|array escaped + */ + function _escape( $data ) { + if ( is_array( $data ) ) { + foreach ( $data as $k => $v ) { + if ( is_array($v) ) + $data[$k] = $this->_escape( $v ); + else + $data[$k] = $this->_real_escape( $v ); + } + } else { + $data = $this->_real_escape( $data ); + } + + return $data; + } + + /** + * Do not use, deprecated. + * + * Use esc_sql() or wpdb::prepare() instead. + * + * @since 0.71 + * @deprecated 3.6.0 + * @see wpdb::prepare() + * @see esc_sql() + * + * @param mixed $data + * @return mixed + */ + public function escape( $data ) { + if ( func_num_args() === 1 && function_exists( '_deprecated_function' ) ) + _deprecated_function( __METHOD__, '3.6', 'wpdb::prepare() or esc_sql()' ); + if ( is_array( $data ) ) { + foreach ( $data as $k => $v ) { + if ( is_array( $v ) ) + $data[$k] = $this->escape( $v, 'recursive' ); + else + $data[$k] = $this->_weak_escape( $v, 'internal' ); + } + } else { + $data = $this->_weak_escape( $data, 'internal' ); + } + + return $data; + } + + /** + * Escapes content by reference for insertion into the database, for security + * + * @uses wpdb::_real_escape() + * @since 2.3.0 + * @param string $string to escape + * @return void + */ + public function escape_by_ref( &$string ) { + if ( ! is_float( $string ) ) + $string = $this->_real_escape( $string ); + } + + /** + * Prepares a SQL query for safe execution. Uses sprintf()-like syntax. + * + * The following directives can be used in the query format string: + * %d (integer) + * %f (float) + * %s (string) + * %% (literal percentage sign - no argument needed) + * + * All of %d, %f, and %s are to be left unquoted in the query string and they need an argument passed for them. + * Literals (%) as parts of the query must be properly written as %%. + * + * This function only supports a small subset of the sprintf syntax; it only supports %d (integer), %f (float), and %s (string). + * Does not support sign, padding, alignment, width or precision specifiers. + * Does not support argument numbering/swapping. + * + * May be called like {@link http://php.net/sprintf sprintf()} or like {@link http://php.net/vsprintf vsprintf()}. + * + * Both %d and %s should be left unquoted in the query string. + * + * wpdb::prepare( "SELECT * FROM `table` WHERE `column` = %s AND `field` = %d", 'foo', 1337 ) + * wpdb::prepare( "SELECT DATE_FORMAT(`field`, '%%c') FROM `table` WHERE `column` = %s", 'foo' ); + * + * @link http://php.net/sprintf Description of syntax. + * @since 2.3.0 + * + * @param string $query Query statement with sprintf()-like placeholders + * @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()}. + * @param mixed $args,... further variables to substitute into the query's placeholders if being called like + * {@link http://php.net/sprintf sprintf()}. + * @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 + */ + public function prepare( $query, $args ) { + if ( is_null( $query ) ) + return; + + // This is not meant to be foolproof -- but it will catch obviously incorrect usage. + if ( strpos( $query, '%' ) === false ) { + _doing_it_wrong( 'wpdb::prepare', sprintf( __( 'The query argument of %s must have a placeholder.' ), 'wpdb::prepare()' ), '3.9' ); + } + + $args = func_get_args(); + array_shift( $args ); + // If args were passed as an array (as in vsprintf), move them up + if ( isset( $args[0] ) && is_array($args[0]) ) + $args = $args[0]; + $query = str_replace( "'%s'", '%s', $query ); // in case someone mistakenly already singlequoted it + $query = str_replace( '"%s"', '%s', $query ); // doublequote unquoting + $query = preg_replace( '|(?esc_like( $find ) . $wild; + * $sql = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_content LIKE %s", $like ); + * + * Example Escape Chain: + * $sql = esc_sql( $wpdb->esc_like( $input ) ); + * + * @since 4.0.0 + * @access public + * + * @param string $text The raw text to be escaped. The input typed by the user should have no + * extra or deleted slashes. + * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call $wpdb::prepare() + * or real_escape next. + */ + public function esc_like( $text ) { + return addcslashes( $text, '_%\\' ); + } + + /** + * Print SQL/DB error. + * + * @since 0.71 + * @global array $EZSQL_ERROR Stores error information of query and error string + * + * @param string $str The error to display + * @return false|null False if the showing of errors is disabled. + */ + public function print_error( $str = '' ) { + global $EZSQL_ERROR; + + if ( !$str ) { + if ( $this->use_mysqli ) { + $str = mysqli_error( $this->dbh ); + } else { + $str = mysql_error( $this->dbh ); + } + } + $EZSQL_ERROR[] = array( 'query' => $this->last_query, 'error_str' => $str ); + + if ( $this->suppress_errors ) + return false; + + wp_load_translations_early(); + + if ( $caller = $this->get_caller() ) + $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s made by %3$s' ), $str, $this->last_query, $caller ); else - return mysql_real_escape_string( $string, $this->dbh ); - */ + $error_str = sprintf( __( 'WordPress database error %1$s for query %2$s' ), $str, $this->last_query ); + + error_log( $error_str ); + + // Are we showing errors? + if ( ! $this->show_errors ) + return false; + + // If there is an error then take note of it + if ( is_multisite() ) { + $msg = "WordPress database error: [$str]\n{$this->last_query}\n"; + if ( defined( 'ERRORLOGFILE' ) ) + error_log( $msg, 3, ERRORLOGFILE ); + if ( defined( 'DIEONDBERROR' ) ) + wp_die( $msg ); + } else { + $str = htmlspecialchars( $str, ENT_QUOTES ); + $query = htmlspecialchars( $this->last_query, ENT_QUOTES ); + + print "WordPress database error: [$str]
+ $query
This either means that the username and password information in your wp-config.php
file is incorrect or we can't contact the database server at %s
. This could mean your host's database server is down.
If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the WordPress Support Forums.
+" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' ); + + return false; + } else if ( $this->dbh ) { + $this->has_connected = true; + $this->set_charset( $this->dbh ); + $this->set_sql_mode(); + $this->ready = true; + $this->select( $this->dbname, $this->dbh ); + + return true; + } + + return false; + } + + /** + * Check that the connection to the database is still up. If not, try to reconnect. + * + * If this function is unable to reconnect, it will forcibly die, or if after the + * the template_redirect hook has been fired, return false instead. + * + * If $allow_bail is false, the lack of database connection will need + * to be handled manually. + * + * @since 3.9.0 + * + * @param bool $allow_bail Optional. Allows the function to bail. Default true. + * @return bool|null True if the connection is up. + */ + public function check_connection( $allow_bail = true ) { + if ( $this->use_mysqli ) { + if ( @mysqli_ping( $this->dbh ) ) { + return true; + } + } else { + if ( @mysql_ping( $this->dbh ) ) { + return true; + } + } + + $error_reporting = false; + + // Disable warnings, as we don't want to see a multitude of "unable to connect" messages + if ( WP_DEBUG ) { + $error_reporting = error_reporting(); + error_reporting( $error_reporting & ~E_WARNING ); + } + + for ( $tries = 1; $tries <= $this->reconnect_retries; $tries++ ) { + // On the last try, re-enable warnings. We want to see a single instance of the + // "unable to connect" message on the bail() screen, if it appears. + if ( $this->reconnect_retries === $tries && WP_DEBUG ) { + error_reporting( $error_reporting ); + } + + if ( $this->db_connect( false ) ) { + if ( $error_reporting ) { + error_reporting( $error_reporting ); + } + + return true; + } + + sleep( 1 ); + } + + // If template_redirect has already happened, it's too late for wp_die()/dead_db(). + // Let's just return and hope for the best. + if ( did_action( 'template_redirect' ) ) { + return false; + } + + if ( ! $allow_bail ) { + return false; + } + + // We weren't able to reconnect, so we better bail. + $this->bail( sprintf( ( " +This means that we lost contact with the database server at %s
. This could mean your host's database server is down.
If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the WordPress Support Forums.
+" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' ); + + // Call dead_db() if bail didn't die, because this database is no more. It has ceased to be (at least temporarily). + dead_db(); + } + + /** + * Perform a MySQL database query, using current database connection. + * + * More information can be found on the codex page. + * + * @since 0.71 + * + * @param string $query Database query + * @return int|false Number of rows affected/selected or false on error + */ + public function query( $query ) { + if ( ! $this->ready ) { + $this->check_current_query = true; + return false; + } + + /** + * Filter the database query. + * + * Some queries are made before the plugins have been loaded, + * and thus cannot be filtered with this method. + * + * @since 2.1.0 + * + * @param string $query Database query. + */ + $query = apply_filters( 'query', $query ); + + $this->flush(); + + // Log how the function was called + $this->func_call = "\$db->query(\"$query\")"; + + // If we're writing to the database, make sure the query will write safely. + if ( $this->check_current_query && ! $this->check_ascii( $query ) ) { + $stripped_query = $this->strip_invalid_text_from_query( $query ); + // strip_invalid_text_from_query() can perform queries, so we need + // to flush again, just to make sure everything is clear. + $this->flush(); + if ( $stripped_query !== $query ) { + $this->insert_id = 0; + return false; + } + } + + $this->check_current_query = true; + // Keep track of the last query for debug.. + $this->last_query = $query; + + $this->_do_query( $query ); + + // MySQL server has gone away, try to reconnect + $mysql_errno = 0; + if ( ! empty( $this->dbh ) ) { + if ( $this->use_mysqli ) { + $mysql_errno = mysqli_errno( $this->dbh ); + } else { + $mysql_errno = mysql_errno( $this->dbh ); + } + } + + if ( empty( $this->dbh ) || 2006 == $mysql_errno ) { + if ( $this->check_connection() ) { + $this->_do_query( $query ); + } else { + $this->insert_id = 0; + return false; + } + } + + // If there is an error then take note of it.. + if ( $this->use_mysqli ) { + $this->last_error = mysqli_error( $this->dbh ); + } else { + $this->last_error = mysql_error( $this->dbh ); + } + + if ( $this->last_error ) { + // Clear insert_id on a subsequent failed insert. + if ( $this->insert_id && preg_match( '/^\s*(insert|replace)\s/i', $query ) ) + $this->insert_id = 0; + + $this->print_error(); + return false; + } + + if ( preg_match( '/^\s*(create|alter|truncate|drop)\s/i', $query ) ) { + $return_val = $this->result; + } elseif ( preg_match( '/^\s*(insert|delete|update|replace)\s/i', $query ) ) { + if ( $this->use_mysqli ) { + $this->rows_affected = mysqli_affected_rows( $this->dbh ); + } else { + $this->rows_affected = mysql_affected_rows( $this->dbh ); + } + // Take note of the insert_id + if ( preg_match( '/^\s*(insert|replace)\s/i', $query ) ) { + if ( $this->use_mysqli ) { + $this->insert_id = mysqli_insert_id( $this->dbh ); + } else { + $this->insert_id = mysql_insert_id( $this->dbh ); + } + } + // Return number of rows affected + $return_val = $this->rows_affected; + } else { + $num_rows = 0; + if ( $this->use_mysqli && $this->result instanceof mysqli_result ) { + while ( $row = @mysqli_fetch_object( $this->result ) ) { + $this->last_result[$num_rows] = $row; + $num_rows++; + } + } else if ( is_resource( $this->result ) ) { + while ( $row = @mysql_fetch_object( $this->result ) ) { + $this->last_result[$num_rows] = $row; + $num_rows++; + } + } + + // Log number of rows the query returned + // and return number of rows selected + $this->num_rows = $num_rows; + $return_val = $num_rows; + } + + return $return_val; + } + + /** + * Internal function to perform the mysql_query() call. + * + * @since 3.9.0 + * + * @access private + * @see wpdb::query() + * + * @param string $query The query to run. + */ + private function _do_query( $query ) { + if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) { + $this->timer_start(); + } + + if ( $this->use_mysqli ) { + $this->result = @mysqli_query( $this->dbh, $query ); + } else { + $this->result = @mysql_query( $query, $this->dbh ); + } + $this->num_queries++; + + if ( defined( 'SAVEQUERIES' ) && SAVEQUERIES ) { + $this->queries[] = array( $query, $this->timer_stop(), $this->get_caller() ); + } + } + + /** + * Insert a row into a table. + * + * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 'bar' ) ) + * wpdb::insert( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) ) + * + * @since 2.5.0 + * @see wpdb::prepare() + * @see wpdb::$field_types + * @see wp_set_wpdb_vars() + * + * @param string $table table name + * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). + * @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', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types. + * @return int|false The number of rows inserted, or false on error. + */ + public function insert( $table, $data, $format = null ) { + return $this->_insert_replace_helper( $table, $data, $format, 'INSERT' ); + } + + /** + * Replace a row into a table. + * + * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 'bar' ) ) + * wpdb::replace( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( '%s', '%d' ) ) + * + * @since 3.0.0 + * @see wpdb::prepare() + * @see wpdb::$field_types + * @see wp_set_wpdb_vars() + * + * @param string $table table name + * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). + * @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', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types. + * @return int|false The number of rows affected, or false on error. + */ + public function replace( $table, $data, $format = null ) { + return $this->_insert_replace_helper( $table, $data, $format, 'REPLACE' ); + } + + /** + * Helper function for insert and replace. + * + * Runs an insert or replace query based on $type argument. + * + * @access private + * @since 3.0.0 + * @see wpdb::prepare() + * @see wpdb::$field_types + * @see wp_set_wpdb_vars() + * + * @param string $table table name + * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). + * @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', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types. + * @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT. + * @return int|false The number of rows affected, or false on error. + */ + function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) { + if ( ! in_array( strtoupper( $type ), array( 'REPLACE', 'INSERT' ) ) ) { + return false; + } + + $data = $this->process_fields( $table, $data, $format ); + if ( false === $data ) { + return false; + } + + $formats = $values = array(); + foreach ( $data as $value ) { + $formats[] = $value['format']; + $values[] = $value['value']; + } + + $fields = '`' . implode( '`, `', array_keys( $data ) ) . '`'; + $formats = implode( ', ', $formats ); + + $sql = "$type INTO `$table` ($fields) VALUES ($formats)"; + + $this->insert_id = 0; + $this->check_current_query = false; + return $this->query( $this->prepare( $sql, $values ) ); + } + + /** + * Update a row in the table + * + * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 'bar' ), array( 'ID' => 1 ) ) + * wpdb::update( 'table', array( 'column' => 'foo', 'field' => 1337 ), array( 'ID' => 1 ), array( '%s', '%d' ), array( '%d' ) ) + * + * @since 2.5.0 + * @see wpdb::prepare() + * @see wpdb::$field_types + * @see wp_set_wpdb_vars() + * + * @param string $table table name + * @param array $data Data to update (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). + * @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw". + * @param array|string $format Optional. An array of formats to be mapped to each of the values in $data. If string, that format will be used for all of the values in $data. + * A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types. + * @param array|string $where_format 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', '%f', '%s' (integer, float, string). If omitted, all values in $where will be treated as strings. + * @return int|false The number of rows updated, or false on error. + */ + public function update( $table, $data, $where, $format = null, $where_format = null ) { + if ( ! is_array( $data ) || ! is_array( $where ) ) { + return false; + } + + $data = $this->process_fields( $table, $data, $format ); + if ( false === $data ) { + return false; + } + $where = $this->process_fields( $table, $where, $where_format ); + if ( false === $where ) { + return false; + } + + $fields = $conditions = $values = array(); + foreach ( $data as $field => $value ) { + $fields[] = "`$field` = " . $value['format']; + $values[] = $value['value']; + } + foreach ( $where as $field => $value ) { + $conditions[] = "`$field` = " . $value['format']; + $values[] = $value['value']; + } + + $fields = implode( ', ', $fields ); + $conditions = implode( ' AND ', $conditions ); + + $sql = "UPDATE `$table` SET $fields WHERE $conditions"; + + $this->check_current_query = false; + return $this->query( $this->prepare( $sql, $values ) ); + } + + /** + * Delete a row in the table + * + * wpdb::delete( 'table', array( 'ID' => 1 ) ) + * wpdb::delete( 'table', array( 'ID' => 1 ), array( '%d' ) ) + * + * @since 3.4.0 + * @see wpdb::prepare() + * @see wpdb::$field_types + * @see wp_set_wpdb_vars() + * + * @param string $table table name + * @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw". + * @param array|string $where_format 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', '%f', '%s' (integer, float, string). If omitted, all values in $where will be treated as strings unless otherwise specified in wpdb::$field_types. + * @return int|false The number of rows updated, or false on error. + */ + public function delete( $table, $where, $where_format = null ) { + if ( ! is_array( $where ) ) { + return false; + } + + $where = $this->process_fields( $table, $where, $where_format ); + if ( false === $where ) { + return false; + } + + $conditions = $values = array(); + foreach ( $where as $field => $value ) { + $conditions[] = "`$field` = " . $value['format']; + $values[] = $value['value']; + } + + $conditions = implode( ' AND ', $conditions ); + + $sql = "DELETE FROM `$table` WHERE $conditions"; + + $this->check_current_query = false; + return $this->query( $this->prepare( $sql, $values ) ); + } + + /** + * Processes arrays of field/value pairs and field formats. + * + * This is a helper method for wpdb's CRUD methods, which take field/value + * pairs for inserts, updates, and where clauses. This method first pairs + * each value with a format. Then it determines the charset of that field, + * using that to determine if any invalid text would be stripped. If text is + * stripped, then field processing is rejected and the query fails. + * + * @since 4.2.0 + * @access protected + * + * @param string $table Table name. + * @param array $data Field/value pair. + * @param mixed $format Format for each field. + * @return array|bool Returns an array of fields that contain paired values + * and formats. Returns false for invalid values. + */ + protected function process_fields( $table, $data, $format ) { + $data = $this->process_field_formats( $data, $format ); + $data = $this->process_field_charsets( $data, $table ); + if ( false === $data ) { + return false; + } + + $converted_data = $this->strip_invalid_text( $data ); + + if ( $data !== $converted_data ) { + return false; + } + + return $data; + } + + /** + * Prepares arrays of value/format pairs as passed to wpdb CRUD methods. + * + * @since 4.2.0 + * @access protected + * + * @param array $data Array of fields to values. + * @param mixed $format Formats to be mapped to the values in $data. + * @return array Array, keyed by field names with values being an array + * of 'value' and 'format' keys. + */ + protected function process_field_formats( $data, $format ) { + $formats = $original_formats = (array) $format; + + foreach ( $data as $field => $value ) { + $value = array( + 'value' => $value, + 'format' => '%s', + ); + + if ( ! empty( $format ) ) { + $value['format'] = array_shift( $formats ); + if ( ! $value['format'] ) { + $value['format'] = reset( $original_formats ); + } + } elseif ( isset( $this->field_types[ $field ] ) ) { + $value['format'] = $this->field_types[ $field ]; + } + + $data[ $field ] = $value; + } + + return $data; + } + + /** + * Adds field charsets to field/value/format arrays generated by + * the {@see wpdb::process_field_formats()} method. + * + * @since 4.2.0 + * @access protected + * + * @param array $data As it comes from the {@see wpdb::process_field_formats()} method. + * @param string $table Table name. + * @return The same array as $data with additional 'charset' keys. + */ + protected function process_field_charsets( $data, $table ) { + foreach ( $data as $field => $value ) { + if ( '%d' === $value['format'] || '%f' === $value['format'] ) { + // We can skip this field if we know it isn't a string. + // This checks %d/%f versus ! %s because it's sprintf() could take more. + $value['charset'] = false; + } elseif ( $this->check_ascii( $value['value'] ) ) { + // If it's ASCII, then we don't need the charset. We can skip this field. + $value['charset'] = false; + } else { + $value['charset'] = $this->get_col_charset( $table, $field ); + if ( is_wp_error( $value['charset'] ) ) { + return false; + } + + // This isn't ASCII. Don't have strip_invalid_text() re-check. + $value['ascii'] = false; + } + + $data[ $field ] = $value; + } + + return $data; + } + + /** + * Retrieve one variable from the database. + * + * Executes a SQL query and returns the value from the SQL result. + * If the SQL result contains more than one column and/or more than one row, this function returns the value in the column and row specified. + * If $query is null, this function returns the value in the specified column and row from the previous SQL result. + * + * @since 0.71 + * + * @param string|null $query Optional. SQL query. Defaults to null, use the result from the previous query. + * @param int $x Optional. Column of value to return. Indexed from 0. + * @param int $y Optional. Row of value to return. Indexed from 0. + * @return string|null Database query result (as string), or null on failure + */ + public function get_var( $query = null, $x = 0, $y = 0 ) { + $this->func_call = "\$db->get_var(\"$query\", $x, $y)"; + + if ( $this->check_safe_collation( $query ) ) { + $this->check_current_query = false; + } + + if ( $query ) { + $this->query( $query ); + } + + // Extract var out of cached results based x,y vals + if ( !empty( $this->last_result[$y] ) ) { + $values = array_values( get_object_vars( $this->last_result[$y] ) ); + } + + // If there is a value return it else return null + return ( isset( $values[$x] ) && $values[$x] !== '' ) ? $values[$x] : null; + } + + /** + * Retrieve one row from the database. + * + * Executes a SQL query and returns the row from the SQL result. + * + * @since 0.71 + * + * @param string|null $query SQL query. + * @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. + * @param int $y Optional. Row to return. Indexed from 0. + * @return mixed Database query result in format specified by $output or null on failure + */ + public function get_row( $query = null, $output = OBJECT, $y = 0 ) { + $this->func_call = "\$db->get_row(\"$query\",$output,$y)"; + + if ( $this->check_safe_collation( $query ) ) { + $this->check_current_query = false; + } + + 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; + } elseif ( $output == ARRAY_A ) { + return $this->last_result[$y] ? get_object_vars( $this->last_result[$y] ) : null; + } elseif ( $output == ARRAY_N ) { + return $this->last_result[$y] ? array_values( get_object_vars( $this->last_result[$y] ) ) : null; + } elseif ( strtoupper( $output ) === OBJECT ) { + // Back compat for OBJECT being previously case insensitive. + return $this->last_result[$y] ? $this->last_result[$y] : null; + } else { + $this->print_error( " \$db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N" ); + } + } + + /** + * Retrieve one column from the database. + * + * Executes a SQL query and returns the column from the SQL result. + * If the SQL result contains more than one column, this function returns the column specified. + * If $query is null, this function returns the specified column from the previous SQL result. + * + * @since 0.71 + * + * @param string|null $query Optional. SQL query. Defaults to previous query. + * @param int $x Optional. Column to return. Indexed from 0. + * @return array Database query result. Array indexed from 0 by SQL result row number. + */ + public function get_col( $query = null , $x = 0 ) { + if ( $this->check_safe_collation( $query ) ) { + $this->check_current_query = false; + } + + if ( $query ) { + $this->query( $query ); + } + + $new_array = array(); + // Extract the column values + for ( $i = 0, $j = count( $this->last_result ); $i < $j; $i++ ) { + $new_array[$i] = $this->get_var( null, $x, $i ); + } + return $new_array; + } + + /** + * Retrieve an entire SQL result set from the database (i.e., many rows) + * + * Executes a SQL query and returns the entire SQL result. + * + * @since 0.71 + * + * @param string $query SQL query. + * @param string $output Optional. Any 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. + * @return mixed Database query results + */ + public function get_results( $query = null, $output = OBJECT ) { + $this->func_call = "\$db->get_results(\"$query\", $output)"; + + if ( $this->check_safe_collation( $query ) ) { + $this->check_current_query = false; + } + + if ( $query ) { + $this->query( $query ); + } else { + return null; + } + + $new_array = array(); + if ( $output == OBJECT ) { + // Return an integer-keyed array of row objects + return $this->last_result; + } elseif ( $output == OBJECT_K ) { + // Return an array of row objects with keys from column 1 + // (Duplicates are discarded) + foreach ( $this->last_result as $row ) { + $var_by_ref = get_object_vars( $row ); + $key = array_shift( $var_by_ref ); + if ( ! isset( $new_array[ $key ] ) ) + $new_array[ $key ] = $row; + } + return $new_array; + } elseif ( $output == ARRAY_A || $output == ARRAY_N ) { + // Return an integer-keyed array of... + if ( $this->last_result ) { + foreach( (array) $this->last_result as $row ) { + if ( $output == ARRAY_N ) { + // ...integer-keyed row arrays + $new_array[] = array_values( get_object_vars( $row ) ); + } else { + // ...column name-keyed row arrays + $new_array[] = get_object_vars( $row ); + } + } + } + return $new_array; + } elseif ( strtoupper( $output ) === OBJECT ) { + // Back compat for OBJECT being previously case insensitive. + return $this->last_result; + } + return null; + } + + /** + * Retrieves the character set for the given table. + * + * @since 4.2.0 + * @access protected + * + * @param string $table Table name. + * @return string|WP_Error Table character set, {@see WP_Error} object if it couldn't be found. + */ + protected function get_table_charset( $table ) { + $tablekey = strtolower( $table ); + + /** + * Filter the table charset value before the DB is checked. + * + * Passing a non-null value to the filter will effectively short-circuit + * checking the DB for the charset, returning that value instead. + * + * @since 4.2.0 + * + * @param string $charset The character set to use. Default null. + * @param string $table The name of the table being checked. + */ + $charset = apply_filters( 'pre_get_table_charset', null, $table ); + if ( null !== $charset ) { + return $charset; + } + + if ( isset( $this->table_charset[ $tablekey ] ) ) { + return $this->table_charset[ $tablekey ]; + } + + $charsets = $columns = array(); + $results = $this->get_results( "SHOW FULL COLUMNS FROM `$table`" ); + if ( ! $results ) { + return new WP_Error( 'wpdb_get_table_charset_failure' ); + } + + foreach ( $results as $column ) { + $columns[ strtolower( $column->Field ) ] = $column; + } + + $this->col_meta[ $tablekey ] = $columns; + + foreach ( $columns as $column ) { + if ( ! empty( $column->Collation ) ) { + list( $charset ) = explode( '_', $column->Collation ); + $charsets[ strtolower( $charset ) ] = true; + } + + list( $type ) = explode( '(', $column->Type ); + + // A binary/blob means the whole query gets treated like this. + if ( in_array( strtoupper( $type ), array( 'BINARY', 'VARBINARY', 'TINYBLOB', 'MEDIUMBLOB', 'BLOB', 'LONGBLOB' ) ) ) { + $this->table_charset[ $tablekey ] = 'binary'; + return 'binary'; + } + } + + // utf8mb3 is an alias for utf8. + if ( isset( $charsets['utf8mb3'] ) ) { + $charsets['utf8'] = true; + unset( $charsets['utf8mb3'] ); + } + + // Check if we have more than one charset in play. + $count = count( $charsets ); + if ( 1 === $count ) { + $charset = key( $charsets ); + } elseif ( 0 === $count ) { + // No charsets, assume this table can store whatever. + $charset = false; + } else { + // More than one charset. Remove latin1 if present and recalculate. + unset( $charsets['latin1'] ); + $count = count( $charsets ); + if ( 1 === $count ) { + // Only one charset (besides latin1). + $charset = key( $charsets ); + } elseif ( 2 === $count && isset( $charsets['utf8'], $charsets['utf8mb4'] ) ) { + // Two charsets, but they're utf8 and utf8mb4, use utf8. + $charset = 'utf8'; + } else { + // Two mixed character sets. ascii. + $charset = 'ascii'; + } + } - /** - * Prepares a SQL query for safe use, using sprintf() syntax. - * - * @link http://php.net/sprintf See for syntax to use for query string. - * @since 2.3.0 - * - * @param null|string $args If string, first parameter must be query statement - * @param mixed $args,... If additional parameters, they will be set inserted into the query. - * @return null|string Sanitized query string - */ - function prepare($args=null) { - if ( is_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); + $this->table_charset[ $tablekey ] = $charset; + return $charset; } /** - * Print SQL/DB error. + * Retrieves the character set for the given column. * - * @since 0.71 - * @global array $EZSQL_ERROR Stores error information of query and error string + * @since 4.2.0 + * @access public * - * @param string $str The error to display - * @return bool False if the showing of errors is disabled. + * @param string $table Table name. + * @param string $column Column name. + * @return mixed Column character set as a string. False if the column has no + * character set. {@see WP_Error} object if there was an error. */ - function print_error($str = '') { - global $EZSQL_ERROR; - - if (!$str) $str = mysql_error($this->dbh); - $EZSQL_ERROR[] = array ('query' => $this->last_query, 'error_str' => $str); + public function get_col_charset( $table, $column ) { + $tablekey = strtolower( $table ); + $columnkey = strtolower( $column ); + + /** + * Filter the column charset value before the DB is checked. + * + * Passing a non-null value to the filter will short-circuit + * checking the DB for the charset, returning that value instead. + * + * @since 4.2.0 + * + * @param string $charset The character set to use. Default null. + * @param string $table The name of the table being checked. + * @param string $column The name of the column being checked. + */ + $charset = apply_filters( 'pre_get_col_charset', null, $table, $column ); + if ( null !== $charset ) { + return $charset; + } - if ( $this->suppress_errors ) + // Skip this entirely if this isn't a MySQL database. + if ( false === $this->is_mysql ) { return false; + } - if ( $caller = $this->get_caller() ) - $error_str = sprintf(/*WP_I18N_DB_QUERY_ERROR_FULL*/'WordPress database error %1$s for query %2$s made by %3$s'/*/WP_I18N_DB_QUERY_ERROR_FULL*/, $str, $this->last_query, $caller); - else - $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); - - $log_error = true; - if ( ! function_exists('error_log') ) - $log_error = false; + if ( empty( $this->table_charset[ $tablekey ] ) ) { + // This primes column information for us. + $table_charset = $this->get_table_charset( $table ); + if ( is_wp_error( $table_charset ) ) { + return $table_charset; + } + } - $log_file = @ini_get('error_log'); - if ( !empty($log_file) && ('syslog' != $log_file) && !@is_writable($log_file) ) - $log_error = false; + // If still no column information, return the table charset. + if ( empty( $this->col_meta[ $tablekey ] ) ) { + return $this->table_charset[ $tablekey ]; + } - if ( $log_error ) - @error_log($error_str, 0); + // If this column doesn't exist, return the table charset. + if ( empty( $this->col_meta[ $tablekey ][ $columnkey ] ) ) { + return $this->table_charset[ $tablekey ]; + } - // Is error output turned on or not.. - if ( !$this->show_errors ) + // Return false when it's not a string column. + if ( empty( $this->col_meta[ $tablekey ][ $columnkey ]->Collation ) ) { return false; + } - $str = htmlspecialchars($str, ENT_QUOTES); - $query = htmlspecialchars($this->last_query, ENT_QUOTES); - - // If there is an error then take note of it - print "WordPress database error: [$str]
- $query