mirror of
https://github.com/MCV-Software/TWBlue.git
synced 2026-03-07 09:57:32 +01:00
Commit
This commit is contained in:
153
src/controller/blueski/templateEditor.py
Normal file
153
src/controller/blueski/templateEditor.py
Normal file
@@ -0,0 +1,153 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
from typing import TYPE_CHECKING, Any
|
||||
|
||||
# fromapprove.controller.mastodon import templateEditor as mastodon_template_editor # If adapting
|
||||
fromapprove.translation import translate as _
|
||||
|
||||
if TYPE_CHECKING:
|
||||
fromapprove.sessions.blueski.session import Session as BlueskiSession # Adjusted
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
# This file would handle the logic for a template editor specific to Blueski.
|
||||
# A template editor allows users to customize how certain information or messages
|
||||
# from Blueski are displayed in Approve.
|
||||
|
||||
# For Blueski, this might be less relevant initially if its content structure
|
||||
# is simpler than Mastodon's, or if user-customizable templates are not a primary feature.
|
||||
# However, having the structure allows for future expansion.
|
||||
|
||||
# Example: Customizing the format of a "new follower" notification, or how a "skeet" is displayed.
|
||||
|
||||
class BlueskiTemplateEditor:
|
||||
def __init__(self, session: BlueskiSession) -> None:
|
||||
self.session = session
|
||||
# self.user_id = session.user_id
|
||||
# self.config_prefix = f"sessions.blueski.{self.user_id}.templates." # Example config path
|
||||
|
||||
def get_editable_templates(self) -> list[dict[str, Any]]:
|
||||
"""
|
||||
Returns a list of templates that the user can edit for Blueski.
|
||||
Each entry should describe the template, its purpose, and current value.
|
||||
"""
|
||||
# This would typically fetch template definitions from a default set
|
||||
# and override with any user-customized versions from config.
|
||||
|
||||
# Example structure for an editable template:
|
||||
# templates = [
|
||||
# {
|
||||
# "id": "new_follower_notification", # Unique ID for this template
|
||||
# "name": _("New Follower Notification Format"),
|
||||
# "description": _("Customize how new follower notifications from Blueski are displayed."),
|
||||
# "default_template": "{{ actor.displayName }} (@{{ actor.handle }}) is now following you on Blueski!",
|
||||
# "current_template": self._get_template_content("new_follower_notification"),
|
||||
# "variables": [ # Available variables for this template
|
||||
# {"name": "actor.displayName", "description": _("Display name of the new follower")},
|
||||
# {"name": "actor.handle", "description": _("Handle of the new follower")},
|
||||
# {"name": "actor.url", "description": _("URL to the new follower's profile")},
|
||||
# ],
|
||||
# "category": "notifications", # For grouping in UI
|
||||
# },
|
||||
# # Add more editable templates for Blueski here
|
||||
# ]
|
||||
# return templates
|
||||
return [] # Placeholder - no editable templates defined yet for Blueski
|
||||
|
||||
def _get_template_content(self, template_id: str) -> str:
|
||||
"""
|
||||
Retrieves the current content of a specific template, either user-customized or default.
|
||||
"""
|
||||
# config_key = self.config_prefix + template_id
|
||||
# default_value = self._get_default_template_content(template_id)
|
||||
# return approve.config.config.get_value(config_key, default_value) # Example config access
|
||||
return self._get_default_template_content(template_id) # Placeholder
|
||||
|
||||
def _get_default_template_content(self, template_id: str) -> str:
|
||||
"""
|
||||
Returns the default content for a given template ID.
|
||||
"""
|
||||
# This could be hardcoded or loaded from a defaults file.
|
||||
# if template_id == "new_follower_notification":
|
||||
# return "{{ actor.displayName }} (@{{ actor.handle }}) is now following you on Blueski!"
|
||||
# # ... other default templates
|
||||
return "" # Placeholder
|
||||
|
||||
async def save_template_content(self, template_id: str, content: str) -> bool:
|
||||
"""
|
||||
Saves the user-customized content for a specific template.
|
||||
"""
|
||||
# config_key = self.config_prefix + template_id
|
||||
# try:
|
||||
# await approve.config.config.set_value(config_key, content) # Example config access
|
||||
# logger.info(f"Blueski template '{template_id}' saved for user {self.user_id}.")
|
||||
# return True
|
||||
# except Exception as e:
|
||||
# logger.error(f"Error saving Blueski template '{template_id}' for user {self.user_id}: {e}")
|
||||
# return False
|
||||
return False # Placeholder
|
||||
|
||||
def get_template_preview(self, template_id: str, custom_content: str | None = None) -> str:
|
||||
"""
|
||||
Generates a preview of a template using sample data.
|
||||
If custom_content is provided, it's used instead of the saved template.
|
||||
"""
|
||||
# content_to_render = custom_content if custom_content is not None else self._get_template_content(template_id)
|
||||
# sample_data = self._get_sample_data_for_template(template_id)
|
||||
|
||||
# try:
|
||||
# # Use a templating engine (like Jinja2) to render the preview
|
||||
# # from jinja2 import Template
|
||||
# # template = Template(content_to_render)
|
||||
# # preview = template.render(**sample_data)
|
||||
# # return preview
|
||||
# return f"Preview for '{template_id}': {content_to_render}" # Basic placeholder
|
||||
# except Exception as e:
|
||||
# logger.error(f"Error generating preview for Blueski template '{template_id}': {e}")
|
||||
# return _("Error generating preview.")
|
||||
return _("Template previews not yet implemented for Blueski.") # Placeholder
|
||||
|
||||
def _get_sample_data_for_template(self, template_id: str) -> dict[str, Any]:
|
||||
"""
|
||||
Returns sample data appropriate for previewing a specific template.
|
||||
"""
|
||||
# if template_id == "new_follower_notification":
|
||||
# return {
|
||||
# "actor": {
|
||||
# "displayName": "Test User",
|
||||
# "handle": "testuser.bsky.social",
|
||||
# "url": "https://bsky.app/profile/testuser.bsky.social"
|
||||
# }
|
||||
# }
|
||||
# # ... other sample data
|
||||
return {} # Placeholder
|
||||
|
||||
# Functions to be called by the main controller/handler for template editor actions.
|
||||
|
||||
async def get_editor_config(session: BlueskiSession) -> dict[str, Any]:
|
||||
"""
|
||||
Get the configuration needed to display the template editor for Blueski.
|
||||
"""
|
||||
editor = BlueskiTemplateEditor(session)
|
||||
return {
|
||||
"editable_templates": editor.get_editable_templates(),
|
||||
"help_text": _("Customize Blueski message formats. Use variables shown for each template."),
|
||||
}
|
||||
|
||||
async def save_template(session: BlueskiSession, template_id: str, content: str) -> bool:
|
||||
"""
|
||||
Save a modified template for Blueski.
|
||||
"""
|
||||
editor = BlueskiTemplateEditor(session)
|
||||
return await editor.save_template_content(template_id, content)
|
||||
|
||||
async def get_template_preview_html(session: BlueskiSession, template_id: str, content: str) -> str:
|
||||
"""
|
||||
Get an HTML preview for a template with given content.
|
||||
"""
|
||||
editor = BlueskiTemplateEditor(session)
|
||||
return editor.get_template_preview(template_id, custom_content=content)
|
||||
|
||||
|
||||
logger.info("Blueski template editor module loaded (placeholders).")
|
||||
Reference in New Issue
Block a user