actions/public.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @copyright 2008-2009 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 if (!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  Laconica
  47  * @author   Evan Prodromou <evan@controlyourself.ca>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://laconi.ca/
  50  *
  51  * @see      PublicrssAction
  52  * @see      PublicxrdsAction
  53  */
  54
  55 class PublicAction extends Action
  56 {
  57     /**
  58      * page of the stream we're on; default = 1
  59      */
  60
  61     var $page = null;
  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
  76     function prepare($args)
  77     {
  78         parent::prepare($args);
  79         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  80
  81         if ($this->page > MAX_PUBLIC_PAGE) {
  82             $this->clientError(sprintf(_("Beyond the page limit (%s)"), MAX_PUBLIC_PAGE));
  83         }
  84
  85         common_set_returnto($this->selfUrl());
  86
  87         return true;
  88     }
  89
  90     /**
  91      * handle request
  92      *
  93      * Show the public stream, using recipe method showPage()
  94      *
  95      * @param array $args arguments, mostly unused
  96      *
  97      * @return void
  98      */
  99
 100     function handle($args)
 101     {
 102         parent::handle($args);
 103
 104         header('X-XRDS-Location: '. common_local_url('publicxrds'));
 105
 106         $this->showPage();
 107     }
 108
 109     /**
 110      * Title of the page
 111      *
 112      * @return page title, including page number if over 1
 113      */
 114
 115     function title()
 116     {
 117         if ($this->page > 1) {
 118             return sprintf(_('Public timeline, page %d'), $this->page);
 119         } else {
 120             return _('Public timeline');
 121         }
 122     }
 123
 124     /**
 125      * Output <head> elements for RSS and Atom feeds
 126      *
 127      * @return void
 128      */
 129
 130     function getFeeds()
 131     {
 132         return array(new Feed(Feed::RSS1, common_local_url('publicrss'),
 133                               _('Public Stream Feed (RSS 1.0)')),
 134                      new Feed(Feed::RSS2,
 135                               common_local_url('api',
 136                                                array('apiaction' => 'statuses',
 137                                                      'method' => 'public_timeline.rss')),
 138                               _('Public Stream Feed (RSS 2.0)')),
 139                      new Feed(Feed::ATOM,
 140                               common_local_url('api',
 141                                                array('apiaction' => 'statuses',
 142                                                      'method' => 'public_timeline.atom')),
 143                               _('Public Stream Feed (Atom)')));
 144     }
 145
 146     /**
 147      * Extra head elements
 148      *
 149      * We include a <meta> element linking to the publicxrds page, for OpenID
 150      * client-side authentication.
 151      *
 152      * @return void
 153      */
 154
 155     function extraHead()
 156     {
 157         // for client side of OpenID authentication
 158         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 159                                      'content' => common_local_url('publicxrds')));
 160     }
 161
 162     /**
 163      * Show tabset for this page
 164      *
 165      * Uses the PublicGroupNav widget
 166      *
 167      * @return void
 168      * @see PublicGroupNav
 169      */
 170
 171     function showLocalNav()
 172     {
 173         $nav = new PublicGroupNav($this);
 174         $nav->show();
 175     }
 176
 177     function showEmptyList()
 178     {
 179         $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
 180
 181         if (common_logged_in()) {
 182             $message .= _('Be the first to post!');
 183         }
 184         else {
 185             if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 186                 $message .= sprintf(_('Why not [register an account](%%%%action.%s%%%%) and be the first to post!'),
 187                                     (!common_config('site','openidonly')) ? 'register' : 'openidlogin');
 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
 205     function showContent()
 206     {
 207         $notice = Notice::publicStream(($this->page-1)*NOTICES_PER_PAGE,
 208                                        NOTICES_PER_PAGE + 1);
 209
 210         if (!$notice) {
 211             $this->serverError(_('Could not retrieve public stream.'));
 212             return;
 213         }
 214
 215         $nl = new NoticeList($notice, $this);
 216
 217         $cnt = $nl->show();
 218
 219         if ($cnt == 0) {
 220             $this->showEmptyList();
 221         }
 222
 223         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 224                           $this->page, 'public');
 225     }
 226
 227     function showSections()
 228     {
 229         // $top = new TopPostersSection($this);
 230         // $top->show();
 231         $pop = new PopularNoticeSection($this);
 232         $pop->show();
 233         $gbp = new GroupsByMembersSection($this);
 234         $gbp->show();
 235         $feat = new FeaturedUsersSection($this);
 236         $feat->show();
 237     }
 238
 239     function showAnonymousMessage()
 240     {
 241         if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 242             $m = sprintf(_('This is %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 243                            'based on the Free Software [Laconica](http://laconi.ca/) tool. ' .
 244                            '[Join now](%%%%action.%s%%%%) to share notices about yourself with friends, family, and colleagues! ' .
 245                            '([Read more](%%%%doc.help%%%%))'),
 246                          (!common_config('site','openidonly')) ? 'register' : 'openidlogin');
 247         } else {
 248             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 249                    'based on the Free Software [Laconica](http://laconi.ca/) tool.');
 250         }
 251         $this->elementStart('div', array('id' => 'anon_notice'));
 252         $this->raw(common_markup_to_html($m));
 253         $this->elementEnd('div');
 254     }
 255 }