actions/apistatusesretweet.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Repeat a notice through the API
   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('GNUSOCIAL')) { exit(1); }
  31
  32 /**
  33  * Repeat a notice through the API
  34  *
  35  * @category API
  36  * @package  StatusNet
  37  * @author   Evan Prodromou <evan@status.net>
  38  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  39  * @link     http://status.net/
  40  */
  41 class ApiStatusesRetweetAction extends ApiAuthAction
  42 {
  43     protected $needPost = true;
  44
  45     var $original = null;
  46
  47     /**
  48      * Take arguments for running
  49      *
  50      * @param array $args $_REQUEST args
  51      *
  52      * @return boolean success flag
  53      */
  54     protected function prepare(array $args=array())
  55     {
  56         parent::prepare($args);
  57
  58         $id = $this->trimmed('id');
  59
  60         $this->original = Notice::getKV('id', $id);
  61
  62         if (!$this->original instanceof Notice) {
  63             // TRANS: Client error displayed trying to repeat a non-existing notice through the API.
  64             $this->clientError(_('No such notice.'), 400, $this->format);
  65         }
  66
  67         return true;
  68     }
  69
  70     /**
  71      * Handle the request
  72      *
  73      * Make a new notice for the update, save it, and show it
  74      *
  75      * @param array $args $_REQUEST data (unused)
  76      *
  77      * @return void
  78      */
  79     protected function handle()
  80     {
  81         parent::handle();
  82
  83         $repeat = $this->original->repeat($this->scoped, $this->source);
  84
  85         $this->showNotice($repeat);
  86     }
  87
  88     /**
  89      * Show the resulting notice
  90      *
  91      * @return void
  92      */
  93     function showNotice($notice)
  94     {
  95         if (!empty($notice)) {
  96             if ($this->format == 'xml') {
  97                 $this->showSingleXmlStatus($notice);
  98             } elseif ($this->format == 'json') {
  99                 $this->show_single_json_status($notice);
 100             }
 101         }
 102     }
 103 }