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