actions/public.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Action for displaying the public stream
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Public
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008-2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/publicgroupnav.php';
  35 require_once INSTALLDIR.'/lib/noticelist.php';
  36 require_once INSTALLDIR.'/lib/feedlist.php';
  37
  38 // Farther than any human will go
  39
  40 define('MAX_PUBLIC_PAGE', 100);
  41
  42 /**
  43  * Action for displaying the public stream
  44  *
  45  * @category Public
  46  * @package  StatusNet
  47  * @author   Evan Prodromou <evan@status.net>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://status.net/
  50  *
  51  * @see      PublicrssAction
  52  * @see      PublicxrdsAction
  53  */
  54 class PublicAction extends Action
  55 {
  56     /**
  57      * page of the stream we're on; default = 1
  58      */
  59
  60     var $page = null;
  61     var $notice;
  62
  63     function isReadOnly($args)
  64     {
  65         return true;
  66     }
  67
  68     /**
  69      * Read and validate arguments
  70      *
  71      * @param array $args URL parameters
  72      *
  73      * @return boolean success value
  74      */
  75     function prepare($args)
  76     {
  77         parent::prepare($args);
  78         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  79
  80         if ($this->page > MAX_PUBLIC_PAGE) {
  81             // TRANS: Client error displayed when requesting a public timeline page beyond the page limit.
  82             // TRANS: %s is the page limit.
  83             $this->clientError(sprintf(_('Beyond the page limit (%s).'), MAX_PUBLIC_PAGE));
  84         }
  85
  86         common_set_returnto($this->selfUrl());
  87
  88         $stream = new PublicNoticeStream(PublicNoticeStream::THREADED);
  89         $this->notice = $stream->getNotices(($this->page-1)*NOTICES_PER_PAGE,
  90                                             NOTICES_PER_PAGE + 1,
  91                                             0,
  92                                             0);
  93
  94         if (!$this->notice) {
  95             // TRANS: Server error displayed when a public timeline cannot be retrieved.
  96             $this->serverError(_('Could not retrieve public stream.'));
  97             return;
  98         }
  99
 100         if($this->page > 1 && $this->notice->N == 0){
 101             // TRANS: Server error when page not found (404).
 102             $this->serverError(_('No such page.'),$code=404);
 103         }
 104
 105         return true;
 106     }
 107
 108     /**
 109      * handle request
 110      *
 111      * Show the public stream, using recipe method showPage()
 112      *
 113      * @param array $args arguments, mostly unused
 114      *
 115      * @return void
 116      */
 117     function handle($args)
 118     {
 119         parent::handle($args);
 120
 121         $this->showPage();
 122     }
 123
 124     /**
 125      * Title of the page
 126      *
 127      * @return page title, including page number if over 1
 128      */
 129     function title()
 130     {
 131         if ($this->page > 1) {
 132             // TRANS: Title for all public timeline pages but the first.
 133             // TRANS: %d is the page number.
 134             return sprintf(_('Public timeline, page %d'), $this->page);
 135         } else {
 136             // TRANS: Title for the first public timeline page.
 137             return _('Public timeline');
 138         }
 139     }
 140
 141     function extraHead()
 142     {
 143         parent::extraHead();
 144         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 145                                            'content' => common_local_url('publicxrds')));
 146
 147         $rsd = common_local_url('rsd');
 148
 149         // RSD, http://tales.phrasewise.com/rfc/rsd
 150
 151         $this->element('link', array('rel' => 'EditURI',
 152                                      'type' => 'application/rsd+xml',
 153                                      'href' => $rsd));
 154     }
 155
 156     /**
 157      * Output <head> elements for RSS and Atom feeds
 158      *
 159      * @return void
 160      */
 161     function getFeeds()
 162     {
 163         return array(new Feed(Feed::RSS1, common_local_url('publicrss'),
 164                               // TRANS: Link description for public timeline feed.
 165                               _('Public Stream Feed (RSS 1.0)')),
 166                      new Feed(Feed::RSS2,
 167                               common_local_url('ApiTimelinePublic',
 168                                                array('format' => 'rss')),
 169                               // TRANS: Link description for public timeline feed.
 170                               _('Public Stream Feed (RSS 2.0)')),
 171                      new Feed(Feed::ATOM,
 172                               common_local_url('ApiTimelinePublic',
 173                                                array('format' => 'atom')),
 174                               // TRANS: Link description for public timeline feed.
 175                               _('Public Stream Feed (Atom)')));
 176     }
 177
 178     function showEmptyList()
 179     {
 180         // TRANS: Text displayed for public feed when there are no public notices.
 181         $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
 182
 183         if (common_logged_in()) {
 184             // TRANS: Additional text displayed for public feed when there are no public notices for a logged in user.
 185             $message .= _('Be the first to post!');
 186         }
 187         else {
 188             if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 189                 // TRANS: Additional text displayed for public feed when there are no public notices for a not logged in user.
 190                 $message .= _('Why not [register an account](%%action.register%%) and be the first to post!');
 191             }
 192         }
 193
 194         $this->elementStart('div', 'guide');
 195         $this->raw(common_markup_to_html($message));
 196         $this->elementEnd('div');
 197     }
 198
 199     /**
 200      * Fill the content area
 201      *
 202      * Shows a list of the notices in the public stream, with some pagination
 203      * controls.
 204      *
 205      * @return void
 206      */
 207     function showContent()
 208     {
 209         $nl = new ThreadedNoticeList($this->notice, $this);
 210
 211         $cnt = $nl->show();
 212
 213         if ($cnt == 0) {
 214             $this->showEmptyList();
 215         }
 216
 217         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 218                           $this->page, 'public');
 219     }
 220
 221     function showSections()
 222     {
 223         // $top = new TopPostersSection($this);
 224         // $top->show();
 225         $pop = new PopularNoticeSection($this);
 226         $pop->show();
 227         $gbp = new GroupsByMembersSection($this);
 228         $gbp->show();
 229         $feat = new FeaturedUsersSection($this);
 230         $feat->show();
 231     }
 232
 233     function showAnonymousMessage()
 234     {
 235         if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 236             // TRANS: Message for not logged in users at an invite-only site trying to view the public feed of notices.
 237             // TRANS: This message contains Markdown links. Please mind the formatting.
 238             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 239                    'based on the Free Software [StatusNet](http://status.net/) tool. ' .
 240                    '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ' .
 241                    '([Read more](%%doc.help%%))');
 242         } else {
 243             // TRANS: Message for not logged in users at a closed site trying to view the public feed of notices.
 244             // TRANS: This message contains Markdown links. Please mind the formatting.
 245             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 246                    'based on the Free Software [StatusNet](http://status.net/) tool.');
 247         }
 248         $this->elementStart('div', array('id' => 'anon_notice'));
 249         $this->raw(common_markup_to_html($m));
 250         $this->elementEnd('div');
 251     }
 252 }