actions/noticesearch.php

   1 <?php
   2 /**
   3  * Notice search action class.
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  Laconica
   9  * @author   Evan Prodromou <evan@controlyourself.ca>
  10  * @author   Robin Millette <millette@controlyourself.ca>
  11  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  12  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  13  * @link     http://laconi.ca/
  14  *
  15  * Laconica - a distributed open-source microblogging tool
  16  * Copyright (C) 2008, Controlez-Vous, Inc.
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU Affero General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU Affero General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU Affero General Public License
  29  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  30  */
  31
  32 if (!defined('LACONICA')) {
  33     exit(1);
  34 }
  35
  36 require_once INSTALLDIR.'/lib/searchaction.php';
  37
  38 /**
  39  * Notice search action class.
  40  *
  41  * @category Action
  42  * @package  Laconica
  43  * @author   Evan Prodromou <evan@controlyourself.ca>
  44  * @author   Robin Millette <millette@controlyourself.ca>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  46  * @link     http://laconi.ca/
  47  * @todo     common parent for people and content search?
  48  */
  49 class NoticesearchAction extends SearchAction
  50 {
  51
  52     function prepare($args)
  53     {
  54         parent::prepare($args);
  55
  56         common_set_returnto($this->selfUrl());
  57
  58         return true;
  59     }
  60
  61     /**
  62      * Get instructions
  63      *
  64      * @return string instruction text
  65      */
  66     function getInstructions()
  67     {
  68         return _('Search for notices on %%site.name%% by their contents. Separate search terms by spaces; they must be 3 characters or more.');
  69     }
  70
  71     /**
  72      * Get title
  73      *
  74      * @return string title
  75      */
  76     function title()
  77     {
  78         return _('Text search');
  79     }
  80
  81     function getFeeds()
  82     {
  83         $q = $this->trimmed('q');
  84
  85         if (!$q) {
  86             return null;
  87         }
  88
  89         return array(new Feed(Feed::RSS1, common_local_url('noticesearchrss',
  90                                                            array('q' => $q)),
  91                               sprintf(_('Search results for "%s" on %s'),
  92                                       $q, common_config('site', 'name'))));
  93     }
  94
  95     /**
  96      * Show results
  97      *
  98      * @param string  $q    search query
  99      * @param integer $page page number
 100      *
 101      * @return void
 102      */
 103     function showResults($q, $page)
 104     {
 105         $notice        = new Notice();
 106
 107         $search_engine = $notice->getSearchEngine('identica_notices');
 108         $search_engine->set_sort_mode('chron');
 109         // Ask for an extra to see if there's more.
 110         $search_engine->limit((($page-1)*NOTICES_PER_PAGE), NOTICES_PER_PAGE + 1);
 111         if (false === $search_engine->query($q)) {
 112             $cnt = 0;
 113         } else {
 114             $cnt = $notice->find();
 115         }
 116         if ($cnt === 0) {
 117             $this->element('p', 'error', _('No results'));
 118             return;
 119         }
 120         $terms = preg_split('/[\s,]+/', $q);
 121         $nl = new SearchNoticeList($notice, $this, $terms);
 122
 123         $cnt = $nl->show();
 124
 125         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 126                           $this->page, 'noticesearch', array('q' => $q));
 127     }
 128     function isReadOnly()
 129     {
 130         return true;
 131     }
 132 }
 133
 134 class SearchNoticeList extends NoticeList {
 135     function __construct($notice, $out=null, $terms)
 136     {
 137         parent::__construct($notice, $out);
 138         $this->terms = $terms;
 139     }
 140
 141     function newListItem($notice)
 142     {
 143         return new SearchNoticeListItem($notice, $this->out, $this->terms);
 144     }
 145 }
 146
 147 class SearchNoticeListItem extends NoticeListItem {
 148     function __construct($notice, $out=null, $terms)
 149     {
 150         parent::__construct($notice, $out);
 151         $this->terms = $terms;
 152     }
 153
 154     function showContent()
 155     {
 156         // FIXME: URL, image, video, audio
 157         $this->out->elementStart('p', array('class' => 'entry-content'));
 158         if ($this->notice->rendered) {
 159             $this->out->raw($this->highlight($this->notice->rendered, $this->terms));
 160         } else {
 161             // XXX: may be some uncooked notices in the DB,
 162             // we cook them right now. This should probably disappear in future
 163             // versions (>> 0.4.x)
 164             $this->out->raw($this->highlight(common_render_content($this->notice->content, $this->notice), $this->terms));
 165         }
 166         $this->out->elementEnd('p');
 167
 168     }
 169
 170     /**
 171      * Highlist query terms
 172      *
 173      * @param string $text  notice text
 174      * @param array  $terms terms to highlight
 175      *
 176      * @return void
 177      */
 178     function highlight($text, $terms)
 179     {
 180         /* Highligh search terms */
 181         $pattern = '/('.implode('|', array_map('htmlspecialchars', $terms)).')/i';
 182         $result  = preg_replace($pattern, '<strong>\\1</strong>', $text);
 183
 184         /* Remove highlighting from inside links, loop incase multiple highlights in links */
 185         $pattern = '/(href="[^"]*)<strong>('.implode('|', array_map('htmlspecialchars', $terms)).')<\/strong>([^"]*")/iU';
 186         do {
 187             $result = preg_replace($pattern, '\\1\\2\\3', $result, -1, $count);
 188         } while ($count);
 189         return $result;
 190     }
 191 }
 192