Changeset 12873

Timestamp:

08/31/2023 10:50:11 AM (2 years ago)

Author:

amieiro

Message:

Translate: Add a link to the OpenAI and DeepL configuration

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions

Files:

• css/translation-suggestions.css (modified) (1 diff)
• inc/class-plugin.php (modified) (2 diffs)
• js/translation-suggestions.js (modified) (5 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/css/translation-suggestions.css

@@ -104 +104 @@
     background: #B5E1B9;
 }
+
+.translation-suggestion__footer_message__for_suggestions {
+    font-size: 12px;
+}

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/inc/class-plugin.php

@@ -173 +173 @@
         $query_tm = mb_strlen( $entry->singular ) <= 420;
 
+        // Used to add a link to add the OpenAI and the DeepL keys.
+        // We only show this link if the user has not added any of these keys yet.
+        $gp_default_sort = get_user_option( 'gp_default_sort' );
+        $openai_key      = trim( gp_array_get( $gp_default_sort, 'openai_api_key' ) );
+        $deepl_key       = trim( gp_array_get( $gp_default_sort, 'deepl_api_key' ) );
         ?>
         <details open class="suggestions__translation-memory<?php echo $query_tm ? '' : ' initialized'; ?>" data-nonce="<?php echo esc_attr( wp_create_nonce( 'translation-memory-suggestions-' . $entry->original_id ) ); ?>">
@@ -181 +186 @@
                 <p class="no-suggestions">No suggestions.</p>
             <?php endif; ?>
+
+            <?php if ( empty( $openai_key ) && empty( $deepl_key ) ) : ?>
+                <p class="translation-suggestion__footer_message__for_suggestions">Get translation suggestions from <a href="https://translate.wordpress.org/settings/" target="_blank">OpenAI</a>  and from <a href="https://translate.wordpress.org/settings/" target="_blank">DeepL</a>. <a href="https://make.wordpress.org/polyglots/2023/03/29/adding-chatgpt-and-deepl-in-the-translation-memory/" target="_blank">More info</a>.</p>
+            <?php endif; ?>
         </details>
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-translation-suggestions/js/translation-suggestions.js

@@ -28 +28 @@
     * Stores the external translations used.
     * @type {object}
-    */
+    */
    var externalSuggestion = {};
 
@@ -63 +63 @@
             $container.append( cachedSuggestion );
             removeNoSuggestionsMessage( $container );
+            moveFooterToTheBottom( $container );
             copyTranslationMemoryToSidebarTab( $container );
             return;
@@ -85 +86 @@
                 storeTheSuggestionInTheCache( type, originalId, response.data );
                 removeNoSuggestionsMessage( $container );
+                moveFooterToTheBottom( $container );
                 copyTranslationMemoryToSidebarTab( $container );
             } else {
@@ -196 +198 @@
     function copyTranslationMemoryToSidebarTab( $container ){
         var editor = $container.closest( '.editor' );
-        var divSidebarWithTM = editor.find( '.meta.translation-memory' ).first();
+        var divSidebarWithTM = editor.find( '.meta.translation-memory' ).first();
         var divId = divSidebarWithTM.attr( 'data-row-id' );
         var TMcontainer = editor.find( '.suggestions__translation-memory' );
@@ -358 +360 @@
             removeNoSuggestionsDuplicateMessage( $container );
         }
+    }
+
+    /**
+     * Moves the footer with the link to OpenAI and DeepL to the bottom of the container.
+     *
+     * This is needed because the suggestions are loaded asynchronously.
+     *
+     * @param {object} $container The container where the suggestions are stored.
+     *
+     * @return {void}
+     */
+    function moveFooterToTheBottom( $container ) {
+        var footer = $container.find( '.translation-suggestion__footer_message__for_suggestions' );
+        if ( ! footer ) {
+            return;
+        }
+        $container.append( footer );
     }