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('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/apiauth.php';
  35 require_once INSTALLDIR . '/lib/mediafile.php';
  36
  37 /**
  38  * Repeat a notice through the API
  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 ApiStatusesRetweetAction extends ApiAuthAction
  47 {
  48     var $original = null;
  49
  50     /**
  51      * Take arguments for running
  52      *
  53      * @param array $args $_REQUEST args
  54      *
  55      * @return boolean success flag
  56      */
  57     function prepare($args)
  58     {
  59         parent::prepare($args);
  60
  61         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
  62             // TRANS: Client error. POST is a HTTP command. It should not be translated.
  63             $this->clientError(_('This method requires a POST.'),
  64                                400, $this->format);
  65             return false;
  66         }
  67
  68         $id = $this->trimmed('id');
  69
  70         $this->original = Notice::staticGet('id', $id);
  71
  72         if (empty($this->original)) {
  73             // TRANS: Client error displayed trying to repeat a non-existing notice through the API.
  74             $this->clientError(_('No such notice.'),
  75                                400, $this->format);
  76             return false;
  77         }
  78
  79         $this->user = $this->auth_user;
  80
  81         if ($this->user->id == $this->original->profile_id) {
  82             // TRANS: Client error displayed trying to repeat an own notice through the API.
  83             $this->clientError(_('Cannot repeat your own notice.'),
  84                                400, $this->format);
  85             return false;
  86         }
  87
  88         // Is it OK to repeat that notice (general enough scope)?
  89
  90         if ($this->original->scope != Notice::SITE_SCOPE &&
  91             $this->original->scope != Notice::PUBLIC_SCOPE) {
  92             // TRANS: Client error displayed when trying to repeat a private notice.
  93             $this->clientError(_('You may not repeat a private notice.'),
  94                                403,
  95                                $this->format);
  96             return false;
  97         }
  98
  99         $profile = $this->user->getProfile();
 100
 101         // Can the profile actually see that notice?
 102
 103         if (!$this->original->inScope($profile)) {
 104             // TRANS: Client error displayed when trying to repeat a notice the user has no access to.
 105             $this->clientError(_('No access to that notice.'),
 106                                403,
 107                                $this->format);
 108             return false;
 109         }
 110
 111         if ($profile->hasRepeated($id)) {
 112             // TRANS: Client error displayed trying to re-repeat a notice through the API.
 113             $this->clientError(_('Already repeated that notice.'),
 114                                400, $this->format);
 115             return false;
 116         }
 117
 118
 119         return true;
 120     }
 121
 122     /**
 123      * Handle the request
 124      *
 125      * Make a new notice for the update, save it, and show it
 126      *
 127      * @param array $args $_REQUEST data (unused)
 128      *
 129      * @return void
 130      */
 131     function handle($args)
 132     {
 133         parent::handle($args);
 134
 135         $repeat = $this->original->repeat($this->user->id, $this->source);
 136
 137         $this->showNotice($repeat);
 138     }
 139
 140     /**
 141      * Show the resulting notice
 142      *
 143      * @return void
 144      */
 145     function showNotice($notice)
 146     {
 147         if (!empty($notice)) {
 148             if ($this->format == 'xml') {
 149                 $this->showSingleXmlStatus($notice);
 150             } elseif ($this->format == 'json') {
 151                 $this->show_single_json_status($notice);
 152             }
 153         }
 154     }
 155 }