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
  36 /**
  37  * Action for displaying the public stream
  38  *
  39  * @category Public
  40  * @package  Laconica
  41  * @author   Evan Prodromou <evan@controlyourself.ca>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://laconi.ca/
  44  *
  45  * @see      PublicrssAction
  46  * @see      PublicxrdsAction
  47  */
  48
  49 class PublicAction extends Action
  50 {
  51     /**
  52      * page of the stream we're on; default = 1
  53      */
  54
  55     var $page = null;
  56
  57     /**
  58      * Read and validate arguments
  59      *
  60      * @param array $args URL parameters
  61      *
  62      * @return boolean success value
  63      */
  64
  65     function prepare($args)
  66     {
  67         parent::prepare($args);
  68         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
  69         return true;
  70     }
  71
  72     /**
  73      * handle request
  74      *
  75      * Show the public stream, using recipe method showPage()
  76      *
  77      * @param array $args arguments, mostly unused
  78      *
  79      * @return void
  80      */
  81
  82     function handle($args)
  83     {
  84         parent::handle($args);
  85
  86         header('X-XRDS-Location: '. common_local_url('publicxrds'));
  87
  88         $this->showPage();
  89     }
  90
  91     /**
  92      * Title of the page
  93      *
  94      * @return page title, including page number if over 1
  95      */
  96
  97     function title()
  98     {
  99         if ($this->page > 1) {
 100             return sprintf(_('Public timeline, page %d'), $this->page);
 101         } else {
 102             return _('Public timeline');
 103         }
 104     }
 105
 106     /**
 107      * Output <head> elements for RSS and Atom feeds
 108      *
 109      * @return void
 110      */
 111
 112     function showFeeds()
 113     {
 114         $this->element('link', array('rel' => 'alternate',
 115                                      'href' => common_local_url('publicrss'),
 116                                      'type' => 'application/rss+xml',
 117                                      'title' => _('Public Stream Feed')));
 118     }
 119
 120     /**
 121      * Extra head elements
 122      *
 123      * We include a <meta> element linking to the publicxrds page, for OpenID
 124      * client-side authentication.
 125      *
 126      * @return void
 127      */
 128
 129     function extraHead()
 130     {
 131         // for client side of OpenID authentication
 132         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
 133                                      'content' => common_local_url('publicxrds')));
 134     }
 135
 136     /**
 137      * Show tabset for this page
 138      *
 139      * Uses the PublicGroupNav widget
 140      *
 141      * @return void
 142      * @see PublicGroupNav
 143      */
 144
 145     function showLocalNav()
 146     {
 147         $nav = new PublicGroupNav($this);
 148         $nav->show();
 149     }
 150
 151     /**
 152      * Fill the content area
 153      *
 154      * Shows a list of the notices in the public stream, with some pagination
 155      * controls.
 156      *
 157      * @return void
 158      */
 159
 160     function showContent()
 161     {
 162         $notice = Notice::publicStream(($this->page-1)*NOTICES_PER_PAGE,
 163                                        NOTICES_PER_PAGE + 1);
 164
 165         if (!$notice) {
 166             $this->server_error(_('Could not retrieve public stream.'));
 167             return;
 168         }
 169
 170         $nl = new NoticeList($notice);
 171
 172         $cnt = $nl->show();
 173
 174         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 175                           $this->page, 'public');
 176     }
 177
 178     /**
 179      * Makes a list of exported feeds for this page
 180      *
 181      * @return void
 182      *
 183      * @todo I18N
 184      */
 185
 186     function showExportData()
 187     {
 188         $fl = new FeedList($this);
 189         $fl->show(array(0 => array('href' => common_local_url('publicrss'),
 190                                    'type' => 'rss',
 191                                    'version' => 'RSS 1.0',
 192                                    'item' => 'publicrss'),
 193                         1 => array('href' => common_local_url('publicatom'),
 194                                    'type' => 'atom',
 195                                    'version' => 'Atom 1.0',
 196                                    'item' => 'publicatom')));
 197     }
 198 }