mprins / dokuwiki-plugin-spatialhelper

syntax/findnearby.php

Indentation +85 added lines, -85 removed lines

@@ -22,95 +22,95 @@
  * @author  Mark C. Prins <mprins@users.sf.net>
  */
 class syntax_plugin_spatialhelper_findnearby extends DokuWiki_Syntax_Plugin {
-    /**
-     *
-     * @see DokuWiki_Syntax_Plugin::getType()
-     */
-    public function getType(): string {
-        return 'substition';
-    }
+	/**
+	 *
+	 * @see DokuWiki_Syntax_Plugin::getType()
+	 */
+	public function getType(): string {
+		return 'substition';
+	}
 
-    /**
-     * Return 'normal' so this syntax can be rendered inline.
-     *
-     * @see DokuWiki_Syntax_Plugin::getPType()
-     */
-    public function getPType(): string {
-        return 'normal';
-    }
+	/**
+	 * Return 'normal' so this syntax can be rendered inline.
+	 *
+	 * @see DokuWiki_Syntax_Plugin::getPType()
+	 */
+	public function getPType(): string {
+		return 'normal';
+	}
 
-    /**
-     *
-     * @see Doku_Parser_Mode::getSort()
-     */
-    public function getSort(): int {
-        return 307;
-    }
+	/**
+	 *
+	 * @see Doku_Parser_Mode::getSort()
+	 */
+	public function getSort(): int {
+		return 307;
+	}
 
-    /**
-     * define our special pattern: {{findnearby>Some linkt text or nothing}}.
-     *
-     * @see Doku_Parser_Mode::connectTo()
-     */
-    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()
+	 */
+	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()
-     */
-    public function handle($match, $state, $pos, Doku_Handler $handler) {
-        $data     = array();
-        $data [0] = trim(substr($match, strlen('{{findnearby>'), -2));
-        if(strlen($data [0]) < 1) {
-            $data [0] = $this->getLang('search_findnearby');
-        }
-        $meta = p_get_metadata(getID(), 'geo');
-        if($meta) {
-            if($meta ['lat'] && $meta ['lon']) {
-                $data [1] = array(
-                    'do'  => 'findnearby',
-                    'lat' => $meta ['lat'],
-                    'lon' => $meta ['lon']
-                );
-            } elseif($meta ['geohash']) {
-                $data [1] = array(
-                    '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()
+	 */
+	public function handle($match, $state, $pos, Doku_Handler $handler) {
+		$data     = array();
+		$data [0] = trim(substr($match, strlen('{{findnearby>'), -2));
+		if(strlen($data [0]) < 1) {
+			$data [0] = $this->getLang('search_findnearby');
+		}
+		$meta = p_get_metadata(getID(), 'geo');
+		if($meta) {
+			if($meta ['lat'] && $meta ['lon']) {
+				$data [1] = array(
+					'do'  => 'findnearby',
+					'lat' => $meta ['lat'],
+					'lon' => $meta ['lon']
+				);
+			} elseif($meta ['geohash']) {
+				$data [1] = array(
+					'do'      => 'findnearby',
+					'geohash' => $meta ['geohash']
+				);
+			}
+			return $data;
+		}
+		return false;
+	}
 
-    /**
-     * Render a link to a search page.
-     *
-     * @see DokuWiki_Syntax_Plugin::render()
-     */
-    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()
+	 */
+	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 +8 added lines, -8 removed lines

@@ -70,18 +70,18 @@ 
     public function handle($match, $state, $pos, Doku_Handler $handler) {
         $data     = array();
         $data [0] = trim(substr($match, strlen('{{findnearby>'), -2));
-        if(strlen($data [0]) < 1) {
+        if (strlen($data [0]) < 1) {
             $data [0] = $this->getLang('search_findnearby');
         }
         $meta = p_get_metadata(getID(), 'geo');
-        if($meta) {
-            if($meta ['lat'] && $meta ['lon']) {
+        if ($meta) {
+            if ($meta ['lat'] && $meta ['lon']) {
                 $data [1] = array(
                     'do'  => 'findnearby',
                     'lat' => $meta ['lat'],
                     'lon' => $meta ['lon']
                 );
-            } elseif($meta ['geohash']) {
+            } elseif ($meta ['geohash']) {
                 $data [1] = array(
                     'do'      => 'findnearby',
                     'geohash' => $meta ['geohash']
@@ -98,16 +98,16 @@ 
      * @see DokuWiki_Syntax_Plugin::render()
      */
     public function render($format, Doku_Renderer $renderer, $data): bool {
-        if($data === false) {
+        if ($data === false) {
             return false;
         }
 
-        if($format === 'xhtml') {
+        if ($format === 'xhtml') {
             $renderer->doc .= '<a href="' . wl(getID(), $data [1]) . '" class="findnearby">' . hsc($data [0]) . '</a>';
             return true;
-        } elseif($format === 'metadata') {
+        } elseif ($format === 'metadata') {
             return false;
-        } elseif($format === 'odt') {
+        } elseif ($format === 'odt') {
             // don't render anything in ODT
             return false;
         }

_test/index.test.php

Indentation +43 added lines, -43 removed lines

@@ -13,47 +13,47 @@
  */
 class index_test extends DokuWikiTest {
 
-    protected $pluginsEnabled = array('spatialhelper');
-
-    /**
-     * Testdata for @return array
-     * @see index_test::test_convertDMStoD
-     *
-     */
-    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'
-            ),
-        );
-    }
-
-    /**
-     * @dataProvider convertDMStoDTestdata
-     */
-    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);
-    }
+	protected $pluginsEnabled = array('spatialhelper');
+
+	/**
+	 * Testdata for @return array
+	 * @see index_test::test_convertDMStoD
+	 *
+	 */
+	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'
+			),
+		);
+	}
+
+	/**
+	 * @dataProvider convertDMStoDTestdata
+	 */
+	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);
+	}
 }

_test/general.test.php

Indentation +30 added lines, -30 removed lines

@@ -23,39 +23,39 @@
  */
 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.
-     */
-    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.
+	 */
+	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::assertTrue(false !== 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::assertTrue(false !== strtotime($info['date']));
+	}
 
-    /**
-     * test if plugin is loaded.
-     */
-    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.
+	 */
+	public function test_plugin_spatialhelper_isloaded(): void {
+		global $plugin_controller;
+		self::assertContains(
+			'spatialhelper', $plugin_controller->getList(), "spatialhelper plugin is loaded"
+		);
+	}
 }

admin/purge.php

Indentation +53 added lines, -53 removed lines

@@ -23,64 +23,64 @@
  */
 class admin_plugin_spatialhelper_purge extends DokuWiki_Admin_Plugin {
 
-    /**
-     *
-     * @see DokuWiki_Admin_Plugin::getMenuSort()
-     */
-    public function getMenuSort(): int {
-        return 801;
-    }
+	/**
+	 *
+	 * @see DokuWiki_Admin_Plugin::getMenuSort()
+	 */
+	public function getMenuSort(): int {
+		return 801;
+	}
 
-    public function getMenuIcon(): string {
-        $plugin = $this->getPluginName();
-        return DOKU_PLUGIN . $plugin . '/admin/purge.svg';
-    }
+	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()
-     */
-    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()
+	 */
+	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');
-        $indexer->generateSpatialIndex();
+		$indexer = plugin_load('helper', 'spatialhelper_index');
+		$indexer->generateSpatialIndex();
 
-        $sitemapper = plugin_load('helper', 'spatialhelper_sitemap');
-        $sitemapper->createKMLSitemap($this->getConf('media_kml'));
-        $sitemapper->createGeoRSSSitemap($this->getConf('media_georss'));
-    }
+		$sitemapper = plugin_load('helper', 'spatialhelper_sitemap');
+		$sitemapper->createKMLSitemap($this->getConf('media_kml'));
+		$sitemapper->createGeoRSSSitemap($this->getConf('media_georss'));
+	}
 
-    /**
-     * render the form for this plugin.
-     *
-     * @see DokuWiki_Admin_Plugin::html()
-     */
-    public function html(): void {
-        echo $this->locale_xhtml('admin_purge_intro');
+	/**
+	 * render the form for this plugin.
+	 *
+	 * @see DokuWiki_Admin_Plugin::html()
+	 */
+	public function html(): void {
+		echo $this->locale_xhtml('admin_purge_intro');
 
-        $form = new Doku_Form(
-            array(
-                'id'     => 'spatialhelper__purgeform',
-                'method' => 'post'
-            )
-        );
-        $form->addHidden('purgeindex', 'true');
+		$form = new Doku_Form(
+			array(
+				'id'     => 'spatialhelper__purgeform',
+				'method' => 'post'
+			)
+		);
+		$form->addHidden('purgeindex', 'true');
 
-        $form->addElement(
-            form_makeButton(
-                'submit', 'admin', $this->getLang('admin_submit'), array(
-                            'title' => $this->getLang('admin_submit')
-                        )
-            )
-        );
-        $form->printForm();
-    }
+		$form->addElement(
+			form_makeButton(
+				'submit', 'admin', $this->getLang('admin_submit'), array(
+							'title' => $this->getLang('admin_submit')
+						)
+			)
+		);
+		$form->printForm();
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -42,10 +42,10 @@
      * @see DokuWiki_Admin_Plugin::handle()
      */
     public function handle(): void {
-        if(isset ($_REQUEST ['purgeindex'])) {
+        if (isset ($_REQUEST ['purgeindex'])) {
             global $conf;
             $path = $conf ['indexdir'] . '/spatial.idx';
-            if(file_exists($path) && unlink($path)) {
+            if (file_exists($path) && unlink($path)) {
                 msg($this->getLang('admin_purged_tiles'), 0);
             }
         }

helper/index.php

Indentation +258 added lines, -258 removed lines

@@ -24,282 +24,282 @@
  * @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 {
@@ -73,14 +73,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);
             }
         }
@@ -96,10 +96,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");
@@ -120,14 +120,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;
@@ -135,12 +135,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:");
@@ -169,8 +169,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;
             }
         }
@@ -198,14 +198,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');
@@ -224,7 +224,7 @@ 
      */
     public function getCoordsFromExif(string $id) {
         $exif = exif_read_data(mediaFN($id), 0, true);
-        if(empty ($exif ['GPS'])) {
+        if (empty ($exif ['GPS'])) {
             return false;
         }
 
@@ -256,7 +256,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]);
@@ -270,10 +270,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];
         }
     }
 
@@ -285,7 +285,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;
         }
 
@@ -296,7 +296,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]);
         }

helper/search.php

Indentation +162 added lines, -162 removed lines

@@ -26,178 +26,178 @@
  * @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,14 +59,14 @@ 
         // 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');
         }
 
@@ -98,7 +98,7 @@ 
      */
     public function findNearby(string $geohash, Point $p = null): array {
         $_geohashClass = new Geohash();
-        if(!$p) {
+        if (!$p) {
             $decodedPoint = $_geohashClass->read($geohash);
         } else {
             $decodedPoint = $p;
@@ -119,10 +119,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);
@@ -138,10 +138,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(
                         [
@@ -151,14 +151,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(
@@ -169,7 +169,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']
@@ -181,12 +181,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 +220 added lines, -220 removed lines

@@ -22,224 +22,224 @@
  * @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(!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 {
-        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(!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($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(!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 {
+		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(!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);
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -33,9 +33,9 @@ 
     public function __construct() {
         global $conf;
         $idx_dir = $conf['indexdir'];
-        if(!@file_exists($idx_dir . '/spatial.idx')) {
+        if (!@file_exists($idx_dir . '/spatial.idx')) {
             $indexer = plugin_load('helper', 'spatialhelper_index');
-            if($indexer !== null) {
+            if ($indexer !== null) {
                 $indexer->generateSpatialIndex();
             }
         }
@@ -85,7 +85,7 @@ 
         $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'])) {
+        if (!empty($conf['tagline'])) {
             $RSSstart .= '<subtitle>' . $conf['tagline'] . '</subtitle>' . DOKU_LF;
         }
         $RSSstart .= '<dc:publisher>' . $conf['title'] . '</dc:publisher>' . DOKU_LF;
@@ -104,12 +104,12 @@ 
         $fh = fopen(mediaFN($mediaID), 'wb');
         fwrite($fh, $RSSstart);
 
-        foreach($this->spatial_idx as $idxEntry) {
+        foreach ($this->spatial_idx as $idxEntry) {
             // get list of id's
-            foreach($idxEntry as $id) {
+            foreach ($idxEntry as $id) {
                 // for document item in the index
-                if(strpos($id, 'media__', 0) !== 0) {
-                    if($this->skipPage($id, $namespace)) {
+                if (strpos($id, 'media__', 0) !== 0) {
+                    if ($this->skipPage($id, $namespace)) {
                         continue;
                     }
 
@@ -123,11 +123,11 @@ 
                     $entry .= '  <summary>' . $desc . '</summary>' . DOKU_LF;
                     $entry .= '  <georss:point>' . $meta['geo']['lat'] . ' ' . $meta['geo']['lon']
                         . '</georss:point>' . DOKU_LF;
-                    if(!empty($meta['geo']['alt'])) {
+                    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'])) {
+                    if (empty($meta['creator'])) {
                         $meta['creator'] = $conf['title'];
                     }
                     $entry .= '  <author><name>' . $meta['creator'] . '</name></author>' . DOKU_LF;
@@ -150,16 +150,16 @@ 
      */
     private function skipPage(string $id, string $namespace): bool {
         dbglog("helper_plugin_spatialhelper_sitemap::skipPage, check for $id in $namespace");
-        if(isHiddenPage($id)) {
+        if (isHiddenPage($id)) {
             return true;
         }
-        if(auth_aclcheck($id, '', null) < AUTH_READ) {
+        if (auth_aclcheck($id, '', null) < AUTH_READ) {
             return true;
         }
 
-        if(!empty($namespace)) {
+        if (!empty($namespace)) {
             // only if id is in or below namespace
-            if(0 !== strpos(getNS($id), $namespace)) {
+            if (0 !== strpos(getNS($id), $namespace)) {
                 // dbglog("helper_plugin_spatialhelper_sitemap::skipPage, skipping $id, not in $namespace");
                 return true;
             }
@@ -199,12 +199,12 @@ 
         $fh = fopen(mediaFN($mediaID), 'wb');
         fwrite($fh, $KMLstart);
 
-        foreach($this->spatial_idx as $idxEntry) {
+        foreach ($this->spatial_idx as $idxEntry) {
             // get list of id's
-            foreach($idxEntry as $id) {
+            foreach ($idxEntry as $id) {
                 // for document item in the index
-                if(strpos($id, 'media__', 0) !== 0) {
-                    if($this->skipPage($id, $namespace)) {
+                if (strpos($id, 'media__', 0) !== 0) {
+                    if ($this->skipPage($id, $namespace)) {
                         continue;
                     }
 
@@ -220,7 +220,7 @@ 
                     // 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'])) {
+                    if (!empty($meta['creator'])) {
                         $plcm .= '  <atom:author><atom:name>' . $meta['creator'] . '</atom:name></atom:author>'
                             . DOKU_LF;
                     }
@@ -229,7 +229,7 @@ 
                     $plcm .= '  <styleUrl>#icon</styleUrl>' . DOKU_LF;
 
                     $plcm .= '  <Point><coordinates>' . $meta['geo']['lon'] . ',' . $meta['geo']['lat'];
-                    if(!empty($meta['geo']['alt'])) {
+                    if (!empty($meta['geo']['alt'])) {
                         $plcm .= ',' . $meta['geo']['alt'];
                     }
                     $plcm .= '</coordinates></Point>' . DOKU_LF;

action.php

Spacing +28 added lines, -28 removed lines

@@ -102,18 +102,18 @@ 
         // $data[3] – rev: The page revision, false for current wiki pages.
 
         dbglog($event->data, "Event data in removeFromIndex.");
-        if(@file_exists($event->data [0] [0])) {
+        if (@file_exists($event->data [0] [0])) {
             // file not new
-            if(!$event->data [0] [1]) {
+            if (!$event->data [0] [1]) {
                 // file is empty, page is being deleted
-                if(empty ($event->data [1])) {
+                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) {
+                if ($indexer) {
                     $indexer->deleteFromIndex($id);
                 }
             }
@@ -146,15 +146,15 @@ 
         // $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')) {
+        if ($helper = plugin_load('helper', 'spatialhelper_sitemap')) {
             // dbglog($helper, "createSpatialSitemap loaded helper.");
 
             $kml = $helper->createKMLSitemap($this->getConf('media_kml'));
             $rss = $helper->createGeoRSSSitemap($this->getConf('media_georss'));
 
-            if(!empty ($this->getConf('sitemap_namespaces'))) {
+            if (!empty ($this->getConf('sitemap_namespaces'))) {
                 $namespaces = array_map('trim', explode("\n", $this->getConf('sitemap_namespaces')));
-                foreach($namespaces as $namespace) {
+                foreach ($namespaces as $namespace) {
                     $kmlN = $helper->createKMLSitemap($namespace . $this->getConf('media_kml'));
                     $rssN = $helper->createGeoRSSSitemap($namespace . $this->getConf('media_georss'));
                     dbglog(
@@ -179,7 +179,7 @@ 
      *          not used
      */
     public function handleActionActPreprocess(Doku_Event $event, $param): void {
-        if($event->data !== 'findnearby') {
+        if ($event->data !== 'findnearby') {
             return;
         }
         $event->preventDefault();
@@ -195,16 +195,16 @@ 
      *          'format'=> HTML | JSON
      */
     public function findnearby(Doku_Event $event, $param): void {
-        if($event->data !== 'findnearby') {
+        if ($event->data !== 'findnearby') {
             return;
         }
         $event->preventDefault();
         $results = array();
         global $INPUT;
-        if($helper = plugin_load('helper', 'spatialhelper_search')) {
-            if($INPUT->has('lat') && $INPUT->has('lon')) {
+        if ($helper = plugin_load('helper', 'spatialhelper_search')) {
+            if ($INPUT->has('lat') && $INPUT->has('lon')) {
                 $results = $helper->findNearbyLatLon($INPUT->param('lat'), $INPUT->param('lon'));
-            } elseif($INPUT->has('geohash')) {
+            } elseif ($INPUT->has('geohash')) {
                 $results = $helper->findNearby($INPUT->str('geohash'));
             } else {
                 $results = array(
@@ -215,7 +215,7 @@ 
 
         $showMedia = $INPUT->bool('showMedia', true);
 
-        switch($param['format']) {
+        switch ($param['format']) {
             case 'JSON' :
                 $this->printJSON($results);
                 break;
@@ -246,13 +246,13 @@ 
      * @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'];
+        $pages   = ( array ) ($searchresults ['pages']);
+        $media   = ( array ) $searchresults ['media'];
+        $lat     = ( float ) $searchresults ['lat'];
+        $lon     = ( float ) $searchresults ['lon'];
+        $geohash = ( string ) $searchresults ['geohash'];
 
-        if(isset ($searchresults ['error'])) {
+        if (isset ($searchresults ['error'])) {
             print '<div class="level1"><p>' . hsc($searchresults ['error']) . '</p></div>';
             return;
         }
@@ -260,9 +260,9 @@ 
         // print a HTML list
         print '<h1>' . $this->getLang('results_header') . '</h1>' . DOKU_LF;
         print '<div class="level1">' . DOKU_LF;
-        if(!empty ($pages)) {
+        if (!empty ($pages)) {
             $pagelist = '<ol>' . DOKU_LF;
-            foreach($pages as $page) {
+            foreach ($pages as $page) {
                 $pagelist .= '<li>' . html_wikilink(
                         ':' . $page ['id'], useHeading('navigation') ? null :
                         noNS($page ['id'])
@@ -282,14 +282,14 @@ 
             print '<p>' . hsc($this->getLang('nothingfound')) . '</p>';
         }
 
-        if(!empty ($media) && $showMedia) {
+        if (!empty ($media) && $showMedia) {
             $pagelist = '<ol>' . DOKU_LF;
-            foreach($media as $m) {
+            foreach ($media as $m) {
                 $opts       = array();
                 $link       = ml($m ['id'], $opts, false, '&amp;', false);
                 $opts ['w'] = '100';
                 $src        = ml($m ['id'], $opts);
-                $pagelist   .= '<li><a href="' . $link . '"><img src="' . $src . '"></a> ('
+                $pagelist .= '<li><a href="' . $link . '"><img src="' . $src . '"></a> ('
                     . $this->getLang('results_distance_prefix') . $page ['distance'] . '&nbsp;m) ' . hsc($desc)
                     . '</li>' . DOKU_LF;
             }
@@ -304,7 +304,7 @@ 
             print '</div>' . DOKU_LF;
         }
         print '<p>' . $this->getLang('results_precision') . $searchresults ['precision'] . ' m. ';
-        if(strlen($geohash) > 1) {
+        if (strlen($geohash) > 1) {
             $url = wl(
                 getID(), array(
                            'do'      => 'findnearby',
@@ -335,9 +335,9 @@ 
 
         // check the list of mimetypes
         // if it's a supported type call appropriate index function
-        if(substr_compare($event->data [3], 'image/jpeg', 0)) {
+        if (substr_compare($event->data [3], 'image/jpeg', 0)) {
             $indexer = plugin_load('helper', 'spatialhelper_index');
-            if($indexer) {
+            if ($indexer) {
                 $indexer->indexImage($event->data [2]);
             }
         }
@@ -358,7 +358,7 @@ 
 
         // remove the media id from the index
         $indexer = plugin_load('helper', 'spatialhelper_index');
-        if($indexer) {
+        if ($indexer) {
             $indexer->deleteFromIndex('media__' . $event->data ['id']);
         }
     }

Indentation +412 added lines, -412 removed lines

@@ -25,416 +25,416 @@
  */
 class action_plugin_spatialhelper extends DokuWiki_Action_Plugin {
 
-    /**
-     * Register for events.
-     *
-     * @param Doku_Event_Handler $controller
-     *          DokuWiki's event controller object. Also available as global $EVENT_HANDLER
-     */
-    public function register(Doku_Event_Handler $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');
-
-        // handle actions we know of
-        $controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handleActionActPreprocess', array());
-        // handle HTML eg. /dokuwiki/doku.php?id=start&do=findnearby&geohash=u15vk4
-        $controller->register_hook(
-            'TPL_ACT_UNKNOWN', 'BEFORE', $this, 'findnearby', array(
-                                 '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', array(
-                                   'format' => 'JSON'
-                               )
-        );
-
-        // listen for media uploads and deletes
-        $controller->register_hook('MEDIA_UPLOAD_FINISH', 'BEFORE', $this, 'handleMediaUploaded', array());
-        $controller->register_hook('MEDIA_DELETE_FILE', 'BEFORE', $this, 'handleMediaDeleted', array());
-
-        $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 Doku_Event $event
-     *          event object
-     * @param mixed      $param
-     *          the parameters passed to register_hook when this handler was registered
-     */
-    public function handleIndexerPageAdd(Doku_Event $event, $param): 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');
-        $entries = $indexer->updateSpatialIndex($id);
-    }
-
-    /**
-     * Update the spatial index, removing the page.
-     *
-     * @param Doku_Event $event
-     *          event object
-     * @param mixed      $param
-     *          the parameters passed to register_hook when this handler was registered
-     */
-    public function removeFromIndex(Doku_Event $event, $param): 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.
-
-        dbglog($event->data, "Event data in removeFromIndex.");
-        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) {
-                    $indexer->deleteFromIndex($id);
-                }
-            }
-        }
-    }
-
-    /**
-     * Add a new SitemapItem object that points to the KML of public geocoded pages.
-     *
-     * @param Doku_Event $event
-     * @param mixed      $param
-     */
-    public function handleSitemapGenerateBefore(Doku_Event $event, $param): void {
-        $path                     = mediaFN($this->getConf('media_kml'));
-        $lastmod                  = @filemtime($path);
-        $event->data ['items'] [] = new Item(ml($this->getConf('media_kml'), '', true, '&', true), $lastmod);
-        //dbglog($event->data ['items'],
-        //  "Added a new SitemapItem object that points to the KML of public geocoded pages.");
-    }
-
-    /**
-     * Create a spatial sitemap or attach the geo/kml map to the sitemap.
-     *
-     * @param Doku_Event $event
-     *          event object, not used
-     * @param mixed      $param
-     *          parameter array, not used
-     */
-    public function handleSitemapGenerateAfter(Doku_Event $event, $param): 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')) {
-            // dbglog($helper, "createSpatialSitemap loaded helper.");
-
-            $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'));
-                    dbglog(
-                        $kmlN && $rssN,
-                        "handleSitemapGenerateAfter, created KML / GeoRSS sitemap in $namespace, succes: "
-                    );
-                }
-            }
-            return $kml && $rss;
-        } else {
-            dbglog($helper, "createSpatialSitemap NOT loaded helper.");
-        }
-    }
-
-    /**
-     * trap findnearby action.
-     * This addional handler is required as described at: https://www.dokuwiki.org/devel:event:tpl_act_unknown
-     *
-     * @param Doku_Event $event
-     *          event object
-     * @param mixed      $param
-     *          not used
-     */
-    public function handleActionActPreprocess(Doku_Event $event, $param): void {
-        if($event->data !== 'findnearby') {
-            return;
-        }
-        $event->preventDefault();
-    }
-
-    /**
-     * handle findnearby action.
-     *
-     * @param Doku_Event $event
-     *          event object
-     * @param mixed      $param
-     *          associative array with keys
-     *          'format'=> HTML | JSON
-     */
-    public function findnearby(Doku_Event $event, $param): void {
-        if($event->data !== 'findnearby') {
-            return;
-        }
-        $event->preventDefault();
-        $results = array();
-        global $INPUT;
-        if($helper = plugin_load('helper', 'spatialhelper_search')) {
-            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 = array(
-                    'error' => hsc($this->getLang('invalidinput'))
-                );
-            }
-        }
-
-        $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;
-        }
-    }
-
-    /**
-     * Print seachresults as HTML lists.
-     *
-     * @param array $searchresults
-     */
-    private function printJSON(array $searchresults): void {
-        require_once DOKU_INC . 'inc/JSON.php';
-        $json = new JSON();
-        header('Content-Type: application/json');
-        print $json->encode($searchresults);
-    }
-
-    /**
-     * 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'])) {
-            print '<div class="level1"><p>' . hsc($searchresults ['error']) . '</p></div>';
-            return;
-        }
-
-        // print a HTML list
-        print '<h1>' . $this->getLang('results_header') . '</h1>' . DOKU_LF;
-        print '<div class="level1">' . DOKU_LF;
-        if(!empty ($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 '<h2>' . $this->getLang('results_pages') . hsc(
-                    ' lat;lon: ' . $lat . ';' . $lon
-                    . ' (geohash: ' . $geohash . ')'
-                ) . '</h2>';
-            print '<div class="level2">' . DOKU_LF;
-            print $pagelist;
-            print '</div>' . DOKU_LF;
-        } else {
-            print '<p>' . hsc($this->getLang('nothingfound')) . '</p>';
-        }
-
-        if(!empty ($media) && $showMedia) {
-            $pagelist = '<ol>' . DOKU_LF;
-            foreach($media as $m) {
-                $opts       = array();
-                $link       = ml($m ['id'], $opts, false, '&amp;', false);
-                $opts ['w'] = '100';
-                $src        = ml($m ['id'], $opts);
-                $pagelist   .= '<li><a href="' . $link . '"><img src="' . $src . '"></a> ('
-                    . $this->getLang('results_distance_prefix') . $page ['distance'] . '&nbsp;m) ' . hsc($desc)
-                    . '</li>' . DOKU_LF;
-            }
-            $pagelist .= '</ol>' . DOKU_LF;
-
-            print '<h2>' . $this->getLang('results_media') . hsc(
-                    ' lat;lon: ' . $lat . ';' . $lon
-                    . ' (geohash: ' . $geohash . ')'
-                ) . '</h2>' . DOKU_LF;
-            print '<div class="level2">' . DOKU_LF;
-            print $pagelist;
-            print '</div>' . DOKU_LF;
-        }
-        print '<p>' . $this->getLang('results_precision') . $searchresults ['precision'] . ' m. ';
-        if(strlen($geohash) > 1) {
-            $url = wl(
-                getID(), array(
-                           'do'      => 'findnearby',
-                           'geohash' => substr($geohash, 0, -1)
-                       )
-            );
-            print '<a href="' . $url . '" class="findnearby">' . $this->getLang('search_largerarea') . '</a>.</p>'
-                . DOKU_LF;
-        }
-        print '</div>' . DOKU_LF;
-    }
-
-    /**
-     * add media to spatial index.
-     *
-     * @param Doku_Event $event
-     * @param mixed      $param
-     */
-    public function handleMediaUploaded(Doku_Event $event, $param): void {
-        // data[0] temporary file name (read from $_FILES)
-        // 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
-
-        dbglog($event->data, "handleMediaUploaded::event data");
-
-        // check the list of mimetypes
-        // if it's a supported type call appropriate index function
-        if(substr_compare($event->data [3], 'image/jpeg', 0)) {
-            $indexer = plugin_load('helper', 'spatialhelper_index');
-            if($indexer) {
-                $indexer->indexImage($event->data [2]);
-            }
-        }
-        // TODO add image/tiff
-        // TODO kml, gpx, geojson...
-    }
-
-    /**
-     * removes the media from the index.
-     */
-    public function handleMediaDeleted(Doku_Event $event, $param): 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
-
-        dbglog($event->data, "handleMediaDeleted::event data");
-
-        // remove the media id from the index
-        $indexer = plugin_load('helper', 'spatialhelper_index');
-        if($indexer) {
-            $indexer->deleteFromIndex('media__' . $event->data ['id']);
-        }
-    }
-
-    /**
-     * add a link to the spatial sitemap files in the header.
-     *
-     * @param Doku_Event $event
-     *          the DokuWiki event. $event->data is a two-dimensional
-     *          array of all meta headers. The keys are meta, link and script.
-     * @param mixed      $param
-     *
-     * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
-     */
-    public function handleMetaheaderOutput(Doku_Event $event, $param): void {
-        // TODO maybe test for exist
-        $event->data ["link"] [] = array(
-            "type"  => "application/atom+xml",
-            "rel"   => "alternate",
-            "href"  => ml($this->getConf('media_georss')),
-            "title" => "Spatial ATOM Feed"
-        );
-        $event->data ["link"] [] = array(
-            "type"  => "application/vnd.google-earth.kml+xml",
-            "rel"   => "alternate",
-            "href"  => ml($this->getConf('media_kml')),
-            "title" => "KML Sitemap"
-        );
-    }
-
-    /**
-     * Add spatialhelper popularity data.
-     *
-     * @param Doku_Event $event
-     *          the DokuWiki event
-     */
-    final public function popularity(Doku_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'];
-    }
-
-    /**
-     * Calculate a new coordinate based on start, distance and bearing
-     *
-     * @param $start array
-     *               - start coordinate as decimal lat/lon pair
-     * @param $dist  float
-     *               - distance in kilometers
-     * @param $brng  float
-     *               - bearing in degrees (compass direction)
-     */
-    private function geoDestination(array $start, float $dist, float $brng): array {
-        $lat1 = $this->toRad($start [0]);
-        $lon1 = $this->toRad($start [1]);
-        // http://en.wikipedia.org/wiki/Earth_radius
-        // average earth radius in km
-        $dist = $dist / 6371.01;
-        $brng = $this->toRad($brng);
-
-        $lon2 = $lon1 + atan2(sin($brng) * sin($dist) * cos($lat1), cos($dist) - sin($lat1) * sin($lat2));
-        $lon2 = fmod(($lon2 + 3 * M_PI), (2 * M_PI)) - M_PI;
-
-        return array(
-            $this->toDeg($lat2),
-            $this->toDeg($lon2)
-        );
-    }
-
-    private function toRad(float $deg): float {
-        return $deg * M_PI / 180;
-    }
-
-    private function toDeg(float $rad): float {
-        return $rad * 180 / M_PI;
-    }
+	/**
+	 * Register for events.
+	 *
+	 * @param Doku_Event_Handler $controller
+	 *          DokuWiki's event controller object. Also available as global $EVENT_HANDLER
+	 */
+	public function register(Doku_Event_Handler $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');
+
+		// handle actions we know of
+		$controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handleActionActPreprocess', array());
+		// handle HTML eg. /dokuwiki/doku.php?id=start&do=findnearby&geohash=u15vk4
+		$controller->register_hook(
+			'TPL_ACT_UNKNOWN', 'BEFORE', $this, 'findnearby', array(
+								 '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', array(
+								   'format' => 'JSON'
+							   )
+		);
+
+		// listen for media uploads and deletes
+		$controller->register_hook('MEDIA_UPLOAD_FINISH', 'BEFORE', $this, 'handleMediaUploaded', array());
+		$controller->register_hook('MEDIA_DELETE_FILE', 'BEFORE', $this, 'handleMediaDeleted', array());
+
+		$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 Doku_Event $event
+	 *          event object
+	 * @param mixed      $param
+	 *          the parameters passed to register_hook when this handler was registered
+	 */
+	public function handleIndexerPageAdd(Doku_Event $event, $param): 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');
+		$entries = $indexer->updateSpatialIndex($id);
+	}
+
+	/**
+	 * Update the spatial index, removing the page.
+	 *
+	 * @param Doku_Event $event
+	 *          event object
+	 * @param mixed      $param
+	 *          the parameters passed to register_hook when this handler was registered
+	 */
+	public function removeFromIndex(Doku_Event $event, $param): 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.
+
+		dbglog($event->data, "Event data in removeFromIndex.");
+		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) {
+					$indexer->deleteFromIndex($id);
+				}
+			}
+		}
+	}
+
+	/**
+	 * Add a new SitemapItem object that points to the KML of public geocoded pages.
+	 *
+	 * @param Doku_Event $event
+	 * @param mixed      $param
+	 */
+	public function handleSitemapGenerateBefore(Doku_Event $event, $param): void {
+		$path                     = mediaFN($this->getConf('media_kml'));
+		$lastmod                  = @filemtime($path);
+		$event->data ['items'] [] = new Item(ml($this->getConf('media_kml'), '', true, '&amp;', true), $lastmod);
+		//dbglog($event->data ['items'],
+		//  "Added a new SitemapItem object that points to the KML of public geocoded pages.");
+	}
+
+	/**
+	 * Create a spatial sitemap or attach the geo/kml map to the sitemap.
+	 *
+	 * @param Doku_Event $event
+	 *          event object, not used
+	 * @param mixed      $param
+	 *          parameter array, not used
+	 */
+	public function handleSitemapGenerateAfter(Doku_Event $event, $param): 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')) {
+			// dbglog($helper, "createSpatialSitemap loaded helper.");
+
+			$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'));
+					dbglog(
+						$kmlN && $rssN,
+						"handleSitemapGenerateAfter, created KML / GeoRSS sitemap in $namespace, succes: "
+					);
+				}
+			}
+			return $kml && $rss;
+		} else {
+			dbglog($helper, "createSpatialSitemap NOT loaded helper.");
+		}
+	}
+
+	/**
+	 * trap findnearby action.
+	 * This addional handler is required as described at: https://www.dokuwiki.org/devel:event:tpl_act_unknown
+	 *
+	 * @param Doku_Event $event
+	 *          event object
+	 * @param mixed      $param
+	 *          not used
+	 */
+	public function handleActionActPreprocess(Doku_Event $event, $param): void {
+		if($event->data !== 'findnearby') {
+			return;
+		}
+		$event->preventDefault();
+	}
+
+	/**
+	 * handle findnearby action.
+	 *
+	 * @param Doku_Event $event
+	 *          event object
+	 * @param mixed      $param
+	 *          associative array with keys
+	 *          'format'=> HTML | JSON
+	 */
+	public function findnearby(Doku_Event $event, $param): void {
+		if($event->data !== 'findnearby') {
+			return;
+		}
+		$event->preventDefault();
+		$results = array();
+		global $INPUT;
+		if($helper = plugin_load('helper', 'spatialhelper_search')) {
+			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 = array(
+					'error' => hsc($this->getLang('invalidinput'))
+				);
+			}
+		}
+
+		$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;
+		}
+	}
+
+	/**
+	 * Print seachresults as HTML lists.
+	 *
+	 * @param array $searchresults
+	 */
+	private function printJSON(array $searchresults): void {
+		require_once DOKU_INC . 'inc/JSON.php';
+		$json = new JSON();
+		header('Content-Type: application/json');
+		print $json->encode($searchresults);
+	}
+
+	/**
+	 * 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'])) {
+			print '<div class="level1"><p>' . hsc($searchresults ['error']) . '</p></div>';
+			return;
+		}
+
+		// print a HTML list
+		print '<h1>' . $this->getLang('results_header') . '</h1>' . DOKU_LF;
+		print '<div class="level1">' . DOKU_LF;
+		if(!empty ($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 '<h2>' . $this->getLang('results_pages') . hsc(
+					' lat;lon: ' . $lat . ';' . $lon
+					. ' (geohash: ' . $geohash . ')'
+				) . '</h2>';
+			print '<div class="level2">' . DOKU_LF;
+			print $pagelist;
+			print '</div>' . DOKU_LF;
+		} else {
+			print '<p>' . hsc($this->getLang('nothingfound')) . '</p>';
+		}
+
+		if(!empty ($media) && $showMedia) {
+			$pagelist = '<ol>' . DOKU_LF;
+			foreach($media as $m) {
+				$opts       = array();
+				$link       = ml($m ['id'], $opts, false, '&amp;', false);
+				$opts ['w'] = '100';
+				$src        = ml($m ['id'], $opts);
+				$pagelist   .= '<li><a href="' . $link . '"><img src="' . $src . '"></a> ('
+					. $this->getLang('results_distance_prefix') . $page ['distance'] . '&nbsp;m) ' . hsc($desc)
+					. '</li>' . DOKU_LF;
+			}
+			$pagelist .= '</ol>' . DOKU_LF;
+
+			print '<h2>' . $this->getLang('results_media') . hsc(
+					' lat;lon: ' . $lat . ';' . $lon
+					. ' (geohash: ' . $geohash . ')'
+				) . '</h2>' . DOKU_LF;
+			print '<div class="level2">' . DOKU_LF;
+			print $pagelist;
+			print '</div>' . DOKU_LF;
+		}
+		print '<p>' . $this->getLang('results_precision') . $searchresults ['precision'] . ' m. ';
+		if(strlen($geohash) > 1) {
+			$url = wl(
+				getID(), array(
+						   'do'      => 'findnearby',
+						   'geohash' => substr($geohash, 0, -1)
+					   )
+			);
+			print '<a href="' . $url . '" class="findnearby">' . $this->getLang('search_largerarea') . '</a>.</p>'
+				. DOKU_LF;
+		}
+		print '</div>' . DOKU_LF;
+	}
+
+	/**
+	 * add media to spatial index.
+	 *
+	 * @param Doku_Event $event
+	 * @param mixed      $param
+	 */
+	public function handleMediaUploaded(Doku_Event $event, $param): void {
+		// data[0] temporary file name (read from $_FILES)
+		// 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
+
+		dbglog($event->data, "handleMediaUploaded::event data");
+
+		// check the list of mimetypes
+		// if it's a supported type call appropriate index function
+		if(substr_compare($event->data [3], 'image/jpeg', 0)) {
+			$indexer = plugin_load('helper', 'spatialhelper_index');
+			if($indexer) {
+				$indexer->indexImage($event->data [2]);
+			}
+		}
+		// TODO add image/tiff
+		// TODO kml, gpx, geojson...
+	}
+
+	/**
+	 * removes the media from the index.
+	 */
+	public function handleMediaDeleted(Doku_Event $event, $param): 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
+
+		dbglog($event->data, "handleMediaDeleted::event data");
+
+		// remove the media id from the index
+		$indexer = plugin_load('helper', 'spatialhelper_index');
+		if($indexer) {
+			$indexer->deleteFromIndex('media__' . $event->data ['id']);
+		}
+	}
+
+	/**
+	 * add a link to the spatial sitemap files in the header.
+	 *
+	 * @param Doku_Event $event
+	 *          the DokuWiki event. $event->data is a two-dimensional
+	 *          array of all meta headers. The keys are meta, link and script.
+	 * @param mixed      $param
+	 *
+	 * @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
+	 */
+	public function handleMetaheaderOutput(Doku_Event $event, $param): void {
+		// TODO maybe test for exist
+		$event->data ["link"] [] = array(
+			"type"  => "application/atom+xml",
+			"rel"   => "alternate",
+			"href"  => ml($this->getConf('media_georss')),
+			"title" => "Spatial ATOM Feed"
+		);
+		$event->data ["link"] [] = array(
+			"type"  => "application/vnd.google-earth.kml+xml",
+			"rel"   => "alternate",
+			"href"  => ml($this->getConf('media_kml')),
+			"title" => "KML Sitemap"
+		);
+	}
+
+	/**
+	 * Add spatialhelper popularity data.
+	 *
+	 * @param Doku_Event $event
+	 *          the DokuWiki event
+	 */
+	final public function popularity(Doku_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'];
+	}
+
+	/**
+	 * Calculate a new coordinate based on start, distance and bearing
+	 *
+	 * @param $start array
+	 *               - start coordinate as decimal lat/lon pair
+	 * @param $dist  float
+	 *               - distance in kilometers
+	 * @param $brng  float
+	 *               - bearing in degrees (compass direction)
+	 */
+	private function geoDestination(array $start, float $dist, float $brng): array {
+		$lat1 = $this->toRad($start [0]);
+		$lon1 = $this->toRad($start [1]);
+		// http://en.wikipedia.org/wiki/Earth_radius
+		// average earth radius in km
+		$dist = $dist / 6371.01;
+		$brng = $this->toRad($brng);
+
+		$lon2 = $lon1 + atan2(sin($brng) * sin($dist) * cos($lat1), cos($dist) - sin($lat1) * sin($lat2));
+		$lon2 = fmod(($lon2 + 3 * M_PI), (2 * M_PI)) - M_PI;
+
+		return array(
+			$this->toDeg($lat2),
+			$this->toDeg($lon2)
+		);
+	}
+
+	private function toRad(float $deg): float {
+		return $deg * M_PI / 180;
+	}
+
+	private function toDeg(float $rad): float {
+		return $rad * 180 / M_PI;
+	}
 }