Changed map output to DOM based output.
[philipp/winterrodeln/mediawiki_extensions/wrmap.git] / wrmap.body.php
index b4671c00438e071ebc7f559904186f5f5d994c32..ccb5b802d36a901f15b782792d4ab5d4cf83dc81 100644 (file)
@@ -1,5 +1,55 @@
 <?php
 
+// DOM helper classes
+// ------------------
+
+// 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;
+       }
+
+}
+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));
+       }
+
+       // 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
@@ -31,8 +81,8 @@ function sledruns_to_json_features() {
                $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[] = $sledrun['date_report'];
-               if (!is_null($sledrun['condition'])) $properties[] = intval($sledrun['condition']);
+               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(
@@ -53,6 +103,10 @@ function sledruns_to_json_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');
@@ -64,7 +118,7 @@ function xml_to_json_features($input) {
                $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_keys(array_merge($point_type, $line_type))) . '>.');
+                       throw new Exception('Unbekanntes Element <' . $feature->getName() . '>. Erlaubt sind: <' . implode('>, <', array_merge($point_types, $line_types)) . '>.');
                }
 
                // point
@@ -74,7 +128,12 @@ function xml_to_json_features($input) {
                        $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) {
-                               $properties[$property] = (string) $feature[$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.');
@@ -94,8 +153,18 @@ function xml_to_json_features($input) {
                        $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'])) $properties['strokeColor'] = (string) $feature['farbe']; // e.g. #a200b7 // TODO: Check
-                       if (isset($feature['dicke'])) $properties['strokeWidth'] = (int) $feature['dicke']; // e.g. 6 // TODO: Check
+                       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(
@@ -149,7 +218,9 @@ class WrBaseMap {
                        // append all elements in the XML
                        $json_features = array_merge($json_features, xml_to_json_features('<wrmap>' . $content . '</wrmap>'));
                } catch (Exception $e) {
-                       return '<div class="error">' . htmlspecialchars("Fehler beim Parsen der Landkarte: " . $e->getMessage()) . '</div>';
+                       $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
@@ -162,15 +233,9 @@ class WrBaseMap {
 
                // Create <div/> element where the map is placed in
                global $wgExtensionAssetsPath;
-               $width_s = (isset($properties['width'])) ? $width . 'px' : '100%';
-               $height_s = (isset($properties['height']) ? $height : 450) . 'px';
-               $output = "<div class=\"wrmap\" style=\"width: $width_s; height: $height_s; border-style:none;\" data-img-path=\"$wgExtensionAssetsPath/wrmap/openlayers/img/\">";
-               $output .= "<script type=\"application/json\">";
-               $output .= htmlspecialchars($json_string, ENT_NOQUOTES);
-               $output .= "</script>";
-               $output .= "</div>\n";
-               
-               return $output;
+               $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');
        }
 }