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('GNUSOCIAL')) { exit(1); }
  31
  32 // Farther than any human will go
  33
  34 define('MAX_PUBLIC_PAGE', 100);
  35
  36 /**
  37  * Action for displaying the public stream
  38  *
  39  * @category Public
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  *
  45  * @see      PublicrssAction
  46  * @see      PublicxrdsAction
  47  */
  48 class PublicAction extends Action
  49 {
  50     /**
  51      * page of the stream we're on; default = 1
  52      */
  53
  54     var $page = null;
  55     var $notice;
  56
  57     protected $stream = null;
  58
  59     function isReadOnly($args)
  60     {
  61         return true;
  62     }
  63
  64     /**
  65      * Read and validate arguments
  66      *
  67      * @param array $args URL parameters
  68      *
  69      * @return boolean success value
  70      */
  71     protected function prepare(array $args=array())
  72     {
  73         parent::prepare($args);
  74         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  75
  76         if ($this->page > MAX_PUBLIC_PAGE) {
  77             // TRANS: Client error displayed when requesting a public timeline page beyond the page limit.
  78             // TRANS: %s is the page limit.
  79             $this->clientError(sprintf(_('Beyond the page limit (%s).'), MAX_PUBLIC_PAGE));
  80         }
  81
  82         common_set_returnto($this->selfUrl());
  83
  84         $this->streamPrepare();
  85
  86         $this->notice = $this->stream->getNotices(($this->page-1)*NOTICES_PER_PAGE,
  87                                             NOTICES_PER_PAGE + 1);
  88
  89         if (!$this->notice) {
  90             // TRANS: Server error displayed when a public timeline cannot be retrieved.
  91             $this->serverError(_('Could not retrieve public timeline.'));
  92         }
  93
  94         if ($this->page > 1 && $this->notice->N == 0){
  95             // TRANS: Server error when page not found (404).
  96             $this->serverError(_('No such page.'),$code=404);
  97         }
  98
  99         return true;
 100     }
 101
 102     protected function streamPrepare()
 103     {
 104         if ($this->scoped instanceof Profile && $this->scoped->isLocal() && $this->scoped->getUser()->streamModeOnly()) {
 105             $this->stream = new PublicNoticeStream($this->scoped);
 106         } else {
 107             $this->stream = new ThreadingPublicNoticeStream($this->scoped);
 108         }
 109     }
 110
 111     /**
 112      * handle request
 113      *
 114      * Show the public stream, using recipe method showPage()
 115      *
 116      * @param array $args arguments, mostly unused
 117      *
 118      * @return void
 119      */
 120     protected function handle()
 121     {
 122         parent::handle();
 123
 124         $this->showPage();
 125     }
 126
 127     /**
 128      * Title of the page
 129      *
 130      * @return page title, including page number if over 1
 131      */
 132     function title()
 133     {
 134         if ($this->page > 1) {
 135             // TRANS: Title for all public timeline pages but the first.
 136             // TRANS: %d is the page number.
 137             return sprintf(_('Public timeline, page %d'), $this->page);
 138         } else {
 139             // TRANS: Title for the first public timeline page.
 140             return _('Public timeline');
 141         }
 142     }
 143
 144     function extraHead()
 145     {
 146         parent::extraHead();
 147         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 148                                            'content' => common_local_url('publicxrds')));
 149
 150         $rsd = common_local_url('rsd');
 151
 152         // RSD, http://tales.phrasewise.com/rfc/rsd
 153
 154         $this->element('link', array('rel' => 'EditURI',
 155                                      'type' => 'application/rsd+xml',
 156                                      'href' => $rsd));
 157
 158         if ($this->page != 1) {
 159             $this->element('link', array('rel' => 'canonical',
 160                                          'href' => common_local_url('public')));
 161         }
 162     }
 163
 164     /**
 165      * Output <head> elements for RSS and Atom feeds
 166      *
 167      * @return void
 168      */
 169     function getFeeds()
 170     {
 171         return array(new Feed(Feed::JSON,
 172                               common_local_url('ApiTimelinePublic',
 173                                                array('format' => 'as')),
 174                               // TRANS: Link description for public timeline feed.
 175                               _('Public Timeline Feed (Activity Streams JSON)')),
 176                     new Feed(Feed::RSS1, common_local_url('publicrss'),
 177                               // TRANS: Link description for public timeline feed.
 178                               _('Public Timeline Feed (RSS 1.0)')),
 179                      new Feed(Feed::RSS2,
 180                               common_local_url('ApiTimelinePublic',
 181                                                array('format' => 'rss')),
 182                               // TRANS: Link description for public timeline feed.
 183                               _('Public Timeline Feed (RSS 2.0)')),
 184                      new Feed(Feed::ATOM,
 185                               common_local_url('ApiTimelinePublic',
 186                                                array('format' => 'atom')),
 187                               // TRANS: Link description for public timeline feed.
 188                               _('Public Timeline Feed (Atom)')));
 189     }
 190
 191     function showEmptyList()
 192     {
 193         // TRANS: Text displayed for public feed when there are no public notices.
 194         $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
 195
 196         if (common_logged_in()) {
 197             // TRANS: Additional text displayed for public feed when there are no public notices for a logged in user.
 198             $message .= _('Be the first to post!');
 199         }
 200         else {
 201             if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 202                 // TRANS: Additional text displayed for public feed when there are no public notices for a not logged in user.
 203                 $message .= _('Why not [register an account](%%action.register%%) and be the first to post!');
 204             }
 205         }
 206
 207         $this->elementStart('div', 'guide');
 208         $this->raw(common_markup_to_html($message));
 209         $this->elementEnd('div');
 210     }
 211
 212     /**
 213      * Fill the content area
 214      *
 215      * Shows a list of the notices in the public stream, with some pagination
 216      * controls.
 217      *
 218      * @return void
 219      */
 220     function showContent()
 221     {
 222         $user = common_current_user();
 223
 224         if (!empty($user) && $user->streamModeOnly()) {
 225             $nl = new PrimaryNoticeList($this->notice, $this, array('show_n'=>NOTICES_PER_PAGE));
 226         } else {
 227             $nl = new ThreadedNoticeList($this->notice, $this, $this->scoped);
 228         }
 229
 230         $cnt = $nl->show();
 231
 232         if ($cnt == 0) {
 233             $this->showEmptyList();
 234         }
 235
 236         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 237                           $this->page, 'public');
 238     }
 239
 240     function showSections()
 241     {
 242         // Show invite button, as long as site isn't closed, and
 243         // we have a logged in user.
 244         if (common_config('invite', 'enabled') && !common_config('site', 'closed') && common_logged_in()) {
 245             if (!common_config('site', 'private')) {
 246                 $ibs = new InviteButtonSection(
 247                     $this,
 248                     // TRANS: Button text for inviting more users to the StatusNet instance.
 249                     // TRANS: Less business/enterprise-oriented language for public sites.
 250                     _m('BUTTON', 'Send invite')
 251                 );
 252             } else {
 253                 $ibs = new InviteButtonSection($this);
 254             }
 255             $ibs->show();
 256         }
 257
 258         $p = Profile::current();
 259
 260         if (!common_config('performance', 'high')) {
 261             $cloud = new PublicTagCloudSection($this);
 262             $cloud->show();
 263         }
 264         $feat = new FeaturedUsersSection($this);
 265         $feat->show();
 266     }
 267
 268     function showAnonymousMessage()
 269     {
 270         if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 271             // TRANS: Message for not logged in users at an invite-only site trying to view the public feed of notices.
 272             // TRANS: This message contains Markdown links. Please mind the formatting.
 273             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 274                    'based on the Free Software [StatusNet](http://status.net/) tool. ' .
 275                    '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ' .
 276                    '([Read more](%%doc.help%%))');
 277         } else {
 278             // TRANS: Message for not logged in users at a closed site trying to view the public feed of notices.
 279             // TRANS: This message contains Markdown links. Please mind the formatting.
 280             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 281                    'based on the Free Software [StatusNet](http://status.net/) tool.');
 282         }
 283         $this->elementStart('div', array('id' => 'anon_notice'));
 284         $this->raw(common_markup_to_html($m));
 285         $this->elementEnd('div');
 286     }
 287 }
 288
 289 class ThreadingPublicNoticeStream extends ThreadingNoticeStream
 290 {
 291     function __construct($profile)
 292     {
 293         parent::__construct(new PublicNoticeStream($profile));
 294     }
 295 }