mprins / dokuwiki-plugin-spatialhelper

helper/index.php

Braces +6 added lines, -2 removed lines

@@ -108,11 +108,15 @@
     {
         $geotags = p_get_metadata($id, 'geo');
         if (empty($geotags)) {
-            if ($verbose) echo "No geo metadata found for page $id" . DOKU_LF;
+            if ($verbose) {
+            	echo "No geo metadata found for page $id" . DOKU_LF;
+            }
             return false;
         }
         if (empty($geotags ['lon']) || empty($geotags ['lat'])) {
-            if ($verbose) echo "No valid geo metadata found for page $id" . DOKU_LF;
+            if ($verbose) {
+            	echo "No valid geo metadata found for page $id" . DOKU_LF;
+            }
             return false;
         }
         Logger::debug("Geo metadata found for page $id", $geotags);

Indentation +274 added lines, -274 removed lines

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

_test/index.test.php

Indentation +91 added lines, -91 removed lines

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

helper/search.php

Indentation +144 added lines, -144 removed lines

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

_test/indexing.test.php

Indentation +74 added lines, -74 removed lines

@@ -26,92 +26,92 @@
  */
 class indexing_test extends DokuWikiTest
 {
-    /**
-     * copy data and add pages to the index.
-     */
-    public static function setUpBeforeClass(): void
-    {
-        parent::setUpBeforeClass();
-        TestUtils::rcopy(TMP_DIR, __DIR__ . '/data/');
-    }
+	/**
+	 * copy data and add pages to the index.
+	 */
+	public static function setUpBeforeClass(): void
+	{
+		parent::setUpBeforeClass();
+		TestUtils::rcopy(TMP_DIR, __DIR__ . '/data/');
+	}
 
-    final public function setUp(): void
-    {
-        $this->pluginsEnabled = array(
-            'geophp',
-            'geotag',
-            'spatialhelper'
-        );
+	final public function setUp(): void
+	{
+		$this->pluginsEnabled = array(
+			'geophp',
+			'geotag',
+			'spatialhelper'
+		);
 
-        global $conf;
-        $conf['allowdebug'] = 1;
-        $conf['dontlog'] = [];
-        $conf['cachetime'] = -1;
+		global $conf;
+		$conf['allowdebug'] = 1;
+		$conf['dontlog'] = [];
+		$conf['cachetime'] = -1;
 
-        parent::setUp();
+		parent::setUp();
 
-        $indexer = plugin_load('helper', 'spatialhelper_index');
-        self::assertInstanceOf('helper_plugin_spatialhelper_index', $indexer);
+		$indexer = plugin_load('helper', 'spatialhelper_index');
+		self::assertInstanceOf('helper_plugin_spatialhelper_index', $indexer);
 
-        $data = [];
-        search($data, $conf['datadir'], 'search_allpages', array('skipacl' => true));
+		$data = [];
+		search($data, $conf['datadir'], 'search_allpages', array('skipacl' => true));
 
-        foreach ($data as $val) {
-            idx_addPage($val['id']);
-            $indexer->updateSpatialIndex($val['id']);
-        }
-    }
+		foreach ($data as $val) {
+			idx_addPage($val['id']);
+			$indexer->updateSpatialIndex($val['id']);
+		}
+	}
 
-    /**
-     * @throws Exception if anything goes wrong
-     */
-    final public function testIndexed(): void
-    {
-        // render the page
-        $request = new TestRequest();
-        $response = $request->get(array('id' => 'geotag'));
+	/**
+	 * @throws Exception if anything goes wrong
+	 */
+	final public function testIndexed(): void
+	{
+		// render the page
+		$request = new TestRequest();
+		$response = $request->get(array('id' => 'geotag'));
 
-        // test metadata
-        self::assertEquals(
-            '52.132633;5.291266;9',
-            $response->queryHTML('meta[name="geo.position"]')->attr('content')
-        );
-        self::assertEquals(
-            '52.132633, 5.291266',
-            $response->queryHTML('meta[name="ICBM"]')->attr('content')
-        );
+		// test metadata
+		self::assertEquals(
+			'52.132633;5.291266;9',
+			$response->queryHTML('meta[name="geo.position"]')->attr('content')
+		);
+		self::assertEquals(
+			'52.132633, 5.291266',
+			$response->queryHTML('meta[name="ICBM"]')->attr('content')
+		);
 
-        // test the geohash and index values
-        self::assertStringStartsWith(
-            'u17b86kyx7jv',
-            $response->queryHTML('meta[name="geo.geohash"]')->attr('content')
-        );
-    }
+		// test the geohash and index values
+		self::assertStringStartsWith(
+			'u17b86kyx7jv',
+			$response->queryHTML('meta[name="geo.geohash"]')->attr('content')
+		);
+	}
 
 
-    final public function testIndexFileExists(): void
-    {
-        self::assertFileExists(TMP_DIR . '/data/index/spatial.idx');
-    }
+	final public function testIndexFileExists(): void
+	{
+		self::assertFileExists(TMP_DIR . '/data/index/spatial.idx');
+	}
 
-    final public function testIndexFileNotEmpty(): void
-    {
-        self::assertGreaterThan(0, filesize(TMP_DIR . '/data/index/spatial.idx'));
-    }
+	final public function testIndexFileNotEmpty(): void
+	{
+		self::assertGreaterThan(0, filesize(TMP_DIR . '/data/index/spatial.idx'));
+	}
 
-    final public function testSearchNearby(): void
-    {
-        $search = plugin_load('helper', 'spatialhelper_search');
-        self::assertInstanceOf('helper_plugin_spatialhelper_search', $search);
+	final public function testSearchNearby(): void
+	{
+		$search = plugin_load('helper', 'spatialhelper_search');
+		self::assertInstanceOf('helper_plugin_spatialhelper_search', $search);
 
-        $result = $search->findNearby('u17b86kyx7');
-        self::assertIsArray($result);
-        self::assertNotEmpty($result);
-        self::assertEmpty($result['media']);
-        self::assertEquals('geotag', $result['pages'][0]['id']);
-        self::assertEquals('u17b86kyx7', $result['geohash']);
-        self::assertEquals(0.6, $result['precision']);
-        self::assertEqualsWithDelta(52.1326, $result['lat'], 0.001);
-        self::assertEqualsWithDelta(5.2912, $result['lon'], 0.001);
-    }
+		$result = $search->findNearby('u17b86kyx7');
+		self::assertIsArray($result);
+		self::assertNotEmpty($result);
+		self::assertEmpty($result['media']);
+		self::assertEquals('geotag', $result['pages'][0]['id']);
+		self::assertEquals('u17b86kyx7', $result['geohash']);
+		self::assertEquals(0.6, $result['precision']);
+		self::assertEqualsWithDelta(52.1326, $result['lat'], 0.001);
+		self::assertEqualsWithDelta(5.2912, $result['lon'], 0.001);
+	}
 }