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

annotate hgext/bugzilla.py @ 13832:9358fdeaa532

bugzilla: fix reStructuredText errors introduced in 60256f7f30c1

author	Martin Geisler <mg@aragost.com>
date	Fri, 01 Apr 2011 11:59:18 +0200
parents	49b5a1aaf726
children	64ad07dff0a8

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>
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	4 # Copyright 2011 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
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	24 2. Writing directly to the Bugzilla database. Only Bugzilla installations
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
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	43 Access via XMLRPC/email behaves uses XMLRPC to query Bugzilla, but sends
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
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	48 user, the Bugzilla username and password used to log into Bugzilla are
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	49 used instead as the source of the comment.
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
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	53 [bugzilla]
13832 9358fdeaa532 bugzilla: fix reStructuredText errors introduced in 60256f7f30c1 Martin Geisler <mg@aragost.com> parents: 13802 diff changeset	54
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	55 version
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	56 This access type to use. Values recognised are:
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	57 xmlrpc Bugzilla XMLRPC interface.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	58 xmlrpc+email Bugzilla XMLRPC and email interfaces.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	59 3.0 MySQL access, Bugzilla 3.0 and later.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	60 2.18 MySQL access, Bugzilla 2.18 and up to but not including 3.0.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	61 2.16 MySQL access, Bugzilla 2.16 and up to but not including 2.18.
7985 0edca606c0f1 bugzilla: word-wrap help texts at 70 characters Martin Geisler <mg@daimi.au.dk> parents: 7762 diff changeset	62
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	63 regexp
9252 b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	64 Regular expression to match bug IDs in changeset commit message.
b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	65 Must contain one "()" group. The default expression matches 'Bug
b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	66 1234', 'Bug no. 1234', 'Bug number 1234', 'Bugs 1234,5678', 'Bug
b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	67 1234 and 5678' and variations thereof. Matching is case insensitive.
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	68
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	69 style
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	70 The style file to use when formatting comments.
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	71
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	72 template
9252 b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	73 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	74 specified. In addition to the usual Mercurial keywords, the
b03aa86f4c10 bugzilla: wrap docstrings at 70 characters Martin Geisler <mg@lazybytes.net> parents: 9204 diff changeset	75 extension specifies::
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	76
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	77 {bug} The Bugzilla bug ID.
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	78 {root} The full pathname of the Mercurial repository.
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	79 {webroot} Stripped pathname of the Mercurial repository.
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	80 {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	81
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	82 Default 'changeset {node\|short} in repo {root} refers '
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	83 'to bug {bug}.\\ndetails:\\n\\t{desc\|tabindent}'
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	84
e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	85 strip
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	86 The number of path separator characters to strip from the front of the
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	87 Mercurial repository path ('{root}' in templates) to produce '{webroot}'.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	88 For example, a repository with '{root}' '/var/local/my-project' with a
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	89 strip of 2 gives a value for '{webroot}' of 'my-project'. Default 0.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	90
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	91 [web]
13832 9358fdeaa532 bugzilla: fix reStructuredText errors introduced in 60256f7f30c1 Martin Geisler <mg@aragost.com> parents: 13802 diff changeset	92
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	93 baseurl
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	94 Base URL for browsing Mercurial repositories. Referenced from
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	95 templates as {hgweb}.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	96
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	97 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	98
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	99 usermap
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	100 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	101 mappings. If specified, the file should contain one mapping per
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	102 line, "committer"="Bugzilla user". See also the [usermap] section.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	103
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	104 [usermap]
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	105 The [usermap] section is used to specify mappings of Mercurial
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	106 committer email to Bugzilla user email. See also [bugzilla].usermap.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	107 Contains entries of the form "committer"="Bugzilla user".
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	108
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	109 XMLRPC access mode configuration:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	110
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	111 [bugzilla]
13832 9358fdeaa532 bugzilla: fix reStructuredText errors introduced in 60256f7f30c1 Martin Geisler <mg@aragost.com> parents: 13802 diff changeset	112
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	113 bzurl
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	114 The base URL for the Bugzilla installation.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	115 Default 'http://localhost/bugzilla'.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	116
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	117 user
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	118 The username to use to log into Bugzilla via XMLRPC. Default 'bugs'.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	119
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	120 password
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	121 The password for Bugzilla login.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	122
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	123 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	124 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	125
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	126 [bugzilla]
13832 9358fdeaa532 bugzilla: fix reStructuredText errors introduced in 60256f7f30c1 Martin Geisler <mg@aragost.com> parents: 13802 diff changeset	127
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	128 bzemail
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	129 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	130
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	131 In addition, the Mercurial email settings must be configured. See the
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	132 documentation for 'hgrc', sections '[email]' and '[smtp]'.
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	133
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	134 MySQL access mode configuration:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	135
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	136 [bugzilla]
13832 9358fdeaa532 bugzilla: fix reStructuredText errors introduced in 60256f7f30c1 Martin Geisler <mg@aragost.com> parents: 13802 diff changeset	137
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	138 host
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	139 Hostname of the MySQL server holding the Bugzilla database.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	140 Default 'localhost'.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	141
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	142 db
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	143 Name of the Bugzilla database in MySQL. Default 'bugs'.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	144
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	145 user
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	146 Username to use to access MySQL server. Default 'bugs'.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	147
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	148 password
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	149 Password to use to access MySQL server.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	150
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	151 timeout
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	152 Database connection timeout (seconds). Default 5.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	153
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	154 bzuser
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	155 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	156 committer cannot be found as a Bugzilla user.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	157
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	158 bzdir
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	159 Bugzilla install directory. Used by default notify. Default
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	160 '/var/www/html/bugzilla'.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	161
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	162 notify
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	163 The command to run to get Bugzilla to send bug change notification
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	164 emails. Substitutes from a map with 3 keys, 'bzdir', 'id' (bug id)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	165 and 'user' (committer bugzilla email). Default depends on version;
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	166 from 2.18 it is "cd %(bzdir)s && perl -T contrib/sendbugmail.pl
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	167 %(id)s %(user)s".
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	168
9203 e4dbd49b88a9 bugzilla: reformat list of configuration options Martin Geisler <mg@lazybytes.net> parents: 9054 diff changeset	169 Activating the extension::
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	170
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	171 [extensions]
10112 703db37d186b hgext: enable extensions without "hgext." prefix in help texts Martin Geisler <mg@lazybytes.net> parents: 9252 diff changeset	172 bugzilla =
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	173
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	174 [hooks]
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	175 # 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	176 incoming.bugzilla = python:hgext.bugzilla.hook
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	177
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	178 Example configurations:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	179
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	180 XMLRPC example configuration. This uses the Bugzilla at
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	181 'http://my-project.org/bugzilla', logging in as user 'bugmail@my-project.org'
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	182 wityh password 'plugh'. It is used with a collection of Mercurial
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	183 repositories in '/var/local/hg/repos/'. ::
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
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	190
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	191 [web]
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	192 baseurl=http://my-project.org/hg
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	193
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	194 XMLRPC+email example configuration. This uses the Bugzilla at
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	195 'http://my-project.org/bugzilla', logging in as 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	196 wityh password 'plugh'. It is used with a collection of Mercurial
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	197 repositories in '/var/local/hg/repos/'. Bug comments are sent to the
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	198 Bugzilla email address 'buzilla@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	199
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	200 [bugzilla]
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	201 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	202 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	203 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	204 bzemail=bugzilla@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	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 [web]
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	207 baseurl=https://dev.laicatc.com/hg
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	208 bugzillaurl=https://dev.laicatc.com/bugzilla
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	209
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	210 MySQL example configuration. This is for a collection of Mercurial
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	211 repositories in '/var/local/hg/repos/' used with a local Bugzilla 3.2
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	212 installation in /opt/bugzilla-3.2. The MySQL database is on 'localhost',
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	213 the Bugzilla database name is 'bugs' and MySQL is accessed with MySQL
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	214 username 'bugs' password 'XYZZY'. ::
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	215
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	216 [bugzilla]
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	217 host=localhost
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	218 password=XYZZY
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	219 version=3.0
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	220 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	221 bzdir=/opt/bugzilla-3.2
9204 8d59e43854d9 bugzilla: wrap example template line Martin Geisler <mg@lazybytes.net> parents: 9203 diff changeset	222 template=Changeset {node\|short} in {root\|basename}.
8d59e43854d9 bugzilla: wrap example template line Martin Geisler <mg@lazybytes.net> parents: 9203 diff changeset	223 {hgweb}/{webroot}/rev/{node\|short}\\n
8d59e43854d9 bugzilla: wrap example template line Martin Geisler <mg@lazybytes.net> parents: 9203 diff changeset	224 {desc}\\n
7504 d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	225 strip=5
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	226
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	227 [web]
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	228 baseurl=http://dev.domain.com/hg
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 [usermap]
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	231 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	232
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	233 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	234
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	235 Changeset 3b16791d6642 in repository-name.
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	236 http://dev.domain.com/hg/repository-name/rev/3b16791d6642
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	237
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	238 Changeset commit comment. Bug 1234.
d8cd79fbed3c Revise Bugzilla module comments into extension help. Jim Hague <jim.hague@acm.org> parents: 7493 diff changeset	239 '''
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	240
3891 6b4127c7d52a Simplify i18n imports Matt Mackall <mpm@selenic.com> parents: 3877 diff changeset	241 from mercurial.i18n import _
6211 f89fd07fc51d Expand import * to allow Pyflakes to find problems Joel Rosdahl <joel@rosdahl.net> parents: 5975 diff changeset	242 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	243 from mercurial import cmdutil, mail, templater, util
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	244 import re, time, xmlrpclib
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	245
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	246 class bzaccess(object):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	247 '''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	248
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	249 def __init__(self, ui):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	250 self.ui = ui
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	251 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	252 if usermap:
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	253 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	254
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	255 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	256 '''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	257 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	258 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	259 return bzuser
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	260 return user
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	261
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	262 # Methods to be implemented by access classes.
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	263 def filter_real_bug_ids(self, ids):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	264 '''remove bug IDs that do not exist in Bugzilla from set.'''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	265 pass
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	266
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	267 def filter_cset_known_bug_ids(self, node, ids):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	268 '''remove bug IDs where node occurs in comment text from set.'''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	269 pass
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	270
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	271 def add_comment(self, bugid, text, committer):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	272 '''add comment to bug.
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	273
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	274 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	275 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	276 '''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	277 pass
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	278
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	279 def notify(self, ids, committer):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	280 '''Force sending of Bugzilla notification emails.'''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	281 pass
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	282
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	283 # 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	284 class bzmysql(bzaccess):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	285 '''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	286
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	287 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	288
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	289 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	290 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	291 '''
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	292
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	293 @staticmethod
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	294 def sql_buglist(ids):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	295 '''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	296 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	297
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	298 _MySQLdb = None
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	299
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	300 def __init__(self, ui):
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	301 try:
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	302 import MySQLdb as mysql
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	303 bzmysql._MySQLdb = mysql
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	304 except ImportError, err:
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	305 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	306
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	307 bzaccess.__init__(self, ui)
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	308
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	309 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	310 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	311 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	312 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	313 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	314 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	315 (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	316 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	317 user=user, passwd=passwd,
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	318 db=db,
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	319 connect_timeout=timeout)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	320 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	321 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	322 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	323 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	324
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	325 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	326 '''run a query.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	327 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	328 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	329 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	330 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	331 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	332 raise
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	333
7019 6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	334 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	335 '''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	336 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	337 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	338 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	339 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	340 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	341
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	342 def filter_real_bug_ids(self, ids):
13799 d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	343 '''filter not-existing bug ids from set.'''
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	344 self.run('select bug_id from bugs where bug_id in %s' %
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	345 bzmysql.sql_buglist(ids))
13799 d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	346 return set([c[0] for c in self.cursor.fetchall()])
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	347
13798 9c9fa78f4e2d bugzilla: rename filter_unknown_bug_ids to reflect its actual purpose. Jim Hague <jim.hague@acm.org> parents: 11567 diff changeset	348 def filter_cset_known_bug_ids(self, node, ids):
13799 d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	349 '''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	350
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	351 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	352 bug_id in %s and thetext like "%%%s%%"''' %
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	353 (bzmysql.sql_buglist(ids), short(node)))
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	354 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	355 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	356 (id, short(node)))
13799 d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	357 ids.discard(id)
d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	358 return ids
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	359
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	360 def notify(self, ids, committer):
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	361 '''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	362
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	363 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	364 (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	365 for id in ids:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	366 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	367 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	368 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	369 try:
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	370 # 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	371 # 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	372 # string.
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	373 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	374 except TypeError:
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	375 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	376 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	377 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	378 out = fp.read()
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	379 ret = fp.close()
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	380 if ret:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	381 self.ui.warn(out)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	382 raise util.Abort(_('bugzilla notify command %s') %
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	383 util.explain_exit(ret)[0])
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	384 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	385
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	386 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	387 '''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	388 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	389 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	390 except KeyError:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	391 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	392 userid = int(user)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	393 except ValueError:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	394 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	395 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	396 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	397 all = self.cursor.fetchall()
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	398 if len(all) != 1:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	399 raise KeyError(user)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	400 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	401 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	402 return userid
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	403
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	404 def get_bugzilla_user(self, committer):
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	405 '''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	406 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	407 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	408 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	409 try:
2306 4c67ba93560b bugzilla: allow to map between committer email and bugzilla user name. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2239 diff changeset	410 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	411 except KeyError:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	412 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	413 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	414 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	415 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	416 user)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	417 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	418 user = defaultuser
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	419 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	420 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	421 (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	422 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	423
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	424 def add_comment(self, bugid, text, committer):
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	425 '''add comment to bug. try adding comment as committer of
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	426 changeset, otherwise as default bugzilla user.'''
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	427 (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	428 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	429 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	430 (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	431 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	432 (bugid, userid, now, text))
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	433 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	434 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	435 (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	436 self.conn.commit()
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	437
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	438 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	439 '''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	440
6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	441 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	442 bzmysql.__init__(self, ui)
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	443 self.default_notify = \
08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	444 "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	445
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	446 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	447 '''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	448
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	449 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	450 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	451
6b1ece890f9a Add support for Bugzilla 3.0 series to bugzilla hook. Jim Hague <jim.hague@acm.org> parents: 6762 diff changeset	452 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	453 '''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	454 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	455 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	456 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	457 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	458 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	459
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	460 # Buzgilla via XMLRPC interface.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	461
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	462 class CookieSafeTransport(xmlrpclib.SafeTransport):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	463 """A SafeTransport that retains cookies over its lifetime.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	464
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	465 The regular xmlrpclib transports ignore cookies. Which causes
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	466 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	467 the Bugzilla XMLRPC interface.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	468
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	469 So this is a SafeTransport which looks for cookies being set
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	470 in responses and saves them to add to all future requests.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	471 It appears a SafeTransport can do both HTTP and HTTPS sessions,
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	472 which saves us having to do a CookieTransport too.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	473 """
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	474
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	475 # Inspiration drawn from
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	476 # 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	477 # 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	478
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	479 cookies = []
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	480 def send_cookies(self, connection):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	481 if self.cookies:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	482 for cookie in self.cookies:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	483 connection.putheader("Cookie", cookie)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	484
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	485 def request(self, host, handler, request_body, verbose=0):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	486 self.verbose = verbose
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	487
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	488 # issue XML-RPC request
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	489 h = self.make_connection(host)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	490 if verbose:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	491 h.set_debuglevel(1)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	492
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	493 self.send_request(h, handler, request_body)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	494 self.send_host(h, host)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	495 self.send_cookies(h)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	496 self.send_user_agent(h)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	497 self.send_content(h, request_body)
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 # 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	500 # 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	501 # 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	502 # 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	503 # that and use it.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	504 try:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	505 response = h.getresponse()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	506 except AttributeError:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	507 response = h._conn.getresponse()
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 # Add any cookie definitions to our list.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	510 for header in response.msg.getallmatchingheaders("Set-Cookie"):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	511 val = header.split(": ", 1)[1]
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	512 cookie = val.split(";", 1)[0]
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	513 self.cookies.append(cookie)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	514
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	515 if response.status != 200:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	516 raise xmlrpclib.ProtocolError(host + handler, response.status,
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	517 response.reason, response.msg.headers)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	518
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	519 payload = response.read()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	520 parser, unmarshaller = self.getparser()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	521 parser.feed(payload)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	522 parser.close()
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 return unmarshaller.close()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	525
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	526 class bzxmlrpc(bzaccess):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	527 """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	528
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	529 Requires a minimum Bugzilla version 3.4.
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	530 """
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	531
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	532 def __init__(self, ui):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	533 bzaccess.__init__(self, ui)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	534
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	535 bzweb = self.ui.config('bugzilla', 'bzurl',
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	536 'http://localhost/bugzilla/')
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	537 bzweb = bzweb.rstrip("/") + "/xmlrpc.cgi"
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	538
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	539 user = self.ui.config('bugzilla', 'user', 'bugs')
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	540 passwd = self.ui.config('bugzilla', 'password')
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	541
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	542 self.bzproxy = xmlrpclib.ServerProxy(bzweb, CookieSafeTransport())
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	543 self.bzproxy.User.login(dict(login=user, password=passwd))
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	544
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	545 def get_bug_comments(self, id):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	546 """Return a string with all comment text for a bug."""
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	547 c = self.bzproxy.Bug.comments(dict(ids=[id]))
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	548 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	549
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	550 def filter_real_bug_ids(self, ids):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	551 res = set()
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	552 bugs = self.bzproxy.Bug.get(dict(ids=sorted(ids), permissive=True))
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	553 for bug in bugs['bugs']:
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	554 res.add(bug['id'])
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	555 return res
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	556
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	557 def filter_cset_known_bug_ids(self, node, ids):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	558 for id in sorted(ids):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	559 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	560 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	561 (id, short(node)))
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	562 ids.discard(id)
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	563 return ids
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	564
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	565 def add_comment(self, bugid, text, committer):
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	566 self.bzproxy.Bug.add_comment(dict(id=bugid, comment=text))
60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	567
13802 49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	568 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	569 """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	570
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	571 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	572 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	573 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	574 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	575 """
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	576
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	577 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	578 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	579
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	580 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	581 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	582 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	583 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	584
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	585 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	586 '''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	587
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	588 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	589 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	590 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	591
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	592 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	593 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	594 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	595 '''
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	596 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	597 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	598 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	599 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	600 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	601 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	602 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	603 user)
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	604 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	605
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	606 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	607
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	608 _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	609 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	610 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	611 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	612 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	613 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	614 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	615 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	616 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	617
49b5a1aaf726 bugzilla: add modified XMLRPC mode that uses email to send bug comments. Jim Hague <jim.hague@acm.org> parents: 13801 diff changeset	618 def add_comment(self, 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	619 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	620
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	621 class bugzilla(object):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	622 # 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	623 # different schemas.
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	624 _versions = {
13800 c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	625 '2.16': bzmysql,
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	626 '2.18': bzmysql_2_18,
13801 60256f7f30c1 bugzilla: add XMLRPC interface. Jim Hague <jim.hague@acm.org> parents: 13800 diff changeset	627 '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	628 '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	629 'xmlrpc+email': bzxmlrpcemail
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	630 }
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	631
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	632 _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	633 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	634
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	635 _bz = None
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	636
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	637 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	638 self.ui = ui
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	639 self.repo = repo
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	640
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	641 def bz(self):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	642 '''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	643 use.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	644
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	645 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	646 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	647 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	648 bzclass = bugzilla._versions[bzversion]
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	649 except KeyError:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	650 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	651 bzversion)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	652 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	653 return bugzilla._bz
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	654
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	655 def __getattr__(self, key):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	656 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	657
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	658 _bug_re = None
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	659 _split_re = None
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	660
3976 f8849648b0e2 bugzilla: use contexts, simplify Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 3891 diff changeset	661 def find_bug_ids(self, ctx):
13799 d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	662 '''return set of integer bug IDs from commit comment.
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	663
13799 d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	664 Extract bug IDs from changeset comments. Filter out any that are
d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	665 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	666 the given changeset in their comments.
d04fc5582772 bugzilla: keep bug IDs in set. Jim Hague <jim.hague@acm.org> parents: 13798 diff changeset	667 '''
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	668 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	669 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	670 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	671 re.IGNORECASE)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	672 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	673 start = 0
8455 a858b54d072b bugzilla: use set instead of dict Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 8225 diff changeset	674 ids = set()
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	675 while True:
3976 f8849648b0e2 bugzilla: use contexts, simplify Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 3891 diff changeset	676 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	677 if not m:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	678 break
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	679 start = m.end()
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	680 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	681 if not id:
08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	682 continue
8455 a858b54d072b bugzilla: use set instead of dict Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 8225 diff changeset	683 ids.add(int(id))
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	684 if ids:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	685 ids = self.filter_real_bug_ids(ids)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	686 if ids:
13798 9c9fa78f4e2d bugzilla: rename filter_unknown_bug_ids to reflect its actual purpose. Jim Hague <jim.hague@acm.org> parents: 11567 diff changeset	687 ids = self.filter_cset_known_bug_ids(ctx.node(), ids)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	688 return ids
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	689
3976 f8849648b0e2 bugzilla: use contexts, simplify Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 3891 diff changeset	690 def update(self, bugid, ctx):
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	691 '''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	692
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	693 def webroot(root):
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	694 '''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	695 url-safe path.'''
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	696 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	697 root = util.pconvert(root)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	698 while count > 0:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	699 c = root.find('/')
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	700 if c == -1:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	701 break
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	702 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	703 count -= 1
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	704 return root
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	705
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	706 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	707 tmpl = self.ui.config('bugzilla', 'template')
3741 0897bf8d54c7 update bugzilla extension to use ui buffers Matt Mackall <mpm@selenic.com> parents: 3643 diff changeset	708 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	709 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	710 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	711 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	712 '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	713 if tmpl:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	714 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	715 t.use_template(tmpl)
3741 0897bf8d54c7 update bugzilla extension to use ui buffers Matt Mackall <mpm@selenic.com> parents: 3643 diff changeset	716 self.ui.pushbuffer()
7369 87158be081b8 cmdutil: use change contexts for cset-printer and cset-templater Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 7280 diff changeset	717 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	718 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	719 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	720 root=self.repo.root,
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	721 webroot=webroot(self.repo.root))
3741 0897bf8d54c7 update bugzilla extension to use ui buffers Matt Mackall <mpm@selenic.com> parents: 3643 diff changeset	722 data = self.ui.popbuffer()
5975 75d9fe70c654 templater: move email function to util Matt Mackall <mpm@selenic.com> parents: 4431 diff changeset	723 self.add_comment(bugid, 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	724
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	725 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	726 '''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	727 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	728 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	729 if node is None:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	730 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	731 hooktype)
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	732 try:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	733 bz = bugzilla(ui, repo)
6747 f6c00b17387c use repo[changeid] to get a changectx Matt Mackall <mpm@selenic.com> parents: 6548 diff changeset	734 ctx = repo[node]
3976 f8849648b0e2 bugzilla: use contexts, simplify Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 3891 diff changeset	735 ids = bz.find_bug_ids(ctx)
2192 2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	736 if ids:
2be3ac7abc21 add bugzilla integration hook. example of writing hook in python. Vadim Gelfer <vadim.gelfer@gmail.com> parents: diff changeset	737 for id in ids:
3976 f8849648b0e2 bugzilla: use contexts, simplify Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 3891 diff changeset	738 bz.update(id, ctx)
7618 6c89dd0a7797 Bugzilla 2.18 and on use contrib/sendbugmail.pl, not processmail. Jim Hague <jim.hague@acm.org> parents: 7504 diff changeset	739 bz.notify(ids, 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	740 except Exception, e:
c2ef8159dabe bugzilla: localise all MySQL direct access inside access class. Jim Hague <jim.hague@acm.org> parents: 13799 diff changeset	741 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	742

Mercurial > public > mercurial-scm > hg

annotate hgext/bugzilla.py @ 13832:9358fdeaa532