actions/apitimelinepublic.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show the public timeline
   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  API
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Jeffery To <jeffery.to@gmail.com>
  27  * @author    mac65 <mac65@mac65.com>
  28  * @author    Mike Cochrane <mikec@mikenz.geek.nz>
  29  * @author    Robin Millette <robin@millette.info>
  30  * @author    Zach Copley <zach@status.net>
  31  * @copyright 2009 StatusNet, Inc.
  32  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  33  * @link      http://status.net/
  34  */
  35
  36 if (!defined('STATUSNET')) {
  37     exit(1);
  38 }
  39
  40 require_once INSTALLDIR . '/lib/apiprivateauth.php';
  41
  42 /**
  43  * Returns the most recent notices (default 20) posted by everybody
  44  *
  45  * @category API
  46  * @package  StatusNet
  47  * @author   Craig Andrews <candrews@integralblue.com>
  48  * @author   Evan Prodromou <evan@status.net>
  49  * @author   Jeffery To <jeffery.to@gmail.com>
  50  * @author   mac65 <mac65@mac65.com>
  51  * @author   Mike Cochrane <mikec@mikenz.geek.nz>
  52  * @author   Robin Millette <robin@millette.info>
  53  * @author   Zach Copley <zach@status.net>
  54  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  55  * @link     http://status.net/
  56  */
  57
  58 class ApiTimelinePublicAction extends ApiPrivateAuthAction
  59 {
  60
  61     var $notices = null;
  62
  63     /**
  64      * Take arguments for running
  65      *
  66      * @param array $args $_REQUEST args
  67      *
  68      * @return boolean success flag
  69      *
  70      */
  71
  72     function prepare($args)
  73     {
  74         parent::prepare($args);
  75
  76         $this->notices = $this->getNotices();
  77
  78         if ($this->since) {
  79             throw new ServerException("since parameter is disabled for performance; use since_id", 403);
  80         }
  81
  82         return true;
  83     }
  84
  85     /**
  86      * Handle the request
  87      *
  88      * Just show the notices
  89      *
  90      * @param array $args $_REQUEST data (unused)
  91      *
  92      * @return void
  93      */
  94
  95     function handle($args)
  96     {
  97         parent::handle($args);
  98         $this->showTimeline();
  99     }
 100
 101     /**
 102      * Show the timeline of notices
 103      *
 104      * @return void
 105      */
 106
 107     function showTimeline()
 108     {
 109         $sitename   = common_config('site', 'name');
 110         $sitelogo   = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png');
 111         $title      = sprintf(_("%s public timeline"), $sitename);
 112         $taguribase = common_config('integration', 'taguri');
 113         $id         = "tag:$taguribase:PublicTimeline";
 114         $link       = common_root_url();
 115         $subtitle   = sprintf(_("%s updates from everyone!"), $sitename);
 116
 117         switch($this->format) {
 118         case 'xml':
 119             $this->showXmlTimeline($this->notices);
 120             break;
 121         case 'rss':
 122             $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $sitelogo);
 123             break;
 124         case 'atom':
 125
 126             $atom = new AtomNoticeFeed();
 127
 128             $atom->setId($id);
 129             $atom->setTitle($title);
 130             $atom->setSubtitle($subtitle);
 131             $atom->setLogo($sitelogo);
 132             $atom->setUpdated('now');
 133
 134             $atom->addLink(common_local_url('public'));
 135
 136             $atom->addLink(
 137                 $this->getSelfUri(
 138                     'ApiTimelinePublic', array('format' => 'atom')
 139                 ),
 140                 array('rel' => 'self', 'type' => 'application/atom+xml')
 141             );
 142
 143             $atom->addEntryFromNotices($this->notices);
 144
 145             $this->raw($atom->getString());
 146
 147             break;
 148         case 'json':
 149             $this->showJsonTimeline($this->notices);
 150             break;
 151         default:
 152             $this->clientError(_('API method not found.'), $code = 404);
 153             break;
 154         }
 155     }
 156
 157     /**
 158      * Get notices
 159      *
 160      * @return array notices
 161      */
 162
 163     function getNotices()
 164     {
 165         $notices = array();
 166
 167         $notice = Notice::publicStream(
 168             ($this->page - 1) * $this->count, $this->count, $this->since_id,
 169             $this->max_id
 170         );
 171
 172         while ($notice->fetch()) {
 173             $notices[] = clone($notice);
 174         }
 175
 176         return $notices;
 177     }
 178
 179     /**
 180      * Is this action read only?
 181      *
 182      * @param array $args other arguments
 183      *
 184      * @return boolean true
 185      */
 186
 187     function isReadOnly($args)
 188     {
 189         return true;
 190     }
 191
 192     /**
 193      * When was this feed last modified?
 194      *
 195      * @return string datestamp of the latest notice in the stream
 196      */
 197
 198     function lastModified()
 199     {
 200         if (!empty($this->notices) && (count($this->notices) > 0)) {
 201             return strtotime($this->notices[0]->created);
 202         }
 203
 204         return null;
 205     }
 206
 207     /**
 208      * An entity tag for this stream
 209      *
 210      * Returns an Etag based on the action name, language, and
 211      * timestamps of the first and last notice in the timeline
 212      *
 213      * @return string etag
 214      */
 215
 216     function etag()
 217     {
 218         if (!empty($this->notices) && (count($this->notices) > 0)) {
 219
 220             $last = count($this->notices) - 1;
 221
 222             return '"' . implode(
 223                 ':',
 224                 array($this->arg('action'),
 225                       common_language(),
 226                       strtotime($this->notices[0]->created),
 227                       strtotime($this->notices[$last]->created))
 228             )
 229             . '"';
 230         }
 231
 232         return null;
 233     }
 234
 235 }