xref: /plugin/openlayersmap/helper/staticmap.php (revision d2f4772aabf3d008005ac2a7cced06742a8f59a8)

<?php
/*
 * Copyright (c) 2008-2017 Mark C. Prins <mprins@users.sf.net>
 *
 * 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.
 */
if (!defined('DOKU_INC')) die();
if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once DOKU_PLUGIN.'openlayersmap/StaticMap.php';
/**
 * DokuWiki Plugin openlayersmap (staticmap Helper Component).
 * This provides the interface to generate a static map based on predefined OSM layers.
 *
 * @author Mark Prins
 */
class helper_plugin_openlayersmap_staticmap extends DokuWiki_Plugin {
	/** maximum width of the resulting image. */
	private $maxWidth = 1024;
	/** maximum heigth of the resulting image. */
	private $maxHeight = 1024;

	/**
	 * Provide metadata of the public methods of this class.
	 *
	 * @return array Information to all provided methods.
	 */
	function getMethods(){
		$result = array();
		$result[] = array(
				'name'   => 'getMap',
				'desc'   => 'returns url to the image',
				'params' => array(
						'lat' => 'float',
						'lon' => 'float',
						'zoom' => 'integer',
						'size' => 'string',
						'maptype' => 'string',
						'markers' => 'string',
						'gpx' => 'string',
						'kml' => 'string',
						'geojson' => 'string',
						'apikey' => 'string'),
				'return' => array('image' => 'string'),
		);
		return $result;
	}

	/**
	 * Create the map.
	 *
	 * @param number lat the latitude of the map's center, eg. 40.714728
	 * @param number lon the longitude of the map's center, eg -73.998672
	 * @param number zoom the zoom level in the tile cache, eg. 14
	 * @param mixed size the size in WxH px, eg. 512x512
	 * @param string maptype the maptype, eg. cycle
	 * @param mixed markers associative array of markers, array('lat'=>$lat,'lon'=>$lon,'type'=>$iconStyle), eg. array(	'lat'=>40.702147,	'lon'=>-74.015794,	'type'=>lightblue1);
	 * @param string gpx media link
	 * @param string kml media link
	 * @param string geojson media link
	 * @param string optional API key eg. for Thunderforest maps
	 *
	 * @return the media id url
	 */
	public function getMap($lat, $lon, $zoom, $size, $maptype, $markers, $gpx, $kml, $geojson, $apikey = ''){
		global $conf;
		// dbglog($markers,'helper_plugin_openlayersmap_staticmap::getMap: markers :');

		// normalize zoom
		$zoom = $zoom?intval($zoom):0;
		if($zoom > 18) $zoom = 18;
		// normalize WxH
		list($width, $height) = explode('x',$size);
		$width = intval($width);
		if($width > $this->maxWidth) $width = $this->maxWidth;
		$height = intval($height);
		if($height > $this->maxHeight) $height = $this->maxHeight;

		// cleanup/validate gpx/kml
		$kml = $this->mediaIdToPath($kml);
		// dbglog($kml,'helper_plugin_openlayersmap_staticmap::getMap: kml file:');
		$gpx = $this->mediaIdToPath($gpx);
		// dbglog($gpx,'helper_plugin_openlayersmap_staticmap::getMap: gpx file:');
		$geojson = $this->mediaIdToPath($geojson);

		// create map
		$map = new StaticMap($lat, $lon, $zoom, $width, $height, $maptype,
				$markers, $gpx, $kml, $geojson, $conf['mediadir'], $conf['cachedir'],
				$this->getConf('autoZoomMap'),
				$apikey
		);

		// return the media id url
		$mediaId = str_replace('/', ':',  $map->getMap());
		// 	if($this->startsWith($mediaId,':')) {
		// 		$mediaId = substr($mediaId, 1);
		// 	}
		return $mediaId;
	}

	private function startsWith($haystack, $needle)	{
		$length = strlen($needle);
		return (substr($haystack, 0, $length) === $needle);
	}

	/**
	 * Constructs the path to a file.
	 * @param string $id the DW media id
	 * @return the path to the file
	 */
	private function mediaIdToPath($id){
		global $conf;
		if(empty($id)) {
			return "";
		}
		$id=str_replace("[[","",$id);
		$id=str_replace("]]","",$id);
		if($this->startsWith($id,':')) {
			$id = substr($id, 1);
		}
		$id=str_replace(":","/",$id);
		return $conf['mediadir'].'/'.$id;
	}
}