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         $title      = sprintf(_("%s public timeline"), $sitename);
 107         $taguribase = common_config('integration', 'taguri');
 108         $id         = "tag:$taguribase:PublicTimeline";
 109         $link       = common_root_url();
 110         $subtitle   = sprintf(_("%s updates from everyone!"), $sitename);
 111
 112         switch($this->format) {
 113         case 'xml':
 114             $this->showXmlTimeline($this->notices);
 115             break;
 116         case 'rss':
 117             $this->showRssTimeline($this->notices, $title, $link, $subtitle);
 118             break;
 119         case 'atom':
 120             $selfuri = common_root_url() . 'api/statuses/public_timeline.atom';
 121             $this->showAtomTimeline(
 122                 $this->notices, $title, $id, $link,
 123                 $subtitle, null, $selfuri
 124             );
 125             break;
 126         case 'json':
 127             $this->showJsonTimeline($this->notices);
 128             break;
 129         default:
 130             $this->clientError(_('API method not found!'), $code = 404);
 131             break;
 132         }
 133     }
 134
 135     /**
 136      * Get notices
 137      *
 138      * @return array notices
 139      */
 140
 141     function getNotices()
 142     {
 143         $notices = array();
 144
 145         $notice = Notice::publicStream(
 146             ($this->page - 1) * $this->count, $this->count, $this->since_id,
 147             $this->max_id, $this->since
 148         );
 149
 150         while ($notice->fetch()) {
 151             $notices[] = clone($notice);
 152         }
 153
 154         return $notices;
 155     }
 156
 157     /**
 158      * Is this action read only?
 159      *
 160      * @param array $args other arguments
 161      *
 162      * @return boolean true
 163      */
 164
 165     function isReadOnly($args)
 166     {
 167         return true;
 168     }
 169
 170     /**
 171      * When was this feed last modified?
 172      *
 173      * @return string datestamp of the latest notice in the stream
 174      */
 175
 176     function lastModified()
 177     {
 178         if (!empty($this->notices) && (count($this->notices) > 0)) {
 179             return strtotime($this->notices[0]->created);
 180         }
 181
 182         return null;
 183     }
 184
 185     /**
 186      * An entity tag for this stream
 187      *
 188      * Returns an Etag based on the action name, language, and
 189      * timestamps of the first and last notice in the timeline
 190      *
 191      * @return string etag
 192      */
 193
 194     function etag()
 195     {
 196         if (!empty($this->notices) && (count($this->notices) > 0)) {
 197
 198             $last = count($this->notices) - 1;
 199
 200             return '"' . implode(
 201                 ':',
 202                 array($this->arg('action'),
 203                       common_language(),
 204                       strtotime($this->notices[0]->created),
 205                       strtotime($this->notices[$last]->created))
 206             )
 207             . '"';
 208         }
 209
 210         return null;
 211     }
 212
 213 }