actions/apitimelineretweetsofme.php

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