mprins / dokuwiki-plugin-spatialhelper

action.php

Spacing +5 added lines, -5 removed lines

@@ -256,11 +256,11 @@
      */
     private function printHTML(array $searchresults, bool $showMedia = true): void
     {
-        $pages = (array)($searchresults ['pages']);
-        $media = (array)$searchresults ['media'];
-        $lat = (float)$searchresults ['lat'];
-        $lon = (float)$searchresults ['lon'];
-        $geohash = (string)$searchresults ['geohash'];
+        $pages = ( array ) ($searchresults ['pages']);
+        $media = ( array ) $searchresults ['media'];
+        $lat = ( float ) $searchresults ['lat'];
+        $lon = ( float ) $searchresults ['lon'];
+        $geohash = ( string ) $searchresults ['geohash'];
 
         if (isset($searchresults ['error'])) {
             echo '<div class="level1"><p>' . hsc($searchresults ['error']) . '</p></div>';

Indentation +337 added lines, -337 removed lines

@@ -30,369 +30,369 @@
  */
 class action_plugin_spatialhelper extends ActionPlugin
 {
-    /**
-     * Register for events.
-     *
-     * @param EventHandler $controller
-     *          DokuWiki's event controller object.
-     */
-    final public function register(EventHandler $controller): void
-    {
-        // listen for page add / delete events
-        // http://www.dokuwiki.org/devel:event:indexer_page_add
-        $controller->register_hook('INDEXER_PAGE_ADD', 'BEFORE', $this, 'handleIndexerPageAdd');
-        $controller->register_hook('IO_WIKIPAGE_WRITE', 'BEFORE', $this, 'removeFromIndex');
+	/**
+	 * Register for events.
+	 *
+	 * @param EventHandler $controller
+	 *          DokuWiki's event controller object.
+	 */
+	final public function register(EventHandler $controller): void
+	{
+		// listen for page add / delete events
+		// http://www.dokuwiki.org/devel:event:indexer_page_add
+		$controller->register_hook('INDEXER_PAGE_ADD', 'BEFORE', $this, 'handleIndexerPageAdd');
+		$controller->register_hook('IO_WIKIPAGE_WRITE', 'BEFORE', $this, 'removeFromIndex');
 
-        // http://www.dokuwiki.org/devel:event:sitemap_generate
-        $controller->register_hook('SITEMAP_GENERATE', 'BEFORE', $this, 'handleSitemapGenerateBefore');
-        // using after will only trigger us if a sitemap was actually created
-        $controller->register_hook('SITEMAP_GENERATE', 'AFTER', $this, 'handleSitemapGenerateAfter');
+		// http://www.dokuwiki.org/devel:event:sitemap_generate
+		$controller->register_hook('SITEMAP_GENERATE', 'BEFORE', $this, 'handleSitemapGenerateBefore');
+		// using after will only trigger us if a sitemap was actually created
+		$controller->register_hook('SITEMAP_GENERATE', 'AFTER', $this, 'handleSitemapGenerateAfter');
 
-        // handle actions we know of
-        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handleActionActPreprocess', []);
-        // handle HTML eg. /dokuwiki/doku.php?id=start&do=findnearby&geohash=u15vk4
-        $controller->register_hook(
-            'TPL_ACT_UNKNOWN',
-            'BEFORE',
-            $this,
-            'findnearby',
-            ['format' => 'HTML']
-        );
-        // handles AJAX/json eg: jQuery.post("/dokuwiki/lib/exe/ajax.php?id=start&call=findnearby&geohash=u15vk4");
-        $controller->register_hook(
-            'AJAX_CALL_UNKNOWN',
-            'BEFORE',
-            $this,
-            'findnearby',
-            ['format' => 'JSON']
-        );
+		// handle actions we know of
+		$controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handleActionActPreprocess', []);
+		// handle HTML eg. /dokuwiki/doku.php?id=start&do=findnearby&geohash=u15vk4
+		$controller->register_hook(
+			'TPL_ACT_UNKNOWN',
+			'BEFORE',
+			$this,
+			'findnearby',
+			['format' => 'HTML']
+		);
+		// handles AJAX/json eg: jQuery.post("/dokuwiki/lib/exe/ajax.php?id=start&call=findnearby&geohash=u15vk4");
+		$controller->register_hook(
+			'AJAX_CALL_UNKNOWN',
+			'BEFORE',
+			$this,
+			'findnearby',
+			['format' => 'JSON']
+		);
 
-        // listen for media uploads and deletes
-        $controller->register_hook('MEDIA_UPLOAD_FINISH', 'BEFORE', $this, 'handleMediaUploaded', []);
-        $controller->register_hook('MEDIA_DELETE_FILE', 'BEFORE', $this, 'handleMediaDeleted', []);
+		// listen for media uploads and deletes
+		$controller->register_hook('MEDIA_UPLOAD_FINISH', 'BEFORE', $this, 'handleMediaUploaded', []);
+		$controller->register_hook('MEDIA_DELETE_FILE', 'BEFORE', $this, 'handleMediaDeleted', []);
 
-        $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'handleMetaheaderOutput');
-        $controller->register_hook('PLUGIN_POPULARITY_DATA_SETUP', 'AFTER', $this, 'popularity');
-    }
+		$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'handleMetaheaderOutput');
+		$controller->register_hook('PLUGIN_POPULARITY_DATA_SETUP', 'AFTER', $this, 'popularity');
+	}
 
-    /**
-     * Update the spatial index for the page.
-     *
-     * @param Event $event
-     *          event object
-     */
-    final  public function handleIndexerPageAdd(Event $event): void
-    {
-        // $event→data['page'] – the page id
-        // $event→data['body'] – empty, can be filled by additional content to index by your plugin
-        // $event→data['metadata'] – the metadata that shall be indexed. This is an array where the keys are the
-        //    metadata indexes and the value a string or an array of strings with the values.
-        //    title and relation_references will already be set.
-        $id = $event->data ['page'];
-        $indexer = plugin_load('helper', 'spatialhelper_index');
-        $indexer->updateSpatialIndex($id);
-    }
+	/**
+	 * Update the spatial index for the page.
+	 *
+	 * @param Event $event
+	 *          event object
+	 */
+	final  public function handleIndexerPageAdd(Event $event): void
+	{
+		// $event→data['page'] – the page id
+		// $event→data['body'] – empty, can be filled by additional content to index by your plugin
+		// $event→data['metadata'] – the metadata that shall be indexed. This is an array where the keys are the
+		//    metadata indexes and the value a string or an array of strings with the values.
+		//    title and relation_references will already be set.
+		$id = $event->data ['page'];
+		$indexer = plugin_load('helper', 'spatialhelper_index');
+		$indexer->updateSpatialIndex($id);
+	}
 
-    /**
-     * Update the spatial index, removing the page.
-     *
-     * @param Event $event
-     *          event object
-     */
-    final    public function removeFromIndex(Event $event): void
-    {
-        // event data:
-        // $data[0] – The raw arguments for io_saveFile as an array. Do not change file path.
-        // $data[0][0] – the file path.
-        // $data[0][1] – the content to be saved, and may be modified.
-        // $data[1] – ns: The colon separated namespace path minus the trailing page name. (false if root ns)
-        // $data[2] – page_name: The wiki page name.
-        // $data[3] – rev: The page revision, false for current wiki pages.
+	/**
+	 * Update the spatial index, removing the page.
+	 *
+	 * @param Event $event
+	 *          event object
+	 */
+	final    public function removeFromIndex(Event $event): void
+	{
+		// event data:
+		// $data[0] – The raw arguments for io_saveFile as an array. Do not change file path.
+		// $data[0][0] – the file path.
+		// $data[0][1] – the content to be saved, and may be modified.
+		// $data[1] – ns: The colon separated namespace path minus the trailing page name. (false if root ns)
+		// $data[2] – page_name: The wiki page name.
+		// $data[3] – rev: The page revision, false for current wiki pages.
 
-        Logger::debug("Event data in removeFromIndex.", $event->data);
-        if (@file_exists($event->data [0] [0])) {
-            // file not new
-            if (!$event->data [0] [1]) {
-                // file is empty, page is being deleted
-                if (empty($event->data [1])) {
-                    // root namespace
-                    $id = $event->data [2];
-                } else {
-                    $id = $event->data [1] . ":" . $event->data [2];
-                }
-                $indexer = plugin_load('helper', 'spatialhelper_index');
-                if ($indexer !== null) {
-                    $indexer->deleteFromIndex($id);
-                }
-            }
-        }
-    }
+		Logger::debug("Event data in removeFromIndex.", $event->data);
+		if (@file_exists($event->data [0] [0])) {
+			// file not new
+			if (!$event->data [0] [1]) {
+				// file is empty, page is being deleted
+				if (empty($event->data [1])) {
+					// root namespace
+					$id = $event->data [2];
+				} else {
+					$id = $event->data [1] . ":" . $event->data [2];
+				}
+				$indexer = plugin_load('helper', 'spatialhelper_index');
+				if ($indexer !== null) {
+					$indexer->deleteFromIndex($id);
+				}
+			}
+		}
+	}
 
-    /**
-     * Add a new SitemapItem object that points to the KML of public geocoded pages.
-     *
-     * @param Event $event
-     */
-    final   public function handleSitemapGenerateBefore(Event $event): void
-    {
-        $path = mediaFN($this->getConf('media_kml'));
-        $lastmod = @filemtime($path);
-        $event->data ['items'] [] = new Item(ml($this->getConf('media_kml'), '', true, '&', true), $lastmod);
-    }
+	/**
+	 * Add a new SitemapItem object that points to the KML of public geocoded pages.
+	 *
+	 * @param Event $event
+	 */
+	final   public function handleSitemapGenerateBefore(Event $event): void
+	{
+		$path = mediaFN($this->getConf('media_kml'));
+		$lastmod = @filemtime($path);
+		$event->data ['items'] [] = new Item(ml($this->getConf('media_kml'), '', true, '&', true), $lastmod);
+	}
 
-    /**
-     * Create a spatial sitemap or attach the geo/kml map to the sitemap.
-     *
-     * @param Event $event
-     *          event object, not used
-     */
-    final   public function handleSitemapGenerateAfter(Event $event): bool
-    {
-        // $event→data['items']: Array of SitemapItem instances, the array of sitemap items that already
-        //      contains all public pages of the wiki
-        // $event→data['sitemap']: The path of the file the sitemap will be saved to.
-        if (($helper = plugin_load('helper', 'spatialhelper_sitemap')) !== null) {
-            $kml = $helper->createKMLSitemap($this->getConf('media_kml'));
-            $rss = $helper->createGeoRSSSitemap($this->getConf('media_georss'));
+	/**
+	 * Create a spatial sitemap or attach the geo/kml map to the sitemap.
+	 *
+	 * @param Event $event
+	 *          event object, not used
+	 */
+	final   public function handleSitemapGenerateAfter(Event $event): bool
+	{
+		// $event→data['items']: Array of SitemapItem instances, the array of sitemap items that already
+		//      contains all public pages of the wiki
+		// $event→data['sitemap']: The path of the file the sitemap will be saved to.
+		if (($helper = plugin_load('helper', 'spatialhelper_sitemap')) !== null) {
+			$kml = $helper->createKMLSitemap($this->getConf('media_kml'));
+			$rss = $helper->createGeoRSSSitemap($this->getConf('media_georss'));
 
-            if (!empty($this->getConf('sitemap_namespaces'))) {
-                $namespaces = array_map('trim', explode("\n", $this->getConf('sitemap_namespaces')));
-                foreach ($namespaces as $namespace) {
-                    $kmlN = $helper->createKMLSitemap($namespace . $this->getConf('media_kml'));
-                    $rssN = $helper->createGeoRSSSitemap($namespace . $this->getConf('media_georss'));
-                    Logger::debug(
-                        "handleSitemapGenerateAfter, created KML / GeoRSS sitemap in $namespace, succes: ",
-                        $kmlN && $rssN
-                    );
-                }
-            }
-            return $kml && $rss;
-        }
-        return false;
-    }
+			if (!empty($this->getConf('sitemap_namespaces'))) {
+				$namespaces = array_map('trim', explode("\n", $this->getConf('sitemap_namespaces')));
+				foreach ($namespaces as $namespace) {
+					$kmlN = $helper->createKMLSitemap($namespace . $this->getConf('media_kml'));
+					$rssN = $helper->createGeoRSSSitemap($namespace . $this->getConf('media_georss'));
+					Logger::debug(
+						"handleSitemapGenerateAfter, created KML / GeoRSS sitemap in $namespace, succes: ",
+						$kmlN && $rssN
+					);
+				}
+			}
+			return $kml && $rss;
+		}
+		return false;
+	}
 
-    /**
-     * trap findnearby action.
-     * This additional handler is required as described at: https://www.dokuwiki.org/devel:event:tpl_act_unknown
-     *
-     * @param Event $event
-     *          event object
-     */
-    final  public function handleActionActPreprocess(Event $event): void
-    {
-        if ($event->data !== 'findnearby') {
-            return;
-        }
-        $event->preventDefault();
-    }
+	/**
+	 * trap findnearby action.
+	 * This additional handler is required as described at: https://www.dokuwiki.org/devel:event:tpl_act_unknown
+	 *
+	 * @param Event $event
+	 *          event object
+	 */
+	final  public function handleActionActPreprocess(Event $event): void
+	{
+		if ($event->data !== 'findnearby') {
+			return;
+		}
+		$event->preventDefault();
+	}
 
-    /**
-     * handle findnearby action.
-     *
-     * @param Event $event
-     *          event object
-     * @param array $param
-     *          associative array with keys
-     *          'format'=> HTML | JSON
-     * @throws JsonException if anything goes wrong with JSON encoding
-     */
-    final  public function findnearby(Event $event, array $param): void
-    {
-        if ($event->data !== 'findnearby') {
-            return;
-        }
-        $event->preventDefault();
-        $results = [];
-        global $INPUT;
-        if (($helper = plugin_load('helper', 'spatialhelper_search')) !== null) {
-            if ($INPUT->has('lat') && $INPUT->has('lon')) {
-                $results = $helper->findNearbyLatLon($INPUT->param('lat'), $INPUT->param('lon'));
-            } elseif ($INPUT->has('geohash')) {
-                $results = $helper->findNearby($INPUT->str('geohash'));
-            } else {
-                $results = ['error' => hsc($this->getLang('invalidinput'))];
-            }
-        }
+	/**
+	 * handle findnearby action.
+	 *
+	 * @param Event $event
+	 *          event object
+	 * @param array $param
+	 *          associative array with keys
+	 *          'format'=> HTML | JSON
+	 * @throws JsonException if anything goes wrong with JSON encoding
+	 */
+	final  public function findnearby(Event $event, array $param): void
+	{
+		if ($event->data !== 'findnearby') {
+			return;
+		}
+		$event->preventDefault();
+		$results = [];
+		global $INPUT;
+		if (($helper = plugin_load('helper', 'spatialhelper_search')) !== null) {
+			if ($INPUT->has('lat') && $INPUT->has('lon')) {
+				$results = $helper->findNearbyLatLon($INPUT->param('lat'), $INPUT->param('lon'));
+			} elseif ($INPUT->has('geohash')) {
+				$results = $helper->findNearby($INPUT->str('geohash'));
+			} else {
+				$results = ['error' => hsc($this->getLang('invalidinput'))];
+			}
+		}
 
-        $showMedia = $INPUT->bool('showMedia', true);
+		$showMedia = $INPUT->bool('showMedia', true);
 
-        switch ($param['format']) {
-            case 'JSON':
-                $this->printJSON($results);
-                break;
-            case 'HTML':
-                // fall through to default
-            default:
-                $this->printHTML($results, $showMedia);
-                break;
-        }
-    }
+		switch ($param['format']) {
+			case 'JSON':
+				$this->printJSON($results);
+				break;
+			case 'HTML':
+				// fall through to default
+			default:
+				$this->printHTML($results, $showMedia);
+				break;
+		}
+	}
 
-    /**
-     * Print seachresults as HTML lists.
-     *
-     * @param array $searchresults
-     * @throws JsonException if anything goes wrong with JSON encoding
-     */
-    private function printJSON(array $searchresults): void
-    {
-        header('Content-Type: application/json');
-        echo json_encode($searchresults, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT);
-    }
+	/**
+	 * Print seachresults as HTML lists.
+	 *
+	 * @param array $searchresults
+	 * @throws JsonException if anything goes wrong with JSON encoding
+	 */
+	private function printJSON(array $searchresults): void
+	{
+		header('Content-Type: application/json');
+		echo json_encode($searchresults, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT);
+	}
 
-    /**
-     * Print seachresults as HTML lists.
-     *
-     * @param array $searchresults
-     * @param bool $showMedia
-     */
-    private function printHTML(array $searchresults, bool $showMedia = true): void
-    {
-        $pages = (array)($searchresults ['pages']);
-        $media = (array)$searchresults ['media'];
-        $lat = (float)$searchresults ['lat'];
-        $lon = (float)$searchresults ['lon'];
-        $geohash = (string)$searchresults ['geohash'];
+	/**
+	 * Print seachresults as HTML lists.
+	 *
+	 * @param array $searchresults
+	 * @param bool $showMedia
+	 */
+	private function printHTML(array $searchresults, bool $showMedia = true): void
+	{
+		$pages = (array)($searchresults ['pages']);
+		$media = (array)$searchresults ['media'];
+		$lat = (float)$searchresults ['lat'];
+		$lon = (float)$searchresults ['lon'];
+		$geohash = (string)$searchresults ['geohash'];
 
-        if (isset($searchresults ['error'])) {
-            echo '<div class="level1"><p>' . hsc($searchresults ['error']) . '</p></div>';
-            return;
-        }
+		if (isset($searchresults ['error'])) {
+			echo '<div class="level1"><p>' . hsc($searchresults ['error']) . '</p></div>';
+			return;
+		}
 
-        // print a HTML list
-        echo '<h1>' . $this->getLang('results_header') . '</h1>' . DOKU_LF;
-        echo '<div class="level1">' . DOKU_LF;
-        if ($pages !== []) {
-            $pagelist = '<ol>' . DOKU_LF;
-            foreach ($pages as $page) {
-                $pagelist .= '<li>' . html_wikilink(
-                    ':' . $page ['id'],
-                    useHeading('navigation') ? null :
-                            noNS($page ['id'])
-                ) . ' (' . $this->getLang('results_distance_prefix')
-                    . $page ['distance'] . '&nbsp;m) ' . $page ['description'] . '</li>' . DOKU_LF;
-            }
-            $pagelist .= '</ol>' . DOKU_LF;
+		// print a HTML list
+		echo '<h1>' . $this->getLang('results_header') . '</h1>' . DOKU_LF;
+		echo '<div class="level1">' . DOKU_LF;
+		if ($pages !== []) {
+			$pagelist = '<ol>' . DOKU_LF;
+			foreach ($pages as $page) {
+				$pagelist .= '<li>' . html_wikilink(
+					':' . $page ['id'],
+					useHeading('navigation') ? null :
+							noNS($page ['id'])
+				) . ' (' . $this->getLang('results_distance_prefix')
+					. $page ['distance'] . '&nbsp;m) ' . $page ['description'] . '</li>' . DOKU_LF;
+			}
+			$pagelist .= '</ol>' . DOKU_LF;
 
-            echo '<h2>' . $this->getLang('results_pages') . hsc(
-                ' lat;lon: ' . $lat . ';' . $lon
-                    . ' (geohash: ' . $geohash . ')'
-            ) . '</h2>';
-            echo '<div class="level2">' . DOKU_LF;
-            echo $pagelist;
-            echo '</div>' . DOKU_LF;
-        } else {
-            echo '<p>' . hsc($this->getLang('nothingfound')) . '</p>';
-        }
+			echo '<h2>' . $this->getLang('results_pages') . hsc(
+				' lat;lon: ' . $lat . ';' . $lon
+					. ' (geohash: ' . $geohash . ')'
+			) . '</h2>';
+			echo '<div class="level2">' . DOKU_LF;
+			echo $pagelist;
+			echo '</div>' . DOKU_LF;
+		} else {
+			echo '<p>' . hsc($this->getLang('nothingfound')) . '</p>';
+		}
 
-        if ($media !== [] && $showMedia) {
-            $pagelist = '<ol>' . DOKU_LF;
-            foreach ($media as $m) {
-                $opts = [];
-                $link = ml($m ['id'], $opts, false);
-                $opts ['w'] = '100';
-                $src = ml($m ['id'], $opts);
-                $pagelist .= '<li><a href="' . $link . '"><img src="' . $src . '" alt=""></a> ('
-                    . $this->getLang('results_distance_prefix') . $m ['distance'] . '&nbsp;m) '
-                    . '</li>' . DOKU_LF;
-            }
-            $pagelist .= '</ol>' . DOKU_LF;
+		if ($media !== [] && $showMedia) {
+			$pagelist = '<ol>' . DOKU_LF;
+			foreach ($media as $m) {
+				$opts = [];
+				$link = ml($m ['id'], $opts, false);
+				$opts ['w'] = '100';
+				$src = ml($m ['id'], $opts);
+				$pagelist .= '<li><a href="' . $link . '"><img src="' . $src . '" alt=""></a> ('
+					. $this->getLang('results_distance_prefix') . $m ['distance'] . '&nbsp;m) '
+					. '</li>' . DOKU_LF;
+			}
+			$pagelist .= '</ol>' . DOKU_LF;
 
-            echo '<h2>' . $this->getLang('results_media') . hsc(
-                ' lat;lon: ' . $lat . ';' . $lon
-                    . ' (geohash: ' . $geohash . ')'
-            ) . '</h2>' . DOKU_LF;
-            echo '<div class="level2">' . DOKU_LF;
-            echo $pagelist;
-            echo '</div>' . DOKU_LF;
-        }
-        echo '<p>' . $this->getLang('results_precision') . $searchresults ['precision'] . ' m. ';
-        if (strlen($geohash) > 1) {
-            $url = wl(
-                getID(),
-                ['do' => 'findnearby', 'geohash' => substr($geohash, 0, -1)]
-            );
-            echo '<a href="' . $url . '" class="findnearby">' . $this->getLang('search_largerarea') . '</a>.</p>'
-                . DOKU_LF;
-        }
-        echo '</div>' . DOKU_LF;
-    }
+			echo '<h2>' . $this->getLang('results_media') . hsc(
+				' lat;lon: ' . $lat . ';' . $lon
+					. ' (geohash: ' . $geohash . ')'
+			) . '</h2>' . DOKU_LF;
+			echo '<div class="level2">' . DOKU_LF;
+			echo $pagelist;
+			echo '</div>' . DOKU_LF;
+		}
+		echo '<p>' . $this->getLang('results_precision') . $searchresults ['precision'] . ' m. ';
+		if (strlen($geohash) > 1) {
+			$url = wl(
+				getID(),
+				['do' => 'findnearby', 'geohash' => substr($geohash, 0, -1)]
+			);
+			echo '<a href="' . $url . '" class="findnearby">' . $this->getLang('search_largerarea') . '</a>.</p>'
+				. DOKU_LF;
+		}
+		echo '</div>' . DOKU_LF;
+	}
 
-    /**
-     * add media to spatial index.
-     *
-     * @param Event $event
-     */
-    final  public function handleMediaUploaded(Event $event): void
-    {
-        //data[0] path/to/new/media.file (normally read from $_FILES, potentially could come from elsewhere)
-        //data[1] file name of the file being uploaded
-        //data[2] future directory id of the file being uploaded
-        //data[3] the mime type of the file being uploaded
-        //data[4] true if the uploaded file exists already
-        //data[5] (since 2011-02-06) the PHP function used to move the file to the correct location
+	/**
+	 * add media to spatial index.
+	 *
+	 * @param Event $event
+	 */
+	final  public function handleMediaUploaded(Event $event): void
+	{
+		//data[0] path/to/new/media.file (normally read from $_FILES, potentially could come from elsewhere)
+		//data[1] file name of the file being uploaded
+		//data[2] future directory id of the file being uploaded
+		//data[3] the mime type of the file being uploaded
+		//data[4] true if the uploaded file exists already
+		//data[5] (since 2011-02-06) the PHP function used to move the file to the correct location
 
-        Logger::debug("handleMediaUploaded::event data", $event->data);
+		Logger::debug("handleMediaUploaded::event data", $event->data);
 
-        // check the list of mimetypes
-        // if it's a supported type call appropriate index function
-        if (str_contains($event->data [3], 'image/jpeg')) {
-            $indexer = plugin_load('helper', 'spatialhelper_index');
-            if ($indexer !== null) {
-                $indexer->indexImage($event->data [2]);
-            }
-        }
-        // TODO add image/tiff
-        // TODO kml, gpx, geojson...
-    }
+		// check the list of mimetypes
+		// if it's a supported type call appropriate index function
+		if (str_contains($event->data [3], 'image/jpeg')) {
+			$indexer = plugin_load('helper', 'spatialhelper_index');
+			if ($indexer !== null) {
+				$indexer->indexImage($event->data [2]);
+			}
+		}
+		// TODO add image/tiff
+		// TODO kml, gpx, geojson...
+	}
 
-    /**
-     * removes the media from the index.
-     * @param Event $event event object with data
-     */
-    final   public function handleMediaDeleted(Event $event): void
-    {
-        // data['id'] ID data['unl'] unlink return code
-        // data['del'] Namespace directory unlink return code
-        // data['name'] file name data['path'] full path to the file
-        // data['size'] file size
+	/**
+	 * removes the media from the index.
+	 * @param Event $event event object with data
+	 */
+	final   public function handleMediaDeleted(Event $event): void
+	{
+		// data['id'] ID data['unl'] unlink return code
+		// data['del'] Namespace directory unlink return code
+		// data['name'] file name data['path'] full path to the file
+		// data['size'] file size
 
-        // remove the media id from the index
-        $indexer = plugin_load('helper', 'spatialhelper_index');
-        if ($indexer !== null) {
-            $indexer->deleteFromIndex('media__' . $event->data ['id']);
-        }
-    }
+		// remove the media id from the index
+		$indexer = plugin_load('helper', 'spatialhelper_index');
+		if ($indexer !== null) {
+			$indexer->deleteFromIndex('media__' . $event->data ['id']);
+		}
+	}
 
-    /**
-     * add a link to the spatial sitemap files in the header.
-     *
-     * @param Event $event the DokuWiki event. $event->data is a two-dimensional array of all meta headers.
-     * The keys are meta, link and script.
-     *
-     * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
-     */
-    final  public function handleMetaheaderOutput(Event $event): void
-    {
-        // TODO maybe test for exist
-        $event->data ["link"] [] = ["type" => "application/atom+xml", "rel" => "alternate",
-            "href" => ml($this->getConf('media_georss')), "title" => "Spatial ATOM Feed"];
-        $event->data ["link"] [] = ["type" => "application/vnd.google-earth.kml+xml", "rel" => "alternate",
-            "href" => ml($this->getConf('media_kml')), "title" => "KML Sitemap"];
-    }
+	/**
+	 * add a link to the spatial sitemap files in the header.
+	 *
+	 * @param Event $event the DokuWiki event. $event->data is a two-dimensional array of all meta headers.
+	 * The keys are meta, link and script.
+	 *
+	 * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
+	 */
+	final  public function handleMetaheaderOutput(Event $event): void
+	{
+		// TODO maybe test for exist
+		$event->data ["link"] [] = ["type" => "application/atom+xml", "rel" => "alternate",
+			"href" => ml($this->getConf('media_georss')), "title" => "Spatial ATOM Feed"];
+		$event->data ["link"] [] = ["type" => "application/vnd.google-earth.kml+xml", "rel" => "alternate",
+			"href" => ml($this->getConf('media_kml')), "title" => "KML Sitemap"];
+	}
 
-    /**
-     * Add spatialhelper popularity data.
-     *
-     * @param Event $event
-     *          the DokuWiki event
-     */
-    final public function popularity(Event $event): void
-    {
-        $versionInfo = getVersionData();
-        $plugin_info = $this->getInfo();
-        $event->data['spatialhelper']['version'] = $plugin_info['date'];
-        $event->data['spatialhelper']['dwversion'] = $versionInfo['date'];
-        $event->data['spatialhelper']['combinedversion'] = $versionInfo['date'] . '_' . $plugin_info['date'];
-    }
+	/**
+	 * Add spatialhelper popularity data.
+	 *
+	 * @param Event $event
+	 *          the DokuWiki event
+	 */
+	final public function popularity(Event $event): void
+	{
+		$versionInfo = getVersionData();
+		$plugin_info = $this->getInfo();
+		$event->data['spatialhelper']['version'] = $plugin_info['date'];
+		$event->data['spatialhelper']['dwversion'] = $versionInfo['date'];
+		$event->data['spatialhelper']['combinedversion'] = $versionInfo['date'] . '_' . $plugin_info['date'];
+	}
 }

admin/purge.php

Indentation +53 added lines, -53 removed lines

@@ -27,63 +27,63 @@
  */
 class admin_plugin_spatialhelper_purge extends AdminPlugin
 {
-    /**
-     *
-     * @see DokuWiki_Admin_Plugin::getMenuSort()
-     */
-    final  public function getMenuSort(): int
-    {
-        return 801;
-    }
+	/**
+	 *
+	 * @see DokuWiki_Admin_Plugin::getMenuSort()
+	 */
+	final  public function getMenuSort(): int
+	{
+		return 801;
+	}
 
-    final  public function getMenuIcon(): string
-    {
-        $plugin = $this->getPluginName();
-        return DOKU_PLUGIN . $plugin . '/admin/purge.svg';
-    }
+	final  public function getMenuIcon(): string
+	{
+		$plugin = $this->getPluginName();
+		return DOKU_PLUGIN . $plugin . '/admin/purge.svg';
+	}
 
-    /**
-     * purge and regenerate the index and sitemaps.
-     *
-     * @see DokuWiki_Admin_Plugin::handle()
-     */
-    final  public function handle(): void
-    {
-        if (isset($_REQUEST ['purgeindex'])) {
-            global $conf;
-            $path = $conf ['indexdir'] . '/spatial.idx';
-            if (file_exists($path) && unlink($path)) {
-                msg($this->getLang('admin_purged_tiles'), 0);
-            }
-        }
+	/**
+	 * purge and regenerate the index and sitemaps.
+	 *
+	 * @see DokuWiki_Admin_Plugin::handle()
+	 */
+	final  public function handle(): void
+	{
+		if (isset($_REQUEST ['purgeindex'])) {
+			global $conf;
+			$path = $conf ['indexdir'] . '/spatial.idx';
+			if (file_exists($path) && unlink($path)) {
+				msg($this->getLang('admin_purged_tiles'), 0);
+			}
+		}
 
-        $indexer = plugin_load('helper', 'spatialhelper_index');
-        if (isset($indexer)) {
-            $indexer->generateSpatialIndex();
-        }
+		$indexer = plugin_load('helper', 'spatialhelper_index');
+		if (isset($indexer)) {
+			$indexer->generateSpatialIndex();
+		}
 
-        $sitemapper = plugin_load('helper', 'spatialhelper_sitemap');
-        if (isset($sitemapper)) {
-            $sitemapper->createKMLSitemap($this->getConf('media_kml'));
-            $sitemapper->createGeoRSSSitemap($this->getConf('media_georss'));
-        }
-    }
+		$sitemapper = plugin_load('helper', 'spatialhelper_sitemap');
+		if (isset($sitemapper)) {
+			$sitemapper->createKMLSitemap($this->getConf('media_kml'));
+			$sitemapper->createGeoRSSSitemap($this->getConf('media_georss'));
+		}
+	}
 
-    /**
-     * render the form for this plugin.
-     *
-     * @see DokuWiki_Admin_Plugin::html()
-     */
-    final  public function html(): void
-    {
-        echo $this->locale_xhtml('admin_purge_intro');
+	/**
+	 * render the form for this plugin.
+	 *
+	 * @see DokuWiki_Admin_Plugin::html()
+	 */
+	final  public function html(): void
+	{
+		echo $this->locale_xhtml('admin_purge_intro');
 
-        $form = new Form(
-            ['id' => 'spatialhelper__purgeform', 'method' => 'post']
-        );
-        $form->setHiddenField('purgeindex', 'true');
-        $form->addButton('submit', $this->getLang('admin_submit'))
-            ->attr('title', $this->getLang('admin_submit'));
-        echo $form->toHTML();
-    }
+		$form = new Form(
+			['id' => 'spatialhelper__purgeform', 'method' => 'post']
+		);
+		$form->setHiddenField('purgeindex', 'true');
+		$form->addButton('submit', $this->getLang('admin_submit'))
+			->attr('title', $this->getLang('admin_submit'));
+		echo $form->toHTML();
+	}
 }

helper/sitemap.php

Indentation +214 added lines, -214 removed lines

@@ -27,218 +27,218 @@
  */
 class helper_plugin_spatialhelper_sitemap extends Plugin
 {
-    /**
-     * spatial index.
-     */
-    private $spatial_idx;
-
-    /**
-     * constructor, load spatial index.
-     */
-    public function __construct()
-    {
-        global $conf;
-        $idx_dir = $conf['indexdir'];
-        if (!@file_exists($idx_dir . '/spatial.idx')) {
-            $indexer = plugin_load('helper', 'spatialhelper_index');
-            if ($indexer !== null) {
-                $indexer->generateSpatialIndex();
-            }
-        }
-        $this->spatial_idx = unserialize(
-            io_readFile($idx_dir . '/spatial.idx', false),
-            ['allowed_classes' => false]
-        );
-    }
-
-    final public function getMethods(): array
-    {
-        $result[] = [
-            'name' => 'createGeoRSSSitemap',
-            'desc' => 'create a spatial sitemap in GeoRSS format.',
-            'params' => ['path' => 'string'], 'return' => ['success' => 'boolean']
-        ];
-        $result[] = [
-            'name' => 'createKMLSitemap',
-            'desc' => 'create a spatial sitemap in KML format.',
-            'params' => ['path' => 'string'], 'return' => ['success' => 'boolean']
-        ];
-        return $result;
-    }
-
-    /**
-     * Create a GeoRSS Simple sitemap (Atom).
-     *
-     * @param string $mediaID id
-     *                        for the GeoRSS file
-     */
-    final public function createGeoRSSSitemap(string $mediaID): bool
-    {
-        global $conf;
-        $namespace = getNS($mediaID);
-
-        $idTag = 'tag:' . parse_url(DOKU_URL, PHP_URL_HOST) . ',';
-
-        $RSSstart = '<?xml version="1.0" encoding="UTF-8"?>' . DOKU_LF;
-        $RSSstart .= '<feed xmlns="http://www.w3.org/2005/Atom" xmlns:georss="http://www.georss.org/georss" ';
-        $RSSstart .= 'xmlns:dc="http://purl.org/dc/elements/1.1/">' . DOKU_LF;
-        $RSSstart .= '<title>' . $conf['title'] . ' spatial feed</title>' . DOKU_LF;
-        if (!empty($conf['tagline'])) {
-            $RSSstart .= '<subtitle>' . $conf['tagline'] . '</subtitle>' . DOKU_LF;
-        }
-        $RSSstart .= '<dc:publisher>' . $conf['title'] . '</dc:publisher>' . DOKU_LF;
-        $RSSstart .= '<link href="' . DOKU_URL . '" />' . DOKU_LF;
-        $RSSstart .= '<link href="' . ml($mediaID, '', true, '&amp;', true) . '" rel="self" />' . DOKU_LF;
-        $RSSstart .= '<updated>' . date(DATE_ATOM) . '</updated>' . DOKU_LF;
-        $RSSstart .= '<id>' . $idTag . date("Y-m-d") . ':' . parse_url(ml($mediaID), PHP_URL_PATH)
-            . '</id>' . DOKU_LF;
-        $RSSstart .= '<rights>' . $conf['license'] . '</rights>' . DOKU_LF;
-
-        $RSSend = '</feed>' . DOKU_LF;
-
-        io_createNamespace($mediaID, 'media');
-        @touch(mediaFN($mediaID));
-        @chmod(mediaFN($mediaID), $conf['fmode']);
-        $fh = fopen(mediaFN($mediaID), 'wb');
-        fwrite($fh, $RSSstart);
-
-        foreach ($this->spatial_idx as $idxEntry) {
-            // get list of id's
-            foreach ($idxEntry as $id) {
-                // for document item in the index
-                if (strpos($id, 'media__') !== 0) {
-                    if ($this->skipPage($id, $namespace)) {
-                        continue;
-                    }
-
-                    $meta = p_get_metadata($id);
-
-                    // $desc = p_render('xhtmlsummary', p_get_instructions($meta['description']['abstract']), $info);
-                    $desc = strip_tags($meta['description']['abstract']);
-
-                    $entry = '<entry>' . DOKU_LF;
-                    $entry .= '  <title>' . $meta['title'] . '</title>' . DOKU_LF;
-                    $entry .= '  <summary>' . $desc . '</summary>' . DOKU_LF;
-                    $entry .= '  <georss:point>' . $meta['geo']['lat'] . ' ' . $meta['geo']['lon']
-                        . '</georss:point>' . DOKU_LF;
-                    if (!empty($meta['geo']['alt'])) {
-                        $entry .= '  <georss:elev>' . $meta['geo']['alt'] . '</georss:elev>' . DOKU_LF;
-                    }
-                    $entry .= '  <link href="' . wl($id) . '" rel="alternate" type="text/html" />' . DOKU_LF;
-                    if (empty($meta['creator'])) {
-                        $meta['creator'] = $conf['title'];
-                    }
-                    $entry .= '  <author><name>' . $meta['creator'] . '</name></author>' . DOKU_LF;
-                    $entry .= '  <updated>' . date_iso8601($meta['date']['modified']) . '</updated>' . DOKU_LF;
-                    $entry .= '  <published>' . date_iso8601($meta['date']['created']) . '</published>' . DOKU_LF;
-                    $entry .= '  <id>' . $idTag . date("Y-m-d", $meta['date']['modified']) . ':'
-                        . parse_url(wl($id), PHP_URL_PATH) . '</id>' . DOKU_LF;
-                    $entry .= '</entry>' . DOKU_LF;
-                    fwrite($fh, $entry);
-                }
-            }
-        }
-
-        fwrite($fh, $RSSend);
-        return fclose($fh);
-    }
-
-    /**
-     * will return true for non-public or hidden pages or pages that are not below or in the namespace.
-     */
-    private function skipPage(string $id, string $namespace): bool
-    {
-        Logger::debug("helper_plugin_spatialhelper_sitemap::skipPage, skipping $id, not in $namespace");
-        if (isHiddenPage($id)) {
-            return true;
-        }
-        if (auth_aclcheck($id, '', null) < AUTH_READ) {
-            return true;
-        }
-
-        if (!empty($namespace)) {
-            // only if id is in or below namespace
-            if (0 !== strpos(getNS($id), $namespace)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-    /**
-     * Create a KML sitemap.
-     *
-     * @param string $mediaID id for the KML file
-     */
-    final public function createKMLSitemap(string $mediaID): bool
-    {
-        global $conf;
-        $namespace = getNS($mediaID);
-
-        $KMLstart = '<?xml version="1.0" encoding="UTF-8"?>' . DOKU_LF;
-        $KMLstart .= '<kml xmlns="http://www.opengis.net/kml/2.2" ';
-        $KMLstart .= 'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ';
-        $KMLstart .= 'xmlns:atom="http://www.w3.org/2005/Atom"';
-        $KMLstart .= ' xsi:schemaLocation="http://www.opengis.net/kml/2.2 ';
-        $KMLstart .= 'http://schemas.opengis.net/kml/2.2.0/ogckml22.xsd">' . DOKU_LF;
-        $KMLstart .= '<Document id="root_doc">' . DOKU_LF;
-        $KMLstart .= '<name>' . $conf['title'] . ' spatial sitemap</name>' . DOKU_LF;
-        $KMLstart .= '<atom:link href="' . DOKU_URL . '" rel="related" type="text/html" />' . DOKU_LF;
-        $KMLstart .= '<!-- atom:updated>' . date(DATE_ATOM) . '</atom:updated -->' . DOKU_LF;
-        $KMLstart .= '<Style id="icon"><IconStyle><color>ffffffff</color><scale>1</scale>';
-        $KMLstart .= '<Icon><href>'
-            . DOKU_BASE . 'lib/plugins/spatialhelper/wikiitem.png</href></Icon></IconStyle></Style>' . DOKU_LF;
-
-        $KMLend = '</Document>' . DOKU_LF . '</kml>';
-
-        io_createNamespace($mediaID, 'media');
-        @touch(mediaFN($mediaID));
-        @chmod(mediaFN($mediaID), $conf['fmode']);
-
-        $fh = fopen(mediaFN($mediaID), 'wb');
-        fwrite($fh, $KMLstart);
-
-        foreach ($this->spatial_idx as $idxEntry) {
-            // get list of id's
-            foreach ($idxEntry as $id) {
-                // for document item in the index
-                if (strpos($id, 'media__') !== 0) {
-                    if ($this->skipPage($id, $namespace)) {
-                        continue;
-                    }
-
-                    $meta = p_get_metadata($id);
-
-                    // $desc = p_render('xhtmlsummary', p_get_instructions($meta['description']['abstract']), $info);
-                    $desc = '<p>' . strip_tags($meta['description']['abstract']) . '</p>';
-                    $desc .= '<p><a href="' . wl($id, '', true) . '">' . $meta['title'] . '</a></p>';
-
-                    // create an entry and store it
-                    $plcm = '<Placemark id="crc32-' . hash('crc32', $id) . '">' . DOKU_LF;
-                    $plcm .= '  <name>' . $meta['title'] . '</name>' . DOKU_LF;
-                    // TODO escape quotes in: title="' . $meta['title'] . '"
-                    $plcm .= '  <atom:link href="' . wl($id, '' . true) . '" rel="alternate" type="text/html" />'
-                        . DOKU_LF;
-                    if (!empty($meta['creator'])) {
-                        $plcm .= '  <atom:author><atom:name>' . $meta['creator'] . '</atom:name></atom:author>'
-                            . DOKU_LF;
-                    }
-
-                    $plcm .= '  <description><![CDATA[' . $desc . ']]></description>' . DOKU_LF;
-                    $plcm .= '  <styleUrl>#icon</styleUrl>' . DOKU_LF;
-
-                    $plcm .= '  <Point><coordinates>' . $meta['geo']['lon'] . ',' . $meta['geo']['lat'];
-                    if (!empty($meta['geo']['alt'])) {
-                        $plcm .= ',' . $meta['geo']['alt'];
-                    }
-                    $plcm .= '</coordinates></Point>' . DOKU_LF;
-                    $plcm .= '</Placemark>' . DOKU_LF;
-
-                    fwrite($fh, $plcm);
-                }
-            }
-        }
-        fwrite($fh, $KMLend);
-        return fclose($fh);
-    }
+	/**
+	 * spatial index.
+	 */
+	private $spatial_idx;
+
+	/**
+	 * constructor, load spatial index.
+	 */
+	public function __construct()
+	{
+		global $conf;
+		$idx_dir = $conf['indexdir'];
+		if (!@file_exists($idx_dir . '/spatial.idx')) {
+			$indexer = plugin_load('helper', 'spatialhelper_index');
+			if ($indexer !== null) {
+				$indexer->generateSpatialIndex();
+			}
+		}
+		$this->spatial_idx = unserialize(
+			io_readFile($idx_dir . '/spatial.idx', false),
+			['allowed_classes' => false]
+		);
+	}
+
+	final public function getMethods(): array
+	{
+		$result[] = [
+			'name' => 'createGeoRSSSitemap',
+			'desc' => 'create a spatial sitemap in GeoRSS format.',
+			'params' => ['path' => 'string'], 'return' => ['success' => 'boolean']
+		];
+		$result[] = [
+			'name' => 'createKMLSitemap',
+			'desc' => 'create a spatial sitemap in KML format.',
+			'params' => ['path' => 'string'], 'return' => ['success' => 'boolean']
+		];
+		return $result;
+	}
+
+	/**
+	 * Create a GeoRSS Simple sitemap (Atom).
+	 *
+	 * @param string $mediaID id
+	 *                        for the GeoRSS file
+	 */
+	final public function createGeoRSSSitemap(string $mediaID): bool
+	{
+		global $conf;
+		$namespace = getNS($mediaID);
+
+		$idTag = 'tag:' . parse_url(DOKU_URL, PHP_URL_HOST) . ',';
+
+		$RSSstart = '<?xml version="1.0" encoding="UTF-8"?>' . DOKU_LF;
+		$RSSstart .= '<feed xmlns="http://www.w3.org/2005/Atom" xmlns:georss="http://www.georss.org/georss" ';
+		$RSSstart .= 'xmlns:dc="http://purl.org/dc/elements/1.1/">' . DOKU_LF;
+		$RSSstart .= '<title>' . $conf['title'] . ' spatial feed</title>' . DOKU_LF;
+		if (!empty($conf['tagline'])) {
+			$RSSstart .= '<subtitle>' . $conf['tagline'] . '</subtitle>' . DOKU_LF;
+		}
+		$RSSstart .= '<dc:publisher>' . $conf['title'] . '</dc:publisher>' . DOKU_LF;
+		$RSSstart .= '<link href="' . DOKU_URL . '" />' . DOKU_LF;
+		$RSSstart .= '<link href="' . ml($mediaID, '', true, '&amp;', true) . '" rel="self" />' . DOKU_LF;
+		$RSSstart .= '<updated>' . date(DATE_ATOM) . '</updated>' . DOKU_LF;
+		$RSSstart .= '<id>' . $idTag . date("Y-m-d") . ':' . parse_url(ml($mediaID), PHP_URL_PATH)
+			. '</id>' . DOKU_LF;
+		$RSSstart .= '<rights>' . $conf['license'] . '</rights>' . DOKU_LF;
+
+		$RSSend = '</feed>' . DOKU_LF;
+
+		io_createNamespace($mediaID, 'media');
+		@touch(mediaFN($mediaID));
+		@chmod(mediaFN($mediaID), $conf['fmode']);
+		$fh = fopen(mediaFN($mediaID), 'wb');
+		fwrite($fh, $RSSstart);
+
+		foreach ($this->spatial_idx as $idxEntry) {
+			// get list of id's
+			foreach ($idxEntry as $id) {
+				// for document item in the index
+				if (strpos($id, 'media__') !== 0) {
+					if ($this->skipPage($id, $namespace)) {
+						continue;
+					}
+
+					$meta = p_get_metadata($id);
+
+					// $desc = p_render('xhtmlsummary', p_get_instructions($meta['description']['abstract']), $info);
+					$desc = strip_tags($meta['description']['abstract']);
+
+					$entry = '<entry>' . DOKU_LF;
+					$entry .= '  <title>' . $meta['title'] . '</title>' . DOKU_LF;
+					$entry .= '  <summary>' . $desc . '</summary>' . DOKU_LF;
+					$entry .= '  <georss:point>' . $meta['geo']['lat'] . ' ' . $meta['geo']['lon']
+						. '</georss:point>' . DOKU_LF;
+					if (!empty($meta['geo']['alt'])) {
+						$entry .= '  <georss:elev>' . $meta['geo']['alt'] . '</georss:elev>' . DOKU_LF;
+					}
+					$entry .= '  <link href="' . wl($id) . '" rel="alternate" type="text/html" />' . DOKU_LF;
+					if (empty($meta['creator'])) {
+						$meta['creator'] = $conf['title'];
+					}
+					$entry .= '  <author><name>' . $meta['creator'] . '</name></author>' . DOKU_LF;
+					$entry .= '  <updated>' . date_iso8601($meta['date']['modified']) . '</updated>' . DOKU_LF;
+					$entry .= '  <published>' . date_iso8601($meta['date']['created']) . '</published>' . DOKU_LF;
+					$entry .= '  <id>' . $idTag . date("Y-m-d", $meta['date']['modified']) . ':'
+						. parse_url(wl($id), PHP_URL_PATH) . '</id>' . DOKU_LF;
+					$entry .= '</entry>' . DOKU_LF;
+					fwrite($fh, $entry);
+				}
+			}
+		}
+
+		fwrite($fh, $RSSend);
+		return fclose($fh);
+	}
+
+	/**
+	 * will return true for non-public or hidden pages or pages that are not below or in the namespace.
+	 */
+	private function skipPage(string $id, string $namespace): bool
+	{
+		Logger::debug("helper_plugin_spatialhelper_sitemap::skipPage, skipping $id, not in $namespace");
+		if (isHiddenPage($id)) {
+			return true;
+		}
+		if (auth_aclcheck($id, '', null) < AUTH_READ) {
+			return true;
+		}
+
+		if (!empty($namespace)) {
+			// only if id is in or below namespace
+			if (0 !== strpos(getNS($id), $namespace)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Create a KML sitemap.
+	 *
+	 * @param string $mediaID id for the KML file
+	 */
+	final public function createKMLSitemap(string $mediaID): bool
+	{
+		global $conf;
+		$namespace = getNS($mediaID);
+
+		$KMLstart = '<?xml version="1.0" encoding="UTF-8"?>' . DOKU_LF;
+		$KMLstart .= '<kml xmlns="http://www.opengis.net/kml/2.2" ';
+		$KMLstart .= 'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ';
+		$KMLstart .= 'xmlns:atom="http://www.w3.org/2005/Atom"';
+		$KMLstart .= ' xsi:schemaLocation="http://www.opengis.net/kml/2.2 ';
+		$KMLstart .= 'http://schemas.opengis.net/kml/2.2.0/ogckml22.xsd">' . DOKU_LF;
+		$KMLstart .= '<Document id="root_doc">' . DOKU_LF;
+		$KMLstart .= '<name>' . $conf['title'] . ' spatial sitemap</name>' . DOKU_LF;
+		$KMLstart .= '<atom:link href="' . DOKU_URL . '" rel="related" type="text/html" />' . DOKU_LF;
+		$KMLstart .= '<!-- atom:updated>' . date(DATE_ATOM) . '</atom:updated -->' . DOKU_LF;
+		$KMLstart .= '<Style id="icon"><IconStyle><color>ffffffff</color><scale>1</scale>';
+		$KMLstart .= '<Icon><href>'
+			. DOKU_BASE . 'lib/plugins/spatialhelper/wikiitem.png</href></Icon></IconStyle></Style>' . DOKU_LF;
+
+		$KMLend = '</Document>' . DOKU_LF . '</kml>';
+
+		io_createNamespace($mediaID, 'media');
+		@touch(mediaFN($mediaID));
+		@chmod(mediaFN($mediaID), $conf['fmode']);
+
+		$fh = fopen(mediaFN($mediaID), 'wb');
+		fwrite($fh, $KMLstart);
+
+		foreach ($this->spatial_idx as $idxEntry) {
+			// get list of id's
+			foreach ($idxEntry as $id) {
+				// for document item in the index
+				if (strpos($id, 'media__') !== 0) {
+					if ($this->skipPage($id, $namespace)) {
+						continue;
+					}
+
+					$meta = p_get_metadata($id);
+
+					// $desc = p_render('xhtmlsummary', p_get_instructions($meta['description']['abstract']), $info);
+					$desc = '<p>' . strip_tags($meta['description']['abstract']) . '</p>';
+					$desc .= '<p><a href="' . wl($id, '', true) . '">' . $meta['title'] . '</a></p>';
+
+					// create an entry and store it
+					$plcm = '<Placemark id="crc32-' . hash('crc32', $id) . '">' . DOKU_LF;
+					$plcm .= '  <name>' . $meta['title'] . '</name>' . DOKU_LF;
+					// TODO escape quotes in: title="' . $meta['title'] . '"
+					$plcm .= '  <atom:link href="' . wl($id, '' . true) . '" rel="alternate" type="text/html" />'
+						. DOKU_LF;
+					if (!empty($meta['creator'])) {
+						$plcm .= '  <atom:author><atom:name>' . $meta['creator'] . '</atom:name></atom:author>'
+							. DOKU_LF;
+					}
+
+					$plcm .= '  <description><![CDATA[' . $desc . ']]></description>' . DOKU_LF;
+					$plcm .= '  <styleUrl>#icon</styleUrl>' . DOKU_LF;
+
+					$plcm .= '  <Point><coordinates>' . $meta['geo']['lon'] . ',' . $meta['geo']['lat'];
+					if (!empty($meta['geo']['alt'])) {
+						$plcm .= ',' . $meta['geo']['alt'];
+					}
+					$plcm .= '</coordinates></Point>' . DOKU_LF;
+					$plcm .= '</Placemark>' . DOKU_LF;
+
+					fwrite($fh, $plcm);
+				}
+			}
+		}
+		fwrite($fh, $KMLend);
+		return fclose($fh);
+	}
 }

helper/search.php

Indentation +139 added lines, -139 removed lines

@@ -30,155 +30,155 @@
  */
 class helper_plugin_spatialhelper_search extends Plugin
 {
-    /**
-     * spatial index.
-     *
-     * @var array
-     */
-    protected $spatial_idx = [];
-    /**
-     * Precision, Distance of Adjacent Cell in Meters.
-     *
-     * @see https://stackoverflow.com/questions/13836416/geohash-and-max-distance
-     *
-     * @var float
-     */
-    private $precision = [5_003_530, 625441, 123264, 19545, 3803, 610, 118, 19, 3.7, 0.6];
+	/**
+	 * spatial index.
+	 *
+	 * @var array
+	 */
+	protected $spatial_idx = [];
+	/**
+	 * Precision, Distance of Adjacent Cell in Meters.
+	 *
+	 * @see https://stackoverflow.com/questions/13836416/geohash-and-max-distance
+	 *
+	 * @var float
+	 */
+	private $precision = [5_003_530, 625441, 123264, 19545, 3803, 610, 118, 19, 3.7, 0.6];
 
-    /**
-     * constructor; initialize/load spatial index.
-     */
-    public function __construct()
-    {
-        global $conf;
+	/**
+	 * constructor; initialize/load spatial index.
+	 */
+	public function __construct()
+	{
+		global $conf;
 
-        if (plugin_load('helper', 'geophp', false, true) === null) {
-            $message =
-                'helper_plugin_spatialhelper_search::spatialhelper_search: required geophp plugin is not available.';
-            msg($message, -1);
-        }
+		if (plugin_load('helper', 'geophp', false, true) === null) {
+			$message =
+				'helper_plugin_spatialhelper_search::spatialhelper_search: required geophp plugin is not available.';
+			msg($message, -1);
+		}
 
-        $idx_dir = $conf ['indexdir'];
-        if (!@file_exists($idx_dir . '/spatial.idx')) {
-            plugin_load('helper', 'spatialhelper_index');
-        }
+		$idx_dir = $conf ['indexdir'];
+		if (!@file_exists($idx_dir . '/spatial.idx')) {
+			plugin_load('helper', 'spatialhelper_index');
+		}
 
-        $this->spatial_idx = unserialize(io_readFile($idx_dir . '/spatial.idx', false), ['allowed_classes' => false]);
-    }
+		$this->spatial_idx = unserialize(io_readFile($idx_dir . '/spatial.idx', false), ['allowed_classes' => false]);
+	}
 
-    /**
-     * Find locations based on the coordinate pair.
-     *
-     * @param float $lat
-     *          The y coordinate (or latitude)
-     * @param float $lon
-     *          The x coordinate (or longitude)
-     * @throws Exception
-     */
-    final public function findNearbyLatLon(float $lat, float $lon): array
-    {
-        $geometry = new Point($lon, $lat);
-        return $this->findNearby($geometry->out('geohash'), $geometry);
-    }
+	/**
+	 * Find locations based on the coordinate pair.
+	 *
+	 * @param float $lat
+	 *          The y coordinate (or latitude)
+	 * @param float $lon
+	 *          The x coordinate (or longitude)
+	 * @throws Exception
+	 */
+	final public function findNearbyLatLon(float $lat, float $lon): array
+	{
+		$geometry = new Point($lon, $lat);
+		return $this->findNearby($geometry->out('geohash'), $geometry);
+	}
 
-    /**
-     * finds nearby elements in the index based on the geohash.
-     * returns a list of documents and the bunding box.
-     *
-     * @param string $geohash
-     * @param Point|null $p
-     *          optional point
-     * @return array of ...
-     * @throws Exception
-     */
-    final public function findNearby(string $geohash, Point $p = null): array
-    {
-        $_geohashClass = new Geohash();
-        if (!$p instanceof Point) {
-            $decodedPoint = $_geohashClass->read($geohash);
-        } else {
-            $decodedPoint = $p;
-        }
+	/**
+	 * finds nearby elements in the index based on the geohash.
+	 * returns a list of documents and the bunding box.
+	 *
+	 * @param string $geohash
+	 * @param Point|null $p
+	 *          optional point
+	 * @return array of ...
+	 * @throws Exception
+	 */
+	final public function findNearby(string $geohash, Point $p = null): array
+	{
+		$_geohashClass = new Geohash();
+		if (!$p instanceof Point) {
+			$decodedPoint = $_geohashClass->read($geohash);
+		} else {
+			$decodedPoint = $p;
+		}
 
-        // find adjacent blocks
-        $adjacent = [];
-        $adjacent ['center'] = $geohash;
-        $adjacent ['top'] = Geohash::adjacent($adjacent ['center'], 'top');
-        $adjacent ['bottom'] = Geohash::adjacent($adjacent ['center'], 'bottom');
-        $adjacent ['right'] = Geohash::adjacent($adjacent ['center'], 'right');
-        $adjacent ['left'] = Geohash::adjacent($adjacent ['center'], 'left');
-        $adjacent ['topleft'] = Geohash::adjacent($adjacent ['left'], 'top');
-        $adjacent ['topright'] = Geohash::adjacent($adjacent ['right'], 'top');
-        $adjacent ['bottomright'] = Geohash::adjacent($adjacent ['right'], 'bottom');
-        $adjacent ['bottomleft'] = Geohash::adjacent($adjacent ['left'], 'bottom');
-        Logger::debug("adjacent geo hashes", $adjacent);
+		// find adjacent blocks
+		$adjacent = [];
+		$adjacent ['center'] = $geohash;
+		$adjacent ['top'] = Geohash::adjacent($adjacent ['center'], 'top');
+		$adjacent ['bottom'] = Geohash::adjacent($adjacent ['center'], 'bottom');
+		$adjacent ['right'] = Geohash::adjacent($adjacent ['center'], 'right');
+		$adjacent ['left'] = Geohash::adjacent($adjacent ['center'], 'left');
+		$adjacent ['topleft'] = Geohash::adjacent($adjacent ['left'], 'top');
+		$adjacent ['topright'] = Geohash::adjacent($adjacent ['right'], 'top');
+		$adjacent ['bottomright'] = Geohash::adjacent($adjacent ['right'], 'bottom');
+		$adjacent ['bottomleft'] = Geohash::adjacent($adjacent ['left'], 'bottom');
+		Logger::debug("adjacent geo hashes", $adjacent);
 
-        // find all the pages in the index that overlap with the adjacent hashes
-        $docIds = [];
-        foreach ($adjacent as $adjHash) {
-            if (is_array($this->spatial_idx)) {
-                foreach ($this->spatial_idx as $_geohash => $_docIds) {
-                    if (strpos($_geohash, (string)$adjHash) !== false) {
-                        // if $adjHash similar to geohash
-                        $docIds = array_merge($docIds, $_docIds);
-                    }
-                }
-            }
-        }
-        $docIds = array_unique($docIds);
-        Logger::debug("found docIDs", $docIds);
+		// find all the pages in the index that overlap with the adjacent hashes
+		$docIds = [];
+		foreach ($adjacent as $adjHash) {
+			if (is_array($this->spatial_idx)) {
+				foreach ($this->spatial_idx as $_geohash => $_docIds) {
+					if (strpos($_geohash, (string)$adjHash) !== false) {
+						// if $adjHash similar to geohash
+						$docIds = array_merge($docIds, $_docIds);
+					}
+				}
+			}
+		}
+		$docIds = array_unique($docIds);
+		Logger::debug("found docIDs", $docIds);
 
-        // create associative array of pages + calculate distance
-        $pages = [];
-        $media = [];
-        $indexer = plugin_load('helper', 'spatialhelper_index');
+		// create associative array of pages + calculate distance
+		$pages = [];
+		$media = [];
+		$indexer = plugin_load('helper', 'spatialhelper_index');
 
-        foreach ($docIds as $id) {
-            if (strpos($id, 'media__') === 0) {
-                $id = substr($id, strlen('media__'));
-                if (auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
-                    $point = $indexer->getCoordsFromExif($id);
-                    $line = new LineString(
-                        [
-                            $decodedPoint,
-                            $point
-                        ]
-                    );
-                    $media [] = ['id' => $id, 'distance' => (int)($line->greatCircleLength()),
-                        'lat' => $point->y(), 'lon' => $point->x()];
-                }
-            } elseif (auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
-                $geotags = p_get_metadata($id, 'geo');
-                $point = new Point($geotags ['lon'], $geotags ['lat']);
-                $line = new LineString(
-                    [
-                        $decodedPoint,
-                        $point
-                    ]
-                );
-                $pages [] = ['id' => $id, 'distance' => (int)($line->greatCircleLength()),
-                    'description' => p_get_metadata($id, 'description')['abstract'],
-                    'lat' => $geotags ['lat'], 'lon' => $geotags ['lon']];
-            }
-        }
+		foreach ($docIds as $id) {
+			if (strpos($id, 'media__') === 0) {
+				$id = substr($id, strlen('media__'));
+				if (auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
+					$point = $indexer->getCoordsFromExif($id);
+					$line = new LineString(
+						[
+							$decodedPoint,
+							$point
+						]
+					);
+					$media [] = ['id' => $id, 'distance' => (int)($line->greatCircleLength()),
+						'lat' => $point->y(), 'lon' => $point->x()];
+				}
+			} elseif (auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
+				$geotags = p_get_metadata($id, 'geo');
+				$point = new Point($geotags ['lon'], $geotags ['lat']);
+				$line = new LineString(
+					[
+						$decodedPoint,
+						$point
+					]
+				);
+				$pages [] = ['id' => $id, 'distance' => (int)($line->greatCircleLength()),
+					'description' => p_get_metadata($id, 'description')['abstract'],
+					'lat' => $geotags ['lat'], 'lon' => $geotags ['lon']];
+			}
+		}
 
-        // sort all the pages/media using distance
-        usort(
-            $pages,
-            static fn($a, $b) => strnatcmp($a ['distance'], $b ['distance'])
-        );
-        usort(
-            $media,
-            static fn($a, $b) => strnatcmp($a ['distance'], $b ['distance'])
-        );
+		// sort all the pages/media using distance
+		usort(
+			$pages,
+			static fn($a, $b) => strnatcmp($a ['distance'], $b ['distance'])
+		);
+		usort(
+			$media,
+			static fn($a, $b) => strnatcmp($a ['distance'], $b ['distance'])
+		);
 
-        return [
-            'pages' => $pages,
-            'media' => $media,
-            'lat' => $decodedPoint->y(),
-            'lon' => $decodedPoint->x(),
-            'geohash' => $geohash,
-            'precision' => $this->precision [strlen($geohash)]
-        ];
-    }
+		return [
+			'pages' => $pages,
+			'media' => $media,
+			'lat' => $decodedPoint->y(),
+			'lon' => $decodedPoint->x(),
+			'geohash' => $geohash,
+			'precision' => $this->precision [strlen($geohash)]
+		];
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -118,7 +118,7 @@ 
         foreach ($adjacent as $adjHash) {
             if (is_array($this->spatial_idx)) {
                 foreach ($this->spatial_idx as $_geohash => $_docIds) {
-                    if (strpos($_geohash, (string)$adjHash) !== false) {
+                    if (strpos($_geohash, ( string ) $adjHash) !== false) {
                         // if $adjHash similar to geohash
                         $docIds = array_merge($docIds, $_docIds);
                     }
@@ -144,7 +144,7 @@ 
                             $point
                         ]
                     );
-                    $media [] = ['id' => $id, 'distance' => (int)($line->greatCircleLength()),
+                    $media [] = ['id' => $id, 'distance' => ( int ) ($line->greatCircleLength()),
                         'lat' => $point->y(), 'lon' => $point->x()];
                 }
             } elseif (auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
@@ -156,7 +156,7 @@ 
                         $point
                     ]
                 );
-                $pages [] = ['id' => $id, 'distance' => (int)($line->greatCircleLength()),
+                $pages [] = ['id' => $id, 'distance' => ( int ) ($line->greatCircleLength()),
                     'description' => p_get_metadata($id, 'description')['abstract'],
                     'lat' => $geotags ['lat'], 'lon' => $geotags ['lon']];
             }

syntax/findnearby.php

Indentation +84 added lines, -84 removed lines

@@ -26,94 +26,94 @@
  */
 class syntax_plugin_spatialhelper_findnearby extends SyntaxPlugin
 {
-    /**
-     *
-     * @see DokuWiki_Syntax_Plugin::getType()
-     */
-    final public function getType(): string
-    {
-        return 'substition';
-    }
+	/**
+	 *
+	 * @see DokuWiki_Syntax_Plugin::getType()
+	 */
+	final public function getType(): string
+	{
+		return 'substition';
+	}
 
-    /**
-     * Return 'normal' so this syntax can be rendered inline.
-     *
-     * @see DokuWiki_Syntax_Plugin::getPType()
-     */
-    final public function getPType(): string
-    {
-        return 'normal';
-    }
+	/**
+	 * Return 'normal' so this syntax can be rendered inline.
+	 *
+	 * @see DokuWiki_Syntax_Plugin::getPType()
+	 */
+	final public function getPType(): string
+	{
+		return 'normal';
+	}
 
-    /**
-     *
-     * @see Doku_Parser_Mode::getSort()
-     */
-    final public function getSort(): int
-    {
-        return 307;
-    }
+	/**
+	 *
+	 * @see Doku_Parser_Mode::getSort()
+	 */
+	final public function getSort(): int
+	{
+		return 307;
+	}
 
-    /**
-     * define our special pattern: {{findnearby>Some linkt text or nothing}}.
-     *
-     * @see Doku_Parser_Mode::connectTo()
-     */
-    final public function connectTo($mode): void
-    {
-        $this->Lexer->addSpecialPattern('\{\{findnearby>.*?\}\}', $mode, 'plugin_spatialhelper_findnearby');
-    }
+	/**
+	 * define our special pattern: {{findnearby>Some linkt text or nothing}}.
+	 *
+	 * @see Doku_Parser_Mode::connectTo()
+	 */
+	final public function connectTo($mode): void
+	{
+		$this->Lexer->addSpecialPattern('\{\{findnearby>.*?\}\}', $mode, 'plugin_spatialhelper_findnearby');
+	}
 
-    /**
-     * look up the page's geo metadata and pass that on to render.
-     *
-     * @param string $match The text matched by the patterns
-     * @param int $state The lexer state for the match
-     * @param int $pos The character position of the matched text
-     * @param Doku_Handler $handler The Doku_Handler object
-     * @return  bool|array Return an array with all data you want to use in render, false don't add an instruction
-     *
-     * @see DokuWiki_Syntax_Plugin::handle()
-     */
-    final public function handle($match, $state, $pos, Doku_Handler $handler): bool|array
-    {
-        $data = [];
-        $data [0] = trim(substr($match, strlen('{{findnearby>'), -2));
-        if ($data [0] === '') {
-            $data [0] = $this->getLang('search_findnearby');
-        }
-        $meta = p_get_metadata(getID(), 'geo');
-        if ($meta) {
-            if ($meta ['lat'] && $meta ['lon']) {
-                $data [1] = ['do' => 'findnearby', 'lat' => $meta ['lat'], 'lon' => $meta ['lon']];
-            } elseif ($meta ['geohash']) {
-                $data [1] = ['do' => 'findnearby', 'geohash' => $meta ['geohash']];
-            }
-            return $data;
-        }
-        return false;
-    }
+	/**
+	 * look up the page's geo metadata and pass that on to render.
+	 *
+	 * @param string $match The text matched by the patterns
+	 * @param int $state The lexer state for the match
+	 * @param int $pos The character position of the matched text
+	 * @param Doku_Handler $handler The Doku_Handler object
+	 * @return  bool|array Return an array with all data you want to use in render, false don't add an instruction
+	 *
+	 * @see DokuWiki_Syntax_Plugin::handle()
+	 */
+	final public function handle($match, $state, $pos, Doku_Handler $handler): bool|array
+	{
+		$data = [];
+		$data [0] = trim(substr($match, strlen('{{findnearby>'), -2));
+		if ($data [0] === '') {
+			$data [0] = $this->getLang('search_findnearby');
+		}
+		$meta = p_get_metadata(getID(), 'geo');
+		if ($meta) {
+			if ($meta ['lat'] && $meta ['lon']) {
+				$data [1] = ['do' => 'findnearby', 'lat' => $meta ['lat'], 'lon' => $meta ['lon']];
+			} elseif ($meta ['geohash']) {
+				$data [1] = ['do' => 'findnearby', 'geohash' => $meta ['geohash']];
+			}
+			return $data;
+		}
+		return false;
+	}
 
-    /**
-     * Render a link to a search page.
-     *
-     * @see DokuWiki_Syntax_Plugin::render()
-     */
-    final public function render($format, Doku_Renderer $renderer, $data): bool
-    {
-        if ($data === false) {
-            return false;
-        }
+	/**
+	 * Render a link to a search page.
+	 *
+	 * @see DokuWiki_Syntax_Plugin::render()
+	 */
+	final public function render($format, Doku_Renderer $renderer, $data): bool
+	{
+		if ($data === false) {
+			return false;
+		}
 
-        if ($format === 'xhtml') {
-            $renderer->doc .= '<a href="' . wl(getID(), $data [1]) . '" class="findnearby">' . hsc($data [0]) . '</a>';
-            return true;
-        } elseif ($format === 'metadata') {
-            return false;
-        } elseif ($format === 'odt') {
-            // don't render anything in ODT
-            return false;
-        }
-        return false;
-    }
+		if ($format === 'xhtml') {
+			$renderer->doc .= '<a href="' . wl(getID(), $data [1]) . '" class="findnearby">' . hsc($data [0]) . '</a>';
+			return true;
+		} elseif ($format === 'metadata') {
+			return false;
+		} elseif ($format === 'odt') {
+			// don't render anything in ODT
+			return false;
+		}
+		return false;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
      *
      * @see DokuWiki_Syntax_Plugin::handle()
      */
-    final public function handle($match, $state, $pos, Doku_Handler $handler): bool|array
+    final public function handle($match, $state, $pos, Doku_Handler $handler): bool | array
     {
         $data = [];
         $data [0] = trim(substr($match, strlen('{{findnearby>'), -2));

helper/index.php

Indentation +270 added lines, -270 removed lines

@@ -28,296 +28,296 @@
  */
 class helper_plugin_spatialhelper_index extends Plugin
 {
-    /**
-     * directory for index files.
-     *
-     * @var string
-     */
-    protected string $idx_dir = '';
+	/**
+	 * directory for index files.
+	 *
+	 * @var string
+	 */
+	protected string $idx_dir = '';
 
-    /**
-     * spatial index, we'll look up list/array so we can do spatial queries.
-     * entries should be: array("geohash" => {"id1","id3",})
-     *
-     * @var array
-     */
-    protected array $spatial_idx = [];
+	/**
+	 * spatial index, we'll look up list/array so we can do spatial queries.
+	 * entries should be: array("geohash" => {"id1","id3",})
+	 *
+	 * @var array
+	 */
+	protected array $spatial_idx = [];
 
-    /**
-     * Constructor, initialises the spatial index.
-     * @throws Exception
-     */
-    public function __construct()
-    {
-        if (plugin_load('helper', 'geophp') === null) {
-            $message = 'Required geophp plugin is not available';
-            msg($message, -1);
-        }
+	/**
+	 * Constructor, initialises the spatial index.
+	 * @throws Exception
+	 */
+	public function __construct()
+	{
+		if (plugin_load('helper', 'geophp') === null) {
+			$message = 'Required geophp plugin is not available';
+			msg($message, -1);
+		}
 
-        global $conf;
-        $this->idx_dir = $conf ['indexdir'];
-        // test if there is a spatialindex, if not build one for the wiki
-        if (!@file_exists($this->idx_dir . '/spatial.idx')) {
-            // creates and stores the index
-            $this->generateSpatialIndex();
-        } else {
-            $this->spatial_idx = unserialize(
-                io_readFile($this->idx_dir . '/spatial.idx', false),
-                ['allowed_classes' => false]
-            );
-            Logger::debug('done loading spatial index', $this->spatial_idx);
-        }
-    }
+		global $conf;
+		$this->idx_dir = $conf ['indexdir'];
+		// test if there is a spatialindex, if not build one for the wiki
+		if (!@file_exists($this->idx_dir . '/spatial.idx')) {
+			// creates and stores the index
+			$this->generateSpatialIndex();
+		} else {
+			$this->spatial_idx = unserialize(
+				io_readFile($this->idx_dir . '/spatial.idx', false),
+				['allowed_classes' => false]
+			);
+			Logger::debug('done loading spatial index', $this->spatial_idx);
+		}
+	}
 
-    /**
-     * (re-)Generates the spatial index by running through all the pages in the wiki.
-     *
-     * @throws Exception
-     * @todo add an option to erase the old index
-     */
-    final public function generateSpatialIndex(): bool
-    {
-        global $conf;
-        require_once(DOKU_INC . 'inc/search.php');
-        $pages = [];
-        search($pages, $conf ['datadir'], 'search_allpages', []);
-        foreach ($pages as $page) {
-            $this->updateSpatialIndex($page ['id']);
-        }
-        // media
-        $media = [];
-        search($media, $conf['mediadir'], 'search_media', []);
-        foreach ($media as $medium) {
-            if ($medium['isimg']) {
-                $this->indexImage($medium['id']);
-            }
-        }
-        return true;
-    }
+	/**
+	 * (re-)Generates the spatial index by running through all the pages in the wiki.
+	 *
+	 * @throws Exception
+	 * @todo add an option to erase the old index
+	 */
+	final public function generateSpatialIndex(): bool
+	{
+		global $conf;
+		require_once(DOKU_INC . 'inc/search.php');
+		$pages = [];
+		search($pages, $conf ['datadir'], 'search_allpages', []);
+		foreach ($pages as $page) {
+			$this->updateSpatialIndex($page ['id']);
+		}
+		// media
+		$media = [];
+		search($media, $conf['mediadir'], 'search_media', []);
+		foreach ($media as $medium) {
+			if ($medium['isimg']) {
+				$this->indexImage($medium['id']);
+			}
+		}
+		return true;
+	}
 
-    /**
-     * Update the spatial index for the page.
-     *
-     * @param string $id
-     *          the document ID
-     * @throws Exception
-     */
-    final public function updateSpatialIndex(string $id): bool
-    {
-        $geotags = p_get_metadata($id, 'geo');
-        if (empty($geotags)) {
-            return false;
-        }
-        if (empty($geotags ['lon']) || empty($geotags ['lat'])) {
-            return false;
-        }
-        Logger::debug("Geo metadata found for page $id", $geotags);
-        $geometry = new Point($geotags ['lon'], $geotags ['lat']);
-        $geohash = $geometry->out('geohash');
-        Logger::debug('Update index for geohash: ' . $geohash);
-        return $this->addToIndex($geohash, $id);
-    }
+	/**
+	 * Update the spatial index for the page.
+	 *
+	 * @param string $id
+	 *          the document ID
+	 * @throws Exception
+	 */
+	final public function updateSpatialIndex(string $id): bool
+	{
+		$geotags = p_get_metadata($id, 'geo');
+		if (empty($geotags)) {
+			return false;
+		}
+		if (empty($geotags ['lon']) || empty($geotags ['lat'])) {
+			return false;
+		}
+		Logger::debug("Geo metadata found for page $id", $geotags);
+		$geometry = new Point($geotags ['lon'], $geotags ['lat']);
+		$geohash = $geometry->out('geohash');
+		Logger::debug('Update index for geohash: ' . $geohash);
+		return $this->addToIndex($geohash, $id);
+	}
 
-    /**
-     * Store the hash/id entry in the index.
-     *
-     * @param string $geohash
-     * @param string $id
-     *          page or media id
-     * @return bool true when succesful
-     */
-    private function addToIndex(string $geohash, string $id): bool
-    {
-        $pageIds = [];
-        // check index for key/geohash
-        if (!array_key_exists($geohash, $this->spatial_idx)) {
-            Logger::debug("Geohash $geohash not in index, just add $id.");
-            $pageIds [] = $id;
-        } else {
-            Logger::debug('Geohash for document is in index, find it.');
-            // check the index for document
-            $knownHashes = $this->findHashesForId($id, $this->spatial_idx);
-            if ($knownHashes === []) {
-                Logger::debug("No index record found for document $id, adding it to the index.");
-                $pageIds = $this->spatial_idx [$geohash];
-                $pageIds [] = $id;
-            }
-            // TODO shortcut, need to make sure there is only one element, if not the index is corrupt
-            $knownHash = $knownHashes [0];
+	/**
+	 * Store the hash/id entry in the index.
+	 *
+	 * @param string $geohash
+	 * @param string $id
+	 *          page or media id
+	 * @return bool true when succesful
+	 */
+	private function addToIndex(string $geohash, string $id): bool
+	{
+		$pageIds = [];
+		// check index for key/geohash
+		if (!array_key_exists($geohash, $this->spatial_idx)) {
+			Logger::debug("Geohash $geohash not in index, just add $id.");
+			$pageIds [] = $id;
+		} else {
+			Logger::debug('Geohash for document is in index, find it.');
+			// check the index for document
+			$knownHashes = $this->findHashesForId($id, $this->spatial_idx);
+			if ($knownHashes === []) {
+				Logger::debug("No index record found for document $id, adding it to the index.");
+				$pageIds = $this->spatial_idx [$geohash];
+				$pageIds [] = $id;
+			}
+			// TODO shortcut, need to make sure there is only one element, if not the index is corrupt
+			$knownHash = $knownHashes [0];
 
-            if ($knownHash === $geohash) {
-                Logger::debug("Document $id was found in index and has the same geohash, nothing to do.");
-                return true;
-            }
+			if ($knownHash === $geohash) {
+				Logger::debug("Document $id was found in index and has the same geohash, nothing to do.");
+				return true;
+			}
 
-            if (!empty($knownHash)) {
-                Logger::debug("Document/media $id was found in index but has different geohash (it moved).");
-                $knownIds = $this->spatial_idx [$knownHash];
-                Logger::debug("Known id's for this hash:", $knownIds);
-                // remove it from the old geohash element
-                $i = array_search($id, $knownIds);
-                Logger::debug('Unsetting:' . $knownIds [$i]);
-                unset($knownIds [$i]);
-                $this->spatial_idx [$knownHash] = $knownIds;
-                // set on new geohash element
-                $pageIds = $this->spatial_idx[$geohash];
-                $pageIds [] = $id;
-            }
-        }
-        // store and save
-        $this->spatial_idx [$geohash] = $pageIds;
-        return $this->saveIndex();
-    }
+			if (!empty($knownHash)) {
+				Logger::debug("Document/media $id was found in index but has different geohash (it moved).");
+				$knownIds = $this->spatial_idx [$knownHash];
+				Logger::debug("Known id's for this hash:", $knownIds);
+				// remove it from the old geohash element
+				$i = array_search($id, $knownIds);
+				Logger::debug('Unsetting:' . $knownIds [$i]);
+				unset($knownIds [$i]);
+				$this->spatial_idx [$knownHash] = $knownIds;
+				// set on new geohash element
+				$pageIds = $this->spatial_idx[$geohash];
+				$pageIds [] = $id;
+			}
+		}
+		// store and save
+		$this->spatial_idx [$geohash] = $pageIds;
+		return $this->saveIndex();
+	}
 
-    /**
-     * Looks up the geohash(es) for the document in the index.
-     *
-     * @param String $id
-     *          document ID
-     * @param array $index
-     *          spatial index
-     */
-    final public function findHashesForId(string $id, array $index): array
-    {
-        $hashes = [];
-        foreach ($index as $hash => $docIds) {
-            if (in_array($id, $docIds)) {
-                $hashes [] = $hash;
-            }
-        }
-        Logger::debug("Found the following hashes for $id (should only be 1)", $hashes);
-        return $hashes;
-    }
+	/**
+	 * Looks up the geohash(es) for the document in the index.
+	 *
+	 * @param String $id
+	 *          document ID
+	 * @param array $index
+	 *          spatial index
+	 */
+	final public function findHashesForId(string $id, array $index): array
+	{
+		$hashes = [];
+		foreach ($index as $hash => $docIds) {
+			if (in_array($id, $docIds)) {
+				$hashes [] = $hash;
+			}
+		}
+		Logger::debug("Found the following hashes for $id (should only be 1)", $hashes);
+		return $hashes;
+	}
 
-    /**
-     * Save spatial index.
-     */
-    private function saveIndex(): bool
-    {
-        return io_saveFile($this->idx_dir . '/spatial.idx', serialize($this->spatial_idx));
-    }
+	/**
+	 * Save spatial index.
+	 */
+	private function saveIndex(): bool
+	{
+		return io_saveFile($this->idx_dir . '/spatial.idx', serialize($this->spatial_idx));
+	}
 
-    /**
-     * Add an index entry for this file having EXIF / IPTC data.
-     *
-     * @param $imgId
-     *          a Dokuwiki image id
-     * @return bool true when image was successfully added to the index.
-     * @throws Exception
-     * @see http://www.php.net/manual/en/function.iptcparse.php
-     * @see http://php.net/manual/en/function.exif-read-data.php
-     *
-     */
-    final public function indexImage(string $imgId): bool
-    {
-        // test for supported files (jpeg only)
-        if (
-            (!str_ends_with(strtolower($imgId), '.jpg')) &&
-            (!str_ends_with(strtolower($imgId), '.jpeg'))
-        ) {
-            Logger::debug("indexImage:: " . $imgId . " is not a supported image file.");
-            return false;
-        }
+	/**
+	 * Add an index entry for this file having EXIF / IPTC data.
+	 *
+	 * @param $imgId
+	 *          a Dokuwiki image id
+	 * @return bool true when image was successfully added to the index.
+	 * @throws Exception
+	 * @see http://www.php.net/manual/en/function.iptcparse.php
+	 * @see http://php.net/manual/en/function.exif-read-data.php
+	 *
+	 */
+	final public function indexImage(string $imgId): bool
+	{
+		// test for supported files (jpeg only)
+		if (
+			(!str_ends_with(strtolower($imgId), '.jpg')) &&
+			(!str_ends_with(strtolower($imgId), '.jpeg'))
+		) {
+			Logger::debug("indexImage:: " . $imgId . " is not a supported image file.");
+			return false;
+		}
 
-        $geometry = $this->getCoordsFromExif($imgId);
-        if (!$geometry) {
-            return false;
-        }
-        $geohash = $geometry->out('geohash');
-        // TODO truncate the geohash to something reasonable, otherwise they are
-        //   useless as an indexing mechanism eg. u1h73weckdrmskdqec3c9 is far too
-        //   precise, limit at ~9 as most GPS are not submeter accurate
-        return $this->addToIndex($geohash, 'media__' . $imgId);
-    }
+		$geometry = $this->getCoordsFromExif($imgId);
+		if (!$geometry) {
+			return false;
+		}
+		$geohash = $geometry->out('geohash');
+		// TODO truncate the geohash to something reasonable, otherwise they are
+		//   useless as an indexing mechanism eg. u1h73weckdrmskdqec3c9 is far too
+		//   precise, limit at ~9 as most GPS are not submeter accurate
+		return $this->addToIndex($geohash, 'media__' . $imgId);
+	}
 
-    /**
-     * retrieve GPS decimal coordinates from exif.
-     *
-     * @param string $id
-     * @return Point|false
-     * @throws Exception
-     */
-    final public function getCoordsFromExif(string $id): Point|false
-    {
-        $exif = exif_read_data(mediaFN($id), 0, true);
-        if (!$exif || empty($exif ['GPS'])) {
-            return false;
-        }
+	/**
+	 * retrieve GPS decimal coordinates from exif.
+	 *
+	 * @param string $id
+	 * @return Point|false
+	 * @throws Exception
+	 */
+	final public function getCoordsFromExif(string $id): Point|false
+	{
+		$exif = exif_read_data(mediaFN($id), 0, true);
+		if (!$exif || empty($exif ['GPS'])) {
+			return false;
+		}
 
-        $lat = $this->convertDMStoD(
-            [
-                $exif ['GPS'] ['GPSLatitude'] [0],
-                $exif ['GPS'] ['GPSLatitude'] [1],
-                $exif ['GPS'] ['GPSLatitude'] [2],
-                $exif ['GPS'] ['GPSLatitudeRef'] ?? 'N'
-            ]
-        );
+		$lat = $this->convertDMStoD(
+			[
+				$exif ['GPS'] ['GPSLatitude'] [0],
+				$exif ['GPS'] ['GPSLatitude'] [1],
+				$exif ['GPS'] ['GPSLatitude'] [2],
+				$exif ['GPS'] ['GPSLatitudeRef'] ?? 'N'
+			]
+		);
 
-        $lon = $this->convertDMStoD(
-            [
-                $exif ['GPS'] ['GPSLongitude'] [0],
-                $exif ['GPS'] ['GPSLongitude'] [1],
-                $exif ['GPS'] ['GPSLongitude'] [2],
-                $exif ['GPS'] ['GPSLongitudeRef'] ?? 'E'
-            ]
-        );
+		$lon = $this->convertDMStoD(
+			[
+				$exif ['GPS'] ['GPSLongitude'] [0],
+				$exif ['GPS'] ['GPSLongitude'] [1],
+				$exif ['GPS'] ['GPSLongitude'] [2],
+				$exif ['GPS'] ['GPSLongitudeRef'] ?? 'E'
+			]
+		);
 
-        return new Point($lon, $lat);
-    }
+		return new Point($lon, $lat);
+	}
 
-    /**
-     * convert DegreesMinutesSeconds to Decimal degrees.
-     *
-     * @param array $param array of rational DMS
-     */
-    final  public function convertDMStoD(array $param): float
-    {
-        //        if (!(is_array($param))) {
-        //            $param = [$param];
-        //        }
-        $deg = $this->convertRationaltoFloat($param [0]);
-        $min = $this->convertRationaltoFloat($param [1]) / 60;
-        $sec = $this->convertRationaltoFloat($param [2]) / 60 / 60;
-        // Hemisphere (N, S, W or E)
-        $hem = ($param [3] === 'N' || $param [3] === 'E') ? 1 : -1;
+	/**
+	 * convert DegreesMinutesSeconds to Decimal degrees.
+	 *
+	 * @param array $param array of rational DMS
+	 */
+	final  public function convertDMStoD(array $param): float
+	{
+		//        if (!(is_array($param))) {
+		//            $param = [$param];
+		//        }
+		$deg = $this->convertRationaltoFloat($param [0]);
+		$min = $this->convertRationaltoFloat($param [1]) / 60;
+		$sec = $this->convertRationaltoFloat($param [2]) / 60 / 60;
+		// Hemisphere (N, S, W or E)
+		$hem = ($param [3] === 'N' || $param [3] === 'E') ? 1 : -1;
 
-        return $hem * ($deg + $min + $sec);
-    }
+		return $hem * ($deg + $min + $sec);
+	}
 
-    final public function convertRationaltoFloat(string $param): float
-    {
-        // rational64u
-        $nums = explode('/', $param);
-        if ((int)$nums[1] > 0) {
-            return (float)$nums[0] / (int)$nums[1];
-        }
+	final public function convertRationaltoFloat(string $param): float
+	{
+		// rational64u
+		$nums = explode('/', $param);
+		if ((int)$nums[1] > 0) {
+			return (float)$nums[0] / (int)$nums[1];
+		}
 
-        return (float)$nums[0];
-    }
+		return (float)$nums[0];
+	}
 
-    /**
-     * Deletes the page from the index.
-     *
-     * @param string $id document ID
-     */
-    final public function deleteFromIndex(string $id): void
-    {
-        // check the index for document
-        $knownHashes = $this->findHashesForId($id, $this->spatial_idx);
-        if ($knownHashes === []) {
-            return;
-        }
+	/**
+	 * Deletes the page from the index.
+	 *
+	 * @param string $id document ID
+	 */
+	final public function deleteFromIndex(string $id): void
+	{
+		// check the index for document
+		$knownHashes = $this->findHashesForId($id, $this->spatial_idx);
+		if ($knownHashes === []) {
+			return;
+		}
 
-        // TODO shortcut, need to make sure there is only one element, if not the index is corrupt
-        $knownHash = $knownHashes [0];
-        $knownIds = $this->spatial_idx [$knownHash];
-        $i = array_search($id, $knownIds);
-        Logger::debug("removing: $knownIds[$i] from the index.");
-        unset($knownIds [$i]);
-        $this->spatial_idx [$knownHash] = $knownIds;
-        if (empty($this->spatial_idx [$knownHash])) {
-            unset($this->spatial_idx [$knownHash]);
-        }
-        $this->saveIndex();
-    }
+		// TODO shortcut, need to make sure there is only one element, if not the index is corrupt
+		$knownHash = $knownHashes [0];
+		$knownIds = $this->spatial_idx [$knownHash];
+		$i = array_search($id, $knownIds);
+		Logger::debug("removing: $knownIds[$i] from the index.");
+		unset($knownIds [$i]);
+		$this->spatial_idx [$knownHash] = $knownIds;
+		if (empty($this->spatial_idx [$knownHash])) {
+			unset($this->spatial_idx [$knownHash]);
+		}
+		$this->saveIndex();
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -237,7 +237,7 @@ 
      * @return Point|false
      * @throws Exception
      */
-    final public function getCoordsFromExif(string $id): Point|false
+    final public function getCoordsFromExif(string $id): Point | false
     {
         $exif = exif_read_data(mediaFN($id), 0, true);
         if (!$exif || empty($exif ['GPS'])) {
@@ -288,11 +288,11 @@ 
     {
         // rational64u
         $nums = explode('/', $param);
-        if ((int)$nums[1] > 0) {
-            return (float)$nums[0] / (int)$nums[1];
+        if (( int ) $nums[1] > 0) {
+            return ( float ) $nums[0] / ( int ) $nums[1];
         }
 
-        return (float)$nums[0];
+        return ( float ) $nums[0];
     }
 
     /**

_test/general.test.php

Indentation +34 added lines, -34 removed lines

@@ -26,43 +26,43 @@
 class general_plugin_spatialhelper_test extends DokuWikiTest
 {
 
-    protected $pluginsEnabled = array('spatialhelper');
+	protected $pluginsEnabled = array('spatialhelper');
 
-    /**
-     * Simple test to make sure the plugin.info.txt is in correct format.
-     */
-    final  public function test_plugininfo(): void
-    {
-        $file = __DIR__ . '/../plugin.info.txt';
-        self::assertFileExists($file);
+	/**
+	 * Simple test to make sure the plugin.info.txt is in correct format.
+	 */
+	final  public function test_plugininfo(): void
+	{
+		$file = __DIR__ . '/../plugin.info.txt';
+		self::assertFileExists($file);
 
-        $info = confToHash($file);
+		$info = confToHash($file);
 
-        self::assertArrayHasKey('base', $info);
-        self::assertArrayHasKey('author', $info);
-        self::assertArrayHasKey('email', $info);
-        self::assertArrayHasKey('date', $info);
-        self::assertArrayHasKey('name', $info);
-        self::assertArrayHasKey('desc', $info);
-        self::assertArrayHasKey('url', $info);
+		self::assertArrayHasKey('base', $info);
+		self::assertArrayHasKey('author', $info);
+		self::assertArrayHasKey('email', $info);
+		self::assertArrayHasKey('date', $info);
+		self::assertArrayHasKey('name', $info);
+		self::assertArrayHasKey('desc', $info);
+		self::assertArrayHasKey('url', $info);
 
-        self::assertEquals('spatialhelper', $info['base']);
-        self::assertRegExp('/^https?:\/\//', $info['url']);
-        self::assertTrue(mail_isvalid($info['email']));
-        self::assertRegExp('/^\d\d\d\d-\d\d-\d\d$/', $info['date']);
-        self::assertNotFalse(strtotime($info['date']));
-    }
+		self::assertEquals('spatialhelper', $info['base']);
+		self::assertRegExp('/^https?:\/\//', $info['url']);
+		self::assertTrue(mail_isvalid($info['email']));
+		self::assertRegExp('/^\d\d\d\d-\d\d-\d\d$/', $info['date']);
+		self::assertNotFalse(strtotime($info['date']));
+	}
 
-    /**
-     * test if plugin is loaded.
-     */
-    final  public function test_plugin_spatialhelper_isloaded(): void
-    {
-        global $plugin_controller;
-        self::assertContains(
-            'spatialhelper',
-            $plugin_controller->getList(),
-            "spatialhelper plugin is loaded"
-        );
-    }
+	/**
+	 * test if plugin is loaded.
+	 */
+	final  public function test_plugin_spatialhelper_isloaded(): void
+	{
+		global $plugin_controller;
+		self::assertContains(
+			'spatialhelper',
+			$plugin_controller->getList(),
+			"spatialhelper plugin is loaded"
+		);
+	}
 }

_test/index.test.php

Indentation +89 added lines, -89 removed lines

@@ -15,93 +15,93 @@
 class index_test extends DokuWikiTest
 {
 
-    protected $pluginsEnabled = array('spatialhelper');
-
-    /**
-     * copy data and add pages to the index.
-     */
-    public static function setUpBeforeClass(): void
-    {
-        parent::setUpBeforeClass();
-        global $conf;
-        $conf['allowdebug'] = 1;
-
-        TestUtils::rcopy(TMP_DIR, __DIR__ . '/data/');
-    }
-
-    /**
-     * Testdata for @return array
-     * @see index_test::test_convertDMStoD
-     *
-     */
-    final public static function convertDMStoDTestdata(): array
-    {
-        return array(
-            array(
-                array(0 => '52/1', 1 => '31/1', 2 => '2/1', 3 => 'N',),
-                52.5172,
-                'Latitude in Europe'
-            ),
-            array(
-                array(0 => '13/1', 1 => '30/1', 2 => '38/1', 3 => 'E',),
-                13.5105,
-                'Longitude in Europe'
-            ),
-            array(
-                array(0 => '50/1', 1 => '34251480/1000000', 2 => '0/1', 3 => 'N',),
-                50.5708,
-                'Latitude in North America'
-            ),
-            array(
-                array(0 => '109/1', 1 => '28041300/1000000', 2 => '0/1', 3 => 'W',),
-                -109.4673,
-                'Longitude in North America'
-            ),
-        );
-    }
-
-    final public function setUp(): void
-    {
-        parent::setUp();
-
-        global $conf;
-        $conf['allowdebug'] = 1;
-        $conf['cachetime'] = -1;
-    }
-
-    /**
-     * @dataProvider convertDMStoDTestdata
-     */
-    final public function test_convertDMStoD(array $input, float $expected_output, string $msg): void
-    {
-        $index = plugin_load('helper', 'spatialhelper_index');
-        assert($index instanceof helper_plugin_spatialhelper_index);
-
-        $actual_output = $index->convertDMStoD($input);
-
-        self::assertEqualsWithDelta($expected_output, $actual_output, 0.0001, $msg);
-    }
-
-    final public function test_ImageWithoutGeotag(): void
-    {
-        $index = plugin_load('helper', 'spatialhelper_index');
-        assert($index instanceof helper_plugin_spatialhelper_index);
-
-        $actual_output = $index->getCoordsFromExif(':vesder_eupen_no_gps.jpg');
-        self::assertFalse($actual_output, 'Expected no geotag to be found');
-    }
-
-    final public function test_ImageWithGeotag(): void
-    {
-        $index = plugin_load('helper', 'spatialhelper_index');
-        assert($index instanceof helper_plugin_spatialhelper_index);
-
-        // lat/lon: 37°4'36.12",31°39'21.96" or x/y: 31.6561,37.0767
-        $actual_output = $index->getCoordsFromExif(':manavgat_restaurant_handost_with_gps.jpg');
-
-        self::assertNotNull($actual_output, 'Expected a geotag to be found');
-        self::assertNotFalse($actual_output, 'Expected a geotag to be found');
-        self::assertEqualsWithDelta(31.6561, $actual_output->x(), 0.0001);
-        self::assertEqualsWithDelta(37.0767, $actual_output->y(), 0.0001);
-    }
+	protected $pluginsEnabled = array('spatialhelper');
+
+	/**
+	 * copy data and add pages to the index.
+	 */
+	public static function setUpBeforeClass(): void
+	{
+		parent::setUpBeforeClass();
+		global $conf;
+		$conf['allowdebug'] = 1;
+
+		TestUtils::rcopy(TMP_DIR, __DIR__ . '/data/');
+	}
+
+	/**
+	 * Testdata for @return array
+	 * @see index_test::test_convertDMStoD
+	 *
+	 */
+	final public static function convertDMStoDTestdata(): array
+	{
+		return array(
+			array(
+				array(0 => '52/1', 1 => '31/1', 2 => '2/1', 3 => 'N',),
+				52.5172,
+				'Latitude in Europe'
+			),
+			array(
+				array(0 => '13/1', 1 => '30/1', 2 => '38/1', 3 => 'E',),
+				13.5105,
+				'Longitude in Europe'
+			),
+			array(
+				array(0 => '50/1', 1 => '34251480/1000000', 2 => '0/1', 3 => 'N',),
+				50.5708,
+				'Latitude in North America'
+			),
+			array(
+				array(0 => '109/1', 1 => '28041300/1000000', 2 => '0/1', 3 => 'W',),
+				-109.4673,
+				'Longitude in North America'
+			),
+		);
+	}
+
+	final public function setUp(): void
+	{
+		parent::setUp();
+
+		global $conf;
+		$conf['allowdebug'] = 1;
+		$conf['cachetime'] = -1;
+	}
+
+	/**
+	 * @dataProvider convertDMStoDTestdata
+	 */
+	final public function test_convertDMStoD(array $input, float $expected_output, string $msg): void
+	{
+		$index = plugin_load('helper', 'spatialhelper_index');
+		assert($index instanceof helper_plugin_spatialhelper_index);
+
+		$actual_output = $index->convertDMStoD($input);
+
+		self::assertEqualsWithDelta($expected_output, $actual_output, 0.0001, $msg);
+	}
+
+	final public function test_ImageWithoutGeotag(): void
+	{
+		$index = plugin_load('helper', 'spatialhelper_index');
+		assert($index instanceof helper_plugin_spatialhelper_index);
+
+		$actual_output = $index->getCoordsFromExif(':vesder_eupen_no_gps.jpg');
+		self::assertFalse($actual_output, 'Expected no geotag to be found');
+	}
+
+	final public function test_ImageWithGeotag(): void
+	{
+		$index = plugin_load('helper', 'spatialhelper_index');
+		assert($index instanceof helper_plugin_spatialhelper_index);
+
+		// lat/lon: 37°4'36.12",31°39'21.96" or x/y: 31.6561,37.0767
+		$actual_output = $index->getCoordsFromExif(':manavgat_restaurant_handost_with_gps.jpg');
+
+		self::assertNotNull($actual_output, 'Expected a geotag to be found');
+		self::assertNotFalse($actual_output, 'Expected a geotag to be found');
+		self::assertEqualsWithDelta(31.6561, $actual_output->x(), 0.0001);
+		self::assertEqualsWithDelta(37.0767, $actual_output->y(), 0.0001);
+	}
 }