xref: /plugin/sphinxsearch-was/action.php (revision 134:2b68d17b7916)

<?php
/**
 * Script to search in dokuwiki documents
 *
 * @author Ivinco <opensource@ivinco.com>
 */

if (!defined('DOKU_INC')) die();
if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');

require_once(DOKU_INC . 'inc/parser/parser.php');

require_once(DOKU_PLUGIN . 'action.php');
require_once(DOKU_PLUGIN . 'sphinxsearch/sphinxapi.php');
require_once(DOKU_PLUGIN . 'sphinxsearch/PageMapper.php');
require_once(DOKU_PLUGIN . 'sphinxsearch/SphinxSearch.php');
require_once(DOKU_PLUGIN . 'sphinxsearch/functions.php');


class action_plugin_sphinxsearch extends DokuWiki_Action_Plugin
{
    var $_search = null;

    var $_helpMessage = '';
    var $_versionNumber = '0.3.11-was1';

    /**
     * return some info
     */
    function getInfo()
    {
        return confToHash(dirname(__FILE__) . '/plugin.info.txt');
    }

    function getHelpInfo()
    {
        $this->_helpMessage = "
====== DokuWiki Sphinx Search plugin features ======

To use the search you need to just enter your search keywords into the searchbox at the top right corner of the DokuWiki. When basic simple search is not enough you can try using the methods listed below:

===== Phrase search (\"\") =====
Put double quotes around a set of words to enable phrase search mode. For example:
<code>\"James Bond\"</code>

===== Search within a namespace =====
You can add \"@ns\" parameter to limit the search to some namespace. For exapmle:
<code>hotel @ns personal:mike:travel</code>
Such query will return only results from \"personal:mike:travel\" namespace for keyword \"hotel\".

===== Excluding keywords or namespaces from search =====
You can add a minus sign to a keyword or a category name exclude it from search. For example:
<code>hotel @ns -personal:mike</code>
Such query will look for \"hotel\" everywhere except the \"personal:mike\" namespace.
<code>blog -post</code>
Such query will look for documents that have keyword \"blog\" but don't have keyword \"post\".

";
        if ($this->getConf('showversion')) {
            $this->_helpMessage .= "DokuWiki Sphinx Search plugin (version $this->_versionNumber) by [[http://www.ivinco.com/software/dokuwiki-sphinx-search-plugin/|Ivinco]].";
        }
        return $this->_helpMessage;
    }

    /**
     * Register to the content display event to place the results under it.
     */
    /**
     * register the eventhandlers
     */
    function register(Doku_Event_Handler $controller)
    {
        $controller->register_hook('TPL_CONTENT_DISPLAY',   'BEFORE', $this, 'handle_act_unknown', array());
    }

    /**
     * If our own action was given we produce our content here
     */
    function handle_act_unknown(&$event, $param)
    {
        global $ACT;
        global $QUERY;
        if ($ACT != 'search') return; // nothing to do for us

        // we can handle it -> prevent others
        $event->stopPropagation();
        $event->preventDefault();

        /*        if (!extension_loaded('sqlite')) {
            echo "SQLite extension is not loaded!";
            return;
        }*/

        if (!empty($_REQUEST['ssplugininfo'])) {
            $info = array();
            echo p_render('xhtml', p_get_instructions($this->getHelpInfo()), $info);
            return;
        }

        $this->_search($QUERY, $_REQUEST['start'], $_REQUEST['prev']);
    }

    /**
     * do the search and displays the result
     */
    function _search($query, $start, $prev)
    {
        global $conf;

        $start = (int)$start;
        if ($start < 0) {
            $start = 0;
        }
        if (empty($prev)) {
            $prev = 0;
        }

        $categories = $this->_getCategories($query);
        $keywords = $this->_getKeywords($query);

        $search = new SphinxSearch($this->getConf('host'), $this->getConf('port'), $this->getConf('index'));
        $search->setSnippetSize($this->getConf('snippetsize'));
        $search->setArroundWordsCount($this->getConf('aroundwords'));
        $search->setTitlePriority($this->getConf('title_priority'));
        $search->setBodyPriority($this->getConf('body_priority'));
        $search->setNamespacePriority($this->getConf('namespace_priority'));
        $search->setPagenamePriority($this->getConf('pagename_priority'));

        if (!empty($keywords) && empty($categories)) {
            $search->setSearchAllQuery($keywords, $categories);
        } elseif (!empty($keywords)) {
            $search->setSearchAllQueryWithCategoryFilter($keywords, $categories);
        } else {
            echo 'Your search - <strong>' . $query . '</strong> - did not match any documents.<br>
                <a href="?do=search&ssplugininfo=1&id=' . $query . '">Search help</a>';
            return;
        }
        $result = $search->search($start, $this->getConf('maxresults'));
        $this->_search = $search;

        if ($search->getError()) {
            echo "Could not connect to Sphinx search engine.";
            return;
        }

        if (!$result) {
            echo 'Your search - <strong>' . $query . '</strong> - did not match any documents.<br/>
                <a href="?do=search&ssplugininfo=1&id=' . $query . '">Search help</a>';
            return;
        }

        $pagesList = $search->getPages($keywords);
        $totalFound = $search->getTotalFound();

        if (empty($pagesList) || 0 == $totalFound) {
            echo 'Your search - <strong>' . $query . '</strong> - did not match any documents.<br/>
                <a href="?do=search&ssplugininfo=1&id=' . $query . '">Search help</a>';
            return;
        } else {
            echo '<link rel="stylesheet" href="' . DOKU_URL . 'lib/plugins/sphinxsearch/css/style.css">';
            echo '<script type="text/javascript" src="' . DOKU_URL . 'lib/plugins/sphinxsearch/js/search.js"></script>';
            echo '<div class="search">';
            echo '<div class="search_sidebar">';
            echo '<h1>Pages Containing Search Terms</h1>';
            printNamespacesNew($this->_getMatchingPagenames($keywords, $categories));
            echo '</div>';
            echo '<h1>Found ' . $totalFound . ($totalFound == 1  ? ' match ' : ' matches ') . ' for query "' . hsc($query) . '"</h1>';
            echo '<div class="search_result">';
            // printout the results
            $pageListGroupByPage = array();
            foreach ($pagesList as $row) {
                $page = $row['page'];
                if (!isset($pageListGroupByPage[$page])) {
                    $pageListGroupByPage[$page] = $row;
                } else {
                    $pageListGroupByPage[$page]['subpages'][] = $row;
                }
            }
            foreach ($pageListGroupByPage as $row) {
                $this->_showResult($row, $keywords, false);
                if (!empty($row['subpages'])) {
                    echo '<div id="more' . $row['page'] . '" class="hide">';
                    foreach ($row['subpages'] as $sub) {
                        $this->_showResult($sub, $keywords, true);
                    }
                    echo '</div>';
                }
            }
            echo '</div>';
            echo '<div class="sphinxsearch_nav">';
            echo '<a class="searchhelp" href="?do=search&ssplugininfo=1&id=' . $query . '">Search help</a>';
            if ($start > 1) {
                if (false !== strpos($prev, ',')) {
                    $prevArry = explode(",", $prev);
                    $prevNum = $prevArry[count($prevArry) - 1];
                    unset($prevArry[count($prevArry) - 1]);
                    $prevString = implode(",", $prevArry);
                } else {
                    $prevNum = 0;
                }

                echo $this->external_link(
                    wl('', array('do' => 'search', 'id' => $query, 'start' => $prevNum, 'prev' => $prevString), 'false', '&'),
                    'prev',
                    'wikilink1 gs_prev',
                    $conf['target']['interwiki']
                );
            }

            echo ' ';

            //if($start + $this->getConf('maxresults') < $totalFound){
            //$next = $start + $this->getConf('maxresults');
            if ($start + $search->getOffset() < $totalFound) {
                $next = $start + $search->getOffset();
                if ($start > 1) {
                    $prevString = $prev . ',' . $start;
                }
                echo $this->external_link(
                    wl('', array('do' => 'search', 'id' => $query, 'start' => $next, 'prev' => $prevString), 'false', '&'),
                    'next',
                    'wikilink1 gs_next',
                    $conf['target']['interwiki']
                );
            }
            echo '</div>';
            if ($this->getConf('showversion')) {
                echo 'DokuWiki Sphinx Search plugin (version ' . $this->_versionNumber . ') by <a href="http://www.ivinco.com/software/dokuwiki-sphinx-search-plugin/">Ivinco</a>.';
            }
            echo '</div>';
        }
    }

    function _showResult($row, $keywords, $subpages = false)
    {
        $page = $row['page'];
        $bodyExcerpt = $row['bodyExcerpt'];
        $titleTextExcerpt = $row['titleTextExcerpt'];
        $hid = $row['hid'];

        $metaData = p_get_metadata($page);

        if (!empty($titleTextExcerpt)) {
            $titleText = $titleTextExcerpt;
        } elseif (!empty($row['title_text'])) {
            $titleText = $row['title_text'];
        } elseif (!empty($metaData['title'])) {
            $titleText = hsc($metaData['title']);
        } else {
            $titleText = hsc($page);
        }

        $namespaces = getNsLinks($page, $keywords, $this->_search);
        $href = !empty($hid) ? (wl($page) . '#' . $hid) : wl($page);

        if ($subpages) {
            echo '<div class="search_result_row_child">';
        } else {
            echo '<div class="search_result_row">';
        }

        echo '<a class="wikilink1 title" href="' . $href . '" title="" >' . $titleText . '</a><br/>';
        echo '<div class="search_snippet">';
        echo strip_tags($bodyExcerpt, '<b>,<strong>');
        echo '</div>';
        $sep = ':';
        $i = 0;
        echo '<span class="search_nmsp">';
        foreach ($namespaces as $name) {
            $link = $name['link'];
            $pageTitle = $name['title'];
            tpl_link($link, $pageTitle);
            if ($i++ < count($namespaces) - 1) {
                echo $sep;
            }
        }
        if (!empty($hid)) {
            echo '#' . $hid;
        }
        echo '</span>';

        if (!empty($metaData['last_change']['date'])) {
            echo '<span class="search_cnt"> - Last modified ' . date("Y-m-d H:i", $metaData['last_change']['date']) . '</span> ';
        } else if (!empty($metaData['date']['created'])) {
            echo '<span class="search_cnt"> - Last modified ' . date("Y-m-d H:i", $metaData['date']['created']) . '</span> ';
        }

        if (!empty($metaData['last_change']['user'])) {
            echo '<span class="search_cnt">by ' . $metaData['last_change']['user'] . '</span> ';
        } else if (!empty($metaData['creator'])) {
            echo '<span class="search_cnt">by ' . $metaData['creator'] . '</span> ';
        }

        if (!empty($row['subpages'])) {
            echo '<br />';
            echo '<div class="morematches"><a href="javascript:void(0)" onClick="sh(' . "'more" . $page . "'" . ');" >Show more matches from this document</a></div>';
        } else {
            echo '<br />';
        }
        echo '<br />';
        echo '</div>';
    }

    function searchform()
    {
        global $lang;
        global $ACT;
        global $QUERY;

        // don't print the search form if search action has been disabled
        if (!actionOk('search')) return false;

        print '<form action="' . wl() . '" accept-charset="utf-8" class="search" id="dw__search"><div class="no">';
        print '<input type="hidden" name="do" value="search" />';
        print '<input type="text" ';
        if ($ACT == 'search') print 'value="' . htmlspecialchars($QUERY) . '" ';
        print 'id="qsearch__in" accesskey="f" name="id" class="edit" title="[ALT+F]" />';
        print '<input type="submit" value="' . $lang['btn_search'] . '" class="button" title="' . $lang['btn_search'] . '" />';
        print '</div></form>';
        return true;
    }

    function _getCategories($query)
    {
        $categories = '';
        $query = urldecode($query);
        if (false !== ($pos = strpos($query, "@ns"))) {;
            $categories = substr($query, $pos + strlen("@ns"));
        }
        return trim($categories);
    }

    function _getKeywords($query)
    {
        $keywords = $query;
        $query = urldecode($query);
        if (false !== ($pos = strpos($query, "-@ns"))) {;
            $keywords = substr($keywords, 0, $pos);
        } else if (false !== ($pos = strpos($query, "@ns"))) {;
            $keywords = substr($keywords, 0, $pos);
        }
        return trim($keywords);
    }

    function _getMatchingPagenames($keywords, $categories)
    {
        //$this->_search->setSearchCategoryQuery($keywords, $categories);
        $this->_search->setSearchOnlyPagename();
        $this->_search->setNamespacePriority($this->getConf('mp_namespace_priority'));
        $this->_search->setPagenamePriority($this->getConf('mp_pagename_priority'));

        $res = $this->_search->search(0, 10);
        if (!$res) {
            return false;
        }

        return $this->_search->getPageNames();
    }
}