source: worklogplugin/trunk/worklog/webui.py

# -*- coding: utf-8 -*-
#
# Copyright (c) 2007-2012 Colin Guthrie <trac@colin.guthr.ie>
# Copyright (c) 2011-2016 Ryan J Ollos <ryan.j.ollos@gmail.com>
# All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution.

import csv
import re
from StringIO import StringIO

from trac.core import *
from trac.perm import IPermissionRequestor
from trac.util import Markup
from trac.web import IRequestHandler
from trac.web.chrome import (
    INavigationContributor, ITemplateProvider, add_stylesheet
)

from manager import WorkLogManager
from usermanual import *


class WorkLogPage(Component):

    implements(IPermissionRequestor, INavigationContributor,
               IRequestHandler, ITemplateProvider)

    # IPermissionRequestor methods

    def get_permission_actions(self):
        return ['WORK_LOG', ('WORK_VIEW', ['WORK_LOG']),
                ('WORK_ADMIN', ['WORK_VIEW'])]

    # INavigationContributor methods

    def get_active_navigation_item(self, req):
        return 'worklog'

    def get_navigation_items(self, req):
        url = req.href.worklog()
        if req.perm.has_permission("WORK_VIEW"):
            yield 'mainnav', "worklog", \
                  Markup('<a href="%s">%s</a>'
                         % (url, "Work Log"))

    # Internal Methods

    def worklog_csv(self, req, log):
        req.send_header('Content-Type', 'text/csv;charset=utf-8')
        req.send_header('Content-Disposition', 'filename=worklog.csv')

        # Headers
        fields = ['user',
                  'name',
                  'starttime',
                  'endtime',
                  'ticket',
                  'summary',
                  'comment']
        sep = ','

        content = StringIO()
        writer = csv.writer(content, delimiter=sep, quoting=csv.QUOTE_MINIMAL)
        writer.writerow([unicode(c).encode('utf-8') for c in fields])

        # Rows
        for row in log:
            values = []
            for field in fields:
                values.append(unicode(row[field]).encode('utf-8'))
            writer.writerow(values)

        req.send_header('Content-Length', content.len)
        req.write(content.getvalue())

    # IRequestHandler methods

    def match_request(self, req):
        if re.search('^/worklog', req.path_info):
            return True
        return None

    def process_request(self, req):
        req.perm.require('WORK_VIEW')

        messages = []

        def addMessage(s):
            messages.extend([s])

        # General protection (not strictly needed if Trac behaves itself)
        if not re.search('/worklog', req.path_info):
            return None

        add_stylesheet(req, "worklog/worklogplugin.css")

        # Specific pages:
        match = re.search('/worklog/users/(.*)', req.path_info)
        if match:
            mgr = WorkLogManager(self.env, self.config, match.group(1))
            if 'format' in req.args and req.args['format'] == 'csv':
                self.worklog_csv(req, mgr.get_work_log('user'))
                return None

            data = {
                'worklog': mgr.get_work_log('user'),
                'ticket_href': req.href.ticket(),
                'usermanual_href': req.href.wiki(user_manual_wiki_title),
                'usermanual_title': user_manual_title
            }
            return 'worklog_user.html', data, None

        match = re.search('/worklog/stop/([0-9]+)', req.path_info)
        if match:
            ticket = match.group(1)
            data = {'worklog_href': req.href.worklog(),
                    'ticket_href':  req.href.ticket(ticket),
                    'ticket':       ticket,
                    'action':       'stop',
                    'label':        'Stop Work'}
            xhr = req.get_header('X-Requested-With') == 'XMLHttpRequest'
            if xhr:
                data['xhr'] = True
            return 'worklog_stop.html', data, None

        mgr = WorkLogManager(self.env, self.config, req.authname)
        if 'format' in req.args and req.args['format'] == 'csv':
            self.worklog_csv(req, mgr.get_work_log())
            return None

        # Not any specific page, so process POST actions here.
        if req.method == 'POST':
            if 'startwork' in req.args and 'ticket' in req.args:
                if not mgr.start_work(req.args['ticket']):
                    addMessage(mgr.get_explanation())
                else:
                    addMessage('You are now working on ticket #%s.'
                               % (req.args['ticket'],))

                req.redirect(req.args['source_url'])
                return None
            elif 'stopwork' in req.args:
                stoptime = None
                if 'stoptime' in req.args and req.args['stoptime']:
                    stoptime = int(req.args['stoptime'])

                comment = ''
                if 'comment' in req.args:
                    comment = req.args['comment']

                if not mgr.stop_work(stoptime, comment):
                    addMessage(mgr.get_explanation())
                else:
                    addMessage('You have stopped working.')

                req.redirect(req.args['source_url'])
                return None

        # no POST, so they're just wanting a list of the worklog entries
        data = {"messages": messages,
                "worklog": mgr.get_work_log('summary'),
                "worklog_href": req.href.worklog(),
                "ticket_href": req.href.ticket(),
                "usermanual_href": req.href.wiki(user_manual_wiki_title),
                "usermanual_title": user_manual_title
                }
        return 'worklog.html', data, None

    # ITemplateProvider methods

    def get_htdocs_dirs(self):
        from pkg_resources import resource_filename
        return [('worklog', resource_filename(__name__, 'htdocs'))]

    def get_templates_dirs(self):
        from pkg_resources import resource_filename
        return [resource_filename(__name__, 'templates')]