WuttaWeb 0.18.0__tar.gz → 0.19.0__tar.gz

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to wuttaweb will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## v0.19.0 (2024-12-23)
+
+### Feat
+
+- add feature to edit email settings, basic message preview
+
+### Fix
+
+- move CRUD header buttons toward center of screen
+
 ## v0.18.0 (2024-12-18)
 
 ### Feat

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: WuttaWeb
-Version: 0.18.0
+Version: 0.19.0
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -39,7 +39,7 @@ Requires-Dist: pyramid-tm
 Requires-Dist: pyramid>=2
 Requires-Dist: waitress
 Requires-Dist: webhelpers2
-Requires-Dist: wuttjamaican[db]>=0.18.1
+Requires-Dist: wuttjamaican[db]>=0.19.0
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: continuum
 Requires-Dist: wutta-continuum; extra == 'continuum'
@@ -53,7 +53,7 @@ Requires-Dist: tox; extra == 'tests'
 Description-Content-Type: text/markdown
 
 
-# wuttaweb
+# WuttaWeb
 
 Web app for Wutta Framework
 

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/README.md

@@ -1,5 +1,5 @@
 
-# wuttaweb
+# WuttaWeb
 
 Web app for Wutta Framework
 

wuttaweb-0.19.0/docs/api/wuttaweb.emails.rst

@@ -0,0 +1,6 @@
+
+``wuttaweb.emails``
+===================
+
+.. automodule:: wuttaweb.emails
+   :members:

wuttaweb-0.19.0/docs/api/wuttaweb.views.email.rst

@@ -0,0 +1,6 @@
+
+``wuttaweb.views.email``
+========================
+
+.. automodule:: wuttaweb.views.email
+   :members:

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/docs/index.rst

@@ -35,6 +35,7 @@ the narrative docs are pretty scant.  That will eventually change.
    api/wuttaweb.db
    api/wuttaweb.db.continuum
    api/wuttaweb.db.sess
+   api/wuttaweb.emails
    api/wuttaweb.forms
    api/wuttaweb.forms.base
    api/wuttaweb.forms.schema
@@ -54,6 +55,7 @@ the narrative docs are pretty scant.  That will eventually change.
    api/wuttaweb.views.base
    api/wuttaweb.views.batch
    api/wuttaweb.views.common
+   api/wuttaweb.views.email
    api/wuttaweb.views.essential
    api/wuttaweb.views.master
    api/wuttaweb.views.people

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.18.0"
+version = "0.19.0"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@wuttaproject.org"}]
@@ -44,7 +44,7 @@ dependencies = [
         "pyramid_tm",
         "waitress",
         "WebHelpers2",
-        "WuttJamaican[db]>=0.18.1",
+        "WuttJamaican[db]>=0.19.0",
         "zope.sqlalchemy>=1.5",
 ]
 

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/src/wuttaweb/app.py

@@ -43,9 +43,12 @@ log = logging.getLogger(__name__)
 class WebAppProvider(AppProvider):
     """
     The :term:`app provider` for WuttaWeb.  This adds some methods to
-    the :term:`app handler`, which are specific to web apps.
+    the :term:`app handler`, which are specific to web apps.  It also
+    registers some :term:`email templates <email template>` for the
+    app, etc.
     """
-    email_templates = 'wuttaweb:email/templates'
+    email_modules = ['wuttaweb.emails']
+    email_templates = ['wuttaweb:email-templates']
 
     def get_web_handler(self, **kwargs):
         """

wuttaweb-0.19.0/src/wuttaweb/emails.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8; -*-
+################################################################################
+#
+#  wuttaweb -- Web App for Wutta Framework
+#  Copyright © 2024 Lance Edgar
+#
+#  This file is part of Wutta Framework.
+#
+#  Wutta Framework is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU General Public License as published by the Free
+#  Software Foundation, either version 3 of the License, or (at your option) any
+#  later version.
+#
+#  Wutta Framework is distributed in the hope that it will be useful, but
+#  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+#  more details.
+#
+#  You should have received a copy of the GNU General Public License along with
+#  Wutta Framework.  If not, see <http://www.gnu.org/licenses/>.
+#
+################################################################################
+"""
+:term:`Email Settings <email setting>` for WuttaWeb
+"""
+
+from wuttjamaican.email import EmailSetting
+
+
+class feedback(EmailSetting):
+    """
+    Sent when user submits feedback via the web app.
+    """
+    default_subject = "User Feedback"
+
+    def sample_data(self):
+        """ """
+        model = self.app.model
+        person = model.Person(full_name="Barney Rubble")
+        user = model.User(username='barney', person=person)
+        return {
+            'user': user,
+            'user_name': str(person),
+            'user_url': '#',
+            'referrer': 'http://example.com/',
+            'client_ip': '127.0.0.1',
+            'message': "This app is cool but needs a new feature.\n\nAllow me to describe...",
+        }

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/src/wuttaweb/forms/schema.py

@@ -30,9 +30,11 @@ import uuid as _uuid
 import colander
 import sqlalchemy as sa
 
+from wuttjamaican.db.model import Person
+from wuttjamaican.conf import parse_list
+
 from wuttaweb.db import Session
 from wuttaweb.forms import widgets
-from wuttjamaican.db.model import Person
 
 
 class WuttaDateTime(colander.DateTime):
@@ -569,5 +571,36 @@ class FileDownload(colander.String):
         return widgets.FileDownloadWidget(self.request, **kwargs)
 
 
+class EmailRecipients(colander.String):
+    """
+    Custom schema type for :term:`email setting` recipient fields
+    (``To``, ``Cc``, ``Bcc``).
+    """
+
+    def serialize(self, node, appstruct):
+        if appstruct is colander.null:
+            return colander.null
+
+        return '\n'.join(parse_list(appstruct))
+
+    def deserialize(self, node, cstruct):
+        """ """
+        if cstruct is colander.null:
+            return colander.null
+
+        values = [value for value in parse_list(cstruct)
+                  if value]
+        return ', '.join(values)
+
+    def widget_maker(self, **kwargs):
+        """
+        Constructs a default widget for the field.
+
+        :returns: Instance of
+           :class:`~wuttaweb.forms.widgets.EmailRecipientsWidget`.
+        """
+        return widgets.EmailRecipientsWidget(**kwargs)
+
+
 # nb. colanderalchemy schema overrides
 sa.DateTime.__colanderalchemy_config__ = {'typ': WuttaDateTime}

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/src/wuttaweb/forms/widgets.py

@@ -51,6 +51,8 @@ from deform.widget import (Widget, TextInputWidget, TextAreaWidget,
                            DateTimeInputWidget, MoneyInputWidget)
 from webhelpers2.html import HTML
 
+from wuttjamaican.conf import parse_list
+
 from wuttaweb.db import Session
 from wuttaweb.grids import Grid
 
@@ -423,6 +425,41 @@ class PermissionsWidget(WuttaCheckboxChoiceWidget):
         return super().serialize(field, cstruct, **kw)
 
 
+class EmailRecipientsWidget(TextAreaWidget):
+    """
+    Widget for :term:`email setting` recipient fields (``To``, ``Cc``,
+    ``Bcc``).
+
+    This is a subclass of
+    :class:`deform:deform.widget.TextAreaWidget`.  It uses these
+    Deform templates:
+
+    * ``textarea``
+    * ``readonly/email_recips``
+
+    See also the :class:`~wuttaweb.forms.schema.EmailRecipients`
+    schema type, which uses this widget.
+    """
+    readonly_template = 'readonly/email_recips'
+
+    def serialize(self, field, cstruct, **kw):
+        """ """
+        readonly = kw.get('readonly', self.readonly)
+        if readonly:
+            kw['recips'] = parse_list(cstruct or '')
+
+        return super().serialize(field, cstruct, **kw)
+
+    def deserialize(self, field, pstruct):
+        """ """
+        if pstruct is colander.null:
+            return colander.null
+
+        values = [value for value in parse_list(pstruct)
+                  if value]
+        return ', '.join(values)
+
+
 class BatchIdWidget(Widget):
     """
     Widget for use with the

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/src/wuttaweb/menus.py

@@ -174,6 +174,12 @@ class MenuHandler(GenericHandler):
                 'perm': 'permissions.list',
             },
             {'type': 'sep'},
+            {
+                'title': "Email Settings",
+                'route': 'email_settings',
+                'perm': 'email_settings.list',
+            },
+            {'type': 'sep'},
             {
                 'title': "App Info",
                 'route': 'appinfo',

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/src/wuttaweb/templates/base.mako

@@ -277,17 +277,21 @@
         % if capture(self.content_title):
             <section id="content-title"
                      class="has-background-primary">
-              <div style="display: flex; align-items: center; padding: 0.5rem;">
+              <div style="display: flex; align-items: center; gap: 0.5rem; padding: 0.5rem;">
 
-                <h1 class="title has-text-white"
-                    v-html="contentTitleHTML">
-                </h1>
+                <div style="width: 60%; display: flex; gap: 0.5rem;">
+
+                  <h1 class="title has-text-white"
+                      v-html="contentTitleHTML">
+                  </h1>
+
+                  <div style="display: flex; gap: 0.5rem;">
+                    ${self.render_instance_header_title_extras()}
+                  </div>
 
-                <div style="flex-grow: 1; display: flex; gap: 0.5rem;">
-                  ${self.render_instance_header_title_extras()}
                 </div>
 
-                <div style="display: flex; gap: 0.5rem;">
+                <div style="width: 40%; display: flex; gap: 0.5rem;">
                   ${self.render_instance_header_buttons()}
                 </div>
 

wuttaweb-0.19.0/src/wuttaweb/templates/deform/readonly/email_recips.pt

@@ -0,0 +1,5 @@
+<ul>
+  <tal:loop tal:repeat="recip recips">
+    <li>${recip}</li>
+  </tal:loop>
+</ul>

wuttaweb-0.19.0/src/wuttaweb/templates/email/settings/view.mako

@@ -0,0 +1,39 @@
+## -*- coding: utf-8; -*-
+<%inherit file="/master/view.mako" />
+
+<%def name="tool_panels()">
+  ${parent.tool_panels()}
+  ${self.tool_panel_preview()}
+</%def>
+
+<%def name="tool_panel_preview()">
+  <wutta-tool-panel heading="Email Preview">
+
+    <b-button type="is-primary"
+              % if has_html_template:
+              tag="a" target="_blank"
+              href="${master.get_action_url('preview', setting)}?mode=html"
+              % else:
+              disabled
+              title="HTML template not found"
+              % endif
+              icon-pack="fas"
+              icon-left="external-link-alt">
+      Preview HTML
+    </b-button>
+
+    <b-button type="is-primary"
+              % if has_txt_template:
+              tag="a" target="_blank"
+              href="${master.get_action_url('preview', setting)}?mode=txt"
+              % else:
+              disabled
+              title="TXT template not found"
+              % endif
+              icon-pack="fas"
+              icon-left="external-link-alt">
+      Preview TXT
+    </b-button>
+
+  </wutta-tool-panel>
+</%def>

wuttaweb-0.19.0/src/wuttaweb/views/email.py

@@ -0,0 +1,298 @@
+# -*- coding: utf-8; -*-
+################################################################################
+#
+#  wuttaweb -- Web App for Wutta Framework
+#  Copyright © 2024 Lance Edgar
+#
+#  This file is part of Wutta Framework.
+#
+#  Wutta Framework is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU General Public License as published by the Free
+#  Software Foundation, either version 3 of the License, or (at your option) any
+#  later version.
+#
+#  Wutta Framework is distributed in the hope that it will be useful, but
+#  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+#  more details.
+#
+#  You should have received a copy of the GNU General Public License along with
+#  Wutta Framework.  If not, see <http://www.gnu.org/licenses/>.
+#
+################################################################################
+"""
+Views for email settings
+"""
+
+import colander
+
+from wuttaweb.views import MasterView
+from wuttaweb.forms.schema import EmailRecipients
+
+
+class EmailSettingView(MasterView):
+    """
+    Master view for :term:`email settings <email setting>`.
+    """
+    model_name = 'email_setting'
+    model_key = 'key'
+    model_title = "Email Setting"
+    url_prefix = '/email/settings'
+    filterable = False
+    sortable = True
+    sort_on_backend = False
+    paginated = False
+    creatable = False
+    deletable = False
+
+    labels = {
+        'key': "Email Key",
+        'replyto': "Reply-To",
+    }
+
+    grid_columns = [
+        'key',
+        'subject',
+        'to',
+        'enabled',
+    ]
+
+    # TODO: why does this not work?
+    sort_defaults = 'key'
+
+    form_fields = [
+        'key',
+        'description',
+        'subject',
+        'sender',
+        'replyto',
+        'to',
+        'cc',
+        'bcc',
+        'notes',
+        'enabled',
+    ]
+
+    def __init__(self, request, context=None):
+        super().__init__(request, context=context)
+        self.email_handler = self.app.get_email_handler()
+
+    def get_grid_data(self, columns=None, session=None):
+        """
+        This view calls
+        :meth:`~wuttjamaican:wuttjamaican.email.EmailHandler.get_email_settings()`
+        on the :attr:`email_handler` to obtain its grid data.
+        """
+        data = []
+        for setting in self.email_handler.get_email_settings().values():
+            data.append(self.normalize_setting(setting))
+        return data
+
+    def normalize_setting(self, setting):
+        """ """
+        key = setting.__name__
+        return {
+            'key': key,
+            'description': setting.__doc__,
+            'subject': self.email_handler.get_auto_subject(key, rendered=False, setting=setting),
+            'sender': self.email_handler.get_auto_sender(key),
+            'replyto': self.email_handler.get_auto_replyto(key) or colander.null,
+            'to': self.email_handler.get_auto_to(key),
+            'cc': self.email_handler.get_auto_cc(key),
+            'bcc': self.email_handler.get_auto_bcc(key),
+            'notes': self.email_handler.get_notes(key) or colander.null,
+            'enabled': self.email_handler.is_enabled(key),
+        }
+
+    def configure_grid(self, g):
+        """ """
+        super().configure_grid(g)
+
+        # key
+        g.set_searchable('key')
+        g.set_link('key')
+
+        # subject
+        g.set_searchable('subject')
+        g.set_link('subject')
+
+        # to
+        g.set_renderer('to', self.render_to_short)
+
+    def render_to_short(self, setting, field, value):
+        """ """
+        recips = value
+        if not recips:
+            return
+
+        if len(recips) < 3:
+            return ', '.join(recips)
+
+        recips = ', '.join(recips[:2])
+        return f"{recips}, ..."
+
+    def get_instance(self):
+        """ """
+        key = self.request.matchdict['key']
+        setting = self.email_handler.get_email_setting(key, instance=False)
+        if setting:
+            return self.normalize_setting(setting)
+
+        raise self.notfound()
+
+    def get_instance_title(self, setting):
+        """ """
+        return setting['subject']
+
+    def configure_form(self, f):
+        """ """
+        super().configure_form(f)
+
+        # description
+        f.set_readonly('description')
+
+        # replyto
+        f.set_required('replyto', False)
+
+        # to
+        f.set_node('to', EmailRecipients())
+
+        # cc
+        f.set_node('cc', EmailRecipients())
+
+        # bcc
+        f.set_node('bcc', EmailRecipients())
+
+        # notes
+        f.set_widget('notes', 'notes')
+        f.set_required('notes', False)
+
+        # enabled
+        f.set_node('enabled', colander.Boolean())
+
+    def persist(self, setting):
+        """ """
+        session = self.Session()
+        key = self.request.matchdict['key']
+
+        def save(name, value):
+            self.app.save_setting(session, f'{self.config.appname}.email.{key}.{name}', value)
+
+        def delete(name):
+            self.app.delete_setting(session, f'{self.config.appname}.email.{key}.{name}')
+
+        # subject
+        if setting['subject']:
+            save('subject', setting['subject'])
+        else:
+            delete('subject')
+
+        # sender
+        if setting['sender']:
+            save('sender', setting['sender'])
+        else:
+            delete('sender')
+
+        # replyto
+        if setting['replyto']:
+            save('replyto', setting['replyto'])
+        else:
+            delete('replyto')
+
+        # to
+        if setting['to']:
+            save('to', setting['to'])
+        else:
+            delete('to')
+
+        # cc
+        if setting['cc']:
+            save('cc', setting['cc'])
+        else:
+            delete('cc')
+
+        # bcc
+        if setting['bcc']:
+            save('bcc', setting['bcc'])
+        else:
+            delete('bcc')
+
+        # notes
+        if setting['notes']:
+            save('notes', setting['notes'])
+        else:
+            delete('notes')
+
+        # enabled
+        save('enabled', 'true' if setting['enabled'] else 'false')
+
+    def render_to_response(self, template, context):
+        """ """
+        if self.viewing:
+            setting = context['instance']
+            context['setting'] = setting
+            context['has_html_template'] = self.email_handler.get_auto_body_template(
+                setting['key'], 'html')
+            context['has_txt_template'] = self.email_handler.get_auto_body_template(
+                setting['key'], 'txt')
+
+        return super().render_to_response(template, context)
+
+    def preview(self):
+        """
+        View for showing a rendered preview of a given email template.
+
+        This will render the email template according to the "mode"
+        requested - i.e. HTML or TXT.
+        """
+        key = self.request.matchdict['key']
+        setting = self.email_handler.get_email_setting(key)
+        context = setting.sample_data()
+        mode = self.request.params.get('mode', 'html')
+
+        if mode == 'txt':
+            body = self.email_handler.get_auto_txt_body(key, context)
+            self.request.response.content_type = 'text/plain'
+
+        else: # html
+            body = self.email_handler.get_auto_html_body(key, context)
+
+        self.request.response.text = body
+        return self.request.response
+
+    @classmethod
+    def defaults(cls, config):
+        """ """
+        cls._email_defaults(config)
+        cls._defaults(config)
+
+    @classmethod
+    def _email_defaults(cls, config):
+        """ """
+        route_prefix = cls.get_route_prefix()
+        permission_prefix = cls.get_permission_prefix()
+        model_title_plural = cls.get_model_title_plural()
+        instance_url_prefix = cls.get_instance_url_prefix()
+
+        # fix permission group
+        config.add_wutta_permission_group(permission_prefix,
+                                          model_title_plural,
+                                          overwrite=False)
+
+        # preview
+        config.add_route(f'{route_prefix}.preview',
+                         f'{instance_url_prefix}/preview')
+        config.add_view(cls, attr='preview',
+                        route_name=f'{route_prefix}.preview',
+                        permission=f'{permission_prefix}.view')
+
+
+def defaults(config, **kwargs):
+    base = globals()
+
+    EmailSettingView = kwargs.get('EmailSettingView', base['EmailSettingView'])
+    EmailSettingView.defaults(config)
+
+
+def includeme(config):
+    defaults(config)

{wuttaweb-0.18.0 → wuttaweb-0.19.0}/src/wuttaweb/views/essential.py

@@ -31,6 +31,7 @@ That will in turn include the following modules:
 
 * :mod:`wuttaweb.views.common`
 * :mod:`wuttaweb.views.auth`
+* :mod:`wuttaweb.views.email`
 * :mod:`wuttaweb.views.settings`
 * :mod:`wuttaweb.views.progress`
 * :mod:`wuttaweb.views.people`
@@ -45,6 +46,7 @@ def defaults(config, **kwargs):
 
     config.include(mod('wuttaweb.views.common'))
     config.include(mod('wuttaweb.views.auth'))
+    config.include(mod('wuttaweb.views.email'))
     config.include(mod('wuttaweb.views.settings'))
     config.include(mod('wuttaweb.views.progress'))
     config.include(mod('wuttaweb.views.people'))