keithsalisbury-subtrac 0.1.1

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

@@ -0,0 +1,27 @@
+from lxml import etree
+from trac.core import *
+
+class IClientSummaryProvider(Interface):
+  """Extension point interface for components that define their own way
+  to summarise a given client.
+  """
+
+  def get_name():
+    """Return the name of the summary (for use in UI)
+    """
+
+  def get_description():
+    """Return the description of the summary (for use in UI)
+    """
+
+  def options(client=None):
+    """Return a series of tupoles defining the options
+    """
+
+  def init(event, client):
+    """Initialise the summary for a specific instance and client combo
+    """
+
+  def get_summary(req, fromdate = None, todate = None):
+    """Get the summary. This must return an etree object
+    """

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

@@ -0,0 +1,152 @@
+import re
+import os
+import sys
+import locale
+import time
+import codecs
+from datetime import datetime
+from optparse import OptionParser
+from StringIO import StringIO
+
+from trac.core import *
+from trac.env import open_environment
+from trac.util.datefmt import format_date, to_datetime
+from trac.wiki import wiki_to_html
+from genshi import escape
+
+from lxml import etree
+from clients.summary import IClientSummaryProvider
+from clients.processor import extract_client_text
+
+
+class ClientMilestoneSummary(Component):
+  implements(IClientSummaryProvider)
+
+  client = None
+  debug = False
+
+  def get_name(self):
+    return "Milestone Summary"
+
+  def get_description(self):
+    return "Provide a summary of all tickets within milestones that have completion dates set where at least one ticket for that client is not closed in that milestone"
+
+  def options(self, client=None):
+    return []
+
+  def init(self, event, client):
+    self.client = client
+    return True
+
+  def get_summary(self, req, fromdate = None, todate = None):
+    def myformat_date(dte):
+      if dte:
+        return format_date(dte, '%e %b %Y')
+      return 'No date set'
+    def myformat_hours(hrs):
+      from math import floor
+      if hrs:
+        hrs = float(hrs)
+        if 0 != hrs:
+          neg = False
+          if hrs < 0:
+            neg = True
+            hours *= -1
+          mins = floor((hrs - floor(hrs)) * 60)
+          str = ''
+          if neg:
+            str = '-'
+          if hrs:
+            str = "%s%sh" % (str, int(floor(hrs)))
+          if mins:
+            str = "%s %sm" % (str, int(mins))
+          return str;
+      return 'No estimate available'
+
+    client = self.client
+    xml = etree.Element('clientsplugin')
+
+    # Place basic client info here
+    xclient = etree.SubElement(xml, 'client')
+    etree.SubElement(xclient, 'name').text = client
+    if fromdate:
+      etree.SubElement(xclient, 'lastupdate').text = myformat_date(fromdate)
+
+    # Information about milestones
+    milestones = {}
+    xmilestones = etree.SubElement(xml, 'milestones')
+
+    db = self.env.get_db_cnx()
+    have_data = False
+    # Load in a summary of the client's tickets
+    sql = ("""\
+      SELECT t.id, t.summary, t.description, t.status, t.milestone,
+        m.due, m.completed, m.description AS mdesc,
+        tcust2.value AS estimatedhours
+      FROM ticket_custom AS tcust
+      INNER JOIN ticket AS t ON tcust.ticket=t.id
+      LEFT JOIN ticket_custom AS tcust2 ON t.id=tcust2.ticket AND tcust2.name='estimatedhours'
+      LEFT JOIN milestone m ON t.milestone=m.name
+      WHERE tcust.name = 'client'
+        AND tcust.value = %s
+        AND t.milestone IN (
+          SELECT DISTINCT st.milestone
+          FROM ticket_custom AS stcust
+          INNER JOIN ticket AS st ON stcust.ticket=st.id
+          INNER JOIN milestone AS sm ON st.milestone=sm.name
+          WHERE stcust.name = tcust.name
+          AND stcust.value = tcust.value
+          AND st.status != 'closed'
+          AND sm.due > 0)
+      """)
+    cur2 = db.cursor()
+    cur2.execute(sql, (client,))
+    xsummary = etree.SubElement(xml, 'summary')
+    for tid, summary, description, status, milestone, due, completed, mdescription, estimatedhours in cur2:
+      have_data = True
+      if milestone:
+        if not milestones.has_key(milestone):
+          xmilestone = etree.SubElement(xmilestones, 'milestone')
+          etree.SubElement(xmilestone, 'name').text = milestone
+          etree.SubElement(xmilestone, 'duetimestamp').text = str(due)
+          etree.SubElement(xmilestone, 'due').text = myformat_date(due)
+          if completed:
+            etree.SubElement(xmilestone, 'completed').text = myformat_date(completed)
+          if mdescription:
+            xmilestone.append(etree.XML('<description>%s</description>' % wiki_to_html(extract_client_text(mdescription), self.env, req)))
+          else:
+            etree.SubElement(xmilestone, 'description').text = ''
+          # Store for use
+          milestones[milestone] = { 'hours': 0, 'xml': xmilestone }
+
+        # Add hours to create a total.
+        if estimatedhours:
+          milestones[milestone]['hours'] += float(estimatedhours) 
+
+      self.env.log.debug("  Summarising ticket #%s" % tid)
+      ticket = etree.SubElement(xsummary, 'ticket')
+      etree.SubElement(ticket, 'id').text = str(tid)
+      etree.SubElement(ticket, 'summary').text = summary
+      ticket.append(etree.XML('<description>%s</description>' % wiki_to_html(extract_client_text(description), self.env, req)))
+      etree.SubElement(ticket, 'status').text = status
+      etree.SubElement(ticket, 'milestone').text = milestone
+      # For conveneince, put the date here too (keeps the XSLTs simpler)
+      etree.SubElement(ticket, 'due').text = myformat_date(due)
+      if estimatedhours:
+        etree.SubElement(ticket, 'estimatedhours').text = myformat_hours(estimatedhours)
+
+
+    # Put the total hours into the milestone info
+    for milestone in milestones:
+      etree.SubElement(milestones[milestone]['xml'], 'estimatedhours').text = myformat_hours(milestones[milestone]['hours'])
+
+    if self.debug:
+      file = open('/tmp/send-client-email.xml', 'w')
+      file.write(etree.tostring(xml, pretty_print=True))
+      file.close()
+      self.env.log.debug(" Wrote XML to /tmp/send-client-email.xml")
+
+    if not have_data:
+      return None
+
+    return xml

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

@@ -0,0 +1,160 @@
+import re
+import os
+import sys
+import locale
+import time
+import codecs
+from datetime import datetime
+from optparse import OptionParser
+from StringIO import StringIO
+
+from trac.core import *
+from trac.env import open_environment
+from trac.util.datefmt import format_date, to_datetime
+from trac.wiki import wiki_to_html
+from genshi import escape
+
+from lxml import etree
+from clients.summary import IClientSummaryProvider
+from clients.processor import extract_client_text
+
+
+class ClientTicketChanges(Component):
+  implements(IClientSummaryProvider)
+
+  client = None
+  debug = False
+
+  def get_name(self):
+    return "Ticket Change Summary"
+
+  def get_description(self):
+    return "Provide a summary of ticket changes since the last run"
+
+  def options(self, client=None):
+    return []
+
+  def init(self, event, client):
+    self.client = client
+    return True
+
+  def get_summary(self, req, fromdate = None, todate = None):
+    def myformat_date(dte):
+      if dte:
+        return format_date(dte, '%e %b %Y')
+      return 'No date set'
+    def myformat_hours(hrs):
+      from math import floor
+      if hrs:
+        hrs = float(hrs)
+        if 0 != hrs:
+          neg = False
+          if hrs < 0:
+            neg = True
+            hours *= -1
+          mins = floor((hrs - floor(hrs)) * 60)
+          str = ''
+          if neg:
+            str = '-'
+          if hrs:
+            str = "%s%sh" % (str, int(floor(hrs)))
+          if mins:
+            str = "%s %sm" % (str, int(mins))
+          return str;
+      return 'No estimate available'
+
+    client = self.client
+    xml = etree.Element('clientsplugin')
+
+    # Place basic client info here
+    xclient = etree.SubElement(xml, 'client')
+    etree.SubElement(xclient, 'name').text = client
+    if fromdate:
+      etree.SubElement(xclient, 'lastupdate').text = myformat_date(fromdate)
+
+    db = self.env.get_db_cnx()
+    have_data = False
+    # Load in any changes that have happend
+    sql = ("""\
+      SELECT t.id, t.summary, t.description, t.status, t.resolution, t.milestone, m.due,
+        tchng.field, tchng.oldvalue, tchng.newvalue
+      FROM ticket_custom tcust
+      INNER JOIN ticket AS t ON tcust.ticket=t.id
+      INNER JOIN ticket_change AS tchng ON t.id=tchng.ticket
+      LEFT JOIN milestone AS m ON t.milestone=m.name
+      WHERE tcust.name = 'client'
+        AND tcust.value = %s
+        AND tchng.field IN ('comment', 'status', 'resolution', 'milestone')
+        AND tchng.time >= %s
+        AND tchng.time < %s
+        AND t.milestone IN (
+          SELECT DISTINCT st.milestone
+          FROM ticket_custom AS stcust
+          INNER JOIN ticket AS st ON stcust.ticket=st.id
+          INNER JOIN milestone AS sm ON st.milestone=sm.name
+          WHERE stcust.name = tcust.name
+          AND stcust.value = tcust.value
+          AND sm.due > 0)
+      ORDER BY t.time
+      """)
+    cur2 = db.cursor()
+    cur2.execute(sql, (client, fromdate, todate))
+    changes = etree.SubElement(xml, 'changes')
+    lasttid = 0
+    for tid, summary, description, status, resolution, milestone, due, cgfield, oldvalue, newvalue in cur2:
+      text = ''
+      if 'status' == cgfield:
+        text = 'Status changed from "%s" to "%s"' % (oldvalue, newvalue)
+      elif 'milestone' == cgfield:
+        text = 'Milestone changed from "%s" to "%s" - please check for revised delivery date.' % (oldvalue, newvalue)
+      elif 'resolution' == cgfield:
+        if oldvalue and not newvalue:
+          text = 'Resolution removed'
+        elif not oldvalue and newvalue:
+          text = 'Resolution set to "%s"' % (newvalue)
+        else:
+          text = 'Resolution changed from "%s" to "%s"' % (oldvalue, newvalue)
+      elif 'comment' == cgfield:
+        # Todo - extract...
+        text = extract_client_text(newvalue).strip()
+        if '' == text:
+          # No comments for the client here so ignore it.
+          continue
+        text = "''Comment for your information:''[[BR]][[BR]]" + text
+      else:
+        # Client should not know any more than this
+        continue
+      
+      if self.debug:
+        self.env.log.debug("  Change notification (%s) for ticket #%s" % (cgfield, tid))
+      have_data = True
+      if lasttid != tid:
+        ticket = etree.SubElement(changes, 'ticket')
+        etree.SubElement(ticket, 'id').text = str(tid)
+        etree.SubElement(ticket, 'summary').text = summary
+        ticket.append(etree.XML('<description>%s</description>' % wiki_to_html(extract_client_text(description), self.env, req)))
+        etree.SubElement(ticket, 'status').text = status
+        etree.SubElement(ticket, 'resolution').text = resolution
+        etree.SubElement(ticket, 'milestone').text = milestone
+        etree.SubElement(ticket, 'due').text = myformat_date(due)
+        changelog = etree.SubElement(ticket, 'changelog')
+
+      detail = etree.XML('<detail>%s</detail>' % wiki_to_html(text, self.env, req))
+      detail.set('field', cgfield)
+      if oldvalue:
+        detail.set('oldvalue', oldvalue)
+      if newvalue:
+        detail.set('newvalue', newvalue)
+      changelog.append(detail)
+      lasttid = tid
+
+    if self.debug:
+      file = open('/tmp/send-client-email.xml', 'w')
+      file.write(etree.tostring(xml, pretty_print=True))
+      file.close()
+      self.env.log.debug(" Wrote XML to /tmp/send-client-email.xml")
+
+    if not have_data:
+      return None
+
+    return xml

data/lib/subtrac/trac-plugins/clientsplugin/clients/templates/admin_client_events.html

@@ -0,0 +1,124 @@
+<!DOCTYPE html
+    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      xmlns:py="http://genshi.edgewall.org/">
+  <xi:include href="admin.html" />
+  <head>
+    <title>Client Events</title>
+    <style type="text/css">
+      p.contextual { margin-top:0; margin-bottom:2em }
+    </style>
+  </head>
+
+  <body>
+    <h2>Manage Client Events</h2>
+
+    <py:choose test="view">
+      <form py:when="'detail'" class="mod" id="modclient" method="post">
+        <fieldset>
+          <legend>Event Overview:</legend>
+          <div class="field">
+            <label><b>Name:</b> $event.name</label>
+            <p class="help">Run this event using the <a href="http://trac-hacks.org/browser/clientsplugin/0.11/cron/run-client-event">run-client-event</a> script with the argument: -c &quot;$event.name&quot;</p>
+          </div>
+          <div class="field">
+            <label><b>Summary:</b> $event.summary</label>
+            <p class="help">$event.summary_description</p>
+          </div>
+          <div class="field">
+            <label><b>Action:</b> $event.action</label>
+            <p class="help">$event.action_description</p>
+          </div>
+          <div class="field">
+            <label><b>Last run:</b> ${pretty_timedelta(event.lastrun)} (${format_date(event.lastrun)} ${format_time(event.lastrun, str('%H:%M'))})</label>
+          </div>
+        </fieldset>
+        <py:for each="options in (event.summary_options, event.action_options)">
+          <fieldset py:if="options">
+            <py:with vars="field = options==event.summary_options and 'summary' or 'action'">
+              <legend py:if="'summary'==field">Summary Options</legend>
+              <legend py:if="'action'==field">Action Options</legend>
+              <div py:for="option in options.values()" class="field">
+                <label>$option.name</label><br />
+                <py:choose test="option.type">
+                  <textarea py:when="'large'" name="${field}-option-${option.md5}" rows="10" cols="70">$option.value</textarea>
+                  <input py:when="'small'" name="${field}-option-${option.md5}" type="text" size="5" value="$option.value" />
+                  <select py:when="'list'" name="${field}-option-${option.md5}">
+                    <option py:for="val in option.vals" selected="${val == option.value and 'selected' or None}">$val</option>
+                  </select>
+                  <input py:otherwise="" name="${field}-option-${option.md5}" type="text" size="60" value="$option.value" />
+                </py:choose>
+                <p class="help">$option.description</p>
+              </div>
+            </py:with>
+          </fieldset>
+        </py:for>
+        <div class="buttons">
+          <input type="submit" name="cancel" value="Cancel" />
+          <input type="submit" name="save" value="Save" />
+        </div>
+      </form>
+
+      <py:otherwise>
+        <form class="addnew" method="post">
+          <fieldset>
+            <legend>Add Client Event:</legend>
+            <div class="field">
+              <label>Name:<br /><input type="text" name="name" /></label>
+            </div>
+            <div class="field">
+              <label>Summary:<br />
+                <select name="summary">
+                  <option py:for="summary in summaries">
+                    $summary
+                  </option>
+                </select>
+              </label>
+            </div>
+            <div class="field">
+              <label>Action:<br />
+                <select name="action">
+                  <option py:for="action in actions">
+                    $action
+                  </option>
+                </select>
+              </label>
+            </div>
+            <div class="buttons">
+              <input type="submit" name="add" value="Add"/>
+            </div>
+          </fieldset>
+        </form>
+
+        <py:choose>
+          <form py:when="events" method="POST">
+            <table class="listing">
+              <thead>
+                <tr><th class="sel">&nbsp;</th>
+                  <th>Name</th><th>Summary</th><th>Action</th>
+                </tr>
+              </thead>
+              <tbody>
+                <tr py:for="event in events">
+                  <td class="sel"><input type="checkbox" name="sel" value="$event.name" /></td>
+                  <td class="name">
+                    <a href="${panel_href(event.name)}">$event.name</a>
+                  </td>
+                  <td class="summary">$event.summary</td>
+                  <td class="action">$event.action</td>
+                </tr>
+              </tbody>
+            </table>
+            <div class="buttons">
+              <input type="submit" name="remove" value="Remove selected items" />
+              <input type="submit" name="apply" value="Apply changes" />
+            </div>
+          </form>
+        </py:choose>
+      </py:otherwise>
+    </py:choose>
+  </body>
+
+</html>