Indexer::addMetaKeys() - Code Metrics - Inspection of "Refactor fulltext search functions and class Doku_..." - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#2943)

unknown

created 2020-09-25 08:20 UTC

Indexer::addMetaKeys() F

↳ Parent: Indexer

Complexity

Conditions	20
Paths	3471

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	20
nc	3471
nop	3
dl	0
loc	94
rs	0
c	0
b	0
f	0

1 Method

Rating	Name	Duplication	Size	Complexity
B	Indexer::deletePage()	0	41	10

How to fix Long Method Complexity

<?php

namespace dokuwiki\Search;

use dokuwiki\Extension\Event;
use dokuwiki\Search\Exception\IndexAccessException;
use dokuwiki\Search\Exception\IndexLockException;
use dokuwiki\Search\Exception\IndexWriteException;

// Version tag used to force rebuild on upgrade
const INDEXER_VERSION = 8;

/**
 * Class DokuWiki Indexer
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Andreas Gohr <[email protected]>
 * @author Tom N Harris <[email protected]>
 */
class Indexer extends AbstractIndex
{
    // page to be indexed
    protected $page;

    /**
     * Indexer constructor
     *
     * @param string $page name of the page to index
     * @return Indexer

     */
    public function __construct($page = null)
    {
        if (isset($page)) $this->page = $page;
    }

    /**
     * Dispatch Indexing request for the page, called by TaskRunner::runIndexer()
     *
     * @param bool $verbose print status messages
     * @param bool $force force reindexing even when the index is up to date
     * @return bool  If the function completed successfully
     *
     * @throws IndexAccessException
     * @throws IndexLockException
     * @throws IndexWriteException
     * @author Satoshi Sahara <[email protected]>
     * @author Tom N Harris <[email protected]>
     */
    public function dispatch($verbose = false, $force = false)
    {
        if (!isset($this->page)) {
            throw new IndexAccessException('Indexer: unknow page name');
        }

        // check if page was deleted but is still in the index
        if (!page_exists($this->page)) {
            return $this->deletePage($verbose, $force);
        }

        // update search index
        return $this->addPage($verbose, $force);
    }

    /**
     * Version of the indexer taking into consideration the external tokenizer.
     * The indexer is only compatible with data written by the same version.
     *
     * @triggers INDEXER_VERSION_GET
     * Plugins that modify what gets indexed should hook this event and
     * add their version info to the event data like so:
     *     $data[$plugin_name] = $plugin_version;
     *
     * @author Tom N Harris <[email protected]>
     * @author Michael Hamann <[email protected]>
     *
     * @return int|string
     */
    public function getVersion()
    {
        static $indexer_version = null;
        if ($indexer_version == null) {
            $version = INDEXER_VERSION;

            // DokuWiki version is included for the convenience of plugins
            $data = array('dokuwiki' => $version);
            Event::createAndTrigger('INDEXER_VERSION_GET', $data, null, false);
            unset($data['dokuwiki']); // this needs to be first
            ksort($data);
            foreach ($data as $plugin => $vers) {
                $version .= '+'.$plugin.'='.$vers;
            }
            $indexer_version = $version;
        }
        return $indexer_version;
    }

    /**
     * Adds/updates the search index for the given page
     *
     * Locking is handled internally.
     *
     * @param bool $verbose print status messages
     * @param bool $force force reindexing even when the index is up to date
     * @return bool  If the function completed successfully
     *
     * @throws IndexAccessException
     * @throws IndexLockException
     * @throws IndexWriteException
     * @author Satoshi Sahara <[email protected]>
     * @author Tom N Harris <[email protected]>
     */
    public function addPage($verbose = false, $force = false)
    {
        if (!isset($this->page)) {
            throw new IndexAccessException('Indexer: invalid page name in addePage');
        } else {
            $page = $this->page;
        }

        // check if indexing needed for the existing page (full text and/or metadata indexing)
        $idxtag = metaFN($page,'.indexed');
        if (!$force && file_exists($idxtag)) {
            if (trim(io_readFile($idxtag)) == $this->getVersion()) {
                $last = @filemtime($idxtag);
                if ($last > @filemtime(wikiFN($page))) {
                    if ($verbose) dbglog("Indexer: index for {$page} up to date");
                    return true;
                }
            }
        }

        // register the page to the page.idx file, $pid is always integer
        $pid = $this->getPID($page);

        // prepare metadata indexing
        $metadata = array();
        $metadata['title'] = p_get_metadata($page, 'title', METADATA_RENDER_UNLIMITED);

        $references = p_get_metadata($page, 'relation references', METADATA_RENDER_UNLIMITED);
        $metadata['relation_references'] = ($references !== null) ?
                array_keys($references) : array();

        $media = p_get_metadata($page, 'relation media', METADATA_RENDER_UNLIMITED);
        $metadata['relation_media'] = ($media !== null) ?
                array_keys($media) : array();

        // check if full text indexing allowed
        $indexenabled = p_get_metadata($page, 'internal index', METADATA_RENDER_UNLIMITED);
        if ($indexenabled !== false) $indexenabled = true;
        $metadata['internal_index'] = $indexenabled;

        $body = '';
        $data = compact('page', 'body', 'metadata', 'pid');
        $event = new Event('INDEXER_PAGE_ADD', $data);
        if ($event->advise_before()) $data['body'] = $data['body'].' '.rawWiki($page);
        $event->advise_after();
        unset($event);
        extract($data);
        $indexenabled = $metadata['internal_index'];
        unset($metadata['internal_index']);

        // Access to Metadata Index
        $result = (new MetadataIndex($pid))->addMetaKeys($metadata);
        if ($verbose) dbglog("Indexer: addMetaKeys({$page}) ".($result ? 'done' : 'failed'));
        if (!$result) {
            return false;
        }

        // Access to Fulltext Index
        if ($indexenabled) {
            $result = (new FulltextIndex($pid))->addWords($body);
            if ($verbose) dbglog("Indexer: addWords() for {$page} done");
            if (!$result) {
                return false;
            }
        } else {
            if ($verbose) dbglog("Indexer: full text indexing disabled for {$page}");
            // ensure the page content deleted from the Fulltext index
            $result = (new FulltextIndex($page))->deleteWords();
            if ($verbose) dbglog("Indexer: deleteWords() for {$page} done");
            if (!$result) {
                return false;
            }
        }

        // update index tag file
        io_saveFile($idxtag, $this->getVersion());
        if ($verbose) dbglog("Indexer: finished");

        return $result;
    }

    /**
     * Remove a page from the index
     *
     * Erases entries in all known indexes. Locking is handled internally.
     *
     * @param string $page name of the page to index
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param bool $verbose print status messages
     * @param bool $force force reindexing even when the index is up to date
     * @return bool  If the function completed successfully
     *
     * @throws IndexAccessException
     * @throws IndexLockException
     * @throws IndexWriteException
     * @author Satoshi Sahara <[email protected]>
     * @author Tom N Harris <[email protected]>
     */
    public function deletePage($verbose = false, $force = false)
    {
        if (!isset($this->page)) {
            throw new IndexAccessException('Indexer: invalid page name in deletePage');
        } else {
            $page = $this->page;
        }

        $idxtag = metaFN($page,'.indexed');
        if (!$force && !file_exists($idxtag)) {
            if ($verbose) dbglog("Indexer: {$page}.indexed file does not exist, ignoring");
            return true;
        }

        // retrieve pid from the page.idx file, $pid is always integer
        $pid = $this->getPID($page);

        // remove obsoleted content from Fulltext index
        $result = (new FulltextIndex($pid))->deleteWords();
        if ($verbose) dbglog("Indexer: deleteWords() for {$page} done");
        if (!$result) {
            return false;
        }

        // delete all keys of the page from metadata index
        $result = (new MetadataIndex($pid))->deleteMetaKeys();
        if ($verbose) dbglog("Indexer: deleteMetaKeys() for {$page} done");
        if (!$result) {
            return false;
        }

        // mark the page as deleted in the page.idx
        $this->lock();
        $this->saveIndexKey('page', '', $pid, self::INDEX_MARK_DELETED.$page);
        if ($verbose) dbglog("Indexer: {$page} has marked as deleted in page.idx");
        $this->unlock();

        unset(static::$pidCache[$pid]);
        @unlink($idxtag);
        return $result;
    }

    /**
     * Rename a page in the search index without changing the indexed content.
     * This function doesn't check if the old or new name exists in the filesystem.
     * It returns an error if the old page isn't in the page list of the indexer
     * and it deletes all previously indexed content of the new page.
     *
     * @param string $oldpage The old page name
     * @param string $newpage The new page name
     * @return bool  If the page was successfully renamed
     * @throws IndexLockException
     * @throws IndexWriteException
     */
    public function renamePage($oldpage, $newpage)
    {
        $index = $this->getIndex('page', '');
        // check if oldpage found in page.idx
        $oldPid = array_search($oldpage, $index, true);
        if ($oldPid === false) return false;

        // check if newpage found in page.idx
        $newPid = array_search($newpage, $index, true);
        if ($newPid !== false) {
            $result = (new Indexer($newpage))->deletePage();
            if (!$result) return false;
            // Note: $index is no longer valid after deletePage()!
            unset($index);
        }

        // update page.idx
        $this->lock();
        $this->saveIndexKey('page', '', $oldPid, $newpage);
        $this->unlock();

        // reset the pid cache
        $this->resetPIDCache();

        return true;
    }

    /**
     * Clear the Page Index
     *
     * @param bool $requireLock should be false only if the caller is resposible for index lock
     * @return bool  If the index has been cleared successfully
     * @throws Exception\IndexLockException
     */
    public function clear($requireLock = true)
    {
        global $conf;

        if ($requireLock) $this->lock();

        // clear Metadata Index
        (new MetadataIndex())->clear(false);

        // clear Fulltext Index
        (new FulltextIndex())->clear(false);

        @unlink($conf['indexdir'].'/page.idx');

        // clear the pid cache
        $this->resetPIDCache();

        if ($requireLock) $this->unlock();
        return true;
    }

}


1			<?php
2
3			namespace dokuwiki\Search;
4
5			use dokuwiki\Extension\Event;
6			use dokuwiki\Search\Exception\IndexAccessException;
7			use dokuwiki\Search\Exception\IndexLockException;
8			use dokuwiki\Search\Exception\IndexWriteException;
9
10			// Version tag used to force rebuild on upgrade
11			const INDEXER_VERSION = 8;
12
13			/**
14			* Class DokuWiki Indexer
15			*
16			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
17			* @author Andreas Gohr <[email protected]>
18			* @author Tom N Harris <[email protected]>
19			*/
20			class Indexer extends AbstractIndex
21			{
22			// page to be indexed
23			protected $page;
24
25			/**
26			* Indexer constructor
27			*
28			* @param string $page name of the page to index
29			* @return Indexer
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-09-25 08:23 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
30			*/
31			public function __construct($page = null)
32			{
33			if (isset($page)) $this->page = $page;
34			}
35
36			/**
37			* Dispatch Indexing request for the page, called by TaskRunner::runIndexer()
38			*
39			* @param bool $verbose print status messages
40			* @param bool $force force reindexing even when the index is up to date
41			* @return bool If the function completed successfully
42			*
43			* @throws IndexAccessException
44			* @throws IndexLockException
45			* @throws IndexWriteException
46			* @author Satoshi Sahara <[email protected]>
47			* @author Tom N Harris <[email protected]>
48			*/
49			public function dispatch($verbose = false, $force = false)
50			{
51			if (!isset($this->page)) {
52			throw new IndexAccessException('Indexer: unknow page name');
53			}
54
55			// check if page was deleted but is still in the index
56			if (!page_exists($this->page)) {
57			return $this->deletePage($verbose, $force);
58			}
59
60			// update search index
61			return $this->addPage($verbose, $force);
62			}
63
64			/**
65			* Version of the indexer taking into consideration the external tokenizer.
66			* The indexer is only compatible with data written by the same version.
67			*
68			* @triggers INDEXER_VERSION_GET
69			* Plugins that modify what gets indexed should hook this event and
70			* add their version info to the event data like so:
71			* $data[$plugin_name] = $plugin_version;
72			*
73			* @author Tom N Harris <[email protected]>
74			* @author Michael Hamann <[email protected]>
75			*
76			* @return int\|string
77			*/
78			public function getVersion()
79			{
80			static $indexer_version = null;
81			if ($indexer_version == null) {
82			$version = INDEXER_VERSION;
83
84			// DokuWiki version is included for the convenience of plugins
85			$data = array('dokuwiki' => $version);
86			Event::createAndTrigger('INDEXER_VERSION_GET', $data, null, false);
87			unset($data['dokuwiki']); // this needs to be first
88			ksort($data);
89			foreach ($data as $plugin => $vers) {
90			$version .= '+'.$plugin.'='.$vers;
91			}
92			$indexer_version = $version;
93			}
94			return $indexer_version;
95			}
96
97			/**
98			* Adds/updates the search index for the given page
99			*
100			* Locking is handled internally.
101			*
102			* @param bool $verbose print status messages
103			* @param bool $force force reindexing even when the index is up to date
104			* @return bool If the function completed successfully
105			*
106			* @throws IndexAccessException
107			* @throws IndexLockException
108			* @throws IndexWriteException
109			* @author Satoshi Sahara <[email protected]>
110			* @author Tom N Harris <[email protected]>
111			*/
112			public function addPage($verbose = false, $force = false)
113			{
114			if (!isset($this->page)) {
115			throw new IndexAccessException('Indexer: invalid page name in addePage');
116			} else {
117			$page = $this->page;
118			}
119
120			// check if indexing needed for the existing page (full text and/or metadata indexing)
121			$idxtag = metaFN($page,'.indexed');
122			if (!$force && file_exists($idxtag)) {
123			if (trim(io_readFile($idxtag)) == $this->getVersion()) {
124			$last = @filemtime($idxtag);
125			if ($last > @filemtime(wikiFN($page))) {
126			if ($verbose) dbglog("Indexer: index for {$page} up to date");
127			return true;
128			}
129			}
130			}
131
132			// register the page to the page.idx file, $pid is always integer
133			$pid = $this->getPID($page);
134
135			// prepare metadata indexing
136			$metadata = array();
137			$metadata['title'] = p_get_metadata($page, 'title', METADATA_RENDER_UNLIMITED);
138
139			$references = p_get_metadata($page, 'relation references', METADATA_RENDER_UNLIMITED);
140			$metadata['relation_references'] = ($references !== null) ?
141			array_keys($references) : array();
142
143			$media = p_get_metadata($page, 'relation media', METADATA_RENDER_UNLIMITED);
144			$metadata['relation_media'] = ($media !== null) ?
145			array_keys($media) : array();
146
147			// check if full text indexing allowed
148			$indexenabled = p_get_metadata($page, 'internal index', METADATA_RENDER_UNLIMITED);
149			if ($indexenabled !== false) $indexenabled = true;
150			$metadata['internal_index'] = $indexenabled;
151
152			$body = '';
153			$data = compact('page', 'body', 'metadata', 'pid');
154			$event = new Event('INDEXER_PAGE_ADD', $data);
155			if ($event->advise_before()) $data['body'] = $data['body'].' '.rawWiki($page);
156			$event->advise_after();
157			unset($event);
158			extract($data);
159			$indexenabled = $metadata['internal_index'];
160			unset($metadata['internal_index']);
161
162			// Access to Metadata Index
163			$result = (new MetadataIndex($pid))->addMetaKeys($metadata);
164			if ($verbose) dbglog("Indexer: addMetaKeys({$page}) ".($result ? 'done' : 'failed'));
165			if (!$result) {
166			return false;
167			}
168
169			// Access to Fulltext Index
170			if ($indexenabled) {
171			$result = (new FulltextIndex($pid))->addWords($body);
172			if ($verbose) dbglog("Indexer: addWords() for {$page} done");
173			if (!$result) {
174			return false;
175			}
176			} else {
177			if ($verbose) dbglog("Indexer: full text indexing disabled for {$page}");
178			// ensure the page content deleted from the Fulltext index
179			$result = (new FulltextIndex($page))->deleteWords();
180			if ($verbose) dbglog("Indexer: deleteWords() for {$page} done");
181			if (!$result) {
182			return false;
183			}
184			}
185
186			// update index tag file
187			io_saveFile($idxtag, $this->getVersion());
188			if ($verbose) dbglog("Indexer: finished");
189
190			return $result;
191			}
192
193			/**
194			* Remove a page from the index
195			*
196			* Erases entries in all known indexes. Locking is handled internally.
197			*
198			* @param string $page name of the page to index
			0 ignored issues – show Bug introduced 2020-09-25 08:23 UTC by Report Bug Copy Issue Report There is no parameter named `$page`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
199			* @param bool $verbose print status messages
200			* @param bool $force force reindexing even when the index is up to date
201			* @return bool If the function completed successfully
202			*
203			* @throws IndexAccessException
204			* @throws IndexLockException
205			* @throws IndexWriteException
206			* @author Satoshi Sahara <[email protected]>
207			* @author Tom N Harris <[email protected]>
208			*/
209			public function deletePage($verbose = false, $force = false)
210			{
211			if (!isset($this->page)) {
212			throw new IndexAccessException('Indexer: invalid page name in deletePage');
213			} else {
214			$page = $this->page;
215			}
216
217			$idxtag = metaFN($page,'.indexed');
218			if (!$force && !file_exists($idxtag)) {
219			if ($verbose) dbglog("Indexer: {$page}.indexed file does not exist, ignoring");
220			return true;
221			}
222
223			// retrieve pid from the page.idx file, $pid is always integer
224			$pid = $this->getPID($page);
225
226			// remove obsoleted content from Fulltext index
227			$result = (new FulltextIndex($pid))->deleteWords();
228			if ($verbose) dbglog("Indexer: deleteWords() for {$page} done");
229			if (!$result) {
230			return false;
231			}
232
233			// delete all keys of the page from metadata index
234			$result = (new MetadataIndex($pid))->deleteMetaKeys();
235			if ($verbose) dbglog("Indexer: deleteMetaKeys() for {$page} done");
236			if (!$result) {
237			return false;
238			}
239
240			// mark the page as deleted in the page.idx
241			$this->lock();
242			$this->saveIndexKey('page', '', $pid, self::INDEX_MARK_DELETED.$page);
243			if ($verbose) dbglog("Indexer: {$page} has marked as deleted in page.idx");
244			$this->unlock();
245
246			unset(static::$pidCache[$pid]);
247			@unlink($idxtag);
248			return $result;
249			}
250
251			/**
252			* Rename a page in the search index without changing the indexed content.
253			* This function doesn't check if the old or new name exists in the filesystem.
254			* It returns an error if the old page isn't in the page list of the indexer
255			* and it deletes all previously indexed content of the new page.
256			*
257			* @param string $oldpage The old page name
258			* @param string $newpage The new page name
259			* @return bool If the page was successfully renamed
260			* @throws IndexLockException
261			* @throws IndexWriteException
262			*/
263			public function renamePage($oldpage, $newpage)
264			{
265			$index = $this->getIndex('page', '');
266			// check if oldpage found in page.idx
267			$oldPid = array_search($oldpage, $index, true);
268			if ($oldPid === false) return false;
269
270			// check if newpage found in page.idx
271			$newPid = array_search($newpage, $index, true);
272			if ($newPid !== false) {
273			$result = (new Indexer($newpage))->deletePage();
274			if (!$result) return false;
275			// Note: $index is no longer valid after deletePage()!
276			unset($index);
277			}
278
279			// update page.idx
280			$this->lock();
281			$this->saveIndexKey('page', '', $oldPid, $newpage);
282			$this->unlock();
283
284			// reset the pid cache
285			$this->resetPIDCache();
286
287			return true;
288			}
289
290			/**
291			* Clear the Page Index
292			*
293			* @param bool $requireLock should be false only if the caller is resposible for index lock
294			* @return bool If the index has been cleared successfully
295			* @throws Exception\IndexLockException
296			*/
297			public function clear($requireLock = true)
298			{
299			global $conf;
300
301			if ($requireLock) $this->lock();
302
303			// clear Metadata Index
304			(new MetadataIndex())->clear(false);
305
306			// clear Fulltext Index
307			(new FulltextIndex())->clear(false);
308
309			@unlink($conf['indexdir'].'/page.idx');
310
311			// clear the pid cache
312			$this->resetPIDCache();
313
314			if ($requireLock) $this->unlock();
315			return true;
316			}
317
318			}
319

splitbrain / dokuwiki

Pull Request — master (#2943)

Indexer::addMetaKeys() F

Complexity

Size

Duplication

Importance

1 Method

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like