source: tracformsplugin/trunk/tracforms/web_ui.py

# -*- coding: utf-8 -*-

import re
from pkg_resources import resource_filename

from trac.core import implements
from trac.resource import get_resource_description, \
                          get_resource_shortname, get_resource_url
from trac.search.api import ISearchSource, shorten_result
from trac.util.datefmt import to_datetime
from trac.util.html import html as tag
from trac.web.api import IRequestFilter, IRequestHandler
from trac.web.chrome import ITemplateProvider, add_ctxtnav, add_stylesheet

from api import FormDBUser, _, dgettext, tag_
from compat import json
from formdb import format_author
from model import Form
from util import parse_history, resource_from_page

tf_page_re = re.compile('/form(/\d+|$)')


class FormUI(FormDBUser):
    """Provides form views for reviewing and managing TracForm data.

    Extensions for the Trac web user interface display saved field values,
    metadata and history. TracSearch support for TracForms is included here
    and administrative actions to revert form changes are embedded as well.
    """

    implements(IRequestFilter, IRequestHandler, ISearchSource,
               ITemplateProvider)

    # IRequestFilter methods

    def pre_process_request(self, req, handler):
        return handler

    def post_process_request(self, req, template, data, content_type):
        env = self.env
        page = req.path_info
        realm, resource_id = resource_from_page(env, page)
        # break (recursive) search for form in forms realm
        if tf_page_re.match(page) is None and resource_id is not None:
            if page == '/wiki' or page == '/wiki/':
                page = '/wiki/WikiStart'
            form = Form(env, realm, resource_id)
            if 'FORM_VIEW' in req.perm(form.resource):
                if len(form.siblings) == 0:
                    # no form record found for this parent resource
                    return template, data, content_type
                elif form.resource.id is not None:
                    # single form record found
                    href = req.href.form(form.resource.id)
                else:
                    # multiple form records found
                    href = req.href.form(action='select', realm=realm,
                                         resource_id=resource_id)
                add_ctxtnav(req, _("Form details"), href=href,
                            title=_("Review form data"))
        elif page.startswith('/form') and not resource_id == '':
            form = Form(env, form_id=resource_id)
            parent = form.resource.parent
            if len(form.siblings) > 1:
                href = req.href.form(action='select', realm=parent.realm,
                                     resource_id=parent.id)
                add_ctxtnav(req, _("Back to forms list"), href=href)
        return template, data, content_type

    # ITemplateProvider methods

    def get_htdocs_dirs(self):
        """Return static resources for TracForms."""
        return [('tracforms', resource_filename(__name__, 'htdocs'))]

    def get_templates_dirs(self):
        """Return template directory for TracForms."""
        return [resource_filename(__name__, 'templates')]

    # IRequestHandler methods

    def match_request(self, req):
        if req.path_info == '/form':
            return True
        match = re.match('/form/(\d+)$', req.path_info)
        if match:
            if match.group(1):
                req.args['id'] = match.group(1)
            return True

    def process_request(self, req):
        env = self.env
        id_hint = req.args.get('id')
        if id_hint is not None and Form.id_is_valid(id_hint):
            form_id = int(id_hint)
        else:
            form_id = None
        if form_id is not None:
            form = Form(env, form_id=form_id)
            if req.method == 'POST':
                req.perm(form.resource).require('FORM_RESET')
                return self._do_reset(env, req, form)

            req.perm(form.resource).require('FORM_VIEW')
            return self._do_view(env, req, form)

        if req.args.get('action') == 'select':
            realm = req.args.get('realm')
            resource_id = req.args.get('resource_id')
            if realm is not None and resource_id is not None:
                form = Form(env, realm, resource_id)
                req.perm(form.resource).require('FORM_VIEW')
                return self._do_switch(env, req, form)

    def _do_view(self, env, req, form):
        data = {'_dgettext': dgettext}
        form_id = form.resource.id
        data['page_title'] = get_resource_description(env, form.resource,
                                                      href=req.href)
        data['title'] = get_resource_shortname(env, form.resource)
        # prime list with current state
        subcontext, author, time = self.get_tracform_meta(form_id)[3:6]
        author = format_author(self.env, req, author, 'change')
        if not subcontext == '':
            data['subcontext'] = subcontext
        state = self.get_tracform_state(form_id)
        data['fields'] = self._render_fields(req, form_id, state)
        history = [{'author': author, 'time': time,
                    'old_state': state}]
        # add recorded old_state
        records = self.get_tracform_history(form_id)
        for author, time, old_state in records:
            author = format_author(self.env, req, author, 'change')
            history.append({'author': author, 'time': time,
                            'old_state': old_state})
        data['history'] = parse_history(history)
        # show reset button in case of existing data and proper permission
        data['allow_reset'] = req.perm(form.resource) \
                                  .has_permission(
            'FORM_RESET') and form.has_data
        add_stylesheet(req, 'tracforms/tracforms.css')
        return 'form.html', data, None

    def _do_switch(self, env, req, form):
        data = {
            '_dgettext': dgettext,
            'page_title': get_resource_description(env, form.resource,
                                                   href=req.href),
            'title': get_resource_shortname(env, form.resource),
            'siblings': []
        }
        for sibling in form.siblings:
            form_id = tag.strong(tag.a(
                _("Form %(form_id)s", form_id=sibling[0]),
                href=req.href.form(sibling[0])))
            if sibling[1] == '':
                data['siblings'].append(form_id)
            else:
                # TRANSLATOR: Form list entry for form select page
                data['siblings'].append(tag_(
                    "%(form_id)s (subcontext = '%(subcontext)s')",
                    form_id=form_id, subcontext=sibling[1]))
        add_stylesheet(req, 'tracforms/tracforms.css')
        return 'switch.html', data, None

    def _do_reset(self, env, req, form):
        author = req.authname
        step = None
        if 'rewind' in req.args:
            step = -1
        elif 'reset' in req.args:
            step = 0
        if form.resource.id is not None:
            self.reset_tracform(form.resource.id, author=author, step=step)
        else:
            self.reset_tracform(tuple([form.parent.realm, form.parent.id]),
                                author=author, step=step)
        return self._do_view(env, req, form)

    def _render_fields(self, req, form_id, state):
        fields = json.loads(state is not None and state or '{}')
        rendered = []
        for name, value in fields.iteritems():
            if value == 'on':
                value = _("checked (checkbox)")
            elif value == '':
                value = _("empty (text field)")
            elif isinstance(value, basestring):
                value = "'".join(['', value, ''])
            else:
                # Still try to display something useful instead of corrupting
                #   parent page beyond hope of recovery through the web_ui.
                value = "'".join(['', repr(value), ''])
            author, time = self.get_tracform_fieldinfo(form_id, name)
            author = format_author(self.env, req, author, 'value')
            rendered.append(
                {'name': name, 'value': value,
                 'author': tag.span(tag(_("by %(author)s", author=author)),
                                    class_='author'),
                 'time': time})
        return rendered

    # ISearchSource methods

    def get_search_filters(self, req):
        if 'FORM_VIEW' in req.perm:
            # TRANSLATOR: The realm name used as TracSearch filter label
            yield ('form', _("Forms"))

    def get_search_results(self, req, terms, filters):
        if 'form' not in filters:
            return
        env = self.env
        results = self.search_tracforms(terms)

        for id_, realm, parent, subctxt, state, author, updated_on in results:
            # DEVEL: support for handling form revisions not implemented yet
            # form = Form(env, realm, parent, subctxt, id, version)
            form = Form(env, realm, parent, subctxt, id_)
            if 'FORM_VIEW' in req.perm(form.resource):
                form = form.resource
                # build a more human-readable form values representation,
                # especially with unicode character escapes removed
                state = _render_values(state)
                yield (get_resource_url(env, form, req.href),
                       get_resource_description(env, form),
                       to_datetime(updated_on), author,
                       shorten_result(state, terms))


def _render_values(state, delimiter=': '):
    fields = []
    for name, value in json.loads(state or '{}').iteritems():
        fields.append(''.join([name, delimiter, value]))
    return '; '.join(fields)