Broke `be comment --xml` out and extended into `be import-xml`.

It should currently do everything that `be comment --xml` did, but it
still has a way to go before it lives up to it's longhelp string,
mostly figuring out bug/comment merging.

The allowed XML format also changed a bit, becoming a bit more
structured.

cmdutil.bug_from_shortname() renamed to cmdutil.bug_from_id().

New functions cmdutil.parse_id() and cmdutil.bug_comment_from_id().

Additional doctests in libbe.comment.Comment.comment_shortnames() to
show example output if bug_shortname==None.

Brought be-xml-to-mbox and be-mbox-to-xml up to speed on the current
<be-xml>-rooted format.
  * Added <extra-string> handling to their comment handling.
  * Moved extra strings from email bodies to X-Extra-String headers
    (some comment bodies are not text, and we should keep the estr
    location consistent between bugs and comments.)

2 files changed, 26 insertions, 24 deletions

diff --git a/interfaces/xml/be-mbox-to-xml b/interfaces/xml/be-mbox-to-xml
index a740117..3af2978 100755
--- a/interfaces/xml/be-mbox-to-xml
+++ b/interfaces/xml/be-mbox-to-xml
@@ -15,8 +15,8 @@
 # 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 imput into be.
-  $ cat mbox | be-mbox-to-xml | be comment --xml <ID> -
+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.
@@ -140,10 +140,10 @@ def comment_message_to_xml(message, fields=None):
 def main(mbox_filename):
     mb = mbox(mbox_filename)
     print u'<?xml version="1.0" encoding="%s" ?>' % DEFAULT_ENCODING
-    print u"<comment-list>"
+    print u"<be-xml>"
     for message in mb:
         print comment_message_to_xml(message)
-    print u"</comment-list>"
+    print u"</be-xml>"
 
 
 if __name__ == "__main__":
diff --git a/interfaces/xml/be-xml-to-mbox b/interfaces/xml/be-xml-to-mbox
index 7960d56..ecc6327 100755
--- a/interfaces/xml/be-xml-to-mbox
+++ b/interfaces/xml/be-xml-to-mbox
@@ -88,19 +88,18 @@ class Bug (LimitedAttrDict):
     def print_to_mbox(self):
         name,addr = email.utils.parseaddr(self["creator"])
         print "From %s %s" % (addr, rfc2822_to_asctime(self["created"]))
-        print "Message-ID: <%s@%s>" % (self["uuid"], DEFAULT_DOMAIN)
+        print "Message-id: <%s@%s>" % (self["uuid"], DEFAULT_DOMAIN)
         print "Date: %s" % self["created"]
         print "From: %s" % self["creator"]
         print "Content-Type: %s; charset=%s" % ("text/plain", DEFAULT_ENCODING)
         print "Content-Transfer-Encoding: 8bit"
         print "Subject: %s: %s" % (self["short-name"], self["summary"])
+        if "extra-strings" in self:
+            for estr in self["extra_strings"]:
+                print "X-Extra-String: %s" % estr
         print ""
         print self["summary"]
         print ""
-        if "extra-strings" in self:
-            print "extra strings:\n  ",
-            print '\n  '.join(self["extra_strings"])
-        print ""
         if "comments" in self:
             for comment in self["comments"]:
                 comment.print_to_mbox(self)            
@@ -131,7 +130,8 @@ class Comment (LimitedAttrDict):
               u"author",
               u"date",
               u"content-type",
-              u"body"]
+              u"body",
+              u"extra-strings"]
     def print_to_mbox(self, bug=None):
         if bug == None:
             bug = Bug()
@@ -142,7 +142,7 @@ class Comment (LimitedAttrDict):
         elif "alt-id" in self: id = self["alt-id"]
         else:                  id = None
         if id != None:
-            print "Message-ID: <%s@%s>" % (id, DEFAULT_DOMAIN)
+            print "Message-id: <%s@%s>" % (id, DEFAULT_DOMAIN)
         print "Date: %s" % self["date"]
         print "From: %s" % self["author"]
         subject = ""
@@ -156,6 +156,9 @@ class Comment (LimitedAttrDict):
         if "in-reply-to" not in self.keys():
             self["in-reply-to"] = bug["uuid"]
         print "In-Reply-To: <%s@%s>" % (self["in-reply-to"], DEFAULT_DOMAIN)
+        if "extra-strings" in self:
+            for estr in self["extra_strings"]:
+                print "X-Extra-String: %s" % estr
         if self["content-type"].startswith("text/"):
             print "Content-Transfer-Encoding: 8bit"
             print "Content-Type: %s; charset=%s" % (self["content-type"], DEFAULT_ENCODING)
@@ -168,9 +171,15 @@ class Comment (LimitedAttrDict):
         assert element.tag == "comment", element.tag
         for field in element.getchildren():
             text = unescape(unicode(field.text).decode("unicode_escape").strip())
-            if field.tag == "body":
-                text+="\n"
-            self[field.tag] = text
+            if field.tag == "extra-string":
+                if "extra-strings" in self:
+                    self["extra-strings"].append(text)
+                else:
+                    self["extra-strings"] = [text]
+            else:
+                if field.tag == "body":
+                    text+="\n"
+                self[field.tag] = text
 
 def print_to_mbox(element):
     if element.tag == "bug":
@@ -181,16 +190,9 @@ def print_to_mbox(element):
         c = Comment()
         c.init_from_etree(element)
         c.print_to_mbox()
-    elif element.tag in ["bugs", "bug-list"]:
-        for b_elt in element.getchildren():
-            b = Bug()
-            b.init_from_etree(b_elt)
-            b.print_to_mbox()
-    elif element.tag in ["comments", "comment-list"]:
-        for c_elt in element.getchildren():
-            c = Comment()
-            c.init_from_etree(c_elt)
-            c.print_to_mbox()
+    elif element.tag in ["be-xml"]:
+        for elt in element.getchildren():
+            print_to_mbox(elt)
 
 if __name__ == "__main__":
     import sys