xref: /dokuwiki/inc/Action/Search.php (revision 6639a1525ac28f6954201966800d5bda77726c4a)

<?php

namespace dokuwiki\Action;

use dokuwiki\Action\Exception\ActionAbort;

/**
 * Class Search
 *
 * Search for pages and content
 *
 * @package dokuwiki\Action
 */
class Search extends AbstractAction {

    protected $pageLookupResults = array();
    protected $fullTextResults = array();
    protected $highlight = array();

    /** @inheritdoc */
    public function minimumPermission() {
        return AUTH_NONE;
    }

    /**
     * we only search if a search word was given
     *
     * @inheritdoc
     */
    public function checkPermissions() {
        parent::checkPermissions();
    }

    public function preProcess()
    {
        global $QUERY, $ID, $conf, $INPUT;
        $s = cleanID($QUERY);

        if ($ID !== $conf['start'] && $s === '') {
            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()
    {
        $this->execute();

        $search = new \dokuwiki\Ui\Search($this->pageLookupResults, $this->fullTextResults, $this->highlight);
        $search->show();
    }


    /**
     * run the search
     */
    protected function execute()
    {
        global $INPUT, $QUERY;
        $this->pageLookupResults = ft_pageLookup($QUERY, true, useHeading('navigation'));
        $this->fullTextResults = ft_pageSearch($QUERY, $highlight, $INPUT->str('sort'));
        $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;

        if ($INPUT->bool('searchPageForm')) {
            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) {
                $searchOriginPage = $INPUT->str('from');
                if (getNS($searchOriginPage) !== false) {
                    $nsParts = explode(':', getNS($searchOriginPage));
                    $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);
                }
            }
        }
    }
}