]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/noticesearch.php
Remove unnecessary require lines and definitions
[quix0rs-gnu-social.git] / actions / noticesearch.php
index 96e4d777fa3aca01c86ea3a0d39285535e014ffd..ee7bb86f40a28f7fac5aba0dc8a848a4268c68d8 100644 (file)
@@ -1,7 +1,19 @@
 <?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Notice search action class.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Robin Millette <millette@status.net>
+ * @author   Sarven Capadisli <csarven@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/searchaction.php');
+require_once INSTALLDIR.'/lib/searchaction.php';
 
-# XXX common parent for people and content search?
+/**
+ * Notice search action class.
+ *
+ * @category Action
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Robin Millette <millette@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ * @todo     common parent for people and content search?
+ */
+class NoticesearchAction extends SearchAction
+{
+    protected $q = null;
 
-class NoticesearchAction extends SearchAction {
+    function prepare($args)
+    {
+        parent::prepare($args);
 
-       function get_instructions() {
-               return _('Search for notices on %%site.name%% by their contents. Separate search terms by spaces; they must be 3 characters or more.');
-       }
+        $this->q = $this->trimmed('q');
 
-       function get_title() {
-               return _('Text search');
-       }
+        // FIXME: very dependent on tag format
+        if (preg_match('/^#([\pL\pN_\-\.]{1,64})/ue', $this->q)) {
+            common_redirect(common_local_url('tag',
+                                             array('tag' => common_canonical_tag(substr($this->q, 1)))),
+                            303);
+        }
 
-       function show_results($q, $page) {
+        if (!empty($this->q)) {
 
-               $notice = new Notice();
+            $profile = Profile::current();
+            $stream  = new SearchNoticeStream($this->q, $profile);
+            $page    = $this->trimmed('page');
 
-               # lcase it for comparison
-               $q = strtolower($q);
+            if (empty($page)) {
+                $page = 1;
+            } else {
+                $page = (int)$page;
+            }
 
-        $search_engine = $notice->getSearchEngine('identica_notices');
+            $this->notice = $stream->getNotices((($page-1)*NOTICES_PER_PAGE), NOTICES_PER_PAGE + 1);
+        }
 
-        $search_engine->set_sort_mode('chron');
-               # Ask for an extra to see if there's more.
-               $search_engine->limit((($page-1)*NOTICES_PER_PAGE), NOTICES_PER_PAGE + 1);
+        common_set_returnto($this->selfUrl());
+
+        return true;
+    }
+
+    /**
+     * Get instructions
+     *
+     * @return string instruction text
+     */
+    function getInstructions()
+    {
+        // TRANS: Instructions for Notice search page.
+        // TRANS: %%site.name%% is the name of the StatusNet site.
+        return _('Search for notices on %%site.name%% by their contents. Separate search terms by spaces; they must be 3 characters or more.');
+    }
+
+    /**
+     * Get title
+     *
+     * @return string title
+     */
+    function title()
+    {
+        // TRANS: Title of the page where users can search for notices.
+        return _('Text search');
+    }
+
+    function getFeeds()
+    {
+        $q = $this->trimmed('q');
+
+        if (!$q) {
+            return null;
+        }
 
-        if (false === $search_engine->query($q)) {
-            $cnt = 0;
+        return array(new Feed(Feed::RSS1, common_local_url('noticesearchrss',
+                                                           array('q' => $q)),
+                              // TRANS: Test in RSS notice search.
+                              // TRANS: %1$s is the query, %2$s is the StatusNet site name.
+                              sprintf(_('Search results for "%1$s" on %2$s'),
+                                      $q, common_config('site', 'name'))));
+    }
+
+    /**
+     * Show results
+     *
+     * @param string  $q    search query
+     * @param integer $page page number
+     *
+     * @return void
+     */
+    function showResults($q, $page)
+    {
+        if (Event::handle('StartNoticeSearchShowResults', array($this, $q, $this->notice))) {
+            if ($this->notice->N === 0) {
+                $this->showEmptyResults($q, $page);
+            } else {
+                $terms = preg_split('/[\s,]+/', $q);
+                $nl = new SearchNoticeList($this->notice, $this, $terms);
+                $cnt = $nl->show();
+                $this->pagination($page > 1,
+                                  $cnt > NOTICES_PER_PAGE,
+                                  $page,
+                                  'noticesearch',
+                                  array('q' => $q));
+            }
+            Event::handle('EndNoticeSearchShowResults', array($this, $q, $this->notice));
         }
-        else {
-               $cnt = $notice->find();
+    }
+
+    function showEmptyResults($q, $page)
+    {
+            // TRANS: Text for notice search results is the query had no results.
+            $this->element('p', 'error', _('No results.'));
+
+            $this->searchSuggestions($q);
+            if (common_logged_in()) {
+                // TRANS: Text for logged in users making a query for notices without results.
+                // TRANS: This message contains a Markdown link.
+                $message = sprintf(_('Be the first to [post on this topic](%%%%action.newnotice%%%%?status_textarea=%s)!'), urlencode($q));
+            }
+            else {
+                // TRANS: Text for not logged in users making a query for notices without results.
+                // TRANS: This message contains Markdown links.
+                $message = sprintf(_('Why not [register an account](%%%%action.register%%%%) and be the first to [post on this topic](%%%%action.newnotice%%%%?status_textarea=%s)!'), urlencode($q));
+            }
+
+            $this->elementStart('div', 'guide');
+            $this->raw(common_markup_to_html($message));
+            $this->elementEnd('div');
+            return;
+    }
+
+    function showScripts()
+    {
+        parent::showScripts();
+        $this->autofocus('q');
+    }
+}
+
+class SearchNoticeList extends NoticeList {
+    function __construct($notice, $out=null, $terms)
+    {
+        parent::__construct($notice, $out);
+        $this->terms = $terms;
+    }
+
+    function newListItem($notice)
+    {
+        return new SearchNoticeListItem($notice, $this->out, $this->terms);
+    }
+}
+
+class SearchNoticeListItem extends NoticeListItem {
+    function __construct($notice, $out=null, $terms)
+    {
+        parent::__construct($notice, $out);
+        $this->terms = $terms;
+    }
+
+    function showContent()
+    {
+        // FIXME: URL, image, video, audio
+        $this->out->elementStart('p', array('class' => 'e-content'));
+        if ($this->notice->rendered) {
+            $this->out->raw($this->highlight($this->notice->rendered, $this->terms));
+        } else {
+            // XXX: may be some uncooked notices in the DB,
+            // we cook them right now. This should probably disappear in future
+            // versions (>> 0.4.x)
+            $this->out->raw($this->highlight(common_render_content($this->notice->content, $this->notice), $this->terms));
+        }
+        $this->out->elementEnd('p');
+
+    }
+
+    /**
+     * Highlist query terms
+     *
+     * @param string $text  notice text
+     * @param array  $terms terms to highlight
+     *
+     * @return void
+     */
+    function highlight($text, $terms)
+    {
+        /* Highligh search terms */
+        $options = implode('|', array_map('preg_quote', array_map('htmlspecialchars', $terms),
+                                                            array_fill(0, sizeof($terms), '/')));
+        $pattern = "/($options)/i";
+        $result = '';
+
+        /* Divide up into text (highlight me) and tags (don't touch) */
+        $chunks = preg_split('/(<[^>]+>)/', $text, 0, PREG_SPLIT_DELIM_CAPTURE);
+        foreach ($chunks as $i => $chunk) {
+            if ($i % 2 == 1) {
+                // odd: delimiter (tag)
+                $result .= $chunk;
+            } else {
+                // even: freetext between tags
+                $result .= preg_replace($pattern, '<strong>\\1</strong>', $chunk);
+            }
         }
-               if ($cnt > 0) {
-                       $terms = preg_split('/[\s,]+/', $q);
-                       common_element_start('ul', array('id' => 'notices'));
-                       for ($i = 0; $i < min($cnt, NOTICES_PER_PAGE); $i++) {
-                               if ($notice->fetch()) {
-                                       $this->show_notice($notice, $terms);
-                               } else {
-                                       // shouldn't happen!
-                                       break;
-                               }
-                       }
-                       common_element_end('ul');
-               } else {
-                       common_element('p', 'error', _('No results'));
-               }
-
-               common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
-                                                 $page, 'noticesearch', array('q' => $q));
-       }
-
-       function show_header($arr) {
-               if ($arr) {
-                       $q = $arr[0];
-               }
-               if ($q) {
-                       common_element('link', array('rel' => 'alternate',
-                                                                                'href' => common_local_url('noticesearchrss',
-                                                                                                                                       array('q' => $q)),
-                                                                                'type' => 'application/rss+xml',
-                                                                                'title' => _('Search Stream Feed')));
-               }
-       }
-
-       # XXX: refactor and combine with StreamAction::show_notice()
-
-       function show_notice($notice, $terms) {
-               $profile = $notice->getProfile();
-               if (!$profile) {
-                       common_log_db_error($notice, 'SELECT', __FILE__);
-                       $this->server_error(_('Notice without matching profile'));
-                       return;
-               }
-               # XXX: RDFa
-               common_element_start('li', array('class' => 'notice_single',
-                                                                                 'id' => 'notice-' . $notice->id));
-               $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
-               common_element_start('a', array('href' => $profile->profileurl));
-               common_element('img', array('src' => ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE),
-                                                                       'class' => 'avatar stream',
-                                                                       'width' => AVATAR_STREAM_SIZE,
-                                                                       'height' => AVATAR_STREAM_SIZE,
-                                                                       'alt' =>
-                                                                       ($profile->fullname) ? $profile->fullname :
-                                                                       $profile->nickname));
-               common_element_end('a');
-               common_element('a', array('href' => $profile->profileurl,
-                                                                 'class' => 'nickname'),
-                                          $profile->nickname);
-               # FIXME: URL, image, video, audio
-               common_element_start('p', array('class' => 'content'));
-               if ($notice->rendered) {
-                       common_raw($this->highlight($notice->rendered, $terms));
-               } else {
-                       # XXX: may be some uncooked notices in the DB,
-                       # we cook them right now. This should probably disappear in future
-                       # versions (>> 0.4.x)
-                       common_raw($this->highlight(common_render_content($notice->content, $notice), $terms));
-               }
-               common_element_end('p');
-               $noticeurl = common_local_url('shownotice', array('notice' => $notice->id));
-               common_element_start('p', 'time');
-               common_element('a', array('class' => 'permalink',
-                                                                 'href' => $noticeurl,
-                                                                 'title' => common_exact_date($notice->created)),
-                                          common_date_string($notice->created));
-               if ($notice->reply_to) {
-                       $replyurl = common_local_url('shownotice', array('notice' => $notice->reply_to));
-                       common_text(' (');
-                       common_element('a', array('class' => 'inreplyto',
-                                                                         'href' => $replyurl),
-                                                  _('in reply to...'));
-                       common_text(')');
-               }
-               common_element_start('a',
-                                                        array('href' => common_local_url('newnotice',
-                                                                                                                         array('replyto' => $profile->nickname)),
-                                                                  'onclick' => 'doreply("'.$profile->nickname.'"); return false',
-                                                                  'title' => _('reply'),
-                                                                  'class' => 'replybutton'));
-               common_hidden('posttoken', common_session_token());
-               
-               common_raw('&rarr;');
-               common_element_end('a');
-               common_element_end('p');
-               common_element_end('li');
-       }
-
-       function highlight($text, $terms) {
-               /* Highligh serach terms */
-               $pattern = '/('.implode('|',array_map('htmlspecialchars', $terms)).')/i';
-               $result = preg_replace($pattern, '<strong>\\1</strong>', $text);
-
-               /* Remove highlighting from inside links, loop incase multiple highlights in links */
-               $pattern = '/(href="[^"]*)<strong>('.implode('|',array_map('htmlspecialchars', $terms)).')<\/strong>([^"]*")/iU';
-               do {
-                       $result = preg_replace($pattern, '\\1\\2\\3', $result, -1, $count);
-               } while ($count);
-               return $result;
-       }
+
+        return $result;
+    }
 }