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