Changed map output to DOM based output.

[philipp/winterrodeln/mediawiki_extensions/wrmap.git] / wrmap.body.php

diff --git a/wrmap.body.php b/wrmap.body.php
index 05e0b1196d83118ef86ef999da55d9d5bc6564ac..ccb5b802d36a901f15b782792d4ab5d4cf83dc81 100644 (file)
--- a/wrmap.body.php
+++ b/wrmap.body.php
@@ -1,197 +1,252 @@
 <?php
 <?php

-require_once dirname(__FILE__) . '/../wrgeo/wrgeo.body.php'; # for the function wrGeoGeoStringToGeo
-
-function wrMapParserFirstCallInit() {
-       global $wgParser;
-       // global $wrGoogleMaps; // is this necessary?
-       global $wgGoogleMapsKey;
-       $wrGoogleMaps = new WrGoogleMaps($wgGoogleMapsKey);
-       $wgParser->setHook('wrmap', 'wrmapParserHook');
-       $wgParser->setHook('wrgmap', array($wrGoogleMaps, 'render'));
-       return true;
-}
-

 
 

-// Tool functions
-// --------------
+// DOM helper classes
+// ------------------

 
 

-/// List of markers - used by the functions wrMapReplaceByMarker and wrMapAfterTidy
-$wrMapMarkerList = array();
+// The following two classes are "duplicated" from the wrreport extension to keep them separate.
+// Put improvements in both classes.
+class WrMapDOMDocument extends DOMDocument {
+       function __construct() {
+               parent::__construct('1.0', 'utf-8');
+               $this->registerNodeClass('DOMElement', 'WrMapDOMElement');
+       }

 
 

+       /// Creates and adds the element with the given tag name and returns it.
+       /// Additionally, it calls setAttribute($key, $value) for every entry
+       /// in $attributes.
+       function appendElement($tagName, $attributes=array()) {
+               $child = $this->appendChild($this->createElement($tagName));
+               foreach ($attributes as $key => $value) $child->setAttribute($key, $value);
+               return $child;
+       }

 
 

-/// Returns a marker for a text and back-replaces the text in wrReportAfterTidy
-function wrMapReplaceByMarker($text, $marker = 'wrMapMarker') {
-       $marker = $marker . mt_rand(1e5, 1e7);
-       global $wrMapMarkerList;
-       $wrMapMarkerList[$marker] = $text;
-       return $marker;

 }
 }

+class WrMapDOMElement extends DOMElement {
+
+       /// Creates and adds the element with the given tag name and returns it
+       /// Additionally, it calls setAttribute($key, $value) for every entry
+       /// in $attributes.
+       function appendElement($tagName, $attributes=array()) {
+               $child = $this->appendChild($this->ownerDocument->createElement($tagName));
+               foreach ($attributes as $key => $value) $child->setAttribute($key, $value);
+               return $child;
+       }

 
 

+       /// Adds any UTF-8 string as content of the element - it will be escaped.
+       function appendText($text) {
+               return $this->appendChild($this->ownerDocument->createTextNode($text));
+       }

 
 

-/// Replaces the markers by its contents
-function wrMapParserAfterTidy(&$parser, &$text) {
-       // find markers in $text
-       // replace markers with actual output
-       global $wrMapMarkerList;
-       foreach ($wrMapMarkerList as $marker => $html) $text = str_replace($marker, $html, $text);
-       return true;
+       // Appends a CDATASections to the element. This can be used to include
+       // raw (unparsed) HTML to the DOM tree as it is necessary because
+       // $parser->recursiveTagParse does not always escape & characters.
+       // (see https://bugzilla.wikimedia.org/show_bug.cgi?id=55526 )
+       // Workaround: Use a CDATA section. When serializing with $doc->saveHTML,
+       // the <![CDATA[...]]> is returned as ... .
+       // However, we end up having unescaped & in the output due to this bug in recursiveTagParse.
+       function appendCDATA($data) {
+               return $this->appendChild($this->ownerDocument->createCDATASection($data));
+       }

 }
 
 
 }
 
 

+// gets coordinates and returns an array of lon/lat coordinate pairs, e.g.
+// 47.12 N 11.87 E
+// 47.13 N 11.70 E
+// ->
+// array(array(11.87, 47.12), array(11.70, 47.13))
+function geo_to_coordinates($input) {
+       $matches = array();
+       $num_matches = preg_match_all('/\s*(\d+\.?\d*)\s*N?\s+(\d+\.?\d*)\s*E?\s*/', $input, $matches);
+       $result = array();
+       for ($i=0; $i!=$num_matches; ++$i) {
+               $result[] = array(floatval($matches[2][$i]), floatval($matches[1][$i]));
+       }
+       if (implode($matches[0]) != $input) throw new Exception('Falsches Koordinatenformat: ' . $input);
+       return $result;
+}
+

 
 

-// Java script
-// -----------
+// convert sledruns to geojson (http://www.geojson.org/geojson-spec.html)
+// Returns an array of features
+function sledruns_to_json_features() {
+       $json_features = array(); // result
+       $dbr = wfGetDB(DB_SLAVE);
+       $res = $dbr->select(array('wrsledruncache', 'wrreportcache'), array('wrsledruncache.page_title', 'position_latitude', 'position_longitude', 'date_report', '`condition`'), array('show_in_overview', 'not under_construction'), __METHOD__, array(), array('wrreportcache' => array('left outer join', 'wrsledruncache.page_id=wrreportcache.page_id')));
+       while ($sledrun = $dbr->fetchRow($res)) {
+               $lat = $sledrun['position_latitude'];
+               $lon = $sledrun['position_longitude'];
+               if (is_null($lat) || is_null($lon)) continue;
+               $lat = floatval($lat);
+               $lon = floatval($lon);
+               $title = Title::newFromText($sledrun['page_title']);
+               $properties = array('type' => 'sledrun', 'name' => $title->getText(), 'wiki' => $title->getLocalUrl());
+               if (!is_null($sledrun['date_report'])) $properties['date_report'] = $sledrun['date_report'];
+               if (!is_null($sledrun['condition'])) $properties['condition'] = intval($sledrun['condition']);
+               $json_feature = array(
+                       'type' => 'feature',
+                       'geometry' => array(
+                               'type' => 'Point',
+                               'coordinates' => array($lon, $lat)
+                       ),
+                       'properties' => $properties
+               );
+               $json_features[] = $json_feature;
+       }
+       $dbr->freeResult($res);
+       return $json_features;
+}

 
 

-// Global JavaScript functions
-define(WRGMAPJSFUNCTIONS, <<<JAVASCRIPT
-<script type="text/javascript">
-//<![CDATA[
-var wrSleddingIcon = new GIcon(G_DEFAULT_ICON);
-wrSleddingIcon.image = "/vorlagen/gmap_rodelbahn_c.png";
-wrSleddingIcon.shadow = "/vorlagen/gmap_rodelbahn_c_s.png";
-wrSleddingIcon.iconSize = new GSize(17, 17);
-wrSleddingIcon.shadowSize = new GSize(23, 23);
-wrSleddingIcon.iconAnchor = new GPoint(9, 9);
-wrSleddingIcon.infoWindowAnchor = new GPoint(9, 9);

 
 

+// convert XML to geojson (http://www.geojson.org/geojson-spec.html)
+// Returns an array of features
+function xml_to_json_features($input) {
+       libxml_use_internal_errors(true); // without that, we get PHP Warnings if the $input is not well-formed
+       $xml = new SimpleXMLElement($input); // input
+       $whitespace = (string) $xml; // everything between <wrmap> and </wrmap> that's not a sub-element
+       if (strlen($whitespace) > 0 && !ctype_space($whitespace)) { // there must not be anythin except sub-elements or whitespace
+               throw new Exception('Die Landkarte enthält folgenden ungültigen Text: "' . trim($xml) . '".');
+       }
+       $json_features = array(); // output
+       $point_types = array('gasthaus', 'haltestelle', 'parkplatz', 'achtung', 'punkt');
+       $line_types = array('rodelbahn', 'gehweg', 'alternative', 'lift', 'anfahrt', 'linie');
+       foreach ($xml as $feature) {
+               $given_properties = array();
+               foreach ($feature->attributes() as $key => $value) $given_properties[] = $key;
+
+               // determine feature type
+               $is_point = in_array($feature->getName(), $point_types);
+               $is_line = in_array($feature->getName(), $line_types);
+               if (!$is_point && !$is_line) {
+                       throw new Exception('Unbekanntes Element <' . $feature->getName() . '>. Erlaubt sind: <' . implode('>, <', array_merge($point_types, $line_types)) . '>.');
+               }

 
 

-function wrCreateMarker(latitude, longitude, name, icon) {
-       var point = new GLatLng(latitude, longitude);
-       var marker = new GMarker(point, icon);
-       GEvent.addListener(marker, "click", function() {marker.openInfoWindowHtml("<strong>" + name + "</strong>");});
-       return marker;
-}
-//]]>
-</script>
-JAVASCRIPT
-);
-
-
-/** This class was inpired by the GoogleMaps class of the GoogleMaps extension. */
-class WrGoogleMaps {
-       /// the Google API key (obtained from
-       /// http://www.google.com/apis/maps/signup.html)
-       private $apiKey = null;
-       
-       /// How many <wrgmap> tags are on the current page?
-       private $mapsCount = 0;
-       
-       /// Constructor
-       function WrGoogleMaps($apiKey) {
-               $this->apiKey = $apiKey;
+               // point
+               if ($is_point) {
+                       $properties = array('type' => $feature->getName());
+                       $allowed_properties = array('name', 'wiki');
+                       $wrong_properties = array_diff($given_properties, $allowed_properties);
+                       if (count($wrong_properties) > 0) throw new Exception("Das Attribut '" . reset($wrong_properties) . "' ist nicht erlaubt bei <" . $feature->getName() . ">. Erlaubt sind: '" . implode("', '", $allowed_properties) . "'.");
+                       foreach ($given_properties as $property) {
+                               $propval = (string) $feature[$property];
+                               if ($property == 'wiki') {
+                                       $title = Title::newFromText($propval);
+                                       $propval = $title->getLocalUrl();
+                               }
+                               $properties[$property] = $propval;
+                       }
+                       $coordinates = geo_to_coordinates($feature);
+                       if (count($coordinates) != 1) throw new Exception('Das Element <' . $feature->getName() . '> muss genau ein Koordinatenpaar haben.');
+                       $json_feature = array(
+                               'type' => 'feature',
+                               'geometry' => array(
+                                       'type' => 'Point',
+                                       'coordinates' => reset($coordinates)
+                               ),
+                               'properties' => $properties
+                       );
+                       $json_features[] = $json_feature;
+               }
+               // line
+               if ($is_line) {
+                       $properties = array('type' => $feature->getName());
+                       $allowed_properties = array('farbe', 'dicke');
+                       $wrong_properties = array_diff($given_properties, $allowed_properties);
+                       if (count($wrong_properties) > 0) throw new Exception("Das Attribut '" . reset($wrong_properties) . "' ist nicht erlaubt bei <" . $feature->getName() . ">. Erlaubt sind: '" . implode("', '", $allowed_properties) . "'.");
+                       if (isset($feature['farbe'])) {
+                               $color = (string) $feature['farbe']; // e.g. #a200b7
+                               if (preg_match('/^#[0-9a-f]{6}$/i', $color) != 1) 
+                                       throw new Exception('Die Farbangabe der Linie hat ein falsches Format. Sie muss z.B. so aussehen: #a200b7.');
+                               $properties['strokeColor'] = $color;
+                       }
+                       if (isset($feature['dicke'])) {
+                               $stroke_width = (int) $feature['dicke']; // e.g. 6
+                               if (((string) $stroke_width) !== (string) $feature['dicke'])
+                                       throw new Exception('Die Angabe der Liniendicke hat ein falsches Format. Sie muss eine ganze Zahl wie z.B. 6 sein.');
+                               $properties['strokeWidth'] = $stroke_width;
+                       }
+                       $json_feature = array(
+                               'type' => 'feature',
+                               'geometry' => array(
+                                       'type' => 'LineString',
+                                       'coordinates' => geo_to_coordinates($feature)
+                               ),
+                               'properties' => $properties
+                       );
+                       $json_features[] = $json_feature;
+               }

        }
        }

-       
-       /// Renders the <wrgmap> tag
+       return $json_features;
+}
+
+
+
+class WrBaseMap {
+       /// Renders the <wrgmap> tag and the <wrmap> tag.
+       /// This class would be the only class needed but as the function render() toes not provide an argument
+       /// telling which tag name called the function, a trick with two inherited classes has to be used.

        /// @param $content string - the content of the <wrgmap> tag
        /// @param $args array - the array of attribute name/value pairs for the tag
        /// @param $parser Parser - the MW Parser object for the current page
        /// @param $content string - the content of the <wrgmap> tag
        /// @param $args array - the array of attribute name/value pairs for the tag
        /// @param $parser Parser - the MW Parser object for the current page

-       /// @param $localParser Parser - the parser for parsing local content

        ///
        /// @return string - the html for rendering the map
        ///
        /// @return string - the html for rendering the map

-       function render($content, $args, &$parser) {
-               ++$this->mapsCount;
-
-               // Query database
-               $dbr = wfGetDB(DB_SLAVE);
-               $res = $dbr->select('wrsleddingcache', array('page_title', 'position_latitude', 'position_longitude'));
-               $sleddingRoutes = array();
-               while ($sleddingRoute = $dbr->fetchRow($res)) $sleddingRoutes[] = $sleddingRoute;
-               $dbr->freeResult($res);
-               
-               // Load Google Maps Script and define functions
-               $output = '';
-               if ($this->mapsCount == 1) {
-                       $output .= '<script src="http://maps.google.com/maps?file=api&amp;v=2&amp;key=' . htmlspecialchars($this->apiKey) . '" type="text/javascript"></script>' . "\n";
-                       $output .= WRGMAPJSFUNCTIONS;
-               }
-                       
-               // Create <div/> element where the map is placed in
-               $mapName = 'wrgmap' . $this->mapsCount;
-               $output .= '<div id="' . $mapName . '" style="width: 100%; height: 450px; border-style:none;"></div>';
-               
-               // Return output
-               $output .= '<script type="text/javascript">' . "\n//<![CDATA[\n";
-               $output .= 'if (GBrowserIsCompatible()) {' . "\n";
-               $output .= $this->addMap($mapName);
-               foreach ($sleddingRoutes as $s) {
-                       $lat = $s['position_latitude'];
-                       $lon = $s['position_longitude'];
-                       $pageTitle = $s['page_title'];
-                       if (!$lat || !$lon) continue;
-                       $output .= $this->addJsMarker($lat, $lon, $pageTitle);
+       public static function render($content, $args, $parser, $frame) {
+               // Unfortunately, $tagname is no argument of this function, therefore we have to use a trick with derived classes.
+               $tagname = strtolower(get_called_class()); // either wrmap or wrgmap
+               assert(in_array($tagname, array('wrmap', 'wrgmap')));
+
+               $parserOutput = $parser->getOutput();
+               $parserOutput->addHeadItem('<script type="text/javascript" src="http://maps.google.com/maps/api/js?v=3.8&amp;sensor=false"></script>', 'googlemaps');
+               $parserOutput->addModules('ext.wrmap');
+
+               // append all sledruns as icon
+               $json_features = array();
+               $show_sledruns = ($tagname == 'wrgmap');
+               if ($show_sledruns) {
+                       $json_features = array_merge($json_features, sledruns_to_json_features());

                }
                }

-               $output .= "}\n//]]>\n</script>\n";
-               return wrMapReplaceByMarker($output);
-       }
-       
-       // returns a string that creates a map object called 'map'
-       private function addMap($mapName) {
-               return "\tvar map = new GMap2(document.getElementById('$mapName'), {'mapTypes': [G_NORMAL_MAP, G_HYBRID_MAP, G_PHYSICAL_MAP, G_SATELLITE_MAP]});\n" .
-               "\tmap.addControl(new GLargeMapControl());\n" .
-               "\tmap.addControl(new GMapTypeControl());\n" .
-               "\tmap.addControl(new GScaleControl());\n" .
-               "\tmap.setCenter(new GLatLng(47.267648, 11.404655), 10);\n" .
-               "\tmap.setMapType(G_PHYSICAL_MAP);\n" .
-               "\tmap.enableScrollWheelZoom();\n";
-       }

 
 

-       // returns a string with a add marker javascript call
-       private function addJsMarker($latitude, $longitude, $pageTitle) {
-               return "\tmap.addOverlay(wrCreateMarker($latitude, $longitude, \"" . htmlspecialchars(addslashes($pageTitle)) . "\", wrSleddingIcon));\n";
-       }
-       
-}
-
-
-/// Format inside <wrmap>...</wrmap> has to be like this:
-///
-/// <wrmap>
-/// Rodelbahn|47.143241 N 11.208959 E|Birgitzer Alm
-/// ...
-/// </wrmap>
-///
-/// The extension produces a format like this:
-/// <googlemap version="0.9" lat="47.241016" lon="11.56517" zoom="11">
-/// 47.241731, 11.358994, Birgitzer Alm
-/// Die Birgitzer Alm ist nett
-/// 47.17607, 11.542763, Naviser Hütte
-/// Die Naviser Hütte
-/// </googlemap>
-function wrmapParserHook($input, $args, $parser) {
-       $debug = (isset($args['debug']) && $args['debug'] != '0');
-
-       $output = '';
-       $lines = explode("\n", $input);
-       $latitudes = array();
-       $longitudes = array();
-       foreach ($lines as $line) {

                try {
                try {

-                       $l = trim($line);
-                       if (strlen($l) == 0) continue;
-                       $columns = explode('|', $line);
-                       if (count($columns) != 3) throw new Exception(sprintf(utf8_encode('Die Anzahl der Spalten ist nicht 3 sondern %d'), count($columns)));
-                       $columns = list($type, $geo, $name) = $columns;
-                       if (strlen(trim($geo)) == 0) continue;
-                       list($latitude, $longitude) = wrGeoStringToGeo($geo);
-                       $latitudes[] = $latitude;
-                       $longitudes[] = $longitude;
-                       $output .= sprintf("%F, %F, %s\n", $latitude, $longitude, htmlspecialchars($name));
+                       // map properties
+                       $properties = array();
+                       if (isset($args['lat'])) $properties['lat'] = (float) $args['lat']; // latitude as float value
+                       if (isset($args['lon'])) $properties['lon'] = (float) $args['lon']; // longitude as float value
+                       if (isset($args['zoom'])) $properties['zoom'] = (int) $args['zoom']; // zoom as int value
+                       if (isset($args['width'])) $properties['width'] = (int) $args['width']; // width as int value
+                       if (isset($args['height'])) $properties['height'] = (int) $args['height']; // height as int value
+
+                       // append all elements in the XML
+                       $json_features = array_merge($json_features, xml_to_json_features('<wrmap>' . $content . '</wrmap>'));

                } catch (Exception $e) {
                } catch (Exception $e) {

-                       return sprintf(utf8_encode('Ungültige Zeile in der Koordinatenliste: <em>%s</em>. %s'), htmlspecialchars($line), htmlspecialchars($e->getMessage()));
+                       $doc = new WrMapDOMDocument();
+                       $doc->appendElement('div', array('class' => 'error'))->appendText('Fehler beim Parsen der Landkarte: ' . $e->getMessage());
+                       return array($doc->saveHTML($doc->firstChild), 'markerType' => 'nowiki');

                }
                }

+
+               // create final geojson
+               $json = array(
+                       'type' => 'FeatureCollection',
+                       'features' => $json_features,
+                       'properties' => $properties
+               );
+               $json_string = json_encode($json);
+
+               // Create <div/> element where the map is placed in
+               global $wgExtensionAssetsPath;
+               $doc = new WrMapDOMDocument();
+               $doc->appendElement('div', array('class' => 'wrmap', 'style' => 'border-style:none;', 'data-img-path' => "$wgExtensionAssetsPath/wrmap/openlayers/img/"))->appendText($json_string);
+               return array($doc->saveHTML($doc->firstChild), 'markerType' => 'nowiki');

        }
        }

-       if (count($latitudes) == 0) return utf8_encode('Keine Koordinaten eingetragen');
-       $minLatitude = min($latitudes);
-       $centerLat = $minLatitude + (max($latitudes) - $minLatitude) / 2;
-       $minLongitude = min($longitudes);
-       $centerLon = $minLongitude + (max($longitudes) - $minLongitude) / 2;
+}

 
 

-       // TODO: Varable zoom level
-       $output = '<googlemap version="0.9" lat="' . $centerLat . '" lon="' . $centerLon . '" type="terrain" zoom="9">'. "\n" . $output . "</googlemap>\n";

 
 

-       if ($debug) return "<pre><nowiki>$output</nowiki></pre>\n";
-       return $parser->recursiveTagParse($output);
+// <wrmap> tag
+class WrMap extends WrBaseMap {

 }
 
 
 }
 
 

+// <wrgmap> tag
+class WrGMap extends WrBaseMap {
+}
+

 ?>
 ?>