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
  46 class ApiTimelineRetweetedToMeAction 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      */
  66
  67     function prepare($args)
  68     {
  69         parent::prepare($args);
  70
  71         $cnt = $this->int('count', self::DEFAULTCOUNT, self::MAXCOUNT, 1);
  72
  73         $page = $this->int('page', 1, (self::MAXNOTICES/$this->cnt));
  74
  75         $since_id = $this->int('since_id');
  76
  77         $max_id = $this->int('max_id');
  78
  79         return true;
  80     }
  81
  82     /**
  83      * Handle the request
  84      *
  85      * show a timeline of the user's repeated notices
  86      *
  87      * @param array $args $_REQUEST data (unused)
  88      *
  89      * @return void
  90      */
  91
  92     function handle($args)
  93     {
  94         parent::handle($args);
  95
  96         $offset = ($this->page-1) * $this->cnt;
  97         $limit  = $this->cnt;
  98
  99         $strm = $this->auth_user->repeatedToMe($offset, $limit, $this->since_id, $this->max_id);
 100
 101         switch ($this->format) {
 102         case 'xml':
 103             $this->showXmlTimeline($strm);
 104             break;
 105         case 'json':
 106             $this->showJsonTimeline($strm);
 107             break;
 108         case 'atom':
 109             $profile    = $this->auth_user->getProfile();
 110
 111             $title      = sprintf(_("Repeated to %s"), $this->auth_user->nickname);
 112             $taguribase = common_config('integration', 'taguri');
 113             $id         = "tag:$taguribase:RepeatedToMe:" . $this->auth_user->id;
 114             $link       = common_local_url('all',
 115                                            array('nickname' => $this->auth_user->nickname));
 116
 117             $this->showAtomTimeline($strm, $title, $id, $link);
 118             break;
 119
 120         default:
 121             $this->clientError(_('API method not found.'), $code = 404);
 122             break;
 123         }
 124     }
 125 }