actions/apitimelinetag.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show the latest notices for a given tag
   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 20 most recent notices tagged by a given tag
  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 ApiTimelineTagAction extends ApiPrivateAuthAction
  53 {
  54
  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
  66     function prepare($args)
  67     {
  68         parent::prepare($args);
  69
  70         $this->tag     = $this->arg('tag');
  71         $this->notices = $this->getNotices();
  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         $this->showTimeline();
  90     }
  91
  92     /**
  93      * Show the timeline of notices
  94      *
  95      * @return void
  96      */
  97
  98     function showTimeline()
  99     {
 100         $sitename   = common_config('site', 'name');
 101         $title      = sprintf(_("Notices tagged with %s"), $this->tag);
 102         $link       = common_local_url(
 103             'tag',
 104             array('tag' => $this->tag)
 105         );
 106         $subtitle   = sprintf(
 107             _('Updates tagged with %1$s on %2$s!'),
 108             $this->tag,
 109             $sitename
 110         );
 111         $taguribase = common_config('integration', 'taguri');
 112         $id         = "tag:$taguribase:TagTimeline:".$tag;
 113
 114         switch($this->format) {
 115         case 'xml':
 116             $this->showXmlTimeline($this->notices);
 117             break;
 118         case 'rss':
 119             $this->showRssTimeline($this->notices, $title, $link, $subtitle);
 120             break;
 121         case 'atom':
 122             $selfuri = common_root_url() .
 123                 'api/statusnet/tags/timeline/' .
 124                     $this->tag . '.atom';
 125             $this->showAtomTimeline(
 126                 $this->notices,
 127                 $title,
 128                 $id,
 129                 $link,
 130                 $subtitle,
 131                 null,
 132                 $selfuri
 133             );
 134             break;
 135         case 'json':
 136             $this->showJsonTimeline($this->notices);
 137             break;
 138         default:
 139             $this->clientError(_('API method not found!'), $code = 404);
 140             break;
 141         }
 142     }
 143
 144     /**
 145      * Get notices
 146      *
 147      * @return array notices
 148      */
 149
 150     function getNotices()
 151     {
 152         $notices = array();
 153
 154         $notice = Notice_tag::getStream(
 155             $this->tag,
 156             ($this->page - 1) * $this->count,
 157             $this->count + 1
 158         );
 159
 160         while ($notice->fetch()) {
 161             $notices[] = clone($notice);
 162         }
 163
 164         return $notices;
 165     }
 166
 167     /**
 168      * Is this action read only?
 169      *
 170      * @param array $args other arguments
 171      *
 172      * @return boolean true
 173      */
 174
 175     function isReadOnly($args)
 176     {
 177         return true;
 178     }
 179
 180     /**
 181      * When was this feed last modified?
 182      *
 183      * @return string datestamp of the latest notice in the stream
 184      */
 185
 186     function lastModified()
 187     {
 188         if (!empty($this->notices) && (count($this->notices) > 0)) {
 189             return strtotime($this->notices[0]->created);
 190         }
 191
 192         return null;
 193     }
 194
 195     /**
 196      * An entity tag for this stream
 197      *
 198      * Returns an Etag based on the action name, language, and
 199      * timestamps of the first and last notice in the timeline
 200      *
 201      * @return string etag
 202      */
 203
 204     function etag()
 205     {
 206         if (!empty($this->notices) && (count($this->notices) > 0)) {
 207
 208             $last = count($this->notices) - 1;
 209
 210             return '"' . implode(
 211                 ':',
 212                 array($this->arg('action'),
 213                       common_language(),
 214                       $this->tag,
 215                       strtotime($this->notices[0]->created),
 216                       strtotime($this->notices[$last]->created))
 217             )
 218             . '"';
 219         }
 220
 221         return null;
 222     }
 223
 224 }