X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=actions%2Fapioauthauthorize.php;h=b2c0de719add7a200398b10d9775060a90c6b02c;hb=c4b8f68a1a3ed6422a2ed1cb7a8b5b5c65011b5f;hp=135c146e5f0b634a586cb77ab3d39973e937befa;hpb=bd7c8825cef793d39a71546319ebae6a04c21e58;p=quix0rs-gnu-social.git
diff --git a/actions/apioauthauthorize.php b/actions/apioauthauthorize.php
index 135c146e5f..b2c0de719a 100644
--- a/actions/apioauthauthorize.php
+++ b/actions/apioauthauthorize.php
@@ -35,7 +35,7 @@ require_once INSTALLDIR . '/lib/apioauth.php';
require_once INSTALLDIR . '/lib/info.php';
/**
- * Authorize an OAuth request token
+ * Authorize an Oputh request token
*
* @category API
* @package StatusNet
@@ -58,7 +58,6 @@ class ApiOauthAuthorizeAction extends Action
*
* @return boolean false
*/
-
function isReadOnly($args)
{
return false;
@@ -68,11 +67,11 @@ class ApiOauthAuthorizeAction extends Action
{
parent::prepare($args);
- $this->nickname = $this->trimmed('nickname');
- $this->password = $this->arg('password');
- $this->oauthTokenParam = $this->arg('oauth_token');
- $this->callback = $this->arg('oauth_callback');
- $this->store = new ApiStatusNetOAuthDataStore();
+ $this->nickname = $this->trimmed('nickname');
+ $this->password = $this->arg('password');
+ $this->oauthTokenParam = $this->arg('oauth_token');
+ $this->mode = $this->arg('mode');
+ $this->store = new ApiStatusNetOAuthDataStore();
try {
$this->app = $this->store->getAppByRequestToken($this->oauthTokenParam);
@@ -92,7 +91,6 @@ class ApiOauthAuthorizeAction extends Action
*
* @return void
*/
-
function handle($args)
{
parent::handle($args);
@@ -120,7 +118,7 @@ class ApiOauthAuthorizeAction extends Action
// Check to make sure we haven't already authorized the token
if ($this->reqToken->state != 0) {
// TRANS: Client error given when an invalid request token was passed to the OAuth API.
- $this->clientError(_("Invalid request token."));
+ $this->clientError(_('Request token already authorized.'));
}
}
}
@@ -145,6 +143,7 @@ class ApiOauthAuthorizeAction extends Action
if (!$token || $token != common_session_token()) {
$this->showForm(
+ // TRANS: Form validation error in API OAuth authorisation because of an invalid session token.
_('There was a problem with your session token. Try again, please.'));
return;
}
@@ -173,11 +172,11 @@ class ApiOauthAuthorizeAction extends Action
$user = common_current_user();
}
- if ($this->arg('allow')) {
-
- // fetch the token
- $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
+ // fetch the token
+ $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
+ assert(!empty($this->reqToken));
+ if ($this->arg('allow')) {
// mark the req token as authorized
try {
$this->store->authorize_token($this->oauthTokenParam);
@@ -185,51 +184,55 @@ class ApiOauthAuthorizeAction extends Action
$this->serverError($e->getMessage());
}
- // associated the authorized req token with the user and the app
-
- $appUser = new Oauth_application_user();
+ common_log(
+ LOG_INFO,
+ sprintf(
+ "API OAuth - User %d (%s) has authorized request token %s for OAuth application %d (%s).",
+ $user->id,
+ $user->nickname,
+ $this->reqToken->tok,
+ $this->app->id,
+ $this->app->name
+ )
+ );
- $appUser->profile_id = $user->id;
- $appUser->application_id = $this->app->id;
+ // XXX: Make sure we have a oauth_token_association table. The table
+ // is now in the main schema, but because it is being added with
+ // a point release, it's unlikely to be there. This code can be
+ // removed as of 1.0.
+ $this->ensureOauthTokenAssociationTable();
- // Note: do not copy the access type from the application.
- // The access type should always be 0 when the OAuth app
- // user record has a request token associated with it.
- // Access type gets assigned once an access token has been
- // granted. The OAuth app user record then gets updated
- // with the new access token and access type.
+ $tokenAssoc = new Oauth_token_association();
- $appUser->token = $this->oauthTokenParam;
- $appUser->created = common_sql_now();
+ $tokenAssoc->profile_id = $user->id;
+ $tokenAssoc->application_id = $this->app->id;
+ $tokenAssoc->token = $this->oauthTokenParam;
+ $tokenAssoc->created = common_sql_now();
- $result = $appUser->insert();
+ $result = $tokenAssoc->insert();
if (!$result) {
- common_log_db_error($appUser, 'INSERT', __FILE__);
- // TRANS: Server error given when a database error occurs inserting an OAuth application user.
- $this->serverError(_('Database error inserting OAuth application user.'));
+ common_log_db_error($tokenAssoc, 'INSERT', __FILE__);
+ // TRANS: Server error displayed when a database action fails.
+ $this->serverError(_('Database error inserting oauth_token_association.'));
}
- // If we have a callback redirect and provide the token
+ $callback = $this->getCallback();
- // Note: A callback specified in the app setup overrides whatever
- // is passed in with the request.
-
- if (!empty($this->app->callback_url)) {
- $this->callback = $this->app->callback_url;
- }
-
- if (!empty($this->callback)) {
- $targetUrl = $this->getCallback(
- $this->callback,
+ if (!empty($callback) && $this->reqToken->verified_callback != 'oob') {
+ $targetUrl = $this->buildCallbackUrl(
+ $callback,
array(
'oauth_token' => $this->oauthTokenParam,
'oauth_verifier' => $this->reqToken->verifier // 1.0a
)
);
+ common_log(LOG_INFO, "Redirecting to callback: $targetUrl");
+
// Redirect the user to the provided OAuth callback
common_redirect($targetUrl, 303);
+
} elseif ($this->app->type == 2) {
// Strangely, a web application seems to want to do the OOB
// workflow. Because no callback was specified anywhere.
@@ -244,34 +247,121 @@ class ApiOauthAuthorizeAction extends Action
);
}
+ // Otherwise, inform the user that the rt was authorized
+ $this->showAuthorized();
+ } else if ($this->arg('cancel')) {
common_log(
LOG_INFO,
sprintf(
- "The request token '%s' for OAuth application %s (%s) has been authorized.",
- $this->oauthTokenParam,
+ "API OAuth - User %d (%s) refused to authorize request token %s for OAuth application %d (%s).",
+ $user->id,
+ $user->nickname,
+ $this->reqToken->tok,
$this->app->id,
$this->app->name
)
);
- // Otherwise, inform the user that the rt was authorized
- $this->showAuthorized();
-
- } else if ($this->arg('cancel')) {
-
try {
$this->store->revoke_token($this->oauthTokenParam, 0);
- $this->showCanceled();
} catch (Exception $e) {
$this->ServerError($e->getMessage());
}
+ $callback = $this->getCallback();
+
+ // If there's a callback available, inform the consumer the user
+ // has refused authorization
+ if (!empty($callback) && $this->reqToken->verified_callback != 'oob') {
+ $targetUrl = $this->buildCallbackUrl(
+ $callback,
+ array(
+ 'oauth_problem' => 'user_refused',
+ )
+ );
+
+ common_log(LOG_INFO, "Redirecting to callback: $targetUrl");
+
+ // Redirect the user to the provided OAuth callback
+ common_redirect($targetUrl, 303);
+ }
+
+ // otherwise inform the user that authorization for the rt was declined
+ $this->showCanceled();
+
} else {
// TRANS: Client error given on when invalid data was passed through a form in the OAuth API.
$this->clientError(_('Unexpected form submission.'));
}
}
+ // XXX Remove this function when we hit 1.0
+ function ensureOauthTokenAssociationTable()
+ {
+ $schema = Schema::get();
+
+ $reqTokenCols = array(
+ new ColumnDef('profile_id', 'integer', null, true, 'PRI'),
+ new ColumnDef('application_id', 'integer', null, true, 'PRI'),
+ new ColumnDef('token', 'varchar', 255, true, 'PRI'),
+ new ColumnDef('created', 'datetime', null, false),
+ new ColumnDef(
+ 'modified',
+ 'timestamp',
+ null,
+ false,
+ null,
+ 'CURRENT_TIMESTAMP',
+ 'on update CURRENT_TIMESTAMP'
+ )
+ );
+
+ $schema->ensureTable('oauth_token_association', $reqTokenCols);
+ }
+
+ /**
+ * Show body - override to add a special CSS class for the authorize
+ * page's "desktop mode" (minimal display)
+ *
+ * Calls template methods
+ *
+ * @return nothing
+ */
+ function showBody()
+ {
+ $bodyClasses = array();
+
+ if ($this->desktopMode()) {
+ $bodyClasses[] = 'oauth-desktop-mode';
+ }
+
+ if (common_current_user()) {
+ $bodyClasses[] = 'user_in';
+ }
+
+ $attrs = array('id' => strtolower($this->trimmed('action')));
+
+ if (!empty($bodyClasses)) {
+ $attrs['class'] = implode(' ', $bodyClasses);
+ }
+
+ $this->elementStart('body', $attrs);
+
+ $this->elementStart('div', array('id' => 'wrap'));
+ if (Event::handle('StartShowHeader', array($this))) {
+ $this->showHeader();
+ Event::handle('EndShowHeader', array($this));
+ }
+ $this->showCore();
+ if (Event::handle('StartShowFooter', array($this))) {
+ $this->showFooter();
+ Event::handle('EndShowFooter', array($this));
+ }
+ $this->elementEnd('div');
+ $this->showScripts();
+ $this->elementEnd('body');
+ }
+
function showForm($error=null)
{
$this->error = $error;
@@ -291,7 +381,6 @@ class ApiOauthAuthorizeAction extends Action
*
* @return string title of the page
*/
-
function title()
{
// TRANS: Title for a page where a user can confirm/deny account access by an external application.
@@ -303,7 +392,6 @@ class ApiOauthAuthorizeAction extends Action
*
* @return void
*/
-
function showContent()
{
$this->elementStart('form', array('method' => 'post',
@@ -316,27 +404,38 @@ class ApiOauthAuthorizeAction extends Action
_('Allow or deny access'));
$this->hidden('token', common_session_token());
+ $this->hidden('mode', $this->mode);
$this->hidden('oauth_token', $this->oauthTokenParam);
$this->hidden('oauth_callback', $this->callback);
$this->elementStart('ul', 'form_data');
$this->elementStart('li');
$this->elementStart('p');
- if (!empty($this->app->icon)) {
+ if (!empty($this->app->icon) && $this->app->name != 'anonymous') {
$this->element('img', array('src' => $this->app->icon));
}
$access = ($this->app->access_type & Oauth_application::$writeAccess) ?
'access and update' : 'access';
- // TRANS: User notification of external application requesting account access.
- // TRANS: %1$s is the application name requesting access, %2$s is the organisation behind the application,
- // TRANS: %3$s is the access type requested, %4$s is the StatusNet sitename.
- $msg = _('The application %1$s by ' .
- '%2$s would like the ability ' .
+ if ($this->app->name == 'anonymous') {
+ // Special message for the anonymous app and consumer.
+ // TRANS: User notification of external application requesting account access.
+ // TRANS: %3$s is the access type requested, %4$s is the StatusNet sitename.
+ $msg = _('An application would like the ability ' .
'to %3$s your %4$s account data. ' .
'You should only give access to your %4$s account ' .
'to third parties you trust.');
+ } else {
+ // TRANS: User notification of external application requesting account access.
+ // TRANS: %1$s is the application name requesting access, %2$s is the organisation behind the application,
+ // TRANS: %3$s is the access type requested, %4$s is the StatusNet sitename.
+ $msg = _('The application %1$s by ' .
+ '%2$s would like the ability ' .
+ 'to %3$s your %4$s account data. ' .
+ 'You should only give access to your %4$s account ' .
+ 'to third parties you trust.');
+ }
$this->raw(sprintf($msg,
$this->app->name,
@@ -415,6 +514,51 @@ class ApiOauthAuthorizeAction extends Action
// NOP
}
+ /*
+ * Checks to see if a the "mode" parameter is present in the request
+ * and set to "desktop". If it is, the page is meant to be displayed in
+ * a small frame of another application, and we should suppress the
+ * header, aside, and footer.
+ */
+ function desktopMode()
+ {
+ if (isset($this->mode) && $this->mode == 'desktop') {
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /*
+ * Override - suppress output in "desktop" mode
+ */
+ function showHeader()
+ {
+ if ($this->desktopMode() == false) {
+ parent::showHeader();
+ }
+ }
+
+ /*
+ * Override - suppress output in "desktop" mode
+ */
+ function showAside()
+ {
+ if ($this->desktopMode() == false) {
+ parent::showAside();
+ }
+ }
+
+ /*
+ * Override - suppress output in "desktop" mode
+ */
+ function showFooter()
+ {
+ if ($this->desktopMode() == false) {
+ parent::showFooter();
+ }
+ }
+
/**
* Show site notice.
*
@@ -452,7 +596,7 @@ class ApiOauthAuthorizeAction extends Action
// TRANS: User notification after revoking OAuth access to an application.
// TRANS: %s is an OAuth token.
_('The request token %s has been revoked.'),
- $this->oauthTokenParm
+ $this->oauthTokenParam
)
);
@@ -467,25 +611,46 @@ class ApiOauthAuthorizeAction extends Action
*/
function showAuthorized()
{
- $title = sprintf(
- // TRANS: Header of user notification after authorising an application access to a profile.
- // TRANS: %s is the authorised application name.
- _("You have successfully authorized %s."),
- $this->app->name
- );
+ $title = null;
+ $msg = null;
- $msg = sprintf(
- // TRANS: Uer notification after authorising an application access to a profile.
- // TRANS: %s is the authorised application name.
- _('Please return to %s and enter the following security code to complete the process.'),
- $this->app->name
- );
+ if ($this->app->name == 'anonymous') {
+
+ $title =
+ // TRANS: Title of the page notifying the user that an anonymous client application was successfully authorized to access the user's account with OAuth.
+ _('You have successfully authorized the application');
+
+ $msg =
+ // TRANS: Message notifying the user that an anonymous client application was successfully authorized to access the user's account with OAuth.
+ _('Please return to the application and enter the following security code to complete the process.');
+
+ } else {
+
+ $title = sprintf(
+ // TRANS: Title of the page notifying the user that the client application was successfully authorized to access the user's account with OAuth.
+ // TRANS: %s is the authorised application name.
+ _('You have successfully authorized %s'),
+ $this->app->name
+ );
+
+ $msg = sprintf(
+ // TRANS: Message notifying the user that the client application was successfully authorized to access the user's account with OAuth.
+ // TRANS: %s is the authorised application name.
+ _('Please return to %s and enter the following security code to complete the process.'),
+ $this->app->name
+ );
+
+ }
if ($this->reqToken->verified_callback == 'oob') {
- $pin = new ApiOauthPinAction($title, $msg, $this->reqToken->verifier);
+ $pin = new ApiOauthPinAction(
+ $title,
+ $msg,
+ $this->reqToken->verifier,
+ $this->desktopMode()
+ );
$pin->showPage();
} else {
-
// NOTE: This would only happen if an application registered as
// a web application but sent in 'oob' for the oauth_callback
// parameter. Usually web apps will send in a callback and
@@ -502,6 +667,35 @@ class ApiOauthAuthorizeAction extends Action
}
}
+ /*
+ * Figure out what the callback should be
+ */
+ function getCallback()
+ {
+ $callback = null;
+
+ // Return the verified callback if we have one
+ if ($this->reqToken->verified_callback != 'oob') {
+
+ $callback = $this->reqToken->verified_callback;
+
+ // Otherwise return the callback that was provided when
+ // registering the app
+ if (empty($callback)) {
+
+ common_debug(
+ "No verified callback found for request token, using application callback: "
+ . $this->app->callback_url,
+ __FILE__
+ );
+
+ $callback = $this->app->callback_url;
+ }
+ }
+
+ return $callback;
+ }
+
/*
* Properly format the callback URL and parameters so it's
* suitable for a redirect in the OAuth dance
@@ -511,7 +705,7 @@ class ApiOauthAuthorizeAction extends Action
*
* @return string $url a URL to use for redirecting to
*/
- function getCallback($url, $params)
+ function buildCallbackUrl($url, $params)
{
foreach ($params as $k => $v) {
$url = $this->appendQueryVar(