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