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