actions/showapplication.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Show an 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  Application
  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  * Show an OAuth application
  36  *
  37  * @category Application
  38  * @package  StatusNet
  39  * @author   Zach Copley <zach@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  42  */
  43
  44 class ShowApplicationAction extends OwnerDesignAction
  45 {
  46     /**
  47      * Application to show
  48      */
  49
  50     var $application = null;
  51
  52     /**
  53      * User who owns the app
  54      */
  55
  56     var $owner = null;
  57
  58     var $msg = null;
  59
  60     var $success = null;
  61
  62     /**
  63      * Load attributes based on database arguments
  64      *
  65      * Loads all the DB stuff
  66      *
  67      * @param array $args $_REQUEST array
  68      *
  69      * @return success flag
  70      */
  71
  72     function prepare($args)
  73     {
  74         parent::prepare($args);
  75
  76         $id = (int)$this->arg('id');
  77
  78         $this->application  = Oauth_application::staticGet($id);
  79         $this->owner        = User::staticGet($this->application->owner);
  80
  81         if (!common_logged_in()) {
  82             $this->clientError(_('You must be logged in to view an application.'));
  83             return false;
  84         }
  85
  86         if (empty($this->application)) {
  87             $this->clientError(_('No such application.'), 404);
  88             return false;
  89         }
  90
  91         $cur = common_current_user();
  92
  93         if ($cur->id != $this->owner->id) {
  94             $this->clientError(_('You are not the owner of this application.'), 401);
  95         }
  96
  97         return true;
  98     }
  99
 100     /**
 101      * Handle the request
 102      *
 103      * Shows info about the app
 104      *
 105      * @return void
 106      */
 107
 108     function handle($args)
 109     {
 110         parent::handle($args);
 111
 112         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 113
 114             // CSRF protection
 115             $token = $this->trimmed('token');
 116             if (!$token || $token != common_session_token()) {
 117                 $this->clientError(_('There was a problem with your session token.'));
 118                 return;
 119             }
 120
 121             if ($this->arg('reset')) {
 122                 $this->resetKey();
 123             }
 124         } else {
 125             $this->showPage();
 126         }
 127     }
 128
 129     /**
 130      * Title of the page
 131      *
 132      * @return string title of the page
 133      */
 134
 135     function title()
 136     {
 137         if (!empty($this->application->name)) {
 138             return 'Application: ' . $this->application->name;
 139         }
 140     }
 141
 142     function showPageNotice()
 143     {
 144         if (!empty($this->msg)) {
 145             $this->element('div', ($this->success) ? 'success' : 'error', $this->msg);
 146         }
 147     }
 148
 149     function showContent()
 150     {
 151
 152         $cur = common_current_user();
 153
 154         $this->elementStart('div', 'entity_actions');
 155         $this->elementStart('ul');
 156         $this->elementStart('li');
 157         $this->element('a',
 158             array('href' =>
 159                 common_local_url(
 160                     'editapplication',
 161                     array(
 162                         'nickname' => $this->owner->nickname,
 163                         'id' => $this->application->id
 164                     )
 165                 )
 166             ), 'Edit application');
 167         $this->elementEnd('li');
 168
 169         $this->elementStart('li');
 170         $this->elementStart('form', array(
 171             'id' => 'forma_reset_key',
 172             'class' => 'form_reset_key',
 173             'method' => 'POST',
 174             'action' => common_local_url('showapplication',
 175                 array('nickname' => $cur->nickname,
 176                       'id' => $this->application->id))));
 177
 178         $this->elementStart('fieldset');
 179         $this->hidden('token', common_session_token());
 180         $this->submit('reset', _('Reset Consumer key/secret'));
 181         $this->elementEnd('fieldset');
 182         $this->elementEnd('form');
 183         $this->elementEnd('li');
 184         $this->elementEnd('ul');
 185         $this->elementEnd('div');
 186
 187         $consumer = $this->application->getConsumer();
 188
 189         $this->elementStart('div', 'entity_application');
 190         $this->element('h2', null, _('Application profile'));
 191         $this->elementStart('dl', 'entity_depiction');
 192         $this->element('dt', null, _('Icon'));
 193         $this->elementStart('dd');
 194         if (!empty($this->application->icon)) {
 195             $this->element('img', array('src' => $this->application->icon));
 196         }
 197         $this->elementEnd('dd');
 198         $this->elementEnd('dl');
 199
 200         $this->elementStart('dl', 'entity_fn');
 201         $this->element('dt', null, _('Name'));
 202         $this->elementStart('dd');
 203         $this->element('span', null, $this->application->name);
 204         $this->raw(sprintf(_(' by %1$s'), $this->application->organization));
 205         $this->elementEnd('dd');
 206         $this->elementEnd('dl');
 207
 208         $this->elementStart('dl', 'entity_note');
 209         $this->element('dt', null, _('Description'));
 210         $this->element('dd', null, $this->application->description);
 211         $this->elementEnd('dl');
 212
 213         $this->elementStart('dl', 'entity_statistics');
 214         $this->element('dt', null, _('Statistics'));
 215         $this->elementStart('dd');
 216         $defaultAccess = ($this->application->access_type & Oauth_application::$writeAccess)
 217             ? 'read-write' : 'read-only';
 218         $profile = Profile::staticGet($this->application->owner);
 219         $userCnt = 0; // XXX: count how many users use the app
 220
 221         $this->raw(sprintf(
 222             _('Created by %1$s - %2$s access by default - %3$d users.'),
 223               $profile->getBestName(),
 224               $defaultAccess,
 225               $userCnt
 226             ));
 227         $this->elementEnd('dd');
 228         $this->elementEnd('dl');
 229         $this->elementEnd('div');
 230
 231         $this->elementStart('div', array('id' => 'entity_data'));
 232         $this->element('h2', null, _('Application info'));
 233         $this->elementStart('dl', 'entity_consumer_key');
 234         $this->element('dt', null, _('Consumer key'));
 235         $this->element('dd', null, $consumer->consumer_key);
 236         $this->elementEnd('dl');
 237
 238         $this->elementStart('dl', 'entity_consumer_secret');
 239         $this->element('dt', null, _('Consumer secret'));
 240         $this->element('dd', null, $consumer->consumer_secret);
 241         $this->elementEnd('dl');
 242
 243         $this->elementStart('dl', 'entity_request_token_url');
 244         $this->element('dt', null, _('Request token URL'));
 245         $this->element('dd', null, common_local_url('apioauthrequesttoken'));
 246         $this->elementEnd('dl');
 247
 248         $this->elementStart('dl', 'entity_access_token_url');
 249         $this->element('dt', null, _('Access token URL'));
 250         $this->element('dd', null, common_local_url('apioauthaccesstoken'));
 251         $this->elementEnd('dl');
 252
 253         $this->elementStart('dl', 'entity_authorize_url');
 254         $this->element('dt', null, _('Authorize URL'));
 255         $this->element('dd', null, common_local_url('apioauthauthorize'));
 256         $this->elementEnd('dl');
 257
 258         $this->element('p', 'oauth-signature-note',
 259             '* We support hmac-sha1 signatures. We do not support the plaintext signature method.');
 260         $this->elementEnd('div');
 261
 262         $this->elementStart('p', array('id' => 'application_action'));
 263         $this->element('a',
 264             array(
 265                 'href' => common_local_url(
 266                     'apps',
 267                     array('nickname' => $this->owner->nickname)),
 268                 'class' => 'more'
 269             ),
 270             'View your applications');
 271         $this->elementEnd('p');
 272     }
 273
 274     function resetKey()
 275     {
 276         $this->application->query('BEGIN');
 277
 278         $consumer = $this->application->getConsumer();
 279         $result = $consumer->delete();
 280
 281         if (!$result) {
 282             common_log_db_error($consumer, 'DELETE', __FILE__);
 283             $this->success = false;
 284             $this->msg = ('Unable to reset consumer key and secret.');
 285             $this->showPage();
 286             return;
 287         }
 288
 289         $consumer = Consumer::generateNew();
 290
 291         $result = $consumer->insert();
 292
 293         if (!$result) {
 294             common_log_db_error($consumer, 'INSERT', __FILE__);
 295             $this->application->query('ROLLBACK');
 296             $this->success = false;
 297             $this->msg = ('Unable to reset consumer key and secret.');
 298             $this->showPage();
 299             return;
 300         }
 301
 302         $orig = clone($this->application);
 303         $this->application->consumer_key = $consumer->consumer_key;
 304         $result = $this->application->update($orig);
 305
 306         if (!$result) {
 307             common_log_db_error($application, 'UPDATE', __FILE__);
 308             $this->application->query('ROLLBACK');
 309             $this->success = false;
 310             $this->msg = ('Unable to reset consumer key and secret.');
 311             $this->showPage();
 312             return;
 313         }
 314
 315         $this->application->query('COMMIT');
 316
 317         $this->success = true;
 318         $this->msg = ('Consumer key and secret reset.');
 319         $this->showPage();
 320     }
 321
 322 }
 323