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/
47 class ApiOauthAuthorizeAction extends Action
58 * Is this a read-only action?
60 * @return boolean false
63 function isReadOnly($args)
68 function prepare($args)
70 parent::prepare($args);
72 $this->nickname = $this->trimmed('nickname');
73 $this->password = $this->arg('password');
74 $this->oauthTokenParam = $this->arg('oauth_token');
75 $this->callback = $this->arg('oauth_callback');
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
97 function handle($args)
99 parent::handle($args);
101 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
107 // Make sure a oauth_token parameter was provided
108 if (empty($this->oauthTokenParam)) {
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)) {
117 _('Invalid request token.')
121 // Check to make sure we haven't already authorized the token
122 if ($this->reqToken->state != 0) {
123 $this->clientError("Invalid request token.");
128 // make sure there's an app associated with this token
129 if (empty($this->app)) {
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?
161 $user = common_check_user($this->nickname, $this->password);
163 $this->showForm(_("Invalid nickname / password!"));
167 $user = common_current_user();
170 if ($this->arg('allow')) {
173 $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
175 // mark the req token as authorized
177 $this->store->authorize_token($this->oauthTokenParam);
178 } catch (Exception $e) {
179 $this->serverError($e->getMessage());
182 // Check to see if there was a previous token associated
183 // with this user/app and kill it. If the user is doing this she
184 // probably doesn't want any old tokens anyway.
186 $appUser = Oauth_application_user::getByKeys($user, $this->app);
188 if (!empty($appUser)) {
189 $result = $appUser->delete();
192 common_log_db_error($appUser, 'DELETE', __FILE__);
193 $this->serverError(_('Database error deleting OAuth application user.'));
197 // associated the authorized req token with the user and the app
199 $appUser = new Oauth_application_user();
201 $appUser->profile_id = $user->id;
202 $appUser->application_id = $this->app->id;
204 // Note: do not copy the access type from the application.
205 // The access type should always be 0 when the OAuth app
206 // user record has a request token associated with it.
207 // Access type gets assigned once an access token has been
208 // granted. The OAuth app user record then gets updated
209 // with the new access token and access type.
211 $appUser->token = $this->oauthTokenParam;
212 $appUser->created = common_sql_now();
214 $result = $appUser->insert();
217 common_log_db_error($appUser, 'INSERT', __FILE__);
218 $this->serverError(_('Database error inserting OAuth application user.'));
221 // If we have a callback redirect and provide the token
223 // Note: A callback specified in the app setup overrides whatever
224 // is passed in with the request.
226 if (!empty($this->app->callback_url)) {
227 $this->callback = $this->app->callback_url;
230 if (!empty($this->callback)) {
232 $targetUrl = $this->getCallback(
235 'oauth_token' => $this->oauthTokenParam,
236 'oauth_verifier' => $this->reqToken->verifier // 1.0a
240 // Redirect the user to the provided OAuth callback
241 common_redirect($targetUrl, 303);
246 "No oauth_callback parameter provided for application ID "
248 . " when authorizing request token."
252 // Otherwise, inform the user that the rt was authorized
253 $this->showAuthorized();
255 } else if ($this->arg('cancel')) {
258 $this->store->revoke_token($this->oauthTokenParam, 0);
259 $this->showCanceled();
260 } catch (Exception $e) {
261 $this->ServerError($e->getMessage());
265 $this->clientError(_('Unexpected form submission.'));
269 function showForm($error=null)
271 $this->error = $error;
275 function showScripts()
277 parent::showScripts();
278 if (!common_logged_in()) {
279 $this->autofocus('nickname');
286 * @return string title of the page
291 return _('An application would like to connect to your account');
295 * Shows the authorization form.
300 function showContent()
302 $this->elementStart('form', array('method' => 'post',
303 'id' => 'form_apioauthauthorize',
304 'class' => 'form_settings',
305 'action' => common_local_url('ApiOauthAuthorize')));
306 $this->elementStart('fieldset');
307 $this->element('legend', array('id' => 'apioauthauthorize_allowdeny'),
308 _('Allow or deny access'));
310 $this->hidden('token', common_session_token());
311 $this->hidden('oauth_token', $this->oauthTokenParam);
312 $this->hidden('oauth_callback', $this->callback);
314 $this->elementStart('ul', 'form_data');
315 $this->elementStart('li');
316 $this->elementStart('p');
317 if (!empty($this->app->icon)) {
318 $this->element('img', array('src' => $this->app->icon));
321 $access = ($this->app->access_type & Oauth_application::$writeAccess) ?
322 'access and update' : 'access';
324 $msg = _('The application <strong>%1$s</strong> by ' .
325 '<strong>%2$s</strong> would like the ability ' .
326 'to <strong>%3$s</strong> your %4$s account data. ' .
327 'You should only give access to your %4$s account ' .
328 'to third parties you trust.');
330 $this->raw(sprintf($msg,
332 $this->app->organization,
334 common_config('site', 'name')));
335 $this->elementEnd('p');
336 $this->elementEnd('li');
337 $this->elementEnd('ul');
339 if (!common_logged_in()) {
341 $this->elementStart('fieldset');
342 $this->element('legend', null, _('Account'));
343 $this->elementStart('ul', 'form_data');
344 $this->elementStart('li');
345 $this->input('nickname', _('Nickname'));
346 $this->elementEnd('li');
347 $this->elementStart('li');
348 $this->password('password', _('Password'));
349 $this->elementEnd('li');
350 $this->elementEnd('ul');
352 $this->elementEnd('fieldset');
356 $this->element('input', array('id' => 'cancel_submit',
357 'class' => 'submit submit form_action-primary',
360 'value' => _('Cancel')));
362 $this->element('input', array('id' => 'allow_submit',
363 'class' => 'submit submit form_action-secondary',
366 'value' => _('Allow')));
368 $this->elementEnd('fieldset');
369 $this->elementEnd('form');
373 * Instructions for using the form
375 * For "remembered" logins, we make the user re-login when they
376 * try to change settings. Different instructions for this case.
381 function getInstructions()
383 return _('Authorize access to your account information.');
389 * Shows different login/register actions.
394 function showLocalNav()
405 function showSiteNotice()
413 * Show the form for posting a new notice
418 function showNoticeForm()
424 * Show a nice message confirming the authorization
425 * operation was canceled.
430 function showCanceled()
432 $info = new InfoAction(
433 _('Authorization canceled.'),
435 _('The request token %s has been revoked.'),
436 $this->oauthTokenParm
444 * Show a nice message that the authorization was successful.
445 * If the operation is out-of-band, show a pin.
450 function showAuthorized()
453 _("You have successfully authorized %s."),
458 _('Please return to %s and enter the following security code to complete the process.'),
462 if ($this->reqToken->verified_callback == 'oob') {
463 $pin = new ApiOauthPinAction($title, $msg, $this->reqToken->verifier);
467 // NOTE: This would only happen if an application registered as
468 // a web application but sent in 'oob' for the oauth_callback
469 // parameter. Usually web apps will send in a callback and
470 // not use the pin-based workflow.
472 $info = new InfoAction(
475 $this->oauthTokenParam,
476 $this->reqToken->verifier
484 * Properly format the callback URL and parameters so it's
485 * suitable for a redirect in the OAuth dance
487 * @param string $url the URL
488 * @param array $params an array of parameters
490 * @return string $url a URL to use for redirecting to
493 function getCallback($url, $params)
495 foreach ($params as $k => $v) {
496 $url = $this->appendQueryVar(
498 OAuthUtil::urlencode_rfc3986($k),
499 OAuthUtil::urlencode_rfc3986($v)
507 * Append a new query parameter after any existing query
510 * @param string $url the URL
511 * @prarm string $k the parameter name
512 * @param string $v value of the paramter
514 * @return string $url the new URL with added parameter
517 function appendQueryVar($url, $k, $v) {
518 $url = preg_replace('/(.*)(\?|&)' . $k . '=[^&]+?(&)(.*)/i', '$1$2$4', $url . '&');
519 $url = substr($url, 0, -1);
520 if (strpos($url, '?') === false) {
521 return ($url . '?' . $k . '=' . $v);
523 return ($url . '&' . $k . '=' . $v);