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.)

1 files changed, 8 insertions, 72 deletions

diff --git a/becommands/comment.py b/becommands/comment.py
index dad32dd..a600e9f 100644
--- a/becommands/comment.py
+++ b/becommands/comment.py
@@ -19,10 +19,6 @@
 from libbe import cmdutil, bugdir, comment, editor
 import os
 import sys
-try: # import core module, Python >= 2.5
-    from xml.etree import ElementTree
-except ImportError: # look for non-core module
-    from elementtree import ElementTree
 __desc__ = __doc__
 
 def execute(args, manipulate_encodings=True):
@@ -32,7 +28,7 @@ def execute(args, manipulate_encodings=True):
     >>> os.chdir(bd.root)
     >>> execute(["a", "This is a comment about a"], manipulate_encodings=False)
     >>> bd._clear_bugs()
-    >>> bug = cmdutil.bug_from_shortname(bd, "a")
+    >>> bug = cmdutil.bug_from_id(bd, "a")
     >>> bug.load_comments(load_full=False)
     >>> comment = bug.comment_root[0]
     >>> print comment.body
@@ -54,7 +50,7 @@ def execute(args, manipulate_encodings=True):
     >>> os.environ["EDITOR"] = "echo 'I like cheese' > "
     >>> execute(["b"], manipulate_encodings=False)
     >>> bd._clear_bugs()
-    >>> bug = cmdutil.bug_from_shortname(bd, "b")
+    >>> bug = cmdutil.bug_from_id(bd, "b")
     >>> bug.load_comments(load_full=False)
     >>> comment = bug.comment_root[0]
     >>> print comment.body
@@ -71,25 +67,10 @@ def execute(args, manipulate_encodings=True):
         raise cmdutil.UsageError("Too many arguments.")
 
     shortname = args[0]
-    if shortname.count(':') > 1:
-        raise cmdutil.UserError("Invalid id '%s'." % shortname)
-    elif shortname.count(':') == 1:
-        # Split shortname generated by Comment.comment_shortnames()
-        bugname = shortname.split(':')[0]
-        is_reply = True
-    else:
-        bugname = shortname
-        is_reply = False
 
     bd = bugdir.BugDir(from_disk=True,
                        manipulate_encodings=manipulate_encodings)
-    bug = cmdutil.bug_from_shortname(bd, bugname)
-    bug.load_comments(load_full=False)
-    if is_reply:
-        parent = bug.comment_root.comment_from_shortname(shortname,
-                                                         bug_shortname=bugname)
-    else:
-        parent = bug.comment_root
+    bug, parent = cmdutil.bug_comment_from_id(bd, shortname)
 
     if len(args) == 1: # try to launch an editor for comment-body entry
         try:
@@ -118,51 +99,11 @@ def execute(args, manipulate_encodings=True):
         if not body.endswith('\n'):
             body+='\n'
 
-    if options.XML == False:
-        new = parent.new_reply(body=body, content_type=options.content_type)
-        if options.author != None:
-            new.author = options.author
-        if options.alt_id != None:
-            new.alt_id = options.alt_id
-    else: # import XML comment [list]
-        # read in the comments
-        str_body = body.encode("unicode_escape").replace(r'\n', '\n')
-        comment_list = ElementTree.XML(str_body)
-        if comment_list.tag not in ["bug", "comment-list"]:
-            raise comment.InvalidXML(
-                comment_list, "root element must be <bug> or <comment-list>")
-        new_comments = []
-        ids = []
-        for c in bug.comment_root.traverse():
-            ids.append(c.uuid)
-            if c.alt_id != None:
-                ids.append(c.alt_id)
-        for child in comment_list.getchildren():
-            if child.tag == "comment":
-                new = comment.Comment(bug)
-                new.from_xml(unicode(ElementTree.tostring(child)).decode("unicode_escape"))
-                if new.alt_id in ids:
-                    raise cmdutil.UserError(
-                        "Clashing comment alt_id: %s" % new.alt_id)
-                ids.append(new.uuid)
-                if new.alt_id != None:
-                    ids.append(new.alt_id)
-                if new.in_reply_to == None:
-                    new.in_reply_to = parent.uuid
-                new_comments.append(new)
-            else:
-                print >> sys.stderr, "Ignoring unknown tag %s in %s" \
-                    % (child.tag, comment_list.tag)
-        try:
-            comment.list_to_root(new_comments,bug,root=parent, # link new comments
-                                 ignore_missing_references=options.ignore_missing_references)
-        except comment.MissingReference, e:
-            raise cmdutil.UserError(e)
-        # Protect against programmer error causing data loss:
-        kids = [c.uuid for c in parent.traverse()]
-        for nc in new_comments:
-            assert nc.uuid in kids, "%s wasn't added to %s" % (nc.uuid, parent.uuid)
-            nc.save()
+    new = parent.new_reply(body=body, content_type=options.content_type)
+    if options.author != None:
+        new.author = options.author
+    if options.alt_id != None:
+        new.alt_id = options.alt_id
 
 def get_parser():
     parser = cmdutil.CmdOptionParser("be comment ID [COMMENT]")
@@ -172,11 +113,6 @@ def get_parser():
                       help="Set an alternate comment ID", default=None)
     parser.add_option("-c", "--content-type", metavar="MIME", dest="content_type",
                       help="Set comment content-type (e.g. text/plain)", default=None)
-    parser.add_option("-x", "--xml", action="store_true", default=False,
-                      dest='XML', help="Use COMMENT to specify an XML comment description rather than the comment body.  The root XML element should be either <bug> or <comment-list> with one or more <comment> children.  The syntax for the <comment> elements should match that generated by 'be show --xml COMMENT-ID'.  Unrecognized tags are ignored.  Missing tags are left at the default value.  The comment UUIDs are always auto-generated, so if you set a <uuid> field, but no <alt-id> field, your <uuid> will be used as the comment's <alt-id>.  An exception is raised if <alt-id> conflicts with an existing comment.")
-    parser.add_option("-i", "--ignore-missing-references", action="store_true",
-                      dest="ignore_missing_references",
-                      help="For XML import, if any comment's <in-reply-to> refers to a non-existent comment, ignore it (instead of raising an exception).")
     return parser
 
 longhelp="""