3 * StatusNet, the distributed open-source microblogging tool
5 * List a user's OAuth connected applications
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 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/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 require_once INSTALLDIR . '/lib/applicationlist.php';
35 require_once INSTALLDIR . '/lib/apioauthstore.php';
38 * Show connected OAuth applications
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/
48 class OauthconnectionssettingsAction extends SettingsAction
51 var $oauth_token = null;
53 function prepare($args)
55 parent::prepare($args);
56 $this->oauth_token = $this->arg('oauth_token');
57 $this->page = ($this->arg('page')) ? ($this->arg('page') + 0) : 1;
64 * @return string Title of the page
68 // TRANS: Title for OAuth connection settings.
69 return _('Connected applications');
73 * Instructions for use
75 * @return instructions for use
77 function getInstructions()
79 // TRANS: Instructions for OAuth connection settings.
80 return _('The following connections exist for your account.');
84 * Content area of the page
89 function showContent()
91 $user = common_current_user();
92 $profile = $user->getProfile();
94 $offset = ($this->page - 1) * APPS_PER_PAGE;
95 $limit = APPS_PER_PAGE + 1;
97 $connection = $user->getConnectedApps($offset, $limit);
101 if (!empty($connection)) {
102 $cal = new ConnectedAppsList($connection, $user, $this);
107 $this->showEmptyListMessage();
112 $cnt > APPS_PER_PAGE,
114 'connectionssettings',
115 array('nickname' => $user->nickname)
120 * Handle posts to this form
122 * Based on the button that was pressed, muxes out to other functions
123 * to do the actual task requested.
125 * All sub-functions reload the form with a message -- success or failure.
129 function handlePost()
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.'));
141 if ($this->arg('revoke')) {
142 $this->revokeAccess($this->oauth_token);
144 // TRANS: Client error when submitting a form with unexpected information.
145 $this->clientError(_('Unexpected form submission.'), 401);
151 * Revoke an access token
153 * XXX: Confirm revoke before doing it
155 * @param int $appId the ID of the application
158 function revokeAccess($token)
160 $cur = common_current_user();
162 $appUser = Oauth_application_user::getByUserAndToken($cur, $token);
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);
170 $app = Oauth_application::staticGet('id', $appUser->application_id);
172 $datastore = new ApiStatusNetOAuthDataStore();
173 $datastore->revoke_token($appUser->token, 1);
175 $result = $appUser->delete();
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));
185 $msg = 'API OAuth - user %s (id: %d) revoked access token %s for app id %d';
193 $appUser->application_id
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.'),
202 substr($appUser->token, 0, 7)
205 $this->showForm($msg, true);
208 function showEmptyListMessage()
210 // TRANS: Empty list message when no applications have been authorised yet.
211 $message = _('You have not authorized any applications to use your account.');
213 $this->elementStart('div', 'guide');
214 $this->raw(common_markup_to_html($message));
215 $this->elementEnd('div');
218 function showSections()
220 $cur = common_current_user();
222 $this->elementStart('div', array('id' => 'developer-help', 'class' => 'section'));
224 $this->element('h2', null, 'Developers');
225 $this->elementStart('p');
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')
235 $output = common_markup_to_html($devMsg);
238 $this->elementEnd('p');
240 $this->elementEnd('section');