another one

Author: vasantvohra

indico/modules/email_templates/blueprint.py

@@ -6,15 +6,17 @@
 # LICENSE file for more details.
 
 from indico.modules.email_templates.controllers import (RHAddCategoryEmailTemplate, RHAddEventEmailTemplate,
-                                                        RHListCategoryEmailTemplates, RHListEventEmailTemplates,
-                                                        RHEditEmailTemplate, RHDeleteEmailTemplate,
-                                                        RHCloneEventEmailTemplate, RHCloneCategoryEmailTemplate,
-                                                        RHCloneEventSystemEmailTemplate,
-                                                        RHCloneCategorySystemEmailTemplate, RHViewEmailTemplate)
+                                                        RHCloneCategoryEmailTemplate,
+                                                        RHCloneCategorySystemEmailTemplate, RHCloneEventEmailTemplate,
+                                                        RHCloneEventSystemEmailTemplate, RHDeleteEmailTemplate,
+                                                        RHEditEmailTemplate, RHListCategoryEmailTemplates,
+                                                        RHListEventEmailTemplates, RHViewCategoryEmailTemplate,
+                                                        RHViewEmailTemplate, RHViewEventEmailTemplate)
 from indico.util.caching import memoize
 from indico.web.flask.util import make_view_func
 from indico.web.flask.wrappers import IndicoBlueprint
 
+
 _bp = IndicoBlueprint('email_templates', __name__, template_folder='templates',
                       virtual_template_folder='email_templates')
 
@@ -46,7 +48,8 @@ def view_func(**kwargs):
                      _dispatch(RHCloneEventEmailTemplate, RHCloneCategoryEmailTemplate),
                      defaults={'object_type': object_type}, methods=('GET', 'POST'))
     _bp.add_url_rule(f'{prefix}/<email_template_name>/view-system-template', 'view_system_email_template',
-                     RHViewEmailTemplate, defaults={'object_type': object_type}, methods=('GET', 'POST'))
+                     _dispatch(RHViewEventEmailTemplate, RHViewCategoryEmailTemplate),
+                     defaults={'object_type': object_type}, methods=('GET', 'POST'))
     _bp.add_url_rule(f'{prefix}/<email_template_name>/system-template/clone', 'clone_system_email_template',
                      _dispatch(RHCloneEventSystemEmailTemplate, RHCloneCategorySystemEmailTemplate),
                      defaults={'object_type': object_type}, methods=('GET', 'POST'))

indico/modules/email_templates/controllers.py

@@ -7,14 +7,15 @@
 
 from copy import deepcopy
 
-from flask import flash, request, session
+from flask import flash, request, session, jsonify, render_template
 from markupsafe import Markup
 from werkzeug.exceptions import Forbidden, NotFound
 
 from indico.core.db import db
 from indico.modules.categories import Category
 from indico.modules.categories.controllers.base import RHManageCategoryBase
 from indico.modules.designer.forms import CloneTemplateForm
+from indico.modules.email_templates.dummy import get_dummy_registration
 from indico.modules.email_templates.forms import CreateEmailTemplatesForm, EditEmailTemplatesForm
 from indico.modules.email_templates.models.email_templates import EmailTemplate
 from indico.modules.email_templates.util import get_inherited_templates, get_system_templates
@@ -123,19 +124,26 @@ def _process(self):
         return jsonify_form(form, disabled_until_change=False)
 
 
-class RHViewEmailTemplate(AddEmailTemplateMixin, RHProtected):
+class RHViewEmailTemplate(AddEmailTemplateMixin):
     def _process_args(self):
+        super()._process_args()
         self.email_template_name = request.view_args['email_template_name']
 
     def _process(self):
-        tpl = get_template_module(f'events/registration/emails/{self.email_template_name}', registration=None,
+        title = self.email_template_name.replace('_', ' ').title()
+        filename = get_system_templates(self.email_template_name)
+        dummy = get_dummy_registration()
+        tpl = get_template_module(f'events/registration/emails/{filename}', registration=dummy,
                                   attach_rejection_reason='{rejection_reason}', diff=None, old_price=None,
                                   receipt=None)
-        form = EditEmailTemplatesForm()
-        if form.validate_on_submit():
-            flash(_("Added new email template '{}'").format(), 'success')
-            return jsonify_data(html=_render_template_list(self.target, event=self.event_or_none))
-        return jsonify_form(form, disabled_until_change=False)
+        # email_body = replace_placeholders('accreditation-email', request.form['body'], accreditation=accreditation)
+        # email_subject = replace_placeholders('accreditation-email', request.form['subject'],
+        #                                      accreditation=accreditation)
+        # tpl = get_template_module('events/registration/emails/custom_email.html', email_subject=email_subject,
+        #                           email_body=email_body)
+        html = render_template('email_templates/preview.html', title=title, type='Registration',
+                               subject=tpl.get_subject(), body=tpl.get_body())
+        return jsonify(html=html)
 
 
 class RHListEventEmailTemplates(EmailTemplateListMixin, RHManageEventBase):
@@ -154,6 +162,14 @@ class RHAddCategoryEmailTemplate(AddEmailTemplateMixin, RHManageCategoryBase):
     pass
 
 
+class RHViewEventEmailTemplate(RHViewEmailTemplate, RHManageEventBase):
+    pass
+
+
+class RHViewCategoryEmailTemplate(RHViewEmailTemplate, RHManageCategoryBase):
+    pass
+
+
 class RHModifyEmailTemplateBase(SpecificEmailTemplateMixin, RHProtected):
     def _check_access(self):
         RHProtected._check_access(self)
@@ -187,7 +203,6 @@ def _check_access(self):
         elif isinstance(self.target, Event):
             check_event_locked(self, self.target)
 
-
     def _process_args(self):
         self.email_tpl = EmailTemplate.get_or_404(request.view_args['email_template_id'])
         if self.target.is_deleted:

indico/modules/email_templates/dummy.py

@@ -0,0 +1,102 @@
+# This file is part of Indico.
+# Copyright (C) 2002 - 2025 CERN
+#
+# Indico is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see the
+# LICENSE file for more details.
+from datetime import datetime
+
+from _decimal import Decimal
+from pytz import timezone
+
+from indico.util.date_time import format_currency
+from indico.util.locators import locator_property
+
+
+class Dummy:
+    """Lightweight dummy object used in many Indico tests."""
+    pass
+
+    def get_data(self):
+        first_name = Dummy()
+        first_name.html_field_name = 'first_name'
+        last_name = Dummy()
+        last_name.html_field_name = 'last_name'
+        date_of_birth = Dummy()
+        date_of_birth.html_field_name = 'date_of_birth'
+        sex = Dummy()
+        country = Dummy()
+        email_address = Dummy()
+
+    def get_summary_data(self, hide_empty=False):
+        # personal_data_section
+        personal_data_section = Dummy()
+        personal_data_section.title = 'Personal Data'
+        personal_data_section.is_manager_only = False
+        return {}
+
+    def render_price(self):
+        return format_currency(self.price, self.currency)
+
+    def get_locator_dict(self):
+        return dict(reg_form_id=self.registration_form.id, registration_id=self.id, event_id=self.event.id)
+
+    @locator_property
+    def locator(self):
+        return self.get_locator_dict()
+
+    @locator.registrant
+    def locator(self):
+        locator = self.get_locator_dict()
+        del locator['registration_id']
+        locator['token'] = 'd8343'
+        return locator
+
+
+def get_dummy_registration():
+    """Return a full dummy registration object using Dummy class."""
+    reg = Dummy()
+
+    # Basic fields
+    reg.id = 123
+    reg.first_name = 'John'
+    reg.last_name = 'Doe'
+    reg.full_name = f'{reg.first_name} {reg.last_name}'
+    reg.email = 'john.doe@example.com'
+    reg.price = 150
+    reg.friendly_id = 123
+
+    # state object
+    reg.state = Dummy()
+    reg.state.title = 'Complete'
+
+    reg.data = []
+
+    reg.summary_data = {}
+
+    # Methods
+    reg.get_full_name = lambda: reg.full_name
+    reg.get_base_price = lambda: reg.price
+
+    # Registration Form
+    reg.registration_form = Dummy()
+    reg.registration_form.id = 123
+    reg.registration_form.title = 'Demo Registration Form'
+    reg.registration_form.currency = 'CHF'
+    reg.price = Decimal('0')
+    reg.currency = 'EUR'
+
+
+    # Event
+    reg.event = Dummy()
+    reg.event.id = 123
+    reg.event.title = 'Demo Conference 2025'
+    reg.event.start_dt = datetime.fromisoformat('2025-02-15 09:00')
+    reg.event.end_dt = datetime.fromisoformat('2025-02-17 17:00')
+    reg.event.timezone = 'Europe/Zurich'
+    reg.event.external_url = 'www.example.com'
+    reg.event.start_dt_local = reg.event.start_dt
+    reg.event.end_dt_local = reg.event.end_dt
+    reg.event.tzinfo = timezone(reg.event.timezone)
+    reg.registration_form.event = reg.event
+    return reg

indico/modules/email_templates/forms.py

@@ -12,7 +12,7 @@
 from indico.util.i18n import _
 from indico.util.placeholders import render_placeholder_info
 from indico.web.forms.base import IndicoForm
-from indico.web.forms.validators import NoRelativeURLs, HiddenUnless
+from indico.web.forms.validators import HiddenUnless, NoRelativeURLs
 from indico.web.forms.widgets import TinyMCEWidget
 
 

indico/modules/email_templates/models/email_templates.py

@@ -9,7 +9,7 @@
 from sqlalchemy.ext.hybrid import Comparator, hybrid_property
 
 from indico.core.db import db
-from indico.modules.logs import EventLogRealm, CategoryLogRealm
+from indico.modules.logs import CategoryLogRealm, EventLogRealm
 from indico.util.locators import locator_property
 from indico.util.string import format_repr
 

indico/modules/email_templates/templates/preview.html

@@ -0,0 +1,16 @@
+{% from 'message_box.html' import message_box %}
+
+{% call message_box('highlight', fixed_width=true) %}
+    {% trans -%}
+        This preview is only shown for a dummy registration.<br>
+        When sending the emails, registrant will receive an email
+        customized with the data of their registration.
+    {%- endtrans %}
+{% endcall %}
+<span class="ui label basic blue">{{ type }}</span>
+<h2>{{ title }}</h2>
+<strong>{% trans %}Subject{% endtrans %}</strong>
+<pre class="mono">{{ subject | forceescape }}</pre>
+<br>
+<strong>{% trans %}Body{% endtrans %}</strong>
+<div>{{ body }}</div>

indico/modules/email_templates/util.py

@@ -21,12 +21,14 @@ def get_inherited_templates(obj):
     return get_all_templates(obj) - set(obj.email_templates)
 
 
-def get_system_templates():
+def get_system_templates(email_template_name=None):
     """Get all templates hardcoded in the registration module system."""
     registration_templates = {
         'registration_creation': 'registration_creation_to_registrant.html',
         'registration_modification': 'registration_modification_to_registrant.html',
         'registration_status_update': 'registration_state_update_to_registrant.html',
         'registration_receipt': 'registration_receipt_created_to_registrant.html'
     }
+    if email_template_name:
+        return registration_templates.get(email_template_name)
     return registration_templates