plugins/Share/actions/apistatusesretweets.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show up to 100 repeats of a notice
   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 /**
  35  * Show up to 100 repeats of a notice
  36  *
  37  * @category API
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43 class ApiStatusesRetweetsAction extends ApiAuthAction
  44 {
  45     const MAXCOUNT = 100;
  46
  47     var $original = null;
  48     var $cnt      = self::MAXCOUNT;
  49
  50     /**
  51      * Take arguments for running
  52      *
  53      * @param array $args $_REQUEST args
  54      *
  55      * @return boolean success flag
  56      */
  57     function prepare(array $args=array())
  58     {
  59         parent::prepare($args);
  60
  61         $id = $this->trimmed('id');
  62
  63         $this->original = Notice::getKV('id', $id);
  64
  65         if (empty($this->original)) {
  66             // TRANS: Client error displayed trying to display redents of a non-exiting notice.
  67             $this->clientError(_('No such notice.'),
  68                                400, $this->format);
  69             return false;
  70         }
  71
  72         $cnt = $this->trimmed('count');
  73
  74         if (empty($cnt) || !is_integer($cnt)) {
  75             $cnt = 100;
  76         } else {
  77             $this->cnt = min((int)$cnt, self::MAXCOUNT);
  78         }
  79
  80         return true;
  81     }
  82
  83     /**
  84      * Handle the request
  85      *
  86      * Make a new notice for the update, save it, and show it
  87      *
  88      * @param array $args $_REQUEST data (unused)
  89      *
  90      * @return void
  91      */
  92     function handle(array $args=array())
  93     {
  94         parent::handle($args);
  95
  96         $strm = $this->original->repeatStream($this->cnt);
  97
  98         switch ($this->format) {
  99         case 'xml':
 100             $this->showXmlTimeline($strm);
 101             break;
 102         case 'json':
 103             $this->showJsonTimeline($strm);
 104             break;
 105         default:
 106             // TRANS: Client error displayed when coming across a non-supported API method.
 107             $this->clientError(_('API method not found.'), $code = 404);
 108             break;
 109         }
 110     }
 111
 112     /**
 113      * Return true if read only.
 114      *
 115      * MAY override
 116      *
 117      * @param array $args other arguments
 118      *
 119      * @return boolean is read only action?
 120      */
 121
 122     function isReadOnly(array $args=array())
 123     {
 124         return true;
 125     }
 126 }