WuttaWeb 0.4.0__tar.gz → 0.5.0__tar.gz

{wuttaweb-0.4.0 → wuttaweb-0.5.0}/CHANGELOG.md

@@ -5,6 +5,18 @@ 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.5.0 (2024-08-06)
+
+### Feat
+
+- add basic support for fanstatic / libcache
+- expose Web Libraries in app info config page
+- add basic configure view for appinfo
+
+### Fix
+
+- bump min version for wuttjamaican
+
 ## v0.4.0 (2024-08-05)
 
 ### Feat

{wuttaweb-0.4.0 → wuttaweb-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: WuttaWeb
-Version: 0.4.0
+Version: 0.5.0
 Summary: Web App for Wutta Framework
 Project-URL: Homepage, https://wuttaproject.org/
 Project-URL: Repository, https://forgejo.wuttaproject.org/wutta/wuttaweb
@@ -26,12 +26,13 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Requires-Dist: pyramid-beaker
 Requires-Dist: pyramid-deform
+Requires-Dist: pyramid-fanstatic
 Requires-Dist: pyramid-mako
 Requires-Dist: pyramid-tm
 Requires-Dist: pyramid>=2
 Requires-Dist: waitress
 Requires-Dist: webhelpers2
-Requires-Dist: wuttjamaican[db]>=0.8.3
+Requires-Dist: wuttjamaican[db]>=0.10.0
 Requires-Dist: zope-sqlalchemy>=1.5
 Provides-Extra: docs
 Requires-Dist: furo; extra == 'docs'

{wuttaweb-0.4.0 → wuttaweb-0.5.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "WuttaWeb"
-version = "0.4.0"
+version = "0.5.0"
 description = "Web App for Wutta Framework"
 readme = "README.md"
 authors = [{name = "Lance Edgar", email = "lance@edbob.org"}]
@@ -33,11 +33,12 @@ dependencies = [
         "pyramid>=2",
         "pyramid_beaker",
         "pyramid_deform",
+        "pyramid_fanstatic",
         "pyramid_mako",
         "pyramid_tm",
         "waitress",
         "WebHelpers2",
-        "WuttJamaican[db]>=0.8.3",
+        "WuttJamaican[db]>=0.10.0",
         "zope.sqlalchemy>=1.5",
 ]
 

{wuttaweb-0.4.0 → wuttaweb-0.5.0}/src/wuttaweb/app.py

@@ -110,7 +110,12 @@ def make_pyramid_config(settings):
 
     The config is initialized with certain features deemed useful for
     all apps.
+
+    :returns: Instance of
+       :class:`pyramid:pyramid.config.Configurator`.
     """
+    settings.setdefault('fanstatic.versioning', 'true')
+    settings.setdefault('mako.directories', ['wuttaweb:templates'])
     settings.setdefault('pyramid_deform.template_search_path',
                         'wuttaweb:templates/deform')
 
@@ -119,8 +124,14 @@ def make_pyramid_config(settings):
     # configure user authorization / authentication
     pyramid_config.set_security_policy(WuttaSecurityPolicy())
 
+    # require CSRF token for POST
+    pyramid_config.set_default_csrf_options(require_csrf=True,
+                                            token='_csrf',
+                                            header='X-CSRF-TOKEN')
+
     pyramid_config.include('pyramid_beaker')
     pyramid_config.include('pyramid_deform')
+    pyramid_config.include('pyramid_fanstatic')
     pyramid_config.include('pyramid_mako')
     pyramid_config.include('pyramid_tm')
 
@@ -143,8 +154,6 @@ def main(global_config, **settings):
     will need to define their own ``main()`` function, and use that
     instead.
     """
-    settings.setdefault('mako.directories', ['wuttaweb:templates'])
-
     wutta_config = make_wutta_config(settings)
     pyramid_config = make_pyramid_config(settings)
 

{wuttaweb-0.4.0 → wuttaweb-0.5.0}/src/wuttaweb/forms/base.py

@@ -323,6 +323,7 @@ class Form:
         """
         context['form'] = self
         context.setdefault('form_attrs', {})
+        context.setdefault('request', self.request)
 
         # auto disable button on submit
         if self.auto_disable_submit:

{wuttaweb-0.4.0 → wuttaweb-0.5.0}/src/wuttaweb/helpers.py

@@ -38,12 +38,20 @@ instance:
 
 This module contains the following references:
 
-* :func:`~wuttaweb.util.get_liburl()`
 * all names from :mod:`webhelpers2:webhelpers2.html`
 * all names from :mod:`webhelpers2:webhelpers2.html.tags`
+* :func:`~wuttaweb.util.get_liburl()`
+* :func:`~wuttaweb.util.get_csrf_token()`
+* :func:`~wuttaweb.util.render_csrf_token()` (as :func:`csrf_token()`)
+
+.. function:: csrf_token
+
+   This is a shorthand reference to
+   :func:`wuttaweb.util.render_csrf_token()`.
+
 """
 
 from webhelpers2.html import *
 from webhelpers2.html.tags import *
 
-from wuttaweb.util import get_liburl
+from wuttaweb.util import get_liburl, get_csrf_token, render_csrf_token as csrf_token

wuttaweb-0.5.0/src/wuttaweb/templates/appinfo/configure.mako

@@ -0,0 +1,177 @@
+## -*- coding: utf-8; -*-
+<%inherit file="/configure.mako" />
+
+<%def name="form_content()">
+
+  <h3 class="block is-size-3">Basics</h3>
+  <div class="block" style="padding-left: 2rem; width: 50%;">
+
+    <b-field label="App Title">
+      <b-input name="${app.appname}.app_title"
+               v-model="simpleSettings['${app.appname}.app_title']"
+               @input="settingsNeedSaved = true">
+      </b-input>
+    </b-field>
+
+    <b-field>
+      <b-checkbox name="${app.appname}.production"
+                  v-model="simpleSettings['${app.appname}.production']"
+                  native-value="true"
+                  @input="settingsNeedSaved = true">
+        Production Mode
+      </b-checkbox>
+    </b-field>
+
+  </div>
+
+  <h3 class="block is-size-3">Web Libraries</h3>
+  <div class="block" style="padding-left: 2rem;">
+
+    <${b}-table :data="weblibs">
+
+      <${b}-table-column field="title"
+                      label="Name"
+                      v-slot="props">
+        {{ props.row.title }}
+      </${b}-table-column>
+
+      <${b}-table-column field="configured_version"
+                      label="Version"
+                      v-slot="props">
+        {{ props.row.configured_version || props.row.default_version }}
+      </${b}-table-column>
+
+      <${b}-table-column field="configured_url"
+                      label="URL Override"
+                      v-slot="props">
+        {{ props.row.configured_url }}
+      </${b}-table-column>
+
+      <${b}-table-column field="live_url"
+                      label="Effective (Live) URL"
+                      v-slot="props">
+        <span v-if="props.row.modified"
+              class="has-text-warning">
+          save settings and refresh page to see new URL
+        </span>
+        <span v-if="!props.row.modified">
+          {{ props.row.live_url }}
+        </span>
+      </${b}-table-column>
+
+      <${b}-table-column field="actions"
+                      label="Actions"
+                      v-slot="props">
+        <a href="#"
+           @click.prevent="editWebLibraryInit(props.row)">
+          % if request.use_oruga:
+              <o-icon icon="edit" />
+          % else:
+              <i class="fas fa-edit"></i>
+          % endif
+          Edit
+        </a>
+      </${b}-table-column>
+
+    </${b}-table>
+
+    % for weblib in weblibs or []:
+        ${h.hidden('wuttaweb.libver.{}'.format(weblib['key']), **{':value': "simpleSettings['wuttaweb.libver.{}']".format(weblib['key'])})}
+        ${h.hidden('wuttaweb.liburl.{}'.format(weblib['key']), **{':value': "simpleSettings['wuttaweb.liburl.{}']".format(weblib['key'])})}
+    % endfor
+
+    <${b}-modal has-modal-card
+                % if request.use_oruga:
+                    v-model:active="editWebLibraryShowDialog"
+                % else:
+                    :active.sync="editWebLibraryShowDialog"
+                % endif
+                >
+      <div class="modal-card">
+
+        <header class="modal-card-head">
+          <p class="modal-card-title">Web Library: {{ editWebLibraryRecord.title }}</p>
+        </header>
+
+        <section class="modal-card-body">
+
+          <b-field grouped>
+
+            <b-field label="Default Version">
+              <b-input v-model="editWebLibraryRecord.default_version"
+                       disabled>
+              </b-input>
+            </b-field>
+
+            <b-field label="Override Version">
+              <b-input v-model="editWebLibraryVersion">
+              </b-input>
+            </b-field>
+
+          </b-field>
+
+          <b-field label="Override URL">
+            <b-input v-model="editWebLibraryURL"
+                     expanded />
+          </b-field>
+
+          <b-field label="Effective URL (as of last page load)">
+            <b-input v-model="editWebLibraryRecord.live_url"
+                     disabled
+                     expanded />
+          </b-field>
+
+        </section>
+
+        <footer class="modal-card-foot">
+          <b-button type="is-primary"
+                    @click="editWebLibrarySave()"
+                    icon-pack="fas"
+                    icon-left="save">
+            Save
+          </b-button>
+          <b-button @click="editWebLibraryShowDialog = false">
+            Cancel
+          </b-button>
+        </footer>
+      </div>
+    </${b}-modal>
+
+  </div>
+</%def>
+
+<%def name="modify_this_page_vars()">
+  ${parent.modify_this_page_vars()}
+  <script>
+
+    ThisPageData.weblibs = ${json.dumps(weblibs or [])|n}
+
+    ThisPageData.editWebLibraryShowDialog = false
+    ThisPageData.editWebLibraryRecord = {}
+    ThisPageData.editWebLibraryVersion = null
+    ThisPageData.editWebLibraryURL = null
+
+    ThisPage.methods.editWebLibraryInit = function(row) {
+        this.editWebLibraryRecord = row
+        this.editWebLibraryVersion = row.configured_version
+        this.editWebLibraryURL = row.configured_url
+        this.editWebLibraryShowDialog = true
+    }
+
+    ThisPage.methods.editWebLibrarySave = function() {
+        this.editWebLibraryRecord.configured_version = this.editWebLibraryVersion
+        this.editWebLibraryRecord.configured_url = this.editWebLibraryURL
+        this.editWebLibraryRecord.modified = true
+
+        this.simpleSettings[`wuttaweb.libver.${'$'}{this.editWebLibraryRecord.key}`] = this.editWebLibraryVersion
+        this.simpleSettings[`wuttaweb.liburl.${'$'}{this.editWebLibraryRecord.key}`] = this.editWebLibraryURL
+
+        this.settingsNeedSaved = true
+        this.editWebLibraryShowDialog = false
+    }
+
+  </script>
+</%def>
+
+
+${parent.body()}

{wuttaweb-0.4.0 → wuttaweb-0.5.0}/src/wuttaweb/templates/base.mako

@@ -209,16 +209,14 @@
             </div>
           </nav>
 
-          <nav class="level" style="margin: 0.5rem auto;">
+          <nav class="level" style="margin: 0.5rem 0.5rem 0.5rem auto;">
             <div class="level-left">
 
               ## Current Context
               <div id="current-context" class="level-item">
                 % if index_title:
                     % if index_url:
-                        <span class="header-text">
-                          ${h.link_to(index_title, index_url)}
-                        </span>
+                        <h1 class="title">${h.link_to(index_title, index_url)}</h1>
                     % else:
                         <h1 class="title">${index_title}</h1>
                     % endif
@@ -226,6 +224,23 @@
               </div>
 
             </div><!-- level-left -->
+
+            <div class="level-right">
+
+              ## TODO
+              % if master and master.configurable and not master.configuring:
+                  <div class="level-item">
+                    <b-button type="is-primary"
+                              tag="a"
+                              href="${url(f'{route_prefix}.configure')}"
+                              icon-pack="fas"
+                              icon-left="cog">
+                      Configure
+                    </b-button>
+                  </div>
+              % endif
+
+            </div> <!-- level-right -->
           </nav><!-- level -->
         </header>
 
@@ -318,8 +333,7 @@
         <div class="navbar-dropdown">
           % if request.is_root:
               ${h.form(url('stop_root'), ref='stopBeingRootForm')}
-              ## TODO
-              ## ${h.csrf_token(request)}
+              ${h.csrf_token(request)}
               <input type="hidden" name="referrer" value="${request.current_route_url()}" />
               <a @click="stopBeingRoot()"
                  class="navbar-item has-background-danger has-text-white">
@@ -328,8 +342,7 @@
               ${h.end_form()}
           % elif request.is_admin:
               ${h.form(url('become_root'), ref='startBeingRootForm')}
-              ## TODO
-              ## ${h.csrf_token(request)}
+              ${h.csrf_token(request)}
               <input type="hidden" name="referrer" value="${request.current_route_url()}" />
               <a @click="startBeingRoot()"
                  class="navbar-item has-background-danger has-text-white">

wuttaweb-0.5.0/src/wuttaweb/templates/configure.mako

@@ -0,0 +1,181 @@
+## -*- coding: utf-8; -*-
+<%inherit file="/page.mako" />
+
+<%def name="title()">Configure ${config_title}</%def>
+
+<%def name="page_content()">
+  <br />
+  ${self.buttons_content()}
+
+  ${h.form(request.current_route_url(), enctype='multipart/form-data', ref='saveSettingsForm', **{'@submit': 'saveSettingsFormSubmit'})}
+  ${h.csrf_token(request)}
+  ${self.form_content()}
+  ${h.end_form()}
+
+  <b-modal has-modal-card
+           :active.sync="purgeSettingsShowDialog">
+    <div class="modal-card">
+
+      <header class="modal-card-head">
+        <p class="modal-card-title">Remove All Settings</p>
+      </header>
+
+      <section class="modal-card-body">
+        <p class="block">
+          Really remove all settings for ${config_title} from the DB?
+        </p>
+        <p class="block">
+          Note that when you <span class="is-italic">save</span>
+          settings, any existing settings are first removed and then
+          new ones are saved.
+        </p>
+        <p class="block">
+          But here you can remove existing without saving new
+          ones.&nbsp; It is basically "factory reset" for
+          ${config_title}.
+        </p>
+      </section>
+
+      <footer class="modal-card-foot">
+        <b-button @click="purgeSettingsShowDialog = false">
+          Cancel
+        </b-button>
+        ${h.form(request.current_route_url())}
+        ${h.csrf_token(request)}
+        ${h.hidden('remove_settings', 'true')}
+        <b-button type="is-danger"
+                  native-type="submit"
+                  :disabled="purgingSettings"
+                  icon-pack="fas"
+                  icon-left="trash"
+                  @click="purgingSettings = true">
+          {{ purgingSettings ? "Working, please wait..." : "Remove All Settings for ${config_title}" }}
+        </b-button>
+        ${h.end_form()}
+      </footer>
+    </div>
+  </b-modal>
+
+</%def>
+
+<%def name="buttons_content()">
+  <div class="level">
+    <div class="level-left">
+
+      <div class="level-item">
+        ${self.intro_message()}
+      </div>
+
+      <div class="level-item">
+        ${self.save_undo_buttons()}
+      </div>
+    </div>
+
+    <div class="level-right">
+      <div class="level-item">
+        ${self.purge_button()}
+      </div>
+    </div>
+  </div>
+</%def>
+
+<%def name="intro_message()">
+  <p class="block">
+    This page lets you modify the settings for ${config_title}.
+  </p>
+</%def>
+
+<%def name="save_undo_buttons()">
+  <div class="buttons"
+       v-if="settingsNeedSaved">
+    <b-button type="is-primary"
+              @click="saveSettings"
+              :disabled="savingSettings"
+              icon-pack="fas"
+              icon-left="save">
+      {{ savingSettings ? "Working, please wait..." : "Save All Settings" }}
+    </b-button>
+    <b-button tag="a" href="${request.current_route_url()}"
+              icon-pack="fas"
+              icon-left="undo"
+              @click="undoChanges = true"
+              :disabled="undoChanges">
+      {{ undoChanges ? "Working, please wait..." : "Undo All Changes" }}
+    </b-button>
+  </div>
+</%def>
+
+<%def name="purge_button()">
+  <b-button type="is-danger"
+            @click="purgeSettingsShowDialog = true"
+            icon-pack="fas"
+            icon-left="trash">
+    Remove All Settings
+  </b-button>
+</%def>
+
+<%def name="form_content()">
+  <b-notification type="is-warning"
+                  :closable="false">
+    <h4 class="block is-size-4">
+      TODO: you must define the
+      <span class="is-family-monospace">&lt;%def name="form_content()"&gt;</span>
+      template block
+    </h4>
+    <p class="block">
+      or if you need more control, define the
+      <span class="is-family-monospace">&lt;%def name="page_content()"&gt;</span>
+      template block
+    </p>
+    <p class="block">
+      for a real-world example see template at
+      <span class="is-family-monospace">wuttaweb:templates/appinfo/configure.mako</span>
+    </p>
+  </b-notification>
+</%def>
+
+<%def name="modify_this_page_vars()">
+  ${parent.modify_this_page_vars()}
+  <script>
+
+    % if simple_settings is not Undefined:
+        ThisPageData.simpleSettings = ${json.dumps(simple_settings)|n}
+    % endif
+
+    ThisPageData.purgeSettingsShowDialog = false
+    ThisPageData.purgingSettings = false
+
+    ThisPageData.settingsNeedSaved = false
+    ThisPageData.undoChanges = false
+    ThisPageData.savingSettings = false
+
+    ThisPage.methods.saveSettings = function() {
+        this.savingSettings = true
+        this.$refs.saveSettingsForm.submit()
+    }
+
+    // nb. this is here to avoid auto-submitting form when user
+    // presses ENTER while some random input field has focus
+    ThisPage.methods.saveSettingsFormSubmit = function(event) {
+        if (!this.savingSettings) {
+            event.preventDefault()
+        }
+    }
+
+    // cf. https://stackoverflow.com/a/56551646
+    ThisPage.methods.beforeWindowUnload = function(e) {
+        if (this.settingsNeedSaved && !this.savingSettings && !this.undoChanges) {
+            e.preventDefault()
+            e.returnValue = ''
+        }
+    }
+
+    ThisPage.created = function() {
+        window.addEventListener('beforeunload', this.beforeWindowUnload)
+    }
+
+  </script>
+</%def>
+
+
+${parent.body()}

{wuttaweb-0.4.0 → wuttaweb-0.5.0}/src/wuttaweb/templates/forms/vue_template.mako

@@ -2,6 +2,7 @@
 
 <script type="text/x-template" id="${form.vue_tagname}-template">
   ${h.form(form.action_url, method='post', enctype='multipart/form-data', **form_attrs)}
+    ${h.csrf_token(request)}
 
     <section>
       % for fieldname in form:

wuttaweb-0.5.0/src/wuttaweb/templates/master/configure.mako

@@ -0,0 +1,9 @@
+## -*- coding: utf-8; -*-
+<%inherit file="/configure.mako" />
+
+## NB. /master/configure.mako is only a placeholder.
+## there is no reason to *inherit* from this template;
+## you can always just inherit from /configure.mako
+
+
+${parent.body()}