#!/usr/bin/env python # trac-post-commit-hook # ---------------------------------------------------------------------------- # Copyright (c) 2004 Stephen Hansen # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to # deal in the Software without restriction, including without limitation the # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or # sell copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # ---------------------------------------------------------------------------- # This Subversion post-commit hook script is meant to interface to the # Trac (http://www.edgewall.com/products/trac/) issue tracking/wiki/etc # system. # # It should be called from the 'post-commit' script in Subversion, such as # via: # # REPOS="$1" # REV="$2" # LOG=`/usr/bin/svnlook log -r $REV $REPOS` # AUTHOR=`/usr/bin/svnlook author -r $REV $REPOS` # TRAC_ENV='/somewhere/trac/project/' # TRAC_URL='http://trac.mysite.com/project/' # # /usr/bin/python /usr/local/src/trac/contrib/trac-post-commit-hook \ # -p "$TRAC_ENV" \ # -r "$REV" \ # -u "$AUTHOR" \ # -m "$LOG" \ # -s "$TRAC_URL" # # It searches commit messages for text in the form of: # command #1 # command #1, #2 # command #1 & #2 # command #1 and #2 # # Instead of the short-hand syntax "#1", "ticket:1" can be used as well, e.g.: # command ticket:1 # command ticket:1, ticket:2 # command ticket:1 & ticket:2 # command ticket:1 and ticket:2 # # In addition, the ':' character can be omitted and issue or bug can be used # instead of ticket. # # You can have more then one command in a message. The following commands # are supported. There is more then one spelling for each command, to make # this as user-friendly as possible. # # close, closed, closes, fix, fixed, fixes # The specified issue numbers are closed with the contents of this # commit message being added to it. # references, refs, addresses, re, see # The specified issue numbers are left in their current status, but # the contents of this commit message are added to their notes. # # A fairly complicated example of what you can do is with a commit message # of: # # Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12. # # This will close #10 and #12, and add a note to #12. import re import os import sys from datetime import datetime from trac.env import open_environment from trac.ticket.notification import TicketNotifyEmail from trac.ticket import Ticket from trac.ticket.web_ui import TicketModule # TODO: move grouped_changelog_entries to model.py from trac.util.text import to_unicode from trac.util.datefmt import utc from trac.versioncontrol.api import NoSuchChangeset from optparse import OptionParser parser = OptionParser() depr = '(not used anymore)' parser.add_option('-e', '--require-envelope', dest='envelope', default='', help=""" Require commands to be enclosed in an envelope. If -e[], then commands must be in the form of [closes #4]. Must be two characters.""") parser.add_option('-p', '--project', dest='project', help='Path to the Trac project.') parser.add_option('-r', '--revision', dest='rev', help='Repository revision number.') parser.add_option('-u', '--user', dest='user', help='The user who is responsible for this action '+depr) parser.add_option('-m', '--msg', dest='msg', help='The log message to search '+depr) parser.add_option('-c', '--encoding', dest='encoding', help='The encoding used by the log message '+depr) parser.add_option('-s', '--siteurl', dest='url', help=depr+' the base_url from trac.ini will always be used.') (options, args) = parser.parse_args(sys.argv[1:]) svnlog = None def log(*args): global svnlog if svnlog is None: svnlog = open('/var/log/svnlog', 'a+',0) for x in args: print >> svnlog, x, print >> svnlog env_id = '[^:/ ]+' ticket_prefix = '(?:#|(?:ticket|issue|bug)[: ]?)' ticket_reference = '(?:%s:)?' % env_id + ticket_prefix + '[0-9]+' ticket_command = (r'(?P[A-Za-z]*).?' '(?P%s(?:(?:[, &]*|[ ]?and[ ]?)%s)*)' % (ticket_reference, ticket_reference)) if options.envelope: ticket_command = r'\%s%s\%s' % (options.envelope[0], ticket_command, options.envelope[1]) # log('initializing patterns...') command_re = re.compile(ticket_command) ticket_re = re.compile('(?:(%s):)?' % env_id + ticket_prefix + '([0-9]+)') # log('done') class CommitHook: _supported_cmds = {'close': '_cmdClose', 'closed': '_cmdClose', 'closes': '_cmdClose', 'fix': '_cmdClose', 'fixed': '_cmdClose', 'fixes': '_cmdClose', 'addresses': '_cmdRefs', 're': '_cmdRefs', 'references': '_cmdRefs', 'refs': '_cmdRefs', 'see': '_cmdRefs'} def __init__(self, project=options.project, author=options.user, rev=options.rev, url=options.url): # log('opening default environment:', project) self.env = open_environment(project) repos = self.env.get_repository() repos.sync() # Instead of bothering with the encoding, we'll use unicode data # as provided by the Trac versioncontrol API (#1310). try: chgset = repos.get_changeset(rev) except NoSuchChangeset: return # out of scope changesets are not cached self.author = chgset.author self.rev = rev self.msg = "(In [%s]) %s" % (rev, chgset.message) self.now = datetime.now(utc) cmd_groups = command_re.findall(self.msg) # log('cmd_groups=', cmd_groups) project_root, project_name = os.path.split(project) if project_name == '': # deal with a possible trailing slash project_root, project_name = os.path.split(project_root) tracs = {} for cmd, tkts in cmd_groups: funcname = CommitHook._supported_cmds.get(cmd.lower(), '') if funcname: for trac_id,tkt_id in ticket_re.findall(tkts): # log('trac_id=', trac_id, 'tkt_id=', tkt_id) func = getattr(self, funcname) if not trac_id: trac_id = project_name tracs.setdefault(trac_id, {}).setdefault(tkt_id, []).append(func) for trac, tickets in tracs.iteritems(): if trac != project_name: self.env = open_environment( os.path.join(project_root,trac)) for tkt_id, cmds in tickets.iteritems(): try: db = self.env.get_db_cnx() ticket = Ticket(self.env, int(tkt_id), db) for cmd in cmds: cmd(ticket) # determine sequence number... cnum = 0 tm = TicketModule(self.env) for change in tm.grouped_changelog_entries(ticket, db): if change['permanent']: cnum += 1 ticket.save_changes(self.author, self.msg, self.now, db, cnum+1) db.commit() tn = TicketNotifyEmail(self.env) tn.notify(ticket, newticket=0, modtime=self.now) except Exception, e: # import traceback # traceback.print_exc(file=sys.stderr) # log('Unexpected error while processing ticket ID %s: %s' % (tkt_id, e)) print>>sys.stderr, 'Unexpected error while processing ticket ' \ 'ID %s: %s' % (tkt_id, e) def _cmdClose(self, ticket): ticket['status'] = 'closed' ticket['resolution'] = 'fixed' def _cmdRefs(self, ticket): pass if __name__ == "__main__": if len(sys.argv) < 5: # log('failed...') print "For usage: %s --help" % (sys.argv[0]) print print "Note that the deprecated options will be removed in Trac 0.12." else: # log('doing hook...') CommitHook()