# -*- coding: utf-8; -*-
################################################################################
#
# Rattail -- Retail Software Framework
# Copyright © 2010-2023 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 <http://www.gnu.org/licenses/>.
#
################################################################################
"""
Base View Class
"""
import os
from rattail.db import model
from rattail.core import Object
from rattail.util import progress_loop
from pyramid import httpexceptions
from pyramid.renderers import render_to_response
from pyramid.response import FileResponse
from tailbone.db import Session
from tailbone.auth import logout_user
from tailbone.progress import SessionProgress
from tailbone.config import protected_usernames
[docs]
class View(object):
"""
Base class for all class-based views.
"""
# quickie (search)
expose_quickie_search = False
def __init__(self, request, context=None):
self.request = request
# if user becomes inactive while logged in, log them out
if getattr(request, 'user', None):
# TODO: why is the user sometimes not attached to session?
# (this has only been seen on mobile, when creating a new ordering batch)
if request.user not in Session():
request.user = Session.merge(request.user)
if not request.user.active:
headers = logout_user(request)
raise self.redirect(request.route_url('home'))
config = self.rattail_config
if config:
self.enum = config.get_enum()
self.model = config.get_model()
@property
def rattail_config(self):
"""
Reference to the effective Rattail config object.
"""
return getattr(self.request, 'rattail_config', None)
[docs]
def get_rattail_app(self):
"""
Returns the Rattail ``AppHandler`` instance, creating it if necessary.
"""
if not hasattr(self, 'rattail_app'):
self.rattail_app = self.rattail_config.get_app()
return self.rattail_app
[docs]
def forbidden(self):
"""
Convenience method, to raise a HTTP 403 Forbidden exception.
"""
return httpexceptions.HTTPForbidden()
def notfound(self):
return httpexceptions.HTTPNotFound()
[docs]
def late_login_user(self):
"""
Returns the :class:`rattail:rattail.db.model.User` instance
corresponding to the "late login" form data (if any), or ``None``.
"""
if self.request.method == 'POST':
uuid = self.request.POST.get('late-login-user')
if uuid:
return Session.get(model.User, uuid)
[docs]
def user_is_protected(self, user):
"""
This logic will consult the settings for a list of "protected"
usernames, which should require root privileges to edit. If the given
``user`` object is represented in this list, it is considered to be
protected and this method will return ``True``; otherwise it returns
``False``.
"""
if not hasattr(self, 'protected_usernames'):
self.protected_usernames = protected_usernames(self.rattail_config)
if self.protected_usernames and user.username in self.protected_usernames:
return True
return False
[docs]
def redirect(self, url, **kwargs):
"""
Convenience method to return a HTTP 302 response.
"""
return httpexceptions.HTTPFound(location=url, **kwargs)
def progress_loop(self, func, items, factory, *args, **kwargs):
return progress_loop(func, items, factory, *args, **kwargs)
[docs]
def make_progress(self, key, **kwargs):
"""
Create and return a :class:`tailbone.progress.SessionProgress`
instance, with the given key.
"""
return SessionProgress(self.request, key, **kwargs)
# TODO: this signature seems wonky
[docs]
def render_progress(self, progress, kwargs, template=None):
"""
Render the progress page, with given kwargs as context.
"""
if not template:
template = '/progress.mako'
kwargs['progress'] = progress
kwargs.setdefault('can_cancel', True)
return render_to_response(template, kwargs, request=self.request)
[docs]
def json_response(self, data):
"""
Convenience method to return a JSON response.
"""
return render_to_response('json', data,
request=self.request)
[docs]
def file_response(self, path, filename=None, attachment=True):
"""
Returns a generic FileResponse from the given path
"""
if not os.path.exists(path):
return self.notfound()
response = FileResponse(path, request=self.request)
response.content_length = os.path.getsize(path)
if attachment:
if not filename:
filename = os.path.basename(path)
response.content_disposition = str('attachment; filename="{}"'.format(filename))
return response
def should_expose_quickie_search(self):
return self.expose_quickie_search
def get_quickie_context(self):
return Object(
url=self.get_quickie_url(),
perm=self.get_quickie_perm(),
placeholder=self.get_quickie_placeholder())
def get_quickie_url(self):
raise NotImplementedError
def get_quickie_perm(self):
raise NotImplementedError
def get_quickie_placeholder(self):
pass