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     /**
  60      * Number of notices being shown on this page.
  61      */
  62     //    Does this need to be here? Should it be?
  63     //    If it does, this property needs to be
  64     //    added to other actions as well, like $page.
  65     //    I'm trying to find a way to capture the
  66     //    output of the $cnt variable from this
  67     //    action's showContent() method but need
  68     //    to do so earlier, I think...?
  69     var $count = null;
  70
  71     function isReadOnly()
  72     {
  73         return true;
  74     }
  75
  76     /**
  77      * Read and validate arguments
  78      *
  79      * @param array $args URL parameters
  80      *
  81      * @return boolean success value
  82      */
  83
  84     function prepare($args)
  85     {
  86         parent::prepare($args);
  87         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  88
  89         common_set_returnto($this->selfUrl());
  90
  91         return true;
  92     }
  93
  94     /**
  95      * handle request
  96      *
  97      * Show the public stream, using recipe method showPage()
  98      *
  99      * @param array $args arguments, mostly unused
 100      *
 101      * @return void
 102      */
 103
 104     function handle($args)
 105     {
 106         parent::handle($args);
 107
 108         header('X-XRDS-Location: '. common_local_url('publicxrds'));
 109
 110         $this->showPage();
 111     }
 112
 113     /**
 114      * Title of the page
 115      *
 116      * @return page title, including page number if over 1
 117      */
 118
 119     function title()
 120     {
 121         if ($this->page > 1) {
 122             return sprintf(_('Public timeline, page %d'), $this->page);
 123         } else {
 124             return _('Public timeline');
 125         }
 126     }
 127
 128     /**
 129      * Output <head> elements for RSS and Atom feeds
 130      *
 131      * @return void
 132      */
 133
 134     function getFeeds()
 135     {
 136         return array(new Feed(Feed::RSS1, common_local_url('publicrss'),
 137                               _('Public Stream Feed (RSS 1.0)')),
 138                      new Feed(Feed::RSS2,
 139                               common_local_url('api',
 140                                                array('apiaction' => 'statuses',
 141                                                      'method' => 'public_timeline.rss')),
 142                               _('Public Stream Feed (RSS 2.0)')),
 143                      new Feed(Feed::ATOM,
 144                               common_local_url('api',
 145                                                array('apiaction' => 'statuses',
 146                                                      'method' => 'public_timeline.atom')),
 147                               _('Public Stream Feed (Atom)')));
 148     }
 149
 150     /**
 151      * Output document relationship links
 152      *
 153      * @return void
 154      */
 155     function showRelationshipLinks()
 156     {
 157         $this->sequenceRelationships($this->page > 1, $this->count > NOTICES_PER_PAGE, // FIXME
 158                                      $this->page, 'public');
 159     }
 160
 161     /**
 162      * Extra head elements
 163      *
 164      * We include a <meta> element linking to the publicxrds page, for OpenID
 165      * client-side authentication.
 166      *
 167      * @return void
 168      */
 169
 170     function extraHead()
 171     {
 172         // for client side of OpenID authentication
 173         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 174                                      'content' => common_local_url('publicxrds')));
 175     }
 176
 177     /**
 178      * Show tabset for this page
 179      *
 180      * Uses the PublicGroupNav widget
 181      *
 182      * @return void
 183      * @see PublicGroupNav
 184      */
 185
 186     function showLocalNav()
 187     {
 188         $nav = new PublicGroupNav($this);
 189         $nav->show();
 190     }
 191
 192     function showEmptyList()
 193     {
 194         $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
 195
 196         if (common_logged_in()) {
 197             $message .= _('Be the first to post!');
 198         }
 199         else {
 200             $message .= _('Why not [register an account](%%action.register%%) and be the first to post!');
 201         }
 202
 203         $this->elementStart('div', 'guide');
 204         $this->raw(common_markup_to_html($message));
 205         $this->elementEnd('div');
 206     }
 207
 208     /**
 209      * Fill the content area
 210      *
 211      * Shows a list of the notices in the public stream, with some pagination
 212      * controls.
 213      *
 214      * @return void
 215      */
 216
 217     function showContent()
 218     {
 219         $notice = Notice::publicStream(($this->page-1)*NOTICES_PER_PAGE,
 220                                        NOTICES_PER_PAGE + 1);
 221
 222         if (!$notice) {
 223             $this->serverError(_('Could not retrieve public stream.'));
 224             return;
 225         }
 226
 227         $nl = new NoticeList($notice, $this);
 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         // $top = new TopPostersSection($this);
 242         // $top->show();
 243         $pop = new PopularNoticeSection($this);
 244         $pop->show();
 245         $gbp = new GroupsByPostsSection($this);
 246         $gbp->show();
 247         $feat = new FeaturedUsersSection($this);
 248         $feat->show();
 249     }
 250
 251     function showAnonymousMessage()
 252     {
 253         if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
 254             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 255                   'based on the Free Software [Laconica](http://laconi.ca/) tool. ' .
 256                   '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ([Read more](%%doc.help%%))');
 257         } else {
 258             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 259                    'based on the Free Software [Laconica](http://laconi.ca/) tool.');
 260         }
 261         $this->elementStart('div', array('id' => 'anon_notice'));
 262         $this->raw(common_markup_to_html($m));
 263         $this->elementEnd('div');
 264     }
 265 }