plugins/DomainStatusNetwork/actions/globalapi.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * An action that requires an API key
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  DomainStatusNetwork
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * An action that requires an API key
  39  *
  40  * @category  General
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class GlobalApiAction extends Action
  49 {
  50     var $email;
  51
  52     /**
  53      * Check for an API key, and throw an exception if it's not set
  54      *
  55      * @param array $args URL and POST params
  56      *
  57      * @return boolean continuation flag
  58      */
  59
  60     function prepare($args)
  61     {
  62         GNUsocial::setApi(true); // reduce exception reports to aid in debugging
  63
  64         parent::prepare($args);
  65
  66         if (!common_config('globalapi', 'enabled')) {
  67             throw new ClientException(_('Global API not enabled.'), 403);
  68         }
  69
  70         $apikey = $this->trimmed('apikey');
  71
  72         if (empty($apikey)) {
  73             throw new ClientException(_('No API key.'), 403);
  74         }
  75
  76         $expected = common_config('globalapi', 'key');
  77
  78         if ($expected != $apikey) {
  79             // FIXME: increment a counter by IP address to prevent brute-force
  80             // attacks on the key.
  81             throw new ClientException(_('Bad API key.'), 403);
  82         }
  83
  84         $email = common_canonical_email($this->trimmed('email'));
  85
  86         if (empty($email)) {
  87             throw new ClientException(_('No email address.'));
  88         }
  89
  90         if (!Validate::email($email, common_config('email', 'check_domain'))) {
  91             throw new ClientException(_('Invalid email address.'));
  92         }
  93
  94         $this->email = $email;
  95
  96         return true;
  97     }
  98
  99     function showError($message, $code=400)
 100     {
 101         $this->showOutput(array('error' => $message), $code);
 102     }
 103
 104     function showSuccess($values=null, $code=200)
 105     {
 106         if (empty($values)) {
 107             $values = array();
 108         }
 109         $values['success'] = 1;
 110         $this->showOutput($values, $code);
 111     }
 112
 113     function showOutput($values, $code)
 114     {
 115         if (array_key_exists($code, ClientErrorAction::$status)) {
 116             $status_string = ClientErrorAction::$status[$code];
 117         } else if (array_key_exists($code, ServerErrorAction::$status)) {
 118             $status_string = ServerErrorAction::$status[$code];
 119         } else {
 120             // bad code!
 121             $code = 500;
 122             $status_string = ServerErrorAction::$status[$code];
 123         }
 124
 125         header('HTTP/1.1 '.$code.' '.$status_string);
 126
 127         header('Content-Type: application/json; charset=utf-8');
 128         print(json_encode($values));
 129         print("\n");
 130     }
 131 }