3 * StatusNet, the distributed open-source microblogging tool
5 * Authorize an OAuth request token
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.
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.
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/>.
24 * @author Zach Copley <zach@status.net>
25 * @copyright 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/
30 if (!defined('STATUSNET')) {
34 require_once INSTALLDIR . '/lib/apioauth.php';
35 require_once INSTALLDIR . '/lib/info.php';
38 * Authorize an Oputh request token
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/
46 class ApiOauthAuthorizeAction extends Action
57 * Is this a read-only action?
59 * @return boolean false
62 function isReadOnly($args)
67 function prepare($args)
69 parent::prepare($args);
71 $this->nickname = $this->trimmed('nickname');
72 $this->password = $this->arg('password');
73 $this->oauthTokenParam = $this->arg('oauth_token');
74 $this->mode = $this->arg('mode');
75 $this->store = new ApiStatusNetOAuthDataStore();
78 $this->app = $this->store->getAppByRequestToken($this->oauthTokenParam);
79 } catch (Exception $e) {
80 $this->clientError($e->getMessage());
87 * Handle input, produce output
89 * Switches on request method; either shows the form or handles its input.
91 * @param array $args $_REQUEST data
95 function handle($args)
97 parent::handle($args);
99 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
105 // Make sure a oauth_token parameter was provided
106 if (empty($this->oauthTokenParam)) {
107 // TRANS: Client error given when no oauth_token was passed to the OAuth API.
108 $this->clientError(_('No oauth_token parameter provided.'));
111 // Check to make sure the token exists
112 $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
114 if (empty($this->reqToken)) {
115 // TRANS: Client error given when an invalid request token was passed to the OAuth API.
116 $this->clientError(_('Invalid request token.'));
119 // Check to make sure we haven't already authorized the token
120 if ($this->reqToken->state != 0) {
121 // TRANS: Client error given when an invalid request token was passed to the OAuth API.
122 $this->clientError(_('Request token already authorized.'));
127 // make sure there's an app associated with this token
128 if (empty($this->app)) {
129 // TRANS: Client error given when an invalid request token was passed to the OAuth API.
130 $this->clientError(_('Invalid request token.'));
133 $name = $this->app->name;
139 function handlePost()
141 // check session token for CSRF protection.
143 $token = $this->trimmed('token');
145 if (!$token || $token != common_session_token()) {
147 _('There was a problem with your session token. Try again, please.'));
155 if (!common_logged_in()) {
157 // XXX Force credentials check?
159 // @fixme this should probably use a unified login form handler
161 if (Event::handle('StartOAuthLoginCheck', array($this, &$user))) {
162 $user = common_check_user($this->nickname, $this->password);
164 Event::handle('EndOAuthLoginCheck', array($this, &$user));
167 // TRANS: Form validation error given when an invalid username and/or password was passed to the OAuth API.
168 $this->showForm(_("Invalid nickname / password!"));
172 $user = common_current_user();
176 $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
177 assert(!empty($this->reqToken));
179 if ($this->arg('allow')) {
181 // mark the req token as authorized
183 $this->store->authorize_token($this->oauthTokenParam);
184 } catch (Exception $e) {
185 $this->serverError($e->getMessage());
191 "API OAuth - User %d (%s) has authorized request token %s for OAuth application %d (%s).",
194 $this->reqToken->tok,
200 // XXX: Make sure we have a oauth_token_association table. The table
201 // is now in the main schema, but because it is being added with
202 // a point release, it's unlikely to be there. This code can be
203 // removed as of 1.0.
204 $this->ensureOauthTokenAssociationTable();
206 $tokenAssoc = new Oauth_token_association();
208 $tokenAssoc->profile_id = $user->id;
209 $tokenAssoc->application_id = $this->app->id;
210 $tokenAssoc->token = $this->oauthTokenParam;
211 $tokenAssoc->created = common_sql_now();
213 $result = $tokenAssoc->insert();
216 common_log_db_error($tokenAssoc, 'INSERT', __FILE__);
217 // TRANS: Server error displayed when a database action fails.
218 $this->serverError(_('Database error inserting oauth_token_association.'));
221 $callback = $this->getCallback();
223 if (!empty($callback) && $this->reqToken->verified_callback != 'oob') {
224 $targetUrl = $this->buildCallbackUrl(
227 'oauth_token' => $this->oauthTokenParam,
228 'oauth_verifier' => $this->reqToken->verifier // 1.0a
232 common_log(LOG_INFO, "Redirecting to callback: $targetUrl");
234 // Redirect the user to the provided OAuth callback
235 common_redirect($targetUrl, 303);
237 } elseif ($this->app->type == 2) {
238 // Strangely, a web application seems to want to do the OOB
239 // workflow. Because no callback was specified anywhere.
243 "API OAuth - No callback provided for OAuth web client ID %s (%s) "
244 . "during authorization step. Falling back to OOB workflow.",
251 // Otherwise, inform the user that the rt was authorized
252 $this->showAuthorized();
254 } else if ($this->arg('cancel')) {
259 "API OAuth - User %d (%s) refused to authorize request token %s for OAuth application %d (%s).",
262 $this->reqToken->tok,
269 $this->store->revoke_token($this->oauthTokenParam, 0);
270 } catch (Exception $e) {
271 $this->ServerError($e->getMessage());
274 $callback = $this->getCallback();
276 // If there's a callback available, inform the consumer the user
277 // has refused authorization
278 if (!empty($callback) && $this->reqToken->verified_callback != 'oob') {
279 $targetUrl = $this->buildCallbackUrl(
282 'oauth_problem' => 'user_refused',
286 common_log(LOG_INFO, "Redirecting to callback: $targetUrl");
288 // Redirect the user to the provided OAuth callback
289 common_redirect($targetUrl, 303);
292 // otherwise inform the user that authorization for the rt was declined
293 $this->showCanceled();
296 // TRANS: Client error given on when invalid data was passed through a form in the OAuth API.
297 $this->clientError(_('Unexpected form submission.'));
301 // XXX Remove this function when we hit 1.0
302 function ensureOauthTokenAssociationTable()
304 $schema = Schema::get();
306 $reqTokenCols = array(
307 new ColumnDef('profile_id', 'integer', null, true, 'PRI'),
308 new ColumnDef('application_id', 'integer', null, true, 'PRI'),
309 new ColumnDef('token', 'varchar', 255, true, 'PRI'),
310 new ColumnDef('created', 'datetime', null, false),
318 'on update CURRENT_TIMESTAMP'
322 $schema->ensureTable('oauth_token_association', $reqTokenCols);
326 * Override to add some special (more compact) styling when the page is
327 * being displayed in desktop mode.
331 function showStylesheets()
333 parent::showStyleSheets();
335 if ($this->desktopMode()) {
336 $this->style('#wrap {min-width: 500px; } #content {width: 480px; padding: 10px;} fieldset {margin-bottom: 10px !important;}</style>');
340 function showForm($error=null)
342 $this->error = $error;
346 function showScripts()
348 parent::showScripts();
349 if (!common_logged_in()) {
350 $this->autofocus('nickname');
357 * @return string title of the page
361 // TRANS: Title for a page where a user can confirm/deny account access by an external application.
362 return _('An application would like to connect to your account');
366 * Shows the authorization form.
370 function showContent()
372 $this->elementStart('form', array('method' => 'post',
373 'id' => 'form_apioauthauthorize',
374 'class' => 'form_settings',
375 'action' => common_local_url('ApiOauthAuthorize')));
376 $this->elementStart('fieldset');
377 $this->element('legend', array('id' => 'apioauthauthorize_allowdeny'),
378 // TRANS: Fieldset legend.
379 _('Allow or deny access'));
381 $this->hidden('token', common_session_token());
382 $this->hidden('mode', $this->mode);
383 $this->hidden('oauth_token', $this->oauthTokenParam);
384 $this->hidden('oauth_callback', $this->callback);
386 $this->elementStart('ul', 'form_data');
387 $this->elementStart('li');
388 $this->elementStart('p');
389 if (!empty($this->app->icon)) {
390 $this->element('img', array('src' => $this->app->icon));
393 $access = ($this->app->access_type & Oauth_application::$writeAccess) ?
394 'access and update' : 'access';
396 // TRANS: User notification of external application requesting account access.
397 // TRANS: %1$s is the application name requesting access, %2$s is the organisation behind the application,
398 // TRANS: %3$s is the access type requested, %4$s is the StatusNet sitename.
399 $msg = _('The application <strong>%1$s</strong> by ' .
400 '<strong>%2$s</strong> would like the ability ' .
401 'to <strong>%3$s</strong> your %4$s account data. ' .
402 'You should only give access to your %4$s account ' .
403 'to third parties you trust.');
405 $this->raw(sprintf($msg,
407 $this->app->organization,
409 common_config('site', 'name')));
410 $this->elementEnd('p');
411 $this->elementEnd('li');
412 $this->elementEnd('ul');
416 if (!common_logged_in()) {
417 if (Event::handle('StartOAuthLoginForm', array($this, &$button))) {
418 $this->elementStart('fieldset');
419 // TRANS: Fieldset legend.
420 $this->element('legend', null, _m('LEGEND','Account'));
421 $this->elementStart('ul', 'form_data');
422 $this->elementStart('li');
423 // TRANS: Field label on OAuth API authorisation form.
424 $this->input('nickname', _('Nickname'));
425 $this->elementEnd('li');
426 $this->elementStart('li');
427 // TRANS: Field label on OAuth API authorisation form.
428 $this->password('password', _('Password'));
429 $this->elementEnd('li');
430 $this->elementEnd('ul');
432 $this->elementEnd('fieldset');
434 Event::handle('EndOAuthLoginForm', array($this, &$button));
437 $this->element('input', array('id' => 'cancel_submit',
438 'class' => 'submit submit form_action-primary',
441 // TRANS: Button text that when clicked will cancel the process of allowing access to an account
442 // TRANS: by an external application.
443 'value' => _m('BUTTON','Cancel')));
445 $this->element('input', array('id' => 'allow_submit',
446 'class' => 'submit submit form_action-secondary',
449 // TRANS: Button text that when clicked will allow access to an account by an external application.
450 'value' => $button ? $button : _m('BUTTON','Allow')));
452 $this->elementEnd('fieldset');
453 $this->elementEnd('form');
457 * Instructions for using the form
459 * For "remembered" logins, we make the user re-login when they
460 * try to change settings. Different instructions for this case.
464 function getInstructions()
466 // TRANS: Form instructions.
467 return _('Authorize access to your account information.');
473 * Shows different login/register actions.
477 function showLocalNav()
483 * Checks to see if a the "mode" parameter is present in the request
484 * and set to "desktop". If it is, the page is meant to be displayed in
485 * a small frame of another application, and we should suppress the
486 * header, aside, and footer.
488 function desktopMode()
490 if (isset($this->mode) && $this->mode == 'desktop') {
498 * Override - suppress output in "desktop" mode
500 function showHeader()
502 if ($this->desktopMode() == false) {
503 parent::showHeader();
508 * Override - suppress output in "desktop" mode
512 if ($this->desktopMode() == false) {
518 * Override - suppress output in "desktop" mode
520 function showFooter()
522 if ($this->desktopMode() == false) {
523 parent::showFooter();
532 function showSiteNotice()
540 * Show the form for posting a new notice
544 function showNoticeForm()
550 * Show a nice message confirming the authorization
551 * operation was canceled.
555 function showCanceled()
557 $info = new InfoAction(
558 // TRANS: Header for user notification after revoking OAuth access to an application.
559 _('Authorization canceled.'),
561 // TRANS: User notification after revoking OAuth access to an application.
562 // TRANS: %s is an OAuth token.
563 _('The request token %s has been revoked.'),
564 $this->oauthTokenParam
572 * Show a nice message that the authorization was successful.
573 * If the operation is out-of-band, show a pin.
577 function showAuthorized()
580 // TRANS: Header of user notification after authorising an application access to a profile.
581 // TRANS: %s is the authorised application name.
582 _("You have successfully authorized %s."),
587 // TRANS: Uer notification after authorising an application access to a profile.
588 // TRANS: %s is the authorised application name.
589 _('Please return to %s and enter the following security code to complete the process.'),
593 if ($this->reqToken->verified_callback == 'oob') {
594 $pin = new ApiOauthPinAction($title, $msg, $this->reqToken->verifier);
598 // NOTE: This would only happen if an application registered as
599 // a web application but sent in 'oob' for the oauth_callback
600 // parameter. Usually web apps will send in a callback and
601 // not use the pin-based workflow.
603 $info = new InfoAction(
606 $this->oauthTokenParam,
607 $this->reqToken->verifier
615 * Figure out what the callback should be
617 function getCallback()
621 // Return the verified callback if we have one
622 if ($this->reqToken->verified_callback != 'oob') {
624 $callback = $this->reqToken->verified_callback;
626 // Otherwise return the callback that was provided when
627 // registering the app
628 if (empty($callback)) {
631 "No verified callback found for request token, using application callback: "
632 . $this->app->callback_url,
636 $callback = $this->app->callback_url;
645 * Properly format the callback URL and parameters so it's
646 * suitable for a redirect in the OAuth dance
648 * @param string $url the URL
649 * @param array $params an array of parameters
651 * @return string $url a URL to use for redirecting to
653 function buildCallbackUrl($url, $params)
655 foreach ($params as $k => $v) {
656 $url = $this->appendQueryVar(
658 OAuthUtil::urlencode_rfc3986($k),
659 OAuthUtil::urlencode_rfc3986($v)
667 * Append a new query parameter after any existing query
670 * @param string $url the URL
671 * @prarm string $k the parameter name
672 * @param string $v value of the paramter
674 * @return string $url the new URL with added parameter
676 function appendQueryVar($url, $k, $v) {
677 $url = preg_replace('/(.*)(\?|&)' . $k . '=[^&]+?(&)(.*)/i', '$1$2$4', $url . '&');
678 $url = substr($url, 0, -1);
679 if (strpos($url, '?') === false) {
680 return ($url . '?' . $k . '=' . $v);
682 return ($url . '&' . $k . '=' . $v);