<!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>[12584] sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/js/translation-suggestions.js: Copy the TM to the tab in the right sidebar</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/12584">12584</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/12584","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>amieiro</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-05-12 08:05:57 +0000 (Fri, 12 May 2023)</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'>Copy the TM to the tab in the right sidebar
- Copy the TM to the tab in the right sidebar.
- Avoid making same request to the OpenAI and DeepL APIs
a few times in the same translation.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggptranslationsuggestionsjstranslationsuggestionsjs">sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/js/translation-suggestions.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginswporggptranslationsuggestionsjstranslationsuggestionsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/js/translation-suggestions.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/js/translation-suggestions.js 2023-05-12 08:05:07 UTC (rev 12583)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/js/translation-suggestions.js 2023-05-12 08:05:57 UTC (rev 12584)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,4 +1,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ( function( $ ){
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Stores the originalId of the translations for which OpenAI has already been queried,
+ * to avoid making the query another time.
+ *
+ * @type {array}
+ */
+ var OpenAITMSuggestionRequested = [];
+
+ /**
+ * Stores the originalId of the translations for which DeepL has already been queried,
+ * to avoid making the query another time.
+ *
+ * @type {array}
+ */
+ var DeeplTMSuggestionRequested = [];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function fetchSuggestions( $container, apiUrl, originalId, translationId, nonce ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var xhr = $.ajax( {
</span><span class="cx" style="display: block; padding: 0 10px"> url: apiUrl,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,6 +31,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $container.find( '.suggestions__loading-indicator' ).remove();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( response.success ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $container.append( response.data );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ removeNoSuggestionsMessage( $container );
+ copyTranslationMemoryToSidebarTab();
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $container.append( $( '<span/>', { 'text': 'Error while loading suggestions.' } ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,11 +47,33 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> xhr.always( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $container.removeClass( 'fetching' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- removeNoSuggestionsMessage( $container );
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Copies the translation memory to the sidebar tab and adds the number of items in the TM to the tab.
+ *
+ * @return {void}
+ */
+ function copyTranslationMemoryToSidebarTab(){
+ var divSidebarWithTM = $gp.editor.current.find( '.meta.translation-memory' ).first();
+ var divId = divSidebarWithTM.attr( 'data-row-id' );
+ var TMcontainer = $gp.editor.current.find( '.suggestions__translation-memory' );
+ if ( !TMcontainer.length ) {
+ return;
+ }
+ if ( !TMcontainer.hasClass( 'initialized' ) ) {
+ return;
+ }
+
+ var itemsInTM = TMcontainer.find( '.translation-suggestion.with-tooltip.translation' ).length;
+ itemsInTM += TMcontainer.find( '.translation-suggestion.with-tooltip.deepl' ).length;
+ itemsInTM += TMcontainer.find( '.translation-suggestion.with-tooltip.openai' ).length;
+ $( '[data-tab="sidebar-tab-translation-memory-' + divId + '"]' ).html( 'TM (' + itemsInTM + ')' );
+ $( '#sidebar-div-translation-memory-' + divId ).html( TMcontainer.html() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Add the suggestion from the translation memory to the translation textarea if
</span><span class="cx" style="display: block; padding: 0 10px"> * the suggestion has 100% of accuracy.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -70,6 +110,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 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">+ if ( !$gp.editor.current.find('translation-suggestion.with-tooltip.translation').first() ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $container.addClass( 'fetching' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> var originalId = $gp.editor.current.original_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,7 +129,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return {void}
</span><span class="cx" style="display: block; padding: 0 10px"> **/
</span><span class="cx" style="display: block; padding: 0 10px"> function maybeFetchOpenAISuggestions() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- maybeFetchExternalSuggestions( gpTranslationSuggestions.get_external_translations.get_openai_translations, window.WPORG_TRANSLATION_MEMORY_OPENAI_API_URL );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ maybeFetchExternalSuggestions( 'OpenAI', gpTranslationSuggestions.get_external_translations.get_openai_translations, window.WPORG_TRANSLATION_MEMORY_OPENAI_API_URL );
</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">@@ -94,16 +138,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return {void}
</span><span class="cx" style="display: block; padding: 0 10px"> **/
</span><span class="cx" style="display: block; padding: 0 10px"> function maybeFetchDeeplSuggestions() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- maybeFetchExternalSuggestions( gpTranslationSuggestions.get_external_translations.get_deepl_translations, window.WPORG_TRANSLATION_MEMORY_DEEPL_API_URL );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ maybeFetchExternalSuggestions( 'DeepL', gpTranslationSuggestions.get_external_translations.get_deepl_translations, window.WPORG_TRANSLATION_MEMORY_DEEPL_API_URL );
</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"> * Gets the suggestions from an external service.
</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 getExternalSuggestions
- * @param apiUrl
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param type The type of the external service: OpenAI or DeepL.
+ * @param getExternalSuggestions Whether to get the suggestions from the external service.
+ * @param apiUrl The URL of the API.
+ *
+ * @return {void}
</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 maybeFetchExternalSuggestions( getExternalSuggestions, apiUrl ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function maybeFetchExternalSuggestions( type, getExternalSuggestions, apiUrl ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> var $container = $gp.editor.current.find( '.suggestions__translation-memory' );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !$container.length ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -111,14 +158,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( true !== getExternalSuggestions ) {
</span><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">-
</del><span class="cx" style="display: block; padding: 0 10px"> var originalId = $gp.editor.current.original_id;
</span><span class="cx" style="display: block; padding: 0 10px"> var translationId = $gp.editor.current.translation_id;
</span><span class="cx" style="display: block; padding: 0 10px"> var nonce = $container.data( 'nonce' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if( true === wasRequestMade( type, originalId ) ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> fetchSuggestions( $container, apiUrl, originalId, translationId, nonce );
</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">+ /**
+ * Checks if the request was already made for this originalId and type.
+ *
+ * @param type The type of the external service: OpenAI or DeepL.
+ * @param originalId The original ID.
+ *
+ * @returns {boolean} Whether the request was already made.
+ */
+ function wasRequestMade( type, originalId ) {
+ if ('OpenAI' === type) {
+ if ( originalId in OpenAITMSuggestionRequested ) {
+ return true;
+ } else {
+ OpenAITMSuggestionRequested[originalId] = true;
+ }
+ }
+ if ('DeepL' === type) {
+ if ( originalId in DeeplTMSuggestionRequested ) {
+ return true;
+ } else {
+ DeeplTMSuggestionRequested[originalId] = true;
+ }
+ }
+ return false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function maybeFetchOtherLanguageSuggestions() {
</span><span class="cx" style="display: block; padding: 0 10px"> var $container = $gp.editor.current.find( '.suggestions__other-languages' );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $container.length ) {
</span></span></pre>
</div>
</div>
</body>
</html>