Better core search

_test/tests/inc/fulltext_query.test.php

@@ -0,0 +1,104 @@
+<?php
+
+// must be run within Dokuwiki
+if (!defined('DOKU_INC')) {
+    die();
+}
+
+/**
+ * Test cases for the link index
+ *
+ * @author Michael Große <grosse@cosmocode.de>
+ *
+ * @group  fulltext
+ */
+class fulltext_query_test extends DokuWikiTest
+{
+    public function test_parse_query()
+    {
+        $Indexer = idx_get_indexer();
+        $inputQuery = 'test -baz "foo bar" @abc ^def';
+
+        $actualParsedQuery = ft_queryParser($Indexer, $inputQuery);
+
+        $expectedParsedQuery = [
+            'query' => 'test -baz "foo bar" @abc ^def',
+            'parsed_str' => '(W+:test)ANDNOT((W-:baz))AND((W_:foo)AND(W_:bar)AND(P+:foo bar))AND(N+:abc)ANDNOT(N-:def)',
+            'parsed_ary' => [
+                'W+:test',
+                'W-:baz',
+                'NOT',
+                'AND',
+                'W_:foo',
+                'W_:bar',
+                'AND',
+                'P+:foo bar',
+                'AND',
+                'AND',
+                'N+:abc',
+                'AND',
+                'N-:def',
+                'NOT',
+                'AND',
+            ],
+            'words' => [
+                'test',
+                'baz',
+                'foo',
+                'bar',
+            ],
+            'highlight' => [
+                'test',
+                'foo bar',
+            ],
+            'and' => [
+                'test',
+            ],
+            'phrases' => [
+                'foo bar',
+            ],
+            'ns' => [
+                'abc',
+            ],
+            'notns' => [
+                'def',
+            ],
+            'not' => [
+                'baz',
+            ],
+        ];
+        $this->assertEquals($expectedParsedQuery, $actualParsedQuery);
+    }
+
+    public function test_unparse_query()
+    {
+        $input = [
+            'and' => [
+                'test',
+            ],
+            'not' => [
+                'baz'
+            ],
+            'phrases' => [
+                'foo bar',
+            ],
+            'ns' => [
+                'abc',
+            ],
+            'notns' => [
+                'def'
+            ],
+        ];
+
+        $actualQuery = ft_queryUnparser_simple(
+            $input['and'],
+            $input['not'],
+            $input['phrases'],
+            $input['ns'],
+            $input['notns']
+        );
+
+        $expectedQuery = 'test -baz "foo bar" @abc ^def';
+        $this->assertEquals($expectedQuery, $actualQuery);
+    }
+}

conf/dokuwiki.php

@@ -156,6 +156,8 @@
 $conf['xsendfile']   = 0;                //Use X-Sendfile (1 = lighttpd, 2 = standard)
 $conf['renderer_xhtml'] = 'xhtml';       //renderer to use for main page generation
 $conf['readdircache'] = 0;               //time cache in second for the readdir operation, 0 to deactivate.
+$conf['search_limit_to_first_ns'] = 0;   //Option to limit the search to the current X namespaces
+$conf['search_default_fragment_behaviour'] = 'exact'; // Option to specify the default fragment search behavior
 
 /* Network Settings */
 $conf['dnslookups'] = 1;                 //disable to disallow IP to hostname lookups

doku.php

@@ -35,7 +35,7 @@
 
 //import variables
 $INPUT->set('id', str_replace("\xC2\xAD", '', $INPUT->str('id'))); //soft-hyphen
-$QUERY          = trim($INPUT->str('id'));
+$QUERY          = trim($INPUT->str('q'));
 $ID             = getID();
 
 $REV   = $INPUT->int('rev');

inc/Action/Search.php

@@ -13,6 +13,10 @@
  */
 class Search extends AbstractAction {
 
+    protected $pageLookupResults = array();
+    protected $fullTextResults = array();
+    protected $highlight = array();
+
     /** @inheritdoc */
     public function minimumPermission() {
         return AUTH_NONE;
@@ -25,13 +29,107 @@ public function minimumPermission() {
      */
     public function checkPermissions() {
         parent::checkPermissions();
-        global $QUERY;
+    }
+
+    public function preProcess()
+    {
+        global $QUERY, $ID, $conf, $INPUT;
         $s = cleanID($QUERY);
-        if($s === '') throw new ActionAbort();
+
+        if ($ID !== $conf['start'] && !$INPUT->has('q')) {
+            parse_str($INPUT->server->str('QUERY_STRING'), $urlParts);
+            $urlParts['q'] = $urlParts['id'];
+            $urlParts['id'] = $conf['start'];
+            $url = DOKU_URL . DOKU_SCRIPT . '?' . http_build_query($urlParts, null, '&');
+            send_redirect($url);
+        }
+
+        if ($s === '') throw new ActionAbort();
+        $this->adjustGlobalQuery();
     }
 
     /** @inheritdoc */
-    public function tplContent() {
-        html_search();
+    public function tplContent()
+    {
+        $this->execute();
+
+        $search = new \dokuwiki\Ui\Search($this->pageLookupResults, $this->fullTextResults, $this->highlight);
+        $search->show();
+    }
+
+
+    /**
+     * run the search
+     */
+    protected function execute()
+    {
+        global $INPUT, $QUERY;
+        $after = $INPUT->str('min');
+        $before = $INPUT->str('max');
+        $this->pageLookupResults = ft_pageLookup($QUERY, true, useHeading('navigation'), $after, $before);
+        $this->fullTextResults = ft_pageSearch($QUERY, $highlight, $INPUT->str('srt'), $after, $before);
+        $this->highlight = $highlight;
+    }
+
+    /**
+     * Adjust the global query accordingly to the config search_limit_to_first_ns and search_default_fragment_behaviour
+     *
+     * This will only do something if the search didn't originate from the form on the searchpage itself
+     */
+    protected function adjustGlobalQuery()
+    {
+        global $conf, $INPUT, $QUERY, $ID;
+
+        if ($INPUT->bool('sf')) {
+            return;
+        }
+
+        $Indexer = idx_get_indexer();
+        $parsedQuery = ft_queryParser($Indexer, $QUERY);
+
+        if (empty($parsedQuery['ns']) && empty($parsedQuery['notns'])) {
+            if ($conf['search_limit_to_first_ns'] > 0) {
+                if (getNS($ID) !== false) {
+                    $nsParts = explode(':', getNS($ID));
+                    $ns = implode(':', array_slice($nsParts, 0, $conf['search_limit_to_first_ns']));
+                    $QUERY .= " @$ns";
+                }
+            }
+        }
+
+        if ($conf['search_default_fragment_behaviour'] !== 'exact') {
+            if (empty(array_diff($parsedQuery['words'], $parsedQuery['and']))) {
+                if (strpos($QUERY, '*') === false) {
+                    $queryParts = explode(' ', $QUERY);
+                    $queryParts = array_map(function ($part) {
+                        if (strpos($part, '@') === 0) {
+                            return $part;
+                        }
+                        if (strpos($part, 'ns:') === 0) {
+                            return $part;
+                        }
+                        if (strpos($part, '^') === 0) {
+                            return $part;
+                        }
+                        if (strpos($part, '-ns:') === 0) {
+                            return $part;
+                        }
+
+                        global $conf;
+
+                        if ($conf['search_default_fragment_behaviour'] === 'starts_with') {
+                            return $part . '*';
+                        }
+                        if ($conf['search_default_fragment_behaviour'] === 'ends_with') {
+                            return '*' . $part;
+                        }
+
+                        return '*' . $part . '*';
+
+                    }, $queryParts);
+                    $QUERY = implode(' ', $queryParts);
+                }
+            }
+        }
     }
 }

inc/Form/Form.php

@@ -24,8 +24,9 @@ class Form extends Element {
      * Creates a new, empty form with some default attributes
      *
      * @param array $attributes
+     * @param bool  $unsafe     if true, then the security token is ommited
      */
-    public function __construct($attributes = array()) {
+    public function __construct($attributes = array(), $unsafe = false) {
         global $ID;
 
         parent::__construct('form', $attributes);
@@ -49,7 +50,9 @@ public function __construct($attributes = array()) {
         }
 
         // add the security token by default
-        $this->setHiddenField('sectok', getSecurityToken());
+        if (!$unsafe) {
+            $this->setHiddenField('sectok', getSecurityToken());
+        }
 
         // identify this as a new form based form in HTML
         $this->addClass('doku_form');
@@ -78,6 +81,20 @@ public function elementCount() {
         return count($this->elements);
     }
 
+    /**
+     * Get the position of the element in the form or false if it is not in the form
+     *
+     * Warning: This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.
+     *
+     * @param Element $element
+     *
+     * @return false|int
+     */
+    public function getElementPosition(Element $element)
+    {
+        return array_search($element, $this->elements, true);
+    }
+
     /**
      * Returns a reference to the element at a position.
      * A position out-of-bounds will return either the

inc/Menu/Item/Edit.php

@@ -18,7 +18,7 @@ public function __construct() {
 
         parent::__construct();
 
-        if($ACT == 'show' || $ACT == 'search') {
+        if($ACT === 'show') {
             $this->method = 'post';
             if($INFO['writable']) {
                 $this->accesskey = 'e';