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-2010 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 $oauth_token = null;
  55
  56     function prepare($args)
  57     {
  58         parent::prepare($args);
  59         $this->oauth_token = $this->arg('oauth_token');
  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 _('The following connections exist for your 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         $connection = $profile->getConnectedApps($offset, $limit);
 101
 102         $cnt = 0;
 103
 104         if (!empty($connection)) {
 105             $cal = new ConnectedAppsList($connection, $user, $this);
 106             $cnt = $cal->show();
 107         }
 108
 109         if ($cnt == 0) {
 110             $this->showEmptyListMessage();
 111         }
 112
 113         $this->pagination(
 114             $this->page > 1,
 115             $cnt > APPS_PER_PAGE,
 116             $this->page,
 117             'connectionssettings',
 118             array('nickname' => $user->nickname)
 119         );
 120     }
 121
 122     /**
 123      * Handle posts to this form
 124      *
 125      * Based on the button that was pressed, muxes out to other functions
 126      * to do the actual task requested.
 127      *
 128      * All sub-functions reload the form with a message -- success or failure.
 129      *
 130      * @return void
 131      */
 132
 133     function handlePost()
 134     {
 135         // CSRF protection
 136
 137         $token = $this->trimmed('token');
 138         if (!$token || $token != common_session_token()) {
 139             $this->showForm(_('There was a problem with your session token. '.
 140                               'Try again, please.'));
 141             return;
 142         }
 143
 144         if ($this->arg('revoke')) {
 145             $this->revokeAccess($this->oauth_token);
 146         } else {
 147             $this->clientError(_('Unexpected form submission.'), 401);
 148             return false;
 149         }
 150     }
 151
 152     /**
 153      * Revoke an access token
 154      *
 155      * XXX: Confirm revoke before doing it
 156      *
 157      * @param int $appId the ID of the application
 158      *
 159      */
 160
 161     function revokeAccess($token)
 162     {
 163         $cur = common_current_user();
 164
 165         $appUser = Oauth_application_user::getByUserAndToken($cur, $token);
 166
 167         if (empty($appUser)) {
 168             $this->clientError(_('You are not a user of that application.'), 401);
 169             return false;
 170         }
 171
 172         $app = Oauth_application::staticGet('id', $appUser->application_id);
 173
 174         $datastore = new ApiStatusNetOAuthDataStore();
 175         $datastore->revoke_token($appUser->token, 1);
 176
 177         $result = $appUser->delete();
 178
 179         if (!$result) {
 180             common_log_db_error($orig, 'DELETE', __FILE__);
 181             $this->clientError(sprintf(_('Unable to revoke access for app: %s.'), $app->id));
 182             return false;
 183         }
 184
 185         $msg = 'API OAuth - user %s (id: %d) revoked access token %s for app id %d';
 186         common_log(
 187             LOG_INFO,
 188             sprintf(
 189                 $msg,
 190                 $cur->nickname,
 191                 $cur->id,
 192                 $appUser->token,
 193                 $appUser->application_id
 194             )
 195         );
 196
 197         $msg = sprintf(
 198             _('You have successfully revoked access for %s and the access token starting with %s'),
 199              $app->name,
 200              substr($appUser->token, 0, 7)
 201         );
 202
 203         $this->showForm($msg, true);
 204     }
 205
 206     function showEmptyListMessage()
 207     {
 208         $message = _('You have not authorized any applications to use your account.');
 209
 210         $this->elementStart('div', 'guide');
 211         $this->raw(common_markup_to_html($message));
 212         $this->elementEnd('div');
 213     }
 214
 215     function showSections()
 216     {
 217         $cur = common_current_user();
 218
 219         $this->elementStart('div', array('id' => 'developer-help', 'class' => 'section'));
 220
 221         $this->element('h2', null, 'Developers');
 222         $this->elementStart('p');
 223
 224         $devMsg = sprintf(
 225             _('Are you a developer? [Register an OAuth client application](%s) to use with this instance of StatusNet.'),
 226             common_local_url('oauthappssettings')
 227         );
 228
 229         $output = common_markup_to_html($devMsg);
 230
 231         $this->raw($output);
 232         $this->elementEnd('p');
 233
 234         $this->elementEnd('section');
 235     }
 236
 237 }