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