Add shadows below markers.

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

diff --git a/wrmap.body.php b/wrmap.body.php
index 04b3d58f34129faba7dd0f8d334709686ba5f9a7..7fc7265657619be24929fb05cd13520df89941de 100644 (file)
--- a/wrmap.body.php
+++ b/wrmap.body.php
@@ -1,4 +1,162 @@
 <?php
 <?php

+/* This extension creates a map using OpenLayers to show sledrun details and sledrun overviews.
+This extension depends on no other extension.
+
+
+Example 1
+---------
+
+<wrgmap lat="47.267648" lon="11.40465" zoom="10"/>
+
+(Shows icons for all sledruns. lat, lon and zoom are optional.)
+
+
+Example 2
+---------
+
+<wrmap lat="47.2417134" lon="11.21408895" zoom="14" width="700" height="400">
+
+<gasthaus name="Rosskogelhütte" wiki="Rosskogelhütte">47.240689 11.190454</gasthaus>
+<gasthaus name="Stiglreith">47.238186 11.221940</gasthaus>
+<gasthaus name="Sulzstich">47.240287 11.203006</gasthaus>
+<parkplatz>47.245789 11.238971</parkplatz>
+<parkplatz>47.237627 11.218886</parkplatz>
+<haltestelle name="Oberperfuss Rangger Köpfl Lift">47.245711 11.238283</haltestelle>
+<achtung name="Kreuzung mit Schipiste">47.2383200 11.2235592</achtung>
+
+<gehweg>
+47.238587 11.203360
+47.239743 11.203522
+47.240135 11.203247
+</gehweg>
+
+<gehweg>
+47.238442 11.203263
+47.237799 11.203511
+47.237133 11.202988
+47.238091 11.206642
+47.237273 11.211675
+47.237133 11.214466
+47.237513 11.218199
+</gehweg>
+
+<alternative>
+47.240487 11.190169
+47.238996 11.188628
+47.238987 11.188018
+47.238267 11.187075
+47.238461 11.190511
+47.239751 11.191795
+47.240037 11.192702
+47.239525 11.193535
+47.239688 11.194272
+47.239017 11.193925
+47.239536 11.195457
+47.240063 11.196230
+47.240747 11.196658
+47.239734 11.198295
+47.238857 11.198346
+47.237743 11.199778
+47.238250 11.202755
+47.238587 11.203360
+</alternative>
+
+<rodelbahn>
+47.238587 11.203360
+47.238185 11.203982
+47.238297 11.204381
+47.239417 11.204972
+47.239210 11.208772
+47.238999 11.209523
+47.239126 11.209839
+47.238933 11.210641
+47.239102 11.210739
+47.238666 11.215042
+47.238203 11.216089
+47.238183 11.218151
+47.237851 11.218599
+47.238055 11.219755
+47.237686 11.222441
+47.238000 11.223367
+47.238625 11.223687
+47.239915 11.223118
+47.240992 11.219781
+47.243412 11.214141
+47.243207 11.218331
+47.243990 11.216205
+47.243785 11.223251
+47.242845 11.228510
+47.242917 11.232501
+47.242524 11.235001
+47.244737 11.231791
+47.244951 11.230868
+47.245470 11.237853
+</rodelbahn>
+
+<lift>
+47.245656 11.237286
+47.238189 11.221344
+</lift>
+
+</wrmap>
+
+
+
+Definition
+----------
+
+* <wrmap>...</wrmap> has to be valid XML.
+* All coordinates are in WGS84 coordinate system.
+* Coordinates have the preferred format "latitude N longitude E",
+  however for parsing the N and E can be omitted.
+* <wrmap> has the following attributes:
+       * lat (float): latitude of map-center, optional.
+       * lon (float): longitude of map-center, optional.
+       * zoom (integer): zoom level of the map (google zoom levels). optional.
+       * width (integer): width of the map in pixel. optional (100% if omitted)
+       * height (integer): height of the map in pixel. optional.
+       * <wrmap> can have any number of the following sub-elements:
+               * <gasthaus>
+               * <haltestelle>
+               * <parkplatz>
+               * <achtung>
+               * <foto>
+               * <verleih>
+               * <punkt>
+               * <rodelbahn>
+               * <alternative>
+               * <gehweg>
+               * <lift>
+               * <anfahrt>
+               * <linie>
+       * The order may be used by the renderer to determine in which order the
+         elements should be drawn.
+* <gasthaus>, <haltestelle>, <parkplatz>, <achtung>, <foto>, <verleih> and <punkt> define points
+       * The elements may have the following attributes:
+               * name (string): defines the name (not the label) of the element
+               * wiki (string): name of a MediaWiki page the point refers to
+       * The content is exactly one coordinate pair.
+* <rodelbahn>, <alternative>, <gehweg>, <lift>, <anfahrt> and <linie>
+  define non-closed polygons.
+       * They may have the following attributes:
+               farbe (hex format, e.g. #12a50f): color of the line
+               dicke (int): width of the line in pixel
+       * The content of the elements are a whitespace separated list of
+               coordinates.
+
+
+For transmitting the map to javascript, geojson is used in the <div> element of the map.
+This way, an extra request is avoided. The geojson format used here consists of a single
+"FeatureCollection" (representing the <wrmap>) containing the sub-elements of wrmap
+as features.
+The features have an properties key that has a hash as values with the properties of
+the XML subelements of wrmap. Optional attributes/properties can be omitted.
+Additionally one mandatory property key is called 'type' and has the sub-element's name
+as value.
+The featurecollection itself has a properties key as well containing the attributes of
+the wrmap element.
+*/
+

 
 // DOM helper classes
 // ------------------
 
 // DOM helper classes
 // ------------------


@@ -129,7 +287,7 @@ class WrBaseMap {
                        $image_url = WrBaseMap::wikipage_to_image($title, 150);
                        if (!is_null($image_url)) $properties['thumb_url'] = $image_url;
                        $json_feature = array(
                        $image_url = WrBaseMap::wikipage_to_image($title, 150);
                        if (!is_null($image_url)) $properties['thumb_url'] = $image_url;
                        $json_feature = array(

-                               'type' => 'feature',
+                               'type' => 'Feature',

                                'geometry' => array(
                                        'type' => 'Point',
                                        'coordinates' => array($lon, $lat)
                                'geometry' => array(
                                        'type' => 'Point',
                                        'coordinates' => array($lon, $lat)


@@ -185,7 +343,7 @@ class WrBaseMap {
                                $coordinates = WrBaseMap::geo_to_coordinates($feature);
                                if (count($coordinates) != 1) throw new Exception(wfMessage('wrmap-error-coordinate-count', $feature->getName())->text());
                                $json_feature = array(
                                $coordinates = WrBaseMap::geo_to_coordinates($feature);
                                if (count($coordinates) != 1) throw new Exception(wfMessage('wrmap-error-coordinate-count', $feature->getName())->text());
                                $json_feature = array(

-                                       'type' => 'feature',
+                                       'type' => 'Feature',

                                        'geometry' => array(
                                                'type' => 'Point',
                                                'coordinates' => reset($coordinates)
                                        'geometry' => array(
                                                'type' => 'Point',
                                                'coordinates' => reset($coordinates)


@@ -202,7 +360,7 @@ class WrBaseMap {
                                if (count($wrong_properties) > 0) throw new Exception(wfMessage('wrmap-error-invalid-attribute',  reset($wrong_properties), $feature->getName(), "'" . implode("', '", $allowed_properties) . "'")->text());
                                if (isset($feature['farbe'])) {
                                        $color = (string) $feature['farbe']; // e.g. #a200b7
                                if (count($wrong_properties) > 0) throw new Exception(wfMessage('wrmap-error-invalid-attribute',  reset($wrong_properties), $feature->getName(), "'" . implode("', '", $allowed_properties) . "'")->text());
                                if (isset($feature['farbe'])) {
                                        $color = (string) $feature['farbe']; // e.g. #a200b7

-                                       if (preg_match('/^#[0-9a-f]{6}$/i', $color) != 1) 
+                                       if (preg_match('/^#[0-9a-f]{6}$/i', $color) != 1)

                                                throw new Exception(wfMessage('wrmap-error-line-color')->text());
                                        $properties['strokeColor'] = $color;
                                }
                                                throw new Exception(wfMessage('wrmap-error-line-color')->text());
                                        $properties['strokeColor'] = $color;
                                }


@@ -213,7 +371,7 @@ class WrBaseMap {
                                        $properties['strokeWidth'] = $stroke_width;
                                }
                                $json_feature = array(
                                        $properties['strokeWidth'] = $stroke_width;
                                }
                                $json_feature = array(

-                                       'type' => 'feature',
+                                       'type' => 'Feature',

                                        'geometry' => array(
                                                'type' => 'LineString',
                                                'coordinates' => WrBaseMap::geo_to_coordinates($feature)
                                        'geometry' => array(
                                                'type' => 'LineString',
                                                'coordinates' => WrBaseMap::geo_to_coordinates($feature)


@@ -241,7 +399,8 @@ class WrBaseMap {
                assert(in_array($tagname, array('wrmap', 'wrgmap')));
 
                $parserOutput = $parser->getOutput();
                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->addHeadItem('<script src="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.5.0/build/ol.js"></script>', 'openlayers_js');
+               $parserOutput->addHeadItem('<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.5.0/css/ol.css">', 'openlayers_css');

                $parserOutput->addModules('ext.wrmap');
 
                // append all sledruns as icon
                $parserOutput->addModules('ext.wrmap');
 
                // append all sledruns as icon


@@ -279,12 +438,16 @@ class WrBaseMap {
                // Create <div/> element where the map is placed in
                global $wgExtensionAssetsPath;
                $doc = new WrMapDOMDocument();
                // Create <div/> element where the map is placed in
                global $wgExtensionAssetsPath;
                $doc = new WrMapDOMDocument();

-               $div = $doc->appendElement('div', array('class' => 'wrmap', 'style' => 'border-style:none;', 'data-ext-path' => "$wgExtensionAssetsPath/wrmap"));
+               $div_map = $doc->appendElement('div', array('class' => 'wrmap', 'style' => 'border-style:none;', 'data-ext-path' => "$wgExtensionAssetsPath/wrmap"));

                // progress message
                // progress message

-               $div->appendElement('div', array())->appendText(wfMessage('wrmap-loading')->text());
+               $div_map->appendElement('div', array())->appendText(wfMessage('wrmap-loading')->text());

                // data
                // data

-               $div->appendElement('div', array('style' => 'height: 0px; display:none;'))->appendText($json_string);
-               return array($doc->saveHTML($div), 'markerType' => 'nowiki');
+               $div_map->appendElement('div', array('style' => 'height: 0px; display:none;'))->appendText($json_string);
+               // popup
+               $div_popup = $doc->appendElement('div', array('id' => 'popup', 'class' => 'ol-popup'));
+               $div_popup->appendElement('a', array('id' => 'popup-closer', 'href' => '#', 'class' => 'ol-popup-closer'));
+               $div_popup->appendElement('div', array('id' => 'popup-content'));
+               return array($doc->saveHTML($div_map) . $doc->saveHTML($div_popup), 'markerType' => 'nowiki');

        }
 
 
        }
 
 


@@ -297,11 +460,19 @@ class WrBaseMap {
 
 // <wrmap> tag
 class WrMap extends WrBaseMap {
 
 // <wrmap> tag
 class WrMap extends WrBaseMap {

+       public static function onParserFirstCallInit(Parser $parser) {
+               $parser->setHook('wrmap', 'WrMap::render');
+               return true;
+       }

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

+       public static function onParserFirstCallInit(Parser $parser) {
+               $parser->setHook('wrgmap', 'WrGMap::render');
+               return true;
+       }

 }
 
 ?>
 }
 
 ?>