xref: /plugin/sphinxsearch-was/action.php (revision 18:fcbacaf89c61) 
1<?php
2/**
3 * Script to search in dokuwiki documents
4 *
5 * @author Yaroslav Vorozhko <yaroslav@ivinco.com>
6 */
7
8if(!defined('DOKU_INC')) die();
9if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
10
11require_once(DOKU_INC.'inc/parser/parser.php');
12
13require_once(DOKU_PLUGIN . 'action.php');
14require_once(DOKU_PLUGIN . 'sphinxsearch/sphinxapi.php');
15require_once(DOKU_PLUGIN . 'sphinxsearch/PageMapper.php');
16require_once(DOKU_PLUGIN . 'sphinxsearch/SphinxSearch.php');
17require_once(DOKU_PLUGIN . 'sphinxsearch/functions.php');
18
19
20class action_plugin_sphinxsearch extends DokuWiki_Action_Plugin {
21
22    /**
23	* return some info
24	*/
25    function getInfo() {
26        return confToHash(dirname(__FILE__).'/plugin.info.txt');
27	}
28
29    /**
30	* Register to the content display event to place the results under it.
31	*/
32    /**
33     * register the eventhandlers
34     */
35    function register(&$controller){
36        $controller->register_hook('ACTION_ACT_PREPROCESS',
37                                   'BEFORE',
38                                   $this,
39                                   'handle_act_preprocess',
40                                   array());
41
42        $controller->register_hook('TPL_ACT_UNKNOWN',
43                                   'BEFORE',
44                                   $this,
45                                   'handle_act_unknown',
46                                   array());
47    }
48
49    /**
50     * Checks if 'googlesearch' was given as action, if so we
51     * do handle the event our self and no further checking takes place
52     */
53    function handle_act_preprocess(&$event, $param){
54        if($event->data != 'sphinxsearch') return; // nothing to do for us
55
56        $event->stopPropagation(); // this is our very own action, no need to check other plugins
57        $event->preventDefault();  // we handle it our self, thanks
58    }
59
60    /**
61     * If our own 'googlesearch' action was given we produce our content here
62     */
63    function handle_act_unknown(&$event, $param){
64        if($event->data != 'sphinxsearch') return; // nothing to do for us
65
66        // we can handle it -> prevent others
67        $event->stopPropagation();
68        $event->preventDefault();
69
70        global $QUERY;
71        $this->_search($QUERY,$_REQUEST['start']);
72    }
73
74    /**
75     * do the search and displays the result
76     */
77    function _search($query, $start) {
78        global $conf;
79
80        $start = (int) $start;
81        if($start < 0) $start = 0;
82
83        $categories = $this->_getCategories($query);
84        $keywords = $this->_getKeywords($query);
85
86        $search = new SphinxSearch($this->getConf('host'), $this->getConf('port'), $this->getConf('index'));
87        $search->setSnippetSize($this->getConf('snippetsize'));
88        $search->setArroundWordsCount($this->getConf('arroundwords'));
89        $pagesList = $search->search($keywords, $categories, $start, $this->getConf('maxresults'));
90
91        $totalFound = $search->getTotalFound();
92        if(!$totalFound){
93            echo '<b>Nothing was found by ' . $query . '</b>!';
94            exit;
95        }
96        echo '<style type="text/css">
97            div.dokuwiki .search_snippet{
98                color:#000000;
99                margin-left:0px;
100            }
101            div.dokuwiki .search_cnt{
102                color:#CCCCCC;
103                font-size: 10px;
104            }
105            div.dokuwiki .search_nmsp{
106                font-size: 10px;
107            }
108            </style>
109            ';
110
111        echo '<h2>Found '.$totalFound . ($totalFound == 1  ? ' document ' : ' documents ') . ' for query "' . hsc($query).'"</h2>';
112	echo '<div class="search_result">';
113        // printout the results
114	foreach ($pagesList as $crc => $row) {
115            $id = $row['page'];
116            $bodyExcerpt = $row['bodyExcerpt'];
117            $titleExcerpt = $row['titleExcerpt'];
118            $hid = $row['hid'];
119            $metaData = p_get_metadata($id);
120            if (!empty($titleExcerpt)){
121                $title = $titleExcerpt;
122            } else {
123                $title = hsc($metaData['title']);
124            }
125
126            if (empty($title)){
127                $title = hsc($id);
128            }
129            $namespaces = getNsLinks($id, $keywords, $search);
130            $href = !empty($hid) ? (wl($id).'#'.$hid) : wl($id);
131
132            echo '<a href="'.$href.'" title="" class="wikilink1">'.$title.'</a><br/>';
133            echo '<div class="search_snippet">';
134            echo strip_tags($bodyExcerpt, '<b>,<strong>');
135            echo '</div>';
136            $sep=':';
137            $i = 0;
138            echo '<span class="search_nmsp">';
139            foreach ($namespaces as $name){
140                $link = $name['link'];
141                $pageTitle = $name['title'];
142                tpl_link($link, $pageTitle);
143                if ($i++ < count($namespaces)-1){
144                    echo $sep;
145                }
146            }
147            if (!empty($hid)){
148                echo '#'.$hid;
149            }
150            echo '</span>';
151            echo '<span class="search_cnt"> - Last modified '.date("Y-m-d H:i",$metaData['date']['modified']).'</span> ';
152            echo '<span class="search_cnt">by '.$metaData['last_change']['user'].'</span> ';
153            echo '<br />';echo '<br />';
154	}
155        echo '</div>';
156        echo '<div class="sphinxsearch_nav">';
157        if ($start > 1){
158            $prev = $start - $this->getConf('maxresults');
159            if($prev < 0) $prev = 0;
160
161            echo $this->external_link(wl('',array('do'=>'sphinxsearch','id'=>$query,'start'=>$prev),'false','&'),
162                                      'prev','wikilink1 gs_prev',$conf['target']['interwiki']);
163        }
164        echo ' ';
165        if($start + $this->getConf('maxresults') < $totalFound){
166            $next = $start + $this->getConf('maxresults');
167
168            echo $this->external_link(wl('',array('do'=>'sphinxsearch','id'=>$query,'start'=>$next),'false','&'),
169                                      'next','wikilink1 gs_next',$conf['target']['interwiki']);
170        }
171        echo '</div>';
172
173    }
174
175     function searchform(){
176          global $lang;
177          global $ACT;
178          global $QUERY;
179
180          // don't print the search form if search action has been disabled
181          if (!actionOk('sphinxsearch')) return false;
182
183          print '<form action="'.wl().'" accept-charset="utf-8" class="search" id="dw__search"><div class="no">';
184          print '<input type="hidden" name="do" value="sphinxsearch" />';
185          print '<input type="text" ';
186          if($ACT == 'sphinxsearch') print 'value="'.htmlspecialchars($QUERY).'" ';
187          print 'id="qsearch__in" accesskey="f" name="id" class="edit" title="[ALT+F]" />';
188          print '<input type="submit" value="'.$lang['btn_search'].'" class="button" title="'.$lang['btn_search'].'" />';
189          print '</div></form>';
190          return true;
191    }
192
193    function _getCategories($query)
194    {
195        $categories = '';
196        $query = urldecode($query);
197        if (false !== ($pos = strpos($query, "@categories"))){;
198            $categories = substr($query, $pos + strlen("@categories"));
199        }
200        return trim($categories);
201    }
202
203    function _getKeywords($query)
204    {
205        $keywords = $query;
206        $query = urldecode($query);
207        if (false !== ($pos = strpos($query, "@categories"))){;
208            $keywords = substr($keywords, 0, $pos);
209        }
210        return trim($keywords);
211    }
212}
213
214?>
215