WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / wp-db.php
index 759baaaee6a69583f2b12925d89b5fe65acd64d9..caae412afa6ff7011a4338b0a7c5dde8e0c0c44d 100644 (file)
@@ -266,7 +266,7 @@ class wpdb {
         * @var array
         */
        var $tables = array( 'posts', 'comments', 'links', 'options', 'postmeta',
-               'terms', 'term_taxonomy', 'term_relationships', 'commentmeta' );
+               'terms', 'term_taxonomy', 'term_relationships', 'termmeta', 'commentmeta' );
 
        /**
         * List of deprecated WordPress tables
@@ -382,6 +382,15 @@ class wpdb {
         */
        public $term_taxonomy;
 
+       /**
+        * WordPress Term Meta table.
+        *
+        * @since 4.4.0
+        * @access public
+        * @var string
+        */
+       public $termmeta;
+
        /*
         * Global and Multisite tables
         */
@@ -840,7 +849,7 @@ class wpdb {
                 */
                $incompatible_modes = (array) apply_filters( 'incompatible_sql_modes', $this->incompatible_modes );
 
-               foreach( $modes as $i => $mode ) {
+               foreach ( $modes as $i => $mode ) {
                        if ( in_array( $mode, $incompatible_modes ) ) {
                                unset( $modes[ $i ] );
                        }
@@ -1043,14 +1052,40 @@ class wpdb {
                        $this->ready = false;
                        if ( ! did_action( 'template_redirect' ) ) {
                                wp_load_translations_early();
-                               $this->bail( sprintf( __( '<h1>Can&#8217;t select database</h1>
-<p>We were able to connect to the database server (which means your username and password is okay) but not able to select the <code>%1$s</code> database.</p>
-<ul>
-<li>Are you sure it exists?</li>
-<li>Does the user <code>%2$s</code> have permission to use the <code>%1$s</code> database?</li>
-<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>
-</ul>
-<p>If you don\'t know how to set up a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href="https://wordpress.org/support/">WordPress Support Forums</a>.</p>' ), htmlspecialchars( $db, ENT_QUOTES ), htmlspecialchars( $this->dbuser, ENT_QUOTES ) ), 'db_select_fail' );
+
+                               $message = '<h1>' . __( 'Can&#8217;t select database' ) . "</h1>\n";
+
+                               $message .= '<p>' . sprintf(
+                                       /* translators: %s: database name */
+                                       __( 'We were able to connect to the database server (which means your username and password is okay) but not able to select the %s database.' ),
+                                       '<code>' . htmlspecialchars( $db, ENT_QUOTES ) . '</code>'
+                               ) . "</p>\n";
+
+                               $message .= "<ul>\n";
+                               $message .= '<li>' . __( 'Are you sure it exists?' ) . "</li>\n";
+
+                               $message .= '<li>' . sprintf(
+                                       /* translators: 1: database user, 2: database name */
+                                       __( 'Does the user %1$s have permission to use the %2$s database?' ),
+                                       '<code>' . htmlspecialchars( $this->dbuser, ENT_QUOTES )  . '</code>',
+                                       '<code>' . htmlspecialchars( $db, ENT_QUOTES ) . '</code>'
+                               ) . "</li>\n";
+
+                               $message .= '<li>' . sprintf(
+                                       /* translators: %s: database name */
+                                       __( '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?' ),
+                                       htmlspecialchars( $db, ENT_QUOTES )
+                               ). "</li>\n";
+
+                               $message .= "</ul>\n";
+
+                               $message .= '<p>' . sprintf(
+                                       /* translators: %s: support forums URL */
+                                       __( 'If you don&#8217;t know how to set up a database you should <strong>contact your host</strong>. If all else fails you may find help at the <a href="%s">WordPress Support Forums</a>.' ),
+                                       __( 'https://wordpress.org/support/' )
+                               ) . "</p>\n";
+
+                               $this->bail( $message, 'db_select_fail' );
                        }
                }
        }
@@ -1061,7 +1096,7 @@ class wpdb {
         * Use esc_sql() or wpdb::prepare() instead.
         *
         * @since 2.8.0
-        * @deprecated 3.6.0
+        * @deprecated 3.6.0 Use wpdb::prepare()
         * @see wpdb::prepare
         * @see esc_sql()
         * @access private
@@ -1097,6 +1132,7 @@ class wpdb {
 
                $class = get_class( $this );
                if ( function_exists( '__' ) ) {
+                       /* translators: %s: database access abstraction class, usually wpdb or a class extending wpdb */
                        _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 );
@@ -1135,7 +1171,7 @@ class wpdb {
         * Use esc_sql() or wpdb::prepare() instead.
         *
         * @since 0.71
-        * @deprecated 3.6.0
+        * @deprecated 3.6.0 Use wpdb::prepare()
         * @see wpdb::prepare()
         * @see esc_sql()
         *
@@ -1474,7 +1510,7 @@ class wpdb {
 
                                if ( $attempt_fallback ) {
                                        $this->use_mysqli = false;
-                                       $this->db_connect();
+                                       return $this->db_connect( $allow_bail );
                                }
                        }
                } else {
@@ -1494,16 +1530,28 @@ class wpdb {
                                die();
                        }
 
-                       $this->bail( sprintf( __( "
-<h1>Error establishing a database connection</h1>
-<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>
-<ul>
-       <li>Are you sure you have the correct username and password?</li>
-       <li>Are you sure that you have typed the correct hostname?</li>
-       <li>Are you sure that the database server is running?</li>
-</ul>
-<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='https://wordpress.org/support/'>WordPress Support Forums</a>.</p>
-" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
+                       $message = '<h1>' . __( 'Error establishing a database connection' ) . "</h1>\n";
+
+                       $message .= '<p>' . sprintf(
+                               /* translators: 1: wp-config.php. 2: database host */
+                               __( 'This either means that the username and password information in your %1$s file is incorrect or we can&#8217;t contact the database server at %2$s. This could mean your host&#8217;s database server is down.' ),
+                               '<code>wp-config.php</code>',
+                               '<code>' . htmlspecialchars( $this->dbhost, ENT_QUOTES ) . '</code>'
+                       ) . "</p>\n";
+
+                       $message .= "<ul>\n";
+                       $message .= '<li>' . __( 'Are you sure you have the correct username and password?' ) . "</li>\n";
+                       $message .= '<li>' . __( 'Are you sure that you have typed the correct hostname?' ) . "</li>\n";
+                       $message .= '<li>' . __( 'Are you sure that the database server is running?' ) . "</li>\n";
+                       $message .= "</ul>\n";
+
+                       $message .= '<p>' . sprintf(
+                               /* translators: %s: support forums URL */
+                               __( 'If you&#8217;re unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href="%s">WordPress Support Forums</a>.' ),
+                               __( 'https://wordpress.org/support/' )
+                       ) . "</p>\n";
+
+                       $this->bail( $message, 'db_connect_fail' );
 
                        return false;
                } elseif ( $this->dbh ) {
@@ -1586,16 +1634,29 @@ class wpdb {
                        return false;
                }
 
+               wp_load_translations_early();
+
+               $message = '<h1>' . __( 'Error reconnecting to the database' ) . "</h1>\n";
+
+               $message .= '<p>' . sprintf(
+                       /* translators: %s: database host */
+                       __( 'This means that we lost contact with the database server at %s. This could mean your host&#8217;s database server is down.' ),
+                       '<code>' . htmlspecialchars( $this->dbhost, ENT_QUOTES ) . '</code>'
+               ) . "</p>\n";
+
+               $message .= "<ul>\n";
+               $message .= '<li>' . __( 'Are you sure that the database server is running?' ) . "</li>\n";
+               $message .= '<li>' . __( 'Are you sure that the database server is not under particularly heavy load?' ) . "</li>\n";
+               $message .= "</ul>\n";
+
+               $message .= '<p>' . sprintf(
+                       /* translators: %s: support forums URL */
+                       __( 'If you&#8217;re unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href="%s">WordPress Support Forums</a>.' ),
+                       __( 'https://wordpress.org/support/' )
+               ) . "</p>\n";
+
                // We weren't able to reconnect, so we better bail.
-               $this->bail( sprintf( ( "
-<h1>Error reconnecting to the database</h1>
-<p>This means that we lost contact with the database server at <code>%s</code>. This could mean your host's database server is down.</p>
-<ul>
-       <li>Are you sure that the database server is running?</li>
-       <li>Are you sure that the database server is not under particularly heavy load?</li>
-</ul>
-<p>If you're unsure what these terms mean you should probably contact your host. If you still need help you can always visit the <a href='https://wordpress.org/support/'>WordPress Support Forums</a>.</p>
-" ), htmlspecialchars( $this->dbhost, ENT_QUOTES ) ), 'db_connect_fail' );
+               $this->bail( $message, '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();
@@ -1770,6 +1831,7 @@ class wpdb {
         * @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).
+        *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
         * @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).
@@ -1794,6 +1856,7 @@ class wpdb {
         * @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).
+        *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
         * @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).
@@ -1818,6 +1881,7 @@ class wpdb {
         * @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).
+        *                             Sending a null value will cause the column to be set to NULL - the corresponding format is ignored in this case.
         * @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).
@@ -1839,6 +1903,11 @@ class wpdb {
 
                $formats = $values = array();
                foreach ( $data as $value ) {
+                       if ( is_null( $value['value'] ) ) {
+                               $formats[] = 'NULL';
+                               continue;
+                       }
+
                        $formats[] = $value['format'];
                        $values[]  = $value['value'];
                }
@@ -1866,9 +1935,12 @@ class wpdb {
         * @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).
+        *                                   Sending a null value will cause the column to be set to NULL - the corresponding
+        *                                   format is ignored in this case.
         * @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".
+        *                                   Sending a null value will create an IS NULL comparison - the corresponding format will be ignored in this case.
         * @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).
@@ -1895,10 +1967,20 @@ class wpdb {
 
                $fields = $conditions = $values = array();
                foreach ( $data as $field => $value ) {
+                       if ( is_null( $value['value'] ) ) {
+                               $fields[] = "`$field` = NULL";
+                               continue;
+                       }
+
                        $fields[] = "`$field` = " . $value['format'];
                        $values[] = $value['value'];
                }
                foreach ( $where as $field => $value ) {
+                       if ( is_null( $value['value'] ) ) {
+                               $conditions[] = "`$field` IS NULL";
+                               continue;
+                       }
+
                        $conditions[] = "`$field` = " . $value['format'];
                        $values[] = $value['value'];
                }
@@ -1927,6 +2009,7 @@ class wpdb {
         * @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".
+        *                                   Sending a null value will create an IS NULL comparison - the corresponding format will be ignored in this case.
         * @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).
@@ -1945,6 +2028,11 @@ class wpdb {
 
                $conditions = $values = array();
                foreach ( $where as $field => $value ) {
+                       if ( is_null( $value['value'] ) ) {
+                               $conditions[] = "`$field` IS NULL";
+                               continue;
+                       }
+
                        $conditions[] = "`$field` = " . $value['format'];
                        $values[] = $value['value'];
                }
@@ -2049,8 +2137,10 @@ class wpdb {
        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.
+                               /*
+                                * We can skip this field if we know it isn't a string.
+                                * This checks %d/%f versus ! %s because its sprintf() could take more.
+                                */
                                $value['charset'] = false;
                        } else {
                                $value['charset'] = $this->get_col_charset( $table, $field );
@@ -2079,8 +2169,10 @@ class wpdb {
        protected function process_field_lengths( $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.
+                               /*
+                                * We can skip this field if we know it isn't a string.
+                                * This checks %d/%f versus ! %s because its sprintf() could take more.
+                                */
                                $value['length'] = false;
                        } else {
                                $value['length'] = $this->get_col_length( $table, $field );
@@ -2249,7 +2341,7 @@ class wpdb {
                } elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
                        // Return an integer-keyed array of...
                        if ( $this->last_result ) {
-                               foreach( (array) $this->last_result as $row ) {
+                               foreach ( (array) $this->last_result as $row ) {
                                        if ( $output == ARRAY_N ) {
                                                // ...integer-keyed row arrays
                                                $new_array[] = array_values( get_object_vars( $row ) );
@@ -2401,7 +2493,7 @@ class wpdb {
                }
 
                // Skip this entirely if this isn't a MySQL database.
-               if ( false === $this->is_mysql ) {
+               if ( empty( $this->is_mysql ) ) {
                        return false;
                }
 
@@ -2450,7 +2542,7 @@ class wpdb {
                $columnkey = strtolower( $column );
 
                // Skip this entirely if this isn't a MySQL database.
-               if ( false === $this->is_mysql ) {
+               if ( empty( $this->is_mysql ) ) {
                        return false;
                }
 
@@ -2482,47 +2574,45 @@ class wpdb {
                                        'type'   => 'char',
                                        'length' => (int) $length,
                                );
-                               break;
+
                        case 'binary':
                        case 'varbinary':
                                return array(
                                        'type'   => 'byte',
                                        'length' => (int) $length,
                                );
-                               break;
+
                        case 'tinyblob':
                        case 'tinytext':
                                return array(
                                        'type'   => 'byte',
                                        'length' => 255,        // 2^8 - 1
                                );
-                               break;
+
                        case 'blob':
                        case 'text':
                                return array(
                                        'type'   => 'byte',
                                        'length' => 65535,      // 2^16 - 1
                                );
-                               break;
+
                        case 'mediumblob':
                        case 'mediumtext':
                                return array(
                                        'type'   => 'byte',
                                        'length' => 16777215,   // 2^24 - 1
                                );
-                               break;
+
                        case 'longblob':
                        case 'longtext':
                                return array(
                                        'type'   => 'byte',
                                        'length' => 4294967295, // 2^32 - 1
                                );
-                               break;
+
                        default:
                                return false;
                }
-
-               return false;
        }
 
        /**
@@ -2594,7 +2684,7 @@ class wpdb {
                }
 
                // If any of the columns don't have one of these collations, it needs more sanity checking.
-               foreach( $this->col_meta[ $table ] as $col ) {
+               foreach ( $this->col_meta[ $table ] as $col ) {
                        if ( empty( $col->Collation ) ) {
                                continue;
                        }
@@ -2721,11 +2811,21 @@ class wpdb {
                                                $charset = $value['charset'];
                                        }
 
+                                       if ( $this->charset ) {
+                                               $connection_charset = $this->charset;
+                                       } else {
+                                               if ( $this->use_mysqli ) {
+                                                       $connection_charset = mysqli_character_set_name( $this->dbh );
+                                               } else {
+                                                       $connection_charset = mysql_client_encoding();
+                                               }
+                                       }
+
                                        if ( is_array( $value['length'] ) ) {
-                                               $queries[ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING $charset ), %.0f ) USING {$this->charset} )", $value['value'], $value['length']['length'] );
+                                               $queries[ $col ] = $this->prepare( "CONVERT( LEFT( CONVERT( %s USING $charset ), %.0f ) USING $connection_charset )", $value['value'], $value['length']['length'] );
                                        } else if ( 'binary' !== $charset ) {
                                                // If we don't have a length, there's no need to convert binary - it will always return the same result.
-                                               $queries[ $col ] = $this->prepare( "CONVERT( CONVERT( %s USING $charset ) USING {$this->charset} )", $value['value'] );
+                                               $queries[ $col ] = $this->prepare( "CONVERT( CONVERT( %s USING $charset ) USING $connection_charset )", $value['value'] );
                                        }
 
                                        unset( $data[ $col ]['db'] );
@@ -2944,7 +3044,7 @@ class wpdb {
                        if ( $col_offset == -1 ) {
                                $i = 0;
                                $new_array = array();
-                               foreach( (array) $this->col_info as $col ) {
+                               foreach ( (array) $this->col_info as $col ) {
                                        $new_array[$i] = $col->{$info_type};
                                        $i++;
                                }
@@ -2991,10 +3091,11 @@ class wpdb {
         */
        public function bail( $message, $error_code = '500' ) {
                if ( !$this->show_errors ) {
-                       if ( class_exists( 'WP_Error' ) )
+                       if ( class_exists( 'WP_Error', false ) ) {
                                $this->error = new WP_Error($error_code, $message);
-                       else
+                       } else {
                                $this->error = $message;
+                       }
                        return false;
                }
                wp_die($message);
@@ -3022,9 +3123,10 @@ class wpdb {
         *
         * Called when WordPress is generating the table scheme.
         *
+        * Use `wpdb::has_cap( 'collation' )`.
+        *
         * @since 2.5.0
-        * @deprecated 3.5.0
-        * @deprecated Use wpdb::has_cap( 'collation' )
+        * @deprecated 3.5.0 Use wpdb::has_cap()
         *
         * @return bool True if collation is supported, false if version does not
         */