Release 1.2.8

Author: konstantin-convergine

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.2.8 - 2025-06-12
+### Added
+- Support for DeepL glossaries.
+- Option to exclude entries from bulk translations.
+
 ## 1.2.7 - 2025-06-10
 ### Added
 - Added support for translating [Craft Commerce](https://craftcms.com/commerce) products, including product variant fields. [Issue #40](https://github.com/convergine/craft-content-buddy/issues/40)

composer.json

@@ -2,7 +2,7 @@
     "name": "convergine/craft-content-buddy",
     "description": "Content Buddy is an AI-driven CraftCMS plugin that leverages the ChatGPT API to automatically generate and manage multi-language content, including text and images, with customizable settings and features for precise control and enhanced content creation.",
     "type": "craft-plugin",
-    "version": "1.2.7",
+    "version": "1.2.8",
     "keywords": [
         "craftcms",
         "content-buddy",

src/BuddyPlugin.php

@@ -10,11 +10,13 @@
 use convergine\contentbuddy\services\Request;
 use convergine\contentbuddy\services\Translate;
 use convergine\contentbuddy\variables\BuddyVariable;
+use craft\events\ModelEvent;
 use Craft;
 use craft\base\Element;
 use craft\base\Field;
 use craft\base\Plugin;
 use craft\controllers\ElementsController;
+use craft\elements\Entry;
 use craft\events\DefineElementEditorHtmlEvent;
 use craft\events\DefineFieldHtmlEvent;
 use craft\events\DefineHtmlEvent;
@@ -39,7 +41,7 @@
 class BuddyPlugin extends Plugin {
 	public static string $plugin;
 	public ?string $name = 'Content Buddy';
-    public string $schemaVersion = '1.2.7';
+    public string $schemaVersion = '1.2.8';
 
     public function init() {
         /* plugin initialization */
@@ -90,6 +92,8 @@ function (RegisterUrlRulesEvent $event) {
 
 				$event->rules['convergine-contentbuddy/site-translate'] = 'convergine-contentbuddy/translate/index';
 				$event->rules['convergine-contentbuddy/site-translate/log'] = 'convergine-contentbuddy/translate/log';
+
+                $event->rules['convergine-contentbuddy/deepl/glossaries'] = 'convergine-contentbuddy/deep-l/glossaries';
 			}
 		);
 	}
@@ -226,6 +230,34 @@ function (DefineHtmlEvent $event) {
 
 			} );
 		}
+
+		Event::on(
+			Entry::class,
+			Entry::EVENT_DEFINE_SIDEBAR_HTML,
+			static function(DefineHtmlEvent $event) {
+				/** @var craft\models\Site $isDefaultSite */
+				$isDefaultSite = $event->sender->getSite()->primary;
+
+				$html = Craft::$app->view->renderTemplate('convergine-contentbuddy/_sidebars/entry-preview.twig',[
+					'element' => $event->sender,
+					'isDefaultSite' => $isDefaultSite,
+					'excludedSites' => BuddyPlugin::getInstance()->translate->getExcludedEntries($event->sender->id)
+				]);
+
+				$event->html .= $html;
+			}
+		);
+
+		Event::on(
+			Entry::class,
+			Entry::EVENT_AFTER_PROPAGATE,
+			function (ModelEvent $event) {
+					if($event->sender->id) {
+						$this->translate->saveExcludeBulkSites( $event->sender );
+					}
+			}
+		);
+
 	}
 
 	protected function createSettingsModel(): SettingsModel {

src/api/TextApi.php

@@ -14,7 +14,7 @@ public function __construct() {
         $this->settings = $settings;
     }
 
-    function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = false, $instructions = '', $lang = '') {}
+    function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = false, $instructions = '', $lang = '', $source_lang = '') {}
 
     protected function getMaxTokensForModel($model): int {
         return match($model) {

src/api/text/DeepL.php

@@ -10,15 +10,23 @@
 use yii\helpers\StringHelper;
 
 class DeepL extends TextApi {
-    public function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = false, $instructions = '', $lang = ''): string {
+    public function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = false, $instructions = '', $lang = '', $source_lang = ''): string {
 		try {
 			$translateData = $this->_getTranslatedData($prompt,$lang);
-			$client = new Client();
-			$sendData = [
-				'text'       => [$translateData['text']],
-				"tag_handling"=>"html",
-				"target_lang" => $translateData['lang'],
-			];
+
+            $sendData = [
+                'text'       => [$translateData['text']],
+                "tag_handling"=>"html",
+                "target_lang" => $translateData['lang'],
+            ];
+
+            if(!empty($this->settings->deepLGlossaryId) && $source_lang !== 'skip') {
+                $source_lang = explode("-",$source_lang)[0];
+                $sendData['source_lang'] = $source_lang ?: 'EN';
+                $sendData['glossary_id'] = $this->settings->deepLGlossaryId;
+            }
+
+            $client = new Client();
 
 			Craft::info( "Translate with DeepL" , 'content-buddy' );
 			Craft::info(  StringHelper::truncateWords($prompt,20,'...',true), 'content-buddy' );
@@ -43,6 +51,12 @@ public function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = fa
 				$message = $json['message'];
 				Craft::info( 'DeepL ERROR', 'content-buddy' );
 				Craft::info( $message, 'content-buddy' );
+
+                // if glossary dictionary is not found, we can try again without it
+                if(str_contains($message, 'No dictionary found for language pair')) {
+                    return $this->sendRequest($prompt, $maxTokens, $temperature, $isTranslate, $instructions, $lang, 'skip');
+                }
+
 				throw new Exception( $message );
 			}
 		} catch ( Throwable $e ) {
@@ -78,4 +92,34 @@ private function _getTranslatedData($prompt,$lang ):array {
 		$text = $promptParts[1];
 		return compact('lang','text');
 	}
-}
+
+    public function getGlossaries() : array {
+        $client = new Client();
+        $res = $client->request('GET', 'https://api.deepl.com/v3/glossaries', [
+            'headers' => [
+                'Authorization' => 'DeepL-Auth-Key '.$this->settings->getDeepLApiKey(),
+                'Content-Type'  => 'application/json'
+            ],
+            'http_errors'=>false
+        ]);
+        $body = $res->getBody();
+        $json = json_decode($body, true);
+        if ($res->getStatusCode() == 403) {
+            Craft::info('DeepL ERROR', 'content-buddy');
+            throw new Exception('DeepL API key is invalid');
+        } elseif (isset($json['message'])) {
+            $message = $json['message'];
+            Craft::info('DeepL ERROR', 'content-buddy');
+            Craft::info($message, 'content-buddy');
+            throw new Exception($message);
+        }
+        $glossaries = [];
+        foreach ($json['glossaries'] as $glossary) {
+            $glossaries[] = [
+                'id' => $glossary['glossary_id'],
+                'name' => $glossary['name'],
+            ];
+        }
+        return $glossaries;
+    }
+}

src/api/text/OpenAi.php

@@ -10,7 +10,7 @@
 use yii\helpers\StringHelper;
 
 class OpenAi extends TextApi {
-    public function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = false, $instructions = '', $lang = ''): string {
+    public function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = false, $instructions = '', $lang = '', $source_lang = ''): string {
         try {
 
             $model = $isTranslate?$this->settings->preferredTranslationModel:$this->settings->preferredModel;

src/api/text/XAi.php

@@ -9,7 +9,7 @@
 use yii\helpers\StringHelper;
 
 class XAi extends TextApi {
-    public function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = false, $instructions = '', $lang = ''): string {
+    public function sendRequest($prompt, $maxTokens, $temperature, $isTranslate = false, $instructions = '', $lang = '', $source_lang = ''): string {
         try {
             $model = $this->settings->xAiModel;
 

src/assets/dist/contentbuddy.js

@@ -0,0 +1,21 @@
+<?php
+namespace convergine\contentbuddy\controllers;
+
+use convergine\contentbuddy\api\text\DeepL;
+use convergine\contentbuddy\BuddyPlugin;
+use convergine\contentbuddy\models\SettingsModel;
+use Craft;
+use craft\web\Controller;
+
+class DeepLController extends Controller {
+	public function actionGlossaries() {
+        //$this->requirePostRequest();
+        try {
+            $deepl = new DeepL();
+            $glossaries = $deepl->getGlossaries();
+            return $this->asJson(['success' => true, 'glossaries' => $glossaries]);
+        } catch (\Exception $e) {
+            return $this->asJson(['success' => false, 'error' => $e->getMessage()]);
+        }
+	}
+}