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 OAuth 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->callback = $this->arg('oauth_callback');
75 $this->mode = $this->arg('mode');
76 $this->store = new ApiStatusNetOAuthDataStore();
79 $this->app = $this->store->getAppByRequestToken($this->oauthTokenParam);
80 } catch (Exception $e) {
81 $this->clientError($e->getMessage());
88 * Handle input, produce output
90 * Switches on request method; either shows the form or handles its input.
92 * @param array $args $_REQUEST data
96 function handle($args)
98 parent::handle($args);
100 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
106 // Make sure a oauth_token parameter was provided
107 if (empty($this->oauthTokenParam)) {
108 // TRANS: Client error given when no oauth_token was passed to the OAuth API.
109 $this->clientError(_('No oauth_token parameter provided.'));
112 // Check to make sure the token exists
113 $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
115 if (empty($this->reqToken)) {
116 // TRANS: Client error given when an invalid request token was passed to the OAuth API.
117 $this->clientError(_('Invalid request token.'));
120 // Check to make sure we haven't already authorized the token
121 if ($this->reqToken->state != 0) {
122 // TRANS: Client error given when an invalid request token was passed to the OAuth API.
123 $this->clientError(_('Invalid request token.'));
128 // make sure there's an app associated with this token
129 if (empty($this->app)) {
130 // TRANS: Client error given when an invalid request token was passed to the OAuth API.
131 $this->clientError(_('Invalid request token.'));
134 $name = $this->app->name;
140 function handlePost()
142 // check session token for CSRF protection.
144 $token = $this->trimmed('token');
146 if (!$token || $token != common_session_token()) {
148 _('There was a problem with your session token. Try again, please.'));
156 if (!common_logged_in()) {
158 // XXX Force credentials check?
160 // @fixme this should probably use a unified login form handler
162 if (Event::handle('StartOAuthLoginCheck', array($this, &$user))) {
163 $user = common_check_user($this->nickname, $this->password);
165 Event::handle('EndOAuthLoginCheck', array($this, &$user));
168 // TRANS: Form validation error given when an invalid username and/or password was passed to the OAuth API.
169 $this->showForm(_("Invalid nickname / password!"));
173 $user = common_current_user();
176 if ($this->arg('allow')) {
179 $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
181 // mark the req token as authorized
183 $this->store->authorize_token($this->oauthTokenParam);
184 } catch (Exception $e) {
185 $this->serverError($e->getMessage());
188 // XXX: Make sure we have a oauth_token_association table. The table
189 // is now in the main schema, but because it is being added with
190 // a point release, it's unlikely to be there. This code can be
191 // removed as of 1.0.
192 $this->ensureOauthTokenAssociationTable();
194 $tokenAssoc = new Oauth_token_association();
196 $tokenAssoc->profile_id = $user->id;
197 $tokenAssoc->application_id = $this->app->id;
198 $tokenAssoc->token = $this->oauthTokenParam;
199 $tokenAssoc->created = common_sql_now();
201 $result = $tokenAssoc->insert();
204 common_log_db_error($tokenAssoc, 'INSERT', __FILE__);
205 // TRANS: Server error displayed when a database action fails.
206 $this->serverError(_('Database error inserting oauth_token_association.'));
209 // If we have a callback redirect and provide the token
211 // Note: A callback specified in the app setup overrides whatever
212 // is passed in with the request.
214 if (!empty($this->app->callback_url)) {
215 $this->callback = $this->app->callback_url;
218 if (!empty($this->callback)) {
219 $targetUrl = $this->getCallback(
222 'oauth_token' => $this->oauthTokenParam,
223 'oauth_verifier' => $this->reqToken->verifier // 1.0a
227 // Redirect the user to the provided OAuth callback
228 common_redirect($targetUrl, 303);
229 } elseif ($this->app->type == 2) {
230 // Strangely, a web application seems to want to do the OOB
231 // workflow. Because no callback was specified anywhere.
235 "API OAuth - No callback provided for OAuth web client ID %s (%s) "
236 . "during authorization step. Falling back to OOB workflow.",
246 "The request token '%s' for OAuth application %s (%s) has been authorized.",
247 $this->oauthTokenParam,
253 // Otherwise, inform the user that the rt was authorized
254 $this->showAuthorized();
255 } else if ($this->arg('cancel')) {
257 $this->store->revoke_token($this->oauthTokenParam, 0);
258 $this->showCanceled();
259 } catch (Exception $e) {
260 $this->ServerError($e->getMessage());
263 // TRANS: Client error given on when invalid data was passed through a form in the OAuth API.
264 $this->clientError(_('Unexpected form submission.'));
268 // XXX Remove this function when we hit 1.0
269 function ensureOauthTokenAssociationTable()
271 $schema = Schema::get();
273 $reqTokenCols = array(
274 new ColumnDef('profile_id', 'integer', null, true, 'PRI'),
275 new ColumnDef('application_id', 'integer', null, true, 'PRI'),
276 new ColumnDef('token', 'varchar', 255, true, 'PRI'),
277 new ColumnDef('created', 'datetime', null, false),
285 'on update CURRENT_TIMESTAMP'
289 $schema->ensureTable('oauth_token_association', $reqTokenCols);
292 function showForm($error=null)
294 $this->error = $error;
298 function showScripts()
300 parent::showScripts();
301 if (!common_logged_in()) {
302 $this->autofocus('nickname');
309 * @return string title of the page
313 // TRANS: Title for a page where a user can confirm/deny account access by an external application.
314 return _('An application would like to connect to your account');
318 * Shows the authorization form.
322 function showContent()
324 $this->elementStart('form', array('method' => 'post',
325 'id' => 'form_apioauthauthorize',
326 'class' => 'form_settings',
327 'action' => common_local_url('ApiOauthAuthorize')));
328 $this->elementStart('fieldset');
329 $this->element('legend', array('id' => 'apioauthauthorize_allowdeny'),
330 // TRANS: Fieldset legend.
331 _('Allow or deny access'));
333 $this->hidden('token', common_session_token());
334 $this->hidden('oauth_token', $this->oauthTokenParam);
335 $this->hidden('oauth_callback', $this->callback);
337 $this->elementStart('ul', 'form_data');
338 $this->elementStart('li');
339 $this->elementStart('p');
340 if (!empty($this->app->icon)) {
341 $this->element('img', array('src' => $this->app->icon));
344 $access = ($this->app->access_type & Oauth_application::$writeAccess) ?
345 'access and update' : 'access';
347 // TRANS: User notification of external application requesting account access.
348 // TRANS: %1$s is the application name requesting access, %2$s is the organisation behind the application,
349 // TRANS: %3$s is the access type requested, %4$s is the StatusNet sitename.
350 $msg = _('The application <strong>%1$s</strong> by ' .
351 '<strong>%2$s</strong> would like the ability ' .
352 'to <strong>%3$s</strong> your %4$s account data. ' .
353 'You should only give access to your %4$s account ' .
354 'to third parties you trust.');
356 $this->raw(sprintf($msg,
358 $this->app->organization,
360 common_config('site', 'name')));
361 $this->elementEnd('p');
362 $this->elementEnd('li');
363 $this->elementEnd('ul');
367 if (!common_logged_in()) {
368 if (Event::handle('StartOAuthLoginForm', array($this, &$button))) {
369 $this->elementStart('fieldset');
370 // TRANS: Fieldset legend.
371 $this->element('legend', null, _m('LEGEND','Account'));
372 $this->elementStart('ul', 'form_data');
373 $this->elementStart('li');
374 // TRANS: Field label on OAuth API authorisation form.
375 $this->input('nickname', _('Nickname'));
376 $this->elementEnd('li');
377 $this->elementStart('li');
378 // TRANS: Field label on OAuth API authorisation form.
379 $this->password('password', _('Password'));
380 $this->elementEnd('li');
381 $this->elementEnd('ul');
383 $this->elementEnd('fieldset');
385 Event::handle('EndOAuthLoginForm', array($this, &$button));
388 $this->element('input', array('id' => 'cancel_submit',
389 'class' => 'submit submit form_action-primary',
392 // TRANS: Button text that when clicked will cancel the process of allowing access to an account
393 // TRANS: by an external application.
394 'value' => _m('BUTTON','Cancel')));
396 $this->element('input', array('id' => 'allow_submit',
397 'class' => 'submit submit form_action-secondary',
400 // TRANS: Button text that when clicked will allow access to an account by an external application.
401 'value' => $button ? $button : _m('BUTTON','Allow')));
403 $this->elementEnd('fieldset');
404 $this->elementEnd('form');
408 * Instructions for using the form
410 * For "remembered" logins, we make the user re-login when they
411 * try to change settings. Different instructions for this case.
415 function getInstructions()
417 // TRANS: Form instructions.
418 return _('Authorize access to your account information.');
424 * Shows different login/register actions.
428 function showLocalNav()
434 * Checks to see if a the "mode" parameter is present in the request
435 * and set to "desktop". If it is, the page is meant to be displayed in
436 * a small frame of another application, and we should suppress the
437 * header, aside, and footer.
439 function desktopMode()
441 if (isset($this->mode) && $this->mode == 'desktop') {
449 * Override - suppress output in "desktop" mode
451 function showHeader()
453 if ($this->desktopMode() == false) {
454 parent::showHeader();
459 * Override - suppress output in "desktop" mode
463 if ($this->desktopMode() == false) {
464 parent::showHeader();
469 * Override - suppress output in "desktop" mode
471 function showFooter()
473 if ($this->desktopMode() == false) {
474 parent::showHeader();
483 function showSiteNotice()
491 * Show the form for posting a new notice
495 function showNoticeForm()
501 * Show a nice message confirming the authorization
502 * operation was canceled.
506 function showCanceled()
508 $info = new InfoAction(
509 // TRANS: Header for user notification after revoking OAuth access to an application.
510 _('Authorization canceled.'),
512 // TRANS: User notification after revoking OAuth access to an application.
513 // TRANS: %s is an OAuth token.
514 _('The request token %s has been revoked.'),
515 $this->oauthTokenParm
523 * Show a nice message that the authorization was successful.
524 * If the operation is out-of-band, show a pin.
528 function showAuthorized()
531 // TRANS: Header of user notification after authorising an application access to a profile.
532 // TRANS: %s is the authorised application name.
533 _("You have successfully authorized %s."),
538 // TRANS: Uer notification after authorising an application access to a profile.
539 // TRANS: %s is the authorised application name.
540 _('Please return to %s and enter the following security code to complete the process.'),
544 if ($this->reqToken->verified_callback == 'oob') {
545 $pin = new ApiOauthPinAction($title, $msg, $this->reqToken->verifier);
549 // NOTE: This would only happen if an application registered as
550 // a web application but sent in 'oob' for the oauth_callback
551 // parameter. Usually web apps will send in a callback and
552 // not use the pin-based workflow.
554 $info = new InfoAction(
557 $this->oauthTokenParam,
558 $this->reqToken->verifier
566 * Properly format the callback URL and parameters so it's
567 * suitable for a redirect in the OAuth dance
569 * @param string $url the URL
570 * @param array $params an array of parameters
572 * @return string $url a URL to use for redirecting to
574 function getCallback($url, $params)
576 foreach ($params as $k => $v) {
577 $url = $this->appendQueryVar(
579 OAuthUtil::urlencode_rfc3986($k),
580 OAuthUtil::urlencode_rfc3986($v)
588 * Append a new query parameter after any existing query
591 * @param string $url the URL
592 * @prarm string $k the parameter name
593 * @param string $v value of the paramter
595 * @return string $url the new URL with added parameter
597 function appendQueryVar($url, $k, $v) {
598 $url = preg_replace('/(.*)(\?|&)' . $k . '=[^&]+?(&)(.*)/i', '$1$2$4', $url . '&');
599 $url = substr($url, 0, -1);
600 if (strpos($url, '?') === false) {
601 return ($url . '?' . $k . '=' . $v);
603 return ($url . '&' . $k . '=' . $v);