<!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>[12196] sites/trunk/api.wordpress.org/public_html/translations/lib.php: Translations API Library: Document what/where various functions are used and general code cleanup.</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 { white-space: pre-line; 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/12196">12196</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/12196","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-11-04 05:06:47 +0000 (Fri, 04 Nov 2022)</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'>Translations API Library: Document what/where various functions are used and general code cleanup.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmltranslationslibphp">sites/trunk/api.wordpress.org/public_html/translations/lib.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmltranslationslibphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/translations/lib.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/translations/lib.php 2022-11-04 04:27:18 UTC (rev 12195)
+++ sites/trunk/api.wordpress.org/public_html/translations/lib.php 2022-11-04 05:06:47 UTC (rev 12196)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,17 +1,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</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 version_compare_version_key_desc( $a, $b ) {
- return version_compare( $b['version'], $a['version'] );
-}
-
-function version_compare_version_prop_desc( $a, $b ) {
- return version_compare( $b->version, $a->version );
-}
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Used by api.wordpress.org/translations/core/1.0/
</ins><span class="cx" style="display: block; padding: 0 10px"> function find_all_translations_for_core( $version = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return find_all_translations_for_type_and_domain( 'core', 'default', $version );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Used by api.wordpress.org/translations/plugins/1.0/, api.wordpress.org/translations/themes/1.0/, and wordpress.org/plugins/wp-json/plugins/v1/plugin/$slug
</ins><span class="cx" style="display: block; padding: 0 10px"> function find_all_translations_for_type_and_domain( $type, $domain = 'default', $version = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,8 +22,8 @@
</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"> $cache_group = 'translations-query';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cache_time = 900; // 15 min
- $cache_key = "$type:$domain:$version";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cache_time = 900; // 15 minutes
+ $cache_key = "$type:$domain:$version";
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $translations = wp_cache_get( $cache_key, $cache_group );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( '_empty_' === $translations ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,11 +34,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $type, $domain ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $translations ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_add( $cache_key, '_empty_', $cache_group, $cache_time );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_cache_add( $cache_key, '_empty_', $cache_group, $cache_time * 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> return array();
</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">- usort( $translations, 'version_compare_version_prop_desc' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ usort( $translations, function( $a, $b ) {
+ return version_compare( $b->version, $a->version );
+ } );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $_translations = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $translations as $translation ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -134,12 +130,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $translations;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Used by check_for_translations_paired_with_update(), and check_for_translations_of_installed_items()
+// Used by api.wordpress.org/plugins/update-check/, api.wordpress.org/themes/update-check, and api.wordpress.org/core/version-check/.
</ins><span class="cx" style="display: block; padding: 0 10px"> function find_latest_translations( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px"> extract( $args, EXTR_SKIP );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $translations_cache_group = 'update-check-translations';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $translations_cache_time = 900; // 15 minutes
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $translations_cache_time = 900; // 15 minutes
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $return = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $languages as $language ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,11 +154,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_key = "{$type}:{$language}:{$domain}";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $results = wp_cache_get( $cache_key, $translations_cache_group );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- // No language packs were found
- if ( '_empty_' == $results )
- continue;
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! $results ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $query = $wpdb->prepare(
</span><span class="cx" style="display: block; padding: 0 10px"> "SELECT `version`, `updated`
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,13 +168,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $results = $wpdb->get_results( $query, ARRAY_A );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $results ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- usort( $results, 'version_compare_version_key_desc' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ usort( $results, function( $a, $b ) {
+ return version_compare( $b['version'], $a['version'] );
+ } );
</ins><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">- wp_cache_set( $cache_key, ( $results ? $results : '_empty_' ), $translations_cache_group, $translations_cache_time );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $results ) {
+ wp_cache_set( $cache_key, $results, $translations_cache_group, $translations_cache_time );
+ } else {
+ $results = '_empty_';
+ wp_cache_set( $cache_key, $results, $translations_cache_group, $translations_cache_time * 2 );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $results )
- continue;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No language packs were found
+ if ( '_empty_' == $results ) {
+ continue;
</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"> if ( $version ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -221,9 +223,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Used by api.wordpress.org/plugins/update-check/ (disabled)
</ins><span class="cx" style="display: block; padding: 0 10px"> function check_for_translations_paired_with_update( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> extract( $args );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $translations_for_update = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $translations_for_update = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> $translations_found_for_update = find_latest_translations( array( 'type' => $type, 'domain' => $domain, 'version' => $version, 'languages' => $languages ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $translations_found_for_update as $language_pack ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,11 +240,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Example: version 3.7 is ready to go, but someone releases an update for 3.6.1.
</span><span class="cx" style="display: block; padding: 0 10px"> // The 3.6.1 strings are "newer" than the 3.7 strings, but the 3.7 language pack is
</span><span class="cx" style="display: block; padding: 0 10px"> // the new minimum, so it needs to be served.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $wporg_updated <= $site_updated && version_compare( $current_version, $language_pack['version'], '>=' ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wporg_updated <= $site_updated && version_compare( $current_version, $language_pack['version'], '>=' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $update = false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $update )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( ! $update ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $translations_for_update[] = $language_pack;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,6 +254,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $translations_for_update;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Used by api.wordpress.org/plugins/update-check/, api.wordpress.org/themes/update-check, and api.wordpress.org/core/version-check/.
</ins><span class="cx" style="display: block; padding: 0 10px"> function check_for_translations_of_installed_items( $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> extract( $args );
</span><span class="cx" style="display: block; padding: 0 10px"> $translations_for_current = find_latest_translations( array( 'type' => $type, 'domain' => $domain, 'version' => $version, 'languages' => $languages ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -259,11 +266,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wporg_updated = strtotime( $language_pack['updated'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $site_updated = strtotime( $language_data[ $language_pack['language'] ]['PO-Revision-Date'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $wporg_updated <= $site_updated )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wporg_updated <= $site_updated ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $update = false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $update )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( ! $update ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $translations[] = $language_pack;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>