Merged be.restructure, major internal reorganization.

Added a bunch of classes to make the commands, user interfaces, and
storage backends more abstract and distinct.  This should make it much
easier to extend and maintain BE.

Features:
 * Directory restructured:
   becommands/ -> libbe/commands
   submods sorted by functionality.
 * Lots of new classes:
   Option, Argument, Command
   InputOutput, StorageCallbacks, UserInterface
   Storage
 * Consolidated ID handling in libbe.util.id
 * Transitioned VCS backends for Python-based VCSs from subprocess
   calss to internal python calls.

Plus the user-visible changes:
 * New bugdir/bug/comment ID format replaces old bug:comment format.
 * Deprecated support for `be diff` on Arch and Darcs <= 2.3.1.  A new
   backend abstraction (Storage) makes the former implementation
   ungainly.
 * Improved command completion.
 * Removed commands close, open, email_bugs, 
 * Flipped some arguments
   `be assign BUG-ID [ASSIGNEE]` -> `be status ASSIGNED BUG-ID ...`
   `be severity BUG-ID SEVERITY` -> `be severity SEVERITY BUG-ID ...`
   `be status BUG-ID STATUS` -> `be status STATUS BUG-ID ...`

In the merge:
  * Added 'commit' to list of pagerless commands.
  * Updated doc/README.dev

See
#bea86499-824e-4e77-b085-2d581fa9ccab/1100c966-9671-4bc6-8b68-6d408a910da1#
for a discussion of why the changes were made and some of the
difficulties en-route.

1 files changed, 154 insertions, 0 deletions

diff --git a/misc/xml/be-mbox-to-xml b/misc/xml/be-mbox-to-xml
new file mode 100755
index 0000000..eda6d6e
--- /dev/null
+++ b/misc/xml/be-mbox-to-xml
@@ -0,0 +1,154 @@
+#!/usr/bin/env python
+# Copyright (C) 2009 W. Trevor King <wking@drexel.edu>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+"""
+Convert an mbox into xml suitable for input into be.
+  $ be-mbox-to-xml file.mbox | be import-xml -c <ID> -
+mbox is a flat-file format, consisting of a series of messages.
+Messages begin with a a From_ line, followed by RFC 822 email,
+followed by a blank line.
+"""
+
+import base64
+import email.utils
+from libbe.encoding import get_encoding, set_IO_stream_encodings
+from libbe.utility import time_to_str
+from mailbox import mbox, Message  # the mailbox people really want an on-disk copy
+from time import asctime, gmtime, mktime
+import types
+from xml.sax.saxutils import escape
+
+DEFAULT_ENCODING = get_encoding()
+set_IO_stream_encodings(DEFAULT_ENCODING)
+
+KNOWN_IDS = []
+
+def normalize_email_address(address):
+    """
+    Standardize whitespace, etc.
+    """
+    addr = email.utils.formataddr(email.utils.parseaddr(address))
+    if len(addr) == 0:
+        return None
+    return addr
+
+def normalize_RFC_2822_date(date):
+    """
+    Some email clients write non-RFC 2822-compliant date tags like:
+      Fri, 18 Sep 2009 08:49:02 -0400 (EDT)
+    with the non-standard (EDT) timezone name.  This funtion attempts
+    to deal with such inconsistencies.
+    """
+    time_tuple = email.utils.parsedate(date)
+    assert time_tuple != None, \
+        'unparsable date: "%s"' % date
+    return time_to_str(mktime(time_tuple))
+
+def comment_message_to_xml(message, fields=None):
+    if fields == None:
+        fields = {}
+    new_fields = {}
+    new_fields[u'alt-id'] = message[u'message-id']
+    new_fields[u'in-reply-to'] = message[u'in-reply-to']
+    new_fields[u'author'] = normalize_email_address(message[u'from'])
+    new_fields[u'date'] = message[u'date']
+    if new_fields[u'date'] != None:
+        new_fields[u'date'] = normalize_RFC_2822_date(new_fields[u'date'])
+    new_fields[u'content-type'] = message.get_content_type()
+    for k,v in new_fields.items():
+        if v != None and type(v) != types.UnicodeType:
+            fields[k] = unicode(v, encoding=DEFAULT_ENCODING)
+        elif v == None and k in fields:
+            new_fields[k] = fields[k]
+    for k,v in fields.items():
+        if k not in new_fields:
+            new_fields.k = fields[k]
+    fields = new_fields
+
+    if fields[u'in-reply-to'] == None:
+        if message[u'references'] != None:
+            refs = message[u'references'].split()
+            for ref in refs: # search for a known reference id.
+                if ref in KNOWN_IDS:
+                    fields[u'in-reply-to'] = ref
+                    break
+            if fields[u'in-reply-to'] == None and len(refs) > 0:
+                fields[u'in-reply-to'] = refs[0] # default to the first
+    else: # check for mutliple in-reply-to references.
+        refs = fields[u'in-reply-to'].split()
+        found_ref = False
+        for ref in refs: # search for a known reference id.
+            if ref in KNOWN_IDS:
+                fields[u'in-reply-to'] = ref
+                found_ref = True
+                break
+        if found_ref == False and len(refs) > 0:
+            fields[u'in-reply-to'] = refs[0] # default to the first
+
+    if fields[u'alt-id'] != None:
+        KNOWN_IDS.append(fields[u'alt-id'])
+
+    if message.is_multipart():
+        ret = []
+        alt_id = fields[u'alt-id']
+        from_str = fields[u'author']
+        date = fields[u'date']
+        for m in message.walk():
+            if m == message:
+                continue
+            fields[u'author'] = from_str
+            fields[u'date'] = date
+            if len(ret) > 0: # we've added one part already
+                fields.pop(u'alt-id') # don't pass alt-id to other parts
+                fields[u'in-reply-to'] = alt_id # others respond to first
+            ret.append(comment_message_to_xml(m, fields))
+            return u'\n'.join(ret)
+
+    charset = message.get_content_charset(DEFAULT_ENCODING).lower()
+    #assert charset == DEFAULT_ENCODING.lower(), \
+    #    u"Unknown charset: %s" % charset
+
+    if message[u'content-transfer-encoding'] == None:
+        encoding = DEFAULT_ENCODING
+    else:
+        encoding = message[u'content-transfer-encoding'].lower()
+    body = message.get_payload(decode=True) # attempt to decode
+    assert body != None, "Unable to decode?"
+    if fields[u'content-type'].startswith(u"text/"):
+        body = unicode(body, encoding=charset).rstrip(u'\n')
+    else:
+        body = base64.encode(body)
+    fields[u'body'] = body
+    lines = [u"<comment>"]
+    for tag,body in fields.items():
+        if body != None:
+            ebody = escape(body)
+            lines.append(u"  <%s>%s</%s>" % (tag, ebody, tag))
+    lines.append(u"</comment>")
+    return u'\n'.join(lines)
+
+def main(mbox_filename):
+    mb = mbox(mbox_filename)
+    print u'<?xml version="1.0" encoding="%s" ?>' % DEFAULT_ENCODING
+    print u"<be-xml>"
+    for message in mb:
+        print comment_message_to_xml(message)
+    print u"</be-xml>"
+
+
+if __name__ == "__main__":
+    import sys
+    main(sys.argv[1])