Changeset 2266

Timestamp:

01/10/2016 06:52:35 PM (9 years ago)

Author:

ocean90

Message:

Translate, Plugin Directory: Clear caches when a translation gets approved or rejected.

Use translation_created and translation_saved actions to catch all translation edits.

File:

• sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-plugins.php (modified) (9 diffs)

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

@@ -6 +6 @@
  */
 class GP_WPorg_Plugins extends GP_Plugin {
-    var $master_project   = 'wp-plugins';
-    var $i18n_cache_group = 'plugins-i18n';
+    public $master_project   = 'wp-plugins';
+    public $i18n_cache_group = 'plugins-i18n';
 
-    function __construct() {
+    public function __construct() {
         parent::__construct();
         $this->add_action( 'init' );
         $this->add_action( 'originals_imported' );
-        $this->add_action( 'post_tmpl_load' );
+
+        $this->add_action( 'translation_created' );
+        $this->add_action( 'translation_saved' );
     }
 
@@ -19 +21 @@
      * Making sure to register the global cache group wordpress.org/plugins/ uses for its display cache.
      */
-    function init() {
+    public function init() {
         wp_cache_add_global_groups( $this->i18n_cache_group );
     }
@@ -26 +28 @@
      * @param $project_id
      */
-    function originals_imported( $project_id ) {
+    public function originals_imported( $project_id ) {
         $project = GP::$project->get( $project_id );
         if ( empty( $project->path ) || !$this->project_is_plugin( $project->path ) ) {
             return;
         }
+
         $this->delete_plugin_i18n_cache_keys_for_project( $project_id );
     }
 
     /**
-     * @param $action
+     * Triggers a cache purge when a new translation was created.
+     *
+     * @param GP_Translation $translation Created translation.
      */
-    function post_tmpl_load( $action ) {
-        if ( !$this->project_is_plugin( $_SERVER["REQUEST_URI"] ) ) {
+    public function translation_created( $translation ) {
+        if ( ! $this->project_is_plugin( $_SERVER['REQUEST_URI'] ) ) {
             return;
         }
-        switch( $action ) {
-            case 'translation-row':
-                if ( ! empty( $_POST['translation'] ) ) {
-                    $this->delete_plugin_i18n_cache_on_translation_edit();
-                }
-                break;
+
+        $this->delete_plugin_i18n_cache_on_translation_edit( $translation );
+    }
+
+    /**
+     * Triggers a cache purge when a translation was updated.
+     *
+     * @param GP_Translation $translation Updated translation.
+     */
+    public function translation_saved( $translation ) {
+        if ( ! $this->project_is_plugin( $_SERVER['REQUEST_URI'] ) ) {
+            return;
         }
+
+        $this->delete_plugin_i18n_cache_on_translation_edit( $translation );
     }
 
@@ -55 +68 @@
      * @return bool
      */
-    function project_is_plugin( $path ) {
+    private function project_is_plugin( $path ) {
         if ( empty( $path ) ) {
             return false;
         }
+
         $path = '/' . trim( $path, '/' ) . '/';
         if ( false === strpos( $path, "/{$this->master_project}/" ) ) {
             return false;
         }
+
         return true;
     }
@@ -71 +86 @@
      * @return string
      */
-    function get_plugin_i18n_cache_prefix( $project_id ) {
+    private function get_plugin_i18n_cache_prefix( $project_id ) {
         $project = GP::$project->get( $project_id );
         if ( empty( $project->path ) || !$this->project_is_plugin( $project->path ) ) {
             return '';
         }
+
         $project_dirs = explode( '/', trim( $project->path, '/' ) );
         if ( empty( $project_dirs ) || 3 !== count( $project_dirs ) || $project_dirs[0] !== $this->master_project ) {
             return '';
         }
+
         return "{$this->master_project}:{$project_dirs[1]}:{$project_dirs[2]}";
     }
@@ -89 +106 @@
      * @param $set string Set, such as 'original', 'fr', 'de'.
      */
-    function delete_plugin_i18n_cache_keys_for( $prefix, $set ) {
+    private function delete_plugin_i18n_cache_keys_for( $prefix, $set ) {
         $suffixes = array(
             'translation_set_id', 'title', 'short_description', 'installation', 'description',
@@ -96 +113 @@
         foreach ( $suffixes as $suffix ) {
             $cache_key = "{$prefix}:{$set}:{$suffix}";
-            // error_log( serialize( array( $cache_key, $this->i18n_cache_group ) ) );
             wp_cache_delete( $cache_key, $this->i18n_cache_group );
-        }
-        // Deal with fr also existing as fr_FR, etc.
-        if ( 2 === strlen( $set ) ) {
-            $this->delete_plugin_i18n_cache_keys_for( $prefix, strtolower( $set ) . '_' . strtoupper( $set ) );
         }
     }
@@ -108 +120 @@
      * @param $project_id int
      */
-    function delete_plugin_i18n_cache_keys_for_project( $project_id ) {
+    private function delete_plugin_i18n_cache_keys_for_project( $project_id ) {
         $prefix = $this->get_plugin_i18n_cache_prefix( (int) $project_id );
-        if ( empty( $prefix ) ) {
+        if ( ! $prefix ) {
             return;
         }
+
         wp_cache_delete( "{$prefix}:originals", $this->i18n_cache_group );
         wp_cache_delete( "{$prefix}:branch_id", $this->i18n_cache_group );
         $this->delete_plugin_i18n_cache_keys_for( $prefix, 'original' );
+
         $translation_sets = (array) GP::$translation_set->by_project_id( $project_id );
         foreach ( $translation_sets as $translation_set ) {
@@ -126 +140 @@
      * @param $locale string
      */
-    function delete_plugin_i18n_cache_keys_for_locale( $project_id, $locale ) {
+    private function delete_plugin_i18n_cache_keys_for_locale( $project_id, $locale ) {
         $prefix = $this->get_plugin_i18n_cache_prefix( (int) $project_id );
-        if ( empty( $prefix ) ) {
+        if ( ! $prefix ) {
             return;
         }
+
         $this->delete_plugin_i18n_cache_keys_for( $prefix, $locale );
     }
 
-    function delete_plugin_i18n_cache_on_translation_edit() {
-        if ( empty( $_POST['translation'] ) ) {
+    /**
+     * Deletes the cache on a translation edit.
+     *
+     * @param GP_Translation $translation The edited translation.
+     */
+    private function delete_plugin_i18n_cache_on_translation_edit( $translation ) {
+        $original = GP::$original->get( $translation->original_id );
+        if ( ! $original ) {
             return;
         }
-        $tmp = array_keys( (array) $_POST['translation'] );
-        if ( empty( $tmp[0] ) || !is_numeric( $tmp[0] ) ) {
+
+        $translation_set = GP::$translation_set->get( $translation->translation_set_id );
+        if ( ! $translation_set ) {
             return;
         }
-        $original = GP::$original->get( (int) $tmp[0] );
-        if ( empty( $original ) ) {
-            return;
-        }
-        $tmp = explode( '/', $_SERVER[ 'REQUEST_URI' ] );
-        if ( empty( $tmp ) || count( $tmp ) < 2 ) {
-            return;
-        }
-        $this->delete_plugin_i18n_cache_keys_for_locale( $original->project_id, gp_sanitize_meta_key( $tmp[ count( $tmp ) - 2 ] ) );
+
+        $this->delete_plugin_i18n_cache_keys_for_locale( $original->project_id, $translation_set->locale );
     }
 }