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 showFeeds()
 135     {
 136         $this->element('link', array('rel' => 'alternate',
 137                                      'href' => common_local_url('publicrss'),
 138                                      'type' => 'application/rss+xml',
 139                                      'title' => _('Public Stream Feed')));
 140     }
 141
 142     /**
 143      * Output document relationship links
 144      *
 145      * @return void
 146      */
 147     function showRelationshipLinks()
 148     {
 149         $this->sequenceRelationships($this->page > 1, $this->count > NOTICES_PER_PAGE, // FIXME
 150                                      $this->page, 'public');
 151     }
 152
 153     /**
 154      * Extra head elements
 155      *
 156      * We include a <meta> element linking to the publicxrds page, for OpenID
 157      * client-side authentication.
 158      *
 159      * @return void
 160      */
 161
 162     function extraHead()
 163     {
 164         // for client side of OpenID authentication
 165         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 166                                      'content' => common_local_url('publicxrds')));
 167     }
 168
 169     /**
 170      * Show tabset for this page
 171      *
 172      * Uses the PublicGroupNav widget
 173      *
 174      * @return void
 175      * @see PublicGroupNav
 176      */
 177
 178     function showLocalNav()
 179     {
 180         $nav = new PublicGroupNav($this);
 181         $nav->show();
 182     }
 183
 184     /**
 185      * Fill the content area
 186      *
 187      * Shows a list of the notices in the public stream, with some pagination
 188      * controls.
 189      *
 190      * @return void
 191      */
 192
 193     function showContent()
 194     {
 195         $notice = Notice::publicStream(($this->page-1)*NOTICES_PER_PAGE,
 196                                        NOTICES_PER_PAGE + 1);
 197
 198         if (!$notice) {
 199             $this->serverError(_('Could not retrieve public stream.'));
 200             return;
 201         }
 202
 203         $nl = new NoticeList($notice, $this);
 204
 205         $cnt = $nl->show();
 206
 207         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 208                           $this->page, 'public');
 209     }
 210
 211     /**
 212      * Makes a list of exported feeds for this page
 213      *
 214      * @return void
 215      *
 216      * @todo I18N
 217      */
 218
 219     function showExportData()
 220     {
 221         $fl = new FeedList($this);
 222         $fl->show(array(0 => array('href' => common_local_url('publicrss'),
 223                                    'type' => 'rss',
 224                                    'version' => 'RSS 1.0',
 225                                    'item' => 'publicrss'),
 226                         1 => array('href' => common_local_url('publicatom'),
 227                                    'type' => 'atom',
 228                                    'version' => 'Atom 1.0',
 229                                    'item' => 'publicatom')));
 230     }
 231
 232     function showSections()
 233     {
 234         // $top = new TopPostersSection($this);
 235         // $top->show();
 236         $pop = new PopularNoticeSection($this);
 237         $pop->show();
 238         $gbp = new GroupsByPostsSection($this);
 239         $gbp->show();
 240         $feat = new FeaturedUsersSection($this);
 241         $feat->show();
 242     }
 243
 244     function showAnonymousMessage()
 245     {
 246                 $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 247                'based on the Free Software [Laconica](http://laconi.ca/) tool. ' .
 248                '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ([Read more](%%doc.help%%))');
 249         $this->elementStart('div', array('id' => 'anon_notice'));
 250         $this->raw(common_markup_to_html($m));
 251         $this->elementEnd('div');
 252     }
 253 }