xref: /plugin/openlayersmap/syntax/olmap.php (revision 09b6a4ff82da6e4871af2765aee9171d2a751cbe) 
1<?php
2/*
3 * Copyright (c) 2008-2011 Mark C. Prins <mc.prins@gmail.com>
4*
5* Permission to use, copy, modify, and distribute this software for any
6* purpose with or without fee is hereby granted, provided that the above
7* copyright notice and this permission notice appear in all copies.
8*
9* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16*/
17
18/**
19 * Plugin OL Maps: Allow Display of a OpenLayers Map in a wiki page.
20 *
21 * @author Mark Prins
22 */
23
24if (!defined('DOKU_INC'))
25define('DOKU_INC', realpath(dirname(__FILE__) . '/../../') . '/');
26if (!defined('DOKU_PLUGIN'))
27define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
28require_once (DOKU_PLUGIN . 'syntax.php');
29
30/**
31 * All DokuWiki plugins to extend the parser/rendering mechanism
32 * need to inherit from this class
33 */
34class syntax_plugin_openlayersmap_olmap extends DokuWiki_Syntax_Plugin {
35	/** defaults of the known attributes of the olmap tag. */
36	private $dflt = array (
37		'id'		=> 'olmap',
38		'width'		=> '550px',
39		'height'	=> '450px',
40		'lat'		=> 50.0,
41		'lon'		=> 5.1,
42		'zoom'		=> 12,
43		'toolbar'	=> true,
44		'statusbar'	=> true,
45		'controls'	=> true,
46		'poihoverstyle'	=> false,
47		'baselyr'	=>'OpenStreetMap',
48	 	'gpxfile'	=> '',
49 		'kmlfile'	=> '',
50		'summary'	=>''
51	);
52
53	/**
54	 * Return the type of syntax this plugin defines.
55	 * @Override
56	 */
57	function getType() {
58		return 'substition';
59	}
60
61	/**
62	 * Defines how this syntax is handled regarding paragraphs.
63	 * @Override
64	 */
65	function getPType() {
66		//normal block stack
67		return 'block';
68	}
69
70	/**
71	 * Returns a number used to determine in which order modes are added.
72	 * @Override
73	 */
74	function getSort() {
75		return 901;
76	}
77
78	/**
79	 * This function is inherited from Doku_Parser_Mode.
80	 * Here is the place to register the regular expressions needed
81	 * to match your syntax.
82	 * @Override
83	 */
84	function connectTo($mode) {
85		$this->Lexer->addSpecialPattern('<olmap ?[^>\n]*>.*?</olmap>', $mode, 'plugin_openlayersmap_olmap');
86	}
87
88	/**
89	 * handle each olmap tag. prepare the matched syntax for use in the renderer.
90	 * @Override
91	 */
92	function handle($match, $state, $pos, &$handler) {
93		// break matched cdata into its components
94		list ($str_params, $str_points) = explode('>', substr($match, 7, -9), 2);
95		// get the lat/lon for adding them to the metadata (used by geotag)
96		preg_match('(lat[:|=]\"\d*\.\d*\")',$match,$mainLat);
97		preg_match('(lon[:|=]\"\d*\.\d*\")',$match,$mainLon);
98		$mainLat=substr($mainLat[0],5,-1);
99		$mainLon=substr($mainLon[0],5,-1);
100
101		$gmap = $this->_extract_params($str_params);
102		$overlay = $this->_extract_points($str_points);
103
104		$imgUrl = "{{";
105		// choose maptype based on tag
106		if (stripos($gmap['baselyr'],'google')>0){
107			// use google
108			$imgUrl .= $this->_getGoogle($gmap, $overlay);
109		}elseif (stripos($gmap['baselyr'],'ve')>0){
110			// use bing
111			$imgUrl .= $this->_getBing($gmap, $overlay);
112		}elseif (stripos($gmap['baselyr'],'mapquest')>0){
113			// use mapquest
114			$imgUrl .=$this->_getMapQuest($gmap,$overlay);
115		}else {
116			// use http://staticmap.openstreetmap.de
117			$imgUrl .=$this->_getStaticOSM($gmap,$overlay);
118		}
119
120		// append dw specific params
121		$imgUrl .="&.png?".$gmap['width']."x".$gmap['height'];
122		$imgUrl .= "&nolink";
123		$imgUrl .= " |".$gmap['summary']." }} ";
124		// remove 'px'
125		$imgUrl = str_replace("px", "",$imgUrl);
126
127		$imgUrl=p_render("xhtml", p_get_instructions($imgUrl), $info);
128
129		$mapid = $gmap['id'];
130
131		// determine width and height (inline styles) for the map image
132		// if ($gmap['width'] || $gmap['height']) {
133		//	$style = $gmap['width'] ? 'width: ' . $gmap['width'] . ";" : "";
134		//	$style .= $gmap['height'] ? 'height: ' . $gmap['height'] . ";" : "";
135		//	$style = "style='$style'";
136		// } else {
137		//	$style = '';
138		//}
139
140		// unset gmap values for width and height - they don't go into javascript
141		// unset ($gmap['width'], $gmap['height']);
142
143		// create a javascript parameter string for the map
144		$param = '';
145		foreach ($gmap as $key => $val) {
146			$param .= is_numeric($val) ? "$key: $val, " : "$key: '" . hsc($val) . "', ";
147		}
148		if (!empty ($param)) {
149			$param = substr($param, 0, -2);
150		}
151		unset ($gmap['id']);
152
153		// create a javascript serialisation of the point data
154		$poi = '';
155		$poitable='';
156		$rowId=0;
157		if (!empty ($overlay)) {
158			foreach ($overlay as $data) {
159				list ($lat, $lon, $text, $angle, $opacity, $img) = $data;
160				$rowId++;
161				$poi .= ", {lat: $lat, lon: $lon, txt: '$text', angle: $angle, opacity: $opacity, img: '$img', rowId: $rowId}";
162				$poitable .='
163			<tr>
164				<td class="rowId">'.$rowId.'</td>
165				<td class="icon"><img src="'.DOKU_BASE.'/lib/plugins/openlayersmap/icons/'.$img.'" alt="icon" /></td>
166				<td class="lat" title="'.$this->getLang('olmapPOIlatTitle').'">'.$lat.'</td>
167				<td class="lon" title="'.$this->getLang('olmapPOIlonTitle').'">'.$lon.'</td>
168				<td class="txt">'.$text.'</td>
169			</tr>';
170			}
171			$poi = substr($poi, 2);
172		}
173		$js .= "createMap({" . $param . " },[$poi]);";
174		// unescape the json
175		$poitable = stripslashes($poitable);
176
177		return array($mapid,$js,$mainLat,$mainLon,$poitable,$gmap['summary'],$imgUrl);
178	}
179
180	/**
181	 * render html tag/output. render the content.
182	 * @Override
183	 */
184	function render($mode, &$renderer, $data) {
185		static $initialised = false; // set to true after script initialisation
186		list ($mapid, $param, $mainLat, $mainLon, $poitable, $poitabledesc, $staticImgUrl) = $data;
187
188		if ($mode == 'xhtml') {
189			$olscript = '';
190			$olEnable = false;
191			$gscript = '';
192			$gEnable = $this->getConf('enableGoogle');
193			$vscript = '';
194			$vEnable = false;
195			//$yscript = '';
196			//$yEnable = false;
197			$mqEnable = $this->getConf('enableMapQuest');
198			$osmEnable = $this->getConf('enableOSM');
199
200			$scriptEnable = '';
201
202			if (!$initialised) {
203				$initialised = true;
204				// render necessary script tags
205				// 				$gscript = $this->getConf('googleScriptUrl');
206				// 				$gscript = $gscript ? '<script type="text/javascript" src="' . $gscript . '"></script>' : "";
207				if($gEnable){
208					$gscript ='<script src="http://maps.google.com/maps/api/js?v=3&sensor=false"></script>';
209				}
210
211				$vscript = $this->getConf('veScriptUrl');
212				$vscript = $vscript ? '<script type="text/javascript" src="' . $vscript . '"></script>' : "";
213
214				//$yscript = $this->getConf('yahooScriptUrl');
215				//$yscript = $yscript ? '<script type="text/javascript" src="' . $yscript . '"></script>' : "";
216
217				$olscript = $this->getConf('olScriptUrl');
218				$olscript = $olscript ? '<script type="text/javascript" src="' . $olscript . '"></script>' : "";
219				$olscript = str_replace('DOKU_PLUGIN', DOKU_PLUGIN, $olscript);
220
221				$scriptEnable = '<script type="text/javascript">' . "\n" . '<!--//--><![CDATA[//><!--' . "\n";
222				$scriptEnable .= $olscript ? 'olEnable = true;' : 'olEnable = false;';
223				//$scriptEnable .= $yscript ? ' yEnable = true;' : ' yEnable = false;';
224				$scriptEnable .= $vscript ? ' veEnable = true;' : ' veEnable = false;';
225				$scriptEnable .= 'gEnable = '.($gEnable ? 'true' : 'false').';';
226				$scriptEnable .= 'osmEnable = '.($osmEnable ? 'true' : 'false').';';
227				$scriptEnable .= 'mqEnable = '.($mqEnable ? 'true' : 'false').';';
228				$scriptEnable .= "\n" . '//--><!]]>' . "\n" . '</script>';
229			}
230			$renderer->doc .= "
231			$gscript
232			$vscript
233			$olscript
234			$scriptEnable";
235
236			$renderer->doc .= '
237				<div id="'.$mapid.'-static" class="olStaticMap">'.$staticImgUrl.'</div>
238				<div id="'.$mapid.'-clearer" class="clearer"></div>';
239
240			// render a (hidden) table of the POI for the print and a11y presentation
241			$renderer->doc .= ' 	<div class="olPOItableSpan" id="'.$mapid.'-table-span"><table class="olPOItable" id="'.$mapid.'-table" summary="'.$poitabledesc.'" title="'.$this->getLang('olmapPOItitle').'">
242		<caption class="olPOITblCaption">'.$this->getLang('olmapPOItitle').'</caption>
243		<thead class="olPOITblHeader">
244			<tr>
245				<th class="rowId" scope="col">id</th>
246				<th class="icon" scope="col">'.$this->getLang('olmapPOIicon').'</th>
247				<th class="lat" scope="col" title="'.$this->getLang('olmapPOIlatTitle').'">'.$this->getLang('olmapPOIlat').'</th>
248				<th class="lon" scope="col" title="'.$this->getLang('olmapPOIlonTitle').'">'.$this->getLang('olmapPOIlon').'</th>
249				<th class="txt" scope="col">'.$this->getLang('olmapPOItxt').'</th>
250			</tr>
251		</thead>
252		<tfoot class="olPOITblFooter"><tr><td colspan="5">'.$poitabledesc.'</td></tr></tfoot>
253		<tbody class="olPOITblBody">'.$poitable.'</tbody>
254	</table></div>';
255			//TODO no tfoot when $poitabledesc is empty
256
257			// render inline mapscript
258			$renderer->doc .="				<script type='text/javascript'><!--//--><![CDATA[//><!--
259			    var $mapid = $param
260			   //--><!]]></script>";
261
262		} elseif ($mode == 'metadata') {
263			// render metadata if available
264			if (!(($this->dflt['lat']==$mainLat)||($thisdflt['lon']==$mainLon))){
265				// unless they are the default
266				$renderer->meta['geo']['lat'] = $mainLat;
267				$renderer->meta['geo']['lon'] = $mainLon;
268			}
269			return true;
270		}
271		return false;
272	}
273
274	/**
275	 * extract parameters for the map from the parameter string
276	 *
277	 * @param   string    $str_params   string of key="value" pairs
278	 * @return  array                   associative array of parameters key=>value
279	 */
280	private function _extract_params($str_params) {
281		$param = array ();
282		preg_match_all('/(\w*)="(.*?)"/us', $str_params, $param, PREG_SET_ORDER);
283		// parse match for instructions, break into key value pairs
284		$gmap = $this->dflt;
285		foreach ($param as $kvpair) {
286			list ($match, $key, $val) = $kvpair;
287			$key = strtolower($key);
288			if (isset ($gmap[$key])){
289				if ($key == 'summary'){
290					// preserve case for summary field
291					$gmap[$key] = $val;
292				}else {
293					$gmap[$key] = strtolower($val);
294				}
295			}
296		}
297		return $gmap;
298	}
299
300	/**
301	 * extract overlay points for the map from the wiki syntax data
302	 *
303	 * @param   string    $str_points   multi-line string of lat,lon,text triplets
304	 * @return  array                   multi-dimensional array of lat,lon,text triplets
305	 */
306	private function _extract_points($str_points) {
307		$point = array ();
308		//preg_match_all('/^([+-]?[0-9].*?),\s*([+-]?[0-9].*?),(.*?),(.*?),(.*?),(.*)$/um', $str_points, $point, PREG_SET_ORDER);
309		/*
310		group 1: ([+-]?[0-9]+(?:\.[0-9]*)?)
311		group 2: ([+-]?[0-9]+(?:\.[0-9]*)?)
312		group 3: (.*?)
313		group 4: (.*?)
314		group 5: (.*?)
315		group 6: (.*)
316		*/
317		preg_match_all('/^([+-]?[0-9]+(?:\.[0-9]*)?),\s*([+-]?[0-9]+(?:\.[0-9]*)?),(.*?),(.*?),(.*?),(.*)$/um', $str_points, $point, PREG_SET_ORDER);
318		// create poi array
319		$overlay = array ();
320		foreach ($point as $pt) {
321			list ($match, $lat, $lon, $angle, $opacity, $img, $text) = $pt;
322			$lat = is_numeric($lat) ? $lat : 0;
323			$lon = is_numeric($lon) ? $lon : 0;
324			$angle = is_numeric($angle) ? $angle : 0;
325			$opacity = is_numeric($opacity) ? $opacity : 0.8;
326			$img = trim($img);
327			// TODO validate using exist & set up default img?
328			$text = addslashes(str_replace("\n", "", p_render("xhtml", p_get_instructions($text), $info)));
329			$overlay[] = array($lat, $lon, $text, $angle, $opacity, $img);
330		}
331		return $overlay;
332	}
333
334	/**
335	 * Create a MapQuest static map API image url.
336	 * @param array $gmap
337	 * @param array $overlay
338	 */
339	private function _getMapQuest($gmap,$overlay) {
340		$sUrl=$this->getConf('iconUrlOverload');
341		if (!$sUrl){
342			$sUrl=DOKU_URL;
343		}
344		switch ($gmap['baselyr']){
345			case 'mq hybrid':
346				$maptype='hyb (Hybrid)';
347				break;
348			case 'mq sat':
349				$maptype='sat (Satellite)';
350				break;
351			case 'mq normal':
352			default:
353				$maptype='map';
354				break;
355		}
356
357
358		$imgUrl = "http://open.mapquestapi.com/staticmap/v3/getmap";
359		$imgUrl .= "?center=".$gmap['lat'].",".$gmap['lon'];
360		$imgUrl .= "&size=".str_replace("px", "",$gmap['width']).",".str_replace("px", "",$gmap['height']);
361		// max level for mapquest is 16
362		if ($gmap['zoom']>16) {
363			$imgUrl .= "&zoom=16";
364		} else			{
365			$imgUrl .= "&zoom=".$gmap['zoom'];
366		}
367		// TODO mapquest allows using one image url with a multiplier $NUMBER eg:
368		// $NUMBER = 2
369		// $imgUrl .= DOKU_URL."/".DOKU_PLUGIN."/".getPluginName()."/icons/".$img.",$NUMBER,C,".$lat1.",".$lon1.",0,0,0,0,C,".$lat2.",".$lon2.",0,0,0,0";
370		if (!empty ($overlay)) {
371			$imgUrl .= "&xis=";
372			foreach ($overlay as $data) {
373				list ($lat, $lon, $text, $angle, $opacity, $img) = $data;
374				$imgUrl .= $sUrl."lib/plugins/openlayersmap/icons/".$img.",1,C,".$lat.",".$lon.",0,0,0,0,";
375			}
376			$imgUrl = substr($imgUrl,0,-1);
377		}
378		$imgUrl .= "&imageType=png&type=".$maptype;
379		dbglog($imgUrl,'syntax_plugin_openlayersmap_olmap::_getMapQuest: MapQuest image url is:');
380		return $imgUrl;
381	}
382
383	private function _getGoogle($gmap, $overlay){
384		$sUrl=$this->getConf('iconUrlOverload');
385		if (!$sUrl){
386			$sUrl=DOKU_URL;
387		}
388		switch ($gmap['baselyr']){
389			case 'google hybrid':
390				$maptype='hybrid';
391				break;
392			case 'google sat':
393				$maptype='satellite';
394				break;
395			case 'google relief':
396				$maptype='terrain';
397				break;
398			case 'google normal':
399			default:
400				$maptype='roadmap';
401				break;
402		}
403
404		//http://maps.google.com/maps/api/staticmap?center=51.565690,5.456756&zoom=16&size=600x400&markers=icon:http://wild-water.nl/dokuwiki/lib/plugins/openlayersmap/icons/marker.png|label:1|51.565690,5.456756&markers=icon:http://wild-water.nl/dokuwiki/lib/plugins/openlayersmap/icons/marker-blue.png|51.566197,5.458966|label:2&markers=icon:http://wild-water.nl/dokuwiki/lib/plugins/openlayersmap/icons/parking.png|51.567177,5.457909|label:3&markers=icon:http://wild-water.nl/dokuwiki/lib/plugins/openlayersmap/icons/parking.png|51.566283,5.457330|label:4&markers=icon:http://wild-water.nl/dokuwiki/lib/plugins/openlayersmap/icons/parking.png|51.565630,5.457695|label:5&sensor=false&format=png&maptype=roadmap
405		$imgUrl = "http://maps.google.com/maps/api/staticmap";
406		$imgUrl .= "?center=".$gmap['lat'].",".$gmap['lon'];
407		$imgUrl .= "&size=".str_replace("px", "",$gmap['width'])."x".str_replace("px", "",$gmap['height']);
408		// don't need this anymore $imgUrl .= "&key=".$this->getConf('googleAPIKey');
409		// max is 21 (== building scale), but that's overkill..
410		if ($gmap['zoom']>16) {
411			$imgUrl .= "&zoom=16";
412		} else			{
413			$imgUrl .= "&zoom=".$gmap['zoom'];
414		}
415
416		if (!empty ($overlay)) {
417			$rowId=0;
418			foreach ($overlay as $data) {
419				list ($lat, $lon, $text, $angle, $opacity, $img) = $data;
420				$imgUrl .= "&markers=icon%3a".$sUrl."lib/plugins/openlayersmap/icons/".$img."%7c".$lat.",".$lon."%7clabel%3a".++$rowId;
421			}
422		}
423		$imgUrl .= "&format=png&maptype=".$maptype."&sensor=false";
424		global $conf;
425		$imgUrl .= "&language=".$conf['lang'];
426		dbglog($imgUrl,'syntax_plugin_openlayersmap_olmap::_getGoogle: Google image url is:');
427		return $imgUrl;
428	}
429
430	/**
431	 *
432	 * Create a bing maps static image url w/ the poi.
433	 * @param array $gmap
434	 * @param array $overlay
435	 */
436	private function _getBing($gmap, $overlay){
437		switch ($gmap['baselyr']){
438			case 've hybrid':
439				$maptype='AerialWithLabels';
440				break;
441			case 've sat':
442				$maptype='Aerial';
443				break;
444			case 've normal':
445			case 've':
446			default:
447				$maptype='Road';
448				break;
449		}
450
451		// TODO since bing does not provide declutter or autozoom/fit we need to determine the bbox based on the poi and lat/lon ourselves
452		//http://dev.virtualearth.net/REST/v1/Imagery/Map/Road/51.56573,5.45690/12?mapSize=400,400&key=Agm4PJzDOGz4Oy9CYKPlV-UtgmsfL2-zeSyfYjRhf57OQB_oj87j5pncKZSay5qY
453		$imgUrl = "http://dev.virtualearth.net/REST/v1/Imagery/Map/".$maptype."/".$gmap['lat'].",".$gmap['lon']."/".$gmap['zoom'];
454		$imgUrl .= "?ms=".str_replace("px", "",$gmap['width']).",".str_replace("px", "",$gmap['height']);
455		// create a bing api key at https://www.bingmapsportal.com/application
456		$imgUrl .= "&key=".$this->getConf('bingAPIKey');
457		if (!empty ($overlay)) {
458			$rowId=0;
459			foreach ($overlay as $data) {
460				list ($lat, $lon, $text, $angle, $opacity, $img) = $data;
461				// TODO icon style lookup, see: http://msdn.microsoft.com/en-us/library/ff701719.aspx for iconStyle
462				// NOTE: the max number of pushpins is 18!
463				$iconStyle=32;
464				$rowId++;
465				$imgUrl .= "&pp=$lat,$lon;$iconStyle;$rowId";
466			}
467		}
468		dbglog($imgUrl,'syntax_plugin_openlayersmap_olmap::_getBing: bing image url is:');
469		return $imgUrl;
470	}
471
472	/**
473	 *
474	 * Create a static OSM map image url w/ the poi from http://staticmap.openstreetmap.de (staticMapLite)
475	 * @param array $gmap
476	 * @param array $overlay
477	 */
478	private function _getStaticOSM($gmap, $overlay){
479		//http://staticmap.openstreetmap.de/staticmap.php?center=47.000622235634,10.117187497601&zoom=5&size=500x350
480		// &markers=48.999812532766,8.3593749976708,lightblue1|43.154850037315,17.499999997306,lightblue1|49.487527053077,10.820312497573,ltblu-pushpin|47.951071133739,15.917968747369,ol-marker|47.921629720114,18.027343747285,ol-marker-gold|47.951071133739,19.257812497236,ol-marker-blue|47.180141361692,19.257812497236,ol-marker-green
481		$imgUrl = "http://staticmap.openstreetmap.de/staticmap.php";
482		$imgUrl .= "?center=".$gmap['lat'].",".$gmap['lon'];
483		$imgUrl .= "&size=".str_replace("px", "",$gmap['width'])."x".str_replace("px", "",$gmap['height']);
484		if ($gmap['zoom']>16) {
485			$imgUrl .= "&zoom=16";
486		} else			{
487			$imgUrl .= "&zoom=".$gmap['zoom'];
488		}
489
490		if (!empty ($overlay)) {
491			$rowId=0;
492			$imgUrl .= "&markers=";
493			foreach ($overlay as $data) {
494				list ($lat, $lon, $text, $angle, $opacity, $img) = $data;
495				$rowId++;
496				$iconStyle = "lightblue$rowId";
497				$imgUrl .= "$lat,$lon,$iconStyle%7c";
498			}
499			$imgUrl = substr($imgUrl,0,-3);
500		}
501
502		dbglog($imgUrl,'syntax_plugin_openlayersmap_olmap::_getStaticOSM: bing image url is:');
503		return $imgUrl;
504
505	}
506}