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->addEntryFromNotices($this->notices);
 129                 $this->raw($atom->getString());
 130             } catch (Atom10FeedException $e) {
 131                 $this->serverError(
 132                     // TRANS: Server error displayed when generating an Atom feed fails.
 133                     // TRANS: %s is the error.
 134                     sprintf(_('Could not generate feed for group - %s'),$e->getMessage()),
 135                     400,
 136                     $this->format
 137                 );
 138                 return;
 139             }
 140             break;
 141         case 'json':
 142             $this->showJsonTimeline($this->notices);
 143             break;
 144         default:
 145             $this->clientError(
 146                 // TRANS: Client error displayed when trying to handle an unknown API method.
 147                 _('API method not found.'),
 148                 404,
 149                 $this->format
 150             );
 151             break;
 152         }
 153     }
 154
 155     /**
 156      * Get notices
 157      *
 158      * @return array notices
 159      */
 160     function getNotices()
 161     {
 162         $notices = array();
 163
 164         $notice = $this->group->getNotices(
 165             ($this->page-1) * $this->count,
 166             $this->count,
 167             $this->since_id,
 168             $this->max_id
 169         );
 170
 171         while ($notice->fetch()) {
 172             $notices[] = clone($notice);
 173         }
 174
 175         return $notices;
 176     }
 177
 178     /**
 179      * Is this action read only?
 180      *
 181      * @param array $args other arguments
 182      *
 183      * @return boolean true
 184      */
 185     function isReadOnly($args)
 186     {
 187         return true;
 188     }
 189
 190     /**
 191      * When was this feed last modified?
 192      *
 193      * @return string datestamp of the latest notice in the stream
 194      */
 195     function lastModified()
 196     {
 197         if (!empty($this->notices) && (count($this->notices) > 0)) {
 198             return strtotime($this->notices[0]->created);
 199         }
 200
 201         return null;
 202     }
 203
 204     /**
 205      * An entity tag for this stream
 206      *
 207      * Returns an Etag based on the action name, language, group ID and
 208      * timestamps of the first and last notice in the timeline
 209      *
 210      * @return string etag
 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_user_cache_hash($this->auth_user),
 222                       common_language(),
 223                       $this->group->id,
 224                       strtotime($this->notices[0]->created),
 225                       strtotime($this->notices[$last]->created))
 226             )
 227             . '"';
 228         }
 229
 230         return null;
 231     }
 232 }