keithsalisbury-subtrac 0.1.1

data/lib/subtrac/trac-plugins/timingandestimationplugin/timingandestimationplugin/ticket_daemon.py

@@ -0,0 +1,194 @@
+from trac.ticket import ITicketChangeListener, Ticket, ITicketManipulator
+from trac.perm import PermissionCache
+from trac.core import *
+import datetime
+
+def identity(x):
+    return x;
+
+try:
+    import trac.util.datefmt
+    to_timestamp = trac.util.datefmt.to_timestamp
+except Exception:
+    to_timestamp = identity
+
+
+def save_custom_field_value( db, ticket_id, field, value ):
+    cursor = db.cursor();
+    cursor.execute("SELECT * FROM ticket_custom " 
+                   "WHERE ticket=%s and name=%s", (ticket_id, field))
+    if cursor.fetchone():
+        cursor.execute("UPDATE ticket_custom SET value=%s "
+                       "WHERE ticket=%s AND name=%s",
+                       (value, ticket_id, field))
+    else:
+        cursor.execute("INSERT INTO ticket_custom (ticket,name, "
+                       "value) VALUES(%s,%s,%s)",
+                       (ticket_id, field, value))
+    db.commit()
+    
+DONTUPDATE = "DONTUPDATE"
+
+def save_ticket_change( db, ticket_id, author, change_time, field, oldvalue, newvalue, log, dontinsert=False):
+    """tries to save a ticket change, 
+ 
+       dontinsert means do not add the change if it didnt already exist 
+    """
+    if type(change_time) == datetime.datetime:
+        change_time = to_timestamp(change_time)
+    cursor = db.cursor();
+    sql = """SELECT * FROM ticket_change  
+             WHERE ticket=%s and author=%s and time=%s and field=%s""" 
+                   
+    cursor.execute(sql, (ticket_id, author, change_time, field))
+    if cursor.fetchone():
+        if oldvalue == DONTUPDATE:
+            cursor.execute("""UPDATE ticket_change  SET  newvalue=%s 
+                       WHERE ticket=%s and author=%s and time=%s and field=%s""",
+                           ( newvalue, ticket_id, author, change_time, field))
+
+        else:
+            cursor.execute("""UPDATE ticket_change  SET oldvalue=%s, newvalue=%s 
+                       WHERE ticket=%s and author=%s and time=%s and field=%s""",
+                           (oldvalue, newvalue, ticket_id, author, change_time, field))
+    else:
+        if oldvalue == DONTUPDATE:
+            oldvalue = '0'
+        if not dontinsert:
+            cursor.execute("""INSERT INTO ticket_change  (ticket,time,author,field, oldvalue, newvalue) 
+                        VALUES(%s, %s, %s, %s, %s, %s)""",
+                           (ticket_id, change_time, author, field, oldvalue, newvalue))
+    db.commit()
+
+def delete_ticket_change( comp, ticket_id, author, change_time, field):
+    """ removes a ticket change from the database """
+    db=comp.env.get_db_cnx()
+    cursor = db.cursor();
+    sql = """DELETE FROM ticket_change  
+             WHERE ticket=%s and author=%s and time=%s and field=%s""" 
+    cursor.execute(sql, (ticket_id, author, change_time, field))
+    db.commit()
+
+    
+    
+
+class TimeTrackingTicketObserver(Component):
+    implements(ITicketChangeListener)
+    def __init__(self):
+        pass
+
+    def watch_hours(self, ticket):
+        def readTicketValue(name, tipe, default=0):
+            if ticket.values.has_key(name):        
+                return tipe(ticket.values[name] or default)
+            else:
+                cursor = self.env.get_db_cnx().cursor()
+                cursor.execute("SELECT * FROM ticket_custom where ticket=%s and name=%s" , (ticket.id, name))
+                val = cursor.fetchone()
+                if val:
+                    return tipe(val[2] or default)
+                return default
+
+        #some european countries use , as the decimal separator
+        convertfloat = lambda x: float(str(x).replace(',','.'))
+        hours = readTicketValue("hours", convertfloat)
+        totalHours = readTicketValue("totalhours", convertfloat)
+
+        db = self.env.get_db_cnx()
+        ticket_id = ticket.id
+        cl = ticket.get_changelog()
+        
+        self.log.debug("found hours: "+str(hours ));
+        #self.log.debug("Dir_ticket:"+str(dir(ticket)))
+        #self.log.debug("ticket.values:"+str(ticket.values))
+        #self.log.debug("changelog:"+str(cl))
+    
+        most_recent_change = None
+        if cl:
+            most_recent_change = cl[-1];
+            change_time = most_recent_change[0]
+            author = most_recent_change[1]
+        else:
+            change_time = ticket.time_created
+            author = ticket.values["reporter"]
+
+        self.log.debug("Checking permissions")
+        perm = PermissionCache(self.env, author)
+        if not perm or not perm.has_permission("TIME_RECORD"):
+            self.log.debug("Skipping recording because no permission to affect time")
+            if hours != 0:
+                
+                tup = (ticket_id, author, change_time, "hours")
+                self.log.debug("deleting ticket change %s %s %s %s" % tup)
+                try:
+                    delete_ticket_change(self, ticket_id, author, change_time, "hours")
+                except Exception, e:
+                    self.log.debug("FAIL: %s" % e)
+                self.log.debug("hours change deleted")
+            return
+        self.log.debug("passed permissions check")
+
+        ## SAVE estimated hour
+        estimatedhours = readTicketValue("estimatedhours", convertfloat)        
+        self.log.debug("found Estimated hours:"+str(estimatedhours))
+        db = self.env.get_db_cnx()
+        save_ticket_change( db, ticket_id, author, change_time, "estimatedhours", DONTUPDATE, str(estimatedhours), self.log, True)
+        save_custom_field_value( db, ticket.id, "estimatedhours", str(estimatedhours))
+        db.commit();
+        #######################
+
+
+        ## If our hours changed 
+        if not hours == 0:                
+            newtotal = str(totalHours+hours)
+            save_ticket_change( db, ticket_id, author, change_time, "hours", '0.0', str(hours), self.log)
+            save_ticket_change( db, ticket_id, author, change_time, "totalhours", str(totalHours), str(newtotal), self.log)
+            save_custom_field_value( db, ticket_id, "hours", '0')
+            save_custom_field_value( db, ticket_id, "totalhours", str(newtotal) )            
+        ########################
+
+    # END of watch_hours
+
+    def ticket_created(self, ticket):
+        """Called when a ticket is created."""
+        self.watch_hours(ticket)
+                               
+
+    def ticket_changed(self, ticket, comment, author, old_values):
+        """Called when a ticket is modified.
+        
+        `old_values` is a dictionary containing the previous values of the
+        fields that have changed.
+        """
+        self.watch_hours(ticket)
+
+    def ticket_deleted(self, ticket):
+        """Called when a ticket is deleted."""
+
+class TimeTrackingTicketValidator(Component):
+    implements(ITicketManipulator)
+
+    def __init__(self):
+        pass
+
+    def prepare_ticket(req, ticket, fields, actions):
+        """not currently called"""
+
+    def validate_ticket(self, req, ticket):
+        """Validate a ticket after it's been populated from user input.
+
+        Must return a list of `(field, message)` tuples, one for each problem
+        detected. `field` can be `None` to indicate an overall problem with the
+        ticket. Therefore, a return value of `[]` means everything is OK."""
+        errors = []
+        #some european countries use , as the decimal separator
+        convertfloat = lambda x: float(str(x).replace(',','.'))
+        try:
+            convertfloat(ticket.values['hours'])
+        except ValueError:
+            errors.append(('Add Hours to Ticket', 'Value must be a number'))
+        try:
+            convertfloat(ticket.values['estimatedhours'])
+        except ValueError:
+            errors.append(('Estimated Number of Hours', 'Value must be a number'))
+        return errors

data/lib/subtrac/trac-plugins/timingandestimationplugin/timingandestimationplugin/ticket_policy.py

@@ -0,0 +1,62 @@
+from trac.core import *
+from trac.perm import PermissionCache, IPermissionRequestor, IPermissionGroupProvider, IPermissionPolicy, PermissionSystem
+from trac.ticket.model import Ticket
+from trac.config import IntOption, ListOption
+from trac.util.compat import set
+
+class InternalTicketsPolicy(Component):
+    """Hide internal tickets."""
+    implements(IPermissionPolicy)
+    group_providers = ExtensionPoint(IPermissionGroupProvider)
+
+    # IPermissionPolicy(Interface)
+    def check_permission(self, action, username, resource, perm):
+        self.log.debug("Internal: action:%s, user:%s, resource:%s, perm: %s" %
+                       ( action, username, resource, perm))
+        self.username = username
+        # Look up the resource parentage for a ticket.
+        while resource:
+            if resource.realm == 'ticket':
+                break
+            resource = resource.parent
+        if resource and resource.realm == 'ticket' and resource.id is not None:
+            rtn = self.check_ticket_access(perm, resource, username)
+            self.log.debug("Internal: RESULTS for %s: %s" % (action,rtn))
+            return rtn
+        return None
+
+    # Internal methods   
+    def _get_groups(self, user):
+        # Get initial subjects
+        groups = set([user])
+        for provider in self.group_providers:
+            for group in provider.get_permission_groups(user):
+                groups.add(group)
+        
+        perms = PermissionSystem(self.env).get_all_permissions()
+        repeat = True
+        while repeat:
+            repeat = False
+            for subject, action in perms:
+                if subject in groups and action.islower() and action not in groups:
+                    groups.add(action)
+                    repeat = True 
+        
+        return groups    
+
+    # Public methods
+    def check_ticket_access(self, perm, res, user):
+        """Return if this req is permitted access to the given ticket ID."""
+        try:
+            tkt = Ticket(self.env, res.id)
+        except TracError:
+            return None # Ticket doesn't exist
+        private_tkt = tkt['internal'] == '1'
+
+        if private_tkt:
+            # cant just check or we get in an infinite call loop
+            perm = PermissionCache(self.env, self.username, None, perm._cache)
+            groups = self._get_groups(user)
+            perm_or_group = self.config.get('ticket', 'internalgroup', 'TIME_ADMIN' )
+            return perm_or_group in groups or perm.has_permission(perm_or_group)
+        return None

data/lib/subtrac/trac-plugins/timingandestimationplugin/timingandestimationplugin/ticket_webui.py

@@ -0,0 +1,28 @@
+import re
+from trac.web.api import ITemplateStreamFilter
+from trac.log import logger_factory
+from trac.core import *
+from genshi.builder import tag
+from trac.web import IRequestHandler
+from trac.util import Markup
+from trac.web.href import Href
+from genshi.filters.transform import Transformer
+
+
+class TicketWebUiAddon(Component):
+    implements(ITemplateStreamFilter)
+    
+    def __init__(self):
+        pass
+
+    # ITemplateStreamFilter
+    def filter_stream(self, req, method, filename, stream, data):
+        self.log.debug("TicketWebUiAddon executing") 
+        if not filename == 'ticket.html':
+            self.log.debug("TicketWebUiAddon not the correct template")
+            return stream
+        stream = stream | Transformer('//div[@id="banner"]').before(
+            tag.script(type="text/javascript", 
+                       src=req.href.chrome("Billing", "ticket.js"))()
+            )
+        return stream

data/lib/subtrac/trac-plugins/timingandestimationplugin/timingandestimationplugin/usermanual.py

@@ -0,0 +1,127 @@
+user_manual_title = "Timing and Estimation Plugin User Manual"
+user_manual_version = 13
+user_manual_wiki_title = "TimingAndEstimationPluginUserManual"
+user_manual_content = """
+
+[[PageOutline]]
+= Timing and Estimation Plugin User Manual =
+[http://trac-hacks.org/wiki/TimingAndEstimationPlugin TimingAndEstimationPlugin on TracHacks] | [http://trac-hacks.org/report/9?COMPONENT=TimingAndEstimationPlugin Open Tickets] | [http://trac-hacks.org/newticket?component=TimingAndEstimationPlugin&owner=bobbysmith007 New Ticket]  | 
+[http://trac-hacks.org/browser/timingandestimationplugin/trunk Web Browsable Source Code]
+
+== Abstract Design Goal ==
+My goal in writing this plugin was to use as much of the existing structure as possible (therefore not needing to add extra structure that might make maintainability difficult).  The largest downside I have found to this is that there is no way to attach more permissions to anything.
+
+== Custom Ticket Fields ==
+In adhering to our design goal, rather than creating a new ticket interface, I create some custom fields and a small daemon to watch over them.  
+
+=== Fields: ===
+ * '''Hours to Add''' This field functions as a time tracker.  When you add hours to it , those hours get added to the total hours field.  The person  who made the change is there fore credited with the hours spent on it.
+ * '''Total Hours''' This field is the total number of hours that have been added to the project. This has been made uneditable by including javascript which replaces the input box with a span containing its value
+   * Reports might not agree with each other if this is manually edited (which is possible if you disable javascript).
+ * '''Is this billable?''' An extra flag on tickets so that they can be marked as billable / not billable.
+ * '''Estimated Hours''' a field that contains the estimated amount of work
+=== Future Fields ===
+ * '''Ticket Rate''' The ability to attach a cost per hour or total amount to an individual ticket
+
+== Billing / Management Page / Time Reports ==
+This page provide a small interface for querying the tickets and adding a bill date at the current time.  
+This interface mostly just gives you links that match the interface to open any of the give reports,
+providing it the correct set of input parameters
+
+The direct url is '/Billing'.
+
+=== No Permissions Branch ===
+The 'Management' button should be in the main title bar.  It is possible that if you are viewing at a low resolution, it was pushed off the edge of the screen.  Also if you are not logged in with report_view permissions, it will not show that button.
+
+=== Permissions Branch ===
+The 'Time Reports' button should be in the main title bar.  Whether or not you see this will be based on whether your user has TIME_VIEW permissions.
+
+
+
+
+=== Set Bill Date ===
+
+This button will add now as a bill date.  This is mostly to make it
+easier to select the last time you billed.  This would allow you to
+set a ticket as having been billed at a given time while others have
+not, and accurately get the correct billing information for all
+tickets.
+
+== Reports ==
+=== Report Types ===
+We provide a few different reports for querying different types of data:
+    * '''Billing Reports''' Currently the billing reports are the only time based reports, and are therefore useful for getting an estimate what tickets had times (and totals), and which developers spent their time where.
+       * Ticket Work Summary
+       * Milestone Work Summary
+       * Developer Work Summary
+    * '''Ticket/Hour Reports''' These reports are useful for reviewing estimates on a large scale or getting an idea of the project at large.  These reports currently ignore the time.
+       * Ticket Hours
+       * Ticket Hours with Description 
+       * Ticket Hours Grouped By Component
+       * Ticket Hours Grouped By Component with Description
+       * Ticket Hours Grouped By Milestone
+       * Ticket Hours Grouped By Milestone with Description
+=== Adding More Reports ===
+To add reports to the Management screen sections, you must run the following sql against your trac database
+Remember to fill in the @reportID of the report you want to insert, and to select the insert statement for the section of your choice.
+ * {{{INSERT INTO custom_report (id, uuid, maingroup, subgroup, version, ordering) VALUES (@reportID , @uuid, 'Timing and Estimation Plugin', 'Billing Reports', 1, 0);}}}
+ * {{{INSERT INTO custom_report (id, uuid, maingroup, subgroup, version, ordering) VALUES (@reportID , @uuid, 'Timing and Estimation Plugin', 'Ticket/Hour Reports', 1, 0);}}}
+
+''NB: @uuid is a globally uninque identifier created via a tool such as {{{uuidgen}}} on Linux or various [http://www.famkruithof.net/uuid/uuidgen online tools]. It is used in this plugin to provide programatic reference to specific reports such that they can be upgraded successfully on future revisions of the plugin''
+
+=== Removing a Report ===
+To remove reports from the Management page, run the following query. 
+Remember to fill in the @reportID of the report you want to modify.
+ * To remove for this version of the plugin (will be over written in future plugin upgrades)
+   * {{{UPDATE custom_report SET maingroup='x'||maingroup WHERE report = @reportID;}}}
+ * To remove permanently (wont be over written in future plugin upgrades)
+   * {{{UPDATE custom_report SET version=9999, maingroup='x'||maingroup WHERE report = @reportID;}}}
+''NB: The 'x' part is not important - you just need to make the column read something other than 'Timing and Estimation Plugin'.''
+
+=== TAKE NOTE ===
+ '''The reports can only be called from the Management Page. They will not work from the Trac View Tickets page. (Due to the custom variables that need values).'''
+
+== Permissions Branch ==
+Recently a branch of this plugin was sponsored by [http://www.obsidiansoft.com/ Obsidian Software] so that it would support per field permissions.  
+
+This is accomplished with Genshi 5 stream filters in trac 11.  This code draws from the [http://trac-hacks.org/wiki/BlackMagicTicketTweaksPlugin BlackMagicTicketTweaksPlugin]
+
+=== Configuration ===
+There is a new trac.ini configuration section which is filled in by default as follows.
+{{{
+#!ini
+[field settings] # per field permissions
+
+# a list of all the fields to apply permissions to
+fields = billable, totalhours, hours, estimatedhours
+
+# a bunch of:
+# field.permission = PERMISSION:consequence
+# where consequence is one of: hide, remove, disable
+#    hide - replaces with hidden input
+#    remove - removes element
+#    disable - removes input in favor of text
+billable.permission = TIME_VIEW:hide, TIME_RECORD:disable
+totalhours.permission = TIME_VIEW:remove, TIME_RECORD:disable
+hours.permission = TIME_RECORD:remove
+estimatedhours.permission = TIME_RECORD:disable
+}}}
+
+
+It also adds an "Internal" checkbox which allows you to set a ticket as internal.  For this policy to work correctly you need to add a line to the trac section of the config telling it which permission policies to use.  (The setup will attempt to put this line of configuration in place. )  The permission that looks at currently is 'TIME_ADMIN'.  To change that group set the internalgroup of the ticket section in the trac.ini as follows:
+
+{{{
+#!ini
+[ticket]
+internalgroup = TRAC_ADMIN
+
+[trac]
+permission_policies = InternalTicketsPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy
+}}}
+
+
+== Future Improvements ==
+ * [http://trac-hacks.org/wiki/TimingAndEstimationPlugin See tickets] at the [http://trac-hacks.org/wiki/TimingAndEstimationPlugin project trac]
+
+
+"""

data/lib/subtrac/trac-plugins/timingandestimationplugin/timingandestimationplugin/webui.py

@@ -0,0 +1,129 @@
+from pkg_resources import resource_filename
+import re
+import time
+import datetime
+import dbhelper
+from sets import Set
+from usermanual import *
+from trac.log import logger_factory
+from trac.core import *
+from trac.web import IRequestHandler
+from trac.perm import IPermissionRequestor
+from trac.util import Markup
+from trac.web.chrome import add_stylesheet, add_script, \
+     INavigationContributor, ITemplateProvider
+from trac.web.href import Href
+from reportmanager import CustomReportManager
+from statuses import get_statuses
+
+#get_statuses = api.get_statuses
+
+class TimingEstimationAndBillingPage(Component):
+    implements(IPermissionRequestor, INavigationContributor, IRequestHandler, ITemplateProvider)
+
+    def __init__(self):
+        pass
+
+    # IPermissionRequestor methods 
+    def get_permission_actions(self): 
+        return ["TIME_VIEW", "TIME_RECORD", ("TIME_ADMIN", ["TIME_RECORD", "TIME_VIEW"])] 
+
+    def set_bill_date(self, username="Timing and Estimation Plugin",  when=0):
+        now = time.time()
+        if not when:
+            when = now
+        when = int(when)
+        now = int(now)
+        dtwhen = datetime.datetime.fromtimestamp(when);
+        strwhen = "%s-%s-%s %#02d:%#02d:%#02d" % \
+                (dtwhen.year, dtwhen.month, dtwhen.day, dtwhen.hour,dtwhen.minute, dtwhen.second)
+        sql = """
+        INSERT INTO bill_date (time, set_when, str_value)
+        VALUES (%s, %s, %s)
+        """
+        dbhelper.execute_non_query(self, sql, when, now, strwhen)
+
+
+
+
+
+
+    # INavigationContributor methods
+    def get_active_navigation_item(self, req):
+        val = re.search('/Billing$', req.path_info)
+        if val and val.start() == 0:
+            return "Billing"
+        else:
+            return ""
+
+    def get_navigation_items(self, req):
+        url = req.href.Billing()
+        if req.perm.has_permission("TIME_VIEW"):
+            yield 'mainnav', "Billing", \
+                Markup('<a href="%s">%s</a>' % \
+                           (url , "Time Reports"))
+
+    # IRequestHandler methods
+    def set_request_billing_dates(self, data):
+        billing_dates = []
+        billing_time_sql = """
+        SELECT DISTINCT time as value, str_value as text
+        FROM bill_date
+        """
+        rs = dbhelper.get_result_set(self, billing_time_sql)
+        if rs:
+            for (value, text) in rs.rows:
+                billing_info = {'text':text , 'value':value}
+                billing_dates.extend([billing_info])
+        #self.log.debug("bill-dates: %s"%billing_dates)
+        data['billing_info']["billdates"] = billing_dates
+
+    def match_request(self, req):
+        val = re.search('/Billing$', req.path_info)
+        return val and val.start() == 0
+
+    def process_request(self, req):
+        messages = []
+        req.perm.require("TIME_VIEW")
+        def addMessage(s):
+            messages.extend([s]);
+
+        if req.method == 'POST':
+            req.perm.require("TIME_VIEW")
+            if req.args.has_key('setbillingtime'):
+                self.set_bill_date(req.authname)
+                addMessage("All tickets last bill date updated")
+
+        mgr = CustomReportManager(self.env, self.log)
+        data = {};
+        data["is_time_admin"] = req.perm.has_permission("TIME_ADMIN")
+        data["statuses"] = get_statuses(self)
+        data["reports"] = mgr.get_reports_by_group(CustomReportManager.TimingAndEstimationKey);
+        #self.log.debug("DEBUG got %s, %s" % (data["reports"], type(data["reports"])));
+        data["billing_info"] = {"messages":         messages,
+                                "href":             req.href.Billing(),
+                                "report_base_href": req.href.report(),
+                                "usermanual_href":  req.href.wiki(user_manual_wiki_title),
+                                "usermanual_title": user_manual_title }
+
+        self.set_request_billing_dates(data)
+
+        add_stylesheet(req, "Billing/billingplugin.css")
+        add_script(req, "Billing/linkifyer.js")
+        return 'billing.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).
+        """
+        return [('Billing', resource_filename(__name__, 'htdocs'))]
+
+    def get_templates_dirs(self):
+        """Return the absolute path of the directory containing the provided
+        genshi templates.
+        """
+        rtn = [resource_filename(__name__, 'templates')]
+        return rtn
+