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/applicationlist.php';
  35 require_once INSTALLDIR . '/lib/statusnetoauthstore.php';
  36
  37 /**
  38  * Show connected OAuth applications
  39  *
  40  * @category Settings
  41  * @package  StatusNet
  42  * @author   Zach Copley <zach@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  *
  46  * @see      SettingsAction
  47  */
  48 class OauthconnectionssettingsAction extends SettingsAction
  49 {
  50     var $page        = null;
  51     var $oauth_token = null;
  52
  53     function prepare($args)
  54     {
  55         parent::prepare($args);
  56         $this->oauth_token = $this->arg('oauth_token');
  57         $this->page = ($this->arg('page')) ? ($this->arg('page') + 0) : 1;
  58         return true;
  59     }
  60
  61     /**
  62      * Title of the page
  63      *
  64      * @return string Title of the page
  65      */
  66     function title()
  67     {
  68         // TRANS: Title for OAuth connection settings.
  69         return _('Connected applications');
  70     }
  71
  72     /**
  73      * Instructions for use
  74      *
  75      * @return instructions for use
  76      */
  77     function getInstructions()
  78     {
  79         // TRANS: Instructions for OAuth connection settings.
  80         return _('The following connections exist for your account.');
  81     }
  82
  83     /**
  84      * Content area of the page
  85      *
  86      * @return void
  87      */
  88
  89     function showContent()
  90     {
  91         $user    = common_current_user();
  92         $profile = $user->getProfile();
  93
  94         $offset = ($this->page - 1) * APPS_PER_PAGE;
  95         $limit  =  APPS_PER_PAGE + 1;
  96
  97         $connection = $user->getConnectedApps($offset, $limit);
  98
  99         $cnt = 0;
 100
 101         if (!empty($connection)) {
 102             $cal = new ConnectedAppsList($connection, $user, $this);
 103             $cnt = $cal->show();
 104         }
 105
 106         if ($cnt == 0) {
 107             $this->showEmptyListMessage();
 108         }
 109
 110         $this->pagination(
 111             $this->page > 1,
 112             $cnt > APPS_PER_PAGE,
 113             $this->page,
 114             'connectionssettings',
 115             array('nickname' => $user->nickname)
 116         );
 117     }
 118
 119     /**
 120      * Handle posts to this form
 121      *
 122      * Based on the button that was pressed, muxes out to other functions
 123      * to do the actual task requested.
 124      *
 125      * All sub-functions reload the form with a message -- success or failure.
 126      *
 127      * @return void
 128      */
 129     function handlePost()
 130     {
 131         // CSRF protection
 132
 133         $token = $this->trimmed('token');
 134         if (!$token || $token != common_session_token()) {
 135             // TRANS: Client error displayed when the session token does not match or is not given.
 136             $this->showForm(_('There was a problem with your session token. '.
 137                               'Try again, please.'));
 138             return;
 139         }
 140
 141         if ($this->arg('revoke')) {
 142             $this->revokeAccess($this->oauth_token);
 143         } else {
 144             // TRANS: Client error when submitting a form with unexpected information.
 145             $this->clientError(_('Unexpected form submission.'), 401);
 146             return false;
 147         }
 148     }
 149
 150     /**
 151      * Revoke an access token
 152      *
 153      * XXX: Confirm revoke before doing it
 154      *
 155      * @param int $appId the ID of the application
 156      *
 157      */
 158     function revokeAccess($token)
 159     {
 160         $cur = common_current_user();
 161
 162         $appUser = Oauth_application_user::getByUserAndToken($cur, $token);
 163
 164         if (empty($appUser)) {
 165             // TRANS: Client error when trying to revoke access for an application while not being a user of it.
 166             $this->clientError(_('You are not a user of that application.'), 401);
 167             return false;
 168         }
 169
 170         $app = Oauth_application::staticGet('id', $appUser->application_id);
 171
 172         $datastore = new ApiStatusNetOAuthDataStore();
 173         $datastore->revoke_token($appUser->token, 1);
 174
 175         $result = $appUser->delete();
 176
 177         if (!$result) {
 178             common_log_db_error($orig, 'DELETE', __FILE__);
 179             // TRANS: Client error when revoking access has failed for some reason.
 180             // TRANS: %s is the application ID revoking access failed for.
 181             $this->clientError(sprintf(_('Unable to revoke access for application: %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             // TRANS: Success message after revoking access for an application.
 199             // TRANS: %1$s is the application name, %2$s is the first part of the user token.
 200             _('You have successfully revoked access for %1$s and the access token starting with %2$s.'),
 201              $app->name,
 202              substr($appUser->token, 0, 7)
 203         );
 204
 205         $this->showForm($msg, true);
 206     }
 207
 208     function showEmptyListMessage()
 209     {
 210         // TRANS: Empty list message when no applications have been authorised yet.
 211         $message = _('You have not authorized any applications to use your account.');
 212
 213         $this->elementStart('div', 'guide');
 214         $this->raw(common_markup_to_html($message));
 215         $this->elementEnd('div');
 216     }
 217
 218     function showSections()
 219     {
 220         $cur = common_current_user();
 221
 222         $this->elementStart('div', array('id' => 'developer-help', 'class' => 'section'));
 223
 224         $this->element('h2', null, 'Developers');
 225         $this->elementStart('p');
 226
 227         $devMsg = sprintf(
 228             // TRANS: Note for developers in the OAuth connection settings form.
 229             // TRANS: This message contains a Markdown link. Do not separate "](".
 230             // TRANS: %s is the URL to the OAuth settings.
 231             _('Are you a developer? [Register an OAuth client application](%s) to use with this instance of StatusNet.'),
 232             common_local_url('oauthappssettings')
 233         );
 234
 235         $output = common_markup_to_html($devMsg);
 236
 237         $this->raw($output);
 238         $this->elementEnd('p');
 239
 240         $this->elementEnd('section');
 241     }
 242 }