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         $q             = strtolower($q);
 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             $terms = preg_split('/[\s,]+/', $q);
 118             $this->elementStart('ul', array('class' => 'notices'));
 119             for ($i = 0; $i < min($cnt, NOTICES_PER_PAGE); $i++) {
 120                 if ($notice->fetch()) {
 121                     $this->showNotice($notice, $terms);
 122                 } else {
 123                     // shouldn't happen!
 124                     break;
 125                 }
 126             }
 127             $this->elementEnd('ul');
 128         } else {
 129             $this->element('p', 'error', _('No results'));
 130         }
 131
 132         $this->pagination($page > 1, $cnt > NOTICES_PER_PAGE,
 133                           $page, 'noticesearch', array('q' => $q));
 134     }
 135
 136     /**
 137      * Show notice
 138      *
 139      * @param class $notice notice
 140      * @param array $terms  terms to highlight
 141      *
 142      * @return void
 143      *
 144      * @todo refactor and combine with StreamAction::showNotice()
 145      */
 146     function showNotice($notice, $terms)
 147     {
 148         $profile = $notice->getProfile();
 149         if (!$profile) {
 150             common_log_db_error($notice, 'SELECT', __FILE__);
 151             $this->serverError(_('Notice without matching profile'));
 152             return;
 153         }
 154         // XXX: RDFa
 155         $this->elementStart('li', array('class' => 'hentry notice',
 156                                           'id' => 'notice-' . $notice->id));
 157
 158         $this->elementStart('div', 'entry-title');
 159         $this->elementStart('span', 'vcard author');
 160         $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
 161         $this->elementStart('a', array('href' => $profile->profileurl,
 162                                        'class' => 'url'));
 163         $this->element('img', array('src' => ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_STREAM_SIZE),
 164                                     'class' => 'avatar photo',
 165                                     'width' => AVATAR_STREAM_SIZE,
 166                                     'height' => AVATAR_STREAM_SIZE,
 167                                     'alt' =>
 168                                     ($profile->fullname) ? $profile->fullname :
 169                                     $profile->nickname));
 170         $this->element('span', 'nickname fn', $profile->nickname);
 171         $this->elementEnd('a');
 172         $this->elementEnd('span');
 173
 174         // FIXME: URL, image, video, audio
 175         $this->elementStart('p', array('class' => 'entry-content'));
 176         if ($notice->rendered) {
 177             $this->raw($this->highlight($notice->rendered, $terms));
 178         } else {
 179             // XXX: may be some uncooked notices in the DB,
 180             // we cook them right now. This should probably disappear in future
 181             // versions (>> 0.4.x)
 182             $this->raw($this->highlight(common_render_content($notice->content, $notice), $terms));
 183         }
 184         $this->elementEnd('p');
 185         $this->elementEnd('div');
 186
 187         $noticeurl = common_local_url('shownotice', array('notice' => $notice->id));
 188         $this->elementStart('div', 'entry-content');
 189         $this->elementStart('dl', 'timestamp');
 190         $this->element('dt', null, _('Published'));
 191         $this->elementStart('dd', null);
 192         $this->elementStart('a', array('rel' => 'bookmark',
 193                                        'href' => $noticeurl));
 194         $dt = common_date_iso8601($notice->created);
 195         $this->element('abbr', array('class' => 'published',
 196                                           'title' => $dt),
 197                             common_date_string($notice->created));
 198         $this->elementEnd('a');
 199         $this->elementEnd('dd');
 200         $this->elementEnd('dl');
 201
 202         if ($notice->reply_to) {
 203             $replyurl = common_local_url('shownotice',
 204                                          array('notice' => $this->notice->reply_to));
 205             $this->elementStart('dl', 'response');
 206             $this->element('dt', null, _('To'));
 207             $this->elementStart('dd');
 208             $this->element('a', array('href' => $replyurl,
 209                                            'rel' => 'in-reply-to'),
 210                                 _('in reply to'));
 211             $this->elementEnd('dd');
 212             $this->elementEnd('dl');
 213         }
 214         $this->elementEnd('div');
 215
 216         $this->elementStart('div', 'notice-options');
 217
 218         $reply_url = common_local_url('newnotice',
 219                                       array('replyto' => $profile->nickname));
 220
 221         $this->elementStart('dl', 'notice_reply');
 222         $this->element('dt', null, _('Reply to this notice'));
 223         $this->elementStart('dd');
 224         $this->elementStart('a', array('href' => $reply_url,
 225                                        'title' => _('Reply to this notice')));
 226         $this->text(_('Reply'));
 227         $this->element('span', 'notice_id', $notice->id);
 228         $this->elementEnd('a');
 229         $this->elementEnd('dd');
 230         $this->elementEnd('dl');
 231         $this->elementEnd('div');
 232         $this->elementEnd('li');
 233     }
 234
 235     /**
 236      * Highlist query terms
 237      *
 238      * @param string $text  notice text
 239      * @param array  $terms terms to highlight
 240      *
 241      * @return void
 242      */
 243     function highlight($text, $terms)
 244     {
 245         /* Highligh serach terms */
 246         $pattern = '/('.implode('|', array_map('htmlspecialchars', $terms)).')/i';
 247         $result  = preg_replace($pattern, '<strong>\\1</strong>', $text);
 248
 249         /* Remove highlighting from inside links, loop incase multiple highlights in links */
 250         $pattern = '/(href="[^"]*)<strong>('.implode('|', array_map('htmlspecialchars', $terms)).')<\/strong>([^"]*")/iU';
 251         do {
 252             $result = preg_replace($pattern, '\\1\\2\\3', $result, -1, $count);
 253         } while ($count);
 254         return $result;
 255     }
 256
 257     function isReadOnly()
 258     {
 259         return true;
 260     }
 261 }
 262