actions/oauthconnectionssettings.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * List a user's OAuth connected applications
   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  Settings
  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 require_once INSTALLDIR . '/lib/connectsettingsaction.php';
  35 require_once INSTALLDIR . '/lib/applicationlist.php';
  36 require_once INSTALLDIR . '/lib/apioauthstore.php';
  37
  38 /**
  39  * Show connected OAuth applications
  40  *
  41  * @category Settings
  42  * @package  StatusNet
  43  * @author   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  *
  47  * @see      SettingsAction
  48  */
  49
  50 class OauthconnectionssettingsAction extends ConnectSettingsAction
  51 {
  52
  53     var $page = null;
  54     var $id   = null;
  55
  56     function prepare($args)
  57     {
  58         parent::prepare($args);
  59         $this->id = (int)$this->arg('id');
  60         $this->page = ($this->arg('page')) ? ($this->arg('page') + 0) : 1;
  61         return true;
  62     }
  63
  64     /**
  65      * Title of the page
  66      *
  67      * @return string Title of the page
  68      */
  69
  70     function title()
  71     {
  72         return _('Connected applications');
  73     }
  74
  75     /**
  76      * Instructions for use
  77      *
  78      * @return instructions for use
  79      */
  80
  81     function getInstructions()
  82     {
  83         return _('You have allowed the following applications to access you account.');
  84     }
  85
  86     /**
  87      * Content area of the page
  88      *
  89      * @return void
  90      */
  91
  92     function showContent()
  93     {
  94         $user    = common_current_user();
  95         $profile = $user->getProfile();
  96
  97         $offset = ($this->page - 1) * APPS_PER_PAGE;
  98         $limit  =  APPS_PER_PAGE + 1;
  99
 100         $application = $profile->getApplications($offset, $limit);
 101
 102         $cnt = 0;
 103
 104         if (!empty($application)) {
 105             $al = new ApplicationList($application, $user, $this, true);
 106             $cnt = $al->show();
 107         }
 108
 109         if ($cnt == 0) {
 110             $this->showEmptyListMessage();
 111         }
 112
 113         $this->pagination($this->page > 1, $cnt > APPS_PER_PAGE,
 114                           $this->page, 'connectionssettings',
 115                           array('nickname' => $user->nickname));
 116     }
 117
 118     /**
 119      * Handle posts to this form
 120      *
 121      * Based on the button that was pressed, muxes out to other functions
 122      * to do the actual task requested.
 123      *
 124      * All sub-functions reload the form with a message -- success or failure.
 125      *
 126      * @return void
 127      */
 128
 129     function handlePost()
 130     {
 131         // CSRF protection
 132
 133         $token = $this->trimmed('token');
 134         if (!$token || $token != common_session_token()) {
 135             $this->showForm(_('There was a problem with your session token. '.
 136                               'Try again, please.'));
 137             return;
 138         }
 139
 140         if ($this->arg('revoke')) {
 141             $this->revokeAccess($this->id);
 142
 143             // XXX: Show some indicator to the user of what's been done.
 144
 145             $this->showPage();
 146         } else {
 147             $this->clientError(_('Unexpected form submission.'), 401);
 148             return false;
 149         }
 150     }
 151
 152     /**
 153      * Revoke access to an authorized OAuth application
 154      *
 155      * @param int $appId the ID of the application
 156      *
 157      */
 158
 159     function revokeAccess($appId)
 160     {
 161         $cur = common_current_user();
 162
 163         $app = Oauth_application::staticGet('id', $appId);
 164
 165         if (empty($app)) {
 166             $this->clientError(_('No such application.'), 404);
 167             return false;
 168         }
 169
 170         // XXX: Transaction here?
 171
 172         $appUser = Oauth_application_user::getByKeys($cur, $app);
 173
 174         if (empty($appUser)) {
 175             $this->clientError(_('You are not a user of that application.'), 401);
 176             return false;
 177         }
 178
 179         $datastore = new ApiStatusNetOAuthDataStore();
 180         $datastore->revoke_token($appUser->token, 1);
 181
 182         $result = $appUser->delete();
 183
 184         if (!$result) {
 185             common_log_db_error($orig, 'DELETE', __FILE__);
 186             $this->clientError(sprintf(_('Unable to revoke access for app: %s.'), $app->id));
 187             return false;
 188         }
 189
 190         $msg = 'User %s (id: %d) revoked access to app %s (id: %d)';
 191         common_log(LOG_INFO, sprintf($msg, $cur->nickname,
 192                                      $cur->id, $app->name, $app->id));
 193
 194     }
 195
 196     function showEmptyListMessage()
 197     {
 198         $message = _('You have not authorized any applications to use your account.');
 199
 200         $this->elementStart('div', 'guide');
 201         $this->raw(common_markup_to_html($message));
 202         $this->elementEnd('div');
 203     }
 204
 205     function showSections()
 206     {
 207        $cur = common_current_user();
 208
 209        $this->element('h2', null, 'Developers');
 210        $this->elementStart('p');
 211        $this->raw(_('Developers can edit the registration settings for their applications '));
 212        $this->element('a',
 213            array('href' => common_local_url('oauthappssettings')),
 214                'here.');
 215        $this->elementEnd('p');
 216     }
 217
 218 }