Ticket #15677: 15677.2.patch

src/wp-admin/includes/translation-install.php

@@ +1 @@
+<?php
+/**
+ * WordPress Translation Install Administration API
+ *
+ * @package WordPress
+ * @subpackage Administration
+ */
+
+
+/**
+ * Retrieve translations from WordPress Plugins API.
+ *
+ * @since 4.0.0
+ *
+ * @param string       $type Type of translations. Accepts 'plugins', 'themes', 'core'.
+ * @param array|object $args Translation API arguments. Optional.
+ *
+ * @return object|WP_Error On success an object of translations, WP_Error on failure.
+ */
+function translations_api( $type, $args = null ) {
+        if ( ! in_array( $type, array( 'plugins', 'themes', 'core' ) ) ) {
+                return  new WP_Error( 'invalid_type', __( 'Invalid translation type.' ) );
+        }
+
+        /**
+         * Allows a plugin to override the WordPress.org Translation Install API entirely.
+         *
+         * @since 4.0.0
+         *
+         * @param bool|array  $result The result object. Default false.
+         * @param string      $type   The type of translations being requested.
+         * @param object      $args   Translation API arguments.
+         */
+        $res = apply_filters( 'translations_api', false, $action, $args );
+
+        if ( false === $res ) {
+                $url = 'http://api.wordpress.org/translations/' . $type . '/1.0/';
+                if ( $ssl = wp_http_supports( array( 'ssl' ) ) ) {
+                        $url = set_url_scheme( $url, 'https' );
+                }
+
+                $options = array(
+                        'timeout' => 3,
+                        'body' => array(
+                                'version' => $GLOBALS['wp_version'],
+                                'request' => json_encode( $args ) // @TODO
+                        ),
+                );
+
+                $request = wp_remote_post( $url, $options );
+
+                if ( $ssl && is_wp_error( $request ) ) {
+                        trigger_error( __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="https://wordpress.org/support/">support forums</a>.' ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ), headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE );
+
+                        $request = wp_remote_post( $http_url, $args );
+                }
+
+                if ( is_wp_error( $request ) ) {
+                        $res = new WP_Error( 'translations_api_failed', __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="https://wordpress.org/support/">support forums</a>.' ), $request->get_error_message() );
+                } else {
+                        $res = json_decode( wp_remote_retrieve_body( $request ), true );
+                        if ( ! is_object( $res ) && ! is_array( $res ) ) {
+                                $res = new WP_Error( 'translations_api_failed', __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="https://wordpress.org/support/">support forums</a>.' ), wp_remote_retrieve_body( $request ) );
+                        }
+                }
+        }
+
+        /**
+         * Filter the Translation Install API response results.
+         *
+         * @since 4.0.0
+         *
+         * @param object|WP_Error $res  Response object or WP_Error.
+         * @param string          $type The type of translations being requested.
+         * @param object          $args Translation API arguments.
+         */
+        return apply_filters( 'translations_api_result', $res, $action, $args );
+}
+
+/**
+ * Get available translations from the WordPress.org API.
+ *
+ * @since 4.0.0
+ *
+ * @return array Array of translations, each an array of data.
+ */
+function wp_get_available_translations() {
+        if ( false !== ( $translations = get_site_transient( 'available_translations' ) ) ) {
+                return $translations;
+        }
+
+        $api = translations_api( 'core' ); // @TODO pass $wp_version
+
+        if ( is_wp_error( $api ) ) {
+                return array();
+        }
+
+        $translations = array();
+        // Key the array with the language code for now
+        foreach ( $api['translations'] as $translation ) {
+                $translations[ $translation['language'] ] = $translation;
+        }
+
+        set_site_transient( 'available_translations', $translations, 3 * HOUR_IN_SECONDS );
+
+        return $translations;
+}
+
+/**
+ * Output the input fields for the language selection form on the installation screen.
+ *
+ * @since 4.0.0
+ *
+ * @see wp_get_available_translations()
+ *
+ * @param array $languages Array of available languages (populated via the Translations API).
+ */
+function wp_install_language_form( $languages ) {
+        $installed_languages = get_available_languages();
+
+        echo "<label class='screen-reader-text' for='language'>Select a default language</label>\n";
+        echo "<select size='14' name='language' id='language'>\n";
+        echo '<option value="" lang="en" selected="selected" data-continue="Continue" data-installed="1">English (United States)</option>';
+        echo "\n";
+
+        if ( defined( 'WPLANG' ) && ( '' !== WPLANG ) && ( 'en_US' !== WPLANG ) ) {
+                if ( isset( $languages[ WPLANG ] ) ) {
+                        $language = $languages[ WPLANG ];
+                        echo '<option value="' . esc_attr( $language['language'] ) . '" lang="' . esc_attr( $language['iso'][1] ) . '">' . esc_html( $language['native_name'] ) . "</option>\n";
+                }
+        }
+
+        foreach ( $languages as $language ) {
+                printf( '<option value="%s" lang="%s" data-continue="%s"%s>%s</option>' . "\n",
+                        esc_attr( $language['language'] ),
+                        esc_attr( $language['iso'][1] ),
+                        esc_attr( $language['strings']['continue'] ),
+                        in_array( $language['language'], $installed_languages ) ? ' data-installed="1"' : '',
+                        esc_html( $language['native_name'] ) );
+        }
+        echo "</select>\n";
+        echo '<p class="step"><span class="spinner"></span><input id="language-continue" type="submit" class="button button-primary button-large" value="Continue" /></p>';
+}
+
+/**
+ * Download a language pack.
+ *
+ * @since 4.0.0
+ *
+ * @see wp_get_available_translations()
+ *
+ * @param string $download Language code to download.
+ * @return string|bool Returns the language code if successfully downloaded
+ *                     (or already installed), or false on failure.
+ */
+function wp_install_download_language_pack( $download ) {
+        // Check if the translation is already installed.
+        if ( in_array( $download, get_available_languages() ) ) {
+                return $download;
+        }
+
+        // Confirm the translation is one we can download.
+        $translations = wp_get_available_translations();
+        if ( ! $translations ) {
+                return false;
+        }
+        foreach ( $translations as $translation ) {
+                if ( $translation['language'] === $download ) {
+                        $translation_to_load = true;
+                        break;
+                }
+        }
+
+        if ( empty( $translation_to_load ) ) {
+                return false;
+        }
+        $translation = (object) $translation;
+
+        require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
+        $skin = new Automatic_Upgrader_Skin;
+        $upgrader = new Language_Pack_Upgrader( $skin );
+        $translation->type = 'core';
+        /**
+         * @todo failures (such as non-direct FS)
+         */
+        $upgrader->upgrade( $translation, array( 'clear_update_cache' => false ) );
+        return $translation->language;
+}
+
+/**
+ * Load a translation during the install process.
+ *
+ * @since 4.0.0
+ *
+ * @see load_textdomain()
+ *
+ * @param string $translation Translation to load.
+ * @return string|bool Returns the language code if successfully loaded,
+ *                     or false on failure.
+ */
+function wp_install_load_language( $translation ) {
+        if ( ! empty( $translation ) ) {
+                if ( in_array( $translation, get_available_languages() ) ) {
+                        $translation_to_load = $translation;
+                }
+        }
+
+        if ( empty( $translation_to_load ) ) {
+                return false;
+        }
+
+        unload_textdomain( 'default' ); // Start over.
+        load_textdomain( 'default', WP_LANG_DIR . "/{$translation_to_load}.mo" );
+        load_textdomain( 'default', WP_LANG_DIR . "/admin-{$translation_to_load}.mo" );
+        return $translation_to_load;
+}

src/wp-admin/includes/upgrade.php

@@ -1419 +1419 @@
  */
 function maybe_create_table($table_name, $create_ddl) {
         global $wpdb;
-        
+
         $query = $wpdb->prepare( "SHOW TABLES LIKE %s", $wpdb->esc_like( $table_name ) );
 
         if ( $wpdb->get_var( $query ) == $table_name ) {
@@ -2192 +2192 @@
         dbDelta( $ms_queries );
 }
 endif;
-
-/**
- * Output the input fields for the language selection form on the installation screen.
- *
- * @since 4.0.0
- *
- * @see wp_get_available_translations_from_api()
- * 
- * @param array $languages Array of available languages (populated via the Translations API).
- */
-function wp_install_language_form( $languages ) {
-        $installed_languages = get_available_languages();
-
-        echo "<label class='screen-reader-text' for='language'>Select a default language</label>\n";
-        echo "<select size='14' name='language' id='language'>\n";
-        echo '<option value="" lang="en" selected="selected" data-continue="Continue" data-installed="1">English (United States)</option>';
-        echo "\n";
-
-        if ( defined( 'WPLANG' ) && ( '' !== WPLANG ) && ( 'en_US' !== WPLANG ) ) {
-                if ( isset( $languages[ WPLANG ] ) ) {
-                        $language = $languages[ WPLANG ];
-                        echo '<option value="' . esc_attr( $language['language'] ) . '" lang="' . esc_attr( $language['iso'][1] ) . '">' . esc_html( $language['native_name'] ) . "</option>\n";
-                }
-        }
-
-        foreach ( $languages as $language ) {
-                printf( '<option value="%s" lang="%s" data-continue="%s"%s>%s</option>' . "\n",
-                        esc_attr( $language['language'] ),
-                        esc_attr( $language['iso'][1] ),
-                        esc_attr( $language['strings']['continue'] ),
-                        in_array( $language['language'], $installed_languages ) ? ' data-installed="1"' : '',
-                        esc_html( $language['native_name'] ) );
-        }
-        echo "</select>\n";
-        echo '<p class="step"><span class="spinner"></span><input id="language-continue" type="submit" class="button button-primary button-large" value="Continue" /></p>';
-}
-
-/**
- * Get available translations from the WordPress.org API.
- *
- * @since 4.0.0
- *
- * @see wp_remote_post()
- *
- * @return array Array of translations, each an array of data.
- */
-function wp_get_available_translations_from_api() {
-        $url = 'http://api.wordpress.org/translations/core/1.0/';
-        if ( wp_http_supports( array( 'ssl' ) ) ) {
-                $url = set_url_scheme( $url, 'https' );
-        }
-
-        $options = array(
-                'timeout' => 3,
-                'body' => array( 'version' => $GLOBALS['wp_version'] ),
-        );
-
-        $response = wp_remote_post( $url, $options );
-        $body = wp_remote_retrieve_body( $response );
-        if ( $body && $body = json_decode( $body, true ) ) {
-                $translations = array();
-                // Key the array with the language code for now
-                foreach ( $body['translations'] as $translation ) {
-                        $translations[ $translation['language'] ] = $translation;
-                }
-                return $translations;
-        }
-        return false;
-}
-
-/**
- * Download a language pack.
- *
- * @since 4.0.0
- *
- * @see wp_get_available_translations_from_api()
- *
- * @param string $download Language code to download.
- * @return string|bool Returns the language code if successfully downloaded
- *                     (or already installed), or false on failure.
- */
-function wp_install_download_language_pack( $download ) {
-        // Check if the translation is already installed.
-        if ( in_array( $download, get_available_languages() ) ) {
-                return $download;
-        }
-
-        // Confirm the translation is one we can download.
-        $translations = wp_get_available_translations_from_api();
-        if ( ! $translations ) {
-                return false;
-        }
-        foreach ( $translations as $translation ) {
-                if ( $translation['language'] === $download ) {
-                        $translation_to_load = true;
-                        break;
-                }
-        }
-
-        if ( empty( $translation_to_load ) ) {
-                return false;
-        }
-        $translation = (object) $translation;
-
-        require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
-        $skin = new Automatic_Upgrader_Skin;
-        $upgrader = new Language_Pack_Upgrader( $skin );
-        $translation->type = 'core';
-        /**
-         * @todo failures (such as non-direct FS)
-         */
-        $upgrader->upgrade( $translation, array( 'clear_update_cache' => false ) );
-        return $translation->language;
-}
-
-/**
- * Load a translation during the install process.
- *
- * @since 4.0.0
- *
- * @see load_textdomain()
- *
- * @param string $translation Translation to load.
- * @return string|bool Returns the language code if successfully loaded,
- *                     or false on failure.
- */
-function wp_install_load_language( $translation ) {
-        if ( ! empty( $translation ) ) {
-                if ( in_array( $translation, get_available_languages() ) ) {
-                        $translation_to_load = $translation;
-                }
-        }
-
-        if ( empty( $translation_to_load ) ) {
-                return false;
-        }
-
-        unload_textdomain( 'default' ); // Start over.
-        load_textdomain( 'default', WP_LANG_DIR . "/{$translation_to_load}.mo" );
-        load_textdomain( 'default', WP_LANG_DIR . "/admin-{$translation_to_load}.mo" );
-        return $translation_to_load;
-}

src/wp-admin/install.php

@@ -38 +38 @@
 /** Load WordPress Administration Upgrade API */
 require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
 
+/** Load WordPress Translation Install API */
+require_once( ABSPATH . 'wp-admin/includes/translation-install.php' );
+
 /** Load wpdb */
 require_once( ABSPATH . WPINC . '/wp-db.php' );
 
@@ -179 +182 @@
 switch($step) {
         case 0: // Step 0
 
-                if ( empty( $_GET['language'] ) && ( $languages = wp_get_available_translations_from_api() ) ) {
+                if ( empty( $_GET['language'] ) && ( $languages = wp_get_available_translations() ) ) {
                         display_header( 'language-chooser' );
                         echo '<form id="setup" method="post" action="?step=1">';
                         wp_install_language_form( $languages );

src/wp-admin/options-general.php

@@ -302 +302 @@
 </select></td>
 </tr>
 <?php do_settings_fields('general', 'default'); ?>
-<?php
-        $languages = get_available_languages();
-        if ( $languages ) :
-?>
-        <tr>
-                <th width="33%" scope="row"><label for="WPLANG"><?php _e('Site Language') ?></label></th>
-                <td>
-                        <?php wp_dropdown_languages( array(
-                                'name'      => 'WPLANG',
-                                'id'        => 'WPLANG',
-                                'selected'  => get_option( 'WPLANG' ),
-                                'languages' => $languages,
-                        ) ); ?>
-                </td>
-        </tr>
-<?php
-        endif;
-?>
+
+<tr>
+        <th width="33%" scope="row"><label for="WPLANG"><?php _e( 'Site Language' ); ?></label></th>
+        <td>
+                <?php
+                $wp_lang = get_option( 'WPLANG' );
+                if ( ! in_array( $wp_lang, get_available_languages() ) ) {
+                        $wp_lang = '';
+                }
+                wp_dropdown_languages( array(
+                        'name'     => 'WPLANG',
+                        'id'       => 'WPLANG',
+                        'selected' => $wp_lang,
+                ) );
+
+                if ( empty( $wp_lang ) && defined( 'WPLANG' ) && WPLANG ) {
+                        ?>
+                        <p class="description"><?php _e( '<code>WPLANG</code> is defined and is used instead of English.' ); ?></p>
+                        <?php
+                }
+                ?>
+        </td>
+</tr>
 </table>
 
 <?php do_settings_sections('general'); ?>

src/wp-admin/options.php

@@ -151 +151 @@
                 $options = $whitelist_options[ $option_page ];
         }
 
-        // Handle custom date/time formats
         if ( 'general' == $option_page ) {
+                // Handle custom date/time formats
                 if ( !empty($_POST['date_format']) && isset($_POST['date_format_custom']) && '\c\u\s\t\o\m' == wp_unslash( $_POST['date_format'] ) )
                         $_POST['date_format'] = $_POST['date_format_custom'];
                 if ( !empty($_POST['time_format']) && isset($_POST['time_format_custom']) && '\c\u\s\t\o\m' == wp_unslash( $_POST['time_format'] ) )
@@ -163 +163 @@
                         $_POST['gmt_offset'] = preg_replace('/UTC\+?/', '', $_POST['gmt_offset']);
                         $_POST['timezone_string'] = '';
                 }
+
+                // Handle translation install
+                if ( ! empty( $_POST['WPLANG'] ) ) {
+                        require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
+                        require_once( ABSPATH . 'wp-admin/includes/translation-install.php' );
+
+                        $language = wp_install_download_language_pack( $_POST['WPLANG'] );
+                        if ( $language ) {
+                                $_POST['WPLANG'] = $language;
+                                wp_install_load_language( $language );
+                        }
+                }
         }
 
         if ( $options ) {

src/wp-admin/setup-config.php

@@ -32 +32 @@
 
 require( ABSPATH . 'wp-settings.php' );
 
-require( ABSPATH . 'wp-admin/includes/upgrade.php' );
+/** Load WordPress Administration Upgrade API */
+require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
 
+/** Load WordPress Translation Install API */
+require_once( ABSPATH . 'wp-admin/includes/translation-install.php' );
+
 // Support wp-config-sample.php one level up, for the develop repo.
 if ( file_exists( ABSPATH . 'wp-config-sample.php' ) )
         $config_file = file( ABSPATH . 'wp-config-sample.php' );
@@ -86 +90 @@
 switch($step) {
         case -1:
 
-                if ( empty( $_GET['language'] ) && ( $languages = wp_get_available_translations_from_api() ) ) {
+                if ( empty( $_GET['language'] ) && ( $languages = wp_get_available_translations() ) ) {
                         setup_config_display_header( 'language-chooser' );
                         echo '<form id="setup" method="post" action="?step=0">';
                         wp_install_language_form( $languages );

src/wp-includes/l10n.php

@@ -823 +823 @@
  * @since 4.0.0
  *
  * @see get_available_languages()
+ * @see wp_get_available_translations()
  *
  * @param array $args Optional arguments. Default empty array.
  */
 function wp_dropdown_languages( $args = array() ) {
-        if ( isset( $args['languages'] ) ) {
-                $languages = $args['languages'];
-        } else {
-                $languages = get_available_languages();
+        require_once( ABSPATH . 'wp-admin/includes/translation-install.php' );
+
+        $locales = get_available_languages();
+        $translations = wp_get_available_translations();
+
+        /*
+         * get_available_languages() just returns the locales. Find the locale in
+         * $translations to get the native name.
+         */
+        $languages = array();
+        foreach ( $locales as $locale ) {
+                if ( isset( $translations[ $locale ] ) ) {
+                        $translation = $translations[ $locale ];
+                        $languages[ $locale ] = array(
+                                'language'     => $translation['language'],
+                                'native_name'  => $translation['native_name'],
+                        );
+                } else {
+                        $languages[ $locale ] = array(
+                                'language'     => $locale,
+                                'native_name'  => '',
+                        );
+                }
         }
 
+        // Remove installed languages from available translations
+        $translations = array_diff_key( $translations, $languages );
+
         printf( '<select name="%s" id="%s">', esc_attr( $args['name'] ), esc_attr( $args['id'] ) );
-        echo '<option value="">en_US</option>';
+
+        $structure = array();
+
+        // Installed languages
+        $structure[] = '<optgroup label="' . esc_attr__( 'Installed Languages' ) . '">';
+        $structure[] = '<option value="">English</option>';
         foreach ( $languages as $language ) {
-                $selected = selected( $language, $args['selected'], false );
-                echo '<option value="' . esc_attr( $language ) .'"' . $selected . '>' . $language . '</option>';
+                $selected = selected( $language['language'], $args['selected'], false );
+                $structure[] = '<option value="' . esc_attr( $language['language'] ) .'"' . $selected . '>' . esc_html( $language['native_name'] ) . '</option>';
         }
+        $structure[] = '</optgroup>';
+
+        // Available translations
+        if ( ! empty( $translations ) ) {
+                $structure[] = '<optgroup label="' . esc_attr__( 'Available Translations' ) . '">';
+                foreach ( $translations as $translation ) {
+                        $selected = selected( $translation['language'], $args['selected'], false );
+                        $structure[] = '<option value="' . esc_attr( $translation['language'] ) .'"' . $selected . '>' . esc_html( $translation['native_name'] ) . '</option>';
+                }
+                $structure[] = '</optgroup>';
+        }
+
+        echo join( "\n", $structure );
+
         echo '</select>';
 }