Fixed typo in comment.
[philipp/winterrodeln/mediawiki_extensions/wrmap.git] / wrmap.body.php
1 <?php
2
3 // DOM helper classes
4 // ------------------
5
6 // The following two classes are "duplicated" from the wrreport extension to keep them separate.
7 // Put improvements in both classes.
8 class WrMapDOMDocument extends DOMDocument {
9         function __construct() {
10                 parent::__construct('1.0', 'utf-8');
11                 $this->registerNodeClass('DOMElement', 'WrMapDOMElement');
12         }
13
14         /// Creates and adds the element with the given tag name and returns it.
15         /// Additionally, it calls setAttribute($key, $value) for every entry
16         /// in $attributes.
17         function appendElement($tagName, $attributes=array()) {
18                 $child = $this->appendChild($this->createElement($tagName));
19                 foreach ($attributes as $key => $value) $child->setAttribute($key, $value);
20                 return $child;
21         }
22
23 }
24 class WrMapDOMElement extends DOMElement {
25
26         /// Creates and adds the element with the given tag name and returns it
27         /// Additionally, it calls setAttribute($key, $value) for every entry
28         /// in $attributes.
29         function appendElement($tagName, $attributes=array()) {
30                 $child = $this->appendChild($this->ownerDocument->createElement($tagName));
31                 foreach ($attributes as $key => $value) $child->setAttribute($key, $value);
32                 return $child;
33         }
34
35         /// Adds any UTF-8 string as content of the element - it will be escaped.
36         function appendText($text) {
37                 return $this->appendChild($this->ownerDocument->createTextNode($text));
38         }
39
40         // Appends a CDATASections to the element. This can be used to include
41         // raw (unparsed) HTML to the DOM tree as it is necessary because
42         // $parser->recursiveTagParse does not always escape & characters.
43         // (see https://bugzilla.wikimedia.org/show_bug.cgi?id=55526 )
44         // Workaround: Use a CDATA section. When serializing with $doc->saveHTML,
45         // the <![CDATA[...]]> is returned as ... .
46         // However, we end up having unescaped & in the output due to this bug in recursiveTagParse.
47         function appendCDATA($data) {
48                 return $this->appendChild($this->ownerDocument->createCDATASection($data));
49         }
50 }
51
52
53 // gets coordinates and returns an array of lon/lat coordinate pairs, e.g.
54 // 47.12 N 11.87 E
55 // 47.13 N 11.70 E
56 // ->
57 // array(array(11.87, 47.12), array(11.70, 47.13))
58 function geo_to_coordinates($input) {
59         $matches = array();
60         $num_matches = preg_match_all('/\s*(\d+\.?\d*)\s*N?\s+(\d+\.?\d*)\s*E?\s*/', $input, $matches);
61         $result = array();
62         for ($i=0; $i!=$num_matches; ++$i) {
63                 $result[] = array(floatval($matches[2][$i]), floatval($matches[1][$i]));
64         }
65         if (implode($matches[0]) != $input) throw new Exception('Falsches Koordinatenformat: ' . $input);
66         return $result;
67 }
68
69
70 // convert sledruns to geojson (http://www.geojson.org/geojson-spec.html)
71 // Returns an array of features
72 function sledruns_to_json_features() {
73         $json_features = array(); // result
74         $dbr = wfGetDB(DB_SLAVE);
75         $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')));
76         while ($sledrun = $dbr->fetchRow($res)) {
77                 $lat = $sledrun['position_latitude'];
78                 $lon = $sledrun['position_longitude'];
79                 if (is_null($lat) || is_null($lon)) continue;
80                 $lat = floatval($lat);
81                 $lon = floatval($lon);
82                 $title = Title::newFromText($sledrun['page_title']);
83                 $properties = array('type' => 'sledrun', 'name' => $title->getText(), 'wiki' => $title->getLocalUrl());
84                 if (!is_null($sledrun['date_report'])) $properties['date_report'] = $sledrun['date_report'];
85                 if (!is_null($sledrun['condition'])) $properties['condition'] = intval($sledrun['condition']);
86                 $json_feature = array(
87                         'type' => 'feature',
88                         'geometry' => array(
89                                 'type' => 'Point',
90                                 'coordinates' => array($lon, $lat)
91                         ),
92                         'properties' => $properties
93                 );
94                 $json_features[] = $json_feature;
95         }
96         $dbr->freeResult($res);
97         return $json_features;
98 }
99
100
101 // convert XML to geojson (http://www.geojson.org/geojson-spec.html)
102 // Returns an array of features
103 function xml_to_json_features($input) {
104         libxml_use_internal_errors(true); // without that, we get PHP Warnings if the $input is not well-formed
105         $xml = new SimpleXMLElement($input); // input
106         $whitespace = (string) $xml; // everything between <wrmap> and </wrmap> that's not a sub-element
107         if (strlen($whitespace) > 0 && !ctype_space($whitespace)) { // there must not be anythin except sub-elements or whitespace
108                 throw new Exception('Die Landkarte enthält folgenden ungültigen Text: "' . trim($xml) . '".');
109         }
110         $json_features = array(); // output
111         $point_types = array('gasthaus', 'haltestelle', 'parkplatz', 'achtung', 'foto', 'punkt');
112         $line_types = array('rodelbahn', 'gehweg', 'alternative', 'lift', 'anfahrt', 'linie');
113         foreach ($xml as $feature) {
114                 $given_properties = array();
115                 foreach ($feature->attributes() as $key => $value) $given_properties[] = $key;
116
117                 // determine feature type
118                 $is_point = in_array($feature->getName(), $point_types);
119                 $is_line = in_array($feature->getName(), $line_types);
120                 if (!$is_point && !$is_line) {
121                         throw new Exception('Unbekanntes Element <' . $feature->getName() . '>. Erlaubt sind: <' . implode('>, <', array_merge($point_types, $line_types)) . '>.');
122                 }
123
124                 // point
125                 if ($is_point) {
126                         $properties = array('type' => $feature->getName());
127                         $allowed_properties = array('name', 'wiki');
128                         $wrong_properties = array_diff($given_properties, $allowed_properties);
129                         if (count($wrong_properties) > 0) throw new Exception("Das Attribut '" . reset($wrong_properties) . "' ist nicht erlaubt bei <" . $feature->getName() . ">. Erlaubt sind: '" . implode("', '", $allowed_properties) . "'.");
130                         foreach ($given_properties as $property) {
131                                 $propval = (string) $feature[$property];
132                                 if ($property == 'wiki') {
133                                         $title = Title::newFromText($propval);
134                                         $propval = $title->getLocalUrl();
135                                 }
136                                 $properties[$property] = $propval;
137                         }
138                         $coordinates = geo_to_coordinates($feature);
139                         if (count($coordinates) != 1) throw new Exception('Das Element <' . $feature->getName() . '> muss genau ein Koordinatenpaar haben.');
140                         $json_feature = array(
141                                 'type' => 'feature',
142                                 'geometry' => array(
143                                         'type' => 'Point',
144                                         'coordinates' => reset($coordinates)
145                                 ),
146                                 'properties' => $properties
147                         );
148                         $json_features[] = $json_feature;
149                 }
150                 // line
151                 if ($is_line) {
152                         $properties = array('type' => $feature->getName());
153                         $allowed_properties = array('farbe', 'dicke');
154                         $wrong_properties = array_diff($given_properties, $allowed_properties);
155                         if (count($wrong_properties) > 0) throw new Exception("Das Attribut '" . reset($wrong_properties) . "' ist nicht erlaubt bei <" . $feature->getName() . ">. Erlaubt sind: '" . implode("', '", $allowed_properties) . "'.");
156                         if (isset($feature['farbe'])) {
157                                 $color = (string) $feature['farbe']; // e.g. #a200b7
158                                 if (preg_match('/^#[0-9a-f]{6}$/i', $color) != 1) 
159                                         throw new Exception('Die Farbangabe der Linie hat ein falsches Format. Sie muss z.B. so aussehen: #a200b7.');
160                                 $properties['strokeColor'] = $color;
161                         }
162                         if (isset($feature['dicke'])) {
163                                 $stroke_width = (int) $feature['dicke']; // e.g. 6
164                                 if (((string) $stroke_width) !== (string) $feature['dicke'])
165                                         throw new Exception('Die Angabe der Liniendicke hat ein falsches Format. Sie muss eine ganze Zahl wie z.B. 6 sein.');
166                                 $properties['strokeWidth'] = $stroke_width;
167                         }
168                         $json_feature = array(
169                                 'type' => 'feature',
170                                 'geometry' => array(
171                                         'type' => 'LineString',
172                                         'coordinates' => geo_to_coordinates($feature)
173                                 ),
174                                 'properties' => $properties
175                         );
176                         $json_features[] = $json_feature;
177                 }
178         }
179         return $json_features;
180 }
181
182
183
184 class WrBaseMap {
185         /// Renders the <wrgmap> tag and the <wrmap> tag.
186         /// This class would be the only class needed but as the function render() does not provide an argument
187         /// telling which tag name called the function, a trick with two inherited classes has to be used.
188         /// @param $content string - the content of the <wrgmap> tag
189         /// @param $args array - the array of attribute name/value pairs for the tag
190         /// @param $parser Parser - the MW Parser object for the current page
191         ///
192         /// @return string - the html for rendering the map
193         public static function render($content, $args, $parser, $frame) {
194                 // Unfortunately, $tagname is no argument of this function, therefore we have to use a trick with derived classes.
195                 $tagname = strtolower(get_called_class()); // either wrmap or wrgmap
196                 assert(in_array($tagname, array('wrmap', 'wrgmap')));
197
198                 $parserOutput = $parser->getOutput();
199                 $parserOutput->addHeadItem('<script type="text/javascript" src="http://maps.google.com/maps/api/js?v=3.8&amp;sensor=false"></script>', 'googlemaps');
200                 $parserOutput->addModules('ext.wrmap');
201
202                 // append all sledruns as icon
203                 $json_features = array();
204                 $show_sledruns = ($tagname == 'wrgmap');
205                 if ($show_sledruns) {
206                         $json_features = array_merge($json_features, sledruns_to_json_features());
207                 }
208
209                 try {
210                         // map properties
211                         $properties = array();
212                         if (isset($args['lat'])) $properties['lat'] = (float) $args['lat']; // latitude as float value
213                         if (isset($args['lon'])) $properties['lon'] = (float) $args['lon']; // longitude as float value
214                         if (isset($args['zoom'])) $properties['zoom'] = (int) $args['zoom']; // zoom as int value
215                         if (isset($args['width'])) $properties['width'] = (int) $args['width']; // width as int value
216                         if (isset($args['height'])) $properties['height'] = (int) $args['height']; // height as int value
217
218                         // append all elements in the XML
219                         $json_features = array_merge($json_features, xml_to_json_features('<wrmap>' . $content . '</wrmap>'));
220                 } catch (Exception $e) {
221                         $doc = new WrMapDOMDocument();
222                         $doc->appendElement('div', array('class' => 'error'))->appendText('Fehler beim Parsen der Landkarte: ' . $e->getMessage());
223                         return array($doc->saveHTML($doc->firstChild), 'markerType' => 'nowiki');
224                 }
225
226                 // create final geojson
227                 $json = array(
228                         'type' => 'FeatureCollection',
229                         'features' => $json_features,
230                         'properties' => $properties
231                 );
232                 $json_string = json_encode($json);
233
234                 // Create <div/> element where the map is placed in
235                 global $wgExtensionAssetsPath;
236                 $doc = new WrMapDOMDocument();
237                 $div = $doc->appendElement('div', array('class' => 'wrmap', 'style' => 'border-style:none;', 'data-img-path' => "$wgExtensionAssetsPath/wrmap/openlayers/img/"));
238                 // progress message
239                 $div->appendElement('div', array())->appendText('Die Landkarte wird geladen...');
240                 // data
241                 $div->appendElement('div', array('style' => 'height: 0px; display:none;'))->appendText($json_string);
242                 return array($doc->saveHTML($div), 'markerType' => 'nowiki');
243         }
244 }
245
246
247 // <wrmap> tag
248 class WrMap extends WrBaseMap {
249 }
250
251
252 // <wrgmap> tag
253 class WrGMap extends WrBaseMap {
254 }
255
256 ?>