keithsalisbury-subtrac 0.1.1

data/lib/subtrac/trac-plugins/clientsplugin/clients/eventsadmin.py

@@ -0,0 +1,71 @@
+from trac.core import *
+from trac.perm import PermissionSystem
+#from trac.ticket.model import AbstractEnum
+#from trac.ticket.admin import AbstractEnumAdminPage
+from trac.ticket.admin import TicketAdminPanel
+
+
+from clients.events import ClientEvent, ClientEventsSystem
+
+from trac.util.datefmt import utc, parse_date, get_date_format_hint, \
+                              get_datetime_format_hint
+from trac.web.chrome import add_link, add_script
+
+
+class ClientEventsAdminPanel(TicketAdminPanel):
+    
+    _type = 'clientevents'
+    _label = ('Client Events', 'Client Events')
+
+    # TicketAdminPanel methods
+    def _render_admin_panel(self, req, cat, page, event):
+        # Detail view?
+        if event:
+            clev = ClientEvent(self.env, event)
+            if req.method == 'POST':
+                if req.args.get('save'):
+                    # Client Events are not saved... just deleted or viewed...
+                    for option in clev.summary_options:
+                      arg = 'summary-option-%s' % clev.summary_options[option]['md5']
+                      clev.summary_options[option]['value'] = req.args.get(arg)
+                    for option in clev.action_options:
+                      arg = 'action-option-%s' % clev.action_options[option]['md5']
+                      clev.action_options[option]['value'] = req.args.get(arg)
+                    clev.update_options()
+                    req.redirect(req.href.admin(cat, page))
+                elif req.args.get('cancel'):
+                    req.redirect(req.href.admin(cat, page))
+
+            add_script(req, 'common/js/wikitoolbar.js')
+            data = {'view': 'detail', 'event': clev}
+
+        else:
+            if req.method == 'POST':
+                # Add Client
+                if req.args.get('add') and req.args.get('name'):
+                    clev = ClientEvent(self.env)
+                    clev.name = req.args.get('name')
+                    clev.summary = req.args.get('summary')
+                    clev.action = req.args.get('action')
+                    clev.insert()
+                    req.redirect(req.href.admin(cat, page))
+
+                # Remove clients
+                elif req.args.get('remove') and req.args.get('sel'):
+                    sel = req.args.get('sel')
+                    sel = isinstance(sel, list) and sel or [sel]
+                    if not sel:
+                        raise TracError('No client event selected')
+                    db = self.env.get_db_cnx()
+                    for name in sel:
+                        clev = ClientEvent(self.env, name, db=db)
+                        clev.delete(db=db)
+                    db.commit()
+                    req.redirect(req.href.admin(cat, page))
+
+            data = {'view': 'list',
+                    'events': ClientEvent.select(self.env),
+                    'summaries': ClientEventsSystem(self.env).get_summaries(),
+                    'actions': ClientEventsSystem(self.env).get_actions()}
+
+        return 'admin_client_events.html', data

data/lib/subtrac/trac-plugins/clientsplugin/clients/htdocs/clients.css

@@ -0,0 +1,4 @@
+fieldset.client
+{
+  clear: both;
+}

data/lib/subtrac/trac-plugins/clientsplugin/clients/model.py

@@ -0,0 +1,135 @@
+import re
+import sys
+import time
+from datetime import date, datetime
+
+from trac.attachment import Attachment
+from trac.core import TracError
+from trac.ticket.api import TicketSystem
+from trac.util import sorted, embedded_numbers
+from trac.util.datefmt import utc, utcmax, to_timestamp
+
+__all__ = ['Client']
+
+def simplify_whitespace(name):
+    """Strip spaces and remove duplicate spaces within names"""
+    return ' '.join(name.split())
+
+class Client(object):
+
+    def __init__(self, env, name=None, db=None):
+        self.env = env
+        if name:
+            name = simplify_whitespace(name)
+        if name:
+            if not db:
+                db = self.env.get_db_cnx()
+            cursor = db.cursor()
+            cursor.execute("SELECT description,"
+                           "default_rate, currency "
+                           "FROM client "
+                           "WHERE name=%s", (name,))
+            row = cursor.fetchone()
+            if not row:
+                raise TracError('Client %s does not exist.' % name)
+            self.name = self._old_name = name
+            self.description = row[0] or ''
+            self.default_rate = row[1] or ''
+            self.currency = row[2] or ''
+        else:
+            self.name = self._old_name = None
+            self.description = None
+            self.default_rate = ''
+            self.currency = ''
+
+    exists = property(fget=lambda self: self._old_name is not None)
+
+    def delete(self, db=None):
+        assert self.exists, 'Cannot deleting non-existent client'
+        if not db:
+            db = self.env.get_db_cnx()
+            handle_ta = True
+        else:
+            handle_ta = False
+
+        cursor = db.cursor()
+        self.env.log.info('Deleting client %s' % self.name)
+        cursor.execute("DELETE FROM client WHERE name=%s", (self.name,))
+
+        self.name = self._old_name = None
+
+        if handle_ta:
+            db.commit()
+
+    def insert(self, db=None):
+        assert not self.exists, 'Cannot insert existing client'
+        self.name = simplify_whitespace(self.name)
+        assert self.name, 'Cannot create client with no name'
+        if not db:
+            db = self.env.get_db_cnx()
+            handle_ta = True
+        else:
+            handle_ta = False
+
+        cursor = db.cursor()
+        self.env.log.debug("Creating new client '%s'" % self.name)
+        cursor.execute("INSERT INTO client (name, description,"
+                       " default_rate, currency) "
+                       "VALUES (%s,%s, %s,%s)",
+                       (self.name, self.description,
+                        self.default_rate, self.currency))
+
+        if handle_ta:
+            db.commit()
+
+    def update(self, db=None):
+        assert self.exists, 'Cannot update non-existent client'
+        self.name = simplify_whitespace(self.name)
+        assert self.name, 'Cannot update client with no name'
+        if not db:
+            db = self.env.get_db_cnx()
+            handle_ta = True
+        else:
+            handle_ta = False
+
+        cursor = db.cursor()
+        self.env.log.info('Updating client "%s"' % self.name)
+        cursor.execute("UPDATE client SET name=%s,description=%s,"
+                       " default_rate=%s, currency=%s "
+                       "WHERE name=%s",
+                       (self.name, self.description,
+                        self.default_rate, self.currency,
+                        self._old_name))
+        if self.name != self._old_name:
+            # Update tickets
+            cursor.execute("UPDATE ticket_custom SET value=%s "
+                           "WHERE name=%s AND value=%s",
+                           (self.name, 'client', self._old_name))
+            # Update event options
+            cursor.execute("UPDATE client_event_summary_options SET client=%s "
+                           "WHERE client=%s",
+                           (self.name, self._old_name))
+            cursor.execute("UPDATE client_event_action_options SET client=%s "
+                           "WHERE client=%s",
+                           (self.name, self._old_name))
+            self._old_name = self.name
+
+        if handle_ta:
+            db.commit()
+
+    def select(cls, env, db=None):
+        if not db:
+            db = env.get_db_cnx()
+        cursor = db.cursor()
+        cursor.execute("SELECT name,description,"
+                       " default_rate, currency "
+                       "FROM client "
+                       "ORDER BY name")
+        for name, description, default_rate, currency in cursor:
+            client = cls(env)
+            client.name = client._old_name = name
+            client.description = description or ''
+            client.default_rate = default_rate or ''
+            client.currency = currency or ''
+            yield client
+    select = classmethod(select)

data/lib/subtrac/trac-plugins/clientsplugin/clients/processor.py

@@ -0,0 +1,70 @@
+from trac.core import *
+from trac.wiki.api import IWikiMacroProvider, WikiSystem, parse_args
+from trac.wiki import wiki_to_html
+from trac.wiki.macros import WikiMacroBase
+from trac.env import IEnvironmentSetupParticipant
+from trac.wiki.parser import WikiParser
+from StringIO import StringIO
+
+class ClientWikiProcessor(Component):
+  implements(IWikiMacroProvider)
+    
+  def __init__(self):
+    pass
+  
+  def get_macros(self):
+    return ['client']
+  
+  def get_macro_description(self, name):
+    return 'No real formatting but allows for easy extraction of specific text blocks designed to be displayed to the client'
+  
+  def expand_macro(self, formatter, name, content):
+    return '<fieldset class="client"><legend>Comments to Client</legend>%s</fieldset>' % \
+           wiki_to_html(content, self.env, formatter.req)
+
+
+def extract_client_text(text, sep="----\n"):
+  buf = StringIO()
+  stack = 0
+  gotblock = False
+  realsep = ''
+  for line in text.splitlines():
+    if stack:
+      realsep = sep
+      if line.strip() == WikiParser.ENDBLOCK:
+        stack = stack - 1
+      if stack:
+        buf.write(line + "\n")
+        realsep = ''
+    if gotblock:
+      if line.strip() == '#!client':
+        stack = stack + 1
+        if stack == 1:
+          buf.write(realsep)
+      else:
+        gotblock = False
+    elif line.strip() ==  WikiParser.STARTBLOCK:
+      gotblock = True
+  return buf.getvalue() 
+
+class TestProcessor(Component):
+  implements(IWikiMacroProvider)
+    
+  def __init__(self):
+    pass
+  
+  def get_macros(self):
+    return ['clientx']
+  
+  def get_macro_description(self, name):
+    return 'Just a test'
+  
+  def expand_macro(self, formatter, name, content):
+    db = self.env.get_db_cnx()
+    cursor = db.cursor()
+    cursor.execute("SELECT text FROM wiki WHERE name=%s ORDER BY version DESC LIMIT 1", ("WikiStart",))
+    try:
+      text = extract_client_text(cursor.fetchone()[0])
+      return wiki_to_html(text, self.env, formatter.req)
+    except:
+      return 'B0rken'

data/lib/subtrac/trac-plugins/clientsplugin/clients/reportmanager.py

@@ -0,0 +1,142 @@
+from trac.core import *
+
+
+class CustomReportManager:
+  """A Class to manage custom reports"""
+  version = 1
+  name = "custom_report_manager_version"
+  env = None
+  log = None
+  
+  def __init__(self, env, log):
+    self.env = env
+    self.log = log
+    self.upgrade()
+  
+  def upgrade(self):  
+    # Check to see what version we have
+    db = self.env.get_db_cnx()
+    cursor = db.cursor()
+    cursor.execute("SELECT value FROM system WHERE name=%s", (self.name,))
+    try:
+      version = int(cursor.fetchone()[0])
+    except:
+      version = 0
+      cursor.execute("INSERT INTO system (name,value) VALUES(%s,%s)",
+                     (self.name, version))
+        
+    if version > self.version:
+      raise TracError("Fatal Error: You appear to be running two plugins with conflicting versions "
+                      "of the CustomReportManager class. Please ensure that '%s' is updated to "
+                      "version %s of the file reportmanager.py (currently using version %s)."
+                      % (__name__, str(version), str(self.version)))
+    
+    # Do the staged updates
+    try:
+      if version < 1:
+        cursor.execute("CREATE TABLE custom_report ("
+                       "id         INTEGER,"
+                       "uuid       VARCHAR(64),"
+                       "maingroup  VARCHAR(255),"
+                       "subgroup   VARCHAR(255),"
+                       "version    INTEGER,"
+                       "ordering   INTEGER)")
+      
+      #if version < 2:
+      #  cursor.execute("...")
+    
+      # Updates complete, set the version
+      cursor.execute("UPDATE system SET value=%s WHERE name=%s", 
+                     (self.version, self.name))
+      db.commit()
+      db.close()
+    
+    except Exception, e:
+      self.log.error("CustomReportManager Exception: %s" % (e,));
+      db.rollback()
+  
+  def add_report(self, title, author, description, query, uuid, version, maingroup, subgroup=""):
+    # First check to see if we can load an existing version of this report
+    db = self.env.get_db_cnx()
+    cursor = db.cursor()
+    try:
+      cursor.execute("SELECT id, version FROM custom_report "
+                     "WHERE uuid=%s", (uuid,))
+      (id, currentversion) = cursor.fetchone()          
+    except:
+      id = None
+      currentversion = 0
+    
+    try:
+      if not id:
+        cursor.execute("SELECT MAX(id) FROM report")
+        next_id = int(cursor.fetchone()[0]) + 1
+        self.log.debug("Inserting new report with uuid '%s'" % (uuid,));
+
+        # Get the ordering of any current reports in this group/subgroup.
+        try:
+          cursor.execute("SELECT MAX(ordering) FROM custom_report "
+                         "WHERE maingroup=%s AND subgroup=%s", (maingroup, subgroup))
+          ordering = int(cursor.fetchone()[0]) + 1
+        except:
+          ordering = 0
+        
+        cursor.execute("INSERT INTO report (id, title, author, description, query) "
+                       "VALUES (%s, %s, %s, %s, %s)",
+                       (next_id, title, author, description, query))
+        cursor.execute("INSERT INTO custom_report (id, uuid, maingroup, subgroup, version, ordering) "
+                       "VALUES (%s, %s, %s, %s, %s, %s)",
+                       (next_id, uuid, maingroup, subgroup, version, ordering))
+        db.commit()
+        db.close()
+        return True
+      if currentversion < version:
+        self.log.debug("Updating report with uuid '%s' to version %s" % (uuid,version));
+        cursor.execute("UPDATE report SET title=%s, author=%s, description=%s, query=%s "
+                       "WHERE id=%s", (title, author, description, query, id))
+        cursor.execute("UPDATE custom_report SET version=%s, maingroup=%s, subgroup=%s "
+                       "WHERE id=%s", (version, maingroup, subgroup, id))
+        db.commit()
+        db.close()
+        return True
+    except Exception, e:
+      self.log.error("CustomReportManager Exception: %s" % (e,));
+      db.rollback()
+    
+    return False
+  
+  def get_report_by_uuid(self, uuid):
+    db = self.env.get_db_cnx()
+    cursor = db.cursor()
+    rv = None
+    try:
+      cursor.execute("SELECT report.id,report.title FROM custom_report "
+                     "LEFT JOIN report ON custom_report.id=report.id "
+                     "WHERE custom_report.uuid=%s", (uuid,))
+      row = cursor.fetchone()
+      rv = (row[0], row[1])
+    except:
+      pass
+    
+    return rv
+  
+  def get_reports_by_group(self, group):
+    db = self.env.get_db_cnx()
+    cursor = db.cursor()
+    rv = {}
+    try:
+      cursor.execute("SELECT custom_report.subgroup,report.id,report.title "
+                     "FROM custom_report "
+                     "LEFT JOIN report ON custom_report.id=report.id "
+                     "WHERE custom_report.maingroup=%s "
+                     "ORDER BY custom_report.subgroup,custom_report.ordering", (group,))
+      for subgroup,id,title in cursor:
+        if not rv.has_key(subgroup):
+          rv[subgroup] = { "title": subgroup,
+                           "reports": [] }
+        rv[subgroup]["reports"].append( { "id": int(id), "title": title } )
+    except:
+      pass
+    
+    return rv
+

data/lib/subtrac/trac-plugins/clientsplugin/clients/reports.py

@@ -0,0 +1,231 @@
+# IF YOU ADD A NEW SECTION OF REPORTS, You will need to make
+# sure that section is also added to the reports hashtable
+# near the bottom
+
+# Please try to keep this clean
+
+billing_reports = [{
+    'uuid':        'cd175fb0-0c74-48e4-816f-d72b4ba98fc1',
+    'title':       'Client Work Summary',
+    'description': '',
+    'version':     1,
+    'sql':         """
+SELECT 
+  __group__, __style__,  ticket, summary, newvalue as Work_added,
+  time, _ord
+FROM(
+  SELECT '' as __style__, t.id as ticket,
+    SUM(CAST(newvalue as DECIMAL)) as newvalue, t.summary as summary,
+    MAX(ticket_change.time) as time, client.value as __group__, 0 as _ord
+  FROM ticket_change
+  JOIN ticket t on t.id = ticket_change.ticket
+  LEFT JOIN ticket_custom as billable on billable.ticket = t.id 
+    and billable.name = 'billable'
+  LEFT JOIN ticket_custom as client on client.ticket = t.id
+    and client.name = 'client'
+  WHERE field = 'hours' and
+    t.status IN ($NEW, $ASSIGNED, $REOPENED, $CLOSED) 
+      AND billable.value in ($BILLABLE, $UNBILLABLE)
+      AND ticket_change.time >= $STARTDATE
+      AND ticket_change.time < $ENDDATE
+  GROUP BY client.value, t.id, t.summary
+  
+  UNION 
+  
+  SELECT 'background-color:#DFE;' as __style__, NULL as ticket,
+    sum(CAST(newvalue as DECIMAL)) as newvalue, 'Total work done' as summary,
+    NULL as time, client.value as __group__, 1 as _ord
+  FROM ticket_change
+  JOIN ticket t on t.id = ticket_change.ticket
+  LEFT JOIN ticket_custom as billable on billable.ticket = t.id 
+    and billable.name = 'billable'
+  LEFT JOIN ticket_custom as client on client.ticket = t.id
+    and client.name = 'client'
+  WHERE field = 'hours' and
+    t.status IN ($NEW, $ASSIGNED, $REOPENED, $CLOSED) 
+      AND billable.value in ($BILLABLE, $UNBILLABLE)
+      AND ticket_change.time >= $STARTDATE
+      AND ticket_change.time < $ENDDATE
+  GROUP By client.value
+)  as tbl
+ORDER BY __group__,  _ord ASC, ticket, time
+    """
+    }]
+
+ticket_hours_reports = [{
+    'uuid':        'e2ab8124-9309-4d1c-9cec-f8c7b11bf579',
+    'title':       'Ticket Hours Grouped By Client',
+    'description': '',
+    'version':     1,
+    'sql':         """
+SELECT __color__, __group__, __style__, ticket, summary, __component__ ,version,
+  severity, milestone, status, owner, estimate_work, total_work, billable,
+  _ord
+
+FROM (
+SELECT p.value AS __color__,
+       client.value AS __group__,
+       '' as __style__,
+       t.id AS ticket, summary AS summary,             -- ## Break line here
+       component as __component__,version, severity, milestone, status, owner,
+       CAST(estimatedhours.value as DECIMAL) as estimate_work,
+       CAST(totalhours.value as DECIMAL) as Total_work,
+       CASE WHEN billable.value = 1 THEN 'Y'
+            else 'N'
+       END as billable,
+       time AS created, changetime AS modified,         -- ## Dates are formatted
+       description AS _description_,                    -- ## Uses a full row
+       changetime AS _changetime,
+       reporter AS _reporter
+       ,0 as _ord                                        
+	
+  FROM ticket as t
+  JOIN enum as p ON p.name=t.priority AND p.type='priority'
+  
+LEFT JOIN ticket_custom as estimatedhours ON estimatedhours.name='estimatedhours'
+      AND estimatedhours.ticket = t.id
+LEFT JOIN ticket_custom as totalhours ON totalhours.name='totalhours'
+      AND totalhours.ticket = t.id
+LEFT JOIN ticket_custom as billable ON billable.name='billable'
+      AND billable.ticket = t.id
+LEFT JOIN ticket_custom as client ON client.name='client'
+      AND client.ticket = t.id
+
+  WHERE t.status IN ($NEW, $ASSIGNED, $REOPENED, $CLOSED) 
+    AND billable.value in ($BILLABLE, $UNBILLABLE)
+  
+
+UNION 
+
+SELECT '1' AS __color__,
+       client.value AS __group__,
+       'background-color:#DFE;' as __style__,
+       NULL as ticket, 'Total work' AS summary,             
+       t.component as __component__, NULL as version, NULL as severity,
+       NULL as  milestone, NULL as status,
+       NULL as owner,
+       SUM(CAST(estimatedhours.value as DECIMAL)) as estimate_work,
+       SUM(CAST(totalhours.value as DECIMAL)) as Total_work,
+       NULL as billable,
+       NULL as created,
+       NULL as modified,         -- ## Dates are formatted
+
+       NULL AS _description_,
+       NULL AS _changetime,
+       NULL AS _reporter
+       ,1 as _ord
+  FROM ticket as t
+  JOIN enum as p ON p.name=t.priority AND p.type='priority'
+  
+LEFT JOIN ticket_custom as estimatedhours ON estimatedhours.name='estimatedhours'
+      AND estimatedhours.ticket = t.id
+
+LEFT JOIN ticket_custom as totalhours ON totalhours.name='totalhours'
+      AND totalhours.ticket = t.id
+
+LEFT JOIN ticket_custom as billable ON billable.name='billable'
+      AND billable.ticket = t.id
+  
+LEFT JOIN ticket_custom as client ON client.name='client'
+      AND client.ticket = t.id
+  
+  WHERE t.status IN ($NEW, $ASSIGNED, $REOPENED, $CLOSED) 
+    AND billable.value in ($BILLABLE, $UNBILLABLE)
+  GROUP BY client.value
+)  as tbl
+ORDER BY __group__, _ord ASC,ticket
+    """
+    },{
+    'uuid':        '9194d297-bd5a-4225-a28c-e981525b20e1',
+    'title':       'Ticket Hours Grouped By Client with Description',
+    'description': '',
+    'version':     1,
+    'sql':         """
+SELECT __color__, __group__, __style__, ticket, summary, __component__ ,version,
+  severity, milestone, status, owner, estimate_work, total_work, billable,
+  _description_, _ord
+
+FROM (
+SELECT p.value AS __color__,
+       client.value AS __group__,
+       '' as __style__,
+       t.id AS ticket, summary AS summary,             -- ## Break line here
+       component as __component__,version, severity, milestone, status, owner,
+       CAST(estimatedhours.value as DECIMAL) as estimate_work,
+       CAST(totalhours.value as DECIMAL) as Total_work,
+       CASE WHEN billable.value = 1 THEN 'Y'
+            else 'N'
+       END as billable,
+       time AS created, changetime AS modified,         -- ## Dates are formatted
+       description AS _description_,                    -- ## Uses a full row
+       changetime AS _changetime,
+       reporter AS _reporter
+       ,0 as _ord                                        
+	
+  FROM ticket as t
+  JOIN enum as p ON p.name=t.priority AND p.type='priority'
+  
+LEFT JOIN ticket_custom as estimatedhours ON estimatedhours.name='estimatedhours'
+      AND estimatedhours.ticket = t.id
+LEFT JOIN ticket_custom as totalhours ON totalhours.name='totalhours'
+      AND totalhours.ticket = t.id
+LEFT JOIN ticket_custom as billable ON billable.name='billable'
+      AND billable.ticket = t.id
+LEFT JOIN ticket_custom as client ON client.name='client'
+      AND client.ticket = t.id
+
+  WHERE t.status IN ($NEW, $ASSIGNED, $REOPENED, $CLOSED) 
+    AND billable.value in ($BILLABLE, $UNBILLABLE)
+  
+
+UNION 
+
+SELECT '1' AS __color__,
+       client.value AS __group__,
+       'background-color:#DFE;' as __style__,
+       NULL as ticket, 'Total work' AS summary,             
+       t.component as __component__, NULL as version, NULL as severity,
+       NULL as  milestone, NULL as status,
+       NULL as owner,
+       SUM(CAST(estimatedhours.value as DECIMAL)) as estimate_work,
+       SUM(CAST(totalhours.value as DECIMAL)) as Total_work,
+       NULL as billable,
+       NULL as created,
+       NULL as modified,         -- ## Dates are formatted
+
+       NULL AS _description_,
+       NULL AS _changetime,
+       NULL AS _reporter
+       ,1 as _ord
+  FROM ticket as t
+  JOIN enum as p ON p.name=t.priority AND p.type='priority'
+  
+LEFT JOIN ticket_custom as estimatedhours ON estimatedhours.name='estimatedhours'
+      AND estimatedhours.ticket = t.id
+
+LEFT JOIN ticket_custom as totalhours ON totalhours.name='totalhours'
+      AND totalhours.ticket = t.id
+
+LEFT JOIN ticket_custom as billable ON billable.name='billable'
+      AND billable.ticket = t.id
+  
+LEFT JOIN ticket_custom as client ON client.name='client'
+      AND client.ticket = t.id
+  
+  WHERE t.status IN ($NEW, $ASSIGNED, $REOPENED, $CLOSED) 
+    AND billable.value in ($BILLABLE, $UNBILLABLE)
+  GROUP BY client.value
+)  as tbl
+ORDER BY __group__, _ord ASC,ticket
+    """
+    }]
+
+
+reports = [{
+    'title':   'Billing Reports',
+    'reports': billing_reports
+    },{
+    'title':   'Ticket/Hour Reports',
+    'reports': ticket_hours_reports
+    }]
+