diff --git a/CHANGELOG.md b/CHANGELOG.md index c974b3a6..4c5304d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,329 +5,6 @@ All notable changes to Tailbone 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.22.7 (2025-02-19) - -### Fix - -- stop using old config for logo image url on login page -- fix warning msg for deprecated Grid param - -## v0.22.6 (2025-02-01) - -### Fix - -- register vue3 form component for products -> make batch - -## v0.22.5 (2024-12-16) - -### Fix - -- whoops this is latest rattail -- require newer rattail lib -- require newer wuttaweb -- let caller request safe HTML literal for rendered grid table - -## v0.22.4 (2024-11-22) - -### Fix - -- avoid error in product search for duplicated key -- use vmodel for confirm password widget input - -## v0.22.3 (2024-11-19) - -### Fix - -- avoid error for trainwreck query when not a customer - -## v0.22.2 (2024-11-18) - -### Fix - -- use local/custom enum for continuum operations -- add basic master view for Product Costs -- show continuum operation type when viewing version history -- always define `app` attr for ViewSupplement -- avoid deprecated import - -## v0.22.1 (2024-11-02) - -### Fix - -- fix submit button for running problem report -- avoid deprecated grid method - -## v0.22.0 (2024-10-22) - -### Feat - -- add support for new ordering batch from parsed file - -### Fix - -- avoid deprecated method to suggest username - -## v0.21.11 (2024-10-03) - -### Fix - -- custom method for adding grid action -- become/stop root should redirect to previous url - -## v0.21.10 (2024-09-15) - -### Fix - -- update project repo links, kallithea -> forgejo -- use better icon for submit button on login page -- wrap notes text for batch view -- expose datasync consumer batch size via configure page - -## v0.21.9 (2024-08-28) - -### Fix - -- render custom attrs in form component tag - -## v0.21.8 (2024-08-28) - -### Fix - -- ignore session kwarg for `MasterView.make_row_grid()` - -## v0.21.7 (2024-08-28) - -### Fix - -- avoid error when form value cannot be obtained - -## v0.21.6 (2024-08-28) - -### Fix - -- avoid error when grid value cannot be obtained - -## v0.21.5 (2024-08-28) - -### Fix - -- set empty string for "-new-" file configure option - -## v0.21.4 (2024-08-26) - -### Fix - -- handle differing email profile keys for appinfo/configure - -## v0.21.3 (2024-08-26) - -### Fix - -- show non-standard config values for app info configure email - -## v0.21.2 (2024-08-26) - -### Fix - -- refactor waterpark base template to use wutta feedback component -- fix input/output file upload feature for configure pages, per oruga -- tweak how grid data translates to Vue template context -- merge filters into main grid template -- add basic wutta view for users -- some fixes for wutta people view -- various fixes for waterpark theme -- avoid deprecated `component` form kwarg - -## v0.21.1 (2024-08-22) - -### Fix - -- misc. bugfixes per recent changes - -## v0.21.0 (2024-08-22) - -### Feat - -- move "most" filtering logic for grid class to wuttaweb -- inherit from wuttaweb templates for home, login pages -- inherit from wuttaweb for AppInfoView, appinfo/configure template -- add "has output file templates" config option for master view - -### Fix - -- change grid reset-view param name to match wuttaweb -- move "searchable columns" grid feature to wuttaweb -- use wuttaweb to get/render csrf token -- inherit from wuttaweb for appinfo/index template -- prefer wuttaweb config for "home redirect to login" feature -- fix master/index template rendering for waterpark theme -- fix spacing for navbar logo/title in waterpark theme - -## v0.20.1 (2024-08-20) - -### Fix - -- fix default filter verbs logic for workorder status - -## v0.20.0 (2024-08-20) - -### Feat - -- add new 'waterpark' theme, based on wuttaweb w/ vue2 + buefy -- refactor templates to simplify base/page/form structure - -### Fix - -- avoid deprecated reference to app db engine - -## v0.19.3 (2024-08-19) - -### Fix - -- add pager stats to all grid vue data (fixes view history) - -## v0.19.2 (2024-08-19) - -### Fix - -- sort on frontend for appinfo package listing grid -- prefer attr over key lookup when getting model values -- replace all occurrences of `component_studly` => `vue_component` - -## v0.19.1 (2024-08-19) - -### Fix - -- fix broken user auth for web API app - -## v0.19.0 (2024-08-18) - -### Feat - -- move multi-column grid sorting logic to wuttaweb -- move single-column grid sorting logic to wuttaweb - -### Fix - -- fix misc. errors in grid template per wuttaweb -- fix broken permission directives in web api startup - -## v0.18.0 (2024-08-16) - -### Feat - -- move "basic" grid pagination logic to wuttaweb -- inherit from wutta base class for Grid -- inherit most logic from wuttaweb, for GridAction - -### Fix - -- avoid route error in user view, when using wutta people view -- fix some more wutta compat for base template - -## v0.17.0 (2024-08-15) - -### Feat - -- use wuttaweb for `get_liburl()` logic - -## v0.16.1 (2024-08-15) - -### Fix - -- improve wutta People view a bit -- update references to `get_class_hierarchy()` -- tweak template for `people/view_profile` per wutta compat - -## v0.16.0 (2024-08-15) - -### Feat - -- add first wutta-based master, for PersonView -- refactor forms/grids/views/templates per wuttaweb compat - -## v0.15.6 (2024-08-13) - -### Fix - -- avoid `before_render` subscriber hook for web API -- simplify verbiage for batch execution panel - -## v0.15.5 (2024-08-09) - -### Fix - -- assign convenience attrs for all views (config, app, enum, model) - -## v0.15.4 (2024-08-09) - -### Fix - -- avoid bug when checking current theme - -## v0.15.3 (2024-08-08) - -### Fix - -- fix timepicker `parseTime()` when value is null - -## v0.15.2 (2024-08-06) - -### Fix - -- use auth handler, avoid legacy calls for role/perm checks - -## v0.15.1 (2024-08-05) - -### Fix - -- move magic `b` template context var to wuttaweb - -## v0.15.0 (2024-08-05) - -### Feat - -- move more subscriber logic to wuttaweb - -### Fix - -- use wuttaweb logic for `util.get_form_data()` - -## v0.14.5 (2024-08-03) - -### Fix - -- use auth handler instead of deprecated auth functions -- avoid duplicate `partial` param when grid reloads data - -## v0.14.4 (2024-07-18) - -### Fix - -- fix more settings persistence bug(s) for datasync/configure -- fix modals for luigi tasks page, per oruga - -## v0.14.3 (2024-07-17) - -### Fix - -- fix auto-collapse title for viewing trainwreck txn -- allow auto-collapse of header when viewing trainwreck txn - -## v0.14.2 (2024-07-15) - -### Fix - -- add null menu handler, for use with API apps - -## v0.14.1 (2024-07-14) - -### Fix - -- update usage of auth handler, per rattail changes -- fix model reference in menu handler -- fix bug when making "integration" menus - ## v0.14.0 (2024-07-14) ### Feat diff --git a/README.md b/README.rst similarity index 56% rename from README.md rename to README.rst index 74c007f6..0cffc62d 100644 --- a/README.md +++ b/README.rst @@ -1,8 +1,10 @@ -# Tailbone +Tailbone +======== Tailbone is an extensible web application based on Rattail. It provides a "back-office network environment" (BONE) for use in managing retail data. -Please see Rattail's [home page](http://rattailproject.org/) for more -information. +Please see Rattail's `home page`_ for more information. + +.. _home page: http://rattailproject.org/ diff --git a/docs/api/util.rst b/docs/api/util.rst deleted file mode 100644 index 35e66ed3..00000000 --- a/docs/api/util.rst +++ /dev/null @@ -1,6 +0,0 @@ - -``tailbone.util`` -================= - -.. automodule:: tailbone.util - :members: diff --git a/docs/conf.py b/docs/conf.py index ade4c92a..52e384f5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,10 +27,10 @@ templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] intersphinx_mapping = { - 'rattail': ('https://docs.wuttaproject.org/rattail/', None), + 'rattail': ('https://rattailproject.org/docs/rattail/', None), 'webhelpers2': ('https://webhelpers2.readthedocs.io/en/latest/', None), - 'wuttaweb': ('https://docs.wuttaproject.org/wuttaweb/', None), - 'wuttjamaican': ('https://docs.wuttaproject.org/wuttjamaican/', None), + 'wuttaweb': ('https://rattailproject.org/docs/wuttaweb/', None), + 'wuttjamaican': ('https://rattailproject.org/docs/wuttjamaican/', None), } # allow todo entries to show up diff --git a/docs/index.rst b/docs/index.rst index d964086f..3ca6d4e2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -52,7 +52,6 @@ Package API: api/grids.core api/progress api/subscribers - api/util api/views/batch api/views/batch.vendorcatalog api/views/core diff --git a/pyproject.toml b/pyproject.toml index a7214a8e..de65655a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,9 +6,9 @@ build-backend = "hatchling.build" [project] name = "Tailbone" -version = "0.22.7" +version = "0.14.0" description = "Backoffice Web Application for Rattail" -readme = "README.md" +readme = "README.rst" authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] license = {text = "GNU GPL v3+"} classifiers = [ @@ -53,13 +53,13 @@ dependencies = [ "pyramid_mako", "pyramid_retry", "pyramid_tm", - "rattail[db,bouncer]>=0.20.1", + "rattail[db,bouncer]>=0.16.0", "sa-filters", "simplejson", "transaction", "waitress", "WebHelpers2", - "WuttaWeb>=0.21.0", + "WuttaWeb>=0.2.0", "zope.sqlalchemy>=1.5", ] @@ -84,9 +84,9 @@ tailbone = "tailbone.config:ConfigExtension" [project.urls] Homepage = "https://rattailproject.org" -Repository = "https://forgejo.wuttaproject.org/rattail/tailbone" -Issues = "https://forgejo.wuttaproject.org/rattail/tailbone/issues" -Changelog = "https://forgejo.wuttaproject.org/rattail/tailbone/src/branch/master/CHANGELOG.md" +Repository = "https://kallithea.rattailproject.org/rattail-project/tailbone" +Issues = "https://redmine.rattailproject.org/projects/tailbone/issues" +Changelog = "https://kallithea.rattailproject.org/rattail-project/tailbone/files/master/CHANGELOG.md" [tool.commitizen] diff --git a/tailbone/api/auth.py b/tailbone/api/auth.py index a710e30d..1b347b21 100644 --- a/tailbone/api/auth.py +++ b/tailbone/api/auth.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar +# Copyright © 2010-2023 Lance Edgar # # This file is part of Rattail. # @@ -24,6 +24,8 @@ Tailbone Web API - Auth Views """ +from rattail.db.auth import set_user_password + from cornice import Service from tailbone.api import APIView, api @@ -40,10 +42,11 @@ class AuthenticationView(APIView): This will establish a server-side web session for the user if none exists. Note that this also resets the user's session timer. """ - data = {'ok': True, 'permissions': []} + data = {'ok': True} if self.request.user: data['user'] = self.get_user_info(self.request.user) - data['permissions'] = list(self.request.user_permissions) + + data['permissions'] = list(self.request.tailbone_cached_permissions) # background color may be set per-request, by some apps if hasattr(self.request, 'background_color') and self.request.background_color: @@ -173,8 +176,7 @@ class AuthenticationView(APIView): return {'error': "The current/old password you provided is incorrect"} # okay then, set new password - auth = self.app.get_auth_handler() - auth.set_user_password(self.request.user, data['new_password']) + set_user_password(self.request.user, data['new_password']) return { 'ok': True, 'user': self.get_user_info(self.request.user), diff --git a/tailbone/api/batch/receiving.py b/tailbone/api/batch/receiving.py index b23bff55..daa4290f 100644 --- a/tailbone/api/batch/receiving.py +++ b/tailbone/api/batch/receiving.py @@ -29,7 +29,8 @@ import logging import humanize import sqlalchemy as sa -from rattail.db.model import PurchaseBatch, PurchaseBatchRow +from rattail.db import model +from rattail.util import pretty_quantity from cornice import Service from deform import widget as dfwidget @@ -44,7 +45,7 @@ log = logging.getLogger(__name__) class ReceivingBatchViews(APIBatchView): - model_class = PurchaseBatch + model_class = model.PurchaseBatch default_handler_spec = 'rattail.batch.purchase:PurchaseBatchHandler' route_prefix = 'receivingbatchviews' permission_prefix = 'receiving' @@ -54,8 +55,7 @@ class ReceivingBatchViews(APIBatchView): supports_execute = True def base_query(self): - model = self.app.model - query = super().base_query() + query = super(ReceivingBatchViews, self).base_query() query = query.filter(model.PurchaseBatch.mode == self.enum.PURCHASE_BATCH_MODE_RECEIVING) return query @@ -85,7 +85,7 @@ class ReceivingBatchViews(APIBatchView): # assume "receive from PO" if given a PO key if data.get('purchase_key'): - data['workflow'] = 'from_po' + data['receiving_workflow'] = 'from_po' return super().create_object(data) @@ -120,7 +120,6 @@ class ReceivingBatchViews(APIBatchView): return self._get(obj=batch) def eligible_purchases(self): - model = self.app.model uuid = self.request.params.get('vendor_uuid') vendor = self.Session.get(model.Vendor, uuid) if uuid else None if not vendor: @@ -177,7 +176,7 @@ class ReceivingBatchViews(APIBatchView): class ReceivingBatchRowViews(APIBatchRowView): - model_class = PurchaseBatchRow + model_class = model.PurchaseBatchRow default_handler_spec = 'rattail.batch.purchase:PurchaseBatchHandler' route_prefix = 'receiving.rows' permission_prefix = 'receiving' @@ -186,8 +185,7 @@ class ReceivingBatchRowViews(APIBatchRowView): supports_quick_entry = True def make_filter_spec(self): - model = self.app.model - filters = super().make_filter_spec() + filters = super(ReceivingBatchRowViews, self).make_filter_spec() if filters: # must translate certain convenience filters @@ -298,11 +296,11 @@ class ReceivingBatchRowViews(APIBatchRowView): return filters def normalize(self, row): - data = super().normalize(row) - model = self.app.model + data = super(ReceivingBatchRowViews, self).normalize(row) batch = row.batch - prodder = self.app.get_products_handler() + app = self.get_rattail_app() + prodder = app.get_products_handler() data['product_uuid'] = row.product_uuid data['item_id'] = row.item_id @@ -377,7 +375,7 @@ class ReceivingBatchRowViews(APIBatchRowView): if accounted_for: # some product accounted for; button should receive "remainder" only if remainder: - remainder = self.app.render_quantity(remainder) + remainder = pretty_quantity(remainder) data['quick_receive_quantity'] = remainder data['quick_receive_text'] = "Receive Remainder ({} {})".format( remainder, data['unit_uom']) @@ -388,7 +386,7 @@ class ReceivingBatchRowViews(APIBatchRowView): else: # nothing yet accounted for, button should receive "all" if not remainder: log.warning("quick receive remainder is empty for row %s", row.uuid) - remainder = self.app.render_quantity(remainder) + remainder = pretty_quantity(remainder) data['quick_receive_quantity'] = remainder data['quick_receive_text'] = "Receive ALL ({} {})".format( remainder, data['unit_uom']) @@ -416,7 +414,7 @@ class ReceivingBatchRowViews(APIBatchRowView): data['received_alert'] = None if self.batch_handler.get_units_confirmed(row): msg = "You have already received some of this product; last update was {}.".format( - humanize.naturaltime(self.app.make_utc() - row.modified)) + humanize.naturaltime(app.make_utc() - row.modified)) data['received_alert'] = msg return data @@ -425,8 +423,6 @@ class ReceivingBatchRowViews(APIBatchRowView): """ View which handles "receiving" against a particular batch row. """ - model = self.app.model - # first do basic input validation schema = ReceiveRow().bind(session=self.Session()) form = forms.Form(schema=schema, request=self.request) diff --git a/tailbone/api/core.py b/tailbone/api/core.py index 0d8eec32..b278d4af 100644 --- a/tailbone/api/core.py +++ b/tailbone/api/core.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar +# Copyright © 2010-2023 Lance Edgar # # This file is part of Rattail. # @@ -102,7 +102,7 @@ class APIView(View): auth = app.get_auth_handler() # basic / default info - is_admin = auth.user_is_admin(user) + is_admin = user.is_admin() employee = app.get_employee(user) info = { 'uuid': user.uuid, diff --git a/tailbone/api/master.py b/tailbone/api/master.py index 551d6428..2d17339e 100644 --- a/tailbone/api/master.py +++ b/tailbone/api/master.py @@ -26,6 +26,7 @@ Tailbone Web API - Master View import json +from rattail.config import parse_bool from rattail.db.util import get_fieldnames from cornice import resource, Service @@ -184,7 +185,7 @@ class APIMasterView(APIView): if sortcol: spec = { 'field': sortcol.field_name, - 'direction': 'asc' if self.config.parse_bool(self.request.params['ascending']) else 'desc', + 'direction': 'asc' if parse_bool(self.request.params['ascending']) else 'desc', } if sortcol.model_name: spec['model'] = sortcol.model_name diff --git a/tailbone/app.py b/tailbone/app.py index d2d0c5ef..b7220703 100644 --- a/tailbone/app.py +++ b/tailbone/app.py @@ -25,15 +25,19 @@ Application Entry Point """ import os +import warnings +import sqlalchemy as sa from sqlalchemy.orm import sessionmaker, scoped_session from wuttjamaican.util import parse_list from rattail.config import make_config from rattail.exceptions import ConfigurationError +from rattail.db.types import GPCType from pyramid.config import Configurator +from pyramid.authentication import SessionAuthenticationPolicy from zope.sqlalchemy import register import tailbone.db @@ -62,20 +66,9 @@ def make_rattail_config(settings): # nb. this is for compaibility with wuttaweb settings['wutta_config'] = rattail_config - # must import all sqlalchemy models before things get rolling, - # otherwise can have errors about continuum TransactionMeta class - # not yet mapped, when relevant pages are first requested... - # cf. https://docs.pylonsproject.org/projects/pyramid_cookbook/en/latest/database/sqlalchemy.html#importing-all-sqlalchemy-models - # hat tip to https://stackoverflow.com/a/59241485 - if getattr(rattail_config, 'tempmon_engine', None): - from rattail_tempmon.db import model as tempmon_model, Session as TempmonSession - tempmon_session = TempmonSession() - tempmon_session.query(tempmon_model.Appliance).first() - tempmon_session.close() - # configure database sessions - if hasattr(rattail_config, 'appdb_engine'): - tailbone.db.Session.configure(bind=rattail_config.appdb_engine) + if hasattr(rattail_config, 'rattail_engine'): + tailbone.db.Session.configure(bind=rattail_config.rattail_engine) if hasattr(rattail_config, 'trainwreck_engine'): tailbone.db.TrainwreckSession.configure(bind=rattail_config.trainwreck_engine) if hasattr(rattail_config, 'tempmon_engine'): @@ -196,16 +189,9 @@ def make_pyramid_config(settings, configure_csrf=True): for spec in includes: config.include(spec) - # add some permissions magic - config.add_directive('add_wutta_permission_group', - 'wuttaweb.auth.add_permission_group') - config.add_directive('add_wutta_permission', - 'wuttaweb.auth.add_permission') - # TODO: deprecate / remove these - config.add_directive('add_tailbone_permission_group', - 'wuttaweb.auth.add_permission_group') - config.add_directive('add_tailbone_permission', - 'wuttaweb.auth.add_permission') + # Add some permissions magic. + config.add_directive('add_tailbone_permission_group', 'tailbone.auth.add_permission_group') + config.add_directive('add_tailbone_permission', 'tailbone.auth.add_permission') # and some similar magic for certain master views config.add_directive('add_tailbone_index_page', 'tailbone.app.add_index_page') @@ -332,8 +318,7 @@ def main(global_config, **settings): """ This function returns a Pyramid WSGI application. """ - settings.setdefault('mako.directories', ['tailbone:templates', - 'wuttaweb:templates']) + settings.setdefault('mako.directories', ['tailbone:templates']) rattail_config = make_rattail_config(settings) pyramid_config = make_pyramid_config(settings) pyramid_config.include('tailbone') diff --git a/tailbone/auth.py b/tailbone/auth.py index 95bf90ba..5a35caa6 100644 --- a/tailbone/auth.py +++ b/tailbone/auth.py @@ -27,28 +27,29 @@ Authentication & Authorization import logging import re -from wuttjamaican.util import UNSPECIFIED +from rattail.util import prettify, NOTSET +from zope.interface import implementer +from pyramid.authentication import SessionAuthenticationHelper +from pyramid.request import RequestLocalCache from pyramid.security import remember, forget -from wuttaweb.auth import WuttaSecurityPolicy from tailbone.db import Session log = logging.getLogger(__name__) -def login_user(request, user, timeout=UNSPECIFIED): +def login_user(request, user, timeout=NOTSET): """ Perform the steps necessary to login the given user. Note that this returns a ``headers`` dict which you should pass to the redirect. """ - config = request.rattail_config - app = config.get_app() + app = request.rattail_config.get_app() user.record_event(app.enum.USER_EVENT_LOGIN) headers = remember(request, user.uuid) - if timeout is UNSPECIFIED: - timeout = session_timeout_for_user(config, user) + if timeout is NOTSET: + timeout = session_timeout_for_user(user) log.debug("setting session timeout for '{}' to {}".format(user.username, timeout)) set_session_timeout(request, timeout) return headers @@ -69,18 +70,15 @@ def logout_user(request): return headers -def session_timeout_for_user(config, user): +def session_timeout_for_user(user): """ Returns the "max" session timeout for the user, according to roles """ - app = config.get_app() - auth = app.get_auth_handler() + from rattail.db.auth import authenticated_role - authenticated = auth.get_role_authenticated(Session()) - roles = user.roles + [authenticated] + roles = user.roles + [authenticated_role(Session())] timeouts = [role.session_timeout for role in roles if role.session_timeout is not None] - if timeouts and 0 not in timeouts: return max(timeouts) @@ -92,12 +90,12 @@ def set_session_timeout(request, timeout): request.session['_timeout'] = timeout or None -class TailboneSecurityPolicy(WuttaSecurityPolicy): +class TailboneSecurityPolicy: - def __init__(self, db_session=None, api_mode=False, **kwargs): - kwargs['db_session'] = db_session or Session() - super().__init__(**kwargs) + def __init__(self, api_mode=False): self.api_mode = api_mode + self.session_helper = SessionAuthenticationHelper() + self.identity_cache = RequestLocalCache(self.load_identity) def load_identity(self, request): config = request.registry.settings.get('rattail_config') @@ -113,7 +111,7 @@ class TailboneSecurityPolicy(WuttaSecurityPolicy): if match: token = match.group(1) auth = app.get_auth_handler() - user = auth.authenticate_user_token(self.db_session, token) + user = auth.authenticate_user_token(Session(), token) if not user: @@ -124,10 +122,63 @@ class TailboneSecurityPolicy(WuttaSecurityPolicy): # fetch user object from db model = app.model - user = self.db_session.get(model.User, uuid) + user = Session.get(model.User, uuid) if not user: return # this user is responsible for data changes in current request - self.db_session.set_continuum_user(user) + Session().set_continuum_user(user) return user + + def identity(self, request): + return self.identity_cache.get_or_create(request) + + def authenticated_userid(self, request): + user = self.identity(request) + if user is not None: + return user.uuid + + def remember(self, request, userid, **kw): + return self.session_helper.remember(request, userid, **kw) + + def forget(self, request, **kw): + return self.session_helper.forget(request, **kw) + + def permits(self, request, context, permission): + # nb. root user can do anything + if request.is_root: + return True + + config = request.registry.settings.get('rattail_config') + app = config.get_app() + auth = app.get_auth_handler() + + user = self.identity(request) + return auth.has_permission(Session(), user, permission) + + +def add_permission_group(config, key, label=None, overwrite=True): + """ + Add a permission group to the app configuration. + """ + def action(): + perms = config.get_settings().get('tailbone_permissions', {}) + if key not in perms or overwrite: + group = perms.setdefault(key, {'key': key}) + group['label'] = label or prettify(key) + config.add_settings({'tailbone_permissions': perms}) + config.action(None, action) + + +def add_permission(config, groupkey, key, label=None): + """ + Add a permission to the app configuration. + """ + def action(): + perms = config.get_settings().get('tailbone_permissions', {}) + group = perms.setdefault(groupkey, {'key': groupkey}) + group.setdefault('label', prettify(groupkey)) + perm = group.setdefault('perms', {}).setdefault(key, {'key': key}) + perm['label'] = label or prettify(key) + config.add_settings({'tailbone_permissions': perms}) + config.action(None, action) diff --git a/tailbone/config.py b/tailbone/config.py index 8392ba0a..ce1691ae 100644 --- a/tailbone/config.py +++ b/tailbone/config.py @@ -26,14 +26,13 @@ Rattail config extension for Tailbone import warnings -from wuttjamaican.conf import WuttaConfigExtension - +from rattail.config import ConfigExtension as BaseExtension from rattail.db.config import configure_session from tailbone.db import Session -class ConfigExtension(WuttaConfigExtension): +class ConfigExtension(BaseExtension): """ Rattail config extension for Tailbone. Does the following: diff --git a/tailbone/diffs.py b/tailbone/diffs.py index 2e582b15..98253c57 100644 --- a/tailbone/diffs.py +++ b/tailbone/diffs.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar +# Copyright © 2010-2023 Lance Edgar # # This file is part of Rattail. # @@ -270,21 +270,9 @@ class VersionDiff(Diff): for field in self.fields: values[field] = {'before': self.render_old_value(field), 'after': self.render_new_value(field)} - - operation = None - if self.version.operation_type == continuum.Operation.INSERT: - operation = 'INSERT' - elif self.version.operation_type == continuum.Operation.UPDATE: - operation = 'UPDATE' - elif self.version.operation_type == continuum.Operation.DELETE: - operation = 'DELETE' - else: - operation = self.version.operation_type - return { 'key': id(self.version), 'model_title': self.title, - 'operation': operation, 'diff_class': self.nature, 'fields': self.fields, 'values': values, diff --git a/tailbone/forms/core.py b/tailbone/forms/core.py index 4024557b..11d489a7 100644 --- a/tailbone/forms/core.py +++ b/tailbone/forms/core.py @@ -35,7 +35,7 @@ from sqlalchemy import orm from sqlalchemy.ext.associationproxy import AssociationProxy, ASSOCIATION_PROXY from wuttjamaican.util import UNSPECIFIED -from rattail.util import pretty_boolean +from rattail.util import prettify, pretty_boolean from rattail.db.util import get_fieldnames import colander @@ -47,10 +47,8 @@ from pyramid_deform import SessionFileUploadTempStore from pyramid.renderers import render from webhelpers2.html import tags, HTML -from wuttaweb.util import FieldList, get_form_data, make_json_safe - from tailbone.db import Session -from tailbone.util import raw_datetime, render_markdown +from tailbone.util import raw_datetime, get_form_data, render_markdown from tailbone.forms import types from tailbone.forms.widgets import (ReadonlyWidget, PlainDateWidget, JQueryDateWidget, JQueryTimeWidget, @@ -328,7 +326,7 @@ class Form(object): """ Base class for all forms. """ - save_label = "Submit" + save_label = "Save" update_label = "Save" show_cancel = True auto_disable = True @@ -339,12 +337,10 @@ class Form(object): model_instance=None, model_class=None, appstruct=UNSPECIFIED, nodes={}, enums={}, labels={}, assume_local_times=False, renderers=None, renderer_kwargs={}, hidden={}, widgets={}, defaults={}, validators={}, required={}, helptext={}, focus_spec=None, - action_url=None, cancel_url=None, - vue_tagname=None, + action_url=None, cancel_url=None, component='tailbone-form', vuejs_component_kwargs=None, vuejs_field_converters={}, json_data={}, included_templates={}, # TODO: ugh this is getting out hand! can_edit_help=False, edit_help_url=None, route_prefix=None, - **kwargs ): self.fields = None if fields is not None: @@ -382,17 +378,7 @@ class Form(object): self.focus_spec = focus_spec self.action_url = action_url self.cancel_url = cancel_url - - # vue_tagname - self.vue_tagname = vue_tagname - if not self.vue_tagname and kwargs.get('component'): - warnings.warn("component kwarg is deprecated for Form(); " - "please use vue_tagname param instead", - DeprecationWarning, stacklevel=2) - self.vue_tagname = kwargs['component'] - if not self.vue_tagname: - self.vue_tagname = 'tailbone-form' - + self.component = component self.vuejs_component_kwargs = vuejs_component_kwargs or {} self.vuejs_field_converters = vuejs_field_converters or {} self.json_data = json_data or {} @@ -401,59 +387,13 @@ class Form(object): self.edit_help_url = edit_help_url self.route_prefix = route_prefix - self.button_icon_submit = kwargs.get('button_icon_submit', 'save') - def __iter__(self): return iter(self.fields) - @property - def vue_component(self): - """ - String name for the Vue component, e.g. ``'TailboneGrid'``. - - This is a generated value based on :attr:`vue_tagname`. - """ - words = self.vue_tagname.split('-') - return ''.join([word.capitalize() for word in words]) - - @property - def component(self): - """ - DEPRECATED - use :attr:`vue_tagname` instead. - """ - warnings.warn("Form.component is deprecated; " - "please use vue_tagname instead", - DeprecationWarning, stacklevel=2) - return self.vue_tagname - @property def component_studly(self): - """ - DEPRECATED - use :attr:`vue_component` instead. - """ - warnings.warn("Form.component_studly is deprecated; " - "please use vue_component instead", - DeprecationWarning, stacklevel=2) - return self.vue_component - - def get_button_label_submit(self): - """ """ - if hasattr(self, '_button_label_submit'): - return self._button_label_submit - - label = getattr(self, 'submit_label', None) - if label: - return label - - return self.save_label - - def set_button_label_submit(self, value): - """ """ - self._button_label_submit = value - - # wutta compat - button_label_submit = property(get_button_label_submit, - set_button_label_submit) + words = self.component.split('-') + return ''.join([word.capitalize() for word in words]) def __contains__(self, item): return item in self.fields @@ -630,9 +570,7 @@ class Form(object): self.schema[key].title = label def get_label(self, key): - config = self.request.rattail_config - app = config.get_app() - return self.labels.get(key, app.make_title(key)) + return self.labels.get(key, prettify(key)) def set_readonly(self, key, readonly=True): if readonly: @@ -863,10 +801,6 @@ class Form(object): DeprecationWarning, stacklevel=2) return self.render_deform(**kwargs) - def get_deform(self): - """ """ - return self.make_deform_form() - def make_deform_form(self): if not hasattr(self, 'deform_form'): @@ -905,11 +839,6 @@ class Form(object): return self.deform_form - def render_vue_template(self, template='/forms/deform.mako', **context): - """ """ - output = self.render_deform(template=template, **context) - return HTML.literal(output) - def render_deform(self, dform=None, template=None, **kwargs): if not template: template = '/forms/deform.mako' @@ -932,8 +861,8 @@ class Form(object): context.setdefault('form_kwargs', {}) # TODO: deprecate / remove the latter option here if self.auto_disable_save or self.auto_disable: - context['form_kwargs'].setdefault('ref', self.vue_component) - context['form_kwargs']['@submit'] = 'submit{}'.format(self.vue_component) + context['form_kwargs'].setdefault('ref', self.component_studly) + context['form_kwargs']['@submit'] = 'submit{}'.format(self.component_studly) if self.focus_spec: context['form_kwargs']['data-focus'] = self.focus_spec context['request'] = self.request @@ -945,13 +874,12 @@ class Form(object): return dict([(field, self.get_label(field)) for field in self]) - def get_field_markdowns(self, session=None): + def get_field_markdowns(self): app = self.request.rattail_config.get_app() model = app.model - session = session or Session() if not hasattr(self, 'field_markdowns'): - infos = session.query(model.TailboneFieldInfo)\ + infos = Session.query(model.TailboneFieldInfo)\ .filter(model.TailboneFieldInfo.route_prefix == self.route_prefix)\ .all() self.field_markdowns = dict([(info.field_name, info.markdown_text) @@ -959,18 +887,6 @@ class Form(object): return self.field_markdowns - def get_vue_field_value(self, key): - """ """ - if key not in self.fields: - return - - dform = self.get_deform() - if key not in dform: - return - - field = dform[key] - return make_json_safe(field.cstruct) - def get_vuejs_model_value(self, field): """ This method must return "raw" JS which will be assigned as the initial @@ -1037,11 +953,7 @@ class Form(object): def set_vuejs_component_kwargs(self, **kwargs): self.vuejs_component_kwargs.update(kwargs) - def render_vue_tag(self, **kwargs): - """ """ - return self.render_vuejs_component(**kwargs) - - def render_vuejs_component(self, **kwargs): + def render_vuejs_component(self): """ Render the Vue.js component HTML for the form. @@ -1052,11 +964,10 @@ class Form(object): """ - kw = dict(self.vuejs_component_kwargs) - kw.update(kwargs) + kwargs = dict(self.vuejs_component_kwargs) if self.can_edit_help: - kw.setdefault(':configure-fields-help', 'configureFieldsHelp') - return HTML.tag(self.vue_tagname, **kw) + kwargs.setdefault(':configure-fields-help', 'configureFieldsHelp') + return HTML.tag(self.component, **kwargs) def set_json_data(self, key, value): """ @@ -1082,12 +993,7 @@ class Form(object): templates.append(HTML.literal(render(template, context))) return HTML.literal('\n').join(templates) - def render_vue_field(self, fieldname, **kwargs): - """ """ - return self.render_field_complete(fieldname, **kwargs) - - def render_field_complete(self, fieldname, bfield_attrs={}, - session=None): + def render_field_complete(self, fieldname, bfield_attrs={}): """ Render the given field completely, i.e. with ```` wrapper. Note that this is meant to render *editable* fields, @@ -1105,7 +1011,7 @@ class Form(object): if self.field_visible(fieldname): label = self.get_label(fieldname) - markdowns = self.get_field_markdowns(session=session) + markdowns = self.get_field_markdowns() # these attrs will be for the (*not* the widget) attrs = { @@ -1224,18 +1130,6 @@ class Form(object): # TODO: again, why does serialize() not return literal? return HTML.literal(field.serialize()) - # TODO: this was copied from wuttaweb; can remove when we align - # Form class structure - def render_vue_finalize(self): - """ """ - set_data = f"{self.vue_component}.data = function() {{ return {self.vue_component}Data }}" - make_component = f"Vue.component('{self.vue_tagname}', {self.vue_component})" - return HTML.tag('script', c=['\n', - HTML.literal(set_data), - '\n', - HTML.literal(make_component), - '\n']) - def render_field_readonly(self, field_name, **kwargs): """ Render the given field completely, but in read-only fashion. @@ -1375,19 +1269,12 @@ class Form(object): def obtain_value(self, record, field_name): if record: - - if isinstance(record, dict): - return record[field_name] - - try: - return getattr(record, field_name) - except AttributeError: - pass - try: return record[field_name] + except KeyError: + return None except TypeError: - pass + return getattr(record, field_name, None) # TODO: is this always safe to do? elif self.defaults and field_name in self.defaults: @@ -1441,6 +1328,30 @@ class Form(object): return False +class FieldList(list): + """ + Convenience wrapper for a form's field list. + """ + + def insert_before(self, field, newfield): + if field in self: + i = self.index(field) + self.insert(i, newfield) + else: + log.warning("field '%s' not found, will append new field: %s", + field, newfield) + self.append(newfield) + + def insert_after(self, field, newfield): + if field in self: + i = self.index(field) + self.insert(i + 1, newfield) + else: + log.warning("field '%s' not found, will append new field: %s", + field, newfield) + self.append(newfield) + + @colander.deferred def upload_widget(node, kw): request = kw['request'] diff --git a/tailbone/grids/core.py b/tailbone/grids/core.py index 56b97b86..b4610a18 100644 --- a/tailbone/grids/core.py +++ b/tailbone/grids/core.py @@ -24,15 +24,13 @@ Core Grid Classes """ -import inspect -import logging -import warnings from urllib.parse import urlencode +import warnings +import logging import sqlalchemy as sa from sqlalchemy import orm -from wuttjamaican.util import UNSPECIFIED from rattail.db.types import GPCType from rattail.util import prettify, pretty_boolean @@ -40,8 +38,6 @@ from pyramid.renderers import render from webhelpers2.html import HTML, tags from paginate_sqlalchemy import SqlalchemyOrmPage -from wuttaweb.grids import Grid as WuttaGrid, GridAction as WuttaGridAction, SortInfo -from wuttaweb.util import FieldList from . import filters as gridfilters from tailbone.db import Session from tailbone.util import raw_datetime @@ -50,17 +46,23 @@ from tailbone.util import raw_datetime log = logging.getLogger(__name__) -class Grid(WuttaGrid): +class FieldList(list): + """ + Convenience wrapper for a field list. """ - Base class for all grids. - This is now a subclass of - :class:`wuttaweb:wuttaweb.grids.base.Grid`, and exists to add - customizations which have traditionally been part of Tailbone. + def insert_before(self, field, newfield): + i = self.index(field) + self.insert(i, newfield) - Some of these customizations are still undocumented. Some will - eventually be moved to the upstream/parent class, and possibly - some will be removed outright. What docs we have, are shown here. + def insert_after(self, field, newfield): + i = self.index(field) + self.insert(i + 1, newfield) + + +class Grid: + """ + Core grid class. In sore need of documentation. .. _Buefy docs: https://buefy.org/documentation/table/ @@ -183,92 +185,31 @@ class Grid(WuttaGrid): grid.row_uuid_getter = fake_uuid """ - def __init__( - self, - request, - key=None, - data=None, - width='auto', - model_title=None, - model_title_plural=None, - enums={}, - assume_local_times=False, - invisible=[], - raw_renderers={}, - extra_row_class=None, - url='#', - use_byte_string_filters=False, - checkboxes=False, - checked=None, - check_handler=None, - check_all_handler=None, - checkable=None, - row_uuid_getter=None, - clicking_row_checks_box=False, - click_handlers=None, - main_actions=[], - more_actions=[], - delete_speedbump=False, - ajax_data_url=None, - expose_direct_link=False, - **kwargs, - ): - if 'component' in kwargs: - warnings.warn("component param is deprecated for Grid(); " - "please use vue_tagname param instead", - DeprecationWarning, stacklevel=2) - kwargs.setdefault('vue_tagname', kwargs.pop('component')) + def __init__(self, key, data, columns=None, width='auto', request=None, + model_class=None, model_title=None, model_title_plural=None, + enums={}, labels={}, assume_local_times=False, renderers={}, invisible=[], + raw_renderers={}, + extra_row_class=None, linked_columns=[], url='#', + joiners={}, filterable=False, filters={}, use_byte_string_filters=False, + searchable={}, + sortable=False, sorters={}, default_sortkey=None, default_sortdir='asc', + pageable=False, default_pagesize=None, default_page=1, + checkboxes=False, checked=None, check_handler=None, check_all_handler=None, + checkable=None, row_uuid_getter=None, + clicking_row_checks_box=False, click_handlers=None, + main_actions=[], more_actions=[], delete_speedbump=False, + ajax_data_url=None, component='tailbone-grid', + expose_direct_link=False, + **kwargs): - if 'default_sortkey' in kwargs: - warnings.warn("default_sortkey param is deprecated for Grid(); " - "please use sort_defaults param instead", - DeprecationWarning, stacklevel=2) - if 'default_sortdir' in kwargs: - warnings.warn("default_sortdir param is deprecated for Grid(); " - "please use sort_defaults param instead", - DeprecationWarning, stacklevel=2) - if 'default_sortkey' in kwargs or 'default_sortdir' in kwargs: - sortkey = kwargs.pop('default_sortkey', None) - sortdir = kwargs.pop('default_sortdir', 'asc') - if sortkey: - kwargs.setdefault('sort_defaults', [(sortkey, sortdir)]) - - if 'pageable' in kwargs: - warnings.warn("pageable param is deprecated for Grid(); " - "please use paginated param instead", - DeprecationWarning, stacklevel=2) - kwargs.setdefault('paginated', kwargs.pop('pageable')) - - if 'default_pagesize' in kwargs: - warnings.warn("default_pagesize param is deprecated for Grid(); " - "please use pagesize param instead", - DeprecationWarning, stacklevel=2) - kwargs.setdefault('pagesize', kwargs.pop('default_pagesize')) - - if 'default_page' in kwargs: - warnings.warn("default_page param is deprecated for Grid(); " - "please use page param instead", - DeprecationWarning, stacklevel=2) - kwargs.setdefault('page', kwargs.pop('default_page')) - - if 'searchable' in kwargs: - warnings.warn("searchable param is deprecated for Grid(); " - "please use searchable_columns param instead", - DeprecationWarning, stacklevel=2) - kwargs.setdefault('searchable_columns', kwargs.pop('searchable')) - - # TODO: this should not be needed once all templates correctly - # reference grid.vue_component etc. - kwargs.setdefault('vue_tagname', 'tailbone-grid') - - # nb. these must be set before super init, as they are - # referenced when constructing filters - self.assume_local_times = assume_local_times - self.use_byte_string_filters = use_byte_string_filters - - kwargs['key'] = key - kwargs['data'] = data - super().__init__(request, **kwargs) + self.key = key + self.data = data + self.columns = FieldList(columns) if columns is not None else None + self.width = width + self.request = request + self.model_class = model_class + if self.model_class and self.columns is None: + self.columns = self.make_columns() self.model_title = model_title if not self.model_title and self.model_class and hasattr(self.model_class, 'get_model_title'): @@ -281,13 +222,32 @@ class Grid(WuttaGrid): if not self.model_title_plural: self.model_title_plural = '{}s'.format(self.model_title) - self.width = width self.enums = enums or {} - self.renderers = self.make_default_renderers(self.renderers) + + self.labels = labels or {} + self.assume_local_times = assume_local_times + self.renderers = self.make_default_renderers(renderers or {}) self.raw_renderers = raw_renderers or {} self.invisible = invisible or [] self.extra_row_class = extra_row_class + self.linked_columns = linked_columns or [] self.url = url + self.joiners = joiners or {} + + self.filterable = filterable + self.use_byte_string_filters = use_byte_string_filters + self.filters = self.make_filters(filters) + + self.searchable = searchable or {} + + self.sortable = sortable + self.sorters = self.make_sorters(sorters) + self.default_sortkey = default_sortkey + self.default_sortdir = default_sortdir + + self.pageable = pageable + self.default_pagesize = default_pagesize + self.default_page = default_page self.checkboxes = checkboxes self.checked = checked @@ -301,104 +261,43 @@ class Grid(WuttaGrid): self.click_handlers = click_handlers or {} + self.main_actions = main_actions or [] + self.more_actions = more_actions or [] self.delete_speedbump = delete_speedbump if ajax_data_url: self.ajax_data_url = ajax_data_url elif self.request: - self.ajax_data_url = self.request.path_url + self.ajax_data_url = self.request.current_route_url(_query=None) else: self.ajax_data_url = '' - self.main_actions = main_actions or [] - if self.main_actions: - warnings.warn("main_actions param is deprecated for Grdi(); " - "please use actions param instead", - DeprecationWarning, stacklevel=2) - self.actions.extend(self.main_actions) - self.more_actions = more_actions or [] - if self.more_actions: - warnings.warn("more_actions param is deprecated for Grdi(); " - "please use actions param instead", - DeprecationWarning, stacklevel=2) - self.actions.extend(self.more_actions) - + self.component = component self.expose_direct_link = expose_direct_link self._whgrid_kwargs = kwargs - @property - def component(self): - """ """ - warnings.warn("Grid.component is deprecated; " - "please use vue_tagname instead", - DeprecationWarning, stacklevel=2) - return self.vue_tagname - @property def component_studly(self): - """ """ - warnings.warn("Grid.component_studly is deprecated; " - "please use vue_component instead", - DeprecationWarning, stacklevel=2) - return self.vue_component + words = self.component.split('-') + return ''.join([word.capitalize() for word in words]) - def get_default_sortkey(self): - """ """ - warnings.warn("Grid.default_sortkey is deprecated; " - "please use Grid.sort_defaults instead", - DeprecationWarning, stacklevel=2) - if self.sort_defaults: - return self.sort_defaults[0].sortkey + def make_columns(self): + """ + Return a default list of columns, based on :attr:`model_class`. + """ + if not self.model_class: + raise ValueError("Must define model_class to use make_columns()") - def set_default_sortkey(self, value): - """ """ - warnings.warn("Grid.default_sortkey is deprecated; " - "please use Grid.sort_defaults instead", - DeprecationWarning, stacklevel=2) - if self.sort_defaults: - info = self.sort_defaults[0] - self.sort_defaults[0] = SortInfo(value, info.sortdir) - else: - self.sort_defaults = [SortInfo(value, 'asc')] + mapper = orm.class_mapper(self.model_class) + return [prop.key for prop in mapper.iterate_properties] - default_sortkey = property(get_default_sortkey, set_default_sortkey) - - def get_default_sortdir(self): - """ """ - warnings.warn("Grid.default_sortdir is deprecated; " - "please use Grid.sort_defaults instead", - DeprecationWarning, stacklevel=2) - if self.sort_defaults: - return self.sort_defaults[0].sortdir - - def set_default_sortdir(self, value): - """ """ - warnings.warn("Grid.default_sortdir is deprecated; " - "please use Grid.sort_defaults instead", - DeprecationWarning, stacklevel=2) - if self.sort_defaults: - info = self.sort_defaults[0] - self.sort_defaults[0] = SortInfo(info.sortkey, value) - else: - raise ValueError("cannot set default_sortdir without default_sortkey") - - default_sortdir = property(get_default_sortdir, set_default_sortdir) - - def get_pageable(self): - """ """ - warnings.warn("Grid.pageable is deprecated; " - "please use Grid.paginated instead", - DeprecationWarning, stacklevel=2) - return self.paginated - - def set_pageable(self, value): - """ """ - warnings.warn("Grid.pageable is deprecated; " - "please use Grid.paginated instead", - DeprecationWarning, stacklevel=2) - self.paginated = value - - pageable = property(get_pageable, set_pageable) + def remove(self, *keys): + """ + This *removes* some column(s) from the grid, altogether. + """ + for key in keys: + if key in self.columns: + self.columns.remove(key) def hide_column(self, key): """ @@ -432,6 +331,9 @@ class Grid(WuttaGrid): if key in self.invisible: self.invisible.remove(key) + def append(self, field): + self.columns.append(field) + def insert_before(self, field, newfield): self.columns.insert_before(field, newfield) @@ -443,54 +345,62 @@ class Grid(WuttaGrid): self.remove(oldfield) def set_joiner(self, key, joiner): - """ """ if joiner is None: - warnings.warn("specifying None is deprecated for Grid.set_joiner(); " - "please use Grid.remove_joiner() instead", - DeprecationWarning, stacklevel=2) - self.remove_joiner(key) + self.joiners.pop(key, None) else: - super().set_joiner(key, joiner) + self.joiners[key] = joiner def set_sorter(self, key, *args, **kwargs): - """ """ - - if len(args) == 1: - if kwargs: - warnings.warn("kwargs are ignored for Grid.set_sorter(); " - "please refactor your code accordingly", - DeprecationWarning, stacklevel=2) - if args[0] is None: - warnings.warn("specifying None is deprecated for Grid.set_sorter(); " - "please use Grid.remove_sorter() instead", - DeprecationWarning, stacklevel=2) - self.remove_sorter(key) - else: - super().set_sorter(key, args[0]) - - elif len(args) == 0: - super().set_sorter(key) - + if len(args) == 1 and args[0] is None: + self.remove_sorter(key) else: - warnings.warn("multiple args are deprecated for Grid.set_sorter(); " - "please refactor your code accordingly", - DeprecationWarning, stacklevel=2) self.sorters[key] = self.make_sorter(*args, **kwargs) - def set_filter(self, key, *args, **kwargs): - """ """ - if len(args) == 1: - if args[0] is None: - warnings.warn("specifying None is deprecated for Grid.set_filter(); " - "please use Grid.remove_filter() instead", - DeprecationWarning, stacklevel=2) - self.remove_filter(key) - return + def remove_sorter(self, key): + self.sorters.pop(key, None) - # TODO: our make_filter() signature differs from upstream, - # so must call it explicitly instead of delegating to super - kwargs.setdefault('label', self.get_label(key)) - self.filters[key] = self.make_filter(key, *args, **kwargs) + def set_sort_defaults(self, sortkey, sortdir='asc'): + self.default_sortkey = sortkey + self.default_sortdir = sortdir + + def set_filter(self, key, *args, **kwargs): + if len(args) == 1 and args[0] is None: + self.remove_filter(key) + else: + if 'label' not in kwargs and key in self.labels: + kwargs['label'] = self.labels[key] + self.filters[key] = self.make_filter(key, *args, **kwargs) + + def set_searchable(self, key, searchable=True): + if searchable: + self.searchable[key] = True + else: + self.searchable.pop(key, None) + + def is_searchable(self, key): + return self.searchable.get(key, False) + + def remove_filter(self, key): + self.filters.pop(key, None) + + def set_label(self, key, label, column_only=False): + self.labels[key] = label + if not column_only and key in self.filters: + self.filters[key].label = label + + def get_label(self, key): + """ + Returns the label text for given field key. + """ + return self.labels.get(key, prettify(key)) + + def set_link(self, key, link=True): + if link: + if key not in self.linked_columns: + self.linked_columns.append(key) + else: # unlink + if self.linked_columns and key in self.linked_columns: + self.linked_columns.remove(key) def set_click_handler(self, key, handler): if handler: @@ -501,6 +411,9 @@ class Grid(WuttaGrid): def has_click_handler(self, key): return key in self.click_handlers + def set_renderer(self, key, renderer): + self.renderers[key] = renderer + def set_raw_renderer(self, key, renderer): """ Set or remove the "raw" renderer for the given field. @@ -568,18 +481,12 @@ class Grid(WuttaGrid): if isinstance(obj, sa.engine.Row): return obj._mapping[column_name] - if isinstance(obj, dict): - return obj[column_name] - try: - return getattr(obj, column_name) - except AttributeError: + return obj[column_name] + except KeyError: pass - - try: - return obj[column_name] except TypeError: - pass + return getattr(obj, column_name, None) def render_currency(self, obj, column_name): value = self.obtain_value(obj, column_name) @@ -694,14 +601,6 @@ class Grid(WuttaGrid): def actions_column_format(self, column_number, row_number, item): return HTML.td(self.render_actions(item, row_number), class_='actions') - # TODO: upstream should handle this.. - def make_backend_filters(self, filters=None): - """ """ - final = self.get_default_filters() - if filters: - final.update(filters) - return final - def get_default_filters(self): """ Returns the default set of filters provided by the grid. @@ -726,6 +625,16 @@ class Grid(WuttaGrid): filters[prop.key] = self.make_filter(prop.key, column) return filters + def make_filters(self, filters=None): + """ + Returns an initial set of filters which will be available to the grid. + The grid itself may or may not provide some default filters, and the + ``filters`` kwarg may contain additions and/or overrides. + """ + if filters: + return filters + return self.get_default_filters() + def make_filter(self, key, column, **kwargs): """ Make a filter suitable for use with the given column. @@ -773,103 +682,95 @@ class Grid(WuttaGrid): if filtr.active: yield filtr + def make_sorters(self, sorters=None): + """ + Returns an initial set of sorters which will be available to the grid. + The grid itself may or may not provide some default sorters, and the + ``sorters`` kwarg may contain additions and/or overrides. + """ + sorters, updates = {}, sorters + if self.model_class: + mapper = orm.class_mapper(self.model_class) + for prop in mapper.iterate_properties: + if isinstance(prop, orm.ColumnProperty) and not prop.key.endswith('uuid'): + sorters[prop.key] = self.make_sorter(prop) + if updates: + sorters.update(updates) + return sorters + + def make_sorter(self, model_property): + """ + Returns a function suitable for a sort map callable, with typical logic + built in for sorting applied to ``field``. + """ + class_ = getattr(model_property, 'class_', self.model_class) + column = getattr(class_, model_property.key) + + def sorter(query, direction): + # TODO: this seems hacky..normally we expect a true query + # of course, but in some cases it may be a list instead. + # if so then we can't actually sort + if isinstance(query, list): + return query + return query.order_by(getattr(column, direction)()) + + sorter._class = class_ + sorter._column = column + + return sorter + def make_simple_sorter(self, key, foldcase=False): - """ """ - warnings.warn("Grid.make_simple_sorter() is deprecated; " - "please use Grid.make_sorter() instead", - DeprecationWarning, stacklevel=2) - return self.make_sorter(key, foldcase=foldcase) - - def get_pagesize_options(self, default=None): - """ """ - # let upstream check config - options = super().get_pagesize_options(default=UNSPECIFIED) - if options is not UNSPECIFIED: - return options - - # fallback to legacy config - options = self.config.get_list('tailbone.grid.pagesize_options') - if options: - warnings.warn("tailbone.grid.pagesize_options setting is deprecated; " - "please set wuttaweb.grids.default_pagesize_options instead", - DeprecationWarning) - options = [int(size) for size in options - if size.isdigit()] - if options: - return options - - if default: - return default - - # use upstream default - return super().get_pagesize_options() - - def get_pagesize(self, default=None): - """ """ - # let upstream check config - pagesize = super().get_pagesize(default=UNSPECIFIED) - if pagesize is not UNSPECIFIED: - return pagesize - - # fallback to legacy config - pagesize = self.config.get_int('tailbone.grid.default_pagesize') - if pagesize: - warnings.warn("tailbone.grid.default_pagesize setting is deprecated; " - "please use wuttaweb.grids.default_pagesize instead", - DeprecationWarning) - return pagesize - - if default: - return default - - # use upstream default - return super().get_pagesize() - - def get_default_pagesize(self): # pragma: no cover - """ """ - warnings.warn("Grid.get_default_pagesize() method is deprecated; " - "please use Grid.get_pagesize() of Grid.page instead", - DeprecationWarning, stacklevel=2) + """ + Returns a function suitable for a sort map callable, with typical logic + built in for sorting a data set comprised of dicts, on the given key. + """ + if foldcase: + keyfunc = lambda v: v[key].lower() + else: + keyfunc = lambda v: v[key] + return lambda q, d: sorted(q, key=keyfunc, reverse=d == 'desc') + def get_default_pagesize(self): if self.default_pagesize: return self.default_pagesize - return self.get_pagesize() + pagesize = self.request.rattail_config.getint('tailbone', + 'grid.default_pagesize', + default=0) + if pagesize: + return pagesize - def load_settings(self, **kwargs): - """ """ - if 'store' in kwargs: - warnings.warn("the 'store' param is deprecated for load_settings(); " - "please use the 'persist' param instead", - DeprecationWarning, stacklevel=2) - kwargs.setdefault('persist', kwargs.pop('store')) + options = self.get_pagesize_options() + return options[0] - persist = kwargs.get('persist', True) + def load_settings(self, store=True): + """ + Load current/effective settings for the grid, from the request query + string and/or session storage. If ``store`` is true, then once + settings have been fully read, they are stored in current session for + next time. Finally, various instance attributes of the grid and its + filters are updated in-place to reflect the settings; this is so code + needn't access the settings dict directly, but the more Pythonic + instance attributes. + """ # initial default settings settings = {} if self.sortable: - if self.sort_defaults: - # nb. as of writing neither Buefy nor Oruga support a - # multi-column *default* sort; so just use first sorter - sortinfo = self.sort_defaults[0] + if self.default_sortkey: settings['sorters.length'] = 1 - settings['sorters.1.key'] = sortinfo.sortkey - settings['sorters.1.dir'] = sortinfo.sortdir + settings['sorters.1.key'] = self.default_sortkey + settings['sorters.1.dir'] = self.default_sortdir else: settings['sorters.length'] = 0 - if self.paginated: - settings['pagesize'] = self.pagesize - settings['page'] = self.page + if self.pageable: + settings['pagesize'] = self.get_default_pagesize() + settings['page'] = self.default_page if self.filterable: for filtr in self.iter_filters(): - defaults = self.filter_defaults.get(filtr.key, {}) - settings[f'filter.{filtr.key}.active'] = defaults.get('active', - filtr.default_active) - settings[f'filter.{filtr.key}.verb'] = defaults.get('verb', - filtr.default_verb) - settings[f'filter.{filtr.key}.value'] = defaults.get('value', - filtr.default_value) + settings['filter.{}.active'.format(filtr.key)] = filtr.default_active + settings['filter.{}.verb'.format(filtr.key)] = filtr.default_verb + settings['filter.{}.value'.format(filtr.key)] = filtr.default_value # If user has default settings on file, apply those first. if self.user_has_defaults(): @@ -877,25 +778,25 @@ class Grid(WuttaGrid): # If request contains instruction to reset to default filters, then we # can skip the rest of the request/session checks. - if self.request.GET.get('reset-view'): + if self.request.GET.get('reset-to-default-filters') == 'true': pass # If request has filter settings, grab those, then grab sort/pager # settings from request or session. - elif self.request_has_settings('filter'): - self.update_filter_settings(settings, src='request') + elif self.filterable and self.request_has_settings('filter'): + self.update_filter_settings(settings, 'request') if self.request_has_settings('sort'): - self.update_sort_settings(settings, src='request') + self.update_sort_settings(settings, 'request') else: - self.update_sort_settings(settings, src='session') + self.update_sort_settings(settings, 'session') self.update_page_settings(settings) # If request has no filter settings but does have sort settings, grab # those, then grab filter settings from session, then grab pager # settings from request or session. elif self.request_has_settings('sort'): - self.update_sort_settings(settings, src='request') - self.update_filter_settings(settings, src='session') + self.update_sort_settings(settings, 'request') + self.update_filter_settings(settings, 'session') self.update_page_settings(settings) # NOTE: These next two are functionally equivalent, but are kept @@ -905,27 +806,27 @@ class Grid(WuttaGrid): # grab those, then grab filter/sort settings from session. elif self.request_has_settings('page'): self.update_page_settings(settings) - self.update_filter_settings(settings, src='session') - self.update_sort_settings(settings, src='session') + self.update_filter_settings(settings, 'session') + self.update_sort_settings(settings, 'session') # If request has no settings, grab all from session. elif self.session_has_settings(): - self.update_filter_settings(settings, src='session') - self.update_sort_settings(settings, src='session') + self.update_filter_settings(settings, 'session') + self.update_sort_settings(settings, 'session') self.update_page_settings(settings) # If no settings were found in request or session, don't store result. else: - persist = False + store = False # Maybe store settings for next time. - if persist: - self.persist_settings(settings, dest='session') + if store: + self.persist_settings(settings, 'session') # If request contained instruction to save current settings as defaults # for the current user, then do that. if self.request.GET.get('save-current-filters-as-defaults') == 'true': - self.persist_settings(settings, dest='defaults') + self.persist_settings(settings, 'defaults') # update ourself to reflect settings if self.filterable: @@ -934,14 +835,13 @@ class Grid(WuttaGrid): filtr.verb = settings['filter.{}.verb'.format(filtr.key)] filtr.value = settings['filter.{}.value'.format(filtr.key)] if self.sortable: - # and self.sort_on_backend: self.active_sorters = [] for i in range(1, settings['sorters.length'] + 1): self.active_sorters.append({ - 'key': settings[f'sorters.{i}.key'], - 'dir': settings[f'sorters.{i}.dir'], + 'field': settings[f'sorters.{i}.key'], + 'order': settings[f'sorters.{i}.dir'], }) - if self.paginated: + if self.pageable: self.pagesize = settings['pagesize'] self.page = settings['page'] @@ -1045,16 +945,23 @@ class Grid(WuttaGrid): merge(f'sorters.{i}.key') merge(f'sorters.{i}.dir') - if self.paginated: + if self.pageable: merge('pagesize', int) merge('page', int) def request_has_settings(self, type_): - """ """ - if super().request_has_settings(type_): - return True + """ + Determine if the current request (GET query string) contains any + filter/sort settings for the grid. + """ + if type_ == 'filter': + for filtr in self.iter_filters(): + if filtr.key in self.request.GET: + return True + if 'filter' in self.request.GET: # user may be applying empty filters + return True - if type_ == 'sort': + elif type_ == 'sort': # TODO: remove this eventually, but some links in the wild # may still include these params, so leave it for now @@ -1062,6 +969,14 @@ class Grid(WuttaGrid): if key in self.request.GET: return True + if 'sort1key' in self.request.GET: + return True + + elif type_ == 'page': + for key in ['pagesize', 'page']: + if key in self.request.GET: + return True + return False def session_has_settings(self): @@ -1077,19 +992,175 @@ class Grid(WuttaGrid): return any([key.startswith(f'{prefix}.filter') for key in self.request.session]) - def persist_settings(self, settings, dest='session'): - """ """ - if dest not in ('defaults', 'session'): - raise ValueError(f"invalid dest identifier: {dest}") + def get_setting(self, source, settings, key, normalize=lambda v: v, default=None): + """ + Get the effective value for a particular setting, preferring ``source`` + but falling back to existing ``settings`` and finally the ``default``. + """ + if source not in ('request', 'session'): + raise ValueError("Invalid source identifier: {}".format(source)) + # If source is query string, try that first. + if source == 'request': + value = self.request.GET.get(key) + if value is not None: + try: + value = normalize(value) + except ValueError: + pass + else: + return value + + # Or, if source is session, try that first. + else: + value = self.request.session.get('grid.{}.{}'.format(self.key, key)) + if value is not None: + return normalize(value) + + # If source had nothing, try default/existing settings. + value = settings.get(key) + if value is not None: + try: + value = normalize(value) + except ValueError: + pass + else: + return value + + # Okay then, default it is. + return default + + def update_filter_settings(self, settings, source): + """ + Updates a settings dictionary according to filter settings data found + in either the GET query string, or session storage. + + :param settings: Dictionary of initial settings, which is to be updated. + + :param source: String identifying the source to consult for settings + data. Must be one of: ``('request', 'session')``. + """ + if not self.filterable: + return + + for filtr in self.iter_filters(): + prefix = 'filter.{}'.format(filtr.key) + + if source == 'request': + # consider filter active if query string contains a value for it + settings['{}.active'.format(prefix)] = filtr.key in self.request.GET + settings['{}.verb'.format(prefix)] = self.get_setting( + source, settings, '{}.verb'.format(filtr.key), default='') + settings['{}.value'.format(prefix)] = self.get_setting( + source, settings, filtr.key, default='') + + else: # source = session + settings['{}.active'.format(prefix)] = self.get_setting( + source, settings, '{}.active'.format(prefix), + normalize=lambda v: str(v).lower() == 'true', default=False) + settings['{}.verb'.format(prefix)] = self.get_setting( + source, settings, '{}.verb'.format(prefix), default='') + settings['{}.value'.format(prefix)] = self.get_setting( + source, settings, '{}.value'.format(prefix), default='') + + def update_sort_settings(self, settings, source): + """ + Updates a settings dictionary according to sort settings data found in + either the GET query string, or session storage. + + :param settings: Dictionary of initial settings, which is to be updated. + + :param source: String identifying the source to consult for settings + data. Must be one of: ``('request', 'session')``. + """ + if not self.sortable: + return + + if source == 'request': + + # TODO: remove this eventually, but some links in the wild + # may still include these params, so leave it for now + if 'sortkey' in self.request.GET: + settings['sorters.length'] = 1 + settings['sorters.1.key'] = self.get_setting(source, settings, 'sortkey') + settings['sorters.1.dir'] = self.get_setting(source, settings, 'sortdir') + + else: # the future + i = 1 + while True: + skey = f'sort{i}key' + if skey in self.request.GET: + settings[f'sorters.{i}.key'] = self.get_setting(source, settings, skey) + settings[f'sorters.{i}.dir'] = self.get_setting(source, settings, f'sort{i}dir') + else: + break + i += 1 + settings['sorters.length'] = i - 1 + + else: # session + + # TODO: definitely will remove this, but leave it for now + # so it doesn't monkey with current user sessions when + # next upgrade happens. so, remove after all are upgraded + sortkey = self.get_setting(source, settings, 'sortkey') + if sortkey: + settings['sorters.length'] = 1 + settings['sorters.1.key'] = sortkey + settings['sorters.1.dir'] = self.get_setting(source, settings, 'sortdir') + + else: # the future + settings['sorters.length'] = self.get_setting(source, settings, + 'sorters.length', int) + for i in range(1, settings['sorters.length'] + 1): + for key in ('key', 'dir'): + skey = f'sorters.{i}.{key}' + settings[skey] = self.get_setting(source, settings, skey) + + def update_page_settings(self, settings): + """ + Updates a settings dictionary according to pager settings data found in + either the GET query string, or session storage. + + Note that due to how the actual pager functions, the effective settings + will often come from *both* the request and session. This is so that + e.g. the page size will remain constant (coming from the session) while + the user jumps between pages (which only provides the single setting). + + :param settings: Dictionary of initial settings, which is to be updated. + """ + if not self.pageable: + return + + pagesize = self.request.GET.get('pagesize') + if pagesize is not None: + if pagesize.isdigit(): + settings['pagesize'] = int(pagesize) + else: + pagesize = self.request.session.get('grid.{}.pagesize'.format(self.key)) + if pagesize is not None: + settings['pagesize'] = pagesize + + page = self.request.GET.get('page') + if page is not None: + if page.isdigit(): + settings['page'] = int(page) + else: + page = self.request.session.get('grid.{}.page'.format(self.key)) + if page is not None: + settings['page'] = int(page) + + def persist_settings(self, settings, to='session'): + """ + Persist the given settings in some way, as defined by ``func``. + """ app = self.request.rattail_config.get_app() model = app.model - def persist(key, value=lambda k: settings.get(k)): - if dest == 'defaults': + def persist(key, value=lambda k: settings[k]): + if to == 'defaults': skey = 'tailbone.{}.grid.{}.{}'.format(self.request.user.uuid, self.key, key) app.save_setting(Session(), skey, value(key)) - else: # dest == session + else: # to == session skey = 'grid.{}.{}'.format(self.key, key) self.request.session[skey] = value(key) @@ -1101,11 +1172,9 @@ class Grid(WuttaGrid): if self.sortable: - # first must clear all sort settings from dest. this is - # because number of sort settings will vary, so we delete - # all and then write all - - if dest == 'defaults': + # first clear existing settings for *sorting* only + # nb. this is because number of sort settings will vary + if to == 'defaults': prefix = f'tailbone.{self.request.user.uuid}.grid.{self.key}' query = Session.query(model.Setting)\ .filter(sa.or_( @@ -1119,9 +1188,7 @@ class Grid(WuttaGrid): for setting in query.all(): Session.delete(setting) Session.flush() - else: # session - # remove sort settings from user session prefix = f'grid.{self.key}' for key in list(self.request.session): if key.startswith(f'{prefix}.sorters.'): @@ -1133,14 +1200,12 @@ class Grid(WuttaGrid): self.request.session.pop(f'{prefix}.sortkey', None) self.request.session.pop(f'{prefix}.sortdir', None) - # now save sort settings to dest - if 'sorters.length' in settings: - persist('sorters.length') - for i in range(1, settings['sorters.length'] + 1): - persist(f'sorters.{i}.key') - persist(f'sorters.{i}.dir') + persist('sorters.length') + for i in range(1, settings['sorters.length'] + 1): + persist(f'sorters.{i}.key') + persist(f'sorters.{i}.dir') - if self.paginated: + if self.pageable: persist('pagesize') persist('page') @@ -1164,27 +1229,110 @@ class Grid(WuttaGrid): return data + def sort_data(self, data): + """ + Sort the given query according to current settings, and return the result. + """ + # bail if no sort settings + if not self.active_sorters: + return data + + # TODO: is there a better way to check for SA sorting? + if self.model_class: + + # collect actual column sorters for order_by clause + sorters = [] + for sorter in self.active_sorters: + sortkey = sorter['field'] + sortfunc = self.sorters.get(sortkey) + if not sortfunc: + log.warning("unknown sorter: %s", sorter) + continue + + # join appropriate model if needed + if sortkey in self.joiners and sortkey not in self.joined: + data = self.joiners[sortkey](data) + self.joined.add(sortkey) + + # add column/dir to collection + sortdir = sorter['order'] + sorters.append(getattr(sortfunc._column, sortdir)()) + + # apply sorting to query + if sorters: + data = data.order_by(*sorters) + + return data + + else: + # not a SQLAlchemy grid, custom sorter + + assert len(self.active_sorters) < 2 + + sortkey = self.active_sorters[0]['field'] + sortdir = self.active_sorters[0]['order'] or 'asc' + + # Cannot sort unless we have a sort function. + sortfunc = self.sorters.get(sortkey) + if not sortfunc: + return data + + # apply joins needed for this sorter + if sortkey in self.joiners and sortkey not in self.joined: + data = self.joiners[sortkey](data) + self.joined.add(sortkey) + + return sortfunc(data, sortdir) + + def paginate_data(self, data): + """ + Paginate the given data set according to current settings, and return + the result. + """ + # we of course assume our current page is correct, at first + pager = self.make_pager(data) + + # if pager has detected that our current page is outside the valid + # range, we must re-orient ourself around the "new" (valid) page + if pager.page != self.page: + self.page = pager.page + self.request.session['grid.{}.page'.format(self.key)] = self.page + pager = self.make_pager(data) + + return pager + + def make_pager(self, data): + + # TODO: this seems hacky..normally we expect `data` to be a + # query of course, but in some cases it may be a list instead. + # if so then we can't use ORM pager + if isinstance(data, list): + import paginate + return paginate.Page(data, + items_per_page=self.pagesize, + page=self.page) + + return SqlalchemyOrmPage(data, + items_per_page=self.pagesize, + page=self.page, + url_maker=URLMaker(self.request)) + def make_visible_data(self): - """ """ - warnings.warn("grid.make_visible_data() method is deprecated; " - "please use grid.get_visible_data() instead", - DeprecationWarning, stacklevel=2) - return self.get_visible_data() - - def render_vue_tag(self, master=None, **kwargs): - """ """ - kwargs.setdefault('ref', 'grid') - kwargs.setdefault(':csrftoken', 'csrftoken') - - if (master and master.deletable and master.has_perm('delete') - and master.delete_confirm == 'simple'): - kwargs.setdefault('@deleteActionClicked', 'deleteObject') - - return HTML.tag(self.vue_tagname, **kwargs) - - def render_vue_template(self, template='/grids/complete.mako', **context): - """ """ - return self.render_complete(template=template, **context) + """ + Apply various settings to the raw data set, to produce a final data + set. This will page / sort / filter as necessary, according to the + grid's defaults and the current request etc. + """ + self.joined = set() + data = self.data + if self.filterable: + data = self.filter_data(data) + if self.sortable: + data = self.sort_data(data) + if self.pageable: + self.pager = self.paginate_data(data) + data = self.pager + return data def render_complete(self, template='/grids/complete.mako', **kwargs): """ @@ -1192,7 +1340,7 @@ class Grid(WuttaGrid): includes the context menu items and grid tools. """ if 'grid_columns' not in kwargs: - kwargs['grid_columns'] = self.get_vue_columns() + kwargs['grid_columns'] = self.get_table_columns() if 'grid_data' not in kwargs: kwargs['grid_data'] = self.get_table_data() @@ -1211,11 +1359,9 @@ class Grid(WuttaGrid): context['request'] = self.request context.setdefault('allow_save_defaults', True) context.setdefault('view_click_handler', self.get_view_click_handler()) - html = render(template, context) - return HTML.literal(html) + return render(template, context) def render_buefy(self, **kwargs): - """ """ warnings.warn("Grid.render_buefy() is deprecated; " "please use Grid.render_complete() instead", DeprecationWarning, stacklevel=2) @@ -1223,7 +1369,6 @@ class Grid(WuttaGrid): def render_table_element(self, template='/grids/b-table.mako', data_prop='gridData', empty_labels=False, - literal=False, **kwargs): """ This is intended for ad-hoc "small" grids with static data. Renders @@ -1235,24 +1380,30 @@ class Grid(WuttaGrid): context['data_prop'] = data_prop context['empty_labels'] = empty_labels if 'grid_columns' not in context: - context['grid_columns'] = self.get_vue_columns() + context['grid_columns'] = self.get_table_columns() context.setdefault('paginated', False) if context['paginated']: context.setdefault('per_page', 20) context['view_click_handler'] = self.get_view_click_handler() - result = render(template, context) - if literal: - result = HTML.literal(result) - return result + return render(template, context) def get_view_click_handler(self): - """ """ + # locate the 'view' action # TODO: this should be easier, and/or moved elsewhere? view = None - for action in self.actions: + for action in self.main_actions: if action.key == 'view': - return getattr(action, 'click_handler', None) + view = action + break + if not view: + for action in self.more_actions: + if action.key == 'view': + view = action + break + + if view: + return view.click_handler def set_filters_sequence(self, filters, only=False): """ @@ -1326,21 +1477,48 @@ class Grid(WuttaGrid): return data - def render_actions(self, row, i): # pragma: no cover - """ """ - warnings.warn("grid.render_actions() is deprecated!", - DeprecationWarning, stacklevel=2) + def render_filters(self, template='/grids/filters.mako', **kwargs): + """ + Render the filters to a Unicode string, using the specified template. + Additional kwargs are passed along as context to the template. + """ + # Provide default data to filters form, so renderer can do some of the + # work for us. + data = {} + for filtr in self.iter_active_filters(): + data['{}.active'.format(filtr.key)] = filtr.active + data['{}.verb'.format(filtr.key)] = filtr.verb + data[filtr.key] = filtr.value - actions = [self.render_action(a, row, i) - for a in self.actions] - actions = [a for a in actions if a] - return HTML.literal('').join(actions) + form = gridfilters.GridFiltersForm(self.filters, + request=self.request, + defaults=data) - def render_action(self, action, row, i): # pragma: no cover - """ """ - warnings.warn("grid.render_action() is deprecated!", - DeprecationWarning, stacklevel=2) + kwargs['request'] = self.request + kwargs['grid'] = self + kwargs['form'] = form + return render(template, kwargs) + def render_actions(self, row, i): + """ + Returns the rendered contents of the 'actions' column for a given row. + """ + main_actions = [self.render_action(a, row, i) + for a in self.main_actions] + main_actions = [a for a in main_actions if a] + more_actions = [self.render_action(a, row, i) + for a in self.more_actions] + more_actions = [a for a in more_actions if a] + if more_actions: + icon = HTML.tag('span', class_='ui-icon ui-icon-carat-1-e') + link = tags.link_to("More" + icon, '#', class_='more') + main_actions.append(HTML.literal('  ') + link + HTML.tag('div', class_='more', c=more_actions)) + return HTML.literal('').join(main_actions) + + def render_action(self, action, row, i): + """ + Renders an action menu item (link) for the given row. + """ url = action.get_url(row, i) if url: kwargs = {'class_': action.key, 'target': action.target} @@ -1374,6 +1552,18 @@ class Grid(WuttaGrid): return tags.checkbox('checkbox-{}-{}'.format(self.key, self.get_row_key(item)), checked=self.checked(item)) + def get_pagesize_options(self): + + # use values from config, if defined + options = self.request.rattail_config.getlist('tailbone', 'grid.pagesize_options') + if options: + options = [int(size) for size in options + if size.isdigit()] + if options: + return options + + return [5, 10, 20, 50, 100, 200] + def has_static_data(self): """ Should return ``True`` if the grid data can be considered "static" @@ -1385,21 +1575,20 @@ class Grid(WuttaGrid): return True return False - def get_vue_columns(self): - """ """ - columns = super().get_vue_columns() - - for column in columns: - column['visible'] = column['field'] not in self.invisible - - return columns - def get_table_columns(self): - """ """ - warnings.warn("grid.get_table_columns() method is deprecated; " - "please use grid.get_vue_columns() instead", - DeprecationWarning, stacklevel=2) - return self.get_vue_columns() + """ + Return a list of dicts representing all grid columns. Meant + for use with the client-side JS table. + """ + columns = [] + for name in self.columns: + columns.append({ + 'field': name, + 'label': self.get_label(name), + 'sortable': self.sortable and name in self.sorters, + 'visible': name not in self.invisible, + }) + return columns def get_uuid_for_row(self, rowobj): @@ -1411,25 +1600,13 @@ class Grid(WuttaGrid): if hasattr(rowobj, 'uuid'): return rowobj.uuid - def get_vue_context(self): - """ """ - return self.get_table_data() - - def get_vue_data(self): - """ """ - table_data = self.get_table_data() - return table_data['data'] - def get_table_data(self): """ Returns a list of data rows for the grid, for use with client-side JS table. """ - if hasattr(self, '_table_data'): - return self._table_data - # filter / sort / paginate to get "visible" data - raw_data = self.get_visible_data() + raw_data = self.make_visible_data() data = [] status_map = {} checked = [] @@ -1470,22 +1647,10 @@ class Grid(WuttaGrid): # leverage configured rendering logic where applicable; # otherwise use "raw" data value as string - value = self.obtain_value(rowobj, name) if self.renderers and name in self.renderers: - renderer = self.renderers[name] - - # TODO: legacy renderer callables require 2 args, - # but wuttaweb callables require 3 args - sig = inspect.signature(renderer) - required = [param for param in sig.parameters.values() - if param.default == param.empty] - - if len(required) == 2: - # TODO: legacy renderer - value = renderer(rowobj, name) - else: # the future - value = renderer(rowobj, name, value) - + value = self.renderers[name](rowobj, name) + else: + value = self.obtain_value(rowobj, name) if value is None: value = "" @@ -1518,8 +1683,6 @@ class Grid(WuttaGrid): results = { 'data': data, - 'row_classes': status_map, - # TODO: deprecate / remove this 'row_status_map': status_map, } @@ -1527,15 +1690,11 @@ class Grid(WuttaGrid): results['checked_rows'] = checked # TODO: this seems a bit hacky, but is required for now to # initialize things on the client side... - var = '{}CurrentData'.format(self.vue_component) + var = '{}CurrentData'.format(self.component_studly) results['checked_rows_code'] = '[{}]'.format( ', '.join(['{}[{}]'.format(var, i) for i in checked])) - if self.paginated and self.paginate_on_backend: - results['pager_stats'] = self.get_vue_pager_stats() - - # TODO: is this actually needed now that we have pager_stats? - if self.paginated and self.pager is not None: + if self.pageable and self.pager is not None: results['total_items'] = self.pager.item_count results['per_page'] = self.pager.items_per_page results['page'] = self.pager.page @@ -1545,38 +1704,41 @@ class Grid(WuttaGrid): else: results['total_items'] = count - self._table_data = results - return self._table_data - - # TODO: remove this when we use upstream GridAction - def add_action(self, key, **kwargs): - """ """ - self.actions.append(GridAction(self.request, key, **kwargs)) + return results def set_action_urls(self, row, rowobj, i): """ Pre-generate all action URLs for the given data row. Meant for use with client-side table, since we can't generate URLs from JS. """ - for action in self.actions: + for action in (self.main_actions + self.more_actions): url = action.get_url(rowobj, i) row['_action_url_{}'.format(action.key)] = url + def is_linked(self, name): + """ + Should return ``True`` if the given column name is configured to be + "linked" (i.e. table cell should contain a link to "view object"), + otherwise ``False``. + """ + if self.linked_columns: + if name in self.linked_columns: + return True + return False -class GridAction(WuttaGridAction): + +class GridAction(object): """ - Represents a "row action" hyperlink within a grid context. + Represents an action available to a grid. This is used to construct the + 'actions' column when rendering the grid. - This is a subclass of - :class:`wuttaweb:wuttaweb.grids.base.GridAction`. + :param key: Key for the action (e.g. ``'edit'``), unique within + the grid. - .. warning:: + :param label: Label to be displayed for the action. If not set, + will be a capitalized version of ``key``. - This class remains for now, to retain compatibility with - existing code. But at some point the WuttaWeb class will - supersede this one entirely. - - :param target: HTML "target" attribute for the ```` tag. + :param icon: Icon name for the action. :param click_handler: Optional JS click handler for the action. This value will be rendered as-is within the final grid @@ -1588,23 +1750,41 @@ class GridAction(WuttaGridAction): * ``$emit('do-something', props.row)`` """ - def __init__( - self, - request, - key, - target=None, - click_handler=None, - **kwargs, - ): - # TODO: previously url default was '#' - but i don't think we - # need that anymore? guess we'll see.. - #kwargs.setdefault('url', '#') - - super().__init__(request, key, **kwargs) - + def __init__(self, key, label=None, url='#', icon=None, target=None, + link_class=None, click_handler=None): + self.key = key + self.label = label or prettify(key) + self.icon = icon + self.url = url self.target = target + self.link_class = link_class self.click_handler = click_handler + def get_url(self, row, i): + """ + Returns an action URL for the given row. + """ + if callable(self.url): + return self.url(row, i) + return self.url + + def render_icon(self): + """ + Render the HTML snippet for the action link icon. + """ + return HTML.tag('i', class_='fas fa-{}'.format(self.icon)) + + def render_label(self): + """ + Render the label "text" within the actions column of a grid + row. Most actions have a static label that never varies, but + you can override this to add e.g. HTML content. Note that the + return value will be treated / rendered as HTML whether or not + it contains any, so perhaps be careful that it is trusted + content. + """ + return self.label + class URLMaker(object): """ diff --git a/tailbone/helpers.py b/tailbone/helpers.py index 50b38c30..d4065cc5 100644 --- a/tailbone/helpers.py +++ b/tailbone/helpers.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar +# Copyright © 2010-2023 Lance Edgar # # This file is part of Rattail. # @@ -24,9 +24,6 @@ Template Context Helpers """ -# start off with all from wuttaweb -from wuttaweb.helpers import * - import os import datetime from decimal import Decimal @@ -36,9 +33,14 @@ from rattail.time import localtime, make_utc from rattail.util import pretty_quantity, pretty_hours, hours_as_decimal from rattail.db.util import maxlen -from tailbone.util import (pretty_datetime, raw_datetime, +from webhelpers2.html import * +from webhelpers2.html.tags import * + +from tailbone.util import (csrf_token, get_csrf_token, + pretty_datetime, raw_datetime, render_markdown, - route_exists) + route_exists, + get_liburl) def pretty_date(date): diff --git a/tailbone/menus.py b/tailbone/menus.py index 09d6f3f0..0752c22d 100644 --- a/tailbone/menus.py +++ b/tailbone/menus.py @@ -96,7 +96,7 @@ class TailboneMenuHandler(WuttaMenuHandler): if not main_keys: return - model = self.app.model + model = self.model menus = [] # menu definition can come either from config file or db @@ -281,9 +281,8 @@ class TailboneMenuHandler(WuttaMenuHandler): """ Make a set of menus for all registered system integrations. """ - tb = self.app.get_tailbone_handler() menus = [] - for provider in tb.iter_providers(): + for provider in self.tb.iter_providers(): menu = provider.make_integration_menu(request) if menu: menus.append(menu) @@ -394,11 +393,6 @@ class TailboneMenuHandler(WuttaMenuHandler): 'route': 'products', 'perm': 'products.list', }, - { - 'title': "Product Costs", - 'route': 'product_costs', - 'perm': 'product_costs.list', - }, { 'title': "Departments", 'route': 'departments', @@ -456,11 +450,6 @@ class TailboneMenuHandler(WuttaMenuHandler): 'route': 'vendors', 'perm': 'vendors.list', }, - { - 'title': "Product Costs", - 'route': 'product_costs', - 'perm': 'product_costs.list', - }, {'type': 'sep'}, { 'title': "Ordering", @@ -713,7 +702,7 @@ class TailboneMenuHandler(WuttaMenuHandler): }, {'type': 'sep'}, { - 'title': "App Info", + 'title': "App Details", 'route': 'appinfo', 'perm': 'appinfo.list', }, @@ -755,18 +744,3 @@ class MenuHandler(TailboneMenuHandler): "please use tailbone.menus.TailboneMenuHandler instead", DeprecationWarning, stacklevel=2) super().__init__(*args, **kwargs) - - -class NullMenuHandler(WuttaMenuHandler): - """ - Null menu handler which uses an empty menu set. - - .. note: - - This class shouldn't even exist, but for the moment, it is - useful to configure non-traditional (e.g. API) web apps to use - this, in order to avoid most of the overhead. - """ - - def make_menus(self, request, **kwargs): - return [] diff --git a/tailbone/static/__init__.py b/tailbone/static/__init__.py index 57700b80..2ad5161a 100644 --- a/tailbone/static/__init__.py +++ b/tailbone/static/__init__.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar +# Copyright © 2010-2017 Lance Edgar # # This file is part of Rattail. # @@ -24,8 +24,9 @@ Static Assets """ +from __future__ import unicode_literals, absolute_import + def includeme(config): - config.include('wuttaweb.static') config.add_static_view('tailbone', 'tailbone:static') config.add_static_view('deform', 'deform:static') diff --git a/tailbone/subscribers.py b/tailbone/subscribers.py index 268d4818..12e1e32a 100644 --- a/tailbone/subscribers.py +++ b/tailbone/subscribers.py @@ -48,21 +48,43 @@ from tailbone.util import get_available_themes, get_global_search_options log = logging.getLogger(__name__) -def new_request(event, session=None): +def new_request(event): """ Event hook called when processing a new request. - This first invokes the upstream hooks: - - * :func:`wuttaweb:wuttaweb.subscribers.new_request()` - * :func:`wuttaweb:wuttaweb.subscribers.new_request_set_user()` + This first invokes the upstream hook: + :func:`wuttaweb:wuttaweb.subscribers.new_request()` It then adds more things to the request object; among them: .. attribute:: request.rattail_config Reference to the app :term:`config object`. Note that this - will be the same as :attr:`wuttaweb:request.wutta_config`. + will be the same as ``request.wutta_config``. + + .. attribute:: request.user + + Reference to the current authenticated user, or ``None``. + + .. attribute:: request.is_admin + + Flag indicating whether current user is a member of the + Administrator role. + + .. attribute:: request.is_root + + Flag indicating whether user is currently elevated to root + privileges. This is only possible if ``request.is_admin = + True``. + + .. method:: request.has_perm(name) + + Function to check if current user has the given permission. + + .. method:: request.has_any_perm(*names) + + Function to check if current user has any of the given + permissions. .. method:: request.register_component(tagname, classname) @@ -72,55 +94,74 @@ def new_request(event, session=None): then in the base template all registered components will be properly loaded. """ + # log.debug("new request: %s", event) request = event.request - # invoke main upstream logic - # nb. this sets request.wutta_config + # invoke upstream logic base.new_request(event) - config = request.wutta_config - app = config.get_app() - auth = app.get_auth_handler() - session = session or Session() - # compatibility - rattail_config = config + rattail_config = request.wutta_config request.rattail_config = rattail_config - def user_getter(request, db_session=None): - user = base.default_user_getter(request, db_session=db_session) - if user: - # nb. we also assign continuum user to session - session = db_session or Session() - session.set_continuum_user(user) - return user + def user(request): + user = None + uuid = request.authenticated_userid + if uuid: + app = request.rattail_config.get_app() + model = app.model + user = Session.get(model.User, uuid) + if user: + Session().set_continuum_user(user) + return user - # invoke upstream hook to set user - base.new_request_set_user(event, user_getter=user_getter, db_session=session) + request.set_property(user, reify=True) # assign client IP address to the session, for sake of versioning - if hasattr(request, 'client_addr'): - session.continuum_remote_addr = request.client_addr + Session().continuum_remote_addr = request.client_addr - # request.register_component() - def register_component(tagname, classname): - """ - Register a Vue 3 component, so the base template knows to - declare it for use within the app (page). - """ - if not hasattr(request, '_tailbone_registered_components'): - request._tailbone_registered_components = OrderedDict() + request.is_admin = bool(request.user) and request.user.is_admin() + request.is_root = request.is_admin and request.session.get('is_root', False) - if tagname in request._tailbone_registered_components: - log.warning("component with tagname '%s' already registered " - "with class '%s' but we are replacing that with " - "class '%s'", - tagname, - request._tailbone_registered_components[tagname], - classname) + # TODO: why would this ever be null? + if rattail_config: - request._tailbone_registered_components[tagname] = classname - request.register_component = register_component + app = rattail_config.get_app() + auth = app.get_auth_handler() + request.tailbone_cached_permissions = auth.get_permissions( + Session(), request.user) + + def has_perm(name): + if name in request.tailbone_cached_permissions: + return True + return request.is_root + request.has_perm = has_perm + + def has_any_perm(*names): + for name in names: + if has_perm(name): + return True + return False + request.has_any_perm = has_any_perm + + def register_component(tagname, classname): + """ + Register a Vue 3 component, so the base template knows to + declare it for use within the app (page). + """ + if not hasattr(request, '_tailbone_registered_components'): + request._tailbone_registered_components = OrderedDict() + + if tagname in request._tailbone_registered_components: + log.warning("component with tagname '%s' already registered " + "with class '%s' but we are replacing that with " + "class '%s'", + tagname, + request._tailbone_registered_components[tagname], + classname) + + request._tailbone_registered_components[tagname] = classname + request.register_component = register_component def before_render(event): @@ -159,6 +200,7 @@ def before_render(event): # theme - we only want do this for classic web app, *not* API # TODO: so, clearly we need a better way to distinguish the two if 'tailbone.theme' in request.registry.settings: + renderer_globals['b'] = 'o' if request.use_oruga else 'b' # for buefy renderer_globals['theme'] = request.registry.settings['tailbone.theme'] # note, this is just a global flag; user still needs permission to see picker expose_picker = config.get_bool('tailbone.themes.expose_picker', @@ -239,10 +281,27 @@ def context_found(event): The following is attached to the request: + * ``get_referrer()`` function + * ``get_session_timeout()`` function """ request = event.request + def get_referrer(default=None, **kwargs): + if request.params.get('referrer'): + return request.params['referrer'] + if request.session.get('referrer'): + return request.session.pop('referrer') + referrer = request.referrer + if (not referrer or referrer == request.current_route_url() + or not referrer.startswith(request.host_url)): + if default: + referrer = default + else: + referrer = request.route_url('home') + return referrer + request.get_referrer = get_referrer + def get_session_timeout(): """ Returns the timeout in effect for the current session diff --git a/tailbone/templates/appinfo/configure.mako b/tailbone/templates/appinfo/configure.mako index 9d866cea..280b5cb9 100644 --- a/tailbone/templates/appinfo/configure.mako +++ b/tailbone/templates/appinfo/configure.mako @@ -1,2 +1,250 @@ ## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/appinfo/configure.mako" /> +<%inherit file="/configure.mako" /> + +<%def name="form_content()"> + +

Basics

+
+ + + + + + + + + + ## TODO: should be a dropdown, app handler defines choices + + + + + + + + + + + + + + Production Mode + + + +
+
+ + + Running from Source + + +
+
+ + + + +
+
+ +
+ +

Display

+
+ + + + + + + + + + +
+ +

Grids

+
+ + + + + + + + + + +
+ +

Web Libraries

+
+ + <${b}-table :data="weblibs"> + + <${b}-table-column field="title" + label="Name" + v-slot="props"> + {{ props.row.title }} + + + <${b}-table-column field="configured_version" + label="Version" + v-slot="props"> + {{ props.row.configured_version || props.row.default_version }} + + + <${b}-table-column field="configured_url" + label="URL Override" + v-slot="props"> + {{ props.row.configured_url }} + + + <${b}-table-column field="live_url" + label="Effective (Live) URL" + v-slot="props"> + + save settings and refresh page to see new URL + + + {{ props.row.live_url }} + + + + <${b}-table-column field="actions" + label="Actions" + v-slot="props"> + + % if request.use_oruga: + + % else: + + % endif + Edit + + + + + + % for weblib in weblibs: + ${h.hidden('tailbone.libver.{}'.format(weblib['key']), **{':value': "simpleSettings['tailbone.libver.{}']".format(weblib['key'])})} + ${h.hidden('tailbone.liburl.{}'.format(weblib['key']), **{':value': "simpleSettings['tailbone.liburl.{}']".format(weblib['key'])})} + % endfor + + <${b}-modal has-modal-card + % if request.use_oruga: + v-model:active="editWebLibraryShowDialog" + % else: + :active.sync="editWebLibraryShowDialog" + % endif + > +
+ +
+

Web Library: {{ editWebLibraryRecord.title }}

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + Save + + + Cancel + +
+
+ + +
+ + +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} + + + + +${parent.body()} diff --git a/tailbone/templates/appinfo/index.mako b/tailbone/templates/appinfo/index.mako index faaea935..73f53920 100644 --- a/tailbone/templates/appinfo/index.mako +++ b/tailbone/templates/appinfo/index.mako @@ -1,7 +1,8 @@ ## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/appinfo/index.mako" /> +<%inherit file="/master/index.mako" /> + +<%def name="render_grid_component()"> -<%def name="page_content()">
- ${parent.page_content()} + <${b}-collapse class="panel" open> + + + +
+
+ <${b}-table :data="configFiles"> + + <${b}-table-column field="priority" + label="Priority" + v-slot="props"> + {{ props.row.priority }} + + + <${b}-table-column field="path" + label="File Path" + v-slot="props"> + {{ props.row.path }} + + + +
+
+ + + <${b}-collapse class="panel" + :open="false"> + + + +
+
+ ${parent.render_grid_component()} +
+
+ + +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} + + + + +${parent.body()} diff --git a/tailbone/templates/appsettings.mako b/tailbone/templates/appsettings.mako index ba667e0e..4f935956 100644 --- a/tailbone/templates/appsettings.mako +++ b/tailbone/templates/appsettings.mako @@ -15,8 +15,8 @@ -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} + -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - + + +${parent.body()} diff --git a/tailbone/templates/base.mako b/tailbone/templates/base.mako index 8228f823..c4cbd648 100644 --- a/tailbone/templates/base.mako +++ b/tailbone/templates/base.mako @@ -1,5 +1,4 @@ ## -*- coding: utf-8; -*- -<%namespace file="/wutta-components.mako" import="make_wutta_components" /> <%namespace file="/grids/nav.mako" import="grid_index_nav" /> <%namespace file="/autocomplete.mako" import="tailbone_autocomplete_template" /> <%namespace name="base_meta" file="/base_meta.mako" /> @@ -35,21 +34,17 @@ -
+ ${declare_formposter_mixin()} + + ${self.body()} + +
- ## TODO: this must come before the self.body() call..but why? - ${declare_formposter_mixin()} - - ## content body from derived/child template - ${self.body()} - - ## Vue app - ${self.render_vue_templates()} - ${self.modify_vue_vars()} - ${self.make_vue_components()} - ${self.make_vue_app()} + ${self.render_whole_page_template()} + ${self.make_whole_page_component()} + ${self.make_whole_page_app()} @@ -127,16 +122,16 @@ <%def name="vuejs()"> - ${h.javascript_link(h.get_liburl(request, 'vue', prefix='tailbone'))} - ${h.javascript_link(h.get_liburl(request, 'vue_resource', prefix='tailbone'))} + ${h.javascript_link(h.get_liburl(request, 'vue'))} + ${h.javascript_link(h.get_liburl(request, 'vue_resource'))} <%def name="buefy()"> - ${h.javascript_link(h.get_liburl(request, 'buefy', prefix='tailbone'))} + ${h.javascript_link(h.get_liburl(request, 'buefy'))} <%def name="fontawesome()"> - + <%def name="extra_javascript()"> @@ -158,16 +153,12 @@ @@ -176,7 +167,7 @@ ${h.stylesheet_link(user_css)} % else: ## upstream Buefy CSS - ${h.stylesheet_link(h.get_liburl(request, 'buefy.css', prefix='tailbone'))} + ${h.stylesheet_link(h.get_liburl(request, 'buefy.css'))} % endif @@ -186,7 +177,7 @@ <%def name="head_tags()"> -<%def name="render_vue_template_whole_page()"> +<%def name="render_whole_page_template()"> +<%def name="modify_whole_page_vars()"> + + + +<%def name="finalize_whole_page_vars()"> + ## NOTE: if you override this, must use + + +<%def name="make_whole_page_app()"> + + + <%def name="wtfield(form, name, **kwargs)">
@@ -930,88 +957,3 @@
- -############################## -## vue components + app -############################## - -<%def name="render_vue_templates()"> - ${page_help.declare_vars()} - ${multi_file_upload.declare_vars()} - ${h.javascript_link(request.static_url('tailbone:static/js/tailbone.feedback.js') + '?ver={}'.format(tailbone.__version__))} - ${h.javascript_link(request.static_url('tailbone:static/js/tailbone.buefy.autocomplete.js') + '?ver={}'.format(tailbone.__version__))} - - ## DEPRECATED; called for back-compat - ${self.render_whole_page_template()} - - -## DEPRECATED; remains for back-compat -<%def name="render_whole_page_template()"> - ${self.render_vue_template_whole_page()} - ${self.declare_whole_page_vars()} - - -## DEPRECATED; remains for back-compat -<%def name="declare_whole_page_vars()"> - ${self.render_vue_script_whole_page()} - - -<%def name="modify_vue_vars()"> - ## DEPRECATED; called for back-compat - ${self.modify_whole_page_vars()} - - -## DEPRECATED; remains for back-compat -<%def name="modify_whole_page_vars()"> - - - -<%def name="make_vue_components()"> - ${make_wutta_components()} - ${make_grid_filter_components()} - ${page_help.make_component()} - ${multi_file_upload.make_component()} - - - ## DEPRECATED; called for back-compat - ${self.finalize_whole_page_vars()} - ${self.make_whole_page_component()} - - -## DEPRECATED; remains for back-compat -<%def name="make_whole_page_component()"> - - - -<%def name="make_vue_app()"> - ## DEPRECATED; called for back-compat - ${self.make_whole_page_app()} - - -## DEPRECATED; remains for back-compat -<%def name="make_whole_page_app()"> - - - -############################## -## DEPRECATED -############################## - -<%def name="finalize_whole_page_vars()"> diff --git a/tailbone/templates/base_meta.mako b/tailbone/templates/base_meta.mako index b6376448..00cfdfe9 100644 --- a/tailbone/templates/base_meta.mako +++ b/tailbone/templates/base_meta.mako @@ -1,7 +1,10 @@ ## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/base_meta.mako" /> -<%def name="app_title()">${app.get_node_title()} +<%def name="app_title()">${rattail_app.get_node_title()} + +<%def name="global_title()">${"[STAGE] " if not request.rattail_config.production() else ''}${self.app_title()} + +<%def name="extra_styles()"> <%def name="favicon()"> @@ -10,3 +13,9 @@ <%def name="header_logo()"> ${h.image(request.rattail_config.get('tailbone', 'header_image_url', default=request.static_url('tailbone:static/img/rattail.ico')), "Header Logo", style="height: 49px;")} + +<%def name="footer()"> +

+ powered by ${h.link_to("Rattail", url('about'))} +

+ diff --git a/tailbone/templates/batch/index.mako b/tailbone/templates/batch/index.mako index bea10a97..209fbb0c 100644 --- a/tailbone/templates/batch/index.mako +++ b/tailbone/templates/batch/index.mako @@ -43,7 +43,7 @@
- ${execute_form.render_vue_tag(ref='executeResultsForm')} + <${execute_form.component} ref="executeResultsForm">
@@ -64,17 +64,10 @@ % endif -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} - % if master.results_executable and master.has_perm('execute_multiple'): - ${execute_form.render_vue_template(form_kwargs={'ref': 'actualExecuteForm'}, buttons=False)} - % endif - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} % if master.results_refreshable and master.has_perm('refresh'): - % endif % if master.results_executable and master.has_perm('execute_multiple'): - % endif + +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} + % if master.results_executable and master.has_perm('execute_multiple'): + ${execute_form.render_deform(form_kwargs={'ref': 'actualExecuteForm'}, buttons=False)|n} + % endif + + + +${parent.body()} diff --git a/tailbone/templates/batch/inventory/desktop_form.mako b/tailbone/templates/batch/inventory/desktop_form.mako index cddaa2c5..7e4795a8 100644 --- a/tailbone/templates/batch/inventory/desktop_form.mako +++ b/tailbone/templates/batch/inventory/desktop_form.mako @@ -147,7 +147,7 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/batch/pos/view.mako b/tailbone/templates/batch/pos/view.mako index 5ecabd4d..0da755aa 100644 --- a/tailbone/templates/batch/pos/view.mako +++ b/tailbone/templates/batch/pos/view.mako @@ -1,9 +1,13 @@ ## -*- coding: utf-8; -*- <%inherit file="/batch/view.mako" /> -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + +${parent.body()} diff --git a/tailbone/templates/batch/vendorcatalog/configure.mako b/tailbone/templates/batch/vendorcatalog/configure.mako index 4f91cb02..0d57053e 100644 --- a/tailbone/templates/batch/vendorcatalog/configure.mako +++ b/tailbone/templates/batch/vendorcatalog/configure.mako @@ -39,9 +39,14 @@
-<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/batch/vendorcatalog/create.mako b/tailbone/templates/batch/vendorcatalog/create.mako index d9d62bd1..d25c8f16 100644 --- a/tailbone/templates/batch/vendorcatalog/create.mako +++ b/tailbone/templates/batch/vendorcatalog/create.mako @@ -1,16 +1,16 @@ ## -*- coding: utf-8; -*- <%inherit file="/batch/create.mako" /> -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/batch/view.mako b/tailbone/templates/batch/view.mako index 7c81ab0e..5e3328d9 100644 --- a/tailbone/templates/batch/view.mako +++ b/tailbone/templates/batch/view.mako @@ -85,11 +85,13 @@
% if batch.executed:

+ Batch was executed ${h.pretty_datetime(request.rattail_config, batch.executed)} by ${batch.executed_by}

% elif master.handler.executable(batch): % if master.has_perm('execute'): +

Batch has not yet been executed.

${execution_described|n}
- ${execute_form.render_vue_tag(ref='executeBatchForm')} + <${execute_form.component} ref="executeBatchForm"> + - + % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/master/clone.mako b/tailbone/templates/master/clone.mako index 4c7e4662..59d6aea2 100644 --- a/tailbone/templates/master/clone.mako +++ b/tailbone/templates/master/clone.mako @@ -34,9 +34,9 @@ ${h.end_form()} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/master/create.mako b/tailbone/templates/master/create.mako index d7dcbbd8..27cd404c 100644 --- a/tailbone/templates/master/create.mako +++ b/tailbone/templates/master/create.mako @@ -1,6 +1,6 @@ ## -*- coding: utf-8; -*- <%inherit file="/form.mako" /> -<%def name="title()">New ${model_title_plural if getattr(master, 'creates_multiple', False) else model_title} +<%def name="title()">New ${model_title_plural if master.creates_multiple else model_title} ${parent.body()} diff --git a/tailbone/templates/master/delete.mako b/tailbone/templates/master/delete.mako index d2f517d9..30bb50ab 100644 --- a/tailbone/templates/master/delete.mako +++ b/tailbone/templates/master/delete.mako @@ -27,21 +27,26 @@ - {{ formSubmitting ? "Working, please wait..." : "${form.button_label_submit}" }} + {{ formButtonText }} ${h.end_form()} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/master/form.mako b/tailbone/templates/master/form.mako index 17063c21..dfe56fa8 100644 --- a/tailbone/templates/master/form.mako +++ b/tailbone/templates/master/form.mako @@ -1,18 +1,18 @@ ## -*- coding: utf-8; -*- <%inherit file="/form.mako" /> -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - - % if form is not Undefined and hasattr(form, 'render_included_templates'): + % if form is not Undefined: ${form.render_included_templates()} % endif + + +${parent.body()} diff --git a/tailbone/templates/master/index.mako b/tailbone/templates/master/index.mako index a2d26c60..33592559 100644 --- a/tailbone/templates/master/index.mako +++ b/tailbone/templates/master/index.mako @@ -15,7 +15,7 @@ <%def name="grid_tools()"> ## grid totals - % if getattr(master, 'supports_grid_totals', False): + % if master.supports_grid_totals:
-## DEPRECATED; remains for back-compat -<%def name="render_this_page()"> - ${self.page_content()} - - <%def name="page_content()"> % if download_results_path: @@ -288,42 +283,56 @@ ${self.render_grid_component()} - % if master.deletable and master.has_perm('delete') and getattr(master, 'delete_confirm', 'full') == 'simple': + % if master.deletable and request.has_perm('{}.delete'.format(permission_prefix)) and master.delete_confirm == 'simple': ${h.form('#', ref='deleteObjectForm')} ${h.csrf_token(request)} ${h.end_form()} % endif -<%def name="render_grid_component()"> - ${grid.render_vue_tag()} - - -############################## -## vue components -############################## - -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} - - ## DEPRECATED; called for back-compat - ${self.make_grid_component()} - - -## DEPRECATED; remains for back-compat <%def name="make_grid_component()"> - ${grid.render_vue_template(tools=capture(self.grid_tools).strip(), context_menu=capture(self.context_menu_items).strip())} + ## TODO: stop using |n filter? + ${grid.render_complete(tools=capture(self.grid_tools).strip(), context_menu=capture(self.context_menu_items).strip())|n} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="render_grid_component()"> + <${grid.component} ref="grid" :csrftoken="csrftoken" + % if master.deletable and request.has_perm('{}.delete'.format(permission_prefix)) and master.delete_confirm == 'simple': + @deleteActionClicked="deleteObject" + % endif + > + + + +<%def name="make_this_page_component()"> + + ## define grid + ${self.make_grid_component()} + + ${parent.make_this_page_component()} + + ## finalize grid + + + +<%def name="render_this_page()"> + ${self.page_content()} + + +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - - + +${parent.body()} diff --git a/tailbone/templates/master/merge.mako b/tailbone/templates/master/merge.mako index 487d258d..5d90043f 100644 --- a/tailbone/templates/master/merge.mako +++ b/tailbone/templates/master/merge.mako @@ -109,8 +109,8 @@ -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} - -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - - + +${parent.body()} diff --git a/tailbone/templates/master/versions.mako b/tailbone/templates/master/versions.mako index a6bb14f0..307674b8 100644 --- a/tailbone/templates/master/versions.mako +++ b/tailbone/templates/master/versions.mako @@ -16,16 +16,27 @@ ${self.page_content()} +<%def name="make_this_page_component()"> + ${parent.make_this_page_component()} + + + +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} + + ## TODO: stop using |n filter + ${grid.render_complete()|n} + + <%def name="page_content()"> - ${grid.render_vue_tag(**{':csrftoken': 'csrftoken'})} + + -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} - ${grid.render_vue_template()} - - -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - ${grid.render_vue_finalize()} - +${parent.body()} diff --git a/tailbone/templates/master/view.mako b/tailbone/templates/master/view.mako index 118c028c..fe44caa9 100644 --- a/tailbone/templates/master/view.mako +++ b/tailbone/templates/master/view.mako @@ -8,7 +8,7 @@ <%def name="render_instance_header_title_extras()"> - % if getattr(master, 'touchable', False) and master.has_perm('touch'): + % if master.touchable and master.has_perm('touch'): @@ -93,7 +93,7 @@ ${parent.render_this_page()} ## render row grid - % if getattr(master, 'has_rows', False): + % if master.has_rows:
% if rows_title:

${rows_title}

@@ -120,7 +120,9 @@

- ${versions_grid.render_vue_tag(ref='versionsGrid', **{'@view-revision': 'viewRevision'})} + + <${b}-modal :width="1200" % if request.use_oruga: @@ -196,7 +198,6 @@

{{ version.model_title }} - ({{ version.operation }})

<%def name="render_row_grid_component()"> - ${rows_grid.render_vue_tag(id='rowGrid', ref='rowGrid')} + -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} - % if getattr(master, 'has_rows', False): - ${rows_grid.render_vue_template(allow_save_defaults=False, tools=capture(self.render_row_grid_tools))} +<%def name="render_this_page_template()"> + % if master.has_rows: + ## TODO: stop using |n filter + ${rows_grid.render_complete(allow_save_defaults=False, tools=capture(self.render_row_grid_tools))|n} % endif + ${parent.render_this_page_template()} % if expose_versions: - ${versions_grid.render_vue_template()} + ${versions_grid.render_complete()|n} % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + % endif + + +<%def name="modify_whole_page_vars()"> + ${parent.modify_whole_page_vars()} + -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - % if getattr(master, 'has_rows', False): - ${rows_grid.render_vue_finalize()} - % endif - % if expose_versions: - ${versions_grid.render_vue_finalize()} - % endif +<%def name="finalize_this_page_vars()"> + ${parent.finalize_this_page_vars()} + + + +${parent.body()} diff --git a/tailbone/templates/members/configure.mako b/tailbone/templates/members/configure.mako index f1f0e39f..465bf611 100644 --- a/tailbone/templates/members/configure.mako +++ b/tailbone/templates/members/configure.mako @@ -52,9 +52,9 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/messages/create.mako b/tailbone/templates/messages/create.mako index 39236f75..4a15573b 100644 --- a/tailbone/templates/messages/create.mako +++ b/tailbone/templates/messages/create.mako @@ -32,14 +32,14 @@ % endif -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} ${message_recipients_template()} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/messages/index.mako b/tailbone/templates/messages/index.mako index eaa4b6c9..3fc82fd3 100644 --- a/tailbone/templates/messages/index.mako +++ b/tailbone/templates/messages/index.mako @@ -22,15 +22,15 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} % if request.matched_route.name in ('messages.inbox', 'messages.archive'): - % endif + + +${parent.body()} diff --git a/tailbone/templates/messages/view.mako b/tailbone/templates/messages/view.mako index 36418698..2e2baa60 100644 --- a/tailbone/templates/messages/view.mako +++ b/tailbone/templates/messages/view.mako @@ -82,19 +82,22 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/ordering/configure.mako b/tailbone/templates/ordering/configure.mako deleted file mode 100644 index dc505c42..00000000 --- a/tailbone/templates/ordering/configure.mako +++ /dev/null @@ -1,74 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="/configure.mako" /> - -<%def name="form_content()"> - -

Workflows

-
- -

- Users can only choose from the workflows enabled below. -

- - - - From Scratch - - - - - - From Order File - - - -
- -

Vendors

-
- - - - Allow ordering for any vendor - - - -
- -

Order Parsers

-
- -

- Only the selected file parsers will be exposed to users. -

- - % for Parser in order_parsers: - - - ${Parser.title} - - - % endfor - -
- - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - - diff --git a/tailbone/templates/ordering/view.mako b/tailbone/templates/ordering/view.mako index 34a6085f..aed6fd75 100644 --- a/tailbone/templates/ordering/view.mako +++ b/tailbone/templates/ordering/view.mako @@ -21,8 +21,8 @@ % endif -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} % if not batch.executed and not batch.complete and master.has_perm('edit_row'): % endif + + +${parent.body()} diff --git a/tailbone/templates/ordering/worksheet.mako b/tailbone/templates/ordering/worksheet.mako index eb2077e7..ca1abf6e 100644 --- a/tailbone/templates/ordering/worksheet.mako +++ b/tailbone/templates/ordering/worksheet.mako @@ -199,8 +199,9 @@ -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} + - -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - - + +############################## +## page body +############################## + +${parent.body()} diff --git a/tailbone/templates/page.mako b/tailbone/templates/page.mako index 43b0a266..17d87c9a 100644 --- a/tailbone/templates/page.mako +++ b/tailbone/templates/page.mako @@ -1,26 +1,42 @@ ## -*- coding: utf-8; -*- <%inherit file="/base.mako" /> -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} - ${self.render_vue_template_this_page()} +<%def name="context_menu_items()"> + % if context_menu_list_items is not Undefined: + % for item in context_menu_list_items: +
  • ${item}
    • + % endfor + % endif -<%def name="render_vue_template_this_page()"> - ## DEPRECATED; called for back-compat - ${self.render_this_page_template()} +<%def name="page_content()"> + +<%def name="render_this_page()"> +
    + +
    + ${self.page_content()} +
    + +
      + ${self.context_menu_items()} +
    + +
    <%def name="render_this_page_template()"> - -## DEPRECATED; remains for back-compat -<%def name="render_this_page()"> -
    - -
    - ${self.page_content()} -
    - - ## DEPRECATED; remains for back-compat -
      - ${self.context_menu_items()} -
    -
    +<%def name="modify_this_page_vars()"> + ## NOTE: if you override this, must use -############################## -## DEPRECATED -############################## -<%def name="declare_this_page_vars()"> - -<%def name="modify_this_page_vars()"> - -<%def name="finalize_this_page_vars()"> +${self.render_this_page_template()} +${self.make_this_page_component()} diff --git a/tailbone/templates/people/index.mako b/tailbone/templates/people/index.mako index cd6fddf1..c819050a 100644 --- a/tailbone/templates/people/index.mako +++ b/tailbone/templates/people/index.mako @@ -3,7 +3,7 @@ <%def name="grid_tools()"> - % if getattr(master, 'mergeable', False) and master.has_perm('request_merge'): + % if master.mergeable and master.has_perm('request_merge'): -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + +${parent.body()} diff --git a/tailbone/templates/people/merge-requests/view.mako b/tailbone/templates/people/merge-requests/view.mako index e2db1476..9e8905cf 100644 --- a/tailbone/templates/people/merge-requests/view.mako +++ b/tailbone/templates/people/merge-requests/view.mako @@ -18,10 +18,10 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} % if not instance.merged and request.has_perm('people.merge'): - % endif + +${parent.body()} diff --git a/tailbone/templates/people/view.mako b/tailbone/templates/people/view.mako index 15c669fa..184f2b91 100644 --- a/tailbone/templates/people/view.mako +++ b/tailbone/templates/people/view.mako @@ -2,16 +2,6 @@ <%inherit file="/master/view.mako" /> <%namespace file="/util.mako" import="view_profiles_helper" /> -<%def name="page_content()"> - ${parent.page_content()} - % if not instance.users and request.has_perm('users.create'): - ${h.form(url('people.make_user'), ref='makeUserForm')} - ${h.csrf_token(request)} - ${h.hidden('person_uuid', value=instance.uuid)} - ${h.end_form()} - % endif - - <%def name="object_helpers()"> ${parent.object_helpers()} ${view_profiles_helper([instance])} @@ -19,15 +9,15 @@ <%def name="render_form()">
    - <${form.vue_tagname} v-on:make-user="makeUser"> +
    -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + +<%def name="page_content()"> + ${parent.page_content()} + % if not instance.users and request.has_perm('users.create'): + ${h.form(url('people.make_user'), ref='makeUserForm')} + ${h.csrf_token(request)} + ${h.hidden('person_uuid', value=instance.uuid)} + ${h.end_form()} + % endif + + + +${parent.body()} + diff --git a/tailbone/templates/people/view_profile.mako b/tailbone/templates/people/view_profile.mako index 6ca5a84c..8044f7c6 100644 --- a/tailbone/templates/people/view_profile.mako +++ b/tailbone/templates/people/view_profile.mako @@ -15,7 +15,7 @@ <%def name="content_title()"> - ${dynamic_content_title or str(instance)} + ${dynamic_content_title} <%def name="render_instance_header_title_extras()"> @@ -1008,7 +1008,7 @@
    - + {{ customer._key }} @@ -1966,106 +1966,37 @@
    - + ${self.render_user_tab_template()} + ${self.render_profile_info_template()} <%def name="declare_personal_tab_vars()"> -<%def name="make_profile_info_component()"> +<%def name="declare_profile_info_vars()"> + -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} +<%def name="make_profile_info_component()"> + ${self.declare_profile_info_vars()} + -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + - % if request.has_perm('people_profile.view_versions'): +<%def name="make_this_page_component()"> + ${parent.make_this_page_component()} + ${self.make_personal_tab_component()} + + % if expose_members: + ${self.make_member_tab_component()} + % endif + + ${self.make_customer_tab_component()} + % if expose_customer_shoppers: + ${self.make_shopper_tab_component()} + % endif + ${self.make_employee_tab_component()} + ${self.make_notes_tab_component()} + + % if expose_transactions: + + ${self.make_transactions_tab_component()} + % endif + + ${self.make_user_tab_component()} + ${self.make_profile_info_component()} + + +<%def name="modify_whole_page_vars()"> + ${parent.modify_whole_page_vars()} + + % if request.has_perm('people_profile.view_versions'): + - - -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - - ${self.make_personal_tab_component()} - - % if expose_members: - ${self.make_member_tab_component()} - % endif - - ${self.make_customer_tab_component()} - % if expose_customer_shoppers: - ${self.make_shopper_tab_component()} - % endif - ${self.make_employee_tab_component()} - ${self.make_notes_tab_component()} - - % if expose_transactions: - - ${self.make_transactions_tab_component()} % endif - - ${self.make_user_tab_component()} - ${self.make_profile_info_component()} -############################## -## DEPRECATED -############################## -<%def name="declare_profile_info_vars()"> +${parent.body()} diff --git a/tailbone/templates/poser/reports/view.mako b/tailbone/templates/poser/reports/view.mako index cb8b51aa..aac0c7ae 100644 --- a/tailbone/templates/poser/reports/view.mako +++ b/tailbone/templates/poser/reports/view.mako @@ -62,13 +62,19 @@
    -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} % if master.has_perm('replace'): - + % endif + +${parent.body()} diff --git a/tailbone/templates/poser/setup.mako b/tailbone/templates/poser/setup.mako index 239e7db2..8d01bb33 100644 --- a/tailbone/templates/poser/setup.mako +++ b/tailbone/templates/poser/setup.mako @@ -118,9 +118,14 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/principal/find_by_perm.mako b/tailbone/templates/principal/find_by_perm.mako index ddc44e3d..1a0a4b7d 100644 --- a/tailbone/templates/principal/find_by_perm.mako +++ b/tailbone/templates/principal/find_by_perm.mako @@ -10,20 +10,12 @@ -<%def name="principal_table()"> -
    - ${grid.render_table_element(data_prop='principalsData')|n} -
    - - -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} + + +<%def name="principal_table()"> +
    + ${grid.render_table_element(data_prop='principalsData')|n} +
    + + +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} + + + +<%def name="make_this_page_component()"> + ${parent.make_this_page_component()} - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - - - -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - + + +${parent.body()} diff --git a/tailbone/templates/products/batch.mako b/tailbone/templates/products/batch.mako index db029e5a..a4a4d503 100644 --- a/tailbone/templates/products/batch.mako +++ b/tailbone/templates/products/batch.mako @@ -22,7 +22,7 @@ <%def name="render_form_innards()"> - ${h.form(request.current_route_url(), **{'@submit': 'submit{}'.format(form.vue_component)})} + ${h.form(request.current_route_url(), **{'@submit': 'submit{}'.format(form.component_studly)})} ${h.csrf_token(request)}
    @@ -43,8 +43,8 @@
    - {{ ${form.vue_component}ButtonText }} + :disabled="${form.component_studly}Submitting"> + {{ ${form.component_studly}ButtonText }} Cancel @@ -55,33 +55,32 @@ <%def name="render_form_template()"> - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - <% request.register_component(form.vue_tagname, form.vue_component) %> - + + +${parent.body()} diff --git a/tailbone/templates/products/configure.mako b/tailbone/templates/products/configure.mako index a43a85d4..6121af67 100644 --- a/tailbone/templates/products/configure.mako +++ b/tailbone/templates/products/configure.mako @@ -95,9 +95,9 @@
    -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/products/index.mako b/tailbone/templates/products/index.mako index 5ffa9512..0d4bc410 100644 --- a/tailbone/templates/products/index.mako +++ b/tailbone/templates/products/index.mako @@ -36,16 +36,16 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} % if label_profiles and master.has_perm('print_labels'): - % endif + + +${parent.body()} diff --git a/tailbone/templates/products/pending/view.mako b/tailbone/templates/products/pending/view.mako index 72c9c76d..765c8838 100644 --- a/tailbone/templates/products/pending/view.mako +++ b/tailbone/templates/products/pending/view.mako @@ -2,6 +2,11 @@ <%inherit file="/master/view.mako" /> <%namespace name="product_lookup" file="/products/lookup.mako" /> +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} + ${product_lookup.tailbone_product_lookup_template()} + + <%def name="page_content()"> ${parent.page_content()} @@ -62,14 +67,9 @@ % endif -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} - ${product_lookup.tailbone_product_lookup_template()} - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - -<%def name="make_vue_components()"> - ${parent.make_vue_components()} +<%def name="make_this_page_component()"> + ${parent.make_this_page_component()} ${product_lookup.tailbone_product_lookup_component()} + + +${parent.body()} diff --git a/tailbone/templates/products/view.mako b/tailbone/templates/products/view.mako index 66ca3128..bd4afc7f 100644 --- a/tailbone/templates/products/view.mako +++ b/tailbone/templates/products/view.mako @@ -282,9 +282,9 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/purchases/credits/index.mako b/tailbone/templates/purchases/credits/index.mako index 94028bdb..4248d4ad 100644 --- a/tailbone/templates/purchases/credits/index.mako +++ b/tailbone/templates/purchases/credits/index.mako @@ -59,24 +59,27 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/receiving/configure.mako b/tailbone/templates/receiving/configure.mako index a36dde43..f613e13e 100644 --- a/tailbone/templates/receiving/configure.mako +++ b/tailbone/templates/receiving/configure.mako @@ -69,12 +69,12 @@

    Vendors

    - - + - Allow receiving for any vendor + Only allow batch for "supported" vendors diff --git a/tailbone/templates/receiving/view.mako b/tailbone/templates/receiving/view.mako index 710dec4a..5f103d7f 100644 --- a/tailbone/templates/receiving/view.mako +++ b/tailbone/templates/receiving/view.mako @@ -139,15 +139,9 @@ % endif -<%def name="object_helpers()"> - ${self.render_status_breakdown()} - ${self.render_po_vs_invoice_helper()} - ${self.render_execute_helper()} - ${self.render_tools_helper()} - +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} % if allow_edit_catalog_unit_cost or allow_edit_invoice_unit_cost: + + +${parent.body()} diff --git a/tailbone/templates/receiving/view_row.mako b/tailbone/templates/receiving/view_row.mako index 086754c6..5077539c 100644 --- a/tailbone/templates/receiving/view_row.mako +++ b/tailbone/templates/receiving/view_row.mako @@ -484,9 +484,9 @@
    -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/reports/generated/choose.mako b/tailbone/templates/reports/generated/choose.mako index 0921530c..a952fb6a 100644 --- a/tailbone/templates/reports/generated/choose.mako +++ b/tailbone/templates/reports/generated/choose.mako @@ -53,13 +53,13 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/reports/generated/delete.mako b/tailbone/templates/reports/generated/delete.mako index f60a9819..0c994ad0 100644 --- a/tailbone/templates/reports/generated/delete.mako +++ b/tailbone/templates/reports/generated/delete.mako @@ -1,11 +1,16 @@ ## -*- coding: utf-8; -*- <%inherit file="/master/delete.mako" /> -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/reports/generated/view.mako b/tailbone/templates/reports/generated/view.mako index cce6f346..6260efba 100644 --- a/tailbone/templates/reports/generated/view.mako +++ b/tailbone/templates/reports/generated/view.mako @@ -23,11 +23,16 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/reports/inventory.mako b/tailbone/templates/reports/inventory.mako index cc5adc10..f051959f 100644 --- a/tailbone/templates/reports/inventory.mako +++ b/tailbone/templates/reports/inventory.mako @@ -48,10 +48,15 @@ ${h.end_form()} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/reports/ordering.mako b/tailbone/templates/reports/ordering.mako index 61ccdb16..1e526792 100644 --- a/tailbone/templates/reports/ordering.mako +++ b/tailbone/templates/reports/ordering.mako @@ -81,9 +81,9 @@ <%def name="extra_fields()"> -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/reports/problems/view.mako b/tailbone/templates/reports/problems/view.mako index 5cdf2be5..026c73dc 100644 --- a/tailbone/templates/reports/problems/view.mako +++ b/tailbone/templates/reports/problems/view.mako @@ -45,10 +45,11 @@ Cancel - ${h.form(master.get_action_url('execute', instance), **{'@submit': 'runReportSubmitting = true'})} + ${h.form(master.get_action_url('execute', instance))} ${h.csrf_token(request)} @@ -61,12 +62,12 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/roles/create.mako b/tailbone/templates/roles/create.mako index 89dd56c3..625b2675 100644 --- a/tailbone/templates/roles/create.mako +++ b/tailbone/templates/roles/create.mako @@ -6,11 +6,15 @@ ${h.stylesheet_link(request.static_url('tailbone:static/css/perms.css'))} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + +${parent.body()} diff --git a/tailbone/templates/roles/edit.mako b/tailbone/templates/roles/edit.mako index e77cca33..67f63013 100644 --- a/tailbone/templates/roles/edit.mako +++ b/tailbone/templates/roles/edit.mako @@ -6,11 +6,15 @@ ${h.stylesheet_link(request.static_url('tailbone:static/css/perms.css'))} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + +${parent.body()} diff --git a/tailbone/templates/roles/view.mako b/tailbone/templates/roles/view.mako index f5588695..0f4ce472 100644 --- a/tailbone/templates/roles/view.mako +++ b/tailbone/templates/roles/view.mako @@ -6,12 +6,12 @@ ${h.stylesheet_link(request.static_url('tailbone:static/css/perms.css'))} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + +${parent.body()} diff --git a/tailbone/templates/settings/email/configure.mako b/tailbone/templates/settings/email/configure.mako index f9c815c2..ef487809 100644 --- a/tailbone/templates/settings/email/configure.mako +++ b/tailbone/templates/settings/email/configure.mako @@ -86,9 +86,9 @@
    -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/settings/email/index.mako b/tailbone/templates/settings/email/index.mako index ab8d6fa4..dbc963b9 100644 --- a/tailbone/templates/settings/email/index.mako +++ b/tailbone/templates/settings/email/index.mako @@ -15,10 +15,10 @@ ${parent.render_grid_component()} -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} % if master.has_perm('configure'): - % endif + +${parent.body()} diff --git a/tailbone/templates/settings/email/view.mako b/tailbone/templates/settings/email/view.mako index 73ad7066..c1bc5ed4 100644 --- a/tailbone/templates/settings/email/view.mako +++ b/tailbone/templates/settings/email/view.mako @@ -6,8 +6,8 @@ -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} +<%def name="render_this_page_template()"> + ${parent.render_this_page_template()} + + +<%def name="make_this_page_component()"> + ${parent.make_this_page_component()} -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - - + +${parent.body()} diff --git a/tailbone/templates/tables/create.mako b/tailbone/templates/tables/create.mako index 34844c5c..4fc2eb96 100644 --- a/tailbone/templates/tables/create.mako +++ b/tailbone/templates/tables/create.mako @@ -695,9 +695,9 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/tempmon/appliances/view.mako b/tailbone/templates/tempmon/appliances/view.mako index a55af922..07a524b8 100644 --- a/tailbone/templates/tempmon/appliances/view.mako +++ b/tailbone/templates/tempmon/appliances/view.mako @@ -8,9 +8,14 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/tempmon/clients/view.mako b/tailbone/templates/tempmon/clients/view.mako index 434da4c8..cff22fed 100644 --- a/tailbone/templates/tempmon/clients/view.mako +++ b/tailbone/templates/tempmon/clients/view.mako @@ -22,9 +22,14 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/tempmon/dashboard.mako b/tailbone/templates/tempmon/dashboard.mako index befaf8b4..396b0e68 100644 --- a/tailbone/templates/tempmon/dashboard.mako +++ b/tailbone/templates/tempmon/dashboard.mako @@ -59,9 +59,9 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/tempmon/probes/graph.mako b/tailbone/templates/tempmon/probes/graph.mako index 94a440e0..412f25dd 100644 --- a/tailbone/templates/tempmon/probes/graph.mako +++ b/tailbone/templates/tempmon/probes/graph.mako @@ -66,9 +66,9 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/themes/butterball/base.mako b/tailbone/templates/themes/butterball/base.mako index b69eacfb..b0e43a37 100644 --- a/tailbone/templates/themes/butterball/base.mako +++ b/tailbone/templates/themes/butterball/base.mako @@ -20,21 +20,38 @@ -
    +
    ## TODO: this must come before the self.body() call..but why? ${declare_formposter_mixin()} + ## global components used by various (but not all) pages + ${make_field_components()} + ${make_grid_filter_components()} + + ## global components for buefy-based template compatibility + ${make_http_plugin()} + ${make_buefy_plugin()} + ${make_buefy_components()} + + ## special global components, used by WholePage + ${self.make_menu_search_component()} + ${page_help.render_template()} + ${page_help.declare_vars()} + % if request.has_perm('common.feedback'): + ${self.make_feedback_component()} + % endif + + ## WholePage component + ${self.make_whole_page_component()} + ## content body from derived/child template ${self.body()} ## Vue app - ${self.render_vue_templates()} - ${self.modify_vue_vars()} - ${self.make_vue_components()} - ${self.make_vue_app()} + ${self.make_whole_page_app()} @@ -54,12 +71,12 @@ { ## TODO: eventually version / url should be configurable "imports": { - "vue": "${h.get_liburl(request, 'bb_vue', prefix='tailbone')}", - "@oruga-ui/oruga-next": "${h.get_liburl(request, 'bb_oruga', prefix='tailbone')}", - "@oruga-ui/theme-bulma": "${h.get_liburl(request, 'bb_oruga_bulma', prefix='tailbone')}", - "@fortawesome/fontawesome-svg-core": "${h.get_liburl(request, 'bb_fontawesome_svg_core', prefix='tailbone')}", - "@fortawesome/free-solid-svg-icons": "${h.get_liburl(request, 'bb_free_solid_svg_icons', prefix='tailbone')}", - "@fortawesome/vue-fontawesome": "${h.get_liburl(request, 'bb_vue_fontawesome', prefix='tailbone')}" + "vue": "${h.get_liburl(request, 'bb_vue')}", + "@oruga-ui/oruga-next": "${h.get_liburl(request, 'bb_oruga')}", + "@oruga-ui/theme-bulma": "${h.get_liburl(request, 'bb_oruga_bulma')}", + "@fortawesome/fontawesome-svg-core": "${h.get_liburl(request, 'bb_fontawesome_svg_core')}", + "@fortawesome/free-solid-svg-icons": "${h.get_liburl(request, 'bb_free_solid_svg_icons')}", + "@fortawesome/vue-fontawesome": "${h.get_liburl(request, 'bb_vue_fontawesome')}" } } @@ -75,7 +92,7 @@ % if user_css: ${h.stylesheet_link(user_css)} % else: - ${h.stylesheet_link(h.get_liburl(request, 'bb_oruga_bulma_css', prefix='tailbone'))} + ${h.stylesheet_link(h.get_liburl(request, 'bb_oruga_bulma_css'))} % endif @@ -579,7 +596,7 @@ -<%def name="render_vue_template_whole_page()"> +<%def name="render_whole_page_template()"> + +## ${multi_file_upload.render_template()} <%def name="render_this_page_component()"> @@ -909,7 +928,7 @@ ${h.form(url('stop_root'), ref='stopBeingRootForm')} ${h.csrf_token(request)} - Stop being root @@ -918,7 +937,7 @@ ${h.form(url('become_root'), ref='startBeingRootForm')} ${h.csrf_token(request)} - Become root @@ -947,23 +966,23 @@ <%def name="render_crud_header_buttons()"> -% if master and master.viewing and not getattr(master, 'cloning', False): + % if master and master.viewing and not master.cloning: ## TODO: is there a better way to check if viewing parent? % if parent_instance is Undefined: % if master.editable and instance_editable and master.has_perm('edit'): - % endif - % if not getattr(master, 'cloning', False) and getattr(master, 'cloneable', False) and master.has_perm('clone'): - % endif % if master.deletable and instance_deletable and master.has_perm('delete'): - @@ -972,7 +991,7 @@ % else: ## viewing row % if instance_deletable and master.has_perm('delete_row'): - @@ -981,13 +1000,13 @@ % endif % elif master and master.editing: % if master.viewable and master.has_perm('view'): - % endif % if master.deletable and instance_deletable and master.has_perm('delete'): - @@ -995,20 +1014,20 @@ % endif % elif master and master.deleting: % if master.viewable and master.has_perm('view'): - % endif % if master.editable and instance_editable and master.has_perm('edit'): - % endif - % elif master and getattr(master, 'cloning', False): + % elif master and master.cloning: % if master.viewable and master.has_perm('view'): - @@ -1049,7 +1068,9 @@ % endif -<%def name="render_vue_script_whole_page()"> +<%def name="declare_whole_page_vars()"> +## ${multi_file_upload.declare_vars()} + -############################## -## vue components + app -############################## +<%def name="modify_whole_page_vars()"> -<%def name="render_vue_templates()"> -## ${multi_file_upload.render_template()} -## ${multi_file_upload.declare_vars()} +## TODO: do we really need this? +## <%def name="finalize_whole_page_vars()"> - ## global components used by various (but not all) pages - ${make_field_components()} - ${make_grid_filter_components()} - - ## global components for buefy-based template compatibility - ${make_http_plugin()} - ${make_buefy_plugin()} - ${make_buefy_components()} - - ## special global components, used by WholePage - ${self.make_menu_search_component()} - ${page_help.render_template()} - ${page_help.declare_vars()} - % if request.has_perm('common.feedback'): - ${self.make_feedback_component()} - % endif - - ## DEPRECATED; called for back-compat - ${self.render_whole_page_template()} - - ## DEPRECATED; called for back-compat - ${self.declare_whole_page_vars()} - - -## DEPRECATED; remains for back-compat -<%def name="render_whole_page_template()"> - ${self.render_vue_template_whole_page()} - ${self.render_vue_script_whole_page()} - - -<%def name="modify_vue_vars()"> - ## DEPRECATED; called for back-compat - ${self.modify_whole_page_vars()} - - -<%def name="make_vue_components()"> - ${page_help.make_component()} - ## ${multi_file_upload.make_component()} - - ## DEPRECATED; called for back-compat (?) - ${self.make_whole_page_component()} - - -## DEPRECATED; remains for back-compat <%def name="make_whole_page_component()"> + ${self.render_whole_page_template()} + ${self.declare_whole_page_vars()} + ${self.modify_whole_page_vars()} +## ${self.finalize_whole_page_vars()} + + ${page_help.make_component()} +## ${multi_file_upload.make_component()} + <% request.register_component('whole-page', 'WholePage') %> -<%def name="make_vue_app()"> - ## DEPRECATED; called for back-compat - ${self.make_whole_page_app()} - - -## DEPRECATED; remains for back-compat <%def name="make_whole_page_app()"> - -############################## -## DEPRECATED -############################## - -<%def name="declare_whole_page_vars()"> - -<%def name="modify_whole_page_vars()"> diff --git a/tailbone/templates/themes/butterball/buefy-components.mako b/tailbone/templates/themes/butterball/buefy-components.mako index 3a2cd798..51a0deb9 100644 --- a/tailbone/templates/themes/butterball/buefy-components.mako +++ b/tailbone/templates/themes/butterball/buefy-components.mako @@ -666,7 +666,6 @@ <%def name="make_b_tooltip_component()"> diff --git a/tailbone/templates/themes/butterball/field-components.mako b/tailbone/templates/themes/butterball/field-components.mako index 917083c4..d79c88f4 100644 --- a/tailbone/templates/themes/butterball/field-components.mako +++ b/tailbone/templates/themes/butterball/field-components.mako @@ -517,9 +517,6 @@ }, parseTime(value) { - if (!value) { - return value - } if (value.getHours) { return value diff --git a/tailbone/templates/themes/waterpark/base.mako b/tailbone/templates/themes/waterpark/base.mako deleted file mode 100644 index 774479ba..00000000 --- a/tailbone/templates/themes/waterpark/base.mako +++ /dev/null @@ -1,504 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/base.mako" /> -<%namespace name="base_meta" file="/base_meta.mako" /> -<%namespace file="/formposter.mako" import="declare_formposter_mixin" /> -<%namespace file="/grids/filter-components.mako" import="make_grid_filter_components" /> -<%namespace name="page_help" file="/page_help.mako" /> - -<%def name="base_styles()"> - ${parent.base_styles()} - ${h.stylesheet_link(request.static_url('tailbone:static/css/diffs.css') + '?ver={}'.format(tailbone.__version__))} - - - -<%def name="before_content()"> - ## TODO: this must come before the self.body() call..but why? - ${declare_formposter_mixin()} - - -<%def name="render_navbar_brand()"> -
    - -
    - ${base_meta.header_logo()} - -
    -     -
    - - -
    - -
    - - -<%def name="render_navbar_start()"> -
    - -
    - - - -
    - - % for topitem in menus: - % if topitem['is_link']: - ${h.link_to(topitem['title'], topitem['url'], target=topitem['target'], class_='navbar-item')} - % else: -
    - ${topitem['title']} -
    - % for item in topitem['items']: - % if item['is_menu']: - <% item_hash = id(item) %> - <% toggle = 'menu_{}_shown'.format(item_hash) %> - - % for subitem in item['items']: - % if subitem['is_sep']: -
    - % else: - ${h.link_to("{}".format(subitem['title']), subitem['url'], class_='navbar-item nested', target=subitem['target'], **{'v-show': toggle})} - % endif - % endfor - % else: - % if item['is_sep']: -
    - % else: - ${h.link_to(item['title'], item['url'], class_='navbar-item', target=item['target'])} - % endif - % endif - % endfor -
    -
    - % endif - % endfor - -
    - - -<%def name="render_theme_picker()"> - % if expose_theme_picker and request.has_perm('common.change_app_theme'): -
    - ${h.form(url('change_theme'), method="post", ref='themePickerForm')} - ${h.csrf_token(request)} - -
    - Theme: - - % for option in theme_picker_options: - - % endfor - -
    - ${h.end_form()} -
    - % endif - - -<%def name="render_feedback_button()"> - -
    - -
    - - ${parent.render_feedback_button()} - - -<%def name="render_crud_header_buttons()"> - % if master: - % if master.viewing: - % if instance_editable and master.has_perm('edit'): - - % endif - % if getattr(master, 'cloneable', False) and not master.cloning and master.has_perm('clone'): - - % endif - % if instance_deletable and master.has_perm('delete'): - - % endif - % elif master.editing: - % if master.has_perm('view'): - - % endif - % if instance_deletable and master.has_perm('delete'): - - % endif - % elif master.deleting: - % if master.has_perm('view'): - - % endif - % if instance_editable and master.has_perm('edit'): - - % endif - % endif - % endif - - -<%def name="render_prevnext_header_buttons()"> - % if show_prev_next is not Undefined and show_prev_next: - % if prev_url: - - % else: - - Older - - % endif - % if next_url: - - % else: - - Newer - - % endif - % endif - - -<%def name="render_this_page_component()"> - - - -<%def name="render_vue_template_feedback()"> - - - -<%def name="render_vue_script_feedback()"> - ${parent.render_vue_script_feedback()} - - - -<%def name="render_vue_templates()"> - ${parent.render_vue_templates()} - ${page_help.render_template()} - ${page_help.declare_vars()} - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - - - -<%def name="make_vue_components()"> - ${parent.make_vue_components()} - ${h.javascript_link(request.static_url('tailbone:static/js/tailbone.buefy.datepicker.js') + f'?ver={tailbone.__version__}')} - ${h.javascript_link(request.static_url('tailbone:static/js/tailbone.buefy.numericinput.js') + f'?ver={tailbone.__version__}')} - ${h.javascript_link(request.static_url('tailbone:static/js/tailbone.buefy.oncebutton.js') + f'?ver={tailbone.__version__}')} - ${h.javascript_link(request.static_url('tailbone:static/js/tailbone.buefy.timepicker.js') + f'?ver={tailbone.__version__}')} - ${make_grid_filter_components()} - ${page_help.make_component()} - diff --git a/tailbone/templates/themes/waterpark/configure.mako b/tailbone/templates/themes/waterpark/configure.mako deleted file mode 100644 index 7a3e5261..00000000 --- a/tailbone/templates/themes/waterpark/configure.mako +++ /dev/null @@ -1,78 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/configure.mako" /> -<%namespace name="tailbone_base" file="tailbone:templates/configure.mako" /> - -<%def name="input_file_templates_section()"> - ${tailbone_base.input_file_templates_section()} - - -<%def name="output_file_templates_section()"> - ${tailbone_base.output_file_templates_section()} - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - - diff --git a/tailbone/templates/themes/waterpark/form.mako b/tailbone/templates/themes/waterpark/form.mako deleted file mode 100644 index f88d6821..00000000 --- a/tailbone/templates/themes/waterpark/form.mako +++ /dev/null @@ -1,10 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/form.mako" /> - -<%def name="render_vue_template_form()"> - % if form is not Undefined: - ${form.render_vue_template(buttons=capture(self.render_form_buttons))} - % endif - - -<%def name="render_form_buttons()"> diff --git a/tailbone/templates/themes/waterpark/master/configure.mako b/tailbone/templates/themes/waterpark/master/configure.mako deleted file mode 100644 index 51da5b0a..00000000 --- a/tailbone/templates/themes/waterpark/master/configure.mako +++ /dev/null @@ -1,2 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/master/configure.mako" /> diff --git a/tailbone/templates/themes/waterpark/master/create.mako b/tailbone/templates/themes/waterpark/master/create.mako deleted file mode 100644 index 23399b9e..00000000 --- a/tailbone/templates/themes/waterpark/master/create.mako +++ /dev/null @@ -1,2 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/master/create.mako" /> diff --git a/tailbone/templates/themes/waterpark/master/delete.mako b/tailbone/templates/themes/waterpark/master/delete.mako deleted file mode 100644 index a15dfaf8..00000000 --- a/tailbone/templates/themes/waterpark/master/delete.mako +++ /dev/null @@ -1,46 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="tailbone:templates/form.mako" /> - -<%def name="title()">Delete ${model_title}: ${instance_title} - -<%def name="render_form()"> -
    - - You are about to delete the following ${model_title} and all associated data: - - ${parent.render_form()} - - -<%def name="render_form_buttons()"> -
    - - Are you sure about this? - -
    - - ${h.form(request.current_route_url(), **{'@submit': 'submitForm'})} - ${h.csrf_token(request)} -
    - - - {{ formSubmitting ? "Working, please wait..." : "${form.button_label_submit}" }} - -
    - ${h.end_form()} - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - - diff --git a/tailbone/templates/themes/waterpark/master/edit.mako b/tailbone/templates/themes/waterpark/master/edit.mako deleted file mode 100644 index 18a2fa2f..00000000 --- a/tailbone/templates/themes/waterpark/master/edit.mako +++ /dev/null @@ -1,2 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/master/edit.mako" /> diff --git a/tailbone/templates/themes/waterpark/master/form.mako b/tailbone/templates/themes/waterpark/master/form.mako deleted file mode 100644 index db56843b..00000000 --- a/tailbone/templates/themes/waterpark/master/form.mako +++ /dev/null @@ -1,2 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/master/form.mako" /> diff --git a/tailbone/templates/themes/waterpark/master/index.mako b/tailbone/templates/themes/waterpark/master/index.mako deleted file mode 100644 index e6702599..00000000 --- a/tailbone/templates/themes/waterpark/master/index.mako +++ /dev/null @@ -1,299 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/master/index.mako" /> - -<%def name="grid_tools()"> - - ## grid totals - % if getattr(master, 'supports_grid_totals', False): -
    - - {{ gridTotalsFetching ? "Working, please wait..." : "Show Totals" }} - -
    - Totals: {{ gridTotalsDisplay }} -
    -
    - % endif - - ## download search results - % if getattr(master, 'results_downloadable', False) and master.has_perm('download_results'): -
    - - Download Results - - - ${h.form(url('{}.download_results'.format(route_prefix)), ref='download_results_form')} - ${h.csrf_token(request)} - - - ${h.end_form()} - - -
    - -
    -

    - There are - - {{ total.toLocaleString('en') }} ${model_title_plural} - - matching your current filters. -

    -

    - You may download this set as a single data file if you like. -

    -
    - - - Excel downloads for large data sets can take a long time to - generate, and bog down the server in the meantime. You are - encouraged to choose CSV for a large data set, even though - the end result (file size) may be larger with CSV. - - -
    - -
    - - - % for key, label in master.download_results_supported_formats().items(): - - % endfor - - -
    - -
    - -
    -

    - Will use DEFAULT fields. -

    -

    - Will use ALL fields. -

    -
    -
    - -
    - - Use Default Fields - - - Use All Fields - - - Choose Fields - -
    - -
    -
    -
    - - - - - -
    -
    -

    - - < - -
    - - > - -
    -
    - - - - - -
    -
    -
    - -
    -
    -
    - -
    - - Cancel - - - -
    -
    -     -
    - % endif - - ## download rows for search results - % if getattr(master, 'has_rows', False) and master.results_rows_downloadable and master.has_perm('download_results_rows'): - - {{ downloadResultsRowsButtonText }} - - ${h.form(url('{}.download_results_rows'.format(route_prefix)), ref='downloadResultsRowsForm')} - ${h.csrf_token(request)} - ${h.end_form()} - % endif - - ## merge 2 objects - % if getattr(master, 'mergeable', False) and request.has_perm('{}.merge'.format(permission_prefix)): - - ${h.form(url('{}.merge'.format(route_prefix)), class_='control', **{'@submit': 'submitMergeForm'})} - ${h.csrf_token(request)} - - - {{ mergeFormButtonText }} - - ${h.end_form()} - % endif - - ## enable / disable selected objects - % if getattr(master, 'supports_set_enabled_toggle', False) and master.has_perm('enable_disable_set'): - - ${h.form(url('{}.enable_set'.format(route_prefix)), class_='control', ref='enable_selected_form')} - ${h.csrf_token(request)} - ${h.hidden('uuids', v_model='selected_uuids')} - - {{ enableSelectedText }} - - ${h.end_form()} - - ${h.form(url('{}.disable_set'.format(route_prefix)), ref='disable_selected_form', class_='control')} - ${h.csrf_token(request)} - ${h.hidden('uuids', v_model='selected_uuids')} - - {{ disableSelectedText }} - - ${h.end_form()} - % endif - - ## delete selected objects - % if getattr(master, 'set_deletable', False) and master.has_perm('delete_set'): - ${h.form(url('{}.delete_set'.format(route_prefix)), ref='delete_selected_form', class_='control')} - ${h.csrf_token(request)} - ${h.hidden('uuids', v_model='selected_uuids')} - - {{ deleteSelectedText }} - - ${h.end_form()} - % endif - - ## delete search results - % if getattr(master, 'bulk_deletable', False) and request.has_perm('{}.bulk_delete'.format(permission_prefix)): - ${h.form(url('{}.bulk_delete'.format(route_prefix)), ref='delete_results_form', class_='control')} - ${h.csrf_token(request)} - - {{ deleteResultsText }} - - ${h.end_form()} - % endif - - - -## DEPRECATED; remains for back-compat -<%def name="render_this_page()"> - ${self.page_content()} - - -<%def name="render_vue_template_grid()"> - ${grid.render_vue_template(tools=capture(self.grid_tools).strip(), context_menu=capture(self.context_menu_items).strip())} - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - - diff --git a/tailbone/templates/themes/waterpark/master/view.mako b/tailbone/templates/themes/waterpark/master/view.mako deleted file mode 100644 index 99194469..00000000 --- a/tailbone/templates/themes/waterpark/master/view.mako +++ /dev/null @@ -1,2 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/master/view.mako" /> diff --git a/tailbone/templates/themes/waterpark/page.mako b/tailbone/templates/themes/waterpark/page.mako deleted file mode 100644 index 66ce47dc..00000000 --- a/tailbone/templates/themes/waterpark/page.mako +++ /dev/null @@ -1,48 +0,0 @@ -## -*- coding: utf-8; -*- -<%inherit file="wuttaweb:templates/page.mako" /> - -<%def name="render_vue_template_this_page()"> - - - -## DEPRECATED; remains for back-compat -<%def name="render_this_page()"> -
    - -
    - ${self.page_content()} -
    - - ## DEPRECATED; remains for back-compat -
      - ${self.context_menu_items()} -
    -
    - - -## DEPRECATED; remains for back-compat -<%def name="context_menu_items()"> - % if context_menu_list_items is not Undefined: - % for item in context_menu_list_items: -
  • ${item}
    • - % endfor - % endif - - -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - - diff --git a/tailbone/templates/trainwreck/transactions/configure.mako b/tailbone/templates/trainwreck/transactions/configure.mako index 10c57e18..99b43fde 100644 --- a/tailbone/templates/trainwreck/transactions/configure.mako +++ b/tailbone/templates/trainwreck/transactions/configure.mako @@ -3,19 +3,6 @@ <%def name="form_content()"> -

    Display

    -
    - - - - Auto-collapse header when viewing transaction - - -
    -

    Rotation

    @@ -62,9 +49,14 @@
    -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/trainwreck/transactions/rollover.mako b/tailbone/templates/trainwreck/transactions/rollover.mako index f26515b5..b36e7bc3 100644 --- a/tailbone/templates/trainwreck/transactions/rollover.mako +++ b/tailbone/templates/trainwreck/transactions/rollover.mako @@ -48,9 +48,14 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/trainwreck/transactions/view.mako b/tailbone/templates/trainwreck/transactions/view.mako index 630950cf..2be51c7d 100644 --- a/tailbone/templates/trainwreck/transactions/view.mako +++ b/tailbone/templates/trainwreck/transactions/view.mako @@ -1,11 +1,15 @@ ## -*- coding: utf-8; -*- <%inherit file="/master/view.mako" /> -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + +${parent.body()} diff --git a/tailbone/templates/trainwreck/transactions/view_row.mako b/tailbone/templates/trainwreck/transactions/view_row.mako index 2507492e..9abcb8ba 100644 --- a/tailbone/templates/trainwreck/transactions/view_row.mako +++ b/tailbone/templates/trainwreck/transactions/view_row.mako @@ -1,11 +1,16 @@ ## -*- coding: utf-8; -*- <%inherit file="/master/view_row.mako" /> -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/units-of-measure/index.mako b/tailbone/templates/units-of-measure/index.mako index 4815fc79..597cabfd 100644 --- a/tailbone/templates/units-of-measure/index.mako +++ b/tailbone/templates/units-of-measure/index.mako @@ -51,17 +51,20 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} % if master.has_perm('collect_wild_uoms'): - + % endif + + +${parent.body()} diff --git a/tailbone/templates/upgrades/configure.mako b/tailbone/templates/upgrades/configure.mako index 9439f830..f7af685c 100644 --- a/tailbone/templates/upgrades/configure.mako +++ b/tailbone/templates/upgrades/configure.mako @@ -111,9 +111,9 @@
    -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/upgrades/view.mako b/tailbone/templates/upgrades/view.mako index c3fca81d..6ae110e0 100644 --- a/tailbone/templates/upgrades/view.mako +++ b/tailbone/templates/upgrades/view.mako @@ -137,11 +137,11 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/users/preferences.mako b/tailbone/templates/users/preferences.mako index ecfdd1c7..c2e17396 100644 --- a/tailbone/templates/users/preferences.mako +++ b/tailbone/templates/users/preferences.mako @@ -42,9 +42,14 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/users/view.mako b/tailbone/templates/users/view.mako index d1afd218..ed2b5f16 100644 --- a/tailbone/templates/users/view.mako +++ b/tailbone/templates/users/view.mako @@ -76,12 +76,12 @@ % endif -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} +<%def name="modify_this_page_vars()"> + ${parent.modify_this_page_vars()} % if master.has_perm('manage_api_tokens'): - % endif + + +${parent.body()} diff --git a/tailbone/templates/vendors/configure.mako b/tailbone/templates/vendors/configure.mako index 6b135346..79dad455 100644 --- a/tailbone/templates/vendors/configure.mako +++ b/tailbone/templates/vendors/configure.mako @@ -44,9 +44,14 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/views/model/create.mako b/tailbone/templates/views/model/create.mako index e902fd48..c5e22cfb 100644 --- a/tailbone/templates/views/model/create.mako +++ b/tailbone/templates/views/model/create.mako @@ -259,9 +259,9 @@ def includeme(config): -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/templates/workorders/view.mako b/tailbone/templates/workorders/view.mako index 432e011d..8740b4c9 100644 --- a/tailbone/templates/workorders/view.mako +++ b/tailbone/templates/workorders/view.mako @@ -145,9 +145,9 @@ -<%def name="modify_vue_vars()"> - ${parent.modify_vue_vars()} - + + +${parent.body()} diff --git a/tailbone/util.py b/tailbone/util.py index 71aa35e3..c1a0e1d5 100644 --- a/tailbone/util.py +++ b/tailbone/util.py @@ -39,12 +39,6 @@ from pyramid.renderers import get_renderer from pyramid.interfaces import IRoutesMapper from webhelpers2.html import HTML, tags -from wuttaweb.util import (get_form_data as wutta_get_form_data, - get_libver as wutta_get_libver, - get_liburl as wutta_get_liburl, - get_csrf_token as wutta_get_csrf_token, - render_csrf_token) - log = logging.getLogger(__name__) @@ -61,30 +55,37 @@ class SortColumn(object): def get_csrf_token(request): - """ """ - warnings.warn("tailbone.util.get_csrf_token() is deprecated; " - "please use wuttaweb.util.get_csrf_token() instead", - DeprecationWarning, stacklevel=2) - return wutta_get_csrf_token(request) + """ + Convenience function to retrieve the effective CSRF token for the given + request. + """ + token = request.session.get_csrf_token() + if token is None: + token = request.session.new_csrf_token() + return token def csrf_token(request, name='_csrf'): - """ """ - warnings.warn("tailbone.util.csrf_token() is deprecated; " - "please use wuttaweb.util.render_csrf_token() instead", - DeprecationWarning, stacklevel=2) - return render_csrf_token(request, name=name) + """ + Convenience function. Returns CSRF hidden tag inside hidden DIV. + """ + token = get_csrf_token(request) + return HTML.tag("div", tags.hidden(name, value=token), style="display:none;") def get_form_data(request): """ - DEPECATED - use :func:`wuttaweb:wuttaweb.util.get_form_data()` - instead. + Returns the effective form data for the given request. Mostly + this is a convenience, to return either POST or JSON depending on + the type of request. """ - warnings.warn("tailbone.util.get_form_data() is deprecated; " - "please use wuttaweb.util.get_form_data() instead", - DeprecationWarning, stacklevel=2) - return wutta_get_form_data(request) + # nb. we prefer JSON only if no POST is present + # TODO: this seems to work for our use case at least, but perhaps + # there is a better way? see also + # https://docs.pylonsproject.org/projects/pyramid/en/latest/api/request.html#pyramid.request.Request.is_xhr + if (request.is_xhr or request.content_type == 'application/json') and not request.POST: + return request.json_body + return request.POST def get_global_search_options(request): @@ -104,32 +105,154 @@ def get_global_search_options(request): return options -def get_libver(request, key, fallback=True, default_only=False): # pragma: no cover +def get_libver(request, key, fallback=True, default_only=False): """ - DEPRECATED - use :func:`wuttaweb:wuttaweb.util.get_libver()` - instead. + Return the appropriate URL for the library identified by ``key``. """ - warnings.warn("tailbone.util.get_libver() is deprecated; " - "please use wuttaweb.util.get_libver() instead", - DeprecationWarning, stacklevel=2) + config = request.rattail_config - return wutta_get_libver(request, key, prefix='tailbone', - configured_only=not fallback, - default_only=default_only) + if not default_only: + version = config.get('tailbone', 'libver.{}'.format(key)) + if version: + return version + + if not fallback and not default_only: + + if key == 'buefy': + version = config.get('tailbone', 'buefy_version') + if version: + return version + + elif key == 'buefy.css': + version = get_libver(request, 'buefy', fallback=False) + if version: + return version + + elif key == 'vue': + version = config.get('tailbone', 'vue_version') + if version: + return version + + return + + if key == 'buefy': + if not default_only: + version = config.get('tailbone', 'buefy_version') + if version: + return version + return 'latest' + + elif key == 'buefy.css': + version = get_libver(request, 'buefy', default_only=default_only) + if version: + return version + return 'latest' + + elif key == 'vue': + if not default_only: + version = config.get('tailbone', 'vue_version') + if version: + return version + return '2.6.14' + + elif key == 'vue_resource': + return 'latest' + + elif key == 'fontawesome': + return '5.3.1' + + elif key == 'bb_vue': + return '3.4.31' + + elif key == 'bb_oruga': + return '0.8.12' + + elif key in ('bb_oruga_bulma', 'bb_oruga_bulma_css'): + return '0.3.0' + + elif key == 'bb_fontawesome_svg_core': + return '6.5.2' + + elif key == 'bb_free_solid_svg_icons': + return '6.5.2' + + elif key == 'bb_vue_fontawesome': + return '3.0.6' -def get_liburl(request, key, fallback=True): # pragma: no cover +def get_liburl(request, key, fallback=True): """ - DEPRECATED - use :func:`wuttaweb:wuttaweb.util.get_liburl()` - instead. + Return the appropriate URL for the library identified by ``key``. """ - warnings.warn("tailbone.util.get_liburl() is deprecated; " - "please use wuttaweb.util.get_liburl() instead", - DeprecationWarning, stacklevel=2) + config = request.rattail_config - return wutta_get_liburl(request, key, prefix='tailbone', - configured_only=not fallback, - default_only=False) + url = config.get('tailbone', 'liburl.{}'.format(key)) + if url: + return url + + if not fallback: + return + + version = get_libver(request, key) + + static = config.get('tailbone.static_libcache.module') + if static: + static = importlib.import_module(static) + needed = request.environ['fanstatic.needed'] + liburl = needed.library_url(static.libcache) + '/' + # nb. add custom url prefix if needed, e.g. /theo + if request.script_name: + liburl = request.script_name + liburl + + if key == 'buefy': + return 'https://unpkg.com/buefy@{}/dist/buefy.min.js'.format(version) + + elif key == 'buefy.css': + return 'https://unpkg.com/buefy@{}/dist/buefy.min.css'.format(version) + + elif key == 'vue': + return 'https://unpkg.com/vue@{}/dist/vue.min.js'.format(version) + + elif key == 'vue_resource': + return 'https://cdn.jsdelivr.net/npm/vue-resource@{}'.format(version) + + elif key == 'fontawesome': + return 'https://use.fontawesome.com/releases/v{}/js/all.js'.format(version) + + elif key == 'bb_vue': + if static and hasattr(static, 'bb_vue_js'): + return liburl + static.bb_vue_js.relpath + return f'https://unpkg.com/vue@{version}/dist/vue.esm-browser.prod.js' + + elif key == 'bb_oruga': + if static and hasattr(static, 'bb_oruga_js'): + return liburl + static.bb_oruga_js.relpath + return f'https://unpkg.com/@oruga-ui/oruga-next@{version}/dist/oruga.mjs' + + elif key == 'bb_oruga_bulma': + if static and hasattr(static, 'bb_oruga_bulma_js'): + return liburl + static.bb_oruga_bulma_js.relpath + return f'https://unpkg.com/@oruga-ui/theme-bulma@{version}/dist/bulma.mjs' + + elif key == 'bb_oruga_bulma_css': + if static and hasattr(static, 'bb_oruga_bulma_css'): + return liburl + static.bb_oruga_bulma_css.relpath + return f'https://unpkg.com/@oruga-ui/theme-bulma@{version}/dist/bulma.css' + + elif key == 'bb_fontawesome_svg_core': + if static and hasattr(static, 'bb_fontawesome_svg_core_js'): + return liburl + static.bb_fontawesome_svg_core_js.relpath + return f'https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-svg-core@{version}/+esm' + + elif key == 'bb_free_solid_svg_icons': + if static and hasattr(static, 'bb_free_solid_svg_icons_js'): + return liburl + static.bb_free_solid_svg_icons_js.relpath + return f'https://cdn.jsdelivr.net/npm/@fortawesome/free-solid-svg-icons@{version}/+esm' + + elif key == 'bb_vue_fontawesome': + if static and hasattr(static, 'bb_vue_fontawesome_js'): + return liburl + static.bb_vue_fontawesome_js.relpath + return f'https://cdn.jsdelivr.net/npm/@fortawesome/vue-fontawesome@{version}/+esm' def pretty_datetime(config, value): @@ -338,8 +461,8 @@ def should_use_oruga(request): supports (and therefore should use) Oruga + Vue 3 as opposed to the default of Buefy + Vue 2. """ - theme = request.registry.settings.get('tailbone.theme') - if theme and 'butterball' in theme: + theme = request.registry.settings['tailbone.theme'] + if 'butterball' in theme: return True return False diff --git a/tailbone/views/auth.py b/tailbone/views/auth.py index eceab803..730d7b6a 100644 --- a/tailbone/views/auth.py +++ b/tailbone/views/auth.py @@ -24,6 +24,8 @@ Auth Views """ +from rattail.db.auth import set_user_password + import colander from deform import widget as dfwidget from pyramid.httpexceptions import HTTPForbidden @@ -44,6 +46,28 @@ class UserLogin(colander.MappingSchema): widget=dfwidget.PasswordWidget()) +@colander.deferred +def current_password_correct(node, kw): + request = kw['request'] + app = request.rattail_config.get_app() + auth = app.get_auth_handler() + user = kw['user'] + def validate(node, value): + if not auth.authenticate_user(Session(), user.username, value): + raise colander.Invalid(node, "The password is incorrect") + return validate + + +class ChangePassword(colander.MappingSchema): + + current_password = colander.SchemaNode(colander.String(), + widget=dfwidget.PasswordWidget(), + validator=current_password_correct) + + new_password = colander.SchemaNode(colander.String(), + widget=dfwidget.CheckedPasswordWidget()) + + class AuthenticationView(View): def forbidden(self): @@ -80,7 +104,6 @@ class AuthenticationView(View): form.save_label = "Login" form.show_reset = True form.show_cancel = False - form.button_icon_submit = 'user' if form.validate(): user = self.authenticate_user(form.validated['username'], form.validated['password']) @@ -94,6 +117,10 @@ class AuthenticationView(View): else: self.request.session.flash("Invalid username or password", 'error') + image_url = self.rattail_config.get( + 'tailbone', 'main_image_url', + default=self.request.static_url('tailbone:static/img/home_logo.png')) + # nb. hacky..but necessary, to add the refs, for autofocus # (also add key handler, so ENTER acts like TAB) dform = form.make_deform_form() @@ -106,6 +133,7 @@ class AuthenticationView(View): return { 'form': form, 'referrer': referrer, + 'image_url': image_url, 'index_title': app.get_node_title(), 'help_url': global_help_url(self.rattail_config), } @@ -154,27 +182,10 @@ class AuthenticationView(View): self.request.user)) return self.redirect(self.request.get_referrer()) - def check_user_password(node, value): - auth = self.app.get_auth_handler() - user = self.request.user - if not auth.check_user_password(user, value): - node.raise_invalid("The password is incorrect") - - schema = colander.Schema() - - schema.add(colander.SchemaNode(colander.String(), - name='current_password', - widget=dfwidget.PasswordWidget(), - validator=check_user_password)) - - schema.add(colander.SchemaNode(colander.String(), - name='new_password', - widget=dfwidget.CheckedPasswordWidget())) - + schema = ChangePassword().bind(user=self.request.user, request=self.request) form = forms.Form(schema=schema, request=self.request) if form.validate(): - auth = self.app.get_auth_handler() - auth.set_user_password(self.request.user, form.validated['new_password']) + set_user_password(self.request.user, form.validated['new_password']) self.request.session.flash("Your password has been changed.") return self.redirect(self.request.get_referrer()) diff --git a/tailbone/views/batch/core.py b/tailbone/views/batch/core.py index c162b579..f4f74a34 100644 --- a/tailbone/views/batch/core.py +++ b/tailbone/views/batch/core.py @@ -46,11 +46,10 @@ import colander from deform import widget as dfwidget from webhelpers2.html import HTML, tags -from wuttaweb.util import render_csrf_token - from tailbone import forms, grids from tailbone.db import Session from tailbone.views import MasterView +from tailbone.util import csrf_token log = logging.getLogger(__name__) @@ -187,9 +186,7 @@ class BatchMasterView(MasterView): breakdown = self.make_status_breakdown(batch) factory = self.get_grid_factory() - g = factory(self.request, - key='batch_row_status_breakdown', - data=[], + g = factory('batch_row_status_breakdown', [], columns=['title', 'count']) g.set_click_handler('title', "autoFilterStatus(props.row)") kwargs['status_breakdown_data'] = breakdown @@ -384,7 +381,7 @@ class BatchMasterView(MasterView): f.set_label('executed_by', "Executed by") # notes - f.set_type('notes', 'text_wrapped') + f.set_type('notes', 'text') # if self.creating and self.request.user: # batch = fs.model @@ -442,7 +439,7 @@ class BatchMasterView(MasterView): form = [ begin_form, - render_csrf_token(self.request), + csrf_token(self.request), tags.hidden('complete', value=value), submit, tags.end_form(), @@ -696,7 +693,7 @@ class BatchMasterView(MasterView): batch = self.get_instance() # TODO: most of this logic is copied from MasterView, should refactor/merge somehow... - if 'actions' not in kwargs: + if 'main_actions' not in kwargs: actions = [] # view action @@ -717,7 +714,7 @@ class BatchMasterView(MasterView): actions.append(self.make_action('delete', icon='trash', url=self.row_delete_action_url)) kwargs.setdefault('delete_speedbump', self.rows_deletable_speedbump) - kwargs['actions'] = actions + kwargs['main_actions'] = actions return super().make_row_grid_kwargs(**kwargs) @@ -862,7 +859,7 @@ class BatchMasterView(MasterView): if not schema: schema = colander.Schema() - kwargs['vue_tagname'] = 'execute-form' + kwargs['component'] = 'execute-form' form = forms.Form(schema=schema, request=self.request, defaults=defaults, **kwargs) self.configure_execute_form(form) return form diff --git a/tailbone/views/batch/pos.py b/tailbone/views/batch/pos.py index b6fef6c8..11031353 100644 --- a/tailbone/views/batch/pos.py +++ b/tailbone/views/batch/pos.py @@ -195,7 +195,6 @@ class POSBatchView(BatchMasterView): factory = self.get_grid_factory() g = factory( - self.request, key=f'{route_prefix}.taxes', data=[], columns=[ diff --git a/tailbone/views/common.py b/tailbone/views/common.py index f4d98c05..7e9ddb09 100644 --- a/tailbone/views/common.py +++ b/tailbone/views/common.py @@ -25,7 +25,6 @@ Various common views """ import os -import warnings from collections import OrderedDict from rattail.batch import consume_batch_id @@ -51,31 +50,13 @@ class CommonView(View): Home page view. """ app = self.get_rattail_app() - - # maybe auto-redirect anons to login if not self.request.user: - redirect = self.config.get_bool('wuttaweb.home_redirect_to_login') - if redirect is None: - redirect = self.config.get_bool('tailbone.login_is_home') - if redirect is not None: - warnings.warn("tailbone.login_is_home setting is deprecated; " - "please set wuttaweb.home_redirect_to_login instead", - DeprecationWarning) - else: - # TODO: this is opposite of upstream default, should change - redirect = True - if redirect: - return self.redirect(self.request.route_url('login')) + if self.rattail_config.getbool('tailbone', 'login_is_home', default=True): + raise self.redirect(self.request.route_url('login')) - image_url = self.config.get('wuttaweb.logo_url') - if not image_url: - image_url = self.config.get('tailbone.main_image_url') - if image_url: - warnings.warn("tailbone.main_image_url setting is deprecated; " - "please set wuttaweb.logo_url instead", - DeprecationWarning) - else: - image_url = self.request.static_url('tailbone:static/img/home_logo.png') + image_url = self.rattail_config.get( + 'tailbone', 'main_image_url', + default=self.request.static_url('tailbone:static/img/home_logo.png')) context = { 'image_url': image_url, diff --git a/tailbone/views/core.py b/tailbone/views/core.py index 88b2519f..b0658d80 100644 --- a/tailbone/views/core.py +++ b/tailbone/views/core.py @@ -58,10 +58,9 @@ class View: config = self.rattail_config if config: - self.config = config - self.app = self.config.get_app() - self.model = self.app.model - self.enum = self.app.enum + app = config.get_app() + self.model = app.model + self.enum = config.get_enum() @property def rattail_config(self): diff --git a/tailbone/views/customers.py b/tailbone/views/customers.py index 7e49ccef..2958a98a 100644 --- a/tailbone/views/customers.py +++ b/tailbone/views/customers.py @@ -208,7 +208,8 @@ class CustomerView(MasterView): url = lambda r, i: self.request.route_url( f'{route_prefix}.view', **self.get_action_route_kwargs(r)) # nb. insert to slot 1, just after normal View action - g.actions.insert(1, self.make_action('view_raw', url=url, icon='eye')) + g.main_actions.insert(1, self.make_action( + 'view_raw', url=url, icon='eye')) g.set_link('name') g.set_link('person') @@ -470,8 +471,7 @@ class CustomerView(MasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.people', + key='{}.people'.format(route_prefix), data=[], columns=[ 'shopper_number', @@ -500,8 +500,7 @@ class CustomerView(MasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.people', + key='{}.people'.format(route_prefix), data=[], columns=[ 'full_name', @@ -513,13 +512,13 @@ class CustomerView(MasterView): ) if self.request.has_perm('people.view'): - g.actions.append(self.make_action('view', icon='eye')) + g.main_actions.append(self.make_action('view', icon='eye')) if self.request.has_perm('people.edit'): - g.actions.append(self.make_action('edit', icon='edit')) + g.main_actions.append(self.make_action('edit', icon='edit')) if self.people_detachable and self.has_perm('detach_person'): - g.actions.append(self.make_action('detach', icon='minus-circle', - link_class='has-text-warning', - click_handler="$emit('detach-person', props.row._action_url_detach)")) + g.main_actions.append(self.make_action('detach', icon='minus-circle', + link_class='has-text-warning', + click_handler="$emit('detach-person', props.row._action_url_detach)")) return HTML.literal( g.render_table_element(data_prop='peopleData')) diff --git a/tailbone/views/custorders/items.py b/tailbone/views/custorders/items.py index e7edf3aa..d8e39f55 100644 --- a/tailbone/views/custorders/items.py +++ b/tailbone/views/custorders/items.py @@ -385,7 +385,6 @@ class CustomerOrderItemView(MasterView): factory = self.get_grid_factory() g = factory( - self.request, key=f'{route_prefix}.events', data=[], columns=[ diff --git a/tailbone/views/custorders/orders.py b/tailbone/views/custorders/orders.py index b1a9831a..f76d4d93 100644 --- a/tailbone/views/custorders/orders.py +++ b/tailbone/views/custorders/orders.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar +# Copyright © 2010-2023 Lance Edgar # # This file is part of Rattail. # @@ -29,12 +29,13 @@ import logging from sqlalchemy import orm -from rattail.db.model import CustomerOrder, CustomerOrderItem -from rattail.util import simple_error +from rattail.db import model +from rattail.util import pretty_quantity, simple_error from rattail.batch import get_batch_handler from webhelpers2.html import tags, HTML +from tailbone.db import Session from tailbone.views import MasterView @@ -45,7 +46,7 @@ class CustomerOrderView(MasterView): """ Master view for customer orders """ - model_class = CustomerOrder + model_class = model.CustomerOrder route_prefix = 'custorders' editable = False configurable = True @@ -79,7 +80,7 @@ class CustomerOrderView(MasterView): ] has_rows = True - model_row_class = CustomerOrderItem + model_row_class = model.CustomerOrderItem rows_viewable = False row_labels = { @@ -115,17 +116,15 @@ class CustomerOrderView(MasterView): ] def __init__(self, request): - super().__init__(request) + super(CustomerOrderView, self).__init__(request) self.batch_handler = self.get_batch_handler() def query(self, session): - model = self.app.model return session.query(model.CustomerOrder)\ .options(orm.joinedload(model.CustomerOrder.customer)) def configure_grid(self, g): super().configure_grid(g) - model = self.app.model # id g.set_link('id') @@ -164,7 +163,7 @@ class CustomerOrderView(MasterView): return f"#{order.id} for {order.customer or order.person}" def configure_form(self, f): - super().configure_form(f) + super(CustomerOrderView, self).configure_form(f) order = f.model_instance f.set_readonly('id') @@ -234,7 +233,6 @@ class CustomerOrderView(MasterView): class_='has-background-warning') def get_row_data(self, order): - model = self.app.model return self.Session.query(model.CustomerOrderItem)\ .filter(model.CustomerOrderItem.order == order) @@ -242,13 +240,11 @@ class CustomerOrderView(MasterView): return item.order def make_row_grid_kwargs(self, **kwargs): - kwargs = super().make_row_grid_kwargs(**kwargs) + kwargs = super(CustomerOrderView, self).make_row_grid_kwargs(**kwargs) - actions = kwargs.get('actions', []) - if not actions: - actions.append(self.make_action('view', icon='eye', - url=self.row_view_action_url)) - kwargs['actions'] = actions + assert not kwargs['main_actions'] + kwargs['main_actions'].append( + self.make_action('view', icon='eye', url=self.row_view_action_url)) return kwargs @@ -257,7 +253,7 @@ class CustomerOrderView(MasterView): return self.request.route_url('custorders.items.view', uuid=item.uuid) def configure_row_grid(self, g): - super().configure_row_grid(g) + super(CustomerOrderView, self).configure_row_grid(g) app = self.get_rattail_app() handler = app.get_batch_handler( 'custorder', @@ -427,7 +423,6 @@ class CustomerOrderView(MasterView): if not user: raise RuntimeError("this feature requires a user to be logged in") - model = self.app.model try: # there should be at most *one* new batch per user batch = self.Session.query(model.CustomerOrderBatch)\ @@ -493,7 +488,6 @@ class CustomerOrderView(MasterView): if not uuid: return {'error': "Must specify a customer UUID"} - model = self.app.model customer = self.Session.get(model.Customer, uuid) if not customer: return {'error': "Customer not found"} @@ -514,7 +508,6 @@ class CustomerOrderView(MasterView): return info def assign_contact(self, batch, data): - model = self.app.model kwargs = {} # this will either be a Person or Customer UUID @@ -669,7 +662,6 @@ class CustomerOrderView(MasterView): if not uuid: return {'error': "Must specify a product UUID"} - model = self.app.model product = self.Session.get(model.Product, uuid) if not product: return {'error': "Product not found"} @@ -733,7 +725,8 @@ class CustomerOrderView(MasterView): return app.render_currency(obj.unit_price) def normalize_row(self, row): - products_handler = self.app.get_products_handler() + app = self.get_rattail_app() + products_handler = app.get_products_handler() data = { 'uuid': row.uuid, @@ -749,20 +742,20 @@ class CustomerOrderView(MasterView): 'product_size': row.product_size, 'product_weighed': row.product_weighed, - 'case_quantity': self.app.render_quantity(row.case_quantity), - 'cases_ordered': self.app.render_quantity(row.cases_ordered), - 'units_ordered': self.app.render_quantity(row.units_ordered), - 'order_quantity': self.app.render_quantity(row.order_quantity), + 'case_quantity': pretty_quantity(row.case_quantity), + 'cases_ordered': pretty_quantity(row.cases_ordered), + 'units_ordered': pretty_quantity(row.units_ordered), + 'order_quantity': pretty_quantity(row.order_quantity), 'order_uom': row.order_uom, 'order_uom_choices': self.uom_choices_for_row(row), - 'discount_percent': self.app.render_quantity(row.discount_percent), + 'discount_percent': pretty_quantity(row.discount_percent), 'department_display': row.department_name, 'unit_price': float(row.unit_price) if row.unit_price is not None else None, 'unit_price_display': self.get_unit_price_display(row), 'total_price': float(row.total_price) if row.total_price is not None else None, - 'total_price_display': self.app.render_currency(row.total_price), + 'total_price_display': app.render_currency(row.total_price), 'status_code': row.status_code, 'status_text': row.status_text, @@ -770,15 +763,15 @@ class CustomerOrderView(MasterView): if row.unit_regular_price: data['unit_regular_price'] = float(row.unit_regular_price) - data['unit_regular_price_display'] = self.app.render_currency(row.unit_regular_price) + data['unit_regular_price_display'] = app.render_currency(row.unit_regular_price) if row.unit_sale_price: data['unit_sale_price'] = float(row.unit_sale_price) - data['unit_sale_price_display'] = self.app.render_currency(row.unit_sale_price) + data['unit_sale_price_display'] = app.render_currency(row.unit_sale_price) if row.sale_ends: - sale_ends = self.app.localtime(row.sale_ends, from_utc=True).date() + sale_ends = app.localtime(row.sale_ends, from_utc=True).date() data['sale_ends'] = str(sale_ends) - data['sale_ends_display'] = self.app.render_date(sale_ends) + data['sale_ends_display'] = app.render_date(sale_ends) if row.unit_sale_price and row.unit_price == row.unit_sale_price: data['pricing_reflects_sale'] = True @@ -815,12 +808,12 @@ class CustomerOrderView(MasterView): case_price = self.batch_handler.get_case_price_for_row(row) data['case_price'] = float(case_price) if case_price is not None else None - data['case_price_display'] = self.app.render_currency(case_price) + data['case_price_display'] = app.render_currency(case_price) if self.batch_handler.product_price_may_be_questionable(): data['price_needs_confirmation'] = row.price_needs_confirmation - key = self.app.get_product_key_field() + key = app.get_product_key_field() if key == 'upc': data['product_key'] = data['product_upc_pretty'] elif key == 'item_id': @@ -844,7 +837,7 @@ class CustomerOrderView(MasterView): case_qty = unit_qty = '??' else: case_qty = data['case_quantity'] - unit_qty = self.app.render_quantity(row.order_quantity * row.case_quantity) + unit_qty = pretty_quantity(row.order_quantity * row.case_quantity) data.update({ 'order_quantity_display': "{} {} (× {} {} = {} {})".format( data['order_quantity'], @@ -857,14 +850,14 @@ class CustomerOrderView(MasterView): else: data.update({ 'order_quantity_display': "{} {}".format( - self.app.render_quantity(row.order_quantity), + pretty_quantity(row.order_quantity), self.enum.UNIT_OF_MEASURE[unit_uom]), }) return data def add_item(self, batch, data): - model = self.app.model + app = self.get_rattail_app() order_quantity = decimal.Decimal(data.get('order_quantity') or '0') order_uom = data.get('order_uom') @@ -895,7 +888,7 @@ class CustomerOrderView(MasterView): pending_info = dict(data['pending_product']) if 'upc' in pending_info: - pending_info['upc'] = self.app.make_gpc(pending_info['upc']) + pending_info['upc'] = app.make_gpc(pending_info['upc']) for field in ('unit_cost', 'regular_price_amount', 'case_size'): if field in pending_info: @@ -924,7 +917,6 @@ class CustomerOrderView(MasterView): if not uuid: return {'error': "Must specify a row UUID"} - model = self.app.model row = self.Session.get(model.CustomerOrderBatchRow, uuid) if not row: return {'error': "Row not found"} @@ -983,7 +975,6 @@ class CustomerOrderView(MasterView): if not uuid: return {'error': "Must specify a row UUID"} - model = self.app.model row = self.Session.get(model.CustomerOrderBatchRow, uuid) if not row: return {'error': "Row not found"} diff --git a/tailbone/views/datasync.py b/tailbone/views/datasync.py index 2b955b5f..134d6018 100644 --- a/tailbone/views/datasync.py +++ b/tailbone/views/datasync.py @@ -202,36 +202,10 @@ class DataSyncThreadView(MasterView): return self.redirect(self.request.get_referrer( default=self.request.route_url('datasyncchanges'))) - def configure_get_simple_settings(self): - """ """ - return [ - - # basic - {'section': 'rattail.datasync', - 'option': 'use_profile_settings', - 'type': bool}, - - # misc. - {'section': 'rattail.datasync', - 'option': 'supervisor_process_name'}, - {'section': 'rattail.datasync', - 'option': 'batch_size_limit', - 'type': int}, - - # legacy - {'section': 'tailbone', - 'option': 'datasync.restart'}, - - ] - - def configure_get_context(self, **kwargs): - """ """ - context = super().configure_get_context(**kwargs) - + def configure_get_context(self): profiles = self.datasync_handler.get_configured_profiles( include_disabled=True, ignore_problems=True) - context['profiles'] = profiles profiles_data = [] for profile in sorted(profiles.values(), key=lambda p: p.key): @@ -269,15 +243,25 @@ class DataSyncThreadView(MasterView): data['consumers_data'] = consumers profiles_data.append(data) - context['profiles_data'] = profiles_data - return context + return { + 'profiles': profiles, + 'profiles_data': profiles_data, + 'use_profile_settings': self.datasync_handler.should_use_profile_settings(), + 'supervisor_process_name': self.rattail_config.get( + 'rattail.datasync', 'supervisor_process_name'), + 'restart_command': self.rattail_config.get( + 'tailbone', 'datasync.restart'), + } - def configure_gather_settings(self, data, **kwargs): - """ """ - settings = super().configure_gather_settings(data, **kwargs) + def configure_gather_settings(self, data): + settings = [] + watch = [] - if data.get('rattail.datasync.use_profile_settings') == 'true': - watch = [] + use_profile_settings = data.get('use_profile_settings') == 'true' + settings.append({'name': 'rattail.datasync.use_profile_settings', + 'value': 'true' if use_profile_settings else 'false'}) + + if use_profile_settings: for profile in json.loads(data['profiles']): pkey = profile['key'] @@ -339,12 +323,17 @@ class DataSyncThreadView(MasterView): settings.append({'name': 'rattail.datasync.watch', 'value': ', '.join(watch)}) + if data['supervisor_process_name']: + settings.append({'name': 'rattail.datasync.supervisor_process_name', + 'value': data['supervisor_process_name']}) + + if data['restart_command']: + settings.append({'name': 'tailbone.datasync.restart', + 'value': data['restart_command']}) + return settings - def configure_remove_settings(self, **kwargs): - """ """ - super().configure_remove_settings(**kwargs) - + def configure_remove_settings(self): purge_datasync_settings(self.rattail_config, self.Session()) @classmethod diff --git a/tailbone/views/departments.py b/tailbone/views/departments.py index 47de8dca..6ee1439f 100644 --- a/tailbone/views/departments.py +++ b/tailbone/views/departments.py @@ -128,8 +128,8 @@ class DepartmentView(MasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.employees', + key='{}.employees'.format(route_prefix), + request=self.request, data=[], columns=[ 'first_name', @@ -140,9 +140,9 @@ class DepartmentView(MasterView): ) if self.request.has_perm('employees.view'): - g.actions.append(self.make_action('view', icon='eye')) + g.main_actions.append(self.make_action('view', icon='eye')) if self.request.has_perm('employees.edit'): - g.actions.append(self.make_action('edit', icon='edit')) + g.main_actions.append(self.make_action('edit', icon='edit')) return HTML.literal( g.render_table_element(data_prop='employeesData')) diff --git a/tailbone/views/email.py b/tailbone/views/email.py index 98bd4295..4014c05e 100644 --- a/tailbone/views/email.py +++ b/tailbone/views/email.py @@ -116,12 +116,11 @@ class EmailSettingView(MasterView): return data def configure_grid(self, g): - super().configure_grid(g) - - g.sort_on_backend = False - g.sort_multiple = False + g.sorters['key'] = g.make_simple_sorter('key', foldcase=True) + g.sorters['prefix'] = g.make_simple_sorter('prefix', foldcase=True) + g.sorters['subject'] = g.make_simple_sorter('subject', foldcase=True) + g.sorters['enabled'] = g.make_simple_sorter('enabled') g.set_sort_defaults('key') - g.set_type('enabled', 'boolean') g.set_link('key') g.set_link('subject') @@ -131,16 +130,18 @@ class EmailSettingView(MasterView): # to g.set_renderer('to', self.render_to_short) + g.sorters['to'] = g.make_simple_sorter('to', foldcase=True) # hidden if self.has_perm('configure'): + g.sorters['hidden'] = g.make_simple_sorter('hidden') g.set_type('hidden', 'boolean') else: g.remove('hidden') # toggle hidden if self.has_perm('configure'): - g.actions.append( + g.main_actions.append( self.make_action('toggle_hidden', url='#', icon='ban', click_handler='toggleHidden(props.row)', factory=ToggleHidden)) diff --git a/tailbone/views/employees.py b/tailbone/views/employees.py index debd8fcb..f4f99058 100644 --- a/tailbone/views/employees.py +++ b/tailbone/views/employees.py @@ -167,7 +167,8 @@ class EmployeeView(MasterView): url = lambda r, i: self.request.route_url( f'{route_prefix}.view', **self.get_action_route_kwargs(r)) # nb. insert to slot 1, just after normal View action - g.actions.insert(1, self.make_action('view_raw', url=url, icon='eye')) + g.main_actions.insert(1, self.make_action( + 'view_raw', url=url, icon='eye')) def default_view_url(self): if (self.request.has_perm('people.view_profile') diff --git a/tailbone/views/master.py b/tailbone/views/master.py index 21a5e58f..1e917902 100644 --- a/tailbone/views/master.py +++ b/tailbone/views/master.py @@ -39,9 +39,8 @@ from sqlalchemy import orm import sqlalchemy_continuum as continuum from sqlalchemy_utils.functions import get_primary_keys, get_columns -from wuttjamaican.util import get_class_hierarchy from rattail.db.continuum import model_transaction_query -from rattail.util import simple_error +from rattail.util import simple_error, get_class_hierarchy from rattail.threads import Thread from rattail.csvutil import UnicodeDictWriter from rattail.excel import ExcelWriter @@ -117,7 +116,6 @@ class MasterView(View): supports_prev_next = False supports_import_batch_from_file = False has_input_file_templates = False - has_output_file_templates = False configurable = False # set to True to add "View *global* Objects" permission, and @@ -138,7 +136,6 @@ class MasterView(View): deleting = False executing = False cloning = False - configuring = False has_pk_fields = False has_image = False has_thumbnail = False @@ -335,7 +332,7 @@ class MasterView(View): # If user just refreshed the page with a reset instruction, issue a # redirect in order to clear out the query string. - if self.request.GET.get('reset-view'): + if self.request.GET.get('reset-to-default-filters') == 'true': kw = {'_query': None} hash_ = self.request.GET.get('hash') if hash_: @@ -343,16 +340,14 @@ class MasterView(View): return self.redirect(self.request.current_route_url(**kw)) # Stash some grid stats, for possible use when generating URLs. - if grid.paginated and hasattr(grid, 'pager'): + if grid.pageable and hasattr(grid, 'pager'): self.first_visible_grid_index = grid.pager.first_item # return grid data only, if partial page was requested - if self.request.GET.get('partial'): - context = grid.get_table_data() - return self.json_response(context) + if self.request.params.get('partial'): + return self.json_response(grid.get_table_data()) context = { - 'index_url': None, # nb. avoid title link since this *is* the index 'grid': grid, } @@ -383,7 +378,7 @@ class MasterView(View): grid contents etc. """ - def make_grid(self, factory=None, key=None, data=None, columns=None, session=None, **kwargs): + def make_grid(self, factory=None, key=None, data=None, columns=None, **kwargs): """ Creates a new grid instance """ @@ -392,12 +387,13 @@ class MasterView(View): if key is None: key = self.get_grid_key() if data is None: - data = self.get_data(session=session) + data = self.get_data(session=kwargs.get('session')) if columns is None: columns = self.get_grid_columns() + kwargs.setdefault('request', self.request) kwargs = self.make_grid_kwargs(**kwargs) - grid = factory(self.request, key=key, data=data, columns=columns, **kwargs) + grid = factory(key, data, columns, **kwargs) self.configure_grid(grid) grid.load_settings() return grid @@ -410,9 +406,9 @@ class MasterView(View): """ if session is None: session = self.Session() - kwargs.setdefault('paginated', False) + kwargs.setdefault('pageable', False) grid = self.make_grid(session=session, **kwargs) - return grid.get_visible_data() + return grid.make_visible_data() def get_grid_columns(self): """ @@ -443,8 +439,7 @@ class MasterView(View): 'filterable': self.filterable, 'use_byte_string_filters': self.use_byte_string_filters, 'sortable': self.sortable, - 'sort_multiple': not self.request.use_oruga, - 'paginated': self.pageable, + 'pageable': self.pageable, 'extra_row_class': self.grid_extra_class, 'url': lambda obj: self.get_action_url('view', obj), 'checkboxes': checkboxes, @@ -458,26 +453,10 @@ class MasterView(View): if self.sortable or self.pageable or self.filterable: defaults['expose_direct_link'] = True - if 'actions' not in kwargs: - - if 'main_actions' in kwargs: - warnings.warn("main_actions param is deprecated for make_grid_kwargs(); " - "please use actions param instead", - DeprecationWarning, stacklevel=2) - main = kwargs.pop('main_actions') - else: - main = self.get_main_actions() - - if 'more_actions' in kwargs: - warnings.warn("more_actions param is deprecated for make_grid_kwargs(); " - "please use actions param instead", - DeprecationWarning, stacklevel=2) - more = kwargs.pop('more_actions') - else: - more = self.get_more_actions() - - defaults['actions'] = main + more - + if 'main_actions' not in kwargs and 'more_actions' not in kwargs: + main, more = self.get_grid_actions() + defaults['main_actions'] = main + defaults['more_actions'] = more defaults.update(kwargs) return defaults @@ -551,8 +530,7 @@ class MasterView(View): def get_quickie_result_url(self, obj): return self.get_action_url('view', obj) - def make_row_grid(self, factory=None, key=None, data=None, columns=None, - session=None, **kwargs): + def make_row_grid(self, factory=None, key=None, data=None, columns=None, **kwargs): """ Make and return a new (configured) rows grid instance. """ @@ -569,8 +547,9 @@ class MasterView(View): if columns is None: columns = self.get_row_grid_columns() + kwargs.setdefault('request', self.request) kwargs = self.make_row_grid_kwargs(**kwargs) - grid = factory(self.request, key=key, data=data, columns=columns, **kwargs) + grid = factory(key, data, columns, **kwargs) self.configure_row_grid(grid) grid.load_settings() return grid @@ -589,16 +568,15 @@ class MasterView(View): 'filterable': self.rows_filterable, 'use_byte_string_filters': self.use_byte_string_filters, 'sortable': self.rows_sortable, - 'sort_multiple': not self.request.use_oruga, - 'paginated': self.rows_pageable, + 'pageable': self.rows_pageable, 'extra_row_class': self.row_grid_extra_class, 'url': lambda obj: self.get_row_action_url('view', obj), } if self.rows_default_pagesize: - defaults['pagesize'] = self.rows_default_pagesize + defaults['default_pagesize'] = self.rows_default_pagesize - if self.has_rows and 'actions' not in defaults: + if self.has_rows and 'main_actions' not in defaults: actions = [] # view action @@ -613,12 +591,10 @@ class MasterView(View): # delete action if self.rows_deletable and self.has_perm('delete_row'): - actions.append(self.make_action('delete', icon='trash', - url=self.row_delete_action_url, - link_class='has-text-danger')) + actions.append(self.make_action('delete', icon='trash', url=self.row_delete_action_url)) defaults['delete_speedbump'] = self.rows_deletable_speedbump - defaults['actions'] = actions + defaults['main_actions'] = actions defaults.update(kwargs) return defaults @@ -653,8 +629,9 @@ class MasterView(View): if columns is None: columns = self.get_version_grid_columns() + kwargs.setdefault('request', self.request) kwargs = self.make_version_grid_kwargs(**kwargs) - grid = factory(self.request, key=key, data=data, columns=columns, **kwargs) + grid = factory(key, data, columns, **kwargs) self.configure_version_grid(grid) grid.load_settings() return grid @@ -680,12 +657,12 @@ class MasterView(View): defaults = { 'model_class': continuum.transaction_class(self.get_model_class()), 'width': 'full', - 'paginated': True, + 'pageable': True, 'url': lambda txn: self.request.route_url(route, uuid=instance.uuid, txnid=txn.id), } - if 'actions' not in kwargs: + if 'main_actions' not in kwargs: url = lambda txn, i: self.request.route_url(route, uuid=instance.uuid, txnid=txn.id) - defaults['actions'] = [ + defaults['main_actions'] = [ self.make_action('view', icon='eye', url=url), ] defaults.update(kwargs) @@ -903,7 +880,7 @@ class MasterView(View): def valid_employee_uuid(self, node, value): if value: - model = self.app.model + model = self.model employee = self.Session.get(model.Employee, value) if not employee: node.raise_invalid("Employee not found") @@ -939,7 +916,7 @@ class MasterView(View): def valid_vendor_uuid(self, node, value): if value: - model = self.app.model + model = self.model vendor = self.Session.get(model.Vendor, value) if not vendor: node.raise_invalid("Vendor not found") @@ -1187,7 +1164,7 @@ class MasterView(View): # If user just refreshed the page with a reset instruction, issue a # redirect in order to clear out the query string. - if self.request.GET.get('reset-view'): + if self.request.GET.get('reset-to-default-filters') == 'true': kw = {'_query': None} hash_ = self.request.GET.get('hash') if hash_: @@ -1382,19 +1359,19 @@ class MasterView(View): return classes def make_revisions_grid(self, obj, empty_data=False): - model = self.app.model + model = self.model route_prefix = self.get_route_prefix() row_url = lambda txn, i: self.request.route_url(f'{route_prefix}.version', uuid=obj.uuid, txnid=txn.id) kwargs = { - 'vue_tagname': 'versions-grid', + 'component': 'versions-grid', 'ajax_data_url': self.get_action_url('revisions_data', obj), 'sortable': True, - 'sort_multiple': not self.request.use_oruga, - 'sort_defaults': ('changed', 'desc'), - 'actions': [ + 'default_sortkey': 'changed', + 'default_sortdir': 'desc', + 'main_actions': [ self.make_action('view', icon='eye', url='#', click_handler='viewRevision(props.row)'), self.make_action('view_separate', url=row_url, target='_blank', @@ -1707,10 +1684,10 @@ class MasterView(View): """ if session is None: session = self.Session() - kwargs.setdefault('paginated', False) + kwargs.setdefault('pageable', False) kwargs.setdefault('sortable', sort) grid = self.make_row_grid(session=session, **kwargs) - return grid.get_visible_data() + return grid.make_visible_data() @classmethod def get_row_url_prefix(cls): @@ -1824,26 +1801,6 @@ class MasterView(View): path = os.path.join(basedir, filespec) return self.file_response(path) - def download_output_file_template(self): - """ - View for downloading an output file template. - """ - key = self.request.GET['key'] - filespec = self.request.GET['file'] - - matches = [tmpl for tmpl in self.get_output_file_templates() - if tmpl['key'] == key] - if not matches: - raise self.notfound() - - template = matches[0] - templatesdir = os.path.join(self.rattail_config.datadir(), - 'templates', 'output_files', - self.get_route_prefix()) - basedir = os.path.join(templatesdir, template['key']) - path = os.path.join(basedir, filespec) - return self.file_response(path) - def edit(self): """ View for editing an existing model record. @@ -1905,7 +1862,6 @@ class MasterView(View): return self.redirect(self.get_action_url('view', instance)) form = self.make_form(instance) - form.save_label = "DELETE Forever" # TODO: Add better validation, ideally CSRF etc. if self.request.method == 'POST': @@ -2153,7 +2109,7 @@ class MasterView(View): Thread target for executing an object. """ app = self.get_rattail_app() - model = self.app.model + model = self.model session = app.make_session() obj = self.get_instance_for_key(key, session) user = session.get(model.User, user_uuid) @@ -2592,12 +2548,11 @@ class MasterView(View): so if you like you can return a different help URL depending on which type of CRUD view is in effect, etc. """ - # nb. self.Session may differ, so use tailbone.db.Session - session = Session() - model = self.app.model + model = self.model route_prefix = self.get_route_prefix() - info = session.query(model.TailbonePageHelp)\ + # nb. self.Session may differ, so use tailbone.db.Session + info = Session.query(model.TailbonePageHelp)\ .filter(model.TailbonePageHelp.route_prefix == route_prefix)\ .first() if info and info.help_url: @@ -2615,12 +2570,11 @@ class MasterView(View): """ Return the markdown help text for current page, if defined. """ - # nb. self.Session may differ, so use tailbone.db.Session - session = Session() - model = self.app.model + model = self.model route_prefix = self.get_route_prefix() - info = session.query(model.TailbonePageHelp)\ + # nb. self.Session may differ, so use tailbone.db.Session + info = Session.query(model.TailbonePageHelp)\ .filter(model.TailbonePageHelp.route_prefix == route_prefix)\ .first() if info and info.markdown_text: @@ -2637,9 +2591,7 @@ class MasterView(View): if not self.can_edit_help(): raise self.forbidden() - # nb. self.Session may differ, so use tailbone.db.Session - session = Session() - model = self.app.model + model = self.model route_prefix = self.get_route_prefix() schema = colander.Schema() @@ -2656,12 +2608,13 @@ class MasterView(View): if not form.validate(): return {'error': "Form did not validate"} - info = session.query(model.TailbonePageHelp)\ + # nb. self.Session may differ, so use tailbone.db.Session + info = Session.query(model.TailbonePageHelp)\ .filter(model.TailbonePageHelp.route_prefix == route_prefix)\ .first() if not info: info = model.TailbonePageHelp(route_prefix=route_prefix) - session.add(info) + Session.add(info) info.help_url = form.validated['help_url'] info.markdown_text = form.validated['markdown_text'] @@ -2671,9 +2624,7 @@ class MasterView(View): if not self.can_edit_help(): raise self.forbidden() - # nb. self.Session may differ, so use tailbone.db.Session - session = Session() - model = self.app.model + model = self.model route_prefix = self.get_route_prefix() schema = colander.Schema() @@ -2689,14 +2640,15 @@ class MasterView(View): if not form.validate(): return {'error': "Form did not validate"} - info = session.query(model.TailboneFieldInfo)\ + # nb. self.Session may differ, so use tailbone.db.Session + info = Session.query(model.TailboneFieldInfo)\ .filter(model.TailboneFieldInfo.route_prefix == route_prefix)\ .filter(model.TailboneFieldInfo.field_name == form.validated['field_name'])\ .first() if not info: info = model.TailboneFieldInfo(route_prefix=route_prefix, field_name=form.validated['field_name']) - session.add(info) + Session.add(info) info.markdown_text = form.validated['markdown_text'] return {'ok': True} @@ -2872,12 +2824,6 @@ class MasterView(View): kwargs['input_file_templates'] = OrderedDict([(tmpl['key'], tmpl) for tmpl in templates]) - # add info for downloadable output file templates, if any - if self.has_output_file_templates: - templates = self.normalize_output_file_templates() - kwargs['output_file_templates'] = OrderedDict([(tmpl['key'], tmpl) - for tmpl in templates]) - return kwargs def get_input_file_templates(self): @@ -2952,81 +2898,6 @@ class MasterView(View): return templates - def get_output_file_templates(self): - return [] - - def normalize_output_file_templates(self, templates=None, - include_file_options=False): - if templates is None: - templates = self.get_output_file_templates() - - route_prefix = self.get_route_prefix() - - if include_file_options: - templatesdir = os.path.join(self.rattail_config.datadir(), - 'templates', 'output_files', - route_prefix) - - for template in templates: - - if 'config_section' not in template: - if hasattr(self, 'output_file_template_config_section'): - template['config_section'] = self.output_file_template_config_section - else: - template['config_section'] = route_prefix - section = template['config_section'] - - if 'config_prefix' not in template: - template['config_prefix'] = '{}.{}'.format( - self.output_file_template_config_prefix, - template['key']) - prefix = template['config_prefix'] - - for key in ('mode', 'file', 'url'): - - if 'option_{}'.format(key) not in template: - template['option_{}'.format(key)] = '{}.{}'.format(prefix, key) - - if 'setting_{}'.format(key) not in template: - template['setting_{}'.format(key)] = '{}.{}'.format( - section, - template['option_{}'.format(key)]) - - if key not in template: - value = self.rattail_config.get( - section, - template['option_{}'.format(key)]) - if value is not None: - template[key] = value - - template.setdefault('mode', 'default') - template.setdefault('file', None) - template.setdefault('url', template['default_url']) - - if include_file_options: - options = [] - basedir = os.path.join(templatesdir, template['key']) - if os.path.exists(basedir): - for name in sorted(os.listdir(basedir)): - if len(name) == 4 and name.isdigit(): - files = os.listdir(os.path.join(basedir, name)) - if len(files) == 1: - options.append(os.path.join(name, files[0])) - template['file_options'] = options - template['file_options_dir'] = basedir - - if template['mode'] == 'external': - template['effective_url'] = template['url'] - elif template['mode'] == 'hosted': - template['effective_url'] = self.request.route_url( - '{}.download_output_file_template'.format(route_prefix), - _query={'key': template['key'], - 'file': template['file']}) - else: - template['effective_url'] = template['default_url'] - - return templates - def template_kwargs_index(self, **kwargs): """ Method stub, so subclass can always invoke super() for it. @@ -3074,12 +2945,6 @@ class MasterView(View): items.append(tags.link_to(f"Download {template['label']} Template", template['effective_url'])) - if self.has_output_file_templates and self.has_perm('configure'): - templates = self.normalize_output_file_templates() - for template in templates: - items.append(tags.link_to(f"Download {template['label']} Template", - template['effective_url'])) - # if self.viewing: # # # TODO: either make this configurable, or just lose it. @@ -3245,11 +3110,6 @@ class MasterView(View): return key def get_grid_actions(self): - """ """ - warnings.warn("get_grid_actions() method is deprecated; " - "please use get_main_actions() or get_more_actions() instead", - DeprecationWarning, stacklevel=2) - main, more = self.get_main_actions(), self.get_more_actions() if len(more) == 1: main, more = main + more, [] @@ -3325,7 +3185,7 @@ class MasterView(View): url=self.default_clone_url) def make_grid_action_delete(self): - kwargs = {'link_class': 'has-text-danger'} + kwargs = {} if self.delete_confirm == 'simple': kwargs['click_handler'] = 'deleteObject' return self.make_action('delete', icon='trash', url=self.default_delete_url, **kwargs) @@ -3359,18 +3219,14 @@ class MasterView(View): def make_action(self, key, url=None, factory=None, **kwargs): """ - Make and return a new :class:`~tailbone.grids.core.GridAction` - instance. - - This can be called to make actions for any grid, not just the - one from :meth:`index()`. + Make a new :class:`GridAction` instance for the current grid. """ if url is None: route = '{}.{}'.format(self.get_route_prefix(), key) url = lambda r, i: self.request.route_url(route, **self.get_action_route_kwargs(r)) if not factory: factory = grids.GridAction - return factory(self.request, key, url=url, **kwargs) + return factory(key, url=url, **kwargs) def get_action_route_kwargs(self, obj): """ @@ -4565,7 +4421,7 @@ class MasterView(View): 'request': self.request, 'readonly': self.viewing, 'model_class': getattr(self, 'model_class', None), - 'action_url': self.request.path_url, + 'action_url': self.request.current_route_url(_query=None), 'assume_local_times': self.has_local_times, 'route_prefix': route_prefix, 'can_edit_help': self.can_edit_help(), @@ -5233,7 +5089,6 @@ class MasterView(View): """ Generic view for configuring some aspect of the software. """ - self.configuring = True app = self.get_rattail_app() if self.request.method == 'POST': if self.request.POST.get('remove_settings'): @@ -5315,39 +5170,6 @@ class MasterView(View): data[template['setting_file']] = os.path.join(numdir, info['filename']) - if self.has_output_file_templates: - templatesdir = os.path.join(self.rattail_config.datadir(), - 'templates', 'output_files', - self.get_route_prefix()) - - def get_next_filedir(basedir): - nextid = 1 - while True: - path = os.path.join(basedir, '{:04d}'.format(nextid)) - if not os.path.exists(path): - # this should fail if there happens to be a race - # condition and someone else got to this id first - os.mkdir(path) - return path - nextid += 1 - - for template in self.normalize_output_file_templates(): - key = '{}.upload'.format(template['setting_file']) - if key in uploads: - assert self.request.POST[template['setting_mode']] == 'hosted' - assert not self.request.POST[template['setting_file']] - info = uploads[key] - basedir = os.path.join(templatesdir, template['key']) - if not os.path.exists(basedir): - os.makedirs(basedir) - filedir = get_next_filedir(basedir) - filepath = os.path.join(filedir, info['filename']) - shutil.copyfile(info['filepath'], filepath) - shutil.rmtree(info['filedir']) - numdir = os.path.basename(filedir) - data[template['setting_file']] = os.path.join(numdir, - info['filename']) - def configure_get_simple_settings(self): """ If you have some "simple" settings, each of which basically @@ -5392,8 +5214,7 @@ class MasterView(View): simple['option']) def configure_get_context(self, simple_settings=None, - input_file_templates=True, - output_file_templates=True): + input_file_templates=True): """ Returns the full context dict, for rendering the configure page template. @@ -5442,7 +5263,7 @@ class MasterView(View): for template in self.normalize_input_file_templates( include_file_options=True): settings[template['setting_mode']] = template['mode'] - settings[template['setting_file']] = template['file'] or '' + settings[template['setting_file']] = template['file'] settings[template['setting_url']] = template['url'] file_options[template['key']] = template['file_options'] file_option_dirs[template['key']] = template['file_options_dir'] @@ -5450,27 +5271,10 @@ class MasterView(View): context['input_file_options'] = file_options context['input_file_option_dirs'] = file_option_dirs - # add settings for output file templates, if any - if output_file_templates and self.has_output_file_templates: - settings = {} - file_options = {} - file_option_dirs = {} - for template in self.normalize_output_file_templates( - include_file_options=True): - settings[template['setting_mode']] = template['mode'] - settings[template['setting_file']] = template['file'] or '' - settings[template['setting_url']] = template['url'] - file_options[template['key']] = template['file_options'] - file_option_dirs[template['key']] = template['file_options_dir'] - context['output_file_template_settings'] = settings - context['output_file_options'] = file_options - context['output_file_option_dirs'] = file_option_dirs - return context def configure_gather_settings(self, data, simple_settings=None, - input_file_templates=True, - output_file_templates=True): + input_file_templates=True): settings = [] # maybe collect "simple" settings @@ -5516,32 +5320,12 @@ class MasterView(View): settings.append({'name': template['setting_url'], 'value': data.get(template['setting_url'])}) - # maybe also collect output file template settings - if output_file_templates and self.has_output_file_templates: - for template in self.normalize_output_file_templates(): - - # mode - settings.append({'name': template['setting_mode'], - 'value': data.get(template['setting_mode'])}) - - # file - value = data.get(template['setting_file']) - if value: - # nb. avoid saving if empty, so can remain "null" - settings.append({'name': template['setting_file'], - 'value': value}) - - # url - settings.append({'name': template['setting_url'], - 'value': data.get(template['setting_url'])}) - return settings def configure_remove_settings(self, simple_settings=None, - input_file_templates=True, - output_file_templates=True): + input_file_templates=True): app = self.get_rattail_app() - model = self.app.model + model = self.model names = [] if simple_settings is None: @@ -5558,14 +5342,6 @@ class MasterView(View): template['setting_url'], ]) - if output_file_templates and self.has_output_file_templates: - for template in self.normalize_output_file_templates(): - names.extend([ - template['setting_mode'], - template['setting_file'], - template['setting_url'], - ]) - if names: # nb. using thread-local session here; we do not use # self.Session b/c it may not point to Rattail @@ -5828,15 +5604,6 @@ class MasterView(View): route_name='{}.download_input_file_template'.format(route_prefix), permission='{}.create'.format(permission_prefix)) - # download output file template - if cls.has_output_file_templates and cls.configurable: - config.add_route(f'{route_prefix}.download_output_file_template', - f'{url_prefix}/download-output-file-template') - config.add_view(cls, attr='download_output_file_template', - route_name=f'{route_prefix}.download_output_file_template', - # TODO: this is different from input file, should change? - permission=f'{permission_prefix}.configure') - # view if cls.viewable: cls._defaults_view(config) @@ -6100,7 +5867,7 @@ class MasterView(View): renderer='json') -class ViewSupplement: +class ViewSupplement(object): """ Base class for view "supplements" - which are sort of like plugins which can "supplement" certain aspects of the view. @@ -6127,7 +5894,6 @@ class ViewSupplement: def __init__(self, master): self.master = master self.request = master.request - self.app = master.app self.model = master.model self.rattail_config = master.rattail_config self.Session = master.Session @@ -6161,7 +5927,7 @@ class ViewSupplement: This is accomplished by subjecting the current base query to a join, e.g. something like:: - model = self.app.model + model = self.model query = query.outerjoin(model.MyExtension) return query """ diff --git a/tailbone/views/members.py b/tailbone/views/members.py index 46ed7e4b..de844eb7 100644 --- a/tailbone/views/members.py +++ b/tailbone/views/members.py @@ -229,7 +229,8 @@ class MemberView(MasterView): url = lambda r, i: self.request.route_url( f'{route_prefix}.view', **self.get_action_route_kwargs(r)) # nb. insert to slot 1, just after normal View action - g.actions.insert(1, self.make_action('view_raw', url=url, icon='eye')) + g.main_actions.insert(1, self.make_action( + 'view_raw', url=url, icon='eye')) # equity_total # TODO: should make this configurable diff --git a/tailbone/views/people.py b/tailbone/views/people.py index 405b1ca3..9b28b94d 100644 --- a/tailbone/views/people.py +++ b/tailbone/views/people.py @@ -175,7 +175,8 @@ class PersonView(MasterView): url = lambda r, i: self.request.route_url( f'{route_prefix}.view', **self.get_action_route_kwargs(r)) # nb. insert to slot 1, just after normal View action - g.actions.insert(1, self.make_action('view_raw', url=url, icon='eye')) + g.main_actions.insert(1, self.make_action( + 'view_raw', url=url, icon='eye')) g.set_link('display_name') g.set_link('first_name') @@ -521,9 +522,9 @@ class PersonView(MasterView): data = self.profile_transactions_query(person) factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.profile.transactions.{person.uuid}', - data=data, + f'{route_prefix}.profile.transactions.{person.uuid}', + data, + request=self.request, model_class=model.Transaction, ajax_data_url=self.get_action_url('view_profile_transactions', person), columns=[ @@ -543,7 +544,7 @@ class PersonView(MasterView): }, filterable=True, sortable=True, - paginated=True, + pageable=True, default_sortkey='end_time', default_sortdir='desc', component='transactions-grid', @@ -551,7 +552,7 @@ class PersonView(MasterView): if self.request.has_perm('trainwreck.transactions.view'): url = lambda row, i: self.request.route_url('trainwreck.transactions.view', uuid=row.uuid) - g.actions.append(self.make_action('view', icon='eye', url=url)) + g.main_actions.append(grids.GridAction('view', icon='eye', url=url)) g.load_settings() g.set_enum('system', self.enum.TRAINWRECK_SYSTEM) @@ -564,19 +565,15 @@ class PersonView(MasterView): Method which must return the base query for the profile's POS Transactions grid data. """ - customer = self.app.get_customer(person) + app = self.get_rattail_app() + customer = app.get_customer(person) - if customer: - key_field = self.app.get_customer_key_field() - customer_key = getattr(customer, key_field) - if customer_key is not None: - customer_key = str(customer_key) - else: - # nb. this should *not* match anything, so query returns - # no results.. - customer_key = person.uuid + key_field = app.get_customer_key_field() + customer_key = getattr(customer, key_field) + if customer_key is not None: + customer_key = str(customer_key) - trainwreck = self.app.get_trainwreck_handler() + trainwreck = app.get_trainwreck_handler() model = trainwreck.get_model() query = TrainwreckSession.query(model.Transaction)\ .filter(model.Transaction.customer_id == customer_key) @@ -1386,8 +1383,8 @@ class PersonView(MasterView): } if not context['users']: - context['suggested_username'] = auth.make_unique_username(self.Session(), - person=person) + context['suggested_username'] = auth.generate_unique_username(self.Session(), + person=person) return context @@ -1416,9 +1413,9 @@ class PersonView(MasterView): route_prefix = self.get_route_prefix() factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.profile.revisions', - data=[], # start with empty data! + '{}.profile.revisions'.format(route_prefix), + [], # start with empty data! + request=self.request, columns=[ 'changed', 'changed_by', @@ -1433,7 +1430,7 @@ class PersonView(MasterView): 'changed_by', 'comment', ], - actions=[ + main_actions=[ self.make_action('view', icon='eye', url='#', click_handler='viewRevision(props.row)'), ], @@ -2190,8 +2187,4 @@ def defaults(config, **kwargs): def includeme(config): - wutta_config = config.registry.settings['wutta_config'] - if wutta_config.get_bool('tailbone.use_wutta_views', default=False, usedb=False): - config.include('tailbone.views.wutta.people') - else: - defaults(config) + defaults(config) diff --git a/tailbone/views/poser/reports.py b/tailbone/views/poser/reports.py index ded80b18..462df51d 100644 --- a/tailbone/views/poser/reports.py +++ b/tailbone/views/poser/reports.py @@ -110,7 +110,7 @@ class PoserReportView(PoserMasterView): g.set_searchable('description') if self.request.has_perm('report_output.create'): - g.actions.append(self.make_action( + g.more_actions.append(self.make_action( 'generate', icon='arrow-circle-right', url=self.get_generate_url)) diff --git a/tailbone/views/principal.py b/tailbone/views/principal.py index 3986f8b0..fb09306b 100644 --- a/tailbone/views/principal.py +++ b/tailbone/views/principal.py @@ -54,7 +54,7 @@ class PrincipalMasterView(MasterView): View for finding all users who have been granted a given permission """ permissions = copy.deepcopy( - self.request.registry.settings.get('wutta_permissions', {})) + self.request.registry.settings.get('tailbone_permissions', {})) # sort groups, and permissions for each group, for UI's sake sorted_perms = sorted(permissions.items(), key=self.perm_sortkey) @@ -124,11 +124,11 @@ class PrincipalMasterView(MasterView): def find_by_perm_make_results_grid(self, principals): route_prefix = self.get_route_prefix() factory = self.get_grid_factory() - g = factory(self.request, - key=f'{route_prefix}.results', + g = factory(key=f'{route_prefix}.results', + request=self.request, data=[], columns=[], - actions=[ + main_actions=[ self.make_action('view', icon='eye', click_handler='navigateTo(props.row._url)'), ]) @@ -194,7 +194,7 @@ class PermissionsRenderer(Object): rendered = False for key in sorted(perms, key=lambda p: perms[p]['label'].lower()): checked = auth.has_permission(Session(), principal, key, - include_anonymous=self.include_guest, + include_guest=self.include_guest, include_authenticated=self.include_authenticated) if checked: label = perms[key]['label'] diff --git a/tailbone/views/products.py b/tailbone/views/products.py index 8461ae03..bf2d7f14 100644 --- a/tailbone/views/products.py +++ b/tailbone/views/products.py @@ -34,7 +34,7 @@ import sqlalchemy_continuum as continuum from rattail import enum, pod, sil from rattail.db import api, auth, Session as RattailSession -from rattail.db.model import Product, PendingProduct, ProductCost, CustomerOrderItem +from rattail.db.model import Product, PendingProduct, CustomerOrderItem from rattail.gpc import GPC from rattail.threads import Thread from rattail.exceptions import LabelPrintingError @@ -384,7 +384,7 @@ class ProductView(MasterView): g.set_filter('report_code_name', model.ReportCode.name) if self.expose_label_printing and self.has_perm('print_labels'): - g.actions.append(self.make_action( + g.more_actions.append(self.make_action( 'print_label', icon='print', url='#', click_handler='quickLabelPrint(props.row)')) @@ -1197,9 +1197,8 @@ class ProductView(MasterView): # regular price data = [] # defer fetching until user asks for it - grid = grids.Grid(self.request, - key='products.regular_price_history', - data=data, + grid = grids.Grid('products.regular_price_history', data, + request=self.request, columns=[ 'price', 'since', @@ -1212,9 +1211,8 @@ class ProductView(MasterView): # current price data = [] # defer fetching until user asks for it - grid = grids.Grid(self.request, - key='products.current_price_history', - data=data, + grid = grids.Grid('products.current_price_history', data, + request=self.request, columns=[ 'price', 'price_type', @@ -1231,9 +1229,8 @@ class ProductView(MasterView): # suggested price data = [] # defer fetching until user asks for it - grid = grids.Grid(self.request, - key='products.suggested_price_history', - data=data, + grid = grids.Grid('products.suggested_price_history', data, + request=self.request, columns=[ 'price', 'since', @@ -1246,9 +1243,8 @@ class ProductView(MasterView): # cost history data = [] # defer fetching until user asks for it - grid = grids.Grid(self.request, - key='products.cost_history', - data=data, + grid = grids.Grid('products.cost_history', data, + request=self.request, columns=[ 'cost', 'vendor', @@ -1339,8 +1335,7 @@ class ProductView(MasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.vendor_sources', + key='{}.vendor_sources'.format(route_prefix), data=[], columns=columns, labels={ @@ -1381,8 +1376,7 @@ class ProductView(MasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.lookup_codes', + key='{}.lookup_codes'.format(route_prefix), data=[], columns=[ 'sequence', @@ -1857,8 +1851,7 @@ class ProductView(MasterView): lookup_fields.append('alt_code') if lookup_fields: product = self.products_handler.locate_product_for_entry( - session, term, lookup_fields=lookup_fields, - first_if_multiple=True) + session, term, lookup_fields=lookup_fields) if product: final_results.append(self.search_normalize_result(product)) @@ -2669,78 +2662,6 @@ class PendingProductView(MasterView): permission=f'{permission_prefix}.ignore_product') -class ProductCostView(MasterView): - """ - Master view for Product Costs - """ - model_class = ProductCost - route_prefix = 'product_costs' - url_prefix = '/products/costs' - has_versions = True - - grid_columns = [ - '_product_key_', - 'vendor', - 'preference', - 'code', - 'case_size', - 'case_cost', - 'pack_size', - 'pack_cost', - 'unit_cost', - ] - - def query(self, session): - """ """ - query = super().query(session) - model = self.app.model - - # always join on Product - return query.join(model.Product) - - def configure_grid(self, g): - """ """ - super().configure_grid(g) - model = self.app.model - - # product key - field = self.get_product_key_field() - g.set_renderer(field, self.render_product_key) - g.set_sorter(field, getattr(model.Product, field)) - g.set_sort_defaults(field) - g.set_filter(field, getattr(model.Product, field)) - - # vendor - g.set_joiner('vendor', lambda q: q.join(model.Vendor)) - g.set_sorter('vendor', model.Vendor.name) - g.set_filter('vendor', model.Vendor.name, label="Vendor Name") - - def render_product_key(self, cost, field): - """ """ - handler = self.app.get_products_handler() - return handler.render_product_key(cost.product) - - def configure_form(self, f): - """ """ - super().configure_form(f) - - # product - f.set_renderer('product', self.render_product) - if 'product_uuid' in f and 'product' in f: - f.remove('product') - f.replace('product_uuid', 'product') - - # vendor - f.set_renderer('vendor', self.render_vendor) - if 'vendor_uuid' in f and 'vendor' in f: - f.remove('vendor') - f.replace('vendor_uuid', 'vendor') - - # futures - # TODO: should eventually show a subgrid here? - f.remove('futures') - - def defaults(config, **kwargs): base = globals() @@ -2750,9 +2671,6 @@ def defaults(config, **kwargs): PendingProductView = kwargs.get('PendingProductView', base['PendingProductView']) PendingProductView.defaults(config) - ProductCostView = kwargs.get('ProductCostView', base['ProductCostView']) - ProductCostView.defaults(config) - def includeme(config): defaults(config) diff --git a/tailbone/views/purchasing/batch.py b/tailbone/views/purchasing/batch.py index 5e00704e..1d11130c 100644 --- a/tailbone/views/purchasing/batch.py +++ b/tailbone/views/purchasing/batch.py @@ -24,8 +24,6 @@ Base class for purchasing batch views """ -import warnings - from rattail.db.model import PurchaseBatch, PurchaseBatchRow import colander @@ -69,8 +67,6 @@ class PurchasingBatchView(BatchMasterView): 'store', 'buyer', 'vendor', - 'description', - 'workflow', 'department', 'purchase', 'vendor_email', @@ -162,174 +158,6 @@ class PurchasingBatchView(BatchMasterView): def batch_mode(self): raise NotImplementedError("Please define `batch_mode` for your purchasing batch view") - def get_supported_workflows(self): - """ - Return the supported "create batch" workflows. - """ - enum = self.app.enum - if self.batch_mode == enum.PURCHASE_BATCH_MODE_ORDERING: - return self.batch_handler.supported_ordering_workflows() - elif self.batch_mode == enum.PURCHASE_BATCH_MODE_RECEIVING: - return self.batch_handler.supported_receiving_workflows() - elif self.batch_mode == enum.PURCHASE_BATCH_MODE_COSTING: - return self.batch_handler.supported_costing_workflows() - raise ValueError("unknown batch mode") - - def allow_any_vendor(self): - """ - Return boolean indicating whether creating a batch for "any" - vendor is allowed, vs. only supported vendors. - """ - enum = self.app.enum - - if self.batch_mode == enum.PURCHASE_BATCH_MODE_ORDERING: - return self.batch_handler.allow_ordering_any_vendor() - - elif self.batch_mode == enum.PURCHASE_BATCH_MODE_RECEIVING: - value = self.config.get_bool('rattail.batch.purchase.allow_receiving_any_vendor') - if value is not None: - return value - value = self.config.get_bool('rattail.batch.purchase.supported_vendors_only') - if value is not None: - warnings.warn("setting rattail.batch.purchase.supported_vendors_only is deprecated; " - "please use rattail.batch.purchase.allow_receiving_any_vendor instead", - DeprecationWarning) - # nb. must negate this setting - return not value - return False - - raise ValueError("unknown batch mode") - - def get_supported_vendors(self): - """ - Return the supported vendors for creating a batch. - """ - return [] - - def create(self, form=None, **kwargs): - """ - Custom view for creating a new batch. We split the process - into two steps, 1) choose workflow and 2) create batch. This - is because the specific form details for creating a batch will - depend on which "type" of batch creation is to be done, and - it's much easier to keep conditional logic for that in the - server instead of client-side etc. - """ - model = self.app.model - enum = self.app.enum - route_prefix = self.get_route_prefix() - - workflows = self.get_supported_workflows() - valid_workflows = [workflow['workflow_key'] - for workflow in workflows] - - # if user has already identified their desired workflow, then - # we can just farm out to the default logic. we will of - # course configure our form differently, based on workflow, - # but this create() method at least will not need - # customization for that. - if self.request.matched_route.name.endswith('create_workflow'): - - redirect = self.redirect(self.request.route_url(f'{route_prefix}.create')) - - # however we do have one more thing to check - the workflow - # requested must of course be valid! - workflow_key = self.request.matchdict['workflow_key'] - if workflow_key not in valid_workflows: - self.request.session.flash(f"Not a supported workflow: {workflow_key}", 'error') - raise redirect - - # also, we require vendor to be correctly identified. if - # someone e.g. navigates to a URL by accident etc. we want - # to gracefully handle and redirect - uuid = self.request.matchdict['vendor_uuid'] - vendor = self.Session.get(model.Vendor, uuid) - if not vendor: - self.request.session.flash("Invalid vendor selection. " - "Please choose an existing vendor.", - 'warning') - raise redirect - - # okay now do the normal thing, per workflow - return super().create(**kwargs) - - # on the other hand, if caller provided a form, that means we are in - # the middle of some other custom workflow, e.g. "add child to truck - # dump parent" or some such. in which case we also defer to the normal - # logic, so as to not interfere with that. - if form: - return super().create(form=form, **kwargs) - - # okay, at this point we need the user to select a vendor and workflow - self.creating = True - context = {} - - # form to accept user choice of vendor/workflow - schema = colander.Schema() - schema.add(colander.SchemaNode(colander.String(), name='vendor')) - schema.add(colander.SchemaNode(colander.String(), name='workflow', - validator=colander.OneOf(valid_workflows))) - factory = self.get_form_factory() - form = factory(schema=schema, request=self.request) - - # configure vendor field - vendor_handler = self.app.get_vendor_handler() - if self.allow_any_vendor(): - # user may choose *any* available vendor - use_dropdown = vendor_handler.choice_uses_dropdown() - if use_dropdown: - vendors = self.Session.query(model.Vendor)\ - .order_by(model.Vendor.id)\ - .all() - vendor_values = [(vendor.uuid, f"({vendor.id}) {vendor.name}") - for vendor in vendors] - form.set_widget('vendor', dfwidget.SelectWidget(values=vendor_values)) - if len(vendors) == 1: - form.set_default('vendor', vendors[0].uuid) - else: - vendor_display = "" - if self.request.method == 'POST': - if self.request.POST.get('vendor'): - vendor = self.Session.get(model.Vendor, self.request.POST['vendor']) - if vendor: - vendor_display = str(vendor) - vendors_url = self.request.route_url('vendors.autocomplete') - form.set_widget('vendor', forms.widgets.JQueryAutocompleteWidget( - field_display=vendor_display, service_url=vendors_url)) - else: # only "supported" vendors allowed - vendors = self.get_supported_vendors() - vendor_values = [(vendor.uuid, vendor_handler.render_vendor(vendor)) - for vendor in vendors] - form.set_widget('vendor', dfwidget.SelectWidget(values=vendor_values)) - form.set_validator('vendor', self.valid_vendor_uuid) - - # configure workflow field - values = [(workflow['workflow_key'], workflow['display']) - for workflow in workflows] - form.set_widget('workflow', - dfwidget.SelectWidget(values=values)) - if len(workflows) == 1: - form.set_default('workflow', workflows[0]['workflow_key']) - - form.submit_label = "Continue" - form.cancel_url = self.get_index_url() - - # if form validates, that means user has chosen a creation - # type, so we just redirect to the appropriate "new batch of - # type X" page - if form.validate(): - workflow_key = form.validated['workflow'] - vendor_uuid = form.validated['vendor'] - url = self.request.route_url(f'{route_prefix}.create_workflow', - workflow_key=workflow_key, - vendor_uuid=vendor_uuid) - raise self.redirect(url) - - context['form'] = form - if hasattr(form, 'make_deform_form'): - context['dform'] = form.make_deform_form() - return self.render_to_response('create', context) - def query(self, session): model = self.model return session.query(model.PurchaseBatch)\ @@ -398,40 +226,20 @@ class PurchasingBatchView(BatchMasterView): def configure_form(self, f): super().configure_form(f) - model = self.app.model - enum = self.app.enum - route_prefix = self.get_route_prefix() - - today = self.app.today() + model = self.model batch = f.model_instance - workflow = self.request.matchdict.get('workflow_key') - vendor_handler = self.app.get_vendor_handler() + app = self.get_rattail_app() + today = app.localtime().date() # mode - f.set_enum('mode', enum.PURCHASE_BATCH_MODE) - - # workflow - if self.creating: - if workflow: - f.set_widget('workflow', dfwidget.HiddenWidget()) - f.set_default('workflow', workflow) - f.set_hidden('workflow') - # nb. show readonly '_workflow' - f.insert_after('workflow', '_workflow') - f.set_readonly('_workflow') - f.set_renderer('_workflow', self.render_workflow) - else: - f.set_readonly('workflow') - f.set_renderer('workflow', self.render_workflow) - else: - f.remove('workflow') + f.set_enum('mode', self.enum.PURCHASE_BATCH_MODE) # store - single_store = self.config.single_store() + single_store = self.rattail_config.single_store() if self.creating: f.replace('store', 'store_uuid') if single_store: - store = self.config.get_store(self.Session()) + store = self.rattail_config.get_store(self.Session()) f.set_widget('store_uuid', dfwidget.HiddenWidget()) f.set_default('store_uuid', store.uuid) f.set_hidden('store_uuid') @@ -455,6 +263,7 @@ class PurchasingBatchView(BatchMasterView): if self.creating: f.replace('vendor', 'vendor_uuid') f.set_label('vendor_uuid', "Vendor") + vendor_handler = app.get_vendor_handler() use_dropdown = vendor_handler.choice_uses_dropdown() if use_dropdown: vendors = self.Session.query(model.Vendor)\ @@ -504,7 +313,7 @@ class PurchasingBatchView(BatchMasterView): if buyer: buyer_display = str(buyer) elif self.creating: - buyer = self.app.get_employee(self.request.user) + buyer = app.get_employee(self.request.user) if buyer: buyer_display = str(buyer) f.set_default('buyer_uuid', buyer.uuid) @@ -515,30 +324,6 @@ class PurchasingBatchView(BatchMasterView): field_display=buyer_display, service_url=buyers_url)) f.set_label('buyer_uuid', "Buyer") - # order_file - if self.creating: - f.set_type('order_file', 'file', required=False) - else: - f.set_readonly('order_file') - f.set_renderer('order_file', self.render_downloadable_file) - - # order_parser_key - if self.creating: - kwargs = {} - if 'vendor_uuid' in self.request.matchdict: - vendor = self.Session.get(model.Vendor, - self.request.matchdict['vendor_uuid']) - if vendor: - kwargs['vendor'] = vendor - parsers = vendor_handler.get_supported_order_parsers(**kwargs) - parser_values = [(p.key, p.title) for p in parsers] - if len(parsers) == 1: - f.set_default('order_parser_key', parsers[0].key) - f.set_widget('order_parser_key', dfwidget.SelectWidget(values=parser_values)) - f.set_label('order_parser_key', "Order Parser") - else: - f.remove_field('order_parser_key') - # invoice_file if self.creating: f.set_type('invoice_file', 'file', required=False) @@ -556,7 +341,7 @@ class PurchasingBatchView(BatchMasterView): if vendor: kwargs['vendor'] = vendor - parsers = self.batch_handler.get_supported_invoice_parsers(**kwargs) + parsers = self.handler.get_supported_invoice_parsers(**kwargs) parser_values = [(p.key, p.display) for p in parsers] if len(parsers) == 1: f.set_default('invoice_parser_key', parsers[0].key) @@ -615,35 +400,6 @@ class PurchasingBatchView(BatchMasterView): 'vendor_contact', 'status_code') - # tweak some things if we are in "step 2" of creating new batch - if self.creating and workflow: - - # display vendor but do not allow changing - vendor = self.Session.get(model.Vendor, self.request.matchdict['vendor_uuid']) - if not vendor: - raise ValueError(f"vendor not found: {self.request.matchdict['vendor_uuid']}") - f.set_readonly('vendor_uuid') - f.set_default('vendor_uuid', str(vendor)) - - # cancel should take us back to choosing a workflow - f.cancel_url = self.request.route_url(f'{route_prefix}.create') - - def render_workflow(self, batch, field): - key = self.request.matchdict['workflow_key'] - info = self.get_workflow_info(key) - if info: - return info['display'] - - def get_workflow_info(self, key): - enum = self.app.enum - if self.batch_mode == enum.PURCHASE_BATCH_MODE_ORDERING: - return self.batch_handler.ordering_workflow_info(key) - elif self.batch_mode == enum.PURCHASE_BATCH_MODE_RECEIVING: - return self.batch_handler.receiving_workflow_info(key) - elif self.batch_mode == enum.PURCHASE_BATCH_MODE_COSTING: - return self.batch_handler.costing_workflow_info(key) - raise ValueError("unknown batch mode") - def render_store(self, batch, field): store = batch.store if not store: @@ -759,12 +515,10 @@ class PurchasingBatchView(BatchMasterView): def get_batch_kwargs(self, batch, **kwargs): kwargs = super().get_batch_kwargs(batch, **kwargs) - model = self.app.model + model = self.model kwargs['mode'] = self.batch_mode - kwargs['workflow'] = self.request.POST['workflow'] kwargs['truck_dump'] = batch.truck_dump - kwargs['order_parser_key'] = batch.order_parser_key kwargs['invoice_parser_key'] = batch.invoice_parser_key if batch.store: @@ -782,11 +536,6 @@ class PurchasingBatchView(BatchMasterView): elif batch.vendor_uuid: kwargs['vendor_uuid'] = batch.vendor_uuid - # must pull vendor from URL if it was not in form data - if 'vendor_uuid' not in kwargs and 'vendor' not in kwargs: - if 'vendor_uuid' in self.request.matchdict: - kwargs['vendor_uuid'] = self.request.matchdict['vendor_uuid'] - if batch.department: kwargs['department'] = batch.department elif batch.department_uuid: @@ -1044,8 +793,8 @@ class PurchasingBatchView(BatchMasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.row_credits', + key='{}.row_credits'.format(route_prefix), + request=self.request, data=[], columns=[ 'credit_type', @@ -1170,25 +919,6 @@ class PurchasingBatchView(BatchMasterView): # # otherwise just view batch again # return self.get_action_url('view', batch) - @classmethod - def defaults(cls, config): - cls._purchase_batch_defaults(config) - cls._batch_defaults(config) - cls._defaults(config) - - @classmethod - def _purchase_batch_defaults(cls, config): - route_prefix = cls.get_route_prefix() - url_prefix = cls.get_url_prefix() - permission_prefix = cls.get_permission_prefix() - - # new batch using workflow X - config.add_route(f'{route_prefix}.create_workflow', - f'{url_prefix}/new/{{workflow_key}}/{{vendor_uuid}}') - config.add_view(cls, attr='create', - route_name=f'{route_prefix}.create_workflow', - permission=f'{permission_prefix}.create') - class NewProduct(colander.Schema): diff --git a/tailbone/views/purchasing/ordering.py b/tailbone/views/purchasing/ordering.py index c7cc7bfc..2e24eebb 100644 --- a/tailbone/views/purchasing/ordering.py +++ b/tailbone/views/purchasing/ordering.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar +# Copyright © 2010-2023 Lance Edgar # # This file is part of Rattail. # @@ -28,10 +28,14 @@ import os import json import openpyxl +from sqlalchemy import orm +from rattail.db import model, api from rattail.core import Object +from rattail.time import localtime + +from webhelpers2.html import tags -from tailbone.db import Session from tailbone.views.purchasing import PurchasingBatchView @@ -47,8 +51,6 @@ class OrderingBatchView(PurchasingBatchView): rows_editable = True has_worksheet = True default_help_url = 'https://rattailproject.org/docs/rattail-manual/features/purchasing/ordering/index.html' - downloadable = True - configurable = True labels = { 'po_total_calculated': "PO Total", @@ -57,14 +59,9 @@ class OrderingBatchView(PurchasingBatchView): form_fields = [ 'id', 'store', - 'vendor', - 'description', - 'workflow', - 'order_file', - 'order_parser_key', 'buyer', + 'vendor', 'department', - 'params', 'purchase', 'vendor_email', 'vendor_fax', @@ -135,26 +132,15 @@ class OrderingBatchView(PurchasingBatchView): return self.enum.PURCHASE_BATCH_MODE_ORDERING def configure_form(self, f): - super().configure_form(f) + super(OrderingBatchView, self).configure_form(f) batch = f.model_instance - workflow = self.request.matchdict.get('workflow_key') # purchase if self.creating or not batch.executed or not batch.purchase: f.remove_field('purchase') - # now that all fields are setup, some final tweaks based on workflow - if self.creating and workflow: - - if workflow == 'from_scratch': - f.remove('order_file', - 'order_parser_key') - - elif workflow == 'from_file': - f.set_required('order_file') - def get_batch_kwargs(self, batch, **kwargs): - kwargs = super().get_batch_kwargs(batch, **kwargs) + kwargs = super(OrderingBatchView, self).get_batch_kwargs(batch, **kwargs) kwargs['ship_method'] = batch.ship_method kwargs['notes_to_vendor'] = batch.notes_to_vendor return kwargs @@ -169,7 +155,7 @@ class OrderingBatchView(PurchasingBatchView): * ``cases_ordered`` * ``units_ordered`` """ - super().configure_row_form(f) + super(OrderingBatchView, self).configure_row_form(f) # when editing, only certain fields should allow changes if self.editing: @@ -322,7 +308,7 @@ class OrderingBatchView(PurchasingBatchView): title = self.get_instance_title(batch) order_date = batch.date_ordered if not order_date: - order_date = self.app.today() + order_date = localtime(self.rattail_config).date() return self.render_to_response('worksheet', { 'batch': batch, @@ -383,7 +369,6 @@ class OrderingBatchView(PurchasingBatchView): of being updated. If a matching row is not found, it will not be created. """ - model = self.app.model batch = self.get_instance() try: @@ -493,75 +478,13 @@ class OrderingBatchView(PurchasingBatchView): return self.file_response(path) def get_execute_success_url(self, batch, result, **kwargs): - model = self.app.model if isinstance(result, model.Purchase): return self.request.route_url('purchases.view', uuid=result.uuid) - return super().get_execute_success_url(batch, result, **kwargs) - - def configure_get_simple_settings(self): - return [ - - # workflows - {'section': 'rattail.batch', - 'option': 'purchase.allow_ordering_from_scratch', - 'type': bool, - 'default': True}, - {'section': 'rattail.batch', - 'option': 'purchase.allow_ordering_from_file', - 'type': bool, - 'default': True}, - - # vendors - {'section': 'rattail.batch', - 'option': 'purchase.allow_ordering_any_vendor', - 'type': bool, - 'default': True, - }, - ] - - def configure_get_context(self): - context = super().configure_get_context() - vendor_handler = self.app.get_vendor_handler() - - Parsers = vendor_handler.get_all_order_parsers() - Supported = vendor_handler.get_supported_order_parsers() - context['order_parsers'] = Parsers - context['order_parsers_data'] = dict([(Parser.key, Parser in Supported) - for Parser in Parsers]) - - return context - - def configure_gather_settings(self, data): - settings = super().configure_gather_settings(data) - vendor_handler = self.app.get_vendor_handler() - - supported = [] - for Parser in vendor_handler.get_all_order_parsers(): - name = f'order_parser_{Parser.key}' - if data.get(name) == 'true': - supported.append(Parser.key) - settings.append({'name': 'rattail.vendors.supported_order_parsers', - 'value': ', '.join(supported)}) - - return settings - - def configure_remove_settings(self): - super().configure_remove_settings() - - names = [ - 'rattail.vendors.supported_order_parsers', - ] - - # nb. using thread-local session here; we do not use - # self.Session b/c it may not point to Rattail - session = Session() - for name in names: - self.app.delete_setting(session, name) + return super(OrderingBatchView, self).get_execute_success_url(batch, result, **kwargs) @classmethod def defaults(cls, config): cls._ordering_defaults(config) - cls._purchase_batch_defaults(config) cls._batch_defaults(config) cls._defaults(config) diff --git a/tailbone/views/purchasing/receiving.py b/tailbone/views/purchasing/receiving.py index 01858c98..be15c1a8 100644 --- a/tailbone/views/purchasing/receiving.py +++ b/tailbone/views/purchasing/receiving.py @@ -25,22 +25,22 @@ Views for 'receiving' (purchasing) batches """ import os +import re import decimal import logging from collections import OrderedDict -# import humanize +import humanize from rattail import pod -from rattail.util import simple_error +from rattail.util import prettify, simple_error import colander from deform import widget as dfwidget from webhelpers2.html import tags, HTML -from wuttaweb.util import get_form_data - -from tailbone import forms +from tailbone import forms, grids +from tailbone.util import get_form_data from tailbone.views.purchasing import PurchasingBatchView @@ -108,7 +108,7 @@ class ReceivingBatchView(PurchasingBatchView): 'store', 'vendor', 'description', - 'workflow', + 'receiving_workflow', 'truck_dump', 'truck_dump_children_first', 'truck_dump_children', @@ -235,18 +235,135 @@ class ReceivingBatchView(PurchasingBatchView): if not self.handler.allow_truck_dump_receiving(): g.remove('truck_dump') - def get_supported_vendors(self): - """ """ - vendor_handler = self.app.get_vendor_handler() - vendors = {} - for parser in self.batch_handler.get_supported_invoice_parsers(): - if parser.vendor_key: - vendor = vendor_handler.get_vendor(self.Session(), - parser.vendor_key) - if vendor: - vendors[vendor.uuid] = vendor - vendors = sorted(vendors.values(), key=lambda v: v.name) - return vendors + def create(self, form=None, **kwargs): + """ + Custom view for creating a new receiving batch. We split the process + into two steps, 1) choose and 2) create. This is because the specific + form details for creating a batch will depend on which "type" of batch + creation is to be done, and it's much easier to keep conditional logic + for that in the server instead of client-side etc. + + See also + :meth:`tailbone.views.purchasing.costing:CostingBatchView.create()` + which uses similar logic. + """ + model = self.model + route_prefix = self.get_route_prefix() + workflows = self.handler.supported_receiving_workflows() + valid_workflows = [workflow['workflow_key'] + for workflow in workflows] + + # if user has already identified their desired workflow, then we can + # just farm out to the default logic. we will of course configure our + # form differently, based on workflow, but this create() method at + # least will not need customization for that. + if self.request.matched_route.name.endswith('create_workflow'): + + redirect = self.redirect(self.request.route_url('{}.create'.format(route_prefix))) + + # however we do have one more thing to check - the workflow + # requested must of course be valid! + workflow_key = self.request.matchdict['workflow_key'] + if workflow_key not in valid_workflows: + self.request.session.flash( + "Not a supported workflow: {}".format(workflow_key), + 'error') + raise redirect + + # also, we require vendor to be correctly identified. if + # someone e.g. navigates to a URL by accident etc. we want + # to gracefully handle and redirect + uuid = self.request.matchdict['vendor_uuid'] + vendor = self.Session.get(model.Vendor, uuid) + if not vendor: + self.request.session.flash("Invalid vendor selection. " + "Please choose an existing vendor.", + 'warning') + raise redirect + + # okay now do the normal thing, per workflow + return super().create(**kwargs) + + # on the other hand, if caller provided a form, that means we are in + # the middle of some other custom workflow, e.g. "add child to truck + # dump parent" or some such. in which case we also defer to the normal + # logic, so as to not interfere with that. + if form: + return super().create(form=form, **kwargs) + + # okay, at this point we need the user to select a vendor and workflow + self.creating = True + context = {} + + # form to accept user choice of vendor/workflow + schema = NewReceivingBatch().bind(valid_workflows=valid_workflows) + form = forms.Form(schema=schema, request=self.request) + + # configure vendor field + app = self.get_rattail_app() + vendor_handler = app.get_vendor_handler() + if self.rattail_config.getbool('rattail.batch', 'purchase.supported_vendors_only'): + # only show vendors for which we have dedicated invoice parsers + vendors = {} + for parser in self.batch_handler.get_supported_invoice_parsers(): + if parser.vendor_key: + vendor = vendor_handler.get_vendor(self.Session(), + parser.vendor_key) + if vendor: + vendors[vendor.uuid] = vendor + vendors = sorted(vendors.values(), key=lambda v: v.name) + vendor_values = [(vendor.uuid, vendor_handler.render_vendor(vendor)) + for vendor in vendors] + form.set_widget('vendor', dfwidget.SelectWidget(values=vendor_values)) + else: + # user may choose *any* available vendor + use_dropdown = vendor_handler.choice_uses_dropdown() + if use_dropdown: + vendors = self.Session.query(model.Vendor)\ + .order_by(model.Vendor.id)\ + .all() + vendor_values = [(vendor.uuid, "({}) {}".format(vendor.id, vendor.name)) + for vendor in vendors] + form.set_widget('vendor', dfwidget.SelectWidget(values=vendor_values)) + if len(vendors) == 1: + form.set_default('vendor', vendors[0].uuid) + else: + vendor_display = "" + if self.request.method == 'POST': + if self.request.POST.get('vendor'): + vendor = self.Session.get(model.Vendor, self.request.POST['vendor']) + if vendor: + vendor_display = str(vendor) + vendors_url = self.request.route_url('vendors.autocomplete') + form.set_widget('vendor', forms.widgets.JQueryAutocompleteWidget( + field_display=vendor_display, service_url=vendors_url)) + form.set_validator('vendor', self.valid_vendor_uuid) + + # configure workflow field + values = [(workflow['workflow_key'], workflow['display']) + for workflow in workflows] + form.set_widget('workflow', + dfwidget.SelectWidget(values=values)) + if len(workflows) == 1: + form.set_default('workflow', workflows[0]['workflow_key']) + + form.submit_label = "Continue" + form.cancel_url = self.get_index_url() + + # if form validates, that means user has chosen a creation type, so we + # just redirect to the appropriate "new batch of type X" page + if form.validate(): + workflow_key = form.validated['workflow'] + vendor_uuid = form.validated['vendor'] + url = self.request.route_url('{}.create_workflow'.format(route_prefix), + workflow_key=workflow_key, + vendor_uuid=vendor_uuid) + raise self.redirect(url) + + context['form'] = form + if hasattr(form, 'make_deform_form'): + context['dform'] = form.make_deform_form() + return self.render_to_response('create', context) def row_deletable(self, row): @@ -287,7 +404,13 @@ class ReceivingBatchView(PurchasingBatchView): # cancel should take us back to choosing a workflow f.cancel_url = self.request.route_url('{}.create'.format(route_prefix)) - # TODO: remove this + # receiving_workflow + if self.creating and workflow: + f.set_readonly('receiving_workflow') + f.set_renderer('receiving_workflow', self.render_receiving_workflow) + else: + f.remove('receiving_workflow') + # batch_type if self.creating: f.set_widget('batch_type', dfwidget.HiddenWidget()) @@ -402,7 +525,7 @@ class ReceivingBatchView(PurchasingBatchView): # multiple invoice files (if applicable) if (not self.creating - and batch.get_param('workflow') == 'from_multi_invoice'): + and batch.get_param('receiving_workflow') == 'from_multi_invoice'): if 'invoice_files' not in f: f.insert_before('invoice_file', 'invoice_files') @@ -501,6 +624,12 @@ class ReceivingBatchView(PurchasingBatchView): items.append(HTML.tag('li', c=[link])) return HTML.tag('ul', c=items) + def render_receiving_workflow(self, batch, field): + key = self.request.matchdict['workflow_key'] + info = self.handler.receiving_workflow_info(key) + if info: + return info['display'] + def get_visible_params(self, batch): params = super().get_visible_params(batch) @@ -525,40 +654,42 @@ class ReceivingBatchView(PurchasingBatchView): def get_batch_kwargs(self, batch, **kwargs): kwargs = super().get_batch_kwargs(batch, **kwargs) + batch_type = self.request.POST['batch_type'] # must pull vendor from URL if it was not in form data if 'vendor_uuid' not in kwargs and 'vendor' not in kwargs: if 'vendor_uuid' in self.request.matchdict: kwargs['vendor_uuid'] = self.request.matchdict['vendor_uuid'] - workflow = kwargs['workflow'] - if workflow == 'from_scratch': + # TODO: ugh should just have workflow and no batch_type + kwargs['receiving_workflow'] = batch_type + if batch_type == 'from_scratch': kwargs.pop('truck_dump_batch', None) kwargs.pop('truck_dump_batch_uuid', None) - elif workflow == 'from_invoice': + elif batch_type == 'from_invoice': pass - elif workflow == 'from_multi_invoice': + elif batch_type == 'from_multi_invoice': pass - elif workflow == 'from_po': + elif batch_type == 'from_po': # TODO: how to best handle this field? this doesn't seem flexible kwargs['purchase_key'] = batch.purchase_uuid - elif workflow == 'from_po_with_invoice': + elif batch_type == 'from_po_with_invoice': # TODO: how to best handle this field? this doesn't seem flexible kwargs['purchase_key'] = batch.purchase_uuid - elif workflow == 'truck_dump_children_first': + elif batch_type == 'truck_dump_children_first': kwargs['truck_dump'] = True kwargs['truck_dump_children_first'] = True kwargs['order_quantities_known'] = True # TODO: this makes sense in some cases, but all? # (should just omit that field when not relevant) kwargs['date_ordered'] = None - elif workflow == 'truck_dump_children_last': + elif batch_type == 'truck_dump_children_last': kwargs['truck_dump'] = True kwargs['truck_dump_ready'] = True # TODO: this makes sense in some cases, but all? # (should just omit that field when not relevant) kwargs['date_ordered'] = None - elif workflow.startswith('truck_dump_child'): + elif batch_type.startswith('truck_dump_child'): truck_dump = self.get_instance() kwargs['store'] = truck_dump.store kwargs['vendor'] = truck_dump.vendor @@ -643,10 +774,8 @@ class ReceivingBatchView(PurchasingBatchView): breakdown = self.make_po_vs_invoice_breakdown(batch) factory = self.get_grid_factory() - g = factory(self.request, - key='batch_po_vs_invoice_breakdown', - data=[], - columns=['title', 'count']) + g = factory('batch_po_vs_invoice_breakdown', [], + columns=['title', 'count']) g.set_click_handler('title', "autoFilterPoVsInvoice(props.row)") kwargs['po_vs_invoice_breakdown_data'] = breakdown kwargs['po_vs_invoice_breakdown_grid'] = HTML.literal( @@ -902,16 +1031,14 @@ class ReceivingBatchView(PurchasingBatchView): if batch.is_truck_dump_parent(): permission_prefix = self.get_permission_prefix() if self.request.has_perm('{}.edit_row'.format(permission_prefix)): - transform = self.make_action('transform', + transform = grids.GridAction('transform', icon='shuffle', label="Transform to Unit", url=self.transform_unit_url) - if g.actions and g.actions[-1].key == 'delete': - delete = g.actions.pop() - g.actions.append(transform) - g.actions.append(delete) - else: - g.actions.append(transform) + g.more_actions.append(transform) + if g.main_actions and g.main_actions[-1].key == 'delete': + delete = g.main_actions.pop() + g.more_actions.append(delete) # truck_dump_status if not batch.is_truck_dump_parent(): @@ -984,7 +1111,7 @@ class ReceivingBatchView(PurchasingBatchView): and self.row_editable(row)): # add the Un-Declare action - g.actions.append(self.make_action( + g.main_actions.append(self.make_action( 'remove', label="Un-Declare", url='#', icon='trash', link_class='has-text-danger', @@ -1855,12 +1982,6 @@ class ReceivingBatchView(PurchasingBatchView): 'type': bool}, # vendors - {'section': 'rattail.batch', - 'option': 'purchase.allow_receiving_any_vendor', - 'type': bool}, - # TODO: deprecated; can remove this once all live config - # is updated. but for now it remains so this setting is - # auto-deleted {'section': 'rattail.batch', 'option': 'purchase.supported_vendors_only', 'type': bool}, @@ -1911,7 +2032,6 @@ class ReceivingBatchView(PurchasingBatchView): @classmethod def defaults(cls, config): cls._receiving_defaults(config) - cls._purchase_batch_defaults(config) cls._batch_defaults(config) cls._defaults(config) @@ -1919,11 +2039,17 @@ class ReceivingBatchView(PurchasingBatchView): def _receiving_defaults(cls, config): rattail_config = config.registry.settings.get('rattail_config') route_prefix = cls.get_route_prefix() + url_prefix = cls.get_url_prefix() instance_url_prefix = cls.get_instance_url_prefix() model_key = cls.get_model_key() model_title = cls.get_model_title() permission_prefix = cls.get_permission_prefix() + # new receiving batch using workflow X + config.add_route('{}.create_workflow'.format(route_prefix), '{}/new/{{workflow_key}}/{{vendor_uuid}}'.format(url_prefix)) + config.add_view(cls, attr='create', route_name='{}.create_workflow'.format(route_prefix), + permission='{}.create'.format(permission_prefix)) + # row-level receiving config.add_route('{}.receive_row'.format(route_prefix), '{}/rows/{{row_uuid}}/receive'.format(instance_url_prefix)) config.add_view(cls, attr='receive_row', route_name='{}.receive_row'.format(route_prefix), @@ -1976,6 +2102,33 @@ class ReceivingBatchView(PurchasingBatchView): permission='{}.auto_receive'.format(permission_prefix)) +@colander.deferred +def valid_workflow(node, kw): + """ + Deferred validator for ``workflow`` field, for new batches. + """ + valid_workflows = kw['valid_workflows'] + + def validate(node, value): + # we just need to provide possible values, and let stock validator + # handle the rest + oneof = colander.OneOf(valid_workflows) + return oneof(node, value) + + return validate + + +class NewReceivingBatch(colander.Schema): + """ + Schema for choosing which "type" of new receiving batch should be created. + """ + vendor = colander.SchemaNode(colander.String(), + label="Vendor") + + workflow = colander.SchemaNode(colander.String(), + validator=valid_workflow) + + class ReceiveRowForm(colander.MappingSchema): mode = colander.SchemaNode(colander.String(), diff --git a/tailbone/views/reports.py b/tailbone/views/reports.py index 099224be..aedda61c 100644 --- a/tailbone/views/reports.py +++ b/tailbone/views/reports.py @@ -308,8 +308,7 @@ class ReportOutputView(ExportMasterView): route_prefix = self.get_route_prefix() factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.params', + key='{}.params'.format(route_prefix), data=params, columns=['key', 'value'], labels={'key': "Name"}, @@ -706,12 +705,9 @@ class ProblemReportView(MasterView): return ', '.join(recips) def render_days(self, report_info, field): - factory = self.get_grid_factory() - g = factory(self.request, - key='days', - data=[], - columns=['weekday_name', 'enabled'], - labels={'weekday_name': "Weekday"}) + g = self.get_grid_factory()('days', [], + columns=['weekday_name', 'enabled'], + labels={'weekday_name': "Weekday"}) return HTML.literal(g.render_table_element(data_prop='weekdaysData')) def template_kwargs_view(self, **kwargs): diff --git a/tailbone/views/roles.py b/tailbone/views/roles.py index e8a6d8a2..0316ea87 100644 --- a/tailbone/views/roles.py +++ b/tailbone/views/roles.py @@ -30,6 +30,7 @@ from sqlalchemy import orm from openpyxl.styles import Font, PatternFill from rattail.db.model import Role +from rattail.db.auth import administrator_role, guest_role, authenticated_role from rattail.excel import ExcelWriter import colander @@ -106,11 +107,8 @@ class RoleView(PrincipalMasterView): if role.node_type and role.node_type != self.rattail_config.node_type(): return False - app = self.get_rattail_app() - auth = app.get_auth_handler() - # only "root" can edit Administrator - if role is auth.get_role_administrator(self.Session()): + if role is administrator_role(self.Session()): return self.request.is_root # only "admin" can edit "admin-ish" roles @@ -118,11 +116,11 @@ class RoleView(PrincipalMasterView): return self.request.is_admin # can edit Authenticated only if user has permission - if role is auth.get_role_authenticated(self.Session()): + if role is authenticated_role(self.Session()): return self.has_perm('edit_authenticated') # can edit Guest only if user has permission - if role is auth.get_role_anonymous(self.Session()): + if role is guest_role(self.Session()): return self.has_perm('edit_guest') # current user can edit their own roles, only if they have permission @@ -141,14 +139,11 @@ class RoleView(PrincipalMasterView): if role.node_type and role.node_type != self.rattail_config.node_type(): return False - app = self.get_rattail_app() - auth = app.get_auth_handler() - - if role is auth.get_role_administrator(self.Session()): + if role is administrator_role(self.Session()): return False - if role is auth.get_role_authenticated(self.Session()): + if role is authenticated_role(self.Session()): return False - if role is auth.get_role_anonymous(self.Session()): + if role is guest_role(self.Session()): return False # only "admin" can delete "admin-ish" roles @@ -191,17 +186,17 @@ class RoleView(PrincipalMasterView): # session_timeout f.set_renderer('session_timeout', self.render_session_timeout) - if self.editing and role is auth.get_role_anonymous(self.Session()): + if self.editing and role is guest_role(self.Session()): f.set_readonly('session_timeout') # sync_me, node_type if not self.creating: include = True - if role is auth.get_role_administrator(self.Session()): + if role is administrator_role(self.Session()): include = False - elif role is auth.get_role_authenticated(self.Session()): + elif role is authenticated_role(self.Session()): include = False - elif role is auth.get_role_anonymous(self.Session()): + elif role is guest_role(self.Session()): include = False if not include: f.remove('sync_me', 'sync_users', 'node_type') @@ -232,7 +227,7 @@ class RoleView(PrincipalMasterView): for groupkey in self.tailbone_permissions: for key in self.tailbone_permissions[groupkey]['perms']: if auth.has_permission(self.Session(), role, key, - include_anonymous=False, + include_guest=False, include_authenticated=False): granted.append(key) f.set_default('permissions', granted) @@ -240,14 +235,12 @@ class RoleView(PrincipalMasterView): f.remove_field('permissions') def render_users(self, role, field): - app = self.get_rattail_app() - auth = app.get_auth_handler() - if role is auth.get_role_anonymous(self.Session()): + if role is guest_role(self.Session()): return ("The guest role is implied for all anonymous users, " "i.e. when not logged in.") - if role is auth.get_role_authenticated(self.Session()): + if role is authenticated_role(self.Session()): return ("The authenticated role is implied for all users, " "but only when logged in.") @@ -255,8 +248,8 @@ class RoleView(PrincipalMasterView): permission_prefix = self.get_permission_prefix() factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.users', + key='{}.users'.format(route_prefix), + request=self.request, data=[], columns=[ 'full_name', @@ -269,9 +262,9 @@ class RoleView(PrincipalMasterView): ) if self.request.has_perm('users.view'): - g.actions.append(self.make_action('view', icon='eye')) + g.main_actions.append(self.make_action('view', icon='eye')) if self.request.has_perm('users.edit'): - g.actions.append(self.make_action('edit', icon='edit')) + g.main_actions.append(self.make_action('edit', icon='edit')) return HTML.literal( g.render_table_element(data_prop='usersData')) @@ -287,8 +280,8 @@ class RoleView(PrincipalMasterView): if the current user is an admin; otherwise it will be the "subset" of permissions which the current user has been granted. """ - # get all known permissions from settings cache - permissions = self.request.registry.settings.get('wutta_permissions', {}) + # fetch full set of permissions registered in the app + permissions = self.request.registry.settings.get('tailbone_permissions', {}) # admin user gets to manage all permissions if self.request.is_admin: @@ -315,9 +308,7 @@ class RoleView(PrincipalMasterView): return available def render_session_timeout(self, role, field): - app = self.get_rattail_app() - auth = app.get_auth_handler() - if role is auth.get_role_anonymous(self.Session()): + if role is guest_role(self.Session()): return "(not applicable)" if role.session_timeout is None: return "" @@ -356,26 +347,23 @@ class RoleView(PrincipalMasterView): auth.revoke_permission(role, pkey) def template_kwargs_view(self, **kwargs): - app = self.get_rattail_app() - auth = app.get_auth_handler() model = self.model role = kwargs['instance'] if role.users: users = sorted(role.users, key=lambda u: u.username) actions = [ - self.make_action('view', icon='zoomin', + grids.GridAction('view', icon='zoomin', url=lambda r, i: self.request.route_url('users.view', uuid=r.uuid)) ] - kwargs['users'] = grids.Grid(self.request, - data=users, - columns=['username', 'active'], + kwargs['users'] = grids.Grid(None, users, ['username', 'active'], + request=self.request, model_class=model.User, - actions=actions) + main_actions=actions) else: kwargs['users'] = None - kwargs['guest_role'] = auth.get_role_anonymous(self.Session()) - kwargs['authenticated_role'] = auth.get_role_authenticated(self.Session()) + kwargs['guest_role'] = guest_role(self.Session()) + kwargs['authenticated_role'] = authenticated_role(self.Session()) role = kwargs['instance'] if role not in (kwargs['guest_role'], kwargs['authenticated_role']): @@ -396,11 +384,9 @@ class RoleView(PrincipalMasterView): return kwargs def before_delete(self, role): - app = self.get_rattail_app() - auth = app.get_auth_handler() - admin = auth.get_role_administrator(self.Session()) - guest = auth.get_role_anonymous(self.Session()) - authenticated = auth.get_role_authenticated(self.Session()) + admin = administrator_role(self.Session()) + guest = guest_role(self.Session()) + authenticated = authenticated_role(self.Session()) if role in (admin, guest, authenticated): self.request.session.flash("You may not delete the {} role.".format(role.name), 'error') return self.redirect(self.request.get_referrer(default=self.request.route_url('roles'))) @@ -416,7 +402,7 @@ class RoleView(PrincipalMasterView): .options(orm.joinedload(model.Role._permissions)) roles = [] for role in all_roles: - if auth.has_permission(session, role, permission, include_anonymous=False): + if auth.has_permission(session, role, permission, include_guest=False): roles.append(role) return roles @@ -489,7 +475,7 @@ class RoleView(PrincipalMasterView): # and show an 'X' for any role which has this perm for col, role in enumerate(roles, 2): if auth.has_permission(self.Session(), role, key, - include_anonymous=False): + include_guest=False): sheet.cell(row=writing_row, column=col, value="X") writing_row += 1 diff --git a/tailbone/views/settings.py b/tailbone/views/settings.py index 10a0c2eb..8d389530 100644 --- a/tailbone/views/settings.py +++ b/tailbone/views/settings.py @@ -24,167 +24,214 @@ Settings Views """ -import json +import os import re +import subprocess +import sys +from collections import OrderedDict -import colander +import json from rattail.db.model import Setting from rattail.settings import Setting as AppSetting from rattail.util import import_module_path -from tailbone import forms, grids +import colander + +from tailbone import forms from tailbone.db import Session from tailbone.views import MasterView, View -from wuttaweb.util import get_libver, get_liburl -from wuttaweb.views.settings import AppInfoView as WuttaAppInfoView +from tailbone.util import get_libver, get_liburl -class AppInfoView(WuttaAppInfoView): - """ """ - Session = Session - weblib_config_prefix = 'tailbone' +class AppInfoView(MasterView): + """ + Master view for the overall app, to show/edit config etc. + """ + route_prefix = 'appinfo' + model_key = 'UNUSED' + model_title = "UNUSED" + model_title_plural = "App Details" + creatable = False + viewable = False + editable = False + deletable = False + filterable = False + pageable = False + configurable = True - # TODO: for now we override to get tailbone searchable grid - def make_grid(self, **kwargs): - """ """ - return grids.Grid(self.request, **kwargs) - - def configure_grid(self, g): - """ """ - super().configure_grid(g) - - # name - g.set_searchable('name') - - # editable_project_location - g.set_searchable('editable_project_location') - - def configure_get_context(self, **kwargs): - """ """ - context = super().configure_get_context(**kwargs) - simple_settings = context['simple_settings'] - weblibs = context['weblibs'] - - for weblib in weblibs: - key = weblib['key'] - - # TODO: this is only needed to migrate legacy settings to - # use the newer wuttaweb setting names - url = simple_settings[f'wuttaweb.liburl.{key}'] - if not url and weblib['configured_url']: - simple_settings[f'wuttaweb.liburl.{key}'] = weblib['configured_url'] - - return context - - # nb. these email settings require special handling below - configure_profile_key_mismatches = [ - 'default.subject', - 'default.to', - 'default.cc', - 'default.bcc', - 'feedback.subject', - 'feedback.to', + grid_columns = [ + 'name', + 'version', + 'editable_project_location', ] - def configure_get_simple_settings(self): - """ """ - simple_settings = super().configure_get_simple_settings() + def get_index_title(self): + app = self.get_rattail_app() + return "{} for {}".format(self.get_model_title_plural(), + app.get_title()) - # TODO: - # there are several email config keys which differ between - # wuttjamaican and rattail. basically all of the "profile" keys - # have a different prefix. + def get_data(self, session=None): + pip = os.path.join(sys.prefix, 'bin', 'pip') + output = subprocess.check_output([pip, 'list', '--format=json']) + data = json.loads(output.decode('utf_8').strip()) - # after wuttaweb has declared its settings, we examine each and - # overwrite the value if one is defined with rattail config key. - # (nb. this happens even if wuttjamaican key has a value!) + for pkg in data: + pkg.setdefault('editable_project_location', '') - # note that we *do* declare the profile mismatch keys for - # rattail, as part of simple settings. this ensures the - # parent logic will always remove them when saving. however - # we must also include them in gather_settings() to ensure - # they are saved to match wuttjamaican values. + return data - # there are also a couple of flags where rattail's default is the - # opposite of wuttjamaican. so we overwrite those too as needed. + def configure_grid(self, g): + super().configure_grid(g) - for setting in simple_settings: + g.sorters['name'] = g.make_simple_sorter('name', foldcase=True) + g.set_sort_defaults('name') + g.set_searchable('name') - # nb. the update home page redirect setting is off by - # default for wuttaweb, but on for tailbone - if setting['name'] == 'wuttaweb.home_redirect_to_login': - value = self.config.get_bool('wuttaweb.home_redirect_to_login') - if value is None: - value = self.config.get_bool('tailbone.login_is_home', default=True) - setting['value'] = value + g.sorters['version'] = g.make_simple_sorter('version', foldcase=True) - # nb. sending email is off by default for wuttjamaican, - # but on for rattail - elif setting['name'] == 'rattail.mail.send_emails': - value = self.config.get_bool('rattail.mail.send_emails', default=True) - setting['value'] = value + g.sorters['editable_project_location'] = g.make_simple_sorter( + 'editable_project_location', foldcase=True) + g.set_searchable('editable_project_location') - # nb. this one is even more special, key is entirely different - elif setting['name'] == 'rattail.email.default.sender': - value = self.config.get('rattail.email.default.sender') - if value is None: - value = self.config.get('rattail.mail.default.from') - setting['value'] = value + def template_kwargs_index(self, **kwargs): + kwargs = super().template_kwargs_index(**kwargs) + kwargs['configure_button_title'] = "Configure App" + return kwargs - else: + def configure_get_context(self, **kwargs): + context = super().configure_get_context(**kwargs) - # nb. fetch alternate value for profile key mismatch - for key in self.configure_profile_key_mismatches: - if setting['name'] == f'rattail.email.{key}': - value = self.config.get(f'rattail.email.{key}') - if value is None: - value = self.config.get(f'rattail.mail.{key}') - setting['value'] = value - break - - # nb. these are no longer used (deprecated), but we keep - # them defined here so the tool auto-deletes them - - simple_settings.extend([ - {'name': 'tailbone.login_is_home'}, - {'name': 'tailbone.buefy_version'}, - {'name': 'tailbone.vue_version'}, + weblibs = OrderedDict([ + ('vue', "Vue"), + ('vue_resource', "vue-resource"), + ('buefy', "Buefy"), + ('buefy.css', "Buefy CSS"), + ('fontawesome', "FontAwesome"), + ('bb_vue', "(BB) vue"), + ('bb_oruga', "(BB) @oruga-ui/oruga-next"), + ('bb_oruga_bulma', "(BB) @oruga-ui/theme-bulma (JS)"), + ('bb_oruga_bulma_css', "(BB) @oruga-ui/theme-bulma (CSS)"), + ('bb_fontawesome_svg_core', "(BB) @fortawesome/fontawesome-svg-core"), + ('bb_free_solid_svg_icons', "(BB) @fortawesome/free-solid-svg-icons"), + ('bb_vue_fontawesome', "(BB) @fortawesome/vue-fontawesome"), ]) - simple_settings.append({'name': 'rattail.mail.default.from'}) - for key in self.configure_profile_key_mismatches: - simple_settings.append({'name': f'rattail.mail.{key}'}) + for key in weblibs: + title = weblibs[key] + weblibs[key] = { + 'key': key, + 'title': title, - for key in self.get_weblibs(): - simple_settings.extend([ - {'name': f'tailbone.libver.{key}'}, - {'name': f'tailbone.liburl.{key}'}, - ]) + # nb. these values are exactly as configured, and are + # used for editing the settings + 'configured_version': get_libver(self.request, key, fallback=False), + 'configured_url': get_liburl(self.request, key, fallback=False), - return simple_settings + # these are for informational purposes only + 'default_version': get_libver(self.request, key, default_only=True), + 'live_url': get_liburl(self.request, key), + } - def configure_gather_settings(self, data, simple_settings=None): - """ """ - settings = super().configure_gather_settings(data, simple_settings=simple_settings) + context['weblibs'] = list(weblibs.values()) + return context - # nb. must add legacy rattail profile settings to match new ones - for setting in list(settings): + def configure_get_simple_settings(self): + return [ - if setting['name'] == 'rattail.email.default.sender': - value = setting['value'] - settings.append({'name': 'rattail.mail.default.from', - 'value': value}) + # basics + {'section': 'rattail', + 'option': 'app_title'}, + {'section': 'rattail', + 'option': 'node_type'}, + {'section': 'rattail', + 'option': 'node_title'}, + {'section': 'rattail', + 'option': 'production', + 'type': bool}, + {'section': 'rattail', + 'option': 'running_from_source', + 'type': bool}, + {'section': 'rattail', + 'option': 'running_from_source.rootpkg'}, - else: - for key in self.configure_profile_key_mismatches: - if setting['name'] == f'rattail.email.{key}': - value = setting['value'] - settings.append({'name': f'rattail.mail.{key}', - 'value': value}) - break + # display + {'section': 'tailbone', + 'option': 'background_color'}, - return settings + # grids + {'section': 'tailbone', + 'option': 'grid.default_pagesize', + # TODO: seems like should enforce this, but validation is + # not setup yet + # 'type': int + }, + + # web libs + {'section': 'tailbone', + 'option': 'libver.vue'}, + {'section': 'tailbone', + 'option': 'liburl.vue'}, + {'section': 'tailbone', + 'option': 'libver.vue_resource'}, + {'section': 'tailbone', + 'option': 'liburl.vue_resource'}, + {'section': 'tailbone', + 'option': 'libver.buefy'}, + {'section': 'tailbone', + 'option': 'liburl.buefy'}, + {'section': 'tailbone', + 'option': 'libver.buefy.css'}, + {'section': 'tailbone', + 'option': 'liburl.buefy.css'}, + {'section': 'tailbone', + 'option': 'libver.fontawesome'}, + {'section': 'tailbone', + 'option': 'liburl.fontawesome'}, + + {'section': 'tailbone', + 'option': 'libver.bb_vue'}, + {'section': 'tailbone', + 'option': 'liburl.bb_vue'}, + + {'section': 'tailbone', + 'option': 'libver.bb_oruga'}, + {'section': 'tailbone', + 'option': 'liburl.bb_oruga'}, + + {'section': 'tailbone', + 'option': 'libver.bb_oruga_bulma'}, + {'section': 'tailbone', + 'option': 'liburl.bb_oruga_bulma'}, + + {'section': 'tailbone', + 'option': 'libver.bb_oruga_bulma_css'}, + {'section': 'tailbone', + 'option': 'liburl.bb_oruga_bulma_css'}, + + {'section': 'tailbone', + 'option': 'libver.bb_fontawesome_svg_core'}, + {'section': 'tailbone', + 'option': 'liburl.bb_fontawesome_svg_core'}, + + {'section': 'tailbone', + 'option': 'libver.bb_free_solid_svg_icons'}, + {'section': 'tailbone', + 'option': 'liburl.bb_free_solid_svg_icons'}, + + {'section': 'tailbone', + 'option': 'libver.bb_vue_fontawesome'}, + {'section': 'tailbone', + 'option': 'liburl.bb_vue_fontawesome'}, + + # nb. these are no longer used (deprecated), but we keep + # them defined here so the tool auto-deletes them + {'section': 'tailbone', + 'option': 'buefy_version'}, + {'section': 'tailbone', + 'option': 'vue_version'}, + + ] class SettingView(MasterView): diff --git a/tailbone/views/tempmon/core.py b/tailbone/views/tempmon/core.py index 7540abbe..d551d6e6 100644 --- a/tailbone/views/tempmon/core.py +++ b/tailbone/views/tempmon/core.py @@ -77,8 +77,8 @@ class MasterView(views.MasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.probes', + key='{}.probes'.format(route_prefix), + request=self.request, data=[], columns=[ 'description', @@ -96,7 +96,7 @@ class MasterView(views.MasterView): 'critical_temp_max': "Crit. Max", }, linked_columns=['description'], - actions=actions, + main_actions=actions, ) return HTML.literal( g.render_table_element(data_prop='probesData')) diff --git a/tailbone/views/trainwreck/base.py b/tailbone/views/trainwreck/base.py index d5f077aa..9a6086d7 100644 --- a/tailbone/views/trainwreck/base.py +++ b/tailbone/views/trainwreck/base.py @@ -246,17 +246,16 @@ class TransactionView(MasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.custorder_xref_markers', + key='{}.custorder_xref_markers'.format(route_prefix), data=[], - columns=['custorder_xref', 'custorder_item_xref']) + columns=['custorder_xref', 'custorder_item_xref'], + request=self.request) return HTML.literal( g.render_table_element(data_prop='custorderXrefMarkersData')) def template_kwargs_view(self, **kwargs): kwargs = super().template_kwargs_view(**kwargs) - config = self.rattail_config form = kwargs['form'] if 'custorder_xref_markers' in form: @@ -269,13 +268,6 @@ class TransactionView(MasterView): }) kwargs['custorder_xref_markers_data'] = markers - # collapse header - kwargs['main_form_title'] = "Transaction Header" - kwargs['main_form_collapsible'] = True - kwargs['main_form_autocollapse'] = config.get_bool( - 'tailbone.trainwreck.view_txn.autocollapse_header', - default=False) - return kwargs def get_xref_buttons(self, txn): @@ -355,11 +347,11 @@ class TransactionView(MasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.discounts', + key='{}.discounts'.format(route_prefix), data=[], columns=['discount_type', 'description', 'amount'], - labels={'discount_type': "Type"}) + labels={'discount_type': "Type"}, + request=self.request) return HTML.literal( g.render_table_element(data_prop='discountsData')) @@ -427,11 +419,6 @@ class TransactionView(MasterView): def configure_get_simple_settings(self): return [ - # display - {'section': 'tailbone', - 'option': 'trainwreck.view_txn.autocollapse_header', - 'type': bool}, - # rotation {'section': 'trainwreck', 'option': 'use_rotation', diff --git a/tailbone/views/upgrades.py b/tailbone/views/upgrades.py index ffa88032..3276b64d 100644 --- a/tailbone/views/upgrades.py +++ b/tailbone/views/upgrades.py @@ -348,27 +348,56 @@ class UpgradeView(MasterView): commit_hash_pattern = re.compile(r'^.{40}$') def get_changelog_projects(self): - project_map = { - 'onager': 'onager', - 'pyCOREPOS': 'pycorepos', - 'rattail': 'rattail', - 'rattail_corepos': 'rattail-corepos', - 'rattail-onager': 'rattail-onager', - 'rattail_tempmon': 'rattail-tempmon', - 'rattail_woocommerce': 'rattail-woocommerce', - 'Tailbone': 'tailbone', - 'tailbone_corepos': 'tailbone-corepos', - 'tailbone-onager': 'tailbone-onager', - 'tailbone_theo': 'theo', - 'tailbone_woocommerce': 'tailbone-woocommerce', + projects = { + 'rattail': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/rattail/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/rattail/files/v{new_version}/CHANGES.rst', + }, + 'Tailbone': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/tailbone/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/tailbone/files/v{new_version}/CHANGES.rst', + }, + 'pyCOREPOS': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/pycorepos/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/pycorepos/files/v{new_version}/CHANGES.rst', + }, + 'rattail_corepos': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/rattail-corepos/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/rattail-corepos/files/v{new_version}/CHANGES.rst', + }, + 'tailbone_corepos': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/tailbone-corepos/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/tailbone-corepos/files/v{new_version}/CHANGES.rst', + }, + 'onager': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-restricted/onager/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-restricted/onager/files/v{new_version}/CHANGES.rst', + }, + 'rattail-onager': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-restricted/rattail-onager/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-restricted/rattail-onager/files/v{new_version}/CHANGELOG.md', + }, + 'rattail_tempmon': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/rattail-tempmon/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/rattail-tempmon/files/v{new_version}/CHANGES.rst', + }, + 'tailbone-onager': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-restricted/tailbone-onager/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-restricted/tailbone-onager/files/v{new_version}/CHANGELOG.md', + }, + 'rattail_woocommerce': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/rattail-woocommerce/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/rattail-woocommerce/files/v{new_version}/CHANGES.rst', + }, + 'tailbone_woocommerce': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/tailbone-woocommerce/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/tailbone-woocommerce/files/v{new_version}/CHANGES.rst', + }, + 'tailbone_theo': { + 'commit_url': 'https://kallithea.rattailproject.org/rattail-project/theo/changelog/{new_version}/?size=10', + 'release_url': 'https://kallithea.rattailproject.org/rattail-project/theo/files/v{new_version}/CHANGES.rst', + }, } - - projects = {} - for name, repo in project_map.items(): - projects[name] = { - 'commit_url': f'https://forgejo.wuttaproject.org/rattail/{repo}/compare/{{old_version}}...{{new_version}}', - 'release_url': f'https://forgejo.wuttaproject.org/rattail/{repo}/src/tag/v{{new_version}}/CHANGELOG.md', - } return projects def get_changelog_url(self, project, old_version, new_version): diff --git a/tailbone/views/users.py b/tailbone/views/users.py index dfed0a11..dd3f7f7b 100644 --- a/tailbone/views/users.py +++ b/tailbone/views/users.py @@ -28,6 +28,8 @@ import sqlalchemy as sa from sqlalchemy import orm from rattail.db.model import User, UserEvent +from rattail.db.auth import (administrator_role, guest_role, + authenticated_role, set_user_password) import colander from deform import widget as dfwidget @@ -44,6 +46,9 @@ class UserView(PrincipalMasterView): Master view for the User model. """ model_class = User + has_rows = True + rows_title = "User Events" + model_row_class = UserEvent has_versions = True touchable = True mergeable = True @@ -74,11 +79,6 @@ class UserView(PrincipalMasterView): 'permissions', ] - has_rows = True - model_row_class = UserEvent - rows_title = "User Events" - rows_viewable = False - row_grid_columns = [ 'type_code', 'occurred', @@ -210,13 +210,9 @@ class UserView(PrincipalMasterView): person_display = str(person) elif self.editing: person_display = str(user.person or '') - try: - people_url = self.request.route_url('people.autocomplete') - except KeyError: - pass # TODO: wutta compat - else: - f.set_widget('person_uuid', forms.widgets.JQueryAutocompleteWidget( - field_display=person_display, service_url=people_url)) + people_url = self.request.route_url('people.autocomplete') + f.set_widget('person_uuid', forms.widgets.JQueryAutocompleteWidget( + field_display=person_display, service_url=people_url)) f.set_validator('person_uuid', self.valid_person) f.set_label('person_uuid', "Person") @@ -282,10 +278,10 @@ class UserView(PrincipalMasterView): # fs.confirm_password.attrs(autocomplete='new-password') if self.viewing: - permissions = self.request.registry.settings.get('wutta_permissions', {}) + permissions = self.request.registry.settings.get('tailbone_permissions', {}) f.set_renderer('permissions', PermissionsRenderer(request=self.request, permissions=permissions, - include_anonymous=True, + include_guest=True, include_authenticated=True)) else: f.remove('permissions') @@ -299,11 +295,11 @@ class UserView(PrincipalMasterView): factory = self.get_grid_factory() g = factory( - self.request, - key=f'{route_prefix}.api_tokens', + request=self.request, + key='{}.api_tokens'.format(route_prefix), data=[], columns=['description', 'created'], - actions=[ + main_actions=[ self.make_action('delete', icon='trash', click_handler="$emit('api-token-delete', props.row)")]) @@ -364,19 +360,17 @@ class UserView(PrincipalMasterView): return tokens def get_possible_roles(self): - app = self.get_rattail_app() - auth = app.get_auth_handler() - model = app.model + model = self.model # some roles should never have users "belong" to them excluded = [ - auth.get_role_anonymous(self.Session()).uuid, - auth.get_role_authenticated(self.Session()).uuid, + guest_role(self.Session()).uuid, + authenticated_role(self.Session()).uuid, ] # only allow "root" user to change true admin role membership if not self.request.is_root: - excluded.append(auth.get_role_administrator(self.Session()).uuid) + excluded.append(administrator_role(self.Session()).uuid) # basic list, minus exclusions so far roles = self.Session.query(model.Role)\ @@ -391,9 +385,7 @@ class UserView(PrincipalMasterView): return roles.order_by(model.Role.name) def objectify(self, form, data=None): - app = self.get_rattail_app() - auth = app.get_auth_handler() - model = app.model + model = self.model # create/update user as per normal if data is None: @@ -428,7 +420,7 @@ class UserView(PrincipalMasterView): # maybe set user password if 'set_password' in form and data['set_password']: - auth.set_user_password(user, data['set_password']) + set_user_password(user, data['set_password']) # update roles for user self.update_roles(user, data) @@ -441,12 +433,10 @@ class UserView(PrincipalMasterView): if 'roles' not in data: return - app = self.get_rattail_app() - auth = app.get_auth_handler() - model = app.model + model = self.model old_roles = set([r.uuid for r in user.roles]) new_roles = data['roles'] - admin = auth.get_role_administrator(self.Session()) + admin = administrator_role(self.Session()) # add any new roles for the user, taking care not to add the admin role # unless acting as root @@ -516,6 +506,7 @@ class UserView(PrincipalMasterView): g.set_sort_defaults('occurred', 'desc') g.set_enum('type_code', self.enum.USER_EVENT) g.set_label('type_code', "Event Type") + g.main_actions = [] def get_version_child_classes(self): model = self.model @@ -801,8 +792,4 @@ def defaults(config, **kwargs): def includeme(config): - wutta_config = config.registry.settings['wutta_config'] - if wutta_config.get_bool('tailbone.use_wutta_views', default=False, usedb=False): - config.include('tailbone.views.wutta.users') - else: - defaults(config) + defaults(config) diff --git a/tailbone/views/workorders.py b/tailbone/views/workorders.py index d8094e4b..a53037bc 100644 --- a/tailbone/views/workorders.py +++ b/tailbone/views/workorders.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar +# Copyright © 2010-2023 Lance Edgar # # This file is part of Rattail. # @@ -83,12 +83,12 @@ class WorkOrderView(MasterView): ] def __init__(self, request): - super().__init__(request) + super(WorkOrderView, self).__init__(request) app = self.get_rattail_app() self.workorder_handler = app.get_workorder_handler() def configure_grid(self, g): - super().configure_grid(g) + super(WorkOrderView, self).configure_grid(g) model = self.model # customer @@ -113,7 +113,7 @@ class WorkOrderView(MasterView): return 'warning' def configure_form(self, f): - super().configure_form(f) + super(WorkOrderView, self).configure_form(f) model = self.model SelectWidget = forms.widgets.JQuerySelectWidget @@ -208,7 +208,7 @@ class WorkOrderView(MasterView): return event.workorder def configure_row_grid(self, g): - super().configure_row_grid(g) + super(WorkOrderView, self).configure_row_grid(g) g.set_enum('type_code', self.enum.WORKORDER_EVENT) g.set_sort_defaults('occurred') @@ -353,7 +353,7 @@ class WorkOrderView(MasterView): class StatusFilter(grids.filters.AlchemyIntegerFilter): def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) + super(StatusFilter, self).__init__(*args, **kwargs) from drild import enum @@ -369,14 +369,14 @@ class StatusFilter(grids.filters.AlchemyIntegerFilter): @property def verb_labels(self): - labels = dict(super().verb_labels) + labels = dict(super(StatusFilter, self).verb_labels) labels['is_active'] = "Is Active" labels['not_active'] = "Is Not Active" return labels @property def valueless_verbs(self): - verbs = list(super().valueless_verbs) + verbs = list(super(StatusFilter, self).valueless_verbs) verbs.extend([ 'is_active', 'not_active', @@ -385,11 +385,7 @@ class StatusFilter(grids.filters.AlchemyIntegerFilter): @property def default_verbs(self): - verbs = super().default_verbs - if callable(verbs): - verbs = verbs() - - verbs = list(verbs or []) + verbs = list(super(StatusFilter, self).default_verbs) verbs.insert(0, 'is_active') verbs.insert(1, 'not_active') return verbs diff --git a/tailbone/views/wutta/__init__.py b/tailbone/views/wutta/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/tailbone/views/wutta/people.py b/tailbone/views/wutta/people.py deleted file mode 100644 index bd96bd4d..00000000 --- a/tailbone/views/wutta/people.py +++ /dev/null @@ -1,143 +0,0 @@ -# -*- coding: utf-8; -*- -################################################################################ -# -# Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar -# -# This file is part of Rattail. -# -# Rattail 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. -# -# Rattail 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 -# Rattail. If not, see . -# -################################################################################ -""" -Person Views -""" - -import colander -import sqlalchemy as sa -from webhelpers2.html import HTML - -from wuttaweb.views import people as wutta -from tailbone.views import people as tailbone -from tailbone.db import Session -from rattail.db.model import Person -from tailbone.grids import Grid - - -class PersonView(wutta.PersonView): - """ - This is the first attempt at blending newer Wutta views with - legacy Tailbone config. - - So, this is a Wutta-based view but it should be included by a - Tailbone app configurator. - """ - model_class = Person - Session = Session - - labels = { - 'display_name': "Full Name", - } - - grid_columns = [ - 'display_name', - 'first_name', - 'last_name', - 'phone', - 'email', - 'merge_requested', - ] - - filter_defaults = { - 'display_name': {'active': True, 'verb': 'contains'}, - } - sort_defaults = 'display_name' - - form_fields = [ - 'first_name', - 'middle_name', - 'last_name', - 'display_name', - 'phone', - 'email', - # TODO - # 'address', - ] - - ############################## - # CRUD methods - ############################## - - # TODO: must use older grid for now, to render filters correctly - def make_grid(self, **kwargs): - """ """ - return Grid(self.request, **kwargs) - - def configure_grid(self, g): - """ """ - super().configure_grid(g) - - # display_name - g.set_link('display_name') - - # merge_requested - g.set_label('merge_requested', "MR") - g.set_renderer('merge_requested', self.render_merge_requested) - - def configure_form(self, f): - """ """ - super().configure_form(f) - - # email - if self.creating or self.editing: - f.remove('email') - else: - # nb. avoid colanderalchemy - f.set_node('email', colander.String()) - - # phone - if self.creating or self.editing: - f.remove('phone') - else: - # nb. avoid colanderalchemy - f.set_node('phone', colander.String()) - - ############################## - # support methods - ############################## - - def render_merge_requested(self, person, key, value, session=None): - """ """ - model = self.app.model - session = session or self.Session() - merge_request = session.query(model.MergePeopleRequest)\ - .filter(sa.or_( - model.MergePeopleRequest.removing_uuid == person.uuid, - model.MergePeopleRequest.keeping_uuid == person.uuid))\ - .filter(model.MergePeopleRequest.merged == None)\ - .first() - if merge_request: - return HTML.tag('span', - class_='has-text-danger has-text-weight-bold', - title="A merge has been requested for this person.", - c="MR") - - -def defaults(config, **kwargs): - kwargs.setdefault('PersonView', PersonView) - tailbone.defaults(config, **kwargs) - - -def includeme(config): - defaults(config) diff --git a/tailbone/views/wutta/users.py b/tailbone/views/wutta/users.py deleted file mode 100644 index 3c3f8d52..00000000 --- a/tailbone/views/wutta/users.py +++ /dev/null @@ -1,57 +0,0 @@ -# -*- coding: utf-8; -*- -################################################################################ -# -# Rattail -- Retail Software Framework -# Copyright © 2010-2024 Lance Edgar -# -# This file is part of Rattail. -# -# Rattail 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. -# -# Rattail 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 -# Rattail. If not, see . -# -################################################################################ -""" -User Views -""" - -from wuttaweb.views import users as wutta -from tailbone.views import users as tailbone -from tailbone.db import Session -from rattail.db.model import User -from tailbone.grids import Grid - - -class UserView(wutta.UserView): - """ - This is the first attempt at blending newer Wutta views with - legacy Tailbone config. - - So, this is a Wutta-based view but it should be included by a - Tailbone app configurator. - """ - model_class = User - Session = Session - - # TODO: must use older grid for now, to render filters correctly - def make_grid(self, **kwargs): - """ """ - return Grid(self.request, **kwargs) - - -def defaults(config, **kwargs): - kwargs.setdefault('UserView', UserView) - tailbone.defaults(config, **kwargs) - - -def includeme(config): - defaults(config) diff --git a/tailbone/webapi.py b/tailbone/webapi.py index d0edb412..1c2fa106 100644 --- a/tailbone/webapi.py +++ b/tailbone/webapi.py @@ -85,34 +85,21 @@ def make_pyramid_config(settings): provider.configure_db_sessions(rattail_config, pyramid_config) # add some permissions magic - pyramid_config.add_directive('add_wutta_permission_group', - 'wuttaweb.auth.add_permission_group') - pyramid_config.add_directive('add_wutta_permission', - 'wuttaweb.auth.add_permission') - # TODO: deprecate / remove these - pyramid_config.add_directive('add_tailbone_permission_group', - 'wuttaweb.auth.add_permission_group') - pyramid_config.add_directive('add_tailbone_permission', - 'wuttaweb.auth.add_permission') + pyramid_config.add_directive('add_tailbone_permission_group', 'tailbone.auth.add_permission_group') + pyramid_config.add_directive('add_tailbone_permission', 'tailbone.auth.add_permission') return pyramid_config -def main(global_config, views='tailbone.api', **settings): +def main(global_config, **settings): """ This function returns a Pyramid WSGI application. """ rattail_config = make_rattail_config(settings) pyramid_config = make_pyramid_config(settings) - # event hooks - pyramid_config.add_subscriber('tailbone.subscribers.new_request', - 'pyramid.events.NewRequest') - # TODO: is this really needed? - pyramid_config.add_subscriber('tailbone.subscribers.context_found', - 'pyramid.events.ContextFound') - - # views - pyramid_config.include(views) + # bring in some Tailbone + pyramid_config.include('tailbone.subscribers') + pyramid_config.include('tailbone.api') return pyramid_config.make_wsgi_app() diff --git a/tests/__init__.py b/tests/__init__.py index 40d8071f..7dec63f0 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -12,6 +12,9 @@ class TestCase(unittest.TestCase): def setUp(self): self.config = testing.setUp() + # TODO: this probably shouldn't (need to) be here + self.config.add_directive('add_tailbone_permission_group', 'tailbone.auth.add_permission_group') + self.config.add_directive('add_tailbone_permission', 'tailbone.auth.add_permission') def tearDown(self): testing.tearDown() diff --git a/tests/forms/__init__.py b/tests/forms/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/forms/test_core.py b/tests/forms/test_core.py deleted file mode 100644 index 894d2302..00000000 --- a/tests/forms/test_core.py +++ /dev/null @@ -1,153 +0,0 @@ -# -*- coding: utf-8; -*- - -from unittest.mock import patch - -import deform -from pyramid import testing - -from tailbone.forms import core as mod -from tests.util import WebTestCase - - -class TestForm(WebTestCase): - - def setUp(self): - self.setup_web() - self.config.setdefault('rattail.web.menus.handler_spec', 'tests.util:NullMenuHandler') - - def make_form(self, **kwargs): - kwargs.setdefault('request', self.request) - return mod.Form(**kwargs) - - def test_basic(self): - form = self.make_form() - self.assertIsInstance(form, mod.Form) - - def test_vue_tagname(self): - - # default - form = self.make_form() - self.assertEqual(form.vue_tagname, 'tailbone-form') - - # can override with param - form = self.make_form(vue_tagname='something-else') - self.assertEqual(form.vue_tagname, 'something-else') - - # can still pass old param - form = self.make_form(component='legacy-name') - self.assertEqual(form.vue_tagname, 'legacy-name') - - def test_vue_component(self): - - # default - form = self.make_form() - self.assertEqual(form.vue_component, 'TailboneForm') - - # can override with param - form = self.make_form(vue_tagname='something-else') - self.assertEqual(form.vue_component, 'SomethingElse') - - # can still pass old param - form = self.make_form(component='legacy-name') - self.assertEqual(form.vue_component, 'LegacyName') - - def test_component(self): - - # default - form = self.make_form() - self.assertEqual(form.component, 'tailbone-form') - - # can override with param - form = self.make_form(vue_tagname='something-else') - self.assertEqual(form.component, 'something-else') - - # can still pass old param - form = self.make_form(component='legacy-name') - self.assertEqual(form.component, 'legacy-name') - - def test_component_studly(self): - - # default - form = self.make_form() - self.assertEqual(form.component_studly, 'TailboneForm') - - # can override with param - form = self.make_form(vue_tagname='something-else') - self.assertEqual(form.component_studly, 'SomethingElse') - - # can still pass old param - form = self.make_form(component='legacy-name') - self.assertEqual(form.component_studly, 'LegacyName') - - def test_button_label_submit(self): - form = self.make_form() - - # default - self.assertEqual(form.button_label_submit, "Submit") - - # can set submit_label - with patch.object(form, 'submit_label', new="Submit Label", create=True): - self.assertEqual(form.button_label_submit, "Submit Label") - - # can set save_label - with patch.object(form, 'save_label', new="Save Label"): - self.assertEqual(form.button_label_submit, "Save Label") - - # can set button_label_submit - form.button_label_submit = "New Label" - self.assertEqual(form.button_label_submit, "New Label") - - def test_get_deform(self): - model = self.app.model - - # sanity check - form = self.make_form(model_class=model.Setting) - dform = form.get_deform() - self.assertIsInstance(dform, deform.Form) - - def test_render_vue_tag(self): - model = self.app.model - - # sanity check - form = self.make_form(model_class=model.Setting) - html = form.render_vue_tag() - self.assertIn('