<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[2266] sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-plugins.php: Translate, Plugin Directory: Clear caches when a translation gets approved or rejected.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/2266">2266</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/2266","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-01-10 18:52:35 +0000 (Sun, 10 Jan 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Translate, Plugin Directory: Clear caches when a translation gets approved or rejected.
Use `translation_created` and `translation_saved` actions to catch all translation edits.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunktranslatewordpressorgincludesgppluginswporgpluginsphp">sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-plugins.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunktranslatewordpressorgincludesgppluginswporgpluginsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-plugins.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-plugins.php 2016-01-10 00:24:19 UTC (rev 2265)
+++ sites/trunk/translate.wordpress.org/includes/gp-plugins/wporg-plugins.php 2016-01-10 18:52:35 UTC (rev 2266)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5,48 +5,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @author stephdau
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class GP_WPorg_Plugins extends GP_Plugin {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var $master_project = 'wp-plugins';
- var $i18n_cache_group = 'plugins-i18n';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $master_project = 'wp-plugins';
+ public $i18n_cache_group = 'plugins-i18n';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function __construct() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function __construct() {
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::__construct();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->add_action( 'init' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->add_action( 'originals_imported' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->add_action( 'post_tmpl_load' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->add_action( 'translation_created' );
+ $this->add_action( 'translation_saved' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Making sure to register the global cache group wordpress.org/plugins/ uses for its display cache.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function init() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function init() {
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_cache_add_global_groups( $this->i18n_cache_group );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $project_id
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function originals_imported( $project_id ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function originals_imported( $project_id ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $project = GP::$project->get( $project_id );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $project->path ) || !$this->project_is_plugin( $project->path ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->delete_plugin_i18n_cache_keys_for_project( $project_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param $action
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Triggers a cache purge when a new translation was created.
+ *
+ * @param GP_Translation $translation Created translation.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function post_tmpl_load( $action ) {
- if ( !$this->project_is_plugin( $_SERVER["REQUEST_URI"] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function translation_created( $translation ) {
+ if ( ! $this->project_is_plugin( $_SERVER['REQUEST_URI'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch( $action ) {
- case 'translation-row':
- if ( ! empty( $_POST['translation'] ) ) {
- $this->delete_plugin_i18n_cache_on_translation_edit();
- }
- break;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $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;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->delete_plugin_i18n_cache_on_translation_edit( $translation );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,14 +67,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function project_is_plugin( $path ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private function project_is_plugin( $path ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $path ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $path = '/' . trim( $path, '/' ) . '/';
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === strpos( $path, "/{$this->master_project}/" ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -70,15 +85,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function get_plugin_i18n_cache_prefix( $project_id ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private function get_plugin_i18n_cache_prefix( $project_id ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $project = GP::$project->get( $project_id );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $project->path ) || !$this->project_is_plugin( $project->path ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $project_dirs = explode( '/', trim( $project->path, '/' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $project_dirs ) || 3 !== count( $project_dirs ) || $project_dirs[0] !== $this->master_project ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return "{$this->master_project}:{$project_dirs[1]}:{$project_dirs[2]}";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -88,33 +105,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $prefix string Cache key prefix, such as 'plugin:livejournal-importer:readme-stable'
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $set string Set, such as 'original', 'fr', 'de'.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function delete_plugin_i18n_cache_keys_for( $prefix, $set ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private function delete_plugin_i18n_cache_keys_for( $prefix, $set ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $suffixes = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'translation_set_id', 'title', 'short_description', 'installation', 'description',
</span><span class="cx" style="display: block; padding: 0 10px"> 'faq', 'screenshots', 'changelog', 'other_notes',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $suffixes as $suffix ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_key = "{$prefix}:{$set}:{$suffix}";
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // error_log( serialize( array( $cache_key, $this->i18n_cache_group ) ) );
</del><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( $cache_key, $this->i18n_cache_group );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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 ) );
- }
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $project_id int
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function delete_plugin_i18n_cache_keys_for_project( $project_id ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private function delete_plugin_i18n_cache_keys_for_project( $project_id ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $prefix = $this->get_plugin_i18n_cache_prefix( (int) $project_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $prefix ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $prefix ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( "{$prefix}:originals", $this->i18n_cache_group );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( "{$prefix}:branch_id", $this->i18n_cache_group );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->delete_plugin_i18n_cache_keys_for( $prefix, 'original' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $translation_sets = (array) GP::$translation_set->by_project_id( $project_id );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $translation_sets as $translation_set ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->delete_plugin_i18n_cache_keys_for( $prefix, $translation_set->locale );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,31 +139,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $project_id int
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $locale string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function delete_plugin_i18n_cache_keys_for_locale( $project_id, $locale ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private function delete_plugin_i18n_cache_keys_for_locale( $project_id, $locale ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $prefix = $this->get_plugin_i18n_cache_prefix( (int) $project_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $prefix ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $prefix ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->delete_plugin_i18n_cache_keys_for( $prefix, $locale );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function delete_plugin_i18n_cache_on_translation_edit() {
- if ( empty( $_POST['translation'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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 ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $tmp = array_keys( (array) $_POST['translation'] );
- if ( empty( $tmp[0] ) || !is_numeric( $tmp[0] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $translation_set = GP::$translation_set->get( $translation->translation_set_id );
+ if ( ! $translation_set ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $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 ] ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->delete_plugin_i18n_cache_keys_for_locale( $original->project_id, $translation_set->locale );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> GP::$plugins->wporg_plugins = new GP_WPorg_Plugins;
</span></span></pre>
</div>
</div>
</body>
</html>