xref: /plugin/openlayersmap/syntax/olmap.php (revision fcd79b5039e7a70f7b2f9a095c2074c77a343448)

<?php
/*
 * Copyright (c) 2008-2011 Mark C. Prins <mc.prins@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

/**
 * Plugin OL Maps: Allow Display of a OpenLayers Map in a wiki page.
 *
 * @author Mark Prins
 */

if (!defined('DOKU_INC'))
define('DOKU_INC', realpath(dirname(__FILE__) . '/../../') . '/');
if (!defined('DOKU_PLUGIN'))
define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
require_once (DOKU_PLUGIN . 'syntax.php');

/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_openlayersmap_olmap extends DokuWiki_Syntax_Plugin {
	/** defaults of the known attributes of the olmap tag. */
	private $dflt = array (
		'id' => 'olmap',
		'width' => '550px',
		'height' => '450px',
		'lat' => 50.0,
		'lon' => 5.1,
		'zoom' => 12,
		'toolbar' => true,
		'statusbar' => true,
		'controls' => true,
		'poihoverstyle' => false,
		'baselyr'=>'OpenStreetMap',
	 	'gpxfile' => '',
 		'kmlfile' => '',
		'summary'=>''
		);

		/**
		 * Return the type of syntax this plugin defines.
		 * @Override
		 */
		function getType() {return 'substition';}

		/**
		 * Defines how this syntax is handled regarding paragraphs.
		 * @Override
		 */
		function getPType() {return 'block';}

		/**
		 * Returns a number used to determine in which order modes are added.
		 * @Override
		 */
		function getSort() {return 901;}

		/**
		 * This function is inherited from Doku_Parser_Mode.
		 * Here is the place to register the regular expressions needed
		 * to match your syntax.
		 * @Override
		 */
		function connectTo($mode) {
			$this->Lexer->addSpecialPattern('<olmap ?[^>\n]*>.*?</olmap>', $mode, 'plugin_openlayersmap_olmap');
		}

		/**
		 * handle each olmap tag. prepare the matched syntax for use in the renderer.
		 * @Override
		 */
		function handle($match, $state, $pos, &$handler) {
			// break matched cdata into its components
			list ($str_params, $str_points) = explode('>', substr($match, 7, -9), 2);
			// get the lat/lon for adding them to the metadata (used by geotag)
			preg_match('(lat[:|=]\"\d*\.\d*\")',$match,$mainLat);
			preg_match('(lon[:|=]\"\d*\.\d*\")',$match,$mainLon);
			$mainLat=substr($mainLat[0],5,-1);
			$mainLon=substr($mainLon[0],5,-1);

			$gmap = $this->_extract_params($str_params);
			$overlay = $this->_extract_points($str_points);

			$imgUrl = "{{";
			// use mapquest open for now
			$imgUrl .= $this->_getMapQuest($gmap,$overlay);
			// dw specific params
			$imgUrl .="&.png?".$gmap['width']."x".$gmap['height'];
			$imgUrl .= "&nolink";
			$imgUrl .= "|".$gmap['summary']." }}";

			// remove 'px'
			$imgUrl = str_replace("px", "",$imgUrl);

			$imgUrl=p_render("xhtml", p_get_instructions($imgUrl), $info);

			$mapid = $gmap['id'];

			// determine width and height (inline styles) for the map image
			if ($gmap['width'] || $gmap['height']) {
				$style = $gmap['width'] ? 'width: ' . $gmap['width'] . ";" : "";
				$style .= $gmap['height'] ? 'height: ' . $gmap['height'] . ";" : "";
				$style = "style='$style'";
			} else {
				$style = '';
			}

			// unset gmap values for width and height - they don't go into javascript
			unset ($gmap['width'], $gmap['height']);

			// create a javascript parameter string for the map
			$param = '';
			foreach ($gmap as $key => $val) {
				$param .= is_numeric($val) ? "$key: $val, " : "$key: '" . hsc($val) . "', ";
			}
			if (!empty ($param)) {
				$param = substr($param, 0, -2);
			}
			unset ($gmap['id']);

			// create a javascript serialisation of the point data
			$poi = '';
			$poitable='';
			$rowId=0;
			if (!empty ($overlay)) {
				foreach ($overlay as $data) {
					list ($lat, $lon, $text, $angle, $opacity, $img) = $data;
					$rowId++;
					$poi .= ", {lat: $lat, lon: $lon, txt: '$text', angle: $angle, opacity: $opacity, img: '$img', rowId: $rowId}";
					$poitable .='<tr>'."\n".'<td class="rowId">'.$rowId.'</td>
							<td class="icon"><img src="/lib/plugins/openlayersmap/icons/'.$img.'" alt="icon"></td>
							<td class="lat" title="'.$this->getLang('olmapPOIlatTitle').'">'.$lat.'</td>
							<td class="lon" title="'.$this->getLang('olmapPOIlonTitle').'">'.$lon.'</td>
							<td class="txt">'.$text.'</td>'."\n".'</tr>';
				}
				$poi = substr($poi, 2);
			}
			$js .= "createMap({" . $param . " },[$poi]);";

			return array($mapid,$style,$js,$mainLat,$mainLon,$poitable,$gmap['summary'],$imgUrl);
		}

		/**
		 * render html tag/output. render the content.
		 * @Override
		 */
		function render($mode, &$renderer, $data) {
			static $initialised = false; // set to true after script initialisation
			list ($mapid, $style, $param, $mainLat, $mainLon, $poitable, $poitabledesc, $staticImgUrl) = $data;

			if ($mode == 'xhtml') {
				$olscript = '';
				$olEnable = false;
				$gscript = '';
				$gEnable = false;
				$vscript = '';
				$vEnable = false;
				$yscript = '';
				$yEnable = false;

				$scriptEnable = '';

				if (!$initialised) {
					$initialised = true;
					// render necessary script tags
					$gscript = $this->getConf('googleScriptUrl');
					$gscript = $gscript ? '<script type="text/javascript" src="' . $gscript . '"></script>' : "";

					$vscript = $this->getConf('veScriptUrl');
					$vscript = $vscript ? '<script type="text/javascript" src="' . $vscript . '"></script>' : "";

					$yscript = $this->getConf('yahooScriptUrl');
					$yscript = $yscript ? '<script type="text/javascript" src="' . $yscript . '"></script>' : "";

					$olscript = $this->getConf('olScriptUrl');
					$olscript = $olscript ? '<script type="text/javascript" src="' . $olscript . '"></script>' : "";
					$olscript = str_replace('DOKU_PLUGIN', DOKU_PLUGIN, $olscript);

					$scriptEnable = '<script type="text/javascript">' . "\n" . '<!--//--><![CDATA[//><!--' . "\n";
					$scriptEnable .= $olscript ? 'olEnable = true;' : 'olEnable = false;';
					$scriptEnable .= $yscript ? ' yEnable = true;' : ' yEnable = false;';
					$scriptEnable .= $vscript ? ' veEnable = true;' : ' veEnable = false;';
					$scriptEnable .= $gscript ? ' gEnable = true;' : ' gEnable = false;';
					$scriptEnable .= "\n" . '//--><!]]>' . "\n" . '</script>';
				}
				$renderer->doc .= "
				$olscript
				$gscript
				$vscript
				$yscript
				$scriptEnable
			    <div id='olContainer' class='olContainer'>
			    <span id='$mapid-static' class='olStaticMap'>$staticImgUrl</span>
				<div id='$mapid-olToolbar' class='olToolbar'></div>
			        <div style='clear:both;'></div>
			        <div id='$mapid' $style ></div>
			        <div id='$mapid-olStatusBar' class='olStatusBarContainer'>
			            <div id='$mapid-statusbar-scale' class='olStatusBar olStatusBarScale'>scale</div>
			            <div id='$mapid-statusbar-link' class='olStatusBar olStatusBarPermalink'>
			                <a href='' id='$mapid-statusbar-link-ref'>map link</a>
			            </div>
			            <div id='$mapid-statusbar-mouseposition' class='olStatusBar olStatusBarMouseposition'></div>
			            <div id='$mapid-statusbar-projection' class='olStatusBar olStatusBarProjection'>proj</div>
			            <div id='$mapid-statusbar-text' class='olStatusBar olStatusBarText'>txt</div>
			        </div>
			    </div>
			    <p>&nbsp;</p>
			    <script type='text/javascript'><!--//--><![CDATA[//><!--
			    var $mapid = $param
			   //--><!]]></script>";

			    // render a (hidden) table of the POI for the print and a11y presentation
			    $renderer->doc .= '
 	<table class="olPOItable inline" id="'.$mapid.'-table" summary="'.$poitabledesc.'" title="'.$this->getLang('olmapPOItitle').'">
		<caption class="olPOITblCaption">'.$this->getLang('olmapPOItitle').'</caption>
		<thead class="olPOITblHeader">
			<tr>
				<th class="rowId" scope="col">id</th>
				<th class="icon" scope="col">'.$this->getLang('olmapPOIicon').'</th>
				<th class="lat" scope="col" title="'.$this->getLang('olmapPOIlatTitle').'">'.$this->getLang('olmapPOIlat').'</th>
				<th class="lon" scope="col" title="'.$this->getLang('olmapPOIlonTitle').'">'.$this->getLang('olmapPOIlon').'</th>
				<th class="txt" scope="col">'.$this->getLang('olmapPOItxt').'</th>
			</tr>
		</thead>
		<tbody class="olPOITblBody">'.$poitable.'</tbody>
		<tfoot class="olPOITblFooter"><tr><td colspan="5">'.$poitabledesc.'</td></tr></tfoot>
	</table>';
			    //TODO no tfoot when $poitabledesc is empty

			} elseif ($mode == 'metadata') {
				// render metadata if available
				if (!(($this->dflt['lat']==$mainLat)||($thisdflt['lon']==$mainLon))){
					// unless they are the default
					$renderer->meta['geo']['lat'] = $mainLat;
					$renderer->meta['geo']['lon'] = $mainLon;
				}
				return true;
			}
			return false;
		}

		/**
		 * extract parameters for the map from the parameter string
		 *
		 * @param   string    $str_params   string of key="value" pairs
		 * @return  array                   associative array of parameters key=>value
		 */
		private function _extract_params($str_params) {
			$param = array ();
			preg_match_all('/(\w*)="(.*?)"/us', $str_params, $param, PREG_SET_ORDER);
			// parse match for instructions, break into key value pairs
			$gmap = $this->dflt;
			foreach ($param as $kvpair) {
				list ($match, $key, $val) = $kvpair;
				$key = strtolower($key);
				if (isset ($gmap[$key])){
					if ($key == 'summary'){
						// preserve case for summary field
						$gmap[$key] = $val;
					}else {
						$gmap[$key] = strtolower($val);
					}
				}
			}
			return $gmap;
		}

		/**
		 * extract overlay points for the map from the wiki syntax data
		 *
		 * @param   string    $str_points   multi-line string of lat,lon,text triplets
		 * @return  array                   multi-dimensional array of lat,lon,text triplets
		 */
		private function _extract_points($str_points) {
			$point = array ();
			//preg_match_all('/^([+-]?[0-9].*?),\s*([+-]?[0-9].*?),(.*?),(.*?),(.*?),(.*)$/um', $str_points, $point, PREG_SET_ORDER);
			/*
			group 1: ([+-]?[0-9]+(?:\.[0-9]*)?)
			group 2: ([+-]?[0-9]+(?:\.[0-9]*)?)
			group 3: (.*?)
			group 4: (.*?)
			group 5: (.*?)
			group 6: (.*)
			*/
			preg_match_all('/^([+-]?[0-9]+(?:\.[0-9]*)?),\s*([+-]?[0-9]+(?:\.[0-9]*)?),(.*?),(.*?),(.*?),(.*)$/um', $str_points, $point, PREG_SET_ORDER);
			// create poi array
			$overlay = array ();
			foreach ($point as $pt) {
				list ($match, $lat, $lon, $angle, $opacity, $img, $text) = $pt;
				$lat = is_numeric($lat) ? $lat : 0;
				$lon = is_numeric($lon) ? $lon : 0;
				$angle = is_numeric($angle) ? $angle : 0;
				$opacity = is_numeric($opacity) ? $opacity : 0.8;
				$img = trim($img);
				// TODO validate & set up default img?
				$text = addslashes(str_replace("\n", "", p_render("xhtml", p_get_instructions($text), $info)));
				$overlay[] = array($lat, $lon, $text, $angle, $opacity, $img);
			}
			return $overlay;
		}

		/**
		 * Create a MapQuest static map API image url.
		 * @param array $gmap
		 * @param array $overlay
		 */
		private function _getMapQuest($gmap,$overlay) {
			$imgUrl = "http://open.mapquestapi.com/staticmap/v3/getmap?";
			$imgUrl .= "size=".$gmap['width'].",".$gmap['height'];
			$imgUrl .= "&center=".$gmap['lat'].",".$gmap['lon'];

			if ($gmap['zoom']>16) {
				$imgUrl .= "&zoom=16";
			} else			{
				$imgUrl .= "&zoom=".$gmap['zoom'];
			}
			// TODO mapquest allows using one image url with a multiplier $NUMBER eg:
			// $NUMBER = 2
			// $imgUrl .= DOKU_URL."/".DOKU_PLUGIN."/".getPluginName()."/icons/".$img.",$NUMBER,C,".$lat1.",".$lon1.",0,0,0,0,C,".$lat2.",".$lon2.",0,0,0,0";
			if (!empty ($overlay)) {
				$imgUrl .= "&xis=";
				foreach ($overlay as $data) {
					list ($lat, $lon, $text, $angle, $opacity, $img) = $data;
					$imgUrl .= DOKU_URL."lib/plugins/openlayersmap/icons/".$img.",1,C,".$lat.",".$lon.",0,0,0,0,";
				}
				$imgUrl = substr($imgUrl,0,-1);
				$imgUrl .= "&imageType=png&type=map";
			}
			return $imgUrl;
		}
}