from __future__ import annotations from collections.abc import Iterable from django.conf import settings from django.core.serializers.json import DjangoJSONEncoder from django.utils.encoding import force_str from django.utils.functional import Promise from django.utils.translation import gettext_lazy as _ class LazyEncoder(DjangoJSONEncoder): """ Class LazyEncoder Django JSON encoder that handles lazy translated strings. Inherits from DjangoJSONEncoder. Methods: - default: Overrides the default method in DjangoJSONEncoder to handle lazy translated strings. """ def default(self, obj): if isinstance(obj, Promise): return force_str(obj) return super().default(obj) _EDITOR_TOOLBAR_BASE_CONFIG = { "Undo": { "title": _("Undo"), "icon": '', }, "Redo": { "title": _("Redo"), "icon": '', }, "Bold": { "title": _("Bold"), "icon": '\n' + ' \n' + "", }, "Italic": { "title": _("Italic"), "icon": '\n' + ' \n' + "", }, "Underline": { "title": _("Underline"), "icon": '\n' + ' \n' + "", }, "Strike": { "title": _("Strike"), "icon": '', }, "Subscript": { "title": _("Subscript"), "icon": '\n' + ' \n' + "", }, "Superscript": { "title": _("Superscript"), "icon": '\n' + ' \n' + "", }, "TextColor": { "title": _("Text color"), }, "InlineQuote": { "title": _("Inline quote"), }, "Highlight": { "title": _("Mark"), }, "RemoveFormat": { "title": _("Remove formatting"), "icon": '' '', }, "JustifyLeft": { "title": _("Align left"), "icon": '\n' + ' \n' + "", }, "JustifyCenter": { "title": _("Align center"), "icon": '\n' + ' \n' + "", }, "JustifyRight": { "title": _("Align right"), "icon": '\n' + ' \n' + "", }, "JustifyBlock": { "title": _("Justify"), "icon": '\n' + ' \n' + "", }, "HorizontalRule": { "title": _("Horizontal rule"), "icon": '\n' + ' \n' + "", }, "NumberedList": { "title": _("Numbered list"), "icon": '\n' + ' \n' + ' \n' + "", }, "BulletedList": { "title": _("Bullet list"), "icon": '\n' + ' \n' + "", }, "Outdent": { "title": _("Outdent"), "icon": '\n' + ' \n' + ' \n' + "", }, "Indent": { "title": _("Indent"), "icon": '\n' + ' \n' + ' \n' + "", }, "Blockquote": { "title": _("Blockquote"), "icon": '\n' + ' \n' + "", }, "Link": { "title": _("Link"), "form": [ { "name": "href_select", "type": "hidden", "required": False, }, { "name": "href", "label": _("Type URL or search for a destination"), "placeholder": _("URL or search"), "type": "text", "class": "js-linkfield", "required": False, }, { "type": "section", "label": _("Link options"), "content": [ { "name": "target", "label": _("Target"), "type": "select", "options": [ {"value": "", "label": "-----"}, {"value": "_blank", "label": _("New window")}, {"value": "_self", "label": _("Same window")}, {"value": "_parent", "label": _("Parent window")}, ], "required": False, } ], }, ], "icon": '\n' + ' \n' + ' \n' + "", }, "Unlink": { "title": _("Unlink"), "icon": '' + ' \n' + ' ' + "", }, "Table": { "title": _("Table"), "icon": '', }, "toggleHeaderRow": { "title": _("Header row"), "icon": '', }, "toggleHeaderColumn": { "title": _("Header column"), "icon": '', }, "addRowBefore": { "title": _("Add row before"), "icon": '', }, "addRowAfter": { "title": _("Add row after"), "icon": '', }, "addColumnBefore": { "title": _("Add column before"), "icon": '', }, "addColumnAfter": { "title": _("Add column after"), "icon": '', }, "deleteRow": { "title": _("Delete row"), "icon": '', }, "deleteColumn": { "title": _("Delete column"), "icon": '', }, "deleteTable": { "title": _("Delete table"), }, "mergeOrSplit": { "title": _("Merge/split cells"), "icon": '', }, "tableClass": {}, "Code": { "title": _("Code"), "icon": '\n' + ' \n' + "", }, "Small": { "title": _("Small"), }, "Kbd": { "title": _("Keyboard input"), "icon": '\n' + ' \n' + "", }, "CodeBlock": { "title": _("Code block"), "icon": '\n' + ' \n' + ' \n' + "", }, "Heading1": { "title": _("Heading 1"), "icon": '\n' + ' \n' + "", }, "Heading2": { "title": _("Heading 2"), "icon": '\n' + ' \n' + "", }, "Heading3": { "title": _("Heading 3"), "icon": '\n' + ' \n' + "", }, "Heading4": { "title": _("Heading 4"), "icon": '\n' + ' \n' + "", }, "Heading5": { "title": _("Heading 5"), "icon": '\n' + ' \n' + "", }, "Heading6": { "title": _("Heading 6"), "icon": '\n' + ' \n' + "", }, "Paragraph": { "title": _("Paragraph"), "icon": '\n' + ' \n' + "", }, "Anchor": { "title": _("Anchor"), }, "Format": { "title": _("Format"), }, "Styles": { "title": _("Styles"), }, "InlineStyles": { "title": _("Styles"), }, "BlockStyles": { "title": _("Blocks"), }, "Font": { "title": _("Font"), }, "FontSize": { "title": _("Font size"), }, "CMSPlugins": { "title": _("CMS Plugins"), "aria": _("CMS Plugins"), "editLabel": _("Edit CMS Plugin"), "addLabel": _("Add CMS Plugin"), "icon": '', }, } DEFAULT_TOOLBAR_CMS = [ ["Undo", "Redo"], ["CMSPlugins", "cmswidget", "-", "ShowBlocks"], ["Format", "Styles", "BlockStyles", "InlineStyles"], ["TextColor", "Highlight", "BGColor", "-", "PasteText", "PasteFromWord"], ["Maximize"], [ "Bold", "Italic", "Underline", "-", "InlineQuote", "Code", "-", "Subscript", "Superscript", ], ["JustifyLeft", "JustifyCenter", "JustifyRight", "JustifyBlock"], ["RemoveFormat"], ["Link", "Unlink"], ["NumberedList", "BulletedList"], ["HorizontalRule", "CodeBlock"], ["Outdent", "Indent", "-", "Blockquote", "-", "Table"], ["ImagePlugin"], ["Source"], ] DEFAULT_TOOLBAR_HTMLField = [ ["Undo", "Redo"], ["ShowBlocks"], ["Format", "Styles", "BlockStyles", "InlineStyles"], ["TextColor", "Highlight", "BGColor", "-", "PasteText", "PasteFromWord"], ["Maximize"], [ "Bold", "Italic", "Underline", "-", "InlineQuote", "Code", "-", "Subscript", "Superscript", ], ["JustifyLeft", "JustifyCenter", "JustifyRight", "JustifyBlock"], ["RemoveFormat"], ["Link", "Unlink"], ["NumberedList", "BulletedList"], ["HorizontalRule", "CodeBlock"], ["Outdent", "Indent", "-", "Blockquote", "-", "Table"], ["Source"], ] class RTEConfig: """ Initializes an instance of RTEConfig. Args: name (str): The name of the RTE configuration. config (str): The configuration string. js (Iterable[str]): An iterable of JavaScript files to include. css (dict): A dictionary of CSS files to include. admin_css (Iterable[str]): An iterable of CSS files for the admin interface only. inline_editing (bool): Whether to enable inline editing. child_plugin_support (bool): Whether to support child plugins. additional_context (dict | None): Additional context to pass to the editor's global setting. Attributes: name (str): The name of the RTE configuration. config (str): The configuration string. js (Iterable[str]): An iterable of JavaScript files to include. css (dict): A dictionary of CSS files to include. admin_css (Iterable[str]): An iterable of CSS files for the admin interface only. inline_editing (bool): Whether to enable inline editing. child_plugin_support (bool): Whether to support child plugins. configuration (dict): A dictionary to hold additional globalboal editor configurations. additional_context (dict): Additional context to pass to the editor's global setting object. """ def __init__( self, name: str, config: str, js: Iterable[str] | None = None, css: dict | None = None, admin_css: Iterable[str] | None = None, inline_editing: bool = False, child_plugin_support: bool = False, configuration: dict | None = None, additional_context: dict | None = None, ): """ """ self.name = name self.config = config self.js = js or [] self.css = css or {} self.admin_css = admin_css or () self.inline_editing = inline_editing self.child_plugin_support = child_plugin_support self.configuration = configuration or {} self.additional_context = additional_context or {} def process_base_config(self, base_config: dict) -> dict: """ Processes the base configuration. Needs to be subclassed. :param base_config: The base configuration to process. :type base_config: dict """ return base_config def get_base_config(self) -> dict: """ Returns the base configuration for the editor. :return: The base configuration for the editor. :rtype: dict """ return self.process_base_config(_EDITOR_TOOLBAR_BASE_CONFIG.copy()) configuration = {} def register(editor: RTEConfig): """ Registers an editor configuration with the system. :param editor: An instance of RTEConfig representing the editor configuration to register. :type editor: RTEConfig """ if not isinstance(editor, RTEConfig): raise TypeError("editor must be an instance of RTEConfig") configuration[editor.name] = editor def get_editor_config(editor: str | None = None) -> RTEConfig: """ Returns the editor configuration. :return: The editor configuration. :rtype: RTEConfig """ config = editor or getattr(settings, "TEXT_EDITOR", "tiptap") config_name = config.rsplit(".", 1)[-1] if config_name not in configuration: # Load the configuration from the module module = __import__(config.rsplit(".", 1)[0], fromlist=[""]) rte_config_instance = getattr(module, config_name) # Cache editor configuration rte_config_instance.name = config_name register(rte_config_instance) return configuration[config_name] DEFAULT_EDITOR = RTEConfig( name="tiptap", config="TIPTAP", js=("djangocms_text/bundles/bundle.tiptap.min.js",), css={"all": ("djangocms_text/css/bundle.tiptap.min.css",)}, admin_css=("djangocms_text/css/tiptap.admin.css",), inline_editing=True, child_plugin_support=True, configuration={}, ) register(DEFAULT_EDITOR)