actions/apitimelinegroup.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show a group's notices
   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    Zach Copley <zach@status.net>
  28  * @copyright 2009-2010 StatusNet, Inc.
  29  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  30  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  31  * @link      http://status.net/
  32  */
  33
  34 if (!defined('STATUSNET')) {
  35     exit(1);
  36 }
  37
  38 require_once INSTALLDIR . '/lib/apiprivateauth.php';
  39
  40 /**
  41  * Returns the most recent notices (default 20) posted to the group specified by ID
  42  *
  43  * @category API
  44  * @package  StatusNet
  45  * @author   Craig Andrews <candrews@integralblue.com>
  46  * @author   Evan Prodromou <evan@status.net>
  47  * @author   Jeffery To <jeffery.to@gmail.com>
  48  * @author   Zach Copley <zach@status.net>
  49  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  50  * @link     http://status.net/
  51  */
  52
  53 class ApiTimelineGroupAction extends ApiPrivateAuthAction
  54 {
  55
  56     var $group   = null;
  57     var $notices = null;
  58
  59     /**
  60      * Take arguments for running
  61      *
  62      * @param array $args $_REQUEST args
  63      *
  64      * @return boolean success flag
  65      *
  66      */
  67
  68     function prepare($args)
  69     {
  70         parent::prepare($args);
  71
  72         $this->group   = $this->getTargetGroup($this->arg('id'));
  73
  74         return true;
  75     }
  76
  77     /**
  78      * Handle the request
  79      *
  80      * Just show the notices
  81      *
  82      * @param array $args $_REQUEST data (unused)
  83      *
  84      * @return void
  85      */
  86
  87     function handle($args)
  88     {
  89         parent::handle($args);
  90
  91         if (empty($this->group)) {
  92             $this->clientError(_('Group not found.'), 404, $this->format);
  93             return false;
  94         }
  95
  96         $this->notices = $this->getNotices();
  97         $this->showTimeline();
  98     }
  99
 100     /**
 101      * Show the timeline of notices
 102      *
 103      * @return void
 104      */
 105
 106     function showTimeline()
 107     {
 108         // We'll pull common formatting out of this for other formats
 109         $atom = new AtomGroupNoticeFeed($this->group, $this->auth_user);
 110
 111         $self = $this->getSelfUri();
 112
 113         switch($this->format) {
 114         case 'xml':
 115             $this->showXmlTimeline($this->notices);
 116             break;
 117         case 'rss':
 118             $this->showRssTimeline(
 119                 $this->notices,
 120                 $atom->title,
 121                 $this->group->homeUrl(),
 122                 $atom->subtitle,
 123                 null,
 124                 $atom->logo,
 125                 $self
 126             );
 127             break;
 128         case 'atom':
 129
 130             header('Content-Type: application/atom+xml; charset=utf-8');
 131
 132             try {
 133                 $atom->addAuthorRaw($this->group->asAtomAuthor());
 134                 $atom->setActivitySubject($this->group->asActivitySubject());
 135                 $atom->setId($self);
 136                 $atom->setSelfLink($self);
 137                 $atom->addEntryFromNotices($this->notices);
 138                 $this->raw($atom->getString());
 139             } catch (Atom10FeedException $e) {
 140                 $this->serverError(
 141                     'Could not generate feed for group - ' . $e->getMessage(),
 142                     400,
 143                     $this->format
 144                 );
 145                 return;
 146             }
 147
 148             break;
 149         case 'json':
 150             $this->showJsonTimeline($this->notices);
 151             break;
 152         default:
 153             $this->clientError(
 154                 _('API method not found.'),
 155                 404,
 156                 $this->format
 157             );
 158             break;
 159         }
 160     }
 161
 162     /**
 163      * Get notices
 164      *
 165      * @return array notices
 166      */
 167
 168     function getNotices()
 169     {
 170         $notices = array();
 171
 172         $notice = $this->group->getNotices(
 173             ($this->page-1) * $this->count,
 174             $this->count,
 175             $this->since_id,
 176             $this->max_id
 177         );
 178
 179         while ($notice->fetch()) {
 180             $notices[] = clone($notice);
 181         }
 182
 183         return $notices;
 184     }
 185
 186     /**
 187      * Is this action read only?
 188      *
 189      * @param array $args other arguments
 190      *
 191      * @return boolean true
 192      */
 193
 194     function isReadOnly($args)
 195     {
 196         return true;
 197     }
 198
 199     /**
 200      * When was this feed last modified?
 201      *
 202      * @return string datestamp of the latest notice in the stream
 203      */
 204
 205     function lastModified()
 206     {
 207         if (!empty($this->notices) && (count($this->notices) > 0)) {
 208             return strtotime($this->notices[0]->created);
 209         }
 210
 211         return null;
 212     }
 213
 214     /**
 215      * An entity tag for this stream
 216      *
 217      * Returns an Etag based on the action name, language, group ID and
 218      * timestamps of the first and last notice in the timeline
 219      *
 220      * @return string etag
 221      */
 222
 223     function etag()
 224     {
 225         if (!empty($this->notices) && (count($this->notices) > 0)) {
 226
 227             $last = count($this->notices) - 1;
 228
 229             return '"' . implode(
 230                 ':',
 231                 array($this->arg('action'),
 232                       common_user_cache_hash($this->auth_user),
 233                       common_language(),
 234                       $this->group->id,
 235                       strtotime($this->notices[0]->created),
 236                       strtotime($this->notices[$last]->created))
 237             )
 238             . '"';
 239         }
 240
 241         return null;
 242     }
 243
 244 }