Search Index Refactoring

_test/core/DokuWikiTest.php

@@ -3,13 +3,15 @@
 use dokuwiki\Extension\PluginController;
 use dokuwiki\Extension\Event;
 use dokuwiki\Extension\EventHandler;
+use dokuwiki\Search\Indexer;
+
 /**
  * Helper class to provide basic functionality for tests
  *
  * @uses PHPUnit_Framework_TestCase and thus PHPUnit 5.7+ is required
  */
-abstract class DokuWikiTest extends PHPUnit\Framework\TestCase {
-
+abstract class DokuWikiTest extends PHPUnit\Framework\TestCase
+{
     /**
      * tests can override this
      *
@@ -80,18 +82,18 @@ public function setUp() : void {
         foreach (array('default','local') as $config_group) {
             if (empty($config_cascade['license'][$config_group])) continue;
             foreach ($config_cascade['license'][$config_group] as $config_file) {
-                if(file_exists($config_file)){
+                if (file_exists($config_file)) {
                     include($config_file);
                 }
             }
         }
         // reload some settings
         $conf['gzip_output'] &= (strpos($_SERVER['HTTP_ACCEPT_ENCODING'],'gzip') !== false);
 
-        if($conf['compression'] == 'bz2' && !DOKU_HAS_BZIP) {
+        if ($conf['compression'] == 'bz2' && !DOKU_HAS_BZIP) {
             $conf['compression'] = 'gz';
         }
-        if($conf['compression'] == 'gz' && !DOKU_HAS_GZIP) {
+        if ($conf['compression'] == 'gz' && !DOKU_HAS_GZIP) {
             $conf['compression'] = 0;
         }
         // make real paths and check them
@@ -144,11 +146,12 @@ public function setUp() : void {
     /**
      * Reinitialize the data directory for this class run
      */
-    public static function setupDataDir() {
+    public static function setupDataDir()
+    {
         // remove any leftovers from the last run
         if(is_dir(DOKU_TMP_DATA)) {
             // clear indexer data and cache
-            idx_get_indexer()->clear();
+            (new Indexer())->clear();
             TestUtils::rdelete(DOKU_TMP_DATA);
         }
 
@@ -159,7 +162,8 @@ public static function setupDataDir() {
     /**
      * Reinitialize the conf directory for this class run
      */
-    public static function setupConfDir() {
+    public static function setupConfDir()
+    {
         $defaults = [
             'acronyms.conf',
             'dokuwiki.php',
@@ -177,13 +181,13 @@ public static function setupConfDir() {
         ];
 
         // clear any leftovers
-        if(is_dir(DOKU_CONF)) {
+        if (is_dir(DOKU_CONF)) {
             TestUtils::rdelete(DOKU_CONF);
         }
         mkdir(DOKU_CONF);
 
         // copy defaults
-        foreach($defaults as $file) {
+        foreach ($defaults as $file) {
             copy(DOKU_INC . '/conf/' . $file, DOKU_CONF . $file);
         }
 
@@ -201,7 +205,8 @@ public static function setupConfDir() {
      * @param bool $init no longer used
      * @return int new timestamp
      */
-    protected function waitForTick($init = false) {
+    protected function waitForTick($init = false)
+    {
         sleep(1);
         return time();
     }
@@ -219,7 +224,8 @@ protected function waitForTick($init = false) {
      * @return mixed
      * @throws ReflectionException when the given obj/func does not exist
      */
-    protected static function callInaccessibleMethod($obj, $func, array $args) {
+    protected static function callInaccessibleMethod($obj, $func, array $args)
+    {
         $class = new \ReflectionClass($obj);
         $method = $class->getMethod($func);
         $method->setAccessible(true);
@@ -237,7 +243,8 @@ protected static function callInaccessibleMethod($obj, $func, array $args) {
      * @return mixed
      * @throws ReflectionException  when the given obj/prop does not exist
      */
-    protected static function getInaccessibleProperty($obj, $prop) {
+    protected static function getInaccessibleProperty($obj, $prop)
+    {
         $class = new \ReflectionClass($obj);
         $property = $class->getProperty($prop);
         $property->setAccessible(true);
@@ -256,7 +263,8 @@ protected static function getInaccessibleProperty($obj, $prop) {
      * @return void
      * @throws ReflectionException when the given obj/prop does not exist
      */
-    protected static function setInaccessibleProperty($obj, $prop, $value) {
+    protected static function setInaccessibleProperty($obj, $prop, $value)
+    {
         $class = new \ReflectionClass($obj);
         $property = $class->getProperty($prop);
         $property->setAccessible(true);

_test/tests/inc/fulltext_backlinks.test.php

@@ -1,5 +1,8 @@
 <?php
 
+use dokuwiki\Search\Indexer;
+use dokuwiki\Search\MetadataIndex;
+
 // must be run within Dokuwiki
 if (!defined('DOKU_INC')) die();
 
@@ -8,38 +11,45 @@
  *
  * @author Michael Hamann <michael@content-space.de>
  */
-class fulltext_backlinks_test extends DokuWikiTest {
-
-    public function test_internallink() {
+class fulltext_backlinks_test extends DokuWikiTest
+{
+    public function test_internallink()
+    {
         saveWikiText('test:internallinks', '[[internälLink]] [[..:internal link]]', 'Test initialization');
-        idx_addPage('test:internallinks');
+        (new Indexer('test:internallinks'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('test:internallinks'), ft_backlinks('internal_link'));
-        $this->assertEquals(array('test:internallinks'), ft_backlinks('test:internaellink'));
+        $this->assertEquals(array('test:internallinks'), $MetadataIndex->backlinks('internal_link'));
+        $this->assertEquals(array('test:internallinks'), $MetadataIndex->backlinks('test:internaellink'));
     }
 
-    public function test_links_in_footnotes() {
+    public function test_links_in_footnotes()
+    {
         saveWikiText('test:link_footnotes', '(([[footnote]] [[:foÖtnotel]]))', 'Test initialization');
-        idx_addPage('test:link_footnotes');
+        (new Indexer('test:link_footnotes'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('test:link_footnotes'), ft_backlinks('test:footnote'));
-        $this->assertEquals(array('test:link_footnotes'), ft_backlinks('fooetnotel'));
+        $this->assertEquals(array('test:link_footnotes'), $MetadataIndex->backlinks('test:footnote'));
+        $this->assertEquals(array('test:link_footnotes'), $MetadataIndex->backlinks('fooetnotel'));
     }
 
-    public function test_links_in_hidden_pages() {
+    public function test_links_in_hidden_pages()
+    {
         global $conf;
         $conf['hidepages'] = 'hidden:.*';
         saveWikiText('hidden:links', '[[wiki:hiddenlink|linktitle]]', 'Test initialization');
-        idx_addPage('hidden:links');
+        (new Indexer('hidden:links'))->addPage();
         saveWikiText('visible:links', '[[wiki:hiddenlink]]', 'Test initialization');
-        idx_addPage('visible:links');
+        (new Indexer('visible:links'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('visible:links'), ft_backlinks('wiki:hiddenlink'));
-        $this->assertEquals(array('visible:links'), ft_backlinks('wiki:hiddenlink', false));
-        $this->assertEquals(array('hidden:links', 'visible:links'), ft_backlinks('wiki:hiddenlink', true));
+        $this->assertEquals(array('visible:links'), $MetadataIndex->backlinks('wiki:hiddenlink'));
+        $this->assertEquals(array('visible:links'), $MetadataIndex->backlinks('wiki:hiddenlink', false));
+        $this->assertEquals(array('hidden:links', 'visible:links'), $MetadataIndex->backlinks('wiki:hiddenlink', true));
     }
 
-    public function test_links_in_protected_pages() {
+    public function test_links_in_protected_pages()
+    {
         global $conf;
         global $AUTH_ACL;
         $conf['superuser'] = 'alice';
@@ -53,33 +63,38 @@ public function test_links_in_protected_pages() {
         $_SERVER['REMOTE_USER'] = 'eve';
 
         saveWikiText('secret:links', '[[wiki:secretlink]]', 'Test initialization');
-        idx_addPage('secret:links');
+        (new Indexer('secret:links'))->addPage();
         saveWikiText('public:links', '[[wiki:secretlink]]', 'Test initialization');
-        idx_addPage('public:links');
+        (new Indexer('public:links'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('public:links'), ft_backlinks('wiki:secretlink'));
-        $this->assertEquals(array('public:links'), ft_backlinks('wiki:secretlink', false));
-        $this->assertEquals(array('public:links', 'secret:links'), ft_backlinks('wiki:secretlink', true));
+        $this->assertEquals(array('public:links'), $MetadataIndex->backlinks('wiki:secretlink'));
+        $this->assertEquals(array('public:links'), $MetadataIndex->backlinks('wiki:secretlink', false));
+        $this->assertEquals(array('public:links', 'secret:links'), $MetadataIndex->backlinks('wiki:secretlink', true));
     }
 
-    public function test_links_in_deleted_pages() {
+    public function test_links_in_deleted_pages()
+    {
         saveWikiText('test:internallinks', '[[internallink]] [[..:internal link]]', 'Test initialization');
-        idx_addPage('test:internallinks');
+        (new Indexer('test:internallinks'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('test:internallinks'), ft_backlinks('test:internallink'));
-        $this->assertEquals(array('test:internallinks'), ft_backlinks('internal_link'));
+        $this->assertEquals(array('test:internallinks'), $MetadataIndex->backlinks('test:internallink'));
+        $this->assertEquals(array('test:internallinks'), $MetadataIndex->backlinks('internal_link'));
 
         saveWikiText('test:internallinks', '', 'Deleted');
 
-        $this->assertEquals(array(), ft_backlinks('test:internallink'));
-        $this->assertEquals(array(), ft_backlinks('internal_link'));
+        $this->assertEquals(array(), $MetadataIndex->backlinks('test:internallink'));
+        $this->assertEquals(array(), $MetadataIndex->backlinks('internal_link'));
     }
 
-    function test_parameters() {
+    function test_parameters()
+    {
         saveWikiText('test:links', '[[wiki:syntax?do=export_raw]] [[:web:scripts:add_vhost.sh?do=export_raw]]', 'Init tests');
-        idx_addPage('test:links');
+        (new Indexer('test:links'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('test:links'), ft_backlinks('wiki:syntax'));
-        $this->assertEquals(array('test:links'), ft_backlinks('web:scripts:add_vhost.sh'));
+        $this->assertEquals(array('test:links'), $MetadataIndex->backlinks('wiki:syntax'));
+        $this->assertEquals(array('test:links'), $MetadataIndex->backlinks('web:scripts:add_vhost.sh'));
     }
 }

_test/tests/inc/fulltext_mediause.test.php

@@ -1,5 +1,8 @@
 <?php
 
+use dokuwiki\Search\Indexer;
+use dokuwiki\Search\MetadataIndex;
+
 // must be run within Dokuwiki
 if (!defined('DOKU_INC')) die();
 
@@ -8,51 +11,62 @@
  *
  * @author Michael Hamann <michael@content-space.de>
  */
-class fultext_mediause_test extends DokuWikiTest {
-
-    public function test_internalmedia() {
+class fultext_mediause_test extends DokuWikiTest
+{
+    public function test_internalmedia()
+    {
         saveWikiText('test:internalmedia_usage', '{{internalmedia.png}} {{..:internal media.png}}', 'Test initialization');
-        idx_addPage('test:internalmedia_usage');
+        (new Indexer('test:internalmedia_usage'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('test:internalmedia_usage'), ft_mediause('internal_media.png'));
-        $this->assertEquals(array('test:internalmedia_usage'), ft_mediause('test:internalmedia.png'));
+        $this->assertEquals(array('test:internalmedia_usage'), $MetadataIndex->mediause('internal_media.png'));
+        $this->assertEquals(array('test:internalmedia_usage'), $MetadataIndex->mediause('test:internalmedia.png'));
     }
 
-    public function test_media_in_links() {
+    public function test_media_in_links()
+    {
         saveWikiText('test:medialinks', '[[doku>wiki:dokuwiki|{{wiki:logo.png}}]] [[http://www.example.com|{{example.png?200x800}}]]', 'Test init');
-        idx_addPage('test:medialinks');
+        (new Indexer('test:medialinks'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('test:medialinks'), ft_mediause('wiki:logo.png'));
-        $this->assertEquals(array('test:medialinks'), ft_mediause('test:example.png'));
+        $this->assertEquals(array('test:medialinks'), $MetadataIndex->mediause('wiki:logo.png'));
+        $this->assertEquals(array('test:medialinks'), $MetadataIndex->mediause('test:example.png'));
     }
 
-    public function test_media_in_local_links() {
+    public function test_media_in_local_links()
+    {
         saveWikiText('test:locallinks', '[[#test|{{wiki:logolocal.png}}]]', 'Test init');
-        idx_addPage('test:locallinks');
+        (new Indexer('test:locallinks'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('test:locallinks'), ft_mediause('wiki:logolocal.png'));
+        $this->assertEquals(array('test:locallinks'), $MetadataIndex->mediause('wiki:logolocal.png'));
     }
 
-    public function test_media_in_footnotes() {
+    public function test_media_in_footnotes()
+    {
         saveWikiText('test:media_footnotes', '(({{footnote.png?20x50}} [[foonote|{{:footlink.png}}]]))', 'Test initialization');
-        idx_addPage('test:media_footnotes');
+        (new Indexer('test:media_footnotes'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array('test:media_footnotes'), ft_mediause('test:footnote.png'));
-        $this->assertEquals(array('test:media_footnotes'), ft_mediause('footlink.png'));
+        $this->assertEquals(array('test:media_footnotes'), $MetadataIndex->mediause('test:footnote.png'));
+        $this->assertEquals(array('test:media_footnotes'), $MetadataIndex->mediause('footlink.png'));
     }
 
-    public function test_media_in_hidden_pages() {
+    public function test_media_in_hidden_pages()
+    {
         global $conf;
         $conf['hidepages'] = 'hidden:.*';
         saveWikiText('hidden:medias', '[[doku>wiki:dokuwiki|{{wiki:hiddenlogo.png}}]]', 'Test initialization');
-        idx_addPage('hidden:medias');
+        (new Indexer('hidden:medias'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array(), ft_mediause('wiki:hiddenlogo.png'));
-        $this->assertEquals(array(), ft_mediause('wiki:hiddenlogo.png', false));
-        $this->assertEquals(array('hidden:medias'), ft_mediause('wiki:hiddenlogo.png', true));
+        $this->assertEquals(array(), $MetadataIndex->mediause('wiki:hiddenlogo.png'));
+        $this->assertEquals(array(), $MetadataIndex->mediause('wiki:hiddenlogo.png', false));
+        $this->assertEquals(array('hidden:medias'), $MetadataIndex->mediause('wiki:hiddenlogo.png', true));
     }
 
-    public function test_media_in_protected_pages() {
+    public function test_media_in_protected_pages()
+    {
         global $conf;
         global $AUTH_ACL;
         $conf['superuser'] = 'alice';
@@ -66,19 +80,22 @@ public function test_media_in_protected_pages() {
         $_SERVER['REMOTE_USER'] = 'eve';
 
         saveWikiText('secret:medias', '[[doku>wiki:dokuwiki|{{wiki:secretlogo.png}}]]', 'Test initialization');
-        idx_addPage('secret:medias');
+        (new Indexer('secret:medias'))->addPage();
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array(), ft_mediause('wiki:secretlogo.png'));
-        $this->assertEquals(array(), ft_mediause('wiki:secretlogo.png', false));
-        $this->assertEquals(array('secret:medias'), ft_mediause('wiki:secretlogo.png', true));
+        $this->assertEquals(array(), $MetadataIndex->mediause('wiki:secretlogo.png'));
+        $this->assertEquals(array(), $MetadataIndex->mediause('wiki:secretlogo.png', false));
+        $this->assertEquals(array('secret:medias'), $MetadataIndex->mediause('wiki:secretlogo.png', true));
     }
 
-    public function test_media_in_deleted_pages() {
+    public function test_media_in_deleted_pages()
+    {
         saveWikiText('test:internalmedia_usage', '{{internalmedia.png}} {{..:internal media.png}}', 'Test initialization');
-        idx_addPage('test:internalmedia_usage');
+        (new Indexer('test:internalmedia_usage'))->addPage();
         saveWikiText('test:internalmedia_usage', '', 'Deleted');
+        $MetadataIndex = new MetadataIndex();
 
-        $this->assertEquals(array(), ft_mediause('internal_media.png'));
-        $this->assertEquals(array(), ft_mediause('test:internalmedia.png'));
+        $this->assertEquals(array(), $MetadataIndex->mediause('internal_media.png'));
+        $this->assertEquals(array(), $MetadataIndex->mediause('test:internalmedia.png'));
     }
 }