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('GNUSOCIAL')) { exit(1); }
33 * Show connected OAuth applications
37 * @author Zach Copley <zach@status.net>
38 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
39 * @link http://status.net/
43 class OauthconnectionssettingsAction extends SettingsAction
47 protected $oauth_token = null;
49 protected function doPreparation()
51 $this->oauth_token = $this->arg('oauth_token');
52 $this->page = $this->int('page') ?: 1;
58 * @return string Title of the page
62 // TRANS: Title for OAuth connection settings.
63 return _('Connected applications');
67 * Instructions for use
69 * @return instructions for use
71 function getInstructions()
73 // TRANS: Instructions for OAuth connection settings.
74 return _('The following connections exist for your account.');
78 * Content area of the page
83 function showContent()
85 $offset = ($this->page - 1) * APPS_PER_PAGE;
86 $limit = APPS_PER_PAGE + 1;
88 $connection = $this->scoped->getConnectedApps($offset, $limit);
92 if (!empty($connection)) {
93 $cal = new ConnectedAppsList($connection, $this->scoped, $this);
98 $this->showEmptyListMessage();
103 $cnt > APPS_PER_PAGE,
105 'connectionssettings',
106 array('nickname' => $this->scoped->getNickname())
111 * Handle posts to this form
113 * Based on the button that was pressed, muxes out to other functions
114 * to do the actual task requested.
116 * All sub-functions reload the form with a message -- success or failure.
120 protected function doPost()
122 if ($this->arg('revoke')) {
123 return $this->revokeAccess($this->oauth_token);
126 // TRANS: Client error when submitting a form with unexpected information.
127 throw new ClientException(_('Unexpected form submission.'), 401);
131 * Revoke an access token
133 * XXX: Confirm revoke before doing it
135 * @param int $appId the ID of the application
138 function revokeAccess($token)
140 $cur = common_current_user();
142 $appUser = Oauth_application_user::getByUserAndToken($cur, $token);
144 if (empty($appUser)) {
145 // TRANS: Client error when trying to revoke access for an application while not being a user of it.
146 $this->clientError(_('You are not a user of that application.'), 401);
149 $app = Oauth_application::getKV('id', $appUser->application_id);
151 $datastore = new ApiGNUsocialOAuthDataStore();
152 $datastore->revoke_token($appUser->token, 1);
154 $result = $appUser->delete();
157 common_log_db_error($orig, 'DELETE', __FILE__);
158 // TRANS: Client error when revoking access has failed for some reason.
159 // TRANS: %s is the application ID revoking access failed for.
160 $this->clientError(sprintf(_('Unable to revoke access for application: %s.'), $app->id));
163 $msg = 'API OAuth - user %s (id: %d) revoked access token %s for app id %d';
171 $appUser->application_id
176 // TRANS: Success message after revoking access for an application.
177 // TRANS: %1$s is the application name, %2$s is the first part of the user token.
178 _('You have successfully revoked access for %1$s and the access token starting with %2$s.'),
180 substr($appUser->token, 0, 7)
183 $this->showForm($msg, true);
186 function showEmptyListMessage()
188 // TRANS: Empty list message when no applications have been authorised yet.
189 $message = _('You have not authorized any applications to use your account.');
191 $this->elementStart('div', 'guide');
192 $this->raw(common_markup_to_html($message));
193 $this->elementEnd('div');
196 function showSections()
198 $cur = common_current_user();
200 $this->elementStart('div', array('id' => 'developer-help', 'class' => 'section'));
202 $this->element('h2', null, 'Developers');
203 $this->elementStart('p');
206 // TRANS: Note for developers in the OAuth connection settings form.
207 // TRANS: This message contains a Markdown link. Do not separate "](".
208 // TRANS: %s is the URL to the OAuth settings.
209 _('Are you a developer? [Register an OAuth client application](%s) to use with this instance of StatusNet.'),
210 common_local_url('oauthappssettings')
213 $output = common_markup_to_html($devMsg);
216 $this->elementEnd('p');
218 $this->elementEnd('section');