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         $sitename   = common_config('site', 'name');
 108         $title      = sprintf(_("%s timeline"), $this->group->nickname);
 109         $taguribase = common_config('integration', 'taguri');
 110         $id         = "tag:$taguribase:GroupTimeline:" . $this->group->id;
 111         $link       = common_local_url(
 112             'showgroup',
 113             array('nickname' => $this->group->nickname)
 114         );
 115         $subtitle   = sprintf(
 116             _('Updates from %1$s on %2$s!'),
 117             $this->group->nickname,
 118             $sitename
 119         );
 120
 121         switch($this->format) {
 122         case 'xml':
 123             $this->showXmlTimeline($this->notices);
 124             break;
 125         case 'rss':
 126             $this->showRssTimeline($this->notices, $title, $link, $subtitle);
 127             break;
 128         case 'atom':
 129             $selfuri = common_root_url() .
 130                 'api/statusnet/groups/timeline/' .
 131                     $this->group->nickname . '.atom';
 132             $this->showAtomTimeline(
 133                 $this->notices,
 134                 $title,
 135                 $id,
 136                 $link,
 137                 $subtitle,
 138                 null,
 139                 $selfuri
 140             );
 141             break;
 142         case 'json':
 143             $this->showJsonTimeline($this->notices);
 144             break;
 145         default:
 146             $this->clientError(
 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
 161     function getNotices()
 162     {
 163         $notices = array();
 164
 165         $notice = $this->group->getNotices(
 166             ($this->page-1) * $this->count,
 167             $this->count,
 168             $this->since_id,
 169             $this->max_id,
 170             $this->since
 171         );
 172
 173         while ($notice->fetch()) {
 174             $notices[] = clone($notice);
 175         }
 176
 177         return $notices;
 178     }
 179
 180     /**
 181      * Is this action read only?
 182      *
 183      * @param array $args other arguments
 184      *
 185      * @return boolean true
 186      */
 187
 188     function isReadOnly($args)
 189     {
 190         return true;
 191     }
 192
 193     /**
 194      * When was this feed last modified?
 195      *
 196      * @return string datestamp of the latest notice in the stream
 197      */
 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
 217     function etag()
 218     {
 219         if (!empty($this->notices) && (count($this->notices) > 0)) {
 220
 221             $last = count($this->notices) - 1;
 222
 223             return '"' . implode(
 224                 ':',
 225                 array($this->arg('action'),
 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
 237 }