lib/applicationeditform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for editing an 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  Form
  23  * @package   StatusNet
  24  * @author    Zach Copley <zach@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') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/form.php';
  35
  36 /**
  37  * Form for editing an application
  38  *
  39  * @category Form
  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  */
  46
  47 class ApplicationEditForm extends Form
  48 {
  49     /**
  50      * group for user to join
  51      */
  52
  53     var $application = null;
  54
  55     /**
  56      * Constructor
  57      *
  58      * @param Action     $out   output channel
  59      * @param User_group $group group to join
  60      */
  61
  62     function __construct($out=null, $application=null)
  63     {
  64         parent::__construct($out);
  65
  66         $this->application = $application;
  67     }
  68
  69     /**
  70      * ID of the form
  71      *
  72      * @return string ID of the form
  73      */
  74
  75     function id()
  76     {
  77         if ($this->application) {
  78             return 'form_application_edit-' . $this->application->id;
  79         } else {
  80             return 'form_application_add';
  81         }
  82     }
  83
  84     /**
  85      * HTTP method used to submit the form
  86      *
  87      * For image data we need to send multipart/form-data
  88      * so we set that here too
  89      *
  90      * @return string the method to use for submitting
  91      */
  92
  93     function method()
  94     {
  95         $this->enctype = 'multipart/form-data';
  96         return 'post';
  97     }
  98
  99     /**
 100      * class of the form
 101      *
 102      * @return string of the form class
 103      */
 104
 105     function formClass()
 106     {
 107         return 'form_settings';
 108     }
 109
 110     /**
 111      * Action of the form
 112      *
 113      * @return string URL of the action
 114      */
 115
 116     function action()
 117     {
 118         $cur = common_current_user();
 119
 120         if (!empty($this->application)) {
 121             return common_local_url('editapplication',
 122                                     array('id' => $this->application->id));
 123         } else {
 124             return common_local_url('newapplication');
 125         }
 126     }
 127
 128     /**
 129      * Name of the form
 130      *
 131      * @return void
 132      */
 133
 134     function formLegend()
 135     {
 136         $this->out->element('legend', null, _('Edit application'));
 137     }
 138
 139     /**
 140      * Data elements of the form
 141      *
 142      * @return void
 143      */
 144
 145     function formData()
 146     {
 147         if ($this->application) {
 148             $id                = $this->application->id;
 149             $icon              = $this->application->icon;
 150             $name              = $this->application->name;
 151             $description       = $this->application->description;
 152             $source_url        = $this->application->source_url;
 153             $organization      = $this->application->organization;
 154             $homepage          = $this->application->homepage;
 155             $callback_url      = $this->application->callback_url;
 156             $this->type        = $this->application->type;
 157             $this->access_type = $this->application->access_type;
 158         } else {
 159             $id                = '';
 160             $icon              = '';
 161             $name              = '';
 162             $description       = '';
 163             $source_url        = '';
 164             $organization      = '';
 165             $homepage          = '';
 166             $callback_url      = '';
 167             $this->type        = '';
 168             $this->access_type = '';
 169         }
 170
 171         $this->out->elementStart('ul', 'form_data');
 172
 173         $this->out->elementStart('li', array('id' => 'application_icon'));
 174
 175         if (!empty($icon)) {
 176             $this->out->element('img', array('src' => $icon));
 177         }
 178
 179         $this->out->element('label', array('for' => 'app_icon'),
 180                             _('Icon'));
 181         $this->out->element('input', array('name' => 'app_icon',
 182                                            'type' => 'file',
 183                                            'id' => 'app_icon'));
 184         $this->out->element('p', 'form_guide', _('Icon for this application'));
 185         $this->out->element('input', array('name' => 'MAX_FILE_SIZE',
 186                                            'type' => 'hidden',
 187                                            'id' => 'MAX_FILE_SIZE',
 188                                            'value' => ImageFile::maxFileSizeInt()));
 189         $this->out->elementEnd('li');
 190
 191         $this->out->elementStart('li');
 192
 193         $this->out->hidden('application_id', $id);
 194
 195         $this->out->input('name', _('Name'),
 196                           ($this->out->arg('name')) ? $this->out->arg('name') : $name);
 197
 198         $this->out->elementEnd('li');
 199
 200         $this->out->elementStart('li');
 201
 202         $maxDesc = Oauth_application::maxDesc();
 203         if ($maxDesc > 0) {
 204             $descInstr = sprintf(_('Describe your application in %d characters'),
 205                                  $maxDesc);
 206         } else {
 207             $descInstr = _('Describe your application');
 208         }
 209         $this->out->textarea('description', _('Description'),
 210                         ($this->out->arg('description')) ? $this->out->arg('description') : $description,
 211                              $descInstr);
 212
 213         $this->out->elementEnd('li');
 214
 215         $this->out->elementStart('li');
 216         $this->out->input('source_url', _('Source URL'),
 217                           ($this->out->arg('source_url')) ? $this->out->arg('source_url') : $source_url,
 218                           _('URL of the homepage of this application'));
 219         $this->out->elementEnd('li');
 220
 221         $this->out->elementStart('li');
 222         $this->out->input('organization', _('Organization'),
 223                           ($this->out->arg('organization')) ? $this->out->arg('organization') : $organization,
 224                           _('Organization responsible for this application'));
 225         $this->out->elementEnd('li');
 226
 227         $this->out->elementStart('li');
 228         $this->out->input('homepage', _('Homepage'),
 229                           ($this->out->arg('homepage')) ? $this->out->arg('homepage') : $homepage,
 230                           _('URL for the homepage of the organization'));
 231         $this->out->elementEnd('li');
 232
 233         $this->out->elementStart('li');
 234         $this->out->input('callback_url', ('Callback URL'),
 235                           ($this->out->arg('callback_url')) ? $this->out->arg('callback_url') : $callback_url,
 236                           _('URL to redirect to after authentication'));
 237         $this->out->elementEnd('li');
 238
 239         $this->out->elementStart('li', array('id' => 'application_types'));
 240
 241         $attrs = array('name' => 'app_type',
 242                        'type' => 'radio',
 243                        'id' => 'app_type-browser',
 244                        'class' => 'radio',
 245                        'value' => Oauth_application::$browser);
 246
 247         // Default to Browser
 248
 249         if ($this->application->type == Oauth_application::$browser
 250             || empty($this->application->type)) {
 251             $attrs['checked'] = 'checked';
 252         }
 253
 254         $this->out->element('input', $attrs);
 255
 256         $this->out->element('label', array('for' => 'app_type-browser',
 257                                            'class' => 'radio'),
 258                             _('Browser'));
 259
 260         $attrs = array('name' => 'app_type',
 261                        'type' => 'radio',
 262                        'id' => 'app_type-dekstop',
 263                        'class' => 'radio',
 264                        'value' => Oauth_application::$desktop);
 265
 266         if ($this->application->type == Oauth_application::$desktop) {
 267             $attrs['checked'] = 'checked';
 268         }
 269
 270         $this->out->element('input', $attrs);
 271
 272         $this->out->element('label', array('for' => 'app_type-desktop',
 273                                            'class' => 'radio'),
 274                             _('Desktop'));
 275         $this->out->element('p', 'form_guide', _('Type of application, browser or desktop'));
 276         $this->out->elementEnd('li');
 277
 278         $this->out->elementStart('li', array('id' => 'default_access_types'));
 279
 280         $attrs = array('name' => 'default_access_type',
 281                        'type' => 'radio',
 282                        'id' => 'default_access_type-r',
 283                        'class' => 'radio',
 284                        'value' => 'r');
 285
 286         // default to read-only access
 287
 288         if ($this->application->access_type & Oauth_application::$readAccess
 289             || empty($this->application->access_type)) {
 290             $attrs['checked'] = 'checked';
 291         }
 292
 293         $this->out->element('input', $attrs);
 294
 295         $this->out->element('label', array('for' => 'default_access_type-ro',
 296                                            'class' => 'radio'),
 297                             _('Read-only'));
 298
 299         $attrs = array('name' => 'default_access_type',
 300                        'type' => 'radio',
 301                        'id' => 'default_access_type-rw',
 302                        'class' => 'radio',
 303                        'value' => 'rw');
 304
 305         if ($this->application->access_type & Oauth_application::$readAccess
 306             && $this->application->access_type & Oauth_application::$writeAccess
 307             ) {
 308             $attrs['checked'] = 'checked';
 309         }
 310
 311         $this->out->element('input', $attrs);
 312
 313         $this->out->element('label', array('for' => 'default_access_type-rw',
 314                                            'class' => 'radio'),
 315                             _('Read-write'));
 316         $this->out->element('p', 'form_guide', _('Default access for this application: read-only, or read-write'));
 317
 318         $this->out->elementEnd('li');
 319
 320         $this->out->elementEnd('ul');
 321     }
 322
 323     /**
 324      * Action elements
 325      *
 326      * @return void
 327      */
 328
 329     function formActions()
 330     {
 331         $this->out->submit('cancel', _('Cancel'), 'submit form_action-primary',
 332                            'cancel', _('Cancel'));
 333         $this->out->submit('save', _('Save'), 'submit form_action-secondary',
 334                            'save', _('Save'));
 335     }
 336 }