1<?php 2/* 3 * Copyright (c) 2011-2020 Mark C. Prins <mprins@users.sf.net> 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 18use dokuwiki\Sitemap\Item; 19 20/** 21 * DokuWiki Plugin dokuwikispatial (Action Component). 22 * 23 * @license BSD license 24 * @author Mark C. Prins <mprins@users.sf.net> 25 */ 26class action_plugin_spatialhelper extends DokuWiki_Action_Plugin { 27 28 /** 29 * Register for events. 30 * 31 * @param Doku_Event_Handler $controller 32 * DokuWiki's event controller object. Also available as global $EVENT_HANDLER 33 */ 34 public function register(Doku_Event_Handler $controller): void { 35 // listen for page add / delete events 36 // http://www.dokuwiki.org/devel:event:indexer_page_add 37 $controller->register_hook('INDEXER_PAGE_ADD', 'BEFORE', $this, 'handleIndexerPageAdd'); 38 $controller->register_hook('IO_WIKIPAGE_WRITE', 'BEFORE', $this, 'removeFromIndex'); 39 40 // http://www.dokuwiki.org/devel:event:sitemap_generate 41 $controller->register_hook('SITEMAP_GENERATE', 'BEFORE', $this, 'handleSitemapGenerateBefore'); 42 // using after will only trigger us if a sitemap was actually created 43 $controller->register_hook('SITEMAP_GENERATE', 'AFTER', $this, 'handleSitemapGenerateAfter'); 44 45 // handle actions we know of 46 $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handleActionActPreprocess', array()); 47 // handle HTML eg. /dokuwiki/doku.php?id=start&do=findnearby&geohash=u15vk4 48 $controller->register_hook( 49 'TPL_ACT_UNKNOWN', 'BEFORE', $this, 'findnearby', array( 50 'format' => 'HTML' 51 ) 52 ); 53 // handles AJAX/json eg: jQuery.post("/dokuwiki/lib/exe/ajax.php?id=start&call=findnearby&geohash=u15vk4"); 54 $controller->register_hook( 55 'AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'findnearby', array( 56 'format' => 'JSON' 57 ) 58 ); 59 60 // listen for media uploads and deletes 61 $controller->register_hook('MEDIA_UPLOAD_FINISH', 'BEFORE', $this, 'handleMediaUploaded', array()); 62 $controller->register_hook('MEDIA_DELETE_FILE', 'BEFORE', $this, 'handleMediaDeleted', array()); 63 64 $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'handleMetaheaderOutput'); 65 } 66 67 /** 68 * Update the spatial index for the page. 69 * 70 * @param Doku_Event $event 71 * event object 72 * @param mixed $param 73 * the parameters passed to register_hook when this handler was registered 74 */ 75 public function handleIndexerPageAdd(Doku_Event $event, $param): void { 76 // $event→data['page'] – the page id 77 // $event→data['body'] – empty, can be filled by additional content to index by your plugin 78 // $event→data['metadata'] – the metadata that shall be indexed. This is an array where the keys are the 79 // metadata indexes and the value a string or an array of strings with the values. 80 // title and relation_references will already be set. 81 $id = $event->data ['page']; 82 $indexer = plugin_load('helper', 'spatialhelper_index'); 83 $entries = $indexer->updateSpatialIndex($id); 84 } 85 86 /** 87 * Update the spatial index, removing the page. 88 * 89 * @param Doku_Event $event 90 * event object 91 * @param mixed $param 92 * the parameters passed to register_hook when this handler was registered 93 */ 94 public function removeFromIndex(Doku_Event $event, $param): void { 95 // event data: 96 // $data[0] – The raw arguments for io_saveFile as an array. Do not change file path. 97 // $data[0][0] – the file path. 98 // $data[0][1] – the content to be saved, and may be modified. 99 // $data[1] – ns: The colon separated namespace path minus the trailing page name. (false if root ns) 100 // $data[2] – page_name: The wiki page name. 101 // $data[3] – rev: The page revision, false for current wiki pages. 102 103 dbglog($event->data, "Event data in removeFromIndex."); 104 if(@file_exists($event->data [0] [0])) { 105 // file not new 106 if(!$event->data [0] [1]) { 107 // file is empty, page is being deleted 108 if(empty ($event->data [1])) { 109 // root namespace 110 $id = $event->data [2]; 111 } else { 112 $id = $event->data [1] . ":" . $event->data [2]; 113 } 114 $indexer = plugin_load('helper', 'spatialhelper_index'); 115 if($indexer) { 116 $indexer->deleteFromIndex($id); 117 } 118 } 119 } 120 } 121 122 /** 123 * Add a new SitemapItem object that points to the KML of public geocoded pages. 124 * 125 * @param Doku_Event $event 126 * @param mixed $param 127 */ 128 public function handleSitemapGenerateBefore(Doku_Event $event, $param): void { 129 $path = mediaFN($this->getConf('media_kml')); 130 $lastmod = @filemtime($path); 131 $event->data ['items'] [] = new Item(ml($this->getConf('media_kml'), '', true, '&', true), $lastmod); 132 //dbglog($event->data ['items'], 133 // "Added a new SitemapItem object that points to the KML of public geocoded pages."); 134 } 135 136 /** 137 * Create a spatial sitemap or attach the geo/kml map to the sitemap. 138 * 139 * @param Doku_Event $event 140 * event object, not used 141 * @param mixed $param 142 * parameter array, not used 143 */ 144 public function handleSitemapGenerateAfter(Doku_Event $event, $param): bool { 145 // $event→data['items']: Array of SitemapItem instances, the array of sitemap items that already 146 // contains all public pages of the wiki 147 // $event→data['sitemap']: The path of the file the sitemap will be saved to. 148 if($helper = plugin_load('helper', 'spatialhelper_sitemap')) { 149 // dbglog($helper, "createSpatialSitemap loaded helper."); 150 151 $kml = $helper->createKMLSitemap($this->getConf('media_kml')); 152 $rss = $helper->createGeoRSSSitemap($this->getConf('media_georss')); 153 154 if(!empty ($this->getConf('sitemap_namespaces'))) { 155 $namespaces = array_map('trim', explode("\n", $this->getConf('sitemap_namespaces'))); 156 foreach($namespaces as $namespace) { 157 $kmlN = $helper->createKMLSitemap($namespace . $this->getConf('media_kml')); 158 $rssN = $helper->createGeoRSSSitemap($namespace . $this->getConf('media_georss')); 159 dbglog( 160 $kmlN && $rssN, 161 "handleSitemapGenerateAfter, created KML / GeoRSS sitemap in $namespace, succes: " 162 ); 163 } 164 } 165 return $kml && $rss; 166 } else { 167 dbglog($helper, "createSpatialSitemap NOT loaded helper."); 168 } 169 } 170 171 /** 172 * trap findnearby action. 173 * This addional handler is required as described at: https://www.dokuwiki.org/devel:event:tpl_act_unknown 174 * 175 * @param Doku_Event $event 176 * event object 177 * @param mixed $param 178 * not used 179 */ 180 public function handleActionActPreprocess(Doku_Event $event, $param): void { 181 if($event->data !== 'findnearby') { 182 return; 183 } 184 $event->preventDefault(); 185 } 186 187 /** 188 * handle findnearby action. 189 * 190 * @param Doku_Event $event 191 * event object 192 * @param mixed $param 193 * associative array with keys 194 * 'format'=> HTML | JSON 195 */ 196 public function findnearby(Doku_Event $event, $param): void { 197 if($event->data !== 'findnearby') { 198 return; 199 } 200 $event->preventDefault(); 201 $results = array(); 202 global $INPUT; 203 if($helper = plugin_load('helper', 'spatialhelper_search')) { 204 if($INPUT->has('lat') && $INPUT->has('lon')) { 205 $results = $helper->findNearbyLatLon($INPUT->param('lat'), $INPUT->param('lon')); 206 } elseif($INPUT->has('geohash')) { 207 $results = $helper->findNearby($INPUT->str('geohash')); 208 } else { 209 $results = array( 210 'error' => hsc($this->getLang('invalidinput')) 211 ); 212 } 213 } 214 215 $showMedia = $INPUT->bool('showMedia', true); 216 217 switch($param['format']) { 218 case 'JSON' : 219 $this->printJSON($results); 220 break; 221 case 'HTML' : 222 // fall through to default 223 default : 224 $this->printHTML($results, $showMedia); 225 break; 226 } 227 } 228 229 /** 230 * Print seachresults as HTML lists. 231 * 232 * @param array $searchresults 233 */ 234 private function printJSON(array $searchresults): void { 235 require_once DOKU_INC . 'inc/JSON.php'; 236 $json = new JSON(); 237 header('Content-Type: application/json'); 238 print $json->encode($searchresults); 239 } 240 241 /** 242 * Print seachresults as HTML lists. 243 * 244 * @param array $searchresults 245 * @param bool $showMedia 246 */ 247 private function printHTML(array $searchresults, bool $showMedia = true): void { 248 $pages = (array) ($searchresults ['pages']); 249 $media = (array) $searchresults ['media']; 250 $lat = (float) $searchresults ['lat']; 251 $lon = (float) $searchresults ['lon']; 252 $geohash = (string) $searchresults ['geohash']; 253 254 if(isset ($searchresults ['error'])) { 255 print '<div class="level1"><p>' . hsc($searchresults ['error']) . '</p></div>'; 256 return; 257 } 258 259 // print a HTML list 260 print '<h1>' . $this->getLang('results_header') . '</h1>' . DOKU_LF; 261 print '<div class="level1">' . DOKU_LF; 262 if(!empty ($pages)) { 263 $pagelist = '<ol>' . DOKU_LF; 264 foreach($pages as $page) { 265 $pagelist .= '<li>' . html_wikilink( 266 ':' . $page ['id'], useHeading('navigation') ? null : 267 noNS($page ['id']) 268 ) . ' (' . $this->getLang('results_distance_prefix') 269 . $page ['distance'] . ' m) ' . $page ['description'] . '</li>' . DOKU_LF; 270 } 271 $pagelist .= '</ol>' . DOKU_LF; 272 273 print '<h2>' . $this->getLang('results_pages') . hsc( 274 ' lat;lon: ' . $lat . ';' . $lon 275 . ' (geohash: ' . $geohash . ')' 276 ) . '</h2>'; 277 print '<div class="level2">' . DOKU_LF; 278 print $pagelist; 279 print '</div>' . DOKU_LF; 280 } else { 281 print '<p>' . hsc($this->getLang('nothingfound')) . '</p>'; 282 } 283 284 if(!empty ($media) && $showMedia) { 285 $pagelist = '<ol>' . DOKU_LF; 286 foreach($media as $m) { 287 $opts = array(); 288 $link = ml($m ['id'], $opts, false, '&', false); 289 $opts ['w'] = '100'; 290 $src = ml($m ['id'], $opts); 291 $pagelist .= '<li><a href="' . $link . '"><img src="' . $src . '"></a> (' 292 . $this->getLang('results_distance_prefix') . $page ['distance'] . ' m) ' . hsc($desc) 293 . '</li>' . DOKU_LF; 294 } 295 $pagelist .= '</ol>' . DOKU_LF; 296 297 print '<h2>' . $this->getLang('results_media') . hsc( 298 ' lat;lon: ' . $lat . ';' . $lon 299 . ' (geohash: ' . $geohash . ')' 300 ) . '</h2>' . DOKU_LF; 301 print '<div class="level2">' . DOKU_LF; 302 print $pagelist; 303 print '</div>' . DOKU_LF; 304 } 305 print '<p>' . $this->getLang('results_precision') . $searchresults ['precision'] . ' m. '; 306 if(strlen($geohash) > 1) { 307 $url = wl( 308 getID(), array( 309 'do' => 'findnearby', 310 'geohash' => substr($geohash, 0, -1) 311 ) 312 ); 313 print '<a href="' . $url . '" class="findnearby">' . $this->getLang('search_largerarea') . '</a>.</p>' 314 . DOKU_LF; 315 } 316 print '</div>' . DOKU_LF; 317 } 318 319 /** 320 * add media to spatial index. 321 * 322 * @param Doku_Event $event 323 * @param mixed $param 324 */ 325 public function handleMediaUploaded(Doku_Event $event, $param): void { 326 // data[0] temporary file name (read from $_FILES) 327 // data[1] file name of the file being uploaded 328 // data[2] future directory id of the file being uploaded 329 // data[3] the mime type of the file being uploaded 330 // data[4] true if the uploaded file exists already 331 // data[5] (since 2011-02-06) the PHP function used to move the file to the correct location 332 333 dbglog($event->data, "handleMediaUploaded::event data"); 334 335 // check the list of mimetypes 336 // if it's a supported type call appropriate index function 337 if(substr_compare($event->data [3], 'image/jpeg', 0)) { 338 $indexer = plugin_load('helper', 'spatialhelper_index'); 339 if($indexer) { 340 $indexer->indexImage($event->data [2], $event->data [1]); 341 } 342 } 343 // TODO add image/tiff 344 // TODO kml, gpx, geojson... 345 } 346 347 /** 348 * removes the media from the index. 349 */ 350 public function handleMediaDeleted(Doku_Event $event, $param): void { 351 // data['id'] ID data['unl'] unlink return code 352 // data['del'] Namespace directory unlink return code 353 // data['name'] file name data['path'] full path to the file 354 // data['size'] file size 355 356 dbglog($event->data, "handleMediaDeleted::event data"); 357 358 // remove the media id from the index 359 $indexer = plugin_load('helper', 'spatialhelper_index'); 360 if($indexer) { 361 $indexer->deleteFromIndex('media__' . $event->data ['id']); 362 } 363 } 364 365 /** 366 * add a link to the spatial sitemap files in the header. 367 * 368 * @param Doku_Event $event 369 * the DokuWiki event. $event->data is a two-dimensional 370 * array of all meta headers. The keys are meta, link and script. 371 * @param mixed $param 372 * 373 * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output 374 */ 375 public function handleMetaheaderOutput(Doku_Event $event, $param): void { 376 // TODO maybe test for exist 377 $event->data ["link"] [] = array( 378 "type" => "application/atom+xml", 379 "rel" => "alternate", 380 "href" => ml($this->getConf('media_georss')), 381 "title" => "Spatial ATOM Feed" 382 ); 383 $event->data ["link"] [] = array( 384 "type" => "application/vnd.google-earth.kml+xml", 385 "rel" => "alternate", 386 "href" => ml($this->getConf('media_kml')), 387 "title" => "KML Sitemap" 388 ); 389 } 390 391 /** 392 * Calculate a new coordinate based on start, distance and bearing 393 * 394 * @param $start array 395 * - start coordinate as decimal lat/lon pair 396 * @param $dist float 397 * - distance in kilometers 398 * @param $brng float 399 * - bearing in degrees (compass direction) 400 */ 401 private function geoDestination(array $start, float $dist, float $brng): array { 402 $lat1 = $this->toRad($start [0]); 403 $lon1 = $this->toRad($start [1]); 404 // http://en.wikipedia.org/wiki/Earth_radius 405 // average earth radius in km 406 $dist = $dist / 6371.01; 407 $brng = $this->toRad($brng); 408 409 $lon2 = $lon1 + atan2(sin($brng) * sin($dist) * cos($lat1), cos($dist) - sin($lat1) * sin($lat2)); 410 $lon2 = fmod(($lon2 + 3 * M_PI), (2 * M_PI)) - M_PI; 411 412 return array( 413 $this->toDeg($lat2), 414 $this->toDeg($lon2) 415 ); 416 } 417 418 private function toRad(float $deg): float { 419 return $deg * M_PI / 180; 420 } 421 422 private function toDeg(float $rad): float { 423 return $rad * 180 / M_PI; 424 } 425} 426