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         return true;
  79     }
  80
  81     /**
  82      * Handle the request
  83      *
  84      * Just show the notices
  85      *
  86      * @param array $args $_REQUEST data (unused)
  87      *
  88      * @return void
  89      */
  90
  91     function handle($args)
  92     {
  93         parent::handle($args);
  94         $this->showTimeline();
  95     }
  96
  97     /**
  98      * Show the timeline of notices
  99      *
 100      * @return void
 101      */
 102
 103     function showTimeline()
 104     {
 105         $sitename   = common_config('site', 'name');
 106         $sitelogo   = (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png');
 107         $title      = sprintf(_("%s public timeline"), $sitename);
 108         $taguribase = TagURI::base();
 109         $id         = "tag:$taguribase:PublicTimeline";
 110         $link       = common_root_url();
 111         $subtitle   = sprintf(_("%s updates from everyone!"), $sitename);
 112
 113         switch($this->format) {
 114         case 'xml':
 115             $this->showXmlTimeline($this->notices);
 116             break;
 117         case 'rss':
 118             $this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $sitelogo);
 119             break;
 120         case 'atom':
 121
 122             $atom = new AtomNoticeFeed();
 123
 124             $atom->setId($id);
 125             $atom->setTitle($title);
 126             $atom->setSubtitle($subtitle);
 127             $atom->setLogo($sitelogo);
 128             $atom->setUpdated('now');
 129
 130             $atom->addLink(common_local_url('public'));
 131
 132             $atom->addLink(
 133                 $this->getSelfUri(
 134                     'ApiTimelinePublic', array('format' => 'atom')
 135                 ),
 136                 array('rel' => 'self', 'type' => 'application/atom+xml')
 137             );
 138
 139             $atom->addEntryFromNotices($this->notices);
 140
 141             $this->raw($atom->getString());
 142
 143             break;
 144         case 'json':
 145             $this->showJsonTimeline($this->notices);
 146             break;
 147         default:
 148             $this->clientError(_('API method not found.'), $code = 404);
 149             break;
 150         }
 151     }
 152
 153     /**
 154      * Get notices
 155      *
 156      * @return array notices
 157      */
 158
 159     function getNotices()
 160     {
 161         $notices = array();
 162
 163         $notice = Notice::publicStream(
 164             ($this->page - 1) * $this->count, $this->count, $this->since_id,
 165             $this->max_id
 166         );
 167
 168         while ($notice->fetch()) {
 169             $notices[] = clone($notice);
 170         }
 171
 172         return $notices;
 173     }
 174
 175     /**
 176      * Is this action read only?
 177      *
 178      * @param array $args other arguments
 179      *
 180      * @return boolean true
 181      */
 182
 183     function isReadOnly($args)
 184     {
 185         return true;
 186     }
 187
 188     /**
 189      * When was this feed last modified?
 190      *
 191      * @return string datestamp of the latest notice in the stream
 192      */
 193
 194     function lastModified()
 195     {
 196         if (!empty($this->notices) && (count($this->notices) > 0)) {
 197             return strtotime($this->notices[0]->created);
 198         }
 199
 200         return null;
 201     }
 202
 203     /**
 204      * An entity tag for this stream
 205      *
 206      * Returns an Etag based on the action name, language, and
 207      * timestamps of the first and last notice in the timeline
 208      *
 209      * @return string etag
 210      */
 211
 212     function etag()
 213     {
 214         if (!empty($this->notices) && (count($this->notices) > 0)) {
 215
 216             $last = count($this->notices) - 1;
 217
 218             return '"' . implode(
 219                 ':',
 220                 array($this->arg('action'),
 221                       common_language(),
 222                       strtotime($this->notices[0]->created),
 223                       strtotime($this->notices[$last]->created))
 224             )
 225             . '"';
 226         }
 227
 228         return null;
 229     }
 230
 231 }