Renamed function parse_googlemap to googlemap_to_wrmap and changed input parameters.
[philipp/winterrodeln/wrpylib.git] / wrpylib / wrmwmarkup.py
index 142512ebaff6695823cb9bc211686dcad15f7394..6877f472a67c942c9b180ea293517bd542d0a3b0 100644 (file)
@@ -10,6 +10,14 @@ import formencode
 import wrpylib.wrvalidators
 import wrpylib.mwmarkup
 
+WRMAP_POINT_TYPES = ['gasthaus', 'haltestelle', 'parkplatz', 'achtung', 'punkt']
+WRMAP_LINE_TYPES = ['rodelbahn', 'gehweg', 'alternative', 'lift', 'anfahrt', 'linie']
+
+
+class ParseError(RuntimeError):
+    """Exception used by some of the functions"""
+    pass
+
 
 def _conv(fnct, value, fieldname):
     """Internal function.
@@ -316,55 +324,46 @@ def find_all_templates(wikitext, find_func):
     return results
 
 
-def parse_googlemap(wikitext):
-    """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.
-
-    :param wikitext: wikitext containing the template. Example:
-
-    wikitext = '''
-    <googlemap version="0.9" lat="47.113291" lon="11.272337" zoom="15">
-    (Parkplatz)47.114958,11.266026
-    Parkplatz
-    
-    (Gasthaus) 47.114715, 11.266262, Alt Bärnbad (Gasthaus)
-    6#FF014E9A
-    47.114715,11.266262
-    47.114135,11.268381
-    47.113421,11.269322
-    47.11277,11.269979
-    47.112408,11.271119
-    </googlemap>
-    '''
-    :returns: (attributes, GeoJSON as Python datatypes)
+def googlemap_to_wrmap(center, zoom, coords, paths):
+    """Converts the output of parse_googlemap to the GeoJSON format wrmap uses.
+    :returns: (GeoJSON as nested Python datatypes)
     """
-    center, zoom, coords, paths = wrpylib.mwmarkup.parse_googlemap(wikitext)
     json_features = []
 
     # point
     for point in coords:
         lon, lat, symbol, title = point
-        properties = {'type': symbol}
-        if title: properties['name'] = title
+        properties = {}
+        if symbol is not None: properties['type'] = symbol.lower()
+        if title is not None: properties['name'] = title
         json_features.append({
-            'type': 'feature',
+            'type': 'Feature',
             'geometry': {'type': 'Point', 'coordinates': [lon, lat]},
             'properties': properties})
         
     # path
     for path in paths:
         style, entries = path
-        properties = {'type': 'line'}
+        style = style.lower()
+        PATH_TYPES = {u'6#ff014e9a': u'rodelbahn', u'6#ffe98401': u'gehweg', u'6#ff7f7fff': u'alternative', u'3#ff000000': u'lift', u'3#ffe1e100': u'anfahrt'}
+        if PATH_TYPES.has_key(style):
+            properties = {'type': PATH_TYPES[style]}
+        else:
+            properties = {'type': 'line'}
+            properties['dicke'] = style[0]
+            properties['farbe'] = style[4:]
         json_features.append({
-            'type': 'feature',
+            'type': 'Feature',
             'geometry': {
                 'type': 'LineString',
                 'coordinates': [[lon, lat] for lon, lat, symbol, title in entries]},
             'properties': properties})
 
-    json = {'type': 'FeatureCollection', 'features': json_features}
-    return {'lon': center[0], 'lat': center[1], 'zoom': zoom}, json
+    geojson = {
+            'type': 'FeatureCollection',
+            'features': json_features,
+            'properties': {'lon': center[0], 'lat': center[1], 'zoom': zoom}}
+    return geojson
 
 
 def parse_wrmap_coordinates(coords):
@@ -388,8 +387,8 @@ def parse_wrmap_coordinates(coords):
 
 def parse_wrmap(wikitext):
     """Parses the (unicode) u'<wrmap ...>content</wrmap>' of the Winterrodeln wrmap 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.
+    out of a page. If wikitext does not contain the wrmap extension text None is returned.
+    If the wrmap contains invalid formatted lines, a ParseError is raised.
 
     :param wikitext: wikitext containing the template. Example:
 
@@ -405,82 +404,120 @@ def parse_wrmap(wikitext):
     </rodelbahn>
     </wrmap>
     '''
-    :returns: (attributes, GeoJSON as Python datatypes)
+    :returns: GeoJSON as nested Python datatype
     """
     # parse XML
     try:
         wrmap_xml = xml.etree.ElementTree.fromstring(wikitext.encode('utf-8'))
     except xml.etree.ElementTree.ParseError as e:
         row, column = e.position
-        raise RuntimeError("XML parse error on row {}, column {}: {}".format(row, column, e))
-    # assert(in_array($tagname, array('wrmap', 'wrgmap'))); # TODO
+        raise ParseError("XML parse error on row {}, column {}: {}".format(row, column, e))
+    if wrmap_xml.tag not in ['wrmap', 'wrgmap']:
+        raise ParseError('No valid tag name')
 
     # convert XML to geojson (http://www.geojson.org/geojson-spec.html)
     json_features = []
-    point_type = {'gasthaus': 'inn', 'haltestelle': 'busstop', 'parkplatz': 'carpark', 'achtung': 'attention', 'punkt': 'point'}
-    line_type = {'rodelbahn': 'sledrun', 'gehweg': 'walk', 'alternative': 'alternative', 'lift': 'lift', 'linie': 'line'}
     for feature in wrmap_xml:
         # determine feature type
-        is_point = point_type.has_key(feature.tag)
-        is_line = line_type.has_key(feature.tag)
+        is_point = feature.tag in WRMAP_POINT_TYPES
+        is_line = feature.tag in WRMAP_LINE_TYPES
         if (not is_point and not is_line):
-            raise RuntimeError('Unknown element <{}>.'.format(feature.tag))
+            raise ParseError('Unknown element <{}>.'.format(feature.tag))
 
         # point
         if is_point:
-            properties = {'type': point_type[feature.tag]}
+            properties = {'type': feature.tag}
             allowed_properties = set(['name', 'wiki'])
             wrong_properties = set(feature.attrib.keys()) - allowed_properties
             if len(wrong_properties) > 0:
-                raise RuntimeError("The attribute '{}' is not allowed at <{}>.".format(list(wrong_properties)[0], feature.tag))
+                raise ParseError("The attribute '{}' is not allowed at <{}>.".format(list(wrong_properties)[0], feature.tag))
             properties.update(feature.attrib)
             coordinates = parse_wrmap_coordinates(feature.text)
             if len(coordinates) != 1:
-                raise RuntimeError('The element <{}> has to have exactly one coordinate pair.'.format(feature.tag))
+                raise ParseError('The element <{}> has to have exactly one coordinate pair.'.format(feature.tag))
             json_features.append({
-                'type': 'feature',
+                'type': 'Feature',
                 'geometry': {'type': 'Point', 'coordinates': coordinates[0]},
                 'properties': properties})
 
         # line
         if is_line:
-            properties = {'type': line_type[feature.tag]}
+            properties = {'type': feature.tag}
             allowed_properties = set(['farbe', 'dicke'])
             wrong_properties = set(feature.attrib.keys()) - allowed_properties
             if len(wrong_properties) > 0:
-                raise RuntimeError("The attribute '{}' is not allowed at <{}>.".format(list(wrong_properties)[0], feature.tag))
+                raise ParseError("The attribute '{}' is not allowed at <{}>.".format(list(wrong_properties)[0], feature.tag))
             if feature.attrib.has_key('farbe'): 
                 if not re.match('#[0-9a-fA-F]{6}$', feature.attrib['farbe']):
-                    raise RuntimeError('The attribute "farbe" has to have a format like "#a0bb43".')
+                    raise ParseError('The attribute "farbe" has to have a format like "#a0bb43".')
                 properties['strokeColor'] = feature.attrib['farbe'] # e.g. #a200b7
             if feature.attrib.has_key('dicke'):
                 try:
                     properties['strokeWidth'] = int(feature.attrib['dicke']) # e.g. 6
                 except ValueError:
-                    raise RuntimeError('The attribute "farbe" has to be an integer.')
+                    raise ParseError('The attribute "dicke" has to be an integer.')
             json_features.append({
-                'type': 'feature',
+                'type': 'Feature',
                 'geometry': {'type': 'LineString', 'coordinates': parse_wrmap_coordinates(feature.text)},
                 'properties': properties})
 
-    json = {
+    # attributes
+    properties = {}
+    for k, v in wrmap_xml.attrib.iteritems():
+        if k in ['lat', 'lon']:
+            try:
+                properties[k] = float(v)
+            except ValueError:
+                raise ParseError('Attribute "{}" has to be a float value.'.format(k))
+        elif k in ['zoom', 'width', 'height']:
+            try:
+                properties[k] = int(v)
+            except ValueError:
+                raise ParseError('Attribute "{}" has to be an integer value.'.format(k))
+        else:
+            raise ParseError('Unknown attribute "{}".'.format(k))
+
+    geojson = {
         'type': 'FeatureCollection',
-        'features': json_features}
+        'features': json_features,
+        'properties': properties}
 
-    # attributes # TODO: check
-    attributes = {}
-    attributes['lat']    = float(wrmap_xml.attrib.get('lat', 47.267648)) # center lat
-    attributes['lon']    = float(wrmap_xml.attrib.get('lon', 11.404655)) # center lon
-    attributes['zoom']   = int(wrmap_xml.attrib.get('zoom', 10))         # Google Zoom Level
-    attributes['width']  = int(wrmap_xml.attrib['width']) if wrmap_xml.attrib.has_key('width') else None # None corresponds to 100%
-    attributes['height'] = int(wrmap_xml.attrib.get('height', 450))      # map height in px
-    # show_sledruns = (wrmap_xml.tag == 'wrgmap')
+    return geojson
 
-    return attributes, json
 
+def create_wrmap_coordinates(coords):
+    result = []
+    for coord in coords:
+        result.append('{:.6f} N {:.6f} E'.format(coord[1], coord[0]))
+    return '\n'.join(result)
 
 def create_wrmap(geojson):
-    """Creates a <wrmap> wikitext from geojson."""
-    pass
-
+    """Creates a <wrmap> wikitext from geojson (as python types)."""
+    wrmap_xml = xml.etree.ElementTree.Element('wrmap')
+    wrmap_xml.text = '\n\n'
+    for k, v in geojson['properties'].iteritems():
+        wrmap_xml.attrib[k] = str(v)
+
+    assert geojson['type'] == 'FeatureCollection'
+    json_features = geojson['features']
+    last_json_feature = None
+    for json_feature in json_features:
+        feature_xml = xml.etree.ElementTree.SubElement(wrmap_xml, json_feature['properties']['type'])
+        geo = json_feature['geometry']
+        if geo['type'] == 'Point':
+            feature_xml.text = create_wrmap_coordinates([geo['coordinates']])
+            if last_json_feature is not None:
+                last_json_feature.tail = '\n'
+        else:
+            if last_json_feature is not None:
+                last_json_feature.tail = '\n\n'
+            feature_xml.text = '\n' + create_wrmap_coordinates(geo['coordinates']) + '\n'
+        last_json_feature = feature_xml
+        feature_xml.attrib = json_feature['properties']
+        del feature_xml.attrib['type']
+
+    if last_json_feature is not None:
+        last_json_feature.tail = '\n\n'
+    return xml.etree.ElementTree.tostring(wrmap_xml, encoding='utf-8').decode('utf-8')