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