actions/apitimelineretweetedtome.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show most recent notices that are repeats in user's inbox
   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    Evan Prodromou <evan@status.net>
  25  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/apiauth.php';
  35
  36 /**
  37  * Show most recent notices that are repeats in user's inbox
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Evan Prodromou <evan@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45 class ApiTimelineRetweetedToMeAction extends ApiAuthAction
  46 {
  47     const DEFAULTCOUNT = 20;
  48     const MAXCOUNT     = 200;
  49     const MAXNOTICES   = 3200;
  50
  51     var $repeats  = null;
  52     var $cnt      = self::DEFAULTCOUNT;
  53     var $page     = 1;
  54     var $since_id = null;
  55     var $max_id   = null;
  56
  57     /**
  58      * Take arguments for running
  59      *
  60      * @param array $args $_REQUEST args
  61      *
  62      * @return boolean success flag
  63      */
  64     function prepare($args)
  65     {
  66         parent::prepare($args);
  67
  68         $cnt = $this->int('count', self::DEFAULTCOUNT, self::MAXCOUNT, 1);
  69
  70         $page = $this->int('page', 1, (self::MAXNOTICES/$this->cnt));
  71
  72         $since_id = $this->int('since_id');
  73
  74         $max_id = $this->int('max_id');
  75
  76         return true;
  77     }
  78
  79     /**
  80      * Handle the request
  81      *
  82      * show a timeline of the user's repeated notices
  83      *
  84      * @param array $args $_REQUEST data (unused)
  85      *
  86      * @return void
  87      */
  88     function handle($args)
  89     {
  90         parent::handle($args);
  91
  92         $offset = ($this->page-1) * $this->cnt;
  93         $limit  = $this->cnt;
  94
  95         // TRANS: Title for Atom feed "repeated to me". %s is the user nickname.
  96         $title      = sprintf(_("Repeated to %s"), $this->auth_user->nickname);
  97         $subtitle   = sprintf(
  98             // @todo FIXME: $profile is not defined.
  99             // TRANS: Subtitle for API action that shows most recent notices that are repeats in user's inbox.
 100             // TRANS: %1$s is the sitename, %2$s is a user nickname, %3$s is a user profile name.
 101             _('%1$s notices that were to repeated to %2$s / %3$s.'),
 102             $sitename, $this->user->nickname, $profile->getBestName()
 103         );
 104         $taguribase = TagURI::base();
 105         $id         = "tag:$taguribase:RepeatedToMe:" . $this->auth_user->id;
 106
 107         $link = common_local_url(
 108             'all',
 109              array('nickname' => $this->auth_user->nickname)
 110         );
 111
 112         $strm = $this->auth_user->repeatedToMe($offset, $limit, $this->since_id, $this->max_id);
 113
 114         switch ($this->format) {
 115         case 'xml':
 116             $this->showXmlTimeline($strm);
 117             break;
 118         case 'json':
 119             $this->showJsonTimeline($strm);
 120             break;
 121         case 'atom':
 122             header('Content-Type: application/atom+xml; charset=utf-8');
 123
 124             $atom = new AtomNoticeFeed($this->auth_user);
 125
 126             $atom->setId($id);
 127             $atom->setTitle($title);
 128             $atom->setSubtitle($subtitle);
 129             $atom->setUpdated('now');
 130             $atom->addLink($link);
 131
 132             $id = $this->arg('id');
 133
 134             $atom->setSelfLink($self);
 135             $atom->addEntryFromNotices($strm);
 136
 137             $this->raw($atom->getString());
 138
 139             break;
 140         case 'as':
 141             header('Content-Type: application/json; charset=utf-8');
 142             $doc = new ActivityStreamJSONDocument($this->auth_user);
 143             $doc->setTitle($title);
 144             $doc->addLink($link, 'alternate', 'text/html');
 145             $doc->addItemsFromNotices($strm);
 146             $this->raw($doc->asString());
 147             break;
 148         default:
 149             // TRANS: Client error displayed when trying to handle an unknown API method.
 150             $this->clientError(_('API method not found.'), $code = 404);
 151             break;
 152         }
 153     }
 154
 155     /**
 156      * Return true if read only.
 157      *
 158      * MAY override
 159      *
 160      * @param array $args other arguments
 161      *
 162      * @return boolean is read only action?
 163      */
 164     function isReadOnly($args)
 165     {
 166         return true;
 167     }
 168 }