lib/editor/tiny/plugins/aiplacement/amd/src/mediaimage.js

  1. // This file is part of Moodle - http://moodle.org/
  2. //
  3. // Moodle is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU General Public License as published by
  5. // the Free Software Foundation, either version 3 of the License, or
  6. // (at your option) any later version.
  7. //
  8. // Moodle is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16. /**
  17.  * AI Modal for Tiny.
  18.  *
  19.  * @module      tiny_aiplacement/mediaimage
  20.  * @copyright   2024 Matt Porritt <matt.porritt@moodle.com>
  21.  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22.  */
  24. import {getString} from 'core/str';
  25. import MediaImage from 'tiny_media/image';
  26. import Notification from 'core/notification';
  27. import {prefetchStrings} from 'core/prefetch';
  29. prefetchStrings('core_ai', [
  30.     'contentwatermark',
  31. ]);
  33. export default class AiMediaImage extends MediaImage {
  34.     constructor(editor, url, alt) {
  35.         super(editor); // Call the parent class constructor
  36.         this.generatedImageUrl = url;
  37.         this.altText = alt;
  38.         getString('contentwatermark', 'core_ai').then((watermark) => {
  39.             this.watermark = watermark;
  40.             return;
  41.         }).catch(Notification.exception);
  42.     }
  44.     getSelectedImage() {
  45.         const imgElement = document.createElement('img');
  47.         // Set attributes for the img element
  48.         imgElement.src = this.generatedImageUrl;
  49.         imgElement.alt = this.truncateAltText(this.altText);
  51.         return imgElement;
  52.     }
  54.     /**
  55.      * Truncate the alt text if it is longer than the maximum length.
  56.      * @param {String} altText The alt text
  57.      * @return {string} The truncated alt text
  58.      */
  59.     truncateAltText(altText) {
  60.         const maximumAltTextLength = 125;
  61.         const watermark = ' - ' + this.watermark;
  62.         const ellipsis = '...';
  64.         // Append the watermark to the alt text.
  65.         if (altText.length + watermark.length <= maximumAltTextLength) {
  66.             altText = altText + watermark;
  67.         } else {
  68.             const remainingLength = maximumAltTextLength - watermark.length - ellipsis.length;
  69.             altText = altText.substring(0, remainingLength) + ellipsis + watermark;
  70.         }
  71.         return altText;
  72.     }
  73. }