mercurial-scm/hg: hgext/bugzilla.py annotate

annotate hgext/bugzilla.py @ 16221:4fc9fcd991c1

bugzilla: modify access interface to include new bug states As a first step to allowing comment text to update bug state, rework the Bugzilla access interface to use a dictionary keyed on bug ID. Dictionary entries will contain new state info in future changes.

author	Jim Hague <jim.hague@acm.org>
date	Thu, 01 Mar 2012 14:51:40 +0000
parents	b468cea3f29d
children	d7b7b453c035

rev	line source
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	1 # bugzilla.py - bugzilla integration for mercurial
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	2 #
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	3 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	4 # Copyright 2011-2 Jim Hague <jim.hague@acm.org>
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	5 #
8225 46293a0c7e9f updated license to be explicit about GPL version 2 Martin Geisler <mg@lazybytes.net> parents: 8209 diff changeset	6 # This software may be used and distributed according to the terms of the
10263 25e572394f5c Update license to GPLv2+ Matt Mackall <mpm@selenic.com> parents: 10112 diff changeset	7 # GNU General Public License version 2 or any later version.
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	8
8935 f4f0e902b750 extensions: change descriptions for hook-providing extensions Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 8894 diff changeset	9 '''hooks for integrating with the Bugzilla bug tracker
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	10
9252 b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	11 This hook extension adds comments on bugs in Bugzilla when changesets
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	12 that refer to bugs by Bugzilla ID are seen. The comment is formatted using
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	13 the Mercurial template mechanism.
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	14
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	15 The hook does not change bug status.
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	16
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	17 Three basic modes of access to Bugzilla are provided:
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	18
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	19 1. Access via the Bugzilla XMLRPC interface. Requires Bugzilla 3.4 or later.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	20
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	21 2. Check data via the Bugzilla XMLRPC interface and submit bug change
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	22 via email to Bugzilla email interface. Requires Bugzilla 3.4 or later.
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	23
13896 3b4025dcb223 bugzilla: more documentation formatting fixups Jim Hague <jim.hague@acm.org> parents: 13884 diff changeset	24 3. Writing directly to the Bugzilla database. Only Bugzilla installations
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	25 using MySQL are supported. Requires Python MySQLdb.
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	26
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	27 Writing directly to the database is susceptible to schema changes, and
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	28 relies on a Bugzilla contrib script to send out bug change
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	29 notification emails. This script runs as the user running Mercurial,
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	30 must be run on the host with the Bugzilla install, and requires
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	31 permission to read Bugzilla configuration details and the necessary
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	32 MySQL user and password to have full access rights to the Bugzilla
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	33 database. For these reasons this access mode is now considered
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	34 deprecated, and will not be updated for new Bugzilla versions going
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	35 forward.
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	36
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	37 Access via XMLRPC needs a Bugzilla username and password to be specified
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	38 in the configuration. Comments are added under that username. Since the
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	39 configuration must be readable by all Mercurial users, it is recommended
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	40 that the rights of that user are restricted in Bugzilla to the minimum
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	41 necessary to add comments.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	42
13871 22d200e49b10 bugzilla: more documentation fixes Jim Hague <jim.hague@acm.org> parents: 13870 diff changeset	43 Access via XMLRPC/email uses XMLRPC to query Bugzilla, but sends
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	44 email to the Bugzilla email interface to submit comments to bugs.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	45 The From: address in the email is set to the email address of the Mercurial
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	46 user, so the comment appears to come from the Mercurial user. In the event
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	47 that the Mercurial user email is not recognised by Bugzilla as a Bugzilla
13871 22d200e49b10 bugzilla: more documentation fixes Jim Hague <jim.hague@acm.org> parents: 13870 diff changeset	48 user, the email associated with the Bugzilla username used to log into
22d200e49b10 bugzilla: more documentation fixes Jim Hague <jim.hague@acm.org> parents: 13870 diff changeset	49 Bugzilla is used instead as the source of the comment.
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	50
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	51 Configuration items common to all access modes:
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	52
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	53 bugzilla.version
13883 fc83d2ca9cfb bugzilla: fix reST error introduced in 22d200e49b10 Martin Geisler <mg@aragost.com> parents: 13871 diff changeset	54 This access type to use. Values recognised are:
13871 22d200e49b10 bugzilla: more documentation fixes Jim Hague <jim.hague@acm.org> parents: 13870 diff changeset	55
13883 fc83d2ca9cfb bugzilla: fix reST error introduced in 22d200e49b10 Martin Geisler <mg@aragost.com> parents: 13871 diff changeset	56 :``xmlrpc``: Bugzilla XMLRPC interface.
fc83d2ca9cfb bugzilla: fix reST error introduced in 22d200e49b10 Martin Geisler <mg@aragost.com> parents: 13871 diff changeset	57 :``xmlrpc+email``: Bugzilla XMLRPC and email interfaces.
fc83d2ca9cfb bugzilla: fix reST error introduced in 22d200e49b10 Martin Geisler <mg@aragost.com> parents: 13871 diff changeset	58 :``3.0``: MySQL access, Bugzilla 3.0 and later.
fc83d2ca9cfb bugzilla: fix reST error introduced in 22d200e49b10 Martin Geisler <mg@aragost.com> parents: 13871 diff changeset	59 :``2.18``: MySQL access, Bugzilla 2.18 and up to but not
fc83d2ca9cfb bugzilla: fix reST error introduced in 22d200e49b10 Martin Geisler <mg@aragost.com> parents: 13871 diff changeset	60 including 3.0.
fc83d2ca9cfb bugzilla: fix reST error introduced in 22d200e49b10 Martin Geisler <mg@aragost.com> parents: 13871 diff changeset	61 :``2.16``: MySQL access, Bugzilla 2.16 and up to but not
fc83d2ca9cfb bugzilla: fix reST error introduced in 22d200e49b10 Martin Geisler <mg@aragost.com> parents: 13871 diff changeset	62 including 2.18.
7985 0edca606c0f1 bugzilla: word-wrap help texts at 70 characters Martin Geisler <mg@daimi.au.dk> parents: 7762 diff changeset	63
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	64 bugzilla.regexp
9252 b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	65 Regular expression to match bug IDs in changeset commit message.
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	66 Must contain one "()" group. The default expression matches ``Bug
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	67 1234``, ``Bug no. 1234``, ``Bug number 1234``, ``Bugs 1234,5678``,
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	68 ``Bug 1234 and 5678`` and variations thereof. Matching is case
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	69 insensitive.
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	70
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	71 bugzilla.style
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	72 The style file to use when formatting comments.
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	73
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	74 bugzilla.template
9252 b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	75 Template to use when formatting comments. Overrides style if
b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	76 specified. In addition to the usual Mercurial keywords, the
13884 773a833ddbc6 bugzilla: convert a verbatim block to a field list Martin Geisler <mg@aragost.com> parents: 13883 diff changeset	77 extension specifies:
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	78
13884 773a833ddbc6 bugzilla: convert a verbatim block to a field list Martin Geisler <mg@aragost.com> parents: 13883 diff changeset	79 :``{bug}``: The Bugzilla bug ID.
773a833ddbc6 bugzilla: convert a verbatim block to a field list Martin Geisler <mg@aragost.com> parents: 13883 diff changeset	80 :``{root}``: The full pathname of the Mercurial repository.
773a833ddbc6 bugzilla: convert a verbatim block to a field list Martin Geisler <mg@aragost.com> parents: 13883 diff changeset	81 :``{webroot}``: Stripped pathname of the Mercurial repository.
773a833ddbc6 bugzilla: convert a verbatim block to a field list Martin Geisler <mg@aragost.com> parents: 13883 diff changeset	82 :``{hgweb}``: Base URL for browsing Mercurial repositories.
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	83
13842 4cffce61bd92 bugzilla: fix bad reST markup Martin Geisler <mg@aragost.com> parents: 13841 diff changeset	84 Default ``changeset {node\|short} in repo {root} refers to bug
4cffce61bd92 bugzilla: fix bad reST markup Martin Geisler <mg@aragost.com> parents: 13841 diff changeset	85 {bug}.\\ndetails:\\n\\t{desc\|tabindent}``
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	86
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	87 bugzilla.strip
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	88 The number of path separator characters to strip from the front of
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	89 the Mercurial repository path (``{root}`` in templates) to produce
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	90 ``{webroot}``. For example, a repository with ``{root}``
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	91 ``/var/local/my-project`` with a strip of 2 gives a value for
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	92 ``{webroot}`` of ``my-project``. Default 0.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	93
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	94 web.baseurl
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	95 Base URL for browsing Mercurial repositories. Referenced from
13896 3b4025dcb223 bugzilla: more documentation formatting fixups Jim Hague <jim.hague@acm.org> parents: 13884 diff changeset	96 templates as ``{hgweb}``.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	97
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	98 Configuration items common to XMLRPC+email and MySQL access modes:
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	99
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	100 bugzilla.usermap
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	101 Path of file containing Mercurial committer email to Bugzilla user email
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	102 mappings. If specified, the file should contain one mapping per
13835 135bed43e20c bugzilla: show usermap syntax more clearly Martin Geisler <mg@aragost.com> parents: 13834 diff changeset	103 line::
135bed43e20c bugzilla: show usermap syntax more clearly Martin Geisler <mg@aragost.com> parents: 13834 diff changeset	104
135bed43e20c bugzilla: show usermap syntax more clearly Martin Geisler <mg@aragost.com> parents: 13834 diff changeset	105 committer = Bugzilla user
135bed43e20c bugzilla: show usermap syntax more clearly Martin Geisler <mg@aragost.com> parents: 13834 diff changeset	106
13896 3b4025dcb223 bugzilla: more documentation formatting fixups Jim Hague <jim.hague@acm.org> parents: 13884 diff changeset	107 See also the ``[usermap]`` section.
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	108
13836 ed15922af2f9 bugzilla: markup section names as literal text Martin Geisler <mg@aragost.com> parents: 13835 diff changeset	109 The ``[usermap]`` section is used to specify mappings of Mercurial
13834 0aa2cfd0b21a bugzilla: use standard section.name notation Martin Geisler <mg@aragost.com> parents: 13833 diff changeset	110 committer email to Bugzilla user email. See also ``bugzilla.usermap``.
13835 135bed43e20c bugzilla: show usermap syntax more clearly Martin Geisler <mg@aragost.com> parents: 13834 diff changeset	111 Contains entries of the form ``committer = Bugzilla user``.
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	112
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	113 XMLRPC access mode configuration:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	114
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	115 bugzilla.bzurl
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	116 The base URL for the Bugzilla installation.
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	117 Default ``http://localhost/bugzilla``.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	118
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	119 bugzilla.user
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	120 The username to use to log into Bugzilla via XMLRPC. Default
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	121 ``bugs``.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	122
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	123 bugzilla.password
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	124 The password for Bugzilla login.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	125
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	126 XMLRPC+email access mode uses the XMLRPC access mode configuration items,
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	127 and also:
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	128
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	129 bugzilla.bzemail
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	130 The Bugzilla email address.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	131
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	132 In addition, the Mercurial email settings must be configured. See the
13837 22f20d0fe2d3 bugzilla: refer to hgrc(5) man page with normal notation Martin Geisler <mg@aragost.com> parents: 13836 diff changeset	133 documentation in hgrc(5), sections ``[email]`` and ``[smtp]``.
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	134
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	135 MySQL access mode configuration:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	136
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	137 bugzilla.host
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	138 Hostname of the MySQL server holding the Bugzilla database.
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	139 Default ``localhost``.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	140
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	141 bugzilla.db
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	142 Name of the Bugzilla database in MySQL. Default ``bugs``.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	143
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	144 bugzilla.user
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	145 Username to use to access MySQL server. Default ``bugs``.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	146
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	147 bugzilla.password
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	148 Password to use to access MySQL server.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	149
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	150 bugzilla.timeout
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	151 Database connection timeout (seconds). Default 5.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	152
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	153 bugzilla.bzuser
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	154 Fallback Bugzilla user name to record comments with, if changeset
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	155 committer cannot be found as a Bugzilla user.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	156
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	157 bugzilla.bzdir
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	158 Bugzilla install directory. Used by default notify. Default
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	159 ``/var/www/html/bugzilla``.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	160
13833 64ad07dff0a8 bugzilla: prefix each config option with section Martin Geisler <mg@aragost.com> parents: 13832 diff changeset	161 bugzilla.notify
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	162 The command to run to get Bugzilla to send bug change notification
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	163 emails. Substitutes from a map with 3 keys, ``bzdir``, ``id`` (bug
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	164 id) and ``user`` (committer bugzilla email). Default depends on
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	165 version; from 2.18 it is "cd %(bzdir)s && perl -T
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	166 contrib/sendbugmail.pl %(id)s %(user)s".
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	167
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	168 Activating the extension::
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	169
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	170 [extensions]
10112 703db37d186b hgext: enable extensions without "hgext." prefix in help texts Martin Geisler <mg@lazybytes.net> parents: 9252 diff changeset	171 bugzilla =
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	172
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	173 [hooks]
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	174 # run bugzilla hook on every change pulled or pushed in here
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	175 incoming.bugzilla = python:hgext.bugzilla.hook
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	176
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	177 Example configurations:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	178
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	179 XMLRPC example configuration. This uses the Bugzilla at
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	180 ``http://my-project.org/bugzilla``, logging in as user
367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	181 ``bugmail@my-project.org`` with password ``plugh``. It is used with a
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	182 collection of Mercurial repositories in ``/var/local/hg/repos/``,
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	183 with a web interface at ``http://my-project.org/hg``. ::
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	184
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	185 [bugzilla]
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	186 bzurl=http://my-project.org/bugzilla
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	187 user=bugmail@my-project.org
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	188 password=plugh
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	189 version=xmlrpc
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	190 template=Changeset {node\|short} in {root\|basename}.
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	191 {hgweb}/{webroot}/rev/{node\|short}\\n
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	192 {desc}\\n
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	193 strip=5
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	194
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	195 [web]
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	196 baseurl=http://my-project.org/hg
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	197
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	198 XMLRPC+email example configuration. This uses the Bugzilla at
13841 367805c848e5 bugzilla: markup literal text as such Martin Geisler <mg@aragost.com> parents: 13837 diff changeset	199 ``http://my-project.org/bugzilla``, logging in as user
14619 29f55c0e39e7 bugzilla: fix typo in documentation Wagner Bruna <wbruna@softwareexpress.com.br> parents: 14234 diff changeset	200 ``bugmail@my-project.org`` with password ``plugh``. It is used with a
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	201 collection of Mercurial repositories in ``/var/local/hg/repos/``,
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	202 with a web interface at ``http://my-project.org/hg``. Bug comments
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	203 are sent to the Bugzilla email address
13854 5ed036e42fd9 bugzilla: fix documentation typo Patrick Mezard <pmezard@gmail.com> parents: 13842 diff changeset	204 ``bugzilla@my-project.org``. ::
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	205
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	206 [bugzilla]
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	207 bzurl=http://my-project.org/bugzilla
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	208 user=bugmail@my-project.org
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	209 password=plugh
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	210 version=xmlrpc
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	211 bzemail=bugzilla@my-project.org
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	212 template=Changeset {node\|short} in {root\|basename}.
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	213 {hgweb}/{webroot}/rev/{node\|short}\\n
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	214 {desc}\\n
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	215 strip=5
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	216
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	217 [web]
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	218 baseurl=http://my-project.org/hg
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	219
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	220 [usermap]
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	221 user@emaildomain.com=user.name@bugzilladomain.com
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	222
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	223 MySQL example configuration. This has a local Bugzilla 3.2 installation
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	224 in ``/opt/bugzilla-3.2``. The MySQL database is on ``localhost``,
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	225 the Bugzilla database name is ``bugs`` and MySQL is
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	226 accessed with MySQL username ``bugs`` password ``XYZZY``. It is used
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	227 with a collection of Mercurial repositories in ``/var/local/hg/repos/``,
ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	228 with a web interface at ``http://my-project.org/hg``. ::
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	229
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	230 [bugzilla]
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	231 host=localhost
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	232 password=XYZZY
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	233 version=3.0
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	234 bzuser=unknown@domain.com
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	235 bzdir=/opt/bugzilla-3.2
9204 8d59e43854d9 bugzilla: wrap example template line Martin Geisler <mg@lazybytes.net> parents: 9203 diff changeset	236 template=Changeset {node\|short} in {root\|basename}.
8d59e43854d9 bugzilla: wrap example template line Martin Geisler <mg@lazybytes.net> parents: 9203 diff changeset	237 {hgweb}/{webroot}/rev/{node\|short}\\n
8d59e43854d9 bugzilla: wrap example template line Martin Geisler <mg@lazybytes.net> parents: 9203 diff changeset	238 {desc}\\n
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	239 strip=5
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	240
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	241 [web]
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	242 baseurl=http://my-project.org/hg
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	243
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	244 [usermap]
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	245 user@emaildomain.com=user.name@bugzilladomain.com
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	246
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	247 All the above add a comment to the Bugzilla bug record of the form::
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	248
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	249 Changeset 3b16791d6642 in repository-name.
13870 ce066d424bba bugzilla: correct sample configurations Jim Hague <jim.hague@acm.org> parents: 13854 diff changeset	250 http://my-project.org/hg/repository-name/rev/3b16791d6642
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	251
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	252 Changeset commit comment. Bug 1234.
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	253 '''
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	254
3891 6b4127c7d52a Simplify i18n imports Matt Mackall <mpm@selenic.com> parents: 3877 diff changeset	255 from mercurial.i18n import _
6211 f89fd07fc51d Expand import * to allow Pyflakes to find problems Joel Rosdahl <joel@rosdahl.net> parents: 5975 diff changeset	256 from mercurial.node import short
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	257 from mercurial import cmdutil, mail, templater, util
15870 f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	258 import re, time, urlparse, xmlrpclib
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	259
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	260 class bzaccess(object):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	261 '''Base class for access to Bugzilla.'''
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	262
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	263 def __init__(self, ui):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	264 self.ui = ui
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	265 usermap = self.ui.config('bugzilla', 'usermap')
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	266 if usermap:
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	267 self.ui.readconfig(usermap, sections=['usermap'])
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	268
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	269 def map_committer(self, user):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	270 '''map name of committer to Bugzilla user name.'''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	271 for committer, bzuser in self.ui.configitems('usermap'):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	272 if committer.lower() == user.lower():
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	273 return bzuser
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	274 return user
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	275
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	276 # Methods to be implemented by access classes.
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	277 #
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	278 # 'bugs' is a dict keyed on bug id, where values are a dict holding
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	279 # updates to bug state. Currently no states are recognised, but this
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	280 # will change soon.
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	281 def filter_real_bug_ids(self, bugs):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	282 '''remove bug IDs that do not exist in Bugzilla from bugs.'''
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	283 pass
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	284
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	285 def filter_cset_known_bug_ids(self, node, bugs):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	286 '''remove bug IDs where node occurs in comment text from bugs.'''
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	287 pass
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	288
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	289 def updatebug(self, bugid, newstate, text, committer):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	290 '''update the specified bug. Add comment text and set new states.
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	291
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	292 If possible add the comment as being from the committer of
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	293 the changeset. Otherwise use the default Bugzilla user.
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	294 '''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	295 pass
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	296
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	297 def notify(self, bugs, committer):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	298 '''Force sending of Bugzilla notification emails.
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	299
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	300 Only required if the access method does not trigger notification
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	301 emails automatically.
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	302 '''
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	303 pass
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	304
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	305 # Bugzilla via direct access to MySQL database.
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	306 class bzmysql(bzaccess):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	307 '''Support for direct MySQL access to Bugzilla.
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	308
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	309 The earliest Bugzilla version this is tested with is version 2.16.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	310
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	311 If your Bugzilla is version 3.2 or above, you are strongly
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	312 recommended to use the XMLRPC access method instead.
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	313 '''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	314
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	315 @staticmethod
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	316 def sql_buglist(ids):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	317 '''return SQL-friendly list of bug ids'''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	318 return '(' + ','.join(map(str, ids)) + ')'
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	319
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	320 _MySQLdb = None
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	321
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	322 def __init__(self, ui):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	323 try:
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	324 import MySQLdb as mysql
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	325 bzmysql._MySQLdb = mysql
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	326 except ImportError, err:
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	327 raise util.Abort(_('python mysql support not available: %s') % err)
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	328
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	329 bzaccess.__init__(self, ui)
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	330
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	331 host = self.ui.config('bugzilla', 'host', 'localhost')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	332 user = self.ui.config('bugzilla', 'user', 'bugs')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	333 passwd = self.ui.config('bugzilla', 'password')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	334 db = self.ui.config('bugzilla', 'db', 'bugs')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	335 timeout = int(self.ui.config('bugzilla', 'timeout', 5))
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	336 self.ui.note(_('connecting to %s:%s as %s, password %s\n') %
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	337 (host, db, user, '' len(passwd)))
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	338 self.conn = bzmysql._MySQLdb.connect(host=host,
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	339 user=user, passwd=passwd,
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	340 db=db,
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	341 connect_timeout=timeout)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	342 self.cursor = self.conn.cursor()
7019 6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	343 self.longdesc_id = self.get_longdesc_id()
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	344 self.user_ids = {}
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	345 self.default_notify = "cd %(bzdir)s && ./processmail %(id)s %(user)s"
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	346
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	347 def run(self, args, *kwargs):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	348 '''run a query.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	349 self.ui.note(_('query: %s %s\n') % (args, kwargs))
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	350 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	351 self.cursor.execute(args, *kwargs)
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	352 except bzmysql._MySQLdb.MySQLError:
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	353 self.ui.note(_('failed query: %s %s\n') % (args, kwargs))
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	354 raise
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	355
7019 6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	356 def get_longdesc_id(self):
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	357 '''get identity of longdesc field'''
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	358 self.run('select fieldid from fielddefs where name = "longdesc"')
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	359 ids = self.cursor.fetchall()
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	360 if len(ids) != 1:
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	361 raise util.Abort(_('unknown database schema'))
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	362 return ids[0][0]
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	363
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	364 def filter_real_bug_ids(self, bugs):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	365 '''filter not-existing bugs from set.'''
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	366 self.run('select bug_id from bugs where bug_id in %s' %
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	367 bzmysql.sql_buglist(bugs.keys()))
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	368 existing = [id for (id,) in self.cursor.fetchall()]
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	369 for id in bugs.keys():
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	370 if id not in existing:
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	371 self.ui.status(_('bug %d does not exist\n') % id)
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	372 del bugs[id]
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	373
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	374 def filter_cset_known_bug_ids(self, node, bugs):
13799 d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	375 '''filter bug ids that already refer to this changeset from set.'''
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	376 self.run('''select bug_id from longdescs where
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	377 bug_id in %s and thetext like "%%%s%%"''' %
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	378 (bzmysql.sql_buglist(bugs.keys()), short(node)))
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	379 for (id,) in self.cursor.fetchall():
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	380 self.ui.status(_('bug %d already knows about changeset %s\n') %
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	381 (id, short(node)))
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	382 del bugs[id]
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	383
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	384 def notify(self, bugs, committer):
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	385 '''tell bugzilla to send mail.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	386 self.ui.status(_('telling bugzilla to send mail:\n'))
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	387 (user, userid) = self.get_bugzilla_user(committer)
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	388 for id in bugs.keys():
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	389 self.ui.status(_(' bug %s\n') % id)
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	390 cmdfmt = self.ui.config('bugzilla', 'notify', self.default_notify)
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	391 bzdir = self.ui.config('bugzilla', 'bzdir', '/var/www/html/bugzilla')
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	392 try:
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	393 # Backwards-compatible with old notify string, which
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	394 # took one string. This will throw with a new format
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	395 # string.
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	396 cmd = cmdfmt % id
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	397 except TypeError:
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	398 cmd = cmdfmt % {'bzdir': bzdir, 'id': id, 'user': user}
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	399 self.ui.note(_('running notify command %s\n') % cmd)
6548 962eb403165b replace usage of os.popen() with util.popen() Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 6211 diff changeset	400 fp = util.popen('(%s) 2>&1' % cmd)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	401 out = fp.read()
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	402 ret = fp.close()
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	403 if ret:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	404 self.ui.warn(out)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	405 raise util.Abort(_('bugzilla notify command %s') %
14234 600e64004eb5 rename explain_exit to explainexit Adrian Buehlmann <adrian@cadifra.com> parents: 13896 diff changeset	406 util.explainexit(ret)[0])
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	407 self.ui.status(_('done\n'))
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	408
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	409 def get_user_id(self, user):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	410 '''look up numeric bugzilla user id.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	411 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	412 return self.user_ids[user]
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	413 except KeyError:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	414 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	415 userid = int(user)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	416 except ValueError:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	417 self.ui.note(_('looking up user %s\n') % user)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	418 self.run('''select userid from profiles
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	419 where login_name like %s''', user)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	420 all = self.cursor.fetchall()
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	421 if len(all) != 1:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	422 raise KeyError(user)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	423 userid = int(all[0][0])
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	424 self.user_ids[user] = userid
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	425 return userid
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	426
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	427 def get_bugzilla_user(self, committer):
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	428 '''See if committer is a registered bugzilla user. Return
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	429 bugzilla username and userid if so. If not, return default
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	430 bugzilla username and userid.'''
2306 4c67ba93560b bugzilla: allow to map between committer email and bugzilla user name. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2239 diff changeset	431 user = self.map_committer(committer)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	432 try:
2306 4c67ba93560b bugzilla: allow to map between committer email and bugzilla user name. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2239 diff changeset	433 userid = self.get_user_id(user)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	434 except KeyError:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	435 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	436 defaultuser = self.ui.config('bugzilla', 'bzuser')
2306 4c67ba93560b bugzilla: allow to map between committer email and bugzilla user name. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2239 diff changeset	437 if not defaultuser:
4c67ba93560b bugzilla: allow to map between committer email and bugzilla user name. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2239 diff changeset	438 raise util.Abort(_('cannot find bugzilla user id for %s') %
4c67ba93560b bugzilla: allow to map between committer email and bugzilla user name. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2239 diff changeset	439 user)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	440 userid = self.get_user_id(defaultuser)
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	441 user = defaultuser
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	442 except KeyError:
2306 4c67ba93560b bugzilla: allow to map between committer email and bugzilla user name. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2239 diff changeset	443 raise util.Abort(_('cannot find bugzilla user id for %s or %s') %
4c67ba93560b bugzilla: allow to map between committer email and bugzilla user name. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2239 diff changeset	444 (user, defaultuser))
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	445 return (user, userid)
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	446
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	447 def updatebug(self, bugid, newstate, text, committer):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	448 '''update bug state with comment text.
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	449
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	450 Try adding comment as committer of changeset, otherwise as
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	451 default bugzilla user.'''
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	452 (user, userid) = self.get_bugzilla_user(committer)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	453 now = time.strftime('%Y-%m-%d %H:%M:%S')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	454 self.run('''insert into longdescs
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	455 (bug_id, who, bug_when, thetext)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	456 values (%s, %s, %s, %s)''',
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	457 (bugid, userid, now, text))
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	458 self.run('''insert into bugs_activity (bug_id, who, bug_when, fieldid)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	459 values (%s, %s, %s, %s)''',
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	460 (bugid, userid, now, self.longdesc_id))
7493 518afef5e350 Fix Bugzilla integration to work with new Bugzilla 3.2. Jim Hague <jim.hague@acm.org> parents: 7369 diff changeset	461 self.conn.commit()
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	462
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	463 class bzmysql_2_18(bzmysql):
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	464 '''support for bugzilla 2.18 series.'''
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	465
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	466 def __init__(self, ui):
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	467 bzmysql.__init__(self, ui)
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	468 self.default_notify = \
08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	469 "cd %(bzdir)s && perl -T contrib/sendbugmail.pl %(id)s %(user)s"
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	470
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	471 class bzmysql_3_0(bzmysql_2_18):
7019 6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	472 '''support for bugzilla 3.0 series.'''
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	473
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	474 def __init__(self, ui):
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	475 bzmysql_2_18.__init__(self, ui)
7019 6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	476
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	477 def get_longdesc_id(self):
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	478 '''get identity of longdesc field'''
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	479 self.run('select id from fielddefs where name = "longdesc"')
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	480 ids = self.cursor.fetchall()
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	481 if len(ids) != 1:
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	482 raise util.Abort(_('unknown database schema'))
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	483 return ids[0][0]
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	484
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	485 # Buzgilla via XMLRPC interface.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	486
15870 f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	487 class cookietransportrequest(object):
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	488 """A Transport request method that retains cookies over its lifetime.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	489
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	490 The regular xmlrpclib transports ignore cookies. Which causes
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	491 a bit of a problem when you need a cookie-based login, as with
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	492 the Bugzilla XMLRPC interface.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	493
15870 f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	494 So this is a helper for defining a Transport which looks for
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	495 cookies being set in responses and saves them to add to all future
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	496 requests.
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	497 """
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	498
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	499 # Inspiration drawn from
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	500 # http://blog.godson.in/2010/09/how-to-make-python-xmlrpclib-client.html
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	501 # http://www.itkovian.net/base/transport-class-for-pythons-xml-rpc-lib/
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	502
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	503 cookies = []
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	504 def send_cookies(self, connection):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	505 if self.cookies:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	506 for cookie in self.cookies:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	507 connection.putheader("Cookie", cookie)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	508
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	509 def request(self, host, handler, request_body, verbose=0):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	510 self.verbose = verbose
16193 b468cea3f29d bugzilla: stop XMLRPC requests from requesting gzipped responses Jim Hague <jim.hague@acm.org> parents: 15870 diff changeset	511 self.accept_gzip_encoding = False
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	512
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	513 # issue XML-RPC request
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	514 h = self.make_connection(host)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	515 if verbose:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	516 h.set_debuglevel(1)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	517
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	518 self.send_request(h, handler, request_body)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	519 self.send_host(h, host)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	520 self.send_cookies(h)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	521 self.send_user_agent(h)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	522 self.send_content(h, request_body)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	523
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	524 # Deal with differences between Python 2.4-2.6 and 2.7.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	525 # In the former h is a HTTP(S). In the latter it's a
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	526 # HTTP(S)Connection. Luckily, the 2.4-2.6 implementation of
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	527 # HTTP(S) has an underlying HTTP(S)Connection, so extract
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	528 # that and use it.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	529 try:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	530 response = h.getresponse()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	531 except AttributeError:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	532 response = h._conn.getresponse()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	533
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	534 # Add any cookie definitions to our list.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	535 for header in response.msg.getallmatchingheaders("Set-Cookie"):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	536 val = header.split(": ", 1)[1]
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	537 cookie = val.split(";", 1)[0]
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	538 self.cookies.append(cookie)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	539
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	540 if response.status != 200:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	541 raise xmlrpclib.ProtocolError(host + handler, response.status,
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	542 response.reason, response.msg.headers)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	543
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	544 payload = response.read()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	545 parser, unmarshaller = self.getparser()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	546 parser.feed(payload)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	547 parser.close()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	548
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	549 return unmarshaller.close()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	550
15870 f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	551 # The explicit calls to the underlying xmlrpclib __init__() methods are
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	552 # necessary. The xmlrpclib.Transport classes are old-style classes, and
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	553 # it turns out their __init__() doesn't get called when doing multiple
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	554 # inheritance with a new-style class.
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	555 class cookietransport(cookietransportrequest, xmlrpclib.Transport):
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	556 def __init__(self, use_datetime=0):
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	557 xmlrpclib.Transport.__init__(self, use_datetime)
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	558
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	559 class cookiesafetransport(cookietransportrequest, xmlrpclib.SafeTransport):
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	560 def __init__(self, use_datetime=0):
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	561 xmlrpclib.SafeTransport.__init__(self, use_datetime)
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	562
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	563 class bzxmlrpc(bzaccess):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	564 """Support for access to Bugzilla via the Bugzilla XMLRPC API.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	565
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	566 Requires a minimum Bugzilla version 3.4.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	567 """
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	568
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	569 def __init__(self, ui):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	570 bzaccess.__init__(self, ui)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	571
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	572 bzweb = self.ui.config('bugzilla', 'bzurl',
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	573 'http://localhost/bugzilla/')
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	574 bzweb = bzweb.rstrip("/") + "/xmlrpc.cgi"
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	575
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	576 user = self.ui.config('bugzilla', 'user', 'bugs')
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	577 passwd = self.ui.config('bugzilla', 'password')
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	578
15870 f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	579 self.bzproxy = xmlrpclib.ServerProxy(bzweb, self.transport(bzweb))
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	580 self.bzproxy.User.login(dict(login=user, password=passwd))
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	581
15870 f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	582 def transport(self, uri):
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	583 if urlparse.urlparse(uri, "http")[0] == "https":
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	584 return cookiesafetransport()
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	585 else:
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	586 return cookietransport()
f4c859293ed4 bugzilla: make XMLRPC interface support http and https access Jim Hague <jim.hague@acm.org> parents: 14619 diff changeset	587
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	588 def get_bug_comments(self, id):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	589 """Return a string with all comment text for a bug."""
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	590 c = self.bzproxy.Bug.comments(dict(ids=[id], include_fields=['text']))
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	591 return ''.join([t['text'] for t in c['bugs'][str(id)]['comments']])
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	592
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	593 def filter_real_bug_ids(self, bugs):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	594 probe = self.bzproxy.Bug.get(dict(ids=sorted(bugs.keys()),
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	595 include_fields=[],
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	596 permissive=True))
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	597 for badbug in probe['faults']:
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	598 id = badbug['id']
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	599 self.ui.status(_('bug %d does not exist\n') % id)
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	600 del bugs[id]
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	601
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	602 def filter_cset_known_bug_ids(self, node, bugs):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	603 for id in sorted(bugs.keys()):
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	604 if self.get_bug_comments(id).find(short(node)) != -1:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	605 self.ui.status(_('bug %d already knows about changeset %s\n') %
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	606 (id, short(node)))
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	607 del bugs[id]
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	608
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	609 def updatebug(self, bugid, newstate, text, committer):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	610 args = dict(id=bugid, comment=text)
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	611 self.bzproxy.Bug.add_comment(args)
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	612
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	613 class bzxmlrpcemail(bzxmlrpc):
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	614 """Read data from Bugzilla via XMLRPC, send updates via email.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	615
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	616 Advantages of sending updates via email:
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	617 1. Comments can be added as any user, not just logged in user.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	618 2. Bug statuses and other fields not accessible via XMLRPC can
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	619 be updated. This is not currently used.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	620 """
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	621
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	622 def __init__(self, ui):
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	623 bzxmlrpc.__init__(self, ui)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	624
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	625 self.bzemail = self.ui.config('bugzilla', 'bzemail')
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	626 if not self.bzemail:
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	627 raise util.Abort(_("configuration 'bzemail' missing"))
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	628 mail.validateconfig(self.ui)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	629
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	630 def send_bug_modify_email(self, bugid, commands, comment, committer):
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	631 '''send modification message to Bugzilla bug via email.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	632
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	633 The message format is documented in the Bugzilla email_in.pl
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	634 specification. commands is a list of command lines, comment is the
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	635 comment text.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	636
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	637 To stop users from crafting commit comments with
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	638 Bugzilla commands, specify the bug ID via the message body, rather
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	639 than the subject line, and leave a blank line after it.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	640 '''
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	641 user = self.map_committer(committer)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	642 matches = self.bzproxy.User.get(dict(match=[user]))
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	643 if not matches['users']:
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	644 user = self.ui.config('bugzilla', 'user', 'bugs')
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	645 matches = self.bzproxy.User.get(dict(match=[user]))
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	646 if not matches['users']:
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	647 raise util.Abort(_("default bugzilla user %s email not found") %
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	648 user)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	649 user = matches['users'][0]['email']
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	650
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	651 text = "\n".join(commands) + "\n@bug_id = %d\n\n" % bugid + comment
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	652
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	653 _charsets = mail._charsets(self.ui)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	654 user = mail.addressencode(self.ui, user, _charsets)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	655 bzemail = mail.addressencode(self.ui, self.bzemail, _charsets)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	656 msg = mail.mimeencode(self.ui, text, _charsets)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	657 msg['From'] = user
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	658 msg['To'] = bzemail
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	659 msg['Subject'] = mail.headencode(self.ui, "Bug modification", _charsets)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	660 sendmail = mail.connect(self.ui)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	661 sendmail(user, bzemail, msg.as_string())
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	662
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	663 def updatebug(self, bugid, newstate, text, committer):
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	664 self.send_bug_modify_email(bugid, [], text, committer)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	665
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	666 class bugzilla(object):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	667 # supported versions of bugzilla. different versions have
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	668 # different schemas.
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	669 _versions = {
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	670 '2.16': bzmysql,
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	671 '2.18': bzmysql_2_18,
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	672 '3.0': bzmysql_3_0,
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	673 'xmlrpc': bzxmlrpc,
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	674 'xmlrpc+email': bzxmlrpcemail
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	675 }
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	676
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	677 _default_bug_re = (r'bugs?\s,?\s(?:#\|nos?\.?\|num(?:ber)?s?)?\s*'
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	678 r'((?:\d+\s(?:,?\s(?:and)?)?\s*)+)')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	679
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	680 _bz = None
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	681
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	682 def __init__(self, ui, repo):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	683 self.ui = ui
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	684 self.repo = repo
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	685
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	686 def bz(self):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	687 '''return object that knows how to talk to bugzilla version in
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	688 use.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	689
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	690 if bugzilla._bz is None:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	691 bzversion = self.ui.config('bugzilla', 'version')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	692 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	693 bzclass = bugzilla._versions[bzversion]
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	694 except KeyError:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	695 raise util.Abort(_('bugzilla version %s not supported') %
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	696 bzversion)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	697 bugzilla._bz = bzclass(self.ui)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	698 return bugzilla._bz
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	699
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	700 def __getattr__(self, key):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	701 return getattr(self.bz(), key)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	702
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	703 _bug_re = None
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	704 _split_re = None
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	705
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	706 def find_bugs(self, ctx):
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	707 '''return bugs dictionary created from commit comment.
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	708
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	709 Extract bug info from changeset comments. Filter out any that are
13799 d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	710 not known to Bugzilla, and any that already have a reference to
d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	711 the given changeset in their comments.
d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	712 '''
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	713 if bugzilla._bug_re is None:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	714 bugzilla._bug_re = re.compile(
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	715 self.ui.config('bugzilla', 'regexp', bugzilla._default_bug_re),
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	716 re.IGNORECASE)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	717 bugzilla._split_re = re.compile(r'\D+')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	718 start = 0
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	719 bugs = {}
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	720 while True:
3976 f8849648b0e2 bugzilla: use contexts, simplify Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 3891 diff changeset	721 m = bugzilla._bug_re.search(ctx.description(), start)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	722 if not m:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	723 break
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	724 start = m.end()
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	725 for id in bugzilla._split_re.split(m.group(1)):
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	726 if not id:
08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	727 continue
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	728 bugs[int(id)] = {}
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	729 if bugs:
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	730 self.filter_real_bug_ids(bugs)
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	731 if bugs:
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	732 self.filter_cset_known_bug_ids(ctx.node(), bugs)
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	733 return bugs
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	734
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	735 def update(self, bugid, newstate, ctx):
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	736 '''update bugzilla bug with reference to changeset.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	737
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	738 def webroot(root):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	739 '''strip leading prefix of repo root and turn into
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	740 url-safe path.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	741 count = int(self.ui.config('bugzilla', 'strip', 0))
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	742 root = util.pconvert(root)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	743 while count > 0:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	744 c = root.find('/')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	745 if c == -1:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	746 break
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	747 root = root[c + 1:]
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	748 count -= 1
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	749 return root
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	750
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	751 mapfile = self.ui.config('bugzilla', 'style')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	752 tmpl = self.ui.config('bugzilla', 'template')
3741 0897bf8d54c7 update bugzilla extension to use ui buffers Matt Mackall <mpm@selenic.com> parents: 3643 diff changeset	753 t = cmdutil.changeset_templater(self.ui, self.repo,
7762 fece056bf240 add --git option to commands supporting --patch (log, incoming, history, tip) Jim Correia <jim.correia@pobox.com> parents: 7618 diff changeset	754 False, None, mapfile, False)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	755 if not mapfile and not tmpl:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	756 tmpl = _('changeset {node\|short} in repo {root} refers '
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	757 'to bug {bug}.\ndetails:\n\t{desc\|tabindent}')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	758 if tmpl:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	759 tmpl = templater.parsestring(tmpl, quoted=False)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	760 t.use_template(tmpl)
3741 0897bf8d54c7 update bugzilla extension to use ui buffers Matt Mackall <mpm@selenic.com> parents: 3643 diff changeset	761 self.ui.pushbuffer()
7369 87158be081b8 cmdutil: use change contexts for cset-printer and cset-templater Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 7280 diff changeset	762 t.show(ctx, changes=ctx.changeset(),
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	763 bug=str(bugid),
2197 5de8b44f0446 define standard name for base url to use when printing hgweb urls. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2192 diff changeset	764 hgweb=self.ui.config('web', 'baseurl'),
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	765 root=self.repo.root,
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	766 webroot=webroot(self.repo.root))
3741 0897bf8d54c7 update bugzilla extension to use ui buffers Matt Mackall <mpm@selenic.com> parents: 3643 diff changeset	767 data = self.ui.popbuffer()
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	768 self.updatebug(bugid, newstate, data, util.email(ctx.user()))
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	769
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	770 def hook(ui, repo, hooktype, node=None, **kwargs):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	771 '''add comment to bugzilla for each changeset that refers to a
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	772 bugzilla bug id. only add a comment once per bug, so same change
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	773 seen multiple times does not fill bug with duplicate data.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	774 if node is None:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	775 raise util.Abort(_('hook type %s does not pass a changeset id') %
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	776 hooktype)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	777 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	778 bz = bugzilla(ui, repo)
6747 f6c00b17387c use repo[changeid] to get a changectx Matt Mackall <mpm@selenic.com> parents: 6548 diff changeset	779 ctx = repo[node]
16221 4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	780 bugs = bz.find_bugs(ctx)
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	781 if bugs:
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	782 for bug in bugs:
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	783 bz.update(bug, bugs[bug], ctx)
4fc9fcd991c1 bugzilla: modify access interface to include new bug states Jim Hague <jim.hague@acm.org> parents: 16193 diff changeset	784 bz.notify(bugs, util.email(ctx.user()))
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	785 except Exception, e:
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	786 raise util.Abort(_('Bugzilla error: %s') % e)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	787

Mercurial > public > mercurial-scm > hg

annotate hgext/bugzilla.py @ 16221:4fc9fcd991c1