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         $this->notice = Notice::publicStream(($this->page-1)*NOTICES_PER_PAGE,
  89                                        NOTICES_PER_PAGE + 1);
  90
  91         if (!$this->notice) {
  92             // TRANS: Server error displayed when a public timeline cannot be retrieved.
  93             $this->serverError(_('Could not retrieve public stream.'));
  94             return;
  95         }
  96
  97         if($this->page > 1 && $this->notice->N == 0){
  98             // TRANS: Server error when page not found (404).
  99             $this->serverError(_('No such page.'),$code=404);
 100         }
 101
 102         return true;
 103     }
 104
 105     /**
 106      * handle request
 107      *
 108      * Show the public stream, using recipe method showPage()
 109      *
 110      * @param array $args arguments, mostly unused
 111      *
 112      * @return void
 113      */
 114     function handle($args)
 115     {
 116         parent::handle($args);
 117
 118         $this->showPage();
 119     }
 120
 121     /**
 122      * Title of the page
 123      *
 124      * @return page title, including page number if over 1
 125      */
 126     function title()
 127     {
 128         if ($this->page > 1) {
 129             // TRANS: Title for all public timeline pages but the first.
 130             // TRANS: %d is the page number.
 131             return sprintf(_('Public timeline, page %d'), $this->page);
 132         } else {
 133             // TRANS: Title for the first public timeline page.
 134             return _('Public timeline');
 135         }
 136     }
 137
 138     function extraHead()
 139     {
 140         parent::extraHead();
 141         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 142                                            'content' => common_local_url('publicxrds')));
 143
 144         $rsd = common_local_url('rsd');
 145
 146         // RSD, http://tales.phrasewise.com/rfc/rsd
 147
 148         $this->element('link', array('rel' => 'EditURI',
 149                                      'type' => 'application/rsd+xml',
 150                                      'href' => $rsd));
 151     }
 152
 153     /**
 154      * Output <head> elements for RSS and Atom feeds
 155      *
 156      * @return void
 157      */
 158     function getFeeds()
 159     {
 160         return array(new Feed(Feed::RSS1, common_local_url('publicrss'),
 161                               // TRANS: Link description for public timeline feed.
 162                               _('Public Stream Feed (RSS 1.0)')),
 163                      new Feed(Feed::RSS2,
 164                               common_local_url('ApiTimelinePublic',
 165                                                array('format' => 'rss')),
 166                               // TRANS: Link description for public timeline feed.
 167                               _('Public Stream Feed (RSS 2.0)')),
 168                      new Feed(Feed::ATOM,
 169                               common_local_url('ApiTimelinePublic',
 170                                                array('format' => 'atom')),
 171                               // TRANS: Link description for public timeline feed.
 172                               _('Public Stream Feed (Atom)')));
 173     }
 174
 175     function showEmptyList()
 176     {
 177         // TRANS: Text displayed for public feed when there are no public notices.
 178         $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
 179
 180         if (common_logged_in()) {
 181             // TRANS: Additional text displayed for public feed when there are no public notices for a logged in user.
 182             $message .= _('Be the first to post!');
 183         }
 184         else {
 185             if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 186                 // TRANS: Additional text displayed for public feed when there are no public notices for a not logged in user.
 187                 $message .= _('Why not [register an account](%%action.register%%) and be the first to post!');
 188             }
 189         }
 190
 191         $this->elementStart('div', 'guide');
 192         $this->raw(common_markup_to_html($message));
 193         $this->elementEnd('div');
 194     }
 195
 196     /**
 197      * Fill the content area
 198      *
 199      * Shows a list of the notices in the public stream, with some pagination
 200      * controls.
 201      *
 202      * @return void
 203      */
 204     function showContent()
 205     {
 206         $nl = new ThreadedNoticeList($this->notice, $this);
 207
 208         $cnt = $nl->show();
 209
 210         if ($cnt == 0) {
 211             $this->showEmptyList();
 212         }
 213
 214         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 215                           $this->page, 'public');
 216     }
 217
 218     function showSections()
 219     {
 220         // $top = new TopPostersSection($this);
 221         // $top->show();
 222         $pop = new PopularNoticeSection($this);
 223         $pop->show();
 224         $gbp = new GroupsByMembersSection($this);
 225         $gbp->show();
 226         $feat = new FeaturedUsersSection($this);
 227         $feat->show();
 228     }
 229
 230     function showAnonymousMessage()
 231     {
 232         if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 233             // TRANS: Message for not logged in users at an invite-only site trying to view the public feed of notices.
 234             // TRANS: This message contains Markdown links. Please mind the formatting.
 235             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 236                    'based on the Free Software [StatusNet](http://status.net/) tool. ' .
 237                    '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ' .
 238                    '([Read more](%%doc.help%%))');
 239         } else {
 240             // TRANS: Message for not logged in users at a closed site trying to view the public feed of notices.
 241             // TRANS: This message contains Markdown links. Please mind the formatting.
 242             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 243                    'based on the Free Software [StatusNet](http://status.net/) tool.');
 244         }
 245         $this->elementStart('div', array('id' => 'anon_notice'));
 246         $this->raw(common_markup_to_html($m));
 247         $this->elementEnd('div');
 248     }
 249 }