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 ManagedAction
  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     protected function doPreparation()
  65     {
  66         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  67
  68         if ($this->page > MAX_PUBLIC_PAGE) {
  69             // TRANS: Client error displayed when requesting a public timeline page beyond the page limit.
  70             // TRANS: %s is the page limit.
  71             $this->clientError(sprintf(_('Beyond the page limit (%s).'), MAX_PUBLIC_PAGE));
  72         }
  73
  74         common_set_returnto($this->selfUrl());
  75
  76         $this->streamPrepare();
  77
  78         $this->notice = $this->stream->getNotices(($this->page-1)*NOTICES_PER_PAGE,
  79                                             NOTICES_PER_PAGE + 1);
  80
  81         if (!$this->notice) {
  82             // TRANS: Server error displayed when a public timeline cannot be retrieved.
  83             $this->serverError(_('Could not retrieve public timeline.'));
  84         }
  85
  86         if ($this->page > 1 && $this->notice->N == 0){
  87             // TRANS: Client error when page not found (404).
  88             $this->clientError(_('No such page.'), 404);
  89         }
  90
  91         return true;
  92     }
  93
  94     protected function streamPrepare()
  95     {
  96         if ($this->scoped instanceof Profile && $this->scoped->isLocal() && $this->scoped->getUser()->streamModeOnly()) {
  97             $this->stream = new PublicNoticeStream($this->scoped);
  98         } else {
  99             $this->stream = new ThreadingPublicNoticeStream($this->scoped);
 100         }
 101     }
 102
 103     /**
 104      * Title of the page
 105      *
 106      * @return page title, including page number if over 1
 107      */
 108     function title()
 109     {
 110         if ($this->page > 1) {
 111             // TRANS: Title for all public timeline pages but the first.
 112             // TRANS: %d is the page number.
 113             return sprintf(_('Public timeline, page %d'), $this->page);
 114         } else {
 115             // TRANS: Title for the first public timeline page.
 116             return _('Public timeline');
 117         }
 118     }
 119
 120     function extraHead()
 121     {
 122         parent::extraHead();
 123         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 124                                            'content' => common_local_url('publicxrds')));
 125
 126         $rsd = common_local_url('rsd');
 127
 128         // RSD, http://tales.phrasewise.com/rfc/rsd
 129
 130         $this->element('link', array('rel' => 'EditURI',
 131                                      'type' => 'application/rsd+xml',
 132                                      'href' => $rsd));
 133
 134         if ($this->page != 1) {
 135             $this->element('link', array('rel' => 'canonical',
 136                                          'href' => common_local_url('public')));
 137         }
 138     }
 139
 140     /**
 141      * Output <head> elements for RSS and Atom feeds
 142      *
 143      * @return void
 144      */
 145     function getFeeds()
 146     {
 147         return array(new Feed(Feed::JSON,
 148                               common_local_url('ApiTimelinePublic',
 149                                                array('format' => 'as')),
 150                               // TRANS: Link description for public timeline feed.
 151                               _('Public Timeline Feed (Activity Streams JSON)')),
 152                     new Feed(Feed::RSS1, common_local_url('publicrss'),
 153                               // TRANS: Link description for public timeline feed.
 154                               _('Public Timeline Feed (RSS 1.0)')),
 155                      new Feed(Feed::RSS2,
 156                               common_local_url('ApiTimelinePublic',
 157                                                array('format' => 'rss')),
 158                               // TRANS: Link description for public timeline feed.
 159                               _('Public Timeline Feed (RSS 2.0)')),
 160                      new Feed(Feed::ATOM,
 161                               common_local_url('ApiTimelinePublic',
 162                                                array('format' => 'atom')),
 163                               // TRANS: Link description for public timeline feed.
 164                               _('Public Timeline Feed (Atom)')));
 165     }
 166
 167     function showEmptyList()
 168     {
 169         // TRANS: Text displayed for public feed when there are no public notices.
 170         $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
 171
 172         if (common_logged_in()) {
 173             // TRANS: Additional text displayed for public feed when there are no public notices for a logged in user.
 174             $message .= _('Be the first to post!');
 175         }
 176         else {
 177             if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 178                 // TRANS: Additional text displayed for public feed when there are no public notices for a not logged in user.
 179                 $message .= _('Why not [register an account](%%action.register%%) and be the first to post!');
 180             }
 181         }
 182
 183         $this->elementStart('div', 'guide');
 184         $this->raw(common_markup_to_html($message));
 185         $this->elementEnd('div');
 186     }
 187
 188     /**
 189      * Fill the content area
 190      *
 191      * Shows a list of the notices in the public stream, with some pagination
 192      * controls.
 193      *
 194      * @return void
 195      */
 196     function showContent()
 197     {
 198         if ($this->scoped instanceof Profile && $this->scoped->isLocal() && $this->scoped->getUser()->streamModeOnly()) {
 199             $nl = new PrimaryNoticeList($this->notice, $this, array('show_n'=>NOTICES_PER_PAGE));
 200         } else {
 201             $nl = new ThreadedNoticeList($this->notice, $this, $this->scoped);
 202         }
 203
 204         $cnt = $nl->show();
 205
 206         if ($cnt == 0) {
 207             $this->showEmptyList();
 208         }
 209
 210         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 211                           $this->page, $this->action);
 212     }
 213
 214     function showSections()
 215     {
 216         // Show invite button, as long as site isn't closed, and
 217         // we have a logged in user.
 218         if (common_config('invite', 'enabled') && !common_config('site', 'closed') && common_logged_in()) {
 219             if (!common_config('site', 'private')) {
 220                 $ibs = new InviteButtonSection(
 221                     $this,
 222                     // TRANS: Button text for inviting more users to the StatusNet instance.
 223                     // TRANS: Less business/enterprise-oriented language for public sites.
 224                     _m('BUTTON', 'Send invite')
 225                 );
 226             } else {
 227                 $ibs = new InviteButtonSection($this);
 228             }
 229             $ibs->show();
 230         }
 231
 232         $p = Profile::current();
 233
 234         if (!common_config('performance', 'high')) {
 235             $cloud = new PublicTagCloudSection($this);
 236             $cloud->show();
 237         }
 238         $feat = new FeaturedUsersSection($this);
 239         $feat->show();
 240     }
 241
 242     function showAnonymousMessage()
 243     {
 244         if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 245             // TRANS: Message for not logged in users at an invite-only site trying to view the public feed of notices.
 246             // TRANS: This message contains Markdown links. Please mind the formatting.
 247             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 248                    'based on the Free Software [StatusNet](http://status.net/) tool. ' .
 249                    '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ' .
 250                    '([Read more](%%doc.help%%))');
 251         } else {
 252             // TRANS: Message for not logged in users at a closed site trying to view the public feed of notices.
 253             // TRANS: This message contains Markdown links. Please mind the formatting.
 254             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 255                    'based on the Free Software [StatusNet](http://status.net/) tool.');
 256         }
 257         $this->elementStart('div', array('id' => 'anon_notice'));
 258         $this->raw(common_markup_to_html($m));
 259         $this->elementEnd('div');
 260     }
 261 }