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 class ApiTimelineGroupAction extends ApiPrivateAuthAction
  53 {
  54     var $group   = null;
  55     var $notices = null;
  56
  57     /**
  58      * Take arguments for running
  59      *
  60      * @param array $args $_REQUEST args
  61      *
  62      * @return boolean success flag
  63      *
  64      */
  65     function prepare($args)
  66     {
  67         parent::prepare($args);
  68
  69         $this->group   = $this->getTargetGroup($this->arg('id'));
  70
  71         return true;
  72     }
  73
  74     /**
  75      * Handle the request
  76      *
  77      * Just show the notices
  78      *
  79      * @param array $args $_REQUEST data (unused)
  80      *
  81      * @return void
  82      */
  83     function handle($args)
  84     {
  85         parent::handle($args);
  86
  87         if (empty($this->group)) {
  88             // TRANS: Client error displayed requesting most recent notices to a group for a non-existing group.
  89             $this->clientError(_('Group not found.'), 404, $this->format);
  90             return false;
  91         }
  92
  93         $this->notices = $this->getNotices();
  94         $this->showTimeline();
  95     }
  96
  97     /**
  98      * Show the timeline of notices
  99      *
 100      * @return void
 101      */
 102     function showTimeline()
 103     {
 104         // We'll pull common formatting out of this for other formats
 105         $atom = new AtomGroupNoticeFeed($this->group, $this->auth_user);
 106
 107         $self = $this->getSelfUri();
 108
 109         switch($this->format) {
 110         case 'xml':
 111             $this->showXmlTimeline($this->notices);
 112             break;
 113         case 'rss':
 114             $this->showRssTimeline(
 115                 $this->notices,
 116                 $atom->title,
 117                 $this->group->homeUrl(),
 118                 $atom->subtitle,
 119                 null,
 120                 $atom->logo,
 121                 $self
 122             );
 123             break;
 124         case 'atom':
 125             header('Content-Type: application/atom+xml; charset=utf-8');
 126
 127             try {
 128                 $atom->addAuthorRaw($this->group->asAtomAuthor());
 129                 $atom->setActivitySubject($this->group->asActivitySubject());
 130                 $atom->setId($self);
 131                 $atom->setSelfLink($self);
 132                 $atom->addEntryFromNotices($this->notices);
 133                 $this->raw($atom->getString());
 134             } catch (Atom10FeedException $e) {
 135                 $this->serverError(
 136                     // TRANS: Server error displayed when generating an Atom feed fails.
 137                     // TRANS: %s is the error.
 138                     sprintf(_('Could not generate feed for group - %s'),$e->getMessage()),
 139                     400,
 140                     $this->format
 141                 );
 142                 return;
 143             }
 144             break;
 145         case 'json':
 146             $this->showJsonTimeline($this->notices);
 147             break;
 148         default:
 149             $this->clientError(
 150                 // TRANS: Client error displayed when trying to handle an unknown API method.
 151                 _('API method not found.'),
 152                 404,
 153                 $this->format
 154             );
 155             break;
 156         }
 157     }
 158
 159     /**
 160      * Get notices
 161      *
 162      * @return array notices
 163      */
 164     function getNotices()
 165     {
 166         $notices = array();
 167
 168         $notice = $this->group->getNotices(
 169             ($this->page-1) * $this->count,
 170             $this->count,
 171             $this->since_id,
 172             $this->max_id
 173         );
 174
 175         while ($notice->fetch()) {
 176             $notices[] = clone($notice);
 177         }
 178
 179         return $notices;
 180     }
 181
 182     /**
 183      * Is this action read only?
 184      *
 185      * @param array $args other arguments
 186      *
 187      * @return boolean true
 188      */
 189     function isReadOnly($args)
 190     {
 191         return true;
 192     }
 193
 194     /**
 195      * When was this feed last modified?
 196      *
 197      * @return string datestamp of the latest notice in the stream
 198      */
 199     function lastModified()
 200     {
 201         if (!empty($this->notices) && (count($this->notices) > 0)) {
 202             return strtotime($this->notices[0]->created);
 203         }
 204
 205         return null;
 206     }
 207
 208     /**
 209      * An entity tag for this stream
 210      *
 211      * Returns an Etag based on the action name, language, group ID and
 212      * timestamps of the first and last notice in the timeline
 213      *
 214      * @return string etag
 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_user_cache_hash($this->auth_user),
 226                       common_language(),
 227                       $this->group->id,
 228                       strtotime($this->notices[0]->created),
 229                       strtotime($this->notices[$last]->created))
 230             )
 231             . '"';
 232         }
 233
 234         return null;
 235     }
 236 }