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()
  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         return true;
  77     }
  78
  79     /**
  80      * handle request
  81      *
  82      * Show the public stream, using recipe method showPage()
  83      *
  84      * @param array $args arguments, mostly unused
  85      *
  86      * @return void
  87      */
  88
  89     function handle($args)
  90     {
  91         parent::handle($args);
  92
  93         header('X-XRDS-Location: '. common_local_url('publicxrds'));
  94
  95         $this->showPage();
  96     }
  97
  98     /**
  99      * Title of the page
 100      *
 101      * @return page title, including page number if over 1
 102      */
 103
 104     function title()
 105     {
 106         if ($this->page > 1) {
 107             return sprintf(_('Public timeline, page %d'), $this->page);
 108         } else {
 109             return _('Public timeline');
 110         }
 111     }
 112
 113     /**
 114      * Output <head> elements for RSS and Atom feeds
 115      *
 116      * @return void
 117      */
 118
 119     function showFeeds()
 120     {
 121         $this->element('link', array('rel' => 'alternate',
 122                                      'href' => common_local_url('publicrss'),
 123                                      'type' => 'application/rss+xml',
 124                                      'title' => _('Public Stream Feed')));
 125     }
 126
 127     /**
 128      * Extra head elements
 129      *
 130      * We include a <meta> element linking to the publicxrds page, for OpenID
 131      * client-side authentication.
 132      *
 133      * @return void
 134      */
 135
 136     function extraHead()
 137     {
 138         // for client side of OpenID authentication
 139         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 140                                      'content' => common_local_url('publicxrds')));
 141     }
 142
 143     /**
 144      * Show tabset for this page
 145      *
 146      * Uses the PublicGroupNav widget
 147      *
 148      * @return void
 149      * @see PublicGroupNav
 150      */
 151
 152     function showLocalNav()
 153     {
 154         $nav = new PublicGroupNav($this);
 155         $nav->show();
 156     }
 157
 158     /**
 159      * Fill the content area
 160      *
 161      * Shows a list of the notices in the public stream, with some pagination
 162      * controls.
 163      *
 164      * @return void
 165      */
 166
 167     function showContent()
 168     {
 169         $notice = Notice::publicStream(($this->page-1)*NOTICES_PER_PAGE,
 170                                        NOTICES_PER_PAGE + 1);
 171
 172         if (!$notice) {
 173             $this->serverError(_('Could not retrieve public stream.'));
 174             return;
 175         }
 176
 177         $nl = new NoticeList($notice, $this);
 178
 179         $cnt = $nl->show();
 180
 181         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 182                           $this->page, 'public');
 183     }
 184
 185     /**
 186      * Makes a list of exported feeds for this page
 187      *
 188      * @return void
 189      *
 190      * @todo I18N
 191      */
 192
 193     function showExportData()
 194     {
 195         $fl = new FeedList($this);
 196         $fl->show(array(0 => array('href' => common_local_url('publicrss'),
 197                                    'type' => 'rss',
 198                                    'version' => 'RSS 1.0',
 199                                    'item' => 'publicrss'),
 200                         1 => array('href' => common_local_url('publicatom'),
 201                                    'type' => 'atom',
 202                                    'version' => 'Atom 1.0',
 203                                    'item' => 'publicatom')));
 204     }
 205
 206     function showSections()
 207     {
 208         $top = new TopPostersSection($this);
 209         $top->show();
 210         $pop = new PopularNoticeSection($this);
 211         $pop->show();
 212         $gbp = new GroupsByPostsSection($this);
 213         $gbp->show();
 214         $feat = new FeaturedUsersSection($this);
 215         $feat->show();
 216     }
 217
 218     function showAnonymousMessage()
 219     {
 220                 $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
 221                'based on the Free Software [Laconica](http://laconi.ca/) tool. ' .
 222                '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ([Read more](%%doc.help%%))');
 223         $this->elementStart('div', array('id' => 'anon_notice'));
 224         $this->raw(common_markup_to_html($m));
 225         $this->elementEnd('div');
 226     }
 227 }