code-edbd4bba728a/detectors/README.txt0000644000000000000000000000222413653031441015637 0ustar 00000000000000This directory has some detector examples that you can use to get ideas on implementing your own detectors. These are provides on an as-is basis. When they were added, they worked for somebody and were considered a useful example. The roundup team will attempt to keep them up to date with major changes as they happen, but there are no guarantees that these will work out of the box. If you find them out of date and have patches to make them work against newer versions of roundup, please open an issue at: http://issues.roundup-tracker.org The current inventory is: creator_resolution.py - only allow the creator of the issue to resolve it emailauditor.py - Rename .eml files (from email multi-part bodies) to .mht so they can be downloaded/viewed in Internet Explorer. irker.py - communicate with irkerd to allow roundtup to send announcements to an IRC channel. newissuecopy.py - notify a team email address (hardcoded in the script) when a new issue arrives. newitemcopy.py - email the DISPATCHER address when new issues, users, keywords etc. are created. Kind of an expanded version of newissuecopy. code-edbd4bba728a/detectors/creator_resolution.py0000644000000000000000000000251013653031441020433 0ustar 00000000000000# This detector was written by richard@mechanicalcat.net and it's been # placed in the Public Domain. Copy and modify to your heart's content. from roundup.exceptions import Reject def creator_resolution(db, cl, nodeid, newvalues): '''Catch attempts to set the status to "resolved" - if the assignedto user isn't the creator, then set the status to "in-progress" (try "confirm-done" first though, but "classic" Roundup doesn't have that status) ''' if 'status' not in newvalues: return # get the resolved state ID resolved_id = db.status.lookup('resolved') if newvalues['status'] != resolved_id: return # check the assignedto assignedto = newvalues.get('assignedto', cl.get(nodeid, 'assignedto')) creator = cl.get(nodeid, 'creator') if assignedto == creator: if db.getuid() != creator: name = db.user.get(creator, 'username') raise Reject('Only the creator (%s) may close this issue'%name) return # set the assignedto and status newvalues['assignedto'] = creator try: status = db.status.lookup('confirm-done') except KeyError: status = db.status.lookup('in-progress') newvalues['status'] = status def init(db): db.issue.audit('set', creator_resolution) # vim: set filetype=python ts=4 sw=4 et si code-edbd4bba728a/detectors/emailauditor.py0000644000000000000000000000275513653031441017203 0ustar 00000000000000 def eml_to_mht(db, cl, nodeid, newvalues): '''This auditor fires whenever a new file entity is created. If the file is of type message/rfc822, we tack onthe extension .eml. The reason for this is that Microsoft Internet Explorer will not open things with a .eml attachment, as they deem it 'unsafe'. Worse yet, they'll just give you an incomprehensible error message. For more information, please see: http://support.microsoft.com/default.aspx?scid=kb;EN-US;825803 Their suggested work around is (excerpt): WORKAROUND To work around this behavior, rename the .EML file that the URL links to so that it has a .MHT file name extension, and then update the URL to reflect the change to the file name. To do this: 1. In Windows Explorer, locate and then select the .EML file that the URL links. 2. Right-click the .EML file, and then click Rename. 3. Change the file name so that the .EML file uses a .MHT file name extension, and then press ENTER. 4. Updated the URL that links to the file to reflect the new file name extension. So... we do that. :)''' if newvalues.get('type', '').lower() == "message/rfc822": if 'name' not in newvalues: newvalues['name'] = 'email.mht' return name = newvalues['name'] if name.endswith('.eml'): name = name[:-4] newvalues['name'] = name + '.mht' def init(db): db.file.audit('create', eml_to_mht) code-edbd4bba728a/detectors/irker.py0000644000000000000000000000547213653031441015637 0ustar 00000000000000# This detector sends notification on IRC through an irker daemon # (http://www.catb.org/esr/irker/) when issues are created or messages # are added. # # Written by Ezio Melotti # # Requires a running irkerd daemon to work. See the irker documentation # for more information about installing, configuring, and running irker. # # Add the IRC channel(s) that should receive notifications in # detectors/config.ini as a comma-separated list, using this format: # # [irker] # channels = irc://chat.freenode.net/channelname # from __future__ import print_function import re import json import socket IRKER_HOST = 'localhost' IRKER_PORT = 6659 max_content = 120 TEMPLATE = ('%(green)s%(author)s%(reset)s ' '%(bluish)s#%(nodeid)s%(reset)s/%(title)s%(bold)s:%(bold)s ' '%(log)s %(url)s') def sendmsg(msg): sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) try: sock.connect((IRKER_HOST, IRKER_PORT)) sock.sendall(msg + "\n") finally: sock.close() def notify_irker(db, cl, nodeid, oldvalues): messages = set(cl.get(nodeid, 'messages')) if oldvalues: messages -= set(oldvalues.get('messages', ())) if not messages: return messages = list(messages) if oldvalues: oldstatus = oldvalues['status'] else: oldstatus = None newstatus = db.issue.get(nodeid, 'status') if oldstatus != newstatus: if oldvalues: status = db.status.get(newstatus, 'name') else: status = 'new' log = '[' + status + '] ' else: log = '' for msg in messages: log += db.msg.get(msg, 'content') if len(log) > max_content: log = log[:max_content-3] + '...' log = re.sub('\s+', ' ', log) # include irc colors params = { 'bold': '\x02', 'green': '\x0303', 'blue': '\x0302', 'bluish': '\x0310', 'yellow': '\x0307', 'brown': '\x0305', 'reset': '\x0F' } # extend with values used in the template params['author'] = db.user.get(db.getuid(), 'username') params['nodeid'] = nodeid params['title'] = db.issue.get(nodeid, 'title') params['log'] = log params['url'] = '%sissue%s' % (db.config.TRACKER_WEB, nodeid) # create the message and use the list of channels defined in # detectors/config.ini msg = json.dumps({ 'to': db.config.detectors.IRKER_CHANNELS.split(','), 'privmsg': TEMPLATE % params, }) try: sendmsg(msg) except Exception as e: # Ignore any errors in sending the irker; # if the server is down, that's just bad luck # XXX might want to do some logging here print('* Sending message to irker failed', str(e)) def init(db): db.issue.react('create', notify_irker) db.issue.react('set', notify_irker) code-edbd4bba728a/detectors/newissuecopy.py0000644000000000000000000000152613653031441017254 0ustar 00000000000000# copied from nosyreaction from roundup import roundupdb def newissuecopy(db, cl, nodeid, oldvalues): ''' Copy a message about new issues to a team address. ''' # get relevant crypto settings encrypt = db.config.PGP_ENABLE and db.config.PGP_ENCRYPT # so use all the messages in the create change_note = cl.generateCreateNote(nodeid) # send a copy to the nosy list for msgid in cl.get(nodeid, 'messages'): try: # note: fourth arg must be a list cl.send_message(nodeid, msgid, change_note, ['team@team.host'], crypt=encrypt) except roundupdb.MessageSendError as message: raise roundupdb.DetectorError(message) def init(db): db.issue.react('create', newissuecopy) # vim: set filetype=python ts=4 sw=4 et si code-edbd4bba728a/detectors/newitemcopy.py0000644000000000000000000000512113653031441017055 0ustar 00000000000000from roundup import hyperdb, roundupdb from roundup.mailer import Mailer def indentChangeNoteValue(text): # copied from roundupdb.IssueClass.indentChangeNoteValue() lines = text.rstrip('\n').split('\n') lines = [ ' '+line for line in lines ] return '\n'.join(lines) def generateCreateNote(db, cl, nodeid): # copied from roundupdb.IssueClass.generateCreateNote() cn = cl.classname props = cl.getprops(protected=0) # list the values m = [] prop_items = sorted(props.items()) for propname, prop in prop_items: value = cl.get(nodeid, propname, None) # skip boring entries if not value: continue if isinstance(prop, hyperdb.Link): link = db.classes[prop.classname] if value: key = link.labelprop(default_to_id=1) if key: value = link.get(value, key) else: value = '' elif isinstance(prop, hyperdb.Multilink): if value is None: value = [] l = [] link = db.classes[prop.classname] key = link.labelprop(default_to_id=1) if key: value = [link.get(entry, key) for entry in value] value.sort() value = ', '.join(value) else: value = str(value) if '\n' in value: value = '\n'+indentChangeNoteValue(value) m.append('%s: %s'%(propname, value)) m.insert(0, '----------') m.insert(0, '') return '\n'.join(m) def newitemcopy(db, cl, nodeid, oldvalues): ''' Copy a message about new items to the dispatcher address. ''' try: create_note = cl.generateCreateNote(nodeid) except AttributeError: create_note = generateCreateNote(db, cl, nodeid) try: dispatcher_email = getattr(db.config, 'DISPATCHER_EMAIL') except AttributeError: return try: msgids = cl.get(nodeid, 'messages') except KeyError: msgids = None if msgids: # send a copy to the dispatcher for msgid in msgids: try: cl.send_message(nodeid, msgid, create_note, [dispatcher_email]) except roundupdb.MessageSendError as message: raise roundupdb.DetectorError(message) else: mailer = Mailer(db.config) subject = 'New %s%s' % (cl.classname, nodeid) mailer.standard_message([dispatcher_email], subject, create_note) def init(db): for classname in db.getclasses(): cl = db.getclass(classname) cl.react('create', newitemcopy)