Now function parse_googlemap behaves like parse_wrmap.
[philipp/winterrodeln/wrpylib.git] / wrpylib / mwmarkup.py
index 1ec41c0e03ce26587372cffb781255a1f97dcd0a..735610c8ba6cc8d9c3fcf8e2167b50c000545c79 100644 (file)
@@ -13,6 +13,11 @@ import re
 import xml.etree.ElementTree
 
 
+class ParseError(RuntimeError):
+    """Exception used by some of the functions"""
+    pass
+
+
 def find_template(wikitext, template_title):
     """Returns the tuple (start, end) of the first occurence of the template '{{template ...}} within wikitext'.
     (None, None) is returned if the template is not found.
@@ -106,14 +111,56 @@ def create_template(template_title, anonym_params=[], named_param_keys=[], named
     return pipe_char.join(parts) + end_char
 
 
-def parse_googlemap(wikitext, detail=False):
-    """Parses the (unicode) u'<googlemap ...>content</googlemap>' of the googlemap extension
-    out of a page. If wikitext does not contain the googlemaps extension text None is returned.
-    If the googlemap contains invalid formatted lines, a RuntimeError is raised.
+def find_tag(wikitext, tagname, pos=0):
+    """Returns the tuple (start, end) of the first occurence of the tag '<tag ...>...</tag>'
+    or '<tag ... />'.
+    (None, None) is returned if the tag is not found.
+    If you are sure that the wikitext contains the tag, the tag could be extracted like follows:
+
+    >>> wikitext = u'This is a <tag>mytag</tag> tag.'
+    >>> start, end = find_template(wikitext, u'tag')
+    >>> print wikitext[start:end]
+    <tag>mytag</tag>
+
+    :param wikitext: The text (preferalbe unicode) that has the template in it.
+    :param tagname: Name of the tag, e.g. u'tag' for <tag>.
+    :param pos: position within wikitext to start searching the tag.
+    :return:
+        (start, content, endtag, end). start is the position of '<' of the tag,
+        content is the beginning of the content (after '>'), enttag is the
+        beginning of the end tag ('</') and end is one position after the end tag.
+        For single tags, (start, None, None, end) is returned.
+        If the tag is not found (or only the start tag is present,
+        (None, None, None, None) is returned.
+    """
+    # Find start tag
+    regexp_starttag = re.compile(u"<{0}.*?(/?)>".format(tagname), re.DOTALL)
+    match_starttag = regexp_starttag.search(wikitext, pos)
+    if match_starttag is None:
+        return None, None, None, None
+
+    # does the tag have content?
+    if len(match_starttag.group(1)) == 1: # group(1) is either '' or '/'.
+        # single tag
+        return match_starttag.start(), None, None, match_starttag.end()
+
+    # tag with content
+    regexp_endtag = re.compile(u'</{0}>'.format(tagname), re.DOTALL)
+    match_endtag = regexp_endtag.search(wikitext, match_starttag.end())
+    if match_endtag is None:
+        # No closing tag - error in wikitext
+        return None, None, None, None
+    return match_starttag.start(), match_starttag.end(), match_endtag.start(), match_endtag.end()
+
+
+def parse_googlemap(wikitext):
+    """Parses the (unicode) u'<googlemap ...>content</googlemap>' of the googlemap extension.
+    If wikitext does not contain the <googlemap> tag or if the <googlemap> tag contains
+    invalid formatted lines, a ParseError is raised.
+    Use find_tag(wikitext, 'googlemap') to find the googlemap tag within an arbitrary
+    wikitext before using this function.
 
     :param wikitext: wikitext containing the template. Example:
-    :param detail: bool. If True, start and end position of <googlemaps>...</googlemap> is
-        returned additionally.
 
     wikitext = '''
     <googlemap version="0.9" lat="47.113291" lon="11.272337" zoom="15">
@@ -134,8 +181,7 @@ def parse_googlemap(wikitext, detail=False):
         zoom is the google zoom level as integer or None if not provided
         coords is a list of (lon, lat, symbol, title) tuples.
         paths is a list of (style, coords) tuples.
-        coords is again a list of (lot, lat, symbol, title) tuples.
-        If detail is True, (center, zoom, coords, paths, start, end) is returned."""
+        coords is again a list of (lot, lat, symbol, title) tuples."""
 
     def is_coord(line):
         """Returns True if the line contains a coordinate."""
@@ -157,15 +203,21 @@ def parse_googlemap(wikitext, detail=False):
         if not match is None: return (float(match.group(2)), float(match.group(1)), None, match.group(3))
         match = re.match(u'([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+)', line)
         if not match is None: return (float(match.group(2)), float(match.group(1)), None, None)
-        return RuntimeError(u'Could not parse line ' + line)
-
-    regexp = re.compile(u"(<googlemap[^>]*>)(.*?)(</googlemap>)", re.DOTALL)
-    match = regexp.search(wikitext)
-    if match is None: return None
-    start = match.start()
-    end = match.end()
-    content = match.group(2)
-    gm = xml.etree.ElementTree.XML((match.group(1)+match.group(3)).encode('UTF8'))
+        return ParseError(u'Could not parse line ' + line)
+
+    start, content, endtag, end = find_tag(wikitext, 'googlemap')
+    if start is None:
+        raise ParseError('<googlemap> tag not found.')
+    if content is None:
+        xml_only = wikitext[start:endtag]
+    else:
+        xml_only = wikitext[start:content]+wikitext[endtag:end]
+        
+    try:
+        gm = xml.etree.ElementTree.XML(xml_only.encode('UTF8'))
+    except xml.etree.ElementTree.ParseError as e:
+        row, column = e.position
+        raise ParseError("XML parse error in <googlemap ...>.")
     zoom = gm.get('zoom')
     lon = gm.get('lon')
     lat = gm.get('lat')
@@ -176,7 +228,7 @@ def parse_googlemap(wikitext, detail=False):
 
     coords = []
     paths = []
-    lines = content.split("\n")
+    lines = wikitext[content:endtag].split("\n")
     i = 0
     while i < len(lines):
         line = lines[i].strip()
@@ -215,8 +267,6 @@ def parse_googlemap(wikitext, detail=False):
             coords.append((lon, lat, symbol, title))
             continue
 
-        raise RuntimeError(u'Unknown line syntax: ' + line)
-    if detail:
-        return (center, zoom, coords, paths, start, end)
+        raise ParseError(u'Unknown line syntax: ' + line)
     return (center, zoom, coords, paths)