keithsalisbury-subtrac 0.1.4 → 0.1.5

data/lib/subtrac/trac-plugins/worklogplugin/worklog/usermanual.py

@@ -1,29 +0,0 @@
-user_manual_title = "Work Log Plugin User Manual"
-user_manual_version = 3
-user_manual_wiki_title = "WorkLogPluginUserManual"
-user_manual_content = """
-= !WorkLog Plugin User Manual =
-This is a plugin that adds a Work Log capability to Trac.
-
-Basically, it allows you to register the fact you have started work on a ticket which effectively allows you to clock on and clock off.
-
-== General stuff ==
-The !WorkLog Plugin uses javascript to add a button to the ticket page to allow you to start/stop working on a given ticket.
-
-If the [http://trac-hacks.org/wiki/TimingAndEstimationPlugin TimingAndEstimationPlugin] is installed then when you clock off, the time spent on the ticket will be recorded - but only if you explicitly enabled this on the [/admin/ticket/worklog plugins admin page].
-
-If you visit the Work Log page (a new navigation entry), you will see a list of people (developers) and which tickets they are currently working on. Work log events are also logged to the Timeline for a historical view. 
-
-In the future it will also provide an extension to the XMLRPC plugin which allows the integration with Desktop applications which will make interaction with this plugin seemless.
-
-== Configuration ==
-Configuration can be done on the plugins [/admin/ticket/worklog admin page] - or directly in the `trac.ini`. The following options are available:
-
-||'''Option'''||'''`trac.ini`'''||'''description'''||
-||Record time via Timing and Estimation Plugin?||timingandestimation = True|__False__||Whether to update the corresponding fields of the Timing and Estimation Plugin. By default, this is disabled. And of course, enabling this would require the [http://trac-hacks.org/wiki/TimingAndEstimationPlugin Timing and Estimation Plugin] to be installed and enabled.||
-||Automatically add a comment when you stop work on a ticket?||comment = True|__False__||As it says: This will automatically add a comment even if you provide none.||
-||Stop work automatically if ticket is closed?||autostop = True|__False__||Usually, you explicitly have to stop work on a ticket. But it's quite handy to do this automatically when closing the ticket (usually, you stop work then). But sometimes you just want to declare e.g. a bug fixed by closing the ticket, while stop working only after having documented your changes somewhere else - so it's up to you how it should be done.||
-||Automatically reassign and accept (if necessary) when starting work?||autoreassignaccept = True|__False__||May ease the take-over of a ticket||
-||Allow users to start working on a different ticket (i.e. automatically stop working on current ticket)?||autostopstart = True|__False__||If you switch to a new ticket, you usually stop working on the first one. So this saves you from doing so manually.||
-||Round up to nearest minute||roundup = <n>||By default, time is rounded up to the full minute. If you want to round up to the next 15min interval, put a 15 here. To only have full hours logged, chose 60. But keep in mind, that a work of 1 minute will always be rounded up to the value defined here - so if rounding up to the full hour, a work of 1 minute will be recorded as 1 hour. Handy to increase your payment ;)||
-"""

data/lib/subtrac/trac-plugins/worklogplugin/worklog/util.py

@@ -1,31 +0,0 @@
-from datetime import datetime
-
-# Stolen from Trac trunk :)
-def pretty_timedelta(time1, time2=None):
-    """Calculate time delta (inaccurately, only for decorative purposes ;-) for
-    prettyprinting. If time1 is None, the current time is used."""
-    if not time1: time1 = datetime.now()
-    if not time2: time2 = datetime.now()
-    if time1 > time2:
-        time2, time1 = time1, time2
-    units = ((3600 * 24 * 365, 'year',   'years'),
-             (3600 * 24 * 30,  'month',  'months'),
-             (3600 * 24 * 7,   'week',   'weeks'),
-             (3600 * 24,       'day',    'days'),
-             (3600,            'hour',   'hours'),
-             (60,              'minute', 'minutes'))
-    diff = time2 - time1
-    age_s = int(diff.days * 86400 + diff.seconds)
-    if age_s < 60:
-        return 'less than a minute'
-    rv = ''
-    for u, unit, unit_plural in units:
-        r = int(float(age_s) / float(u))
-        if r > 0:
-            tmp_rv = '%d %s' % (r, r == 1 and unit or unit_plural)
-            if rv:
-                rv += ', '
-            rv += tmp_rv
-        age_s = float(age_s) - (r * float(u)) 
-    return rv
-

data/lib/subtrac/trac-plugins/worklogplugin/worklog/webadminui.py

@@ -1,47 +0,0 @@
-import time
-
-from trac import ticket
-from trac import util
-from trac.core import *
-from trac.perm import IPermissionRequestor, PermissionSystem
-from trac.util import Markup
-from trac.ticket.admin import TicketAdminPanel
-
-
-class WorklogAdminPanel(TicketAdminPanel):
-    _type = 'worklog'
-    _label = ('Work Log', 'Work Log')
-
-    def _render_admin_panel(self, req, cat, page, component):
-        req.perm.require('TICKET_ADMIN') and req.perm.require('WORK_ADMIN') 
-
-        bools = [ "timingandestimation", "comment",
-                  "autostop", "autostopstart", "autoreassignaccept" ]
-        
-        if req.method == 'POST' and req.args.has_key('update'):
-            for yesno in bools:
-                if req.args.has_key(yesno):
-                    self.config.set(self._type, yesno, True)
-                else:
-                    self.config.set(self._type, yesno, False)
-                roundup = 1
-                if req.args.has_key('roundup'):
-                    try:
-                        if int(req.args.get('roundup')) > 0:
-                            roundup = int(req.args.get('roundup'))
-                    except:
-                        pass
-                self.config.set(self._type, 'roundup', roundup)
-                
-            self.config.save()
-
-        settings = {}
-        for yesno in bools:
-            if self.config.getbool(self._type, yesno):
-                settings[yesno] = 'checked'
-
-        if self.config.getint(self._type, 'roundup'):
-            settings['roundup'] = self.config.getint(self._type, 'roundup')
-        
-        settings['view'] = 'settings'
-        return 'worklog_webadminui.html', settings

data/lib/subtrac/trac-plugins/worklogplugin/worklog/webui.py

@@ -1,174 +0,0 @@
-import re
-from util import *
-from time import time
-from datetime import tzinfo, timedelta, datetime
-from usermanual import *
-from manager import WorkLogManager
-from trac.log import logger_factory
-from trac.core import *
-from trac.perm import IPermissionRequestor
-from trac.web import IRequestHandler, IRequestFilter
-from trac.util.datefmt import format_date, format_time
-from trac.util import Markup
-from trac.ticket import Ticket
-from trac.web.chrome import add_stylesheet, add_script, \
-     INavigationContributor, ITemplateProvider
-from trac.web.href import Href
-from trac.wiki.formatter import wiki_to_html
-from trac.util.text import CRLF
-
-class WorkLogPage(Component):
-    implements(IPermissionRequestor, INavigationContributor, IRequestHandler, ITemplateProvider)
-
-    def __init__(self):
-        pass
-
-    # 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/plain')
-      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=','
-      req.write(sep.join(fields) + CRLF)
-
-      # Rows
-      for row in log:
-        first = True
-        for field in fields:
-          if not first:
-            req.write(sep)
-          first = False
-          req.write(str(row[field])
-                    .replace(sep, '_').replace('\\', '\\\\')
-                    .replace('\n', '\\n').replace('\r', '\\r'))
-        req.write(CRLF)
-    
-    # IRequestHandler methods
-    def match_request(self, req):
-        if re.search('^/worklog', req.path_info):
-            return True
-        return None
-
-    def process_request(self, req):
-        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 req.args.has_key('format') 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 req.args.has_key('format') 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 req.args.has_key('startwork') and req.args.has_key('ticket'):
-                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 req.args.has_key('stopwork'):
-                stoptime = None
-                if req.args.has_key('stoptime') and req.args['stoptime']:
-                    stoptime = int(req.args['stoptime'])
-
-                comment = ''
-                if req.args.has_key('comment'):
-                    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
-    def get_htdocs_dirs(self):
-        """Return the absolute path of a directory containing additional
-        static resources (such as images, style sheets, etc).
-        """
-        from pkg_resources import resource_filename
-        return [('worklog', resource_filename(__name__, 'htdocs'))]
-
-    def get_templates_dirs(self):
-        """Return the absolute path of the directory containing the provided
-        ClearSilver templates.
-        """
-        from pkg_resources import resource_filename
-        return [resource_filename(__name__, 'templates')]
-    

data/lib/subtrac/trac-plugins/worklogplugin/worklog/xmlrpc.py

@@ -1,73 +0,0 @@
-import xmlrpclib
-import posixpath
-
-from manager import WorkLogManager
-
-from trac.core import *
-from trac.perm import IPermissionRequestor
-from tracrpc.api import IXMLRPCHandler, expose_rpc
-
-class WorlLogRPC(Component):
-    """ Interface to the [http://trac-hacks.org/wiki/WorkLogPlugin Work Log Plugin] """
-    implements(IXMLRPCHandler)
-
-    def __init__(self):
-        pass
-
-    def xmlrpc_namespace(self):
-        return 'worklog'
-
-    def xmlrpc_methods(self):
-        yield ('WIKI_VIEW', ((int,),), self.getRPCVersionSupported)
-        yield ('WIKI_VIEW', ((str, int),), self.startWork)
-        yield ('WIKI_VIEW', ((str,), (str, str), (str, str, int),), self.stopWork)
-        yield ('WIKI_VIEW', ((dict,), (dict, str),), self.getLatestTask)
-        yield ('WIKI_VIEW', ((dict,), (dict, str),), self.getActiveTask)
-        yield ('WIKI_VIEW', ((str, int,),), self.whoIsWorkingOn)
-        yield ('WIKI_VIEW', ((str, int,),), self.whoLastWorkedOn)
-
-    def getRPCVersionSupported(self, req):
-        """ Returns 1 with this version of the Work Log XMLRPC API. """
-        return 1
-
-    def startWork(self, req, ticket):
-        """ Start work on a ticket. Returns the string 'OK' on success or an explanation on error (requires authentication)"""
-        mgr = WorkLogManager(self.env, self.config, req.authname)
-        if mgr.start_work(ticket):
-            return 'OK'
-        return mgr.get_explanation()
-            
-    def stopWork(self, req, comment='', stoptime=None):
-        """ Stops work. Returns the string 'OK' on success or an explanation on error (requires authentication, stoptime is seconds since epoch) """
-        mgr = WorkLogManager(self.env, self.config, req.authname)
-        if mgr.stop_work(stoptime, comment):
-            return 'OK'
-        return mgr.get_explanation()
-
-    def getLatestTask(self, req, username=None):
-        """ Returns a structure representing the info about the latest task. """
-        if username:
-            mgr = WorkLogManager(self.env, self.config, username)
-        else:
-            mgr = WorkLogManager(self.env, self.config, req.authname)
-        return mgr.get_latest_task()
-        
-    def getActiveTask(self, req, username=None):
-        """ Returns a structure representing the info about the active task (identical to getLatestTask but does not return anything if the work has stopped). """
-        if username:
-            mgr = WorkLogManager(self.env, self.config, username)
-        else:
-            mgr = WorkLogManager(self.env, self.config, req.authname)
-        return mgr.get_active_task()
-        
-    def whoIsWorkingOn(self, req, ticket):
-        """ Returns the username of the person currently working on the given ticket """
-        mgr = WorkLogManager(self.env, self.config, req.authname)
-        (who, when) = mgr.who_is_working_on(ticket)
-        return who
-            
-    def whoLastWorkedOn(self, req, ticket):
-        """ Returns the username of the person last worked on the given ticket """
-        mgr = WorkLogManager(self.env, self.config, req.authname)
-        return mgr.who_last_worked_on(ticket)
-