mprins / dokuwiki-plugin-spatialhelper

helper/search.php

Indentation +161 added lines, -161 removed lines

@@ -26,177 +26,177 @@
  * @author  Mark Prins
  */
 class helper_plugin_spatialhelper_search extends DokuWiki_Plugin {
-    /**
-     * spatial index.
-     *
-     * @var array
-     */
-    protected $spatial_idx = array();
-    /**
-     * Precision, Distance of Adjacent Cell in Meters.
-     *
-     * @see https://stackoverflow.com/questions/13836416/geohash-and-max-distance
-     *
-     * @var float
-     */
-    private $precision = array(
-        5003530,
-        625441,
-        123264,
-        19545,
-        3803,
-        610,
-        118,
-        19,
-        3.7,
-        0.6
-    );
+	/**
+	 * spatial index.
+	 *
+	 * @var array
+	 */
+	protected $spatial_idx = array();
+	/**
+	 * Precision, Distance of Adjacent Cell in Meters.
+	 *
+	 * @see https://stackoverflow.com/questions/13836416/geohash-and-max-distance
+	 *
+	 * @var float
+	 */
+	private $precision = array(
+		5003530,
+		625441,
+		123264,
+		19545,
+		3803,
+		610,
+		118,
+		19,
+		3.7,
+		0.6
+	);
 
-    /**
-     * constructor; initialize/load spatial index.
-     */
-    public function __construct() {
-        // parent::__construct ();
-        global $conf;
+	/**
+	 * constructor; initialize/load spatial index.
+	 */
+	public function __construct() {
+		// parent::__construct ();
+		global $conf;
 
-        if(!plugin_load('helper', 'geophp', false, true)) {
-            $message = 'helper_plugin_spatialhelper_search::spatialhelper_search: required geophp plugin is not available.';
-            msg($message, -1);
-        }
+		if(!plugin_load('helper', 'geophp', false, true)) {
+			$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)
-     */
-    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)
+	 */
+	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
-     */
-    public function findNearby(string $geohash, Point $p = null): array {
-        $_geohashClass = new Geohash();
-        if(!$p) {
-            $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
+	 */
+	public function findNearby(string $geohash, Point $p = null): array {
+		$_geohashClass = new Geohash();
+		if(!$p) {
+			$decodedPoint = $_geohashClass->read($geohash);
+		} else {
+			$decodedPoint = $p;
+		}
 
-        // find adjacent blocks
-        $adjacent                 = array();
-        $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');
-        dbglog($adjacent, "adjacent geo hashes:");
+		// find adjacent blocks
+		$adjacent                 = array();
+		$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');
+		dbglog($adjacent, "adjacent geo hashes:");
 
-        // find all the pages in the index that overlap with the adjacent hashes
-        $docIds = array();
-        foreach($adjacent as $adjHash) {
-            if(is_array($this->spatial_idx)) {
-                foreach($this->spatial_idx as $_geohash => $_docIds) {
-                    if(strpos($_geohash, $adjHash) !== false) {
-                        // dbglog ( "Found adjacent geo hash: $adjHash in $_geohash" );
-                        // if $adjHash similar to geohash
-                        $docIds = array_merge($docIds, $_docIds);
-                    }
-                }
-            }
-        }
-        $docIds = array_unique($docIds);
-        dbglog($docIds, "found docIDs");
+		// find all the pages in the index that overlap with the adjacent hashes
+		$docIds = array();
+		foreach($adjacent as $adjHash) {
+			if(is_array($this->spatial_idx)) {
+				foreach($this->spatial_idx as $_geohash => $_docIds) {
+					if(strpos($_geohash, $adjHash) !== false) {
+						// dbglog ( "Found adjacent geo hash: $adjHash in $_geohash" );
+						// if $adjHash similar to geohash
+						$docIds = array_merge($docIds, $_docIds);
+					}
+				}
+			}
+		}
+		$docIds = array_unique($docIds);
+		dbglog($docIds, "found docIDs");
 
-        // create associative array of pages + calculate distance
-        $pages   = array();
-        $media   = array();
-        $indexer = plugin_load('helper', 'spatialhelper_index');
+		// create associative array of pages + calculate distance
+		$pages   = array();
+		$media   = array();
+		$indexer = plugin_load('helper', 'spatialhelper_index');
 
-        foreach($docIds as $id) {
-            if(strpos($id, 'media__', 0) === 0) {
-                $id = substr($id, strlen('media__'));
-                if(auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
-                    $point    = $indexer->getCoordsFromExif($id);
-                    $line     = new LineString(
-                        [
-                            $decodedPoint,
-                            $point
-                        ]
-                    );
-                    $media [] = array(
-                        'id'       => $id,
-                        'distance' => (int) ($line->greatCircleLength()),
-                        'lat'      => $point->y(),
-                        'lon'      => $point->x()
-                        // optionally add other meta such as tag, description...
-                    );
-                }
-            } else {
-                if(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 [] = array(
-                        'id'          => $id,
-                        'distance'    => (int) ($line->greatCircleLength()),
-                        'description' => p_get_metadata($id, 'description')['abstract'],
-                        'lat'         => $geotags ['lat'],
-                        'lon'         => $geotags ['lon']
-                        // optionally add other meta such as tag...
-                    );
-                }
-            }
-        }
+		foreach($docIds as $id) {
+			if(strpos($id, 'media__', 0) === 0) {
+				$id = substr($id, strlen('media__'));
+				if(auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
+					$point    = $indexer->getCoordsFromExif($id);
+					$line     = new LineString(
+						[
+							$decodedPoint,
+							$point
+						]
+					);
+					$media [] = array(
+						'id'       => $id,
+						'distance' => (int) ($line->greatCircleLength()),
+						'lat'      => $point->y(),
+						'lon'      => $point->x()
+						// optionally add other meta such as tag, description...
+					);
+				}
+			} else {
+				if(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 [] = array(
+						'id'          => $id,
+						'distance'    => (int) ($line->greatCircleLength()),
+						'description' => p_get_metadata($id, 'description')['abstract'],
+						'lat'         => $geotags ['lat'],
+						'lon'         => $geotags ['lon']
+						// optionally add other meta such as tag...
+					);
+				}
+			}
+		}
 
-        // sort all the pages/media using distance
-        usort(
-            $pages, static function ($a, $b) {
-            return strnatcmp($a ['distance'], $b ['distance']);
-        }
-        );
-        usort(
-            $media, static function ($a, $b) {
-            return strnatcmp($a ['distance'], $b ['distance']);
-        }
-        );
+		// sort all the pages/media using distance
+		usort(
+			$pages, static function ($a, $b) {
+			return strnatcmp($a ['distance'], $b ['distance']);
+		}
+		);
+		usort(
+			$media, static function ($a, $b) {
+			return strnatcmp($a ['distance'], $b ['distance']);
+		}
+		);
 
-        return array(
-            'pages'     => $pages,
-            'media'     => $media,
-            'lat'       => $decodedPoint->y(),
-            'lon'       => $decodedPoint->x(),
-            'geohash'   => $geohash,
-            'precision' => $this->precision [strlen($geohash)]
-        );
-    }
+		return array(
+			'pages'     => $pages,
+			'media'     => $media,
+			'lat'       => $decodedPoint->y(),
+			'lon'       => $decodedPoint->x(),
+			'geohash'   => $geohash,
+			'precision' => $this->precision [strlen($geohash)]
+		);
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -59,13 +59,13 @@ 
         // parent::__construct ();
         global $conf;
 
-        if(!plugin_load('helper', 'geophp', false, true)) {
+        if (!plugin_load('helper', 'geophp', false, true)) {
             $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')) {
+        if (!@file_exists($idx_dir . '/spatial.idx')) {
             plugin_load('helper', 'spatialhelper_index');
         }
 
@@ -97,7 +97,7 @@ 
      */
     public function findNearby(string $geohash, Point $p = null): array {
         $_geohashClass = new Geohash();
-        if(!$p) {
+        if (!$p) {
             $decodedPoint = $_geohashClass->read($geohash);
         } else {
             $decodedPoint = $p;
@@ -118,10 +118,10 @@ 
 
         // find all the pages in the index that overlap with the adjacent hashes
         $docIds = array();
-        foreach($adjacent as $adjHash) {
-            if(is_array($this->spatial_idx)) {
-                foreach($this->spatial_idx as $_geohash => $_docIds) {
-                    if(strpos($_geohash, $adjHash) !== false) {
+        foreach ($adjacent as $adjHash) {
+            if (is_array($this->spatial_idx)) {
+                foreach ($this->spatial_idx as $_geohash => $_docIds) {
+                    if (strpos($_geohash, $adjHash) !== false) {
                         // dbglog ( "Found adjacent geo hash: $adjHash in $_geohash" );
                         // if $adjHash similar to geohash
                         $docIds = array_merge($docIds, $_docIds);
@@ -137,10 +137,10 @@ 
         $media   = array();
         $indexer = plugin_load('helper', 'spatialhelper_index');
 
-        foreach($docIds as $id) {
-            if(strpos($id, 'media__', 0) === 0) {
+        foreach ($docIds as $id) {
+            if (strpos($id, 'media__', 0) === 0) {
                 $id = substr($id, strlen('media__'));
-                if(auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
+                if (auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
                     $point    = $indexer->getCoordsFromExif($id);
                     $line     = new LineString(
                         [
@@ -150,14 +150,14 @@ 
                     );
                     $media [] = array(
                         'id'       => $id,
-                        'distance' => (int) ($line->greatCircleLength()),
+                        'distance' => ( int ) ($line->greatCircleLength()),
                         'lat'      => $point->y(),
                         'lon'      => $point->x()
                         // optionally add other meta such as tag, description...
                     );
                 }
             } else {
-                if(auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
+                if (auth_quickaclcheck($id) >= /*AUTH_READ*/ 1) {
                     $geotags  = p_get_metadata($id, 'geo');
                     $point    = new Point($geotags ['lon'], $geotags ['lat']);
                     $line     = new LineString(
@@ -168,7 +168,7 @@ 
                     );
                     $pages [] = array(
                         'id'          => $id,
-                        'distance'    => (int) ($line->greatCircleLength()),
+                        'distance'    => ( int ) ($line->greatCircleLength()),
                         'description' => p_get_metadata($id, 'description')['abstract'],
                         'lat'         => $geotags ['lat'],
                         'lon'         => $geotags ['lon']
@@ -180,12 +180,12 @@ 
 
         // sort all the pages/media using distance
         usort(
-            $pages, static function ($a, $b) {
+            $pages, static function($a, $b) {
             return strnatcmp($a ['distance'], $b ['distance']);
         }
         );
         usort(
-            $media, static function ($a, $b) {
+            $media, static function($a, $b) {
             return strnatcmp($a ['distance'], $b ['distance']);
         }
         );

helper/sitemap.php

Indentation +217 added lines, -217 removed lines

@@ -22,221 +22,221 @@
  * @author  Mark Prins
  */
 class helper_plugin_spatialhelper_sitemap extends DokuWiki_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($fn = $idx_dir . '/spatial.idx', false), ['allowed_classes' => false]);
-    }
-
-    final public function getMethods(): array {
-        $result[] = array(
-            'name'   => 'createGeoRSSSitemap',
-            'desc'   => 'create a spatial sitemap in GeoRSS format.',
-            'params' => array(
-                'path' => 'string'
-            ),
-            'return' => array(
-                'success' => 'boolean'
-            )
-        );
-        $result[] = array(
-            'name'   => 'createKMLSitemap',
-            'desc'   => 'create a spatial sitemap in KML format.',
-            'params' => array(
-                'path' => 'string'
-            ),
-            'return' => array(
-                '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) !== 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(isset($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 {
-        dbglog("helper_plugin_spatialhelper_sitemap::skipPage, check for $id 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)) {
-                // dbglog("helper_plugin_spatialhelper_sitemap::skipPage, skipping $id, not in $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) !== 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(isset($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($fn = $idx_dir . '/spatial.idx', false), ['allowed_classes' => false]);
+	}
+
+	final public function getMethods(): array {
+		$result[] = array(
+			'name'   => 'createGeoRSSSitemap',
+			'desc'   => 'create a spatial sitemap in GeoRSS format.',
+			'params' => array(
+				'path' => 'string'
+			),
+			'return' => array(
+				'success' => 'boolean'
+			)
+		);
+		$result[] = array(
+			'name'   => 'createKMLSitemap',
+			'desc'   => 'create a spatial sitemap in KML format.',
+			'params' => array(
+				'path' => 'string'
+			),
+			'return' => array(
+				'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) !== 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(isset($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 {
+		dbglog("helper_plugin_spatialhelper_sitemap::skipPage, check for $id 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)) {
+				// dbglog("helper_plugin_spatialhelper_sitemap::skipPage, skipping $id, not in $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) !== 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(isset($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/index.php

Indentation +255 added lines, -255 removed lines

@@ -24,279 +24,279 @@
  * @author  Mark Prins
  */
 class helper_plugin_spatialhelper_index extends DokuWiki_Plugin {
-    /**
-     * directory for index files.
-     *
-     * @var string
-     */
-    protected $idx_dir = '';
+	/**
+	 * directory for index files.
+	 *
+	 * @var string
+	 */
+	protected $idx_dir = '';
 
-    /**
-     * spatial index, well lookup list/array so we can do spatial queries.
-     * entries should be: array("geohash" => {"id1","id3",})
-     *
-     * @var array
-     */
-    protected $spatial_idx = array();
+	/**
+	 * spatial index, well lookup list/array so we can do spatial queries.
+	 * entries should be: array("geohash" => {"id1","id3",})
+	 *
+	 * @var array
+	 */
+	protected $spatial_idx = array();
 
-    /**
-     * Constructor, initialises the spatial index.
-     */
-    public function __construct() {
-        if(!plugin_load('helper', 'geophp')) {
-            $message = 'helper_plugin_spatialhelper_index::spatialhelper_index: required geophp plugin is not available.';
-            msg($message, -1);
-        }
+	/**
+	 * Constructor, initialises the spatial index.
+	 */
+	public function __construct() {
+		if(!plugin_load('helper', 'geophp')) {
+			$message = 'helper_plugin_spatialhelper_index::spatialhelper_index: 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]);
-            dbglog($this->spatial_idx, 'done loading spatial index');
-        }
-    }
+		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]);
+			dbglog($this->spatial_idx, 'done loading spatial index');
+		}
+	}
 
-    /**
-     * (re-)Generates the spatial index by running through all the pages in the wiki.
-     *
-     * @todo add an option to erase the old index
-     */
-    public function generateSpatialIndex(): bool {
-        global $conf;
-        require_once(DOKU_INC . 'inc/search.php');
-        $pages = array();
-        search($pages, $conf ['datadir'], 'search_allpages', array());
-        foreach($pages as $page) {
-            $this->updateSpatialIndex($page ['id']);
-        }
-        // media
-        $media = array();
-        search($media, $conf ['mediadir'], 'search_media', array());
-        foreach($media as $medium) {
-            if($medium ['isimg']) {
-                $this->indexImage($medium);
-            }
-        }
-        return true;
-    }
+	/**
+	 * (re-)Generates the spatial index by running through all the pages in the wiki.
+	 *
+	 * @todo add an option to erase the old index
+	 */
+	public function generateSpatialIndex(): bool {
+		global $conf;
+		require_once(DOKU_INC . 'inc/search.php');
+		$pages = array();
+		search($pages, $conf ['datadir'], 'search_allpages', array());
+		foreach($pages as $page) {
+			$this->updateSpatialIndex($page ['id']);
+		}
+		// media
+		$media = array();
+		search($media, $conf ['mediadir'], 'search_media', array());
+		foreach($media as $medium) {
+			if($medium ['isimg']) {
+				$this->indexImage($medium);
+			}
+		}
+		return true;
+	}
 
-    /**
-     * Update the spatial index for the page.
-     *
-     * @param string $id
-     *          the document ID
-     * @throws Exception
-     */
-    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;
-        }
-        dbglog($geotags, "Geo metadata found for page $id");
-        $geometry = new Point($geotags ['lon'], $geotags ['lat']);
-        $geohash  = $geometry->out('geohash');
-        dbglog('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
+	 */
+	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;
+		}
+		dbglog($geotags, "Geo metadata found for page $id");
+		$geometry = new Point($geotags ['lon'], $geotags ['lat']);
+		$geohash  = $geometry->out('geohash');
+		dbglog('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 = array();
-        // check index for key/geohash
-        if(!array_key_exists($geohash, $this->spatial_idx)) {
-            dbglog("Geohash $geohash not in index, just add $id.");
-            $pageIds [] = $id;
-        } else {
-            dbglog('Geohash for document is in index, find it.');
-            // check the index for document
-            $knownHashes = $this->findHashesForId($id, $this->spatial_idx);
-            if(empty ($knownHashes)) {
-                dbglog("No index record found for document $id, just add");
-                $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 = array();
+		// check index for key/geohash
+		if(!array_key_exists($geohash, $this->spatial_idx)) {
+			dbglog("Geohash $geohash not in index, just add $id.");
+			$pageIds [] = $id;
+		} else {
+			dbglog('Geohash for document is in index, find it.');
+			// check the index for document
+			$knownHashes = $this->findHashesForId($id, $this->spatial_idx);
+			if(empty ($knownHashes)) {
+				dbglog("No index record found for document $id, just add");
+				$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) {
-                dbglog("Document $id was found in index and has the same geohash, nothing to do.");
-                return true;
-            }
+			if($knownHash === $geohash) {
+				dbglog("Document $id was found in index and has the same geohash, nothing to do.");
+				return true;
+			}
 
-            if(!empty ($knownHash)) {
-                dbglog("Document/media $id was found in index but has different geohash (it moved).");
-                $knownIds = $this->spatial_idx [$knownHash];
-                dbglog($knownIds, "Known id's for this hash:");
-                // remove it from the old geohash element
-                $i = array_search($id, $knownIds);
-                dbglog('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)) {
+				dbglog("Document/media $id was found in index but has different geohash (it moved).");
+				$knownIds = $this->spatial_idx [$knownHash];
+				dbglog($knownIds, "Known id's for this hash:");
+				// remove it from the old geohash element
+				$i = array_search($id, $knownIds);
+				dbglog('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
-     */
-    public function findHashesForId(string $id, array $index): array {
-        $hashes = array();
-        foreach($index as $hash => $docIds) {
-            if(in_array($id, $docIds, false)) {
-                $hashes [] = $hash;
-            }
-        }
-        dbglog($hashes, "Found the following hashes for $id (should only be 1)");
-        return $hashes;
-    }
+	/**
+	 * Looks up the geohash(es) for the document in the index.
+	 *
+	 * @param String $id
+	 *          document ID
+	 * @param array  $index
+	 *          spatial index
+	 */
+	public function findHashesForId(string $id, array $index): array {
+		$hashes = array();
+		foreach($index as $hash => $docIds) {
+			if(in_array($id, $docIds, false)) {
+				$hashes [] = $hash;
+			}
+		}
+		dbglog($hashes, "Found the following hashes for $id (should only be 1)");
+		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 $img
-     *          a Dokuwiki image
-     * @return bool true when image was succesfully 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
-     *
-     */
-    public function indexImage($img): bool {
-        // test for supported files (jpeg only)
-        if(
-            (substr($img ['file'], -strlen('.jpg')) !== '.jpg') &&
-            (substr($img ['file'], -strlen('.jpeg')) !== '.jpeg')) {
-            return false;
-        }
+	/**
+	 * Add an index entry for this file having EXIF / IPTC data.
+	 *
+	 * @param $img
+	 *          a Dokuwiki image
+	 * @return bool true when image was succesfully 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
+	 *
+	 */
+	public function indexImage($img): bool {
+		// test for supported files (jpeg only)
+		if(
+			(substr($img ['file'], -strlen('.jpg')) !== '.jpg') &&
+			(substr($img ['file'], -strlen('.jpeg')) !== '.jpeg')) {
+			return false;
+		}
 
-        $geometry = $this->getCoordsFromExif($img ['id']);
-        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__' . $img ['id']);
-    }
+		$geometry = $this->getCoordsFromExif($img ['id']);
+		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__' . $img ['id']);
+	}
 
-    /**
-     * retrieve GPS decimal coordinates from exif.
-     *
-     * @param string $id
-     * @return Point|false
-     * @throws Exception
-     */
-    public function getCoordsFromExif(string $id) {
-        $exif = exif_read_data(mediaFN($id), 0, true);
-        if(empty ($exif ['GPS'])) {
-            return false;
-        }
+	/**
+	 * retrieve GPS decimal coordinates from exif.
+	 *
+	 * @param string $id
+	 * @return Point|false
+	 * @throws Exception
+	 */
+	public function getCoordsFromExif(string $id) {
+		$exif = exif_read_data(mediaFN($id), 0, true);
+		if(empty ($exif ['GPS'])) {
+			return false;
+		}
 
-        $lat = $this->convertDMStoD(
-            array(
-                $exif ['GPS'] ['GPSLatitude'] [0],
-                $exif ['GPS'] ['GPSLatitude'] [1],
-                $exif ['GPS'] ['GPSLatitude'] [2],
-                $exif ['GPS'] ['GPSLatitudeRef']
-            )
-        );
+		$lat = $this->convertDMStoD(
+			array(
+				$exif ['GPS'] ['GPSLatitude'] [0],
+				$exif ['GPS'] ['GPSLatitude'] [1],
+				$exif ['GPS'] ['GPSLatitude'] [2],
+				$exif ['GPS'] ['GPSLatitudeRef']
+			)
+		);
 
-        $lon = $this->convertDMStoD(
-            array(
-                $exif ['GPS'] ['GPSLongitude'] [0],
-                $exif ['GPS'] ['GPSLongitude'] [1],
-                $exif ['GPS'] ['GPSLongitude'] [2],
-                $exif ['GPS'] ['GPSLongitudeRef']
-            )
-        );
+		$lon = $this->convertDMStoD(
+			array(
+				$exif ['GPS'] ['GPSLongitude'] [0],
+				$exif ['GPS'] ['GPSLongitude'] [1],
+				$exif ['GPS'] ['GPSLongitude'] [2],
+				$exif ['GPS'] ['GPSLongitudeRef']
+			)
+		);
 
-        return new Point($lon, $lat);
-    }
+		return new Point($lon, $lat);
+	}
 
-    /**
-     * convert DegreesMinutesSeconds to Decimal degrees.
-     *
-     * @param array $param array of rational DMS
-     * @return float
-     */
-    public function convertDMStoD(array $param): float {
-        if(!is_array($param)) {
-            $param = array($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);
-    }
+	/**
+	 * convert DegreesMinutesSeconds to Decimal degrees.
+	 *
+	 * @param array $param array of rational DMS
+	 * @return float
+	 */
+	public function convertDMStoD(array $param): float {
+		if(!is_array($param)) {
+			$param = array($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);
+	}
 
-    public function convertRationaltoFloat($param): float {
-        // rational64u
-        $nums = explode('/', $param);
-        if((int) $nums[1] > 0) {
-            return (float) $nums[0] / (int) $nums[1];
-        } else {
-            return (float) $nums[0];
-        }
-    }
+	public function convertRationaltoFloat($param): float {
+		// rational64u
+		$nums = explode('/', $param);
+		if((int) $nums[1] > 0) {
+			return (float) $nums[0] / (int) $nums[1];
+		} else {
+			return (float) $nums[0];
+		}
+	}
 
-    /**
-     * Deletes the page from the index.
-     *
-     * @param string $id document ID
-     */
-    public function deleteFromIndex(string $id): void {
-        // check the index for document
-        $knownHashes = $this->findHashesForId($id, $this->spatial_idx);
-        if(empty ($knownHashes)) {
-            return;
-        }
+	/**
+	 * Deletes the page from the index.
+	 *
+	 * @param string $id document ID
+	 */
+	public function deleteFromIndex(string $id): void {
+		// check the index for document
+		$knownHashes = $this->findHashesForId($id, $this->spatial_idx);
+		if(empty ($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);
-        dbglog("removing: $knownIds[$i] from the index.");
-        unset ($knownIds [$i]);
-        $this->spatial_idx [$knownHash] = $knownIds;
-        if(empty ($this->spatial_idx [$knownHash])) {
-            // dbglog ( "removing key: $knownHash from the index." );
-            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);
+		dbglog("removing: $knownIds[$i] from the index.");
+		unset ($knownIds [$i]);
+		$this->spatial_idx [$knownHash] = $knownIds;
+		if(empty ($this->spatial_idx [$knownHash])) {
+			// dbglog ( "removing key: $knownHash from the index." );
+			unset ($this->spatial_idx [$knownHash]);
+		}
+		$this->saveIndex();
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -43,7 +43,7 @@ 
      * Constructor, initialises the spatial index.
      */
     public function __construct() {
-        if(!plugin_load('helper', 'geophp')) {
+        if (!plugin_load('helper', 'geophp')) {
             $message = 'helper_plugin_spatialhelper_index::spatialhelper_index: required geophp plugin is not available.';
             msg($message, -1);
         }
@@ -51,7 +51,7 @@ 
         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')) {
+        if (!@file_exists($this->idx_dir . '/spatial.idx')) {
             // creates and stores the index
             $this->generateSpatialIndex();
         } else {
@@ -70,14 +70,14 @@ 
         require_once(DOKU_INC . 'inc/search.php');
         $pages = array();
         search($pages, $conf ['datadir'], 'search_allpages', array());
-        foreach($pages as $page) {
+        foreach ($pages as $page) {
             $this->updateSpatialIndex($page ['id']);
         }
         // media
         $media = array();
         search($media, $conf ['mediadir'], 'search_media', array());
-        foreach($media as $medium) {
-            if($medium ['isimg']) {
+        foreach ($media as $medium) {
+            if ($medium ['isimg']) {
                 $this->indexImage($medium);
             }
         }
@@ -93,10 +93,10 @@ 
      */
     public function updateSpatialIndex(string $id): bool {
         $geotags = p_get_metadata($id, 'geo');
-        if(empty ($geotags)) {
+        if (empty ($geotags)) {
             return false;
         }
-        if(empty ($geotags ['lon']) || empty ($geotags ['lat'])) {
+        if (empty ($geotags ['lon']) || empty ($geotags ['lat'])) {
             return false;
         }
         dbglog($geotags, "Geo metadata found for page $id");
@@ -117,14 +117,14 @@ 
     private function addToIndex(string $geohash, string $id): bool {
         $pageIds = array();
         // check index for key/geohash
-        if(!array_key_exists($geohash, $this->spatial_idx)) {
+        if (!array_key_exists($geohash, $this->spatial_idx)) {
             dbglog("Geohash $geohash not in index, just add $id.");
             $pageIds [] = $id;
         } else {
             dbglog('Geohash for document is in index, find it.');
             // check the index for document
             $knownHashes = $this->findHashesForId($id, $this->spatial_idx);
-            if(empty ($knownHashes)) {
+            if (empty ($knownHashes)) {
                 dbglog("No index record found for document $id, just add");
                 $pageIds    = $this->spatial_idx [$geohash];
                 $pageIds [] = $id;
@@ -132,12 +132,12 @@ 
             // TODO shortcut, need to make sure there is only one element, if not the index is corrupt
             $knownHash = $knownHashes [0];
 
-            if($knownHash === $geohash) {
+            if ($knownHash === $geohash) {
                 dbglog("Document $id was found in index and has the same geohash, nothing to do.");
                 return true;
             }
 
-            if(!empty ($knownHash)) {
+            if (!empty ($knownHash)) {
                 dbglog("Document/media $id was found in index but has different geohash (it moved).");
                 $knownIds = $this->spatial_idx [$knownHash];
                 dbglog($knownIds, "Known id's for this hash:");
@@ -166,8 +166,8 @@ 
      */
     public function findHashesForId(string $id, array $index): array {
         $hashes = array();
-        foreach($index as $hash => $docIds) {
-            if(in_array($id, $docIds, false)) {
+        foreach ($index as $hash => $docIds) {
+            if (in_array($id, $docIds, false)) {
                 $hashes [] = $hash;
             }
         }
@@ -195,14 +195,14 @@ 
      */
     public function indexImage($img): bool {
         // test for supported files (jpeg only)
-        if(
+        if (
             (substr($img ['file'], -strlen('.jpg')) !== '.jpg') &&
             (substr($img ['file'], -strlen('.jpeg')) !== '.jpeg')) {
             return false;
         }
 
         $geometry = $this->getCoordsFromExif($img ['id']);
-        if(!$geometry) {
+        if (!$geometry) {
             return false;
         }
         $geohash = $geometry->out('geohash');
@@ -221,7 +221,7 @@ 
      */
     public function getCoordsFromExif(string $id) {
         $exif = exif_read_data(mediaFN($id), 0, true);
-        if(empty ($exif ['GPS'])) {
+        if (empty ($exif ['GPS'])) {
             return false;
         }
 
@@ -253,7 +253,7 @@ 
      * @return float
      */
     public function convertDMStoD(array $param): float {
-        if(!is_array($param)) {
+        if (!is_array($param)) {
             $param = array($param);
         }
         $deg = $this->convertRationaltoFloat($param [0]);
@@ -267,10 +267,10 @@ 
     public function convertRationaltoFloat($param): float {
         // 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];
         } else {
-            return (float) $nums[0];
+            return ( float ) $nums[0];
         }
     }
 
@@ -282,7 +282,7 @@ 
     public function deleteFromIndex(string $id): void {
         // check the index for document
         $knownHashes = $this->findHashesForId($id, $this->spatial_idx);
-        if(empty ($knownHashes)) {
+        if (empty ($knownHashes)) {
             return;
         }
 
@@ -293,7 +293,7 @@ 
         dbglog("removing: $knownIds[$i] from the index.");
         unset ($knownIds [$i]);
         $this->spatial_idx [$knownHash] = $knownIds;
-        if(empty ($this->spatial_idx [$knownHash])) {
+        if (empty ($this->spatial_idx [$knownHash])) {
             // dbglog ( "removing key: $knownHash from the index." );
             unset ($this->spatial_idx [$knownHash]);
         }