Changeset 1721

Timestamp:

07/10/2015 05:29:36 PM (9 years ago)

Author:

ocean90

Message:

Translate: Improve custom routes.

• Don't register custom routes for API request.
• Move locale overview to translate.wordpress.org, no redirect anymore.
• Replace /languages prefix with /locale.
• Redirect old /languages URLs to the new route.
• Rename custom templates.

see #994, #1091.

Location:

sites/trunk/translate.wordpress.org

Files:

• includes/gp-plugins/wporg-routes/routes/index.php (modified) (1 diff)
• includes/gp-plugins/wporg-routes/routes/locale.php (modified) (3 diffs)
• includes/gp-plugins/wporg-routes/routes/redirector.php (added)
• includes/gp-plugins/wporg-routes/wporg-routes.php (modified) (3 diffs)
• public_html/gp-templates/index-locales.php (moved) (moved from sites/trunk/translate.wordpress.org/public_html/gp-templates/locales.php) (2 diffs)
• public_html/gp-templates/locale-project.php (modified) (2 diffs)
• public_html/gp-templates/locale-projects.php (moved) (moved from sites/trunk/translate.wordpress.org/public_html/gp-templates/locale.php) (4 diffs)

sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-routes/routes/index.php

@@ -7 +7 @@
 class GP_WPorg_Route_Index extends GP_Route {
 
-    public function get_index() {
-        $this->redirect( gp_url( '/languages' ) );
+    /**
+     * Prints all exisiting locales as cards.
+     */
+    public function get_locales() {
+        $locales = array();
+        $existing_locales = GP::$translation_set->existing_locales();
+        foreach ( $existing_locales as $locale ) {
+            $locales[] = GP_Locales::by_slug( $locale );
+        }
+        usort( $locales, array( $this, '_sort_english_name_callback') );
+        unset( $existing_locales );
+
+        $contributors_count = wp_cache_get( 'contributors-count', 'wporg-translate' );
+        if ( false === $contributors_count ) {
+            $contributors_count = array();
+        }
+
+        $translation_status = wp_cache_get( 'translation-status', 'wporg-translate' );
+        if ( false === $translation_status ) {
+            $translation_status = array();
+        }
+
+        $this->tmpl( 'index-locales', get_defined_vars() );
+    }
+
+    private function _sort_english_name_callback( $a, $b ) {
+        return $a->english_name > $b->english_name;
     }
 }

sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-routes/routes/locale.php

@@ -3 +3 @@
  * Locale Route Class.
  *
- * Provides the route for translate.wordpress.org/languages.
+ * Provides the route for translate.wordpress.org/locale/$locale.
  */
 class GP_WPorg_Route_Locale extends GP_Route {
-
-    /**
-     * Prints all exisiting locales as cards.
-     */
-    public function get_locales() {
-        $locales = array();
-        $existing_locales = GP::$translation_set->existing_locales();
-        foreach ( $existing_locales as $locale ) {
-            $locales[] = GP_Locales::by_slug( $locale );
-        }
-        usort( $locales, array( $this, '_sort_english_name_callback') );
-        unset( $existing_locales );
-
-        $contributors_count = wp_cache_get( 'contributors-count', 'wporg-translate' );
-        if ( false === $contributors_count ) {
-            $contributors_count = array();
-        }
-
-        $translation_status = wp_cache_get( 'translation-status', 'wporg-translate' );
-        if ( false === $translation_status ) {
-            $translation_status = array();
-        }
-
-        $this->tmpl( 'locales', get_defined_vars() );
-    }
 
     /**
@@ -78 +53 @@
         $variants = $this->get_locale_variants( $locale_slug, array_keys( $project_status ) );
 
-        $this->tmpl( 'locale', get_defined_vars() );
+        $this->tmpl( 'locale-projects', get_defined_vars() );
     }
 
@@ -285 +260 @@
         return strcasecmp( $a->name, $b->name );
     }
-
-    private function _sort_english_name_callback( $a, $b ) {
-        return $a->english_name > $b->english_name;
-    }
 }

sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-routes/wporg-routes.php

@@ -1 +1 @@
 <?php
 /**
- * This plugins overrides some of the default routes of GlotPress.
+ * Register custom routes for translate.wordpress.org.
  *
  * @author ocean90
  */
 
+require_once __DIR__ . '/routes/redirector.php';
 require_once __DIR__ . '/routes/index.php';
 require_once __DIR__ . '/routes/locale.php';
@@ -18 +19 @@
 
     public function init() {
+        // Bail for API requests.
+        $request_uri = GP::$router->request_uri();
+        if ( gp_startswith( $request_uri, '/' . GP::$router->api_prefix . '/' ) ) {
+            return;
+        }
+
         $path = '(.+?)';
         $locale = '(' . implode( '|', array_map( function( $locale ) { return $locale->slug; }, GP_Locales::locales() ) ) . ')';
 
-        /*
-         * Unset default routes.
-         * The `routes` filter can't be used, see https://glotpress.trac.wordpress.org/ticket/249.
-         */
+        // Unset default routes.
         unset( GP::$router->urls['/'] );
         unset( GP::$router->urls["get:/languages/$locale/$path"] );
@@ -30 +34 @@
         unset( GP::$router->urls['get:/languages'] );
 
-        GP::$router->add( '/', array( 'GP_WPorg_Route_Index', 'get_index' ) );
-        GP::$router->add( "/languages/$locale/$path/$path/$path", array( 'GP_WPorg_Route_Locale', 'get_locale_project' ) );
-        GP::$router->add( "/languages/$locale/$path/$path", array( 'GP_WPorg_Route_Locale', 'get_locale_projects' ) );
-        GP::$router->add( "/languages/$locale/$path", array( 'GP_WPorg_Route_Locale', 'get_locale_projects' ) );
-        GP::$router->add( "/languages/$locale", array( 'GP_WPorg_Route_Locale', 'get_locale_projects' ) );
-        GP::$router->add( '/languages', array( 'GP_WPorg_Route_Locale', 'get_locales' ) );
+        // Redirect routes.
+        GP::$router->add( "/languages/$path", array( 'GP_WPorg_Route_Redirector', 'redirect_languages' ) );
+        GP::$router->add( '/languages', array( 'GP_WPorg_Route_Redirector', 'redirect_languages' ) );
+
+        // Register custom routes.
+        GP::$router->add( '/', array( 'GP_WPorg_Route_Index', 'get_locales' ) );
+        GP::$router->add( "/locale/$locale/$path/$path/$path", array( 'GP_WPorg_Route_Locale', 'get_locale_project' ) );
+        GP::$router->add( "/locale/$locale/$path/$path", array( 'GP_WPorg_Route_Locale', 'get_locale_projects' ) );
+        GP::$router->add( "/locale/$locale/$path", array( 'GP_WPorg_Route_Locale', 'get_locale_projects' ) );
+        GP::$router->add( "/locale/$locale", array( 'GP_WPorg_Route_Locale', 'get_locale_projects' ) );
     }
 }

sites/trunk/translate.wordpress.org/public_html/gp-templates/index-locales.php

@@ -30 +30 @@
             <div class="locale <?php echo 'percent-' . $percent_complete; ?>">
                 <ul class="name">
-                    <li class="english"><?php echo gp_link_get( gp_url_join( gp_url_current(), $locale->slug ), $locale->english_name ) ?></li>
-                    <li class="native"><?php echo gp_link_get( gp_url_join( gp_url_current(), $locale->slug ), $locale->native_name ) ?></li>
-                    <li class="code"><?php echo gp_link_get( gp_url_join( gp_url_current(), $locale->slug ), $wp_locale ) ?></li>
+                    <li class="english"><?php echo gp_link_get( gp_url_join( '/locale', $locale->slug ), $locale->english_name ) ?></li>
+                    <li class="native"><?php echo gp_link_get( gp_url_join( '/locale', $locale->slug ), $locale->native_name ) ?></li>
+                    <li class="code"><?php echo gp_link_get( gp_url_join( '/locale', $locale->slug ), $wp_locale ) ?></li>
                 </ul>
                 <div class="contributors">
@@ -48 +48 @@
                 <div class="locale-button">
                     <div class="button contribute-button">
-                        <?php echo gp_link_get( gp_url_join( gp_url_current(), $locale->slug ), 'Contribute Translation' ) ?>
+                        <?php echo gp_link_get( gp_url_join( '/locale', $locale->slug ), 'Contribute Translation' ) ?>
                     </div>
                 </div>

sites/trunk/translate.wordpress.org/public_html/gp-templates/locale-project.php

@@ -3 +3 @@
 
 $breadcrumb   = array();
-$breadcrumb[] = gp_link_get( '/languages', __( 'Locales' ) );
-$breadcrumb[] = gp_link_get( gp_url_join( '/languages', $locale_slug, $set_slug), esc_html( $locale->english_name ) );
+$breadcrumb[] = gp_link_get( '/', __( 'Locales' ) );
+$breadcrumb[] = gp_link_get( gp_url_join( '/locale', $locale_slug, $set_slug), esc_html( $locale->english_name ) );
 $breadcrumb[] = $sub_project->name;
 gp_breadcrumb( $breadcrumb );
@@ -36 +36 @@
                                     '<option name="%s" data-project-url="%s"%s>%s</option>',
                                     $variant,
-                                    esc_url( gp_url_join( '/languages', $locale_slug, $variant, $sub_project->path ) ),
+                                    esc_url( gp_url_join( '/locale', $locale_slug, $variant, $sub_project->path ) ),
                                     ( $set_slug == $variant ) ? ' selected="selected"' : '',
                                     ucfirst( $variant )

sites/trunk/translate.wordpress.org/public_html/gp-templates/locale-projects.php

@@ -3 +3 @@
 
 $breadcrumb   = array();
-$breadcrumb[] = gp_link_get( '/languages', __( 'Locales' ) );
+$breadcrumb[] = gp_link_get( '/', __( 'Locales' ) );
 $breadcrumb[] = esc_html( $locale->english_name );
 gp_breadcrumb( $breadcrumb );
@@ -29 +29 @@
                                 '<option name="%s" data-project-url="%s"%s>%s</option>',
                                 $variant,
-                                esc_url( gp_url_join( '/languages', $locale_slug, $variant, $project->slug ) ),
+                                esc_url( gp_url_join( '/locale', $locale_slug, $variant, $project->slug ) ),
                                 ( $set_slug == $variant ) ? ' selected="selected"' : '',
                                 ucfirst( $variant )
@@ -59 +59 @@
             printf(
                 '<li><a href="%s"%s>%s</a></li>',
-                gp_url_join( '/languages', $locale_slug, $set_slug, $top_level_project->slug ),
+                gp_url_join( '/locale', $locale_slug, $set_slug, $top_level_project->slug ),
                 ( $top_level_project->path == $project_path ) ? ' class="current"' : '',
                 $top_level_project->name
@@ -83 +83 @@
         }
 
-        $project_url = gp_url_join( '/languages', $locale_slug, $set_slug, $sub_project->path );
+        $project_url = gp_url_join( '/locale', $locale_slug, $set_slug, $sub_project->path );
 
         $project_icon = '';