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     var $notice;
  63
  64     function isReadOnly($args)
  65     {
  66         return true;
  67     }
  68
  69     /**
  70      * Read and validate arguments
  71      *
  72      * @param array $args URL parameters
  73      *
  74      * @return boolean success value
  75      */
  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             $this->clientError(sprintf(_("Beyond the page limit (%s)"), MAX_PUBLIC_PAGE));
  84         }
  85
  86         common_set_returnto($this->selfUrl());
  87
  88         $this->notice = Notice::publicStream(($this->page-1)*NOTICES_PER_PAGE,
  89                                        NOTICES_PER_PAGE + 1);
  90
  91         if (!$this->notice) {
  92             $this->serverError(_('Could not retrieve public stream.'));
  93             return;
  94         }
  95
  96         if($this->page > 1 && $this->notice->N == 0){
  97             $this->serverError(_('No such page'),$code=404);
  98         }
  99
 100         return true;
 101     }
 102
 103     /**
 104      * handle request
 105      *
 106      * Show the public stream, using recipe method showPage()
 107      *
 108      * @param array $args arguments, mostly unused
 109      *
 110      * @return void
 111      */
 112
 113     function handle($args)
 114     {
 115         parent::handle($args);
 116
 117         $this->showPage();
 118     }
 119
 120     /**
 121      * Title of the page
 122      *
 123      * @return page title, including page number if over 1
 124      */
 125
 126     function title()
 127     {
 128         if ($this->page > 1) {
 129             return sprintf(_('Public timeline, page %d'), $this->page);
 130         } else {
 131             return _('Public timeline');
 132         }
 133     }
 134
 135     /**
 136      * Output <head> elements for RSS and Atom feeds
 137      *
 138      * @return void
 139      */
 140
 141     function getFeeds()
 142     {
 143         return array(new Feed(Feed::RSS1, common_local_url('publicrss'),
 144                               _('Public Stream Feed (RSS 1.0)')),
 145                      new Feed(Feed::RSS2,
 146                               common_local_url('api',
 147                                                array('apiaction' => 'statuses',
 148                                                      'method' => 'public_timeline.rss')),
 149                               _('Public Stream Feed (RSS 2.0)')),
 150                      new Feed(Feed::ATOM,
 151                               common_local_url('api',
 152                                                array('apiaction' => 'statuses',
 153                                                      'method' => 'public_timeline.atom')),
 154                               _('Public Stream Feed (Atom)')));
 155     }
 156
 157     /**
 158      * Show tabset for this page
 159      *
 160      * Uses the PublicGroupNav widget
 161      *
 162      * @return void
 163      * @see PublicGroupNav
 164      */
 165
 166     function showLocalNav()
 167     {
 168         $nav = new PublicGroupNav($this);
 169         $nav->show();
 170     }
 171
 172     function showEmptyList()
 173     {
 174         $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
 175
 176         if (common_logged_in()) {
 177             $message .= _('Be the first to post!');
 178         }
 179         else {
 180             if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 181                 $message .= sprintf(_('Why not [register an account](%%%%action.%s%%%%) and be the first to post!'),
 182                                     (!common_config('site','openidonly')) ? 'register' : 'openidlogin');
 183             }
 184         }
 185
 186         $this->elementStart('div', 'guide');
 187         $this->raw(common_markup_to_html($message));
 188         $this->elementEnd('div');
 189     }
 190
 191     /**
 192      * Fill the content area
 193      *
 194      * Shows a list of the notices in the public stream, with some pagination
 195      * controls.
 196      *
 197      * @return void
 198      */
 199
 200     function showContent()
 201     {
 202         $nl = new NoticeList($this->notice, $this);
 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, 'public');
 212     }
 213
 214     function showSections()
 215     {
 216         // $top = new TopPostersSection($this);
 217         // $top->show();
 218         $pop = new PopularNoticeSection($this);
 219         $pop->show();
 220         $gbp = new GroupsByMembersSection($this);
 221         $gbp->show();
 222         $feat = new FeaturedUsersSection($this);
 223         $feat->show();
 224     }
 225
 226     function showAnonymousMessage()
 227     {
 228         if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 229             $m = sprintf(_('This is %%%%site.name%%%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 230                            'based on the Free Software [Laconica](http://laconi.ca/) tool. ' .
 231                            '[Join now](%%%%action.%s%%%%) to share notices about yourself with friends, family, and colleagues! ' .
 232                            '([Read more](%%%%doc.help%%%%))'),
 233                          (!common_config('site','openidonly')) ? 'register' : 'openidlogin');
 234         } else {
 235             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 236                    'based on the Free Software [Laconica](http://laconi.ca/) tool.');
 237         }
 238         $this->elementStart('div', array('id' => 'anon_notice'));
 239         $this->raw(common_markup_to_html($m));
 240         $this->elementEnd('div');
 241     }
 242 }