Add new bugzilla module

ChangeLog

@@ -1,3 +1,5 @@
+	* Added Bugzilla module
+	
 	* Changed the name of the "bug" command in the AdminCommands
 	plugin to "reportbug" instead.
 	

plugins/Bugzilla.py

@@ -0,0 +1,297 @@
+#!/usr/bin/env python
+
+###
+# Copyright (c) 2003, Daniel Berlin
+# Based on code from kibot
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+###
+"""
+Bugzilla bug retriever
+"""
+import urllib as _urllib
+import string as _string
+import xml.dom.minidom as _minidom
+import base64 as _base64
+import re as _re
+import os
+from htmlentitydefs import entitydefs as _entities
+
+import plugins
+
+import string
+
+import utils
+import privmsgs
+import callbacks
+import conf
+import sqlite
+
+dbfilename = os.path.join(conf.dataDir, 'Bugzilla.db')
+def makeDb(filename):
+    if os.path.exists(filename):
+        return sqlite.connect(filename)
+    db = sqlite.connect(filename)
+    cursor = db.cursor()
+    cursor.execute("""CREATE TABLE bugzillas (
+                      shorthand TEXT UNIQUE ON CONFLICT REPLACE,
+                      url TEXT,
+                      description TEXT
+                      )""")
+    cursor = db.cursor();
+    cursor.execute("""INSERT INTO bugzillas VALUES (%s, %s, %s)""",
+                    'rh', 'http://bugzilla.redhat.com/bugzilla', 'Red Hat')
+    cursor.execute("""INSERT INTO bugzillas VALUES (%s, %s, %s)""",
+                    'gnome', 'http://bugzilla.gnome.org', 'Gnome')
+    cursor.execute("""INSERT INTO bugzillas VALUES (%s, %s, %s)""",
+                    'xim', 'http://bugzilla.ximian.com', 'Ximian')
+    cursor.execute("""INSERT INTO bugzillas VALUES (%s, %s, %s)""",
+                    'moz', 'http://bugzilla.mozilla.org', 'Mozilla')
+    cursor.execute("""INSERT INTO bugzillas VALUES (%s, %s, %s)""",
+                    'gcc', 'http://gcc.gnu.org/bugzilla', 'GCC')
+    db.commit()
+    return db
+
+class BugError(Exception):
+    """A bugzilla error"""
+    def __init__(self, args = None):
+        Exception.__init__(self)
+        self.args = args
+
+def configure(onStart, afterConnect, advanced):
+    from questions import expect, anything, yn
+    onStart.append('load Bugzilla')
+
+class Bugzilla(callbacks.Privmsg):
+    """Show a link to a bug report with a brief description"""
+    threaded = True
+    def __init__(self):
+        callbacks.Privmsg.__init__(self)
+        self.entre = _re.compile('&(\S*?);')
+        self.db = makeDb(dbfilename)
+
+    def die(self):
+        self.db.close()
+        del self.db
+        # quick hack for testing only
+        import sys
+        global _base64, _minidom
+        del _base64
+        del _minidom
+        for mod in ['xml.dom.minidom', 'base64']:
+            if sys.modules.has_key(mod):
+                del sys.modules[mod]
+        import gc
+        gc.collect()
+
+    def addzilla(self, irc, msg, args):
+        """shorthand url description
+        Add a bugzilla to the list of defined bugzillae.
+        E.g.: addzilla rh http://bugzilla.redhat.com/bugzilla Red Hat Zilla"""
+        try:
+            words = args
+            shorthand = words.pop(0)
+            url = words.pop(0)
+            description = ' '.join(words)
+        except:
+            irc.reply(msg, 'Invalid format, please see help addzilla')
+            return
+        cursor = self.db.cursor()
+        cursor.execute("""INSERT INTO bugzillas VALUES (%s, %s, %s)""",
+                    shorthand, url, description)
+        self.db.commit()
+        irc.reply(msg, 'Added bugzilla entry for "%s" with shorthand "%s"' % (
+            description, shorthand))
+        return
+
+    def delzilla(self, irc, msg, args):
+        """shorthand
+        Delete a bugzilla from the list of define bugzillae.
+        E.g.: delzilla rh"""
+        shorthand = ' '.join(args)
+        cursor = self.db.cursor()
+        cursor.execute("""SELECT * from bugzillas where shorthand = %s""", shorthand)
+        if cursor.rowcount == 0:
+            irc.reply(msg, 'Bugzilla "%s" not defined. Try zillalist.' % shorthand)
+            return
+        cursor.execute("""DELETE FROM bugzillas where shorthand = %s""", shorthand)
+        self.db.commit()
+        irc.reply(msg, 'Deleted bugzilla "%s"' % shorthand)
+        return
+
+    def listzilla(self, irc,  msg, args):
+        """[shorthand]
+        List defined bugzillae
+        E.g.: listzilla rh; or just listzilla"""
+        shorthand = ' '.join(args)
+        if shorthand:
+            cursor = self.db.cursor()
+            cursor.execute("""SELECT url,description from bugzillas where shorthand = %s""", shorthand)
+            if cursor.rowcount == 0:
+                irc.reply(msg, 'No such bugzilla defined: "%s".' % shorthand)
+                return
+            url, description = cursor.fetchone()
+            irc.reply(msg, '%s: %s, %s' % (shorthand, description, url))
+            return
+        else:
+            cursor = self.db.cursor()
+            cursor.execute("""SELECT shorthand from bugzillas""")
+            if cursor.rowcount == 0:
+                irc.reply(msg, 'No bugzillae defined. Add some with "addzilla"!')
+                return
+            results = ['%s' % (item[0]) for item in cursor.fetchall()]
+            irc.reply(msg, 'Defined bugzillae: %s' % ' '.join(results))
+            return    
+
+    def bug(self, irc, msg, args):
+        """bug shorthand number
+        Look up a bug number in a bugzilla.
+        E.g.: bug rh 10301"""
+        try: shorthand, num = args
+        except:
+            irc.reply(msg, 'Invalid format. Try help bug')
+            return
+        cursor = self.db.cursor()
+        cursor.execute("""SELECT url,description from bugzillas where shorthand = %s""", shorthand)
+        if cursor.rowcount == 0:
+            irc.reply(msg, 'Bugzilla "%s" is not defined.' % shorthand)
+            return
+        if not self._is_bug_number(num):
+            irc.reply(msg, '"%s" does not seem to be a number' % num)
+            return
+        url, desc = cursor.fetchone()
+        queryurl = '%s/xml.cgi?id=%s' % (url, num)
+        try:
+            summary = self._get_short_bug_summary(queryurl, desc, num)
+        except BugError, e:
+            irc.reply(msg, str(e))
+            return
+        except IOError, e:
+            msgtouser = '%s. Try yourself: %s' % (e, queryurl)
+            irc.reply(msg, msgtouser)
+            return
+
+        report = {}
+        report['zilla'] = str(desc)
+        report['id'] = str(num)
+        report['url'] = str('%s/show_bug.cgi?id=%s' % (url, num))
+        report['title'] = str(summary['title'])
+        report['summary'] = str(self._mk_component_severity_status(summary))
+        irc.reply(msg, '%(zilla)s bug #%(id)s: %(title)s' % report)
+        irc.reply(msg, '  %(summary)s' % report)
+        irc.reply(msg, '  %(url)s' % report)
+        return
+
+    def _mk_component_severity_status(self, summary):
+        ary = []
+        if summary.has_key('component'):
+            ary.append('Component: %s' % summary['component'])
+        if summary.has_key('severity'):
+            ary.append('Severity: %s' % summary['severity'])
+        if summary.has_key('status'):
+            if summary.has_key('resolution'):
+                ary.append('Status: %s/%s' %
+                           (summary['status'], summary['resolution']))
+            else:
+                ary.append('Status: %s' % summary['status'])
+        out = _string.join(ary, ', ')
+        return out
+
+    def _is_bug_number(self, bug):
+        try: int(bug)
+        except: return 0
+        else: return 1
+        
+    def _get_short_bug_summary(self, url, desc, num):
+        bugxml = self._getbugxml(url, desc)
+        try: zilladom = _minidom.parseString(bugxml)
+        except Exception, e:
+            msg = 'Could not parse XML returned by %s bugzilla: %s'
+            raise BugError(str(msg % (desc, e)))
+        bug_n = zilladom.getElementsByTagName('bug')[0]
+        if bug_n.hasAttribute('error'):
+            errtxt = bug_n.getAttribute('error')
+            zilladom.unlink()
+            msg = 'Error getting %s bug #%s: %s' % (desc, num, errtxt)
+            raise BugError(str(msg))
+        summary = {}
+        try:
+            node = bug_n.getElementsByTagName('short_desc')[0]
+            summary['title'] = self._getnodetxt(node)
+            node = bug_n.getElementsByTagName('bug_status')[0]
+            summary['status'] = self._getnodetxt(node)
+            try:
+                node = bug_n.getElementsByTagName('resolution')[0]
+                summary['resolution'] = self._getnodetxt(node)
+            except:
+                pass
+            node = bug_n.getElementsByTagName('component')[0]
+            summary['component'] = self._getnodetxt(node)
+            node = bug_n.getElementsByTagName('bug_severity')[0]
+            summary['severity'] = self._getnodetxt(node)
+        except Exception, e:
+            zilladom.unlink()
+            msg = 'Could not parse XML returned by %s bugzilla: %s'
+            raise BugError(str(msg % (desc, e)))
+        zilladom.unlink()
+        return summary
+
+    def _getbugxml(self, url, desc):
+        try: fh = _urllib.urlopen(url)
+        except: raise IOError('Connection to %s bugzilla failed' % desc)
+        bugxml = ''
+        while 1:
+            chunk = fh.read(8192)
+            if chunk == '':
+                break
+            bugxml = bugxml + chunk
+        fh.close()
+        if not len(bugxml):
+            msg = 'Error getting bug content from %s' % desc
+            raise IOError(msg)
+        return bugxml
+
+    def _getnodetxt(self, node):
+        val = ''
+        for childnode in node.childNodes:
+            if childnode.nodeType == childnode.TEXT_NODE:
+                val = val + childnode.data
+        if node.hasAttribute('encoding'):
+            encoding = node.getAttribute('encoding')
+            if encoding == 'base64':
+                try:
+                    val = _base64.decodestring(val)
+                except:
+                    val = 'Cannot convert bug data from base64!'
+        entre = self.entre
+        while entre.search(val):
+            entity = entre.search(val).group(1)
+            if _entities.has_key(entity):
+                val = _re.sub(entre, _entities[entity], val)
+            else:
+                val = _re.sub(entre, '_', val)
+        return val
+Class = Bugzilla

test/test_Bugzilla.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+###
+# Copyright (c) 2003, Daniel Berlin
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions, and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions, and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#   * Neither the name of the author of this software nor the name of
+#     contributors to this software may be used to endorse or promote products
+#     derived from this software without specific prior written consent.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+###
+
+from test import *
+
+class BugzillaTest(PluginTestCase, PluginDocumentation):
+    plugins = ('Bugzilla',)
+    def testBugzilla(self):
+        self.assertNotError('bug gcc 5')
+# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
+