actions/newapplication.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Register a new OAuth Application
   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  Applications
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@status.net>
  25  * @copyright 2008-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') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Add a new application
  36  *
  37  * This is the form for adding a new application
  38  *
  39  * @category Application
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@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 class NewApplicationAction extends OwnerDesignAction
  46 {
  47     var $msg;
  48
  49     function title()
  50     {
  51         // TRANS: This is the title of the form for adding a new application.
  52         return _('New application');
  53     }
  54
  55     /**
  56      * Prepare to run
  57      */
  58
  59     function prepare($args)
  60     {
  61         parent::prepare($args);
  62
  63         if (!common_logged_in()) {
  64             // TRANS: Client error displayed trying to add a new application while not logged in.
  65             $this->clientError(_('You must be logged in to register an application.'));
  66             return false;
  67         }
  68
  69         return true;
  70     }
  71
  72     /**
  73      * Handle the request
  74      *
  75      * On GET, show the form. On POST, try to save the app.
  76      *
  77      * @param array $args unused
  78      *
  79      * @return void
  80      */
  81
  82     function handle($args)
  83     {
  84         parent::handle($args);
  85
  86         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  87         $this->handlePost($args);
  88         } else {
  89             $this->showForm();
  90         }
  91     }
  92
  93     function handlePost($args)
  94     {
  95         // Workaround for PHP returning empty $_POST and $_FILES when POST
  96         // length > post_max_size in php.ini
  97
  98         if (empty($_FILES)
  99             && empty($_POST)
 100             && ($_SERVER['CONTENT_LENGTH'] > 0)
 101         ) {
 102             // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
 103             // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
 104             $msg = _m('The server was unable to handle that much POST data (%s byte) due to its current configuration.',
 105                       'The server was unable to handle that much POST data (%s bytes) due to its current configuration.',
 106                       intval($_SERVER['CONTENT_LENGTH']));
 107             $this->clientException(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
 108             return;
 109         }
 110
 111         // CSRF protection
 112         $token = $this->trimmed('token');
 113         if (!$token || $token != common_session_token()) {
 114             $this->clientError(_('There was a problem with your session token.'));
 115             return;
 116         }
 117
 118         $cur = common_current_user();
 119
 120         if ($this->arg('cancel')) {
 121             common_redirect(common_local_url('oauthappssettings'), 303);
 122         } elseif ($this->arg('save')) {
 123             $this->trySave();
 124         } else {
 125             $this->clientError(_('Unexpected form submission.'));
 126         }
 127     }
 128
 129     function showForm($msg=null)
 130     {
 131         $this->msg = $msg;
 132         $this->showPage();
 133     }
 134
 135     function showContent()
 136     {
 137         $form = new ApplicationEditForm($this);
 138         $form->show();
 139     }
 140
 141     function showPageNotice()
 142     {
 143         if ($this->msg) {
 144             $this->element('p', 'error', $this->msg);
 145         } else {
 146             $this->element('p', 'instructions',
 147                            _('Use this form to register a new application.'));
 148         }
 149     }
 150
 151     function trySave()
 152     {
 153         $name         = $this->trimmed('name');
 154         $description  = $this->trimmed('description');
 155         $source_url   = $this->trimmed('source_url');
 156         $organization = $this->trimmed('organization');
 157         $homepage     = $this->trimmed('homepage');
 158         $callback_url = $this->trimmed('callback_url');
 159         $type         = $this->arg('app_type');
 160         $access_type  = $this->arg('default_access_type');
 161
 162         if (empty($name)) {
 163              $this->showForm(_('Name is required.'));
 164              return;
 165         } else if ($this->nameExists($name)) {
 166             $this->showForm(_('Name already in use. Try another one.'));
 167             return;
 168         } elseif (mb_strlen($name) > 255) {
 169             $this->showForm(_('Name is too long (maximum 255 characters).'));
 170             return;
 171         } elseif (empty($description)) {
 172             $this->showForm(_('Description is required.'));
 173             return;
 174         } elseif (Oauth_application::descriptionTooLong($description)) {
 175             $this->showForm(sprintf(
 176                 // TRANS: Form validation error in New application form.
 177                 // TRANS: %d is the maximum number of characters for the description.
 178                 _m('Description is too long (maximum %d character).',
 179                    'Description is too long (maximum %d characters).',
 180                    Oauth_application::maxDesc()),
 181                 Oauth_application::maxDesc()));
 182             return;
 183         } elseif (empty($source_url)) {
 184             $this->showForm(_('Source URL is required.'));
 185             return;
 186         } elseif ((strlen($source_url) > 0)
 187             && !Validate::uri(
 188                 $source_url,
 189                 array('allowed_schemes' => array('http', 'https'))
 190                 )
 191             )
 192         {
 193             $this->showForm(_('Source URL is not valid.'));
 194             return;
 195         } elseif (empty($organization)) {
 196             $this->showForm(_('Organization is required.'));
 197             return;
 198         } elseif (mb_strlen($organization) > 255) {
 199             $this->showForm(_('Organization is too long (maximum 255 characters).'));
 200             return;
 201         } elseif (empty($homepage)) {
 202             $this->showForm(_('Organization homepage is required.'));
 203             return;
 204         } elseif ((strlen($homepage) > 0)
 205             && !Validate::uri(
 206                 $homepage,
 207                 array('allowed_schemes' => array('http', 'https'))
 208                 )
 209             )
 210         {
 211             $this->showForm(_('Homepage is not a valid URL.'));
 212             return;
 213         } elseif (mb_strlen($callback_url) > 255) {
 214             $this->showForm(_('Callback is too long.'));
 215             return;
 216         } elseif (strlen($callback_url) > 0
 217             && !Validate::uri(
 218                 $source_url,
 219                 array('allowed_schemes' => array('http', 'https'))
 220                 )
 221             )
 222         {
 223             $this->showForm(_('Callback URL is not valid.'));
 224             return;
 225         }
 226
 227         $cur = common_current_user();
 228
 229         // Checked in prepare() above
 230
 231         assert(!is_null($cur));
 232
 233         $app = new Oauth_application();
 234
 235         $app->query('BEGIN');
 236
 237         $app->name         = $name;
 238         $app->owner        = $cur->id;
 239         $app->description  = $description;
 240         $app->source_url   = $source_url;
 241         $app->organization = $organization;
 242         $app->homepage     = $homepage;
 243         $app->callback_url = $callback_url;
 244         $app->type         = $type;
 245
 246         // Yeah, I dunno why I chose bit flags. I guess so I could
 247         // copy this value directly to Oauth_application_user
 248         // access_type which I think does need bit flags -- Z
 249
 250         if ($access_type == 'r') {
 251             $app->setAccessFlags(true, false);
 252         } else {
 253             $app->setAccessFlags(true, true);
 254         }
 255
 256         $app->created = common_sql_now();
 257
 258         // generate consumer key and secret
 259
 260         $consumer = Consumer::generateNew();
 261
 262         $result = $consumer->insert();
 263
 264         if (!$result) {
 265             common_log_db_error($consumer, 'INSERT', __FILE__);
 266             $this->serverError(_('Could not create application.'));
 267         }
 268
 269         $app->consumer_key = $consumer->consumer_key;
 270
 271         $this->app_id = $app->insert();
 272
 273         if (!$this->app_id) {
 274             common_log_db_error($app, 'INSERT', __FILE__);
 275             $this->serverError(_('Could not create application.'));
 276             $app->query('ROLLBACK');
 277         }
 278
 279         $app->uploadLogo();
 280
 281         $app->query('COMMIT');
 282
 283         common_redirect(common_local_url('oauthappssettings'), 303);
 284
 285     }
 286
 287     /**
 288      * Does the app name already exist?
 289      *
 290      * Checks the DB to see someone has already registered an app
 291      * with the same name.
 292      *
 293      * @param string $name app name to check
 294      *
 295      * @return boolean true if the name already exists
 296      */
 297
 298     function nameExists($name)
 299     {
 300         $app = Oauth_application::staticGet('name', $name);
 301         return !empty($app);
 302     }
 303
 304 }
 305