3 * Let the user authorize a remote subscription request
9 * @author Evan Prodromou <evan@status.net>
10 * @author Robin Millette <millette@status.net>
11 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
12 * @link http://status.net/
14 * StatusNet - the distributed open-source microblogging tool
15 * Copyright (C) 2008-2011, StatusNet, Inc.
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU Affero General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Affero General Public License for more details.
27 * You should have received a copy of the GNU Affero General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
33 require_once dirname(__FILE__) . '/../lib/omb.php';
34 require_once dirname(__FILE__) . '/../extlib/libomb/service_provider.php';
35 require_once dirname(__FILE__) . '/../extlib/libomb/profile.php';
36 define('TIMESTAMP_THRESHOLD', 300);
38 // @todo FIXME: Missing documentation.
39 class UserauthorizationAction extends Action
44 function handle($args)
46 parent::handle($args);
48 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
49 /* Use a session token for CSRF protection. */
50 $token = $this->trimmed('token');
51 if (!$token || $token != common_session_token()) {
52 $srv = $this->getStoredParams();
53 // TRANS: Client error displayed when the session token does not match or is not given.
54 $this->showForm($srv->getRemoteUser(), _('There was a problem ' .
55 'with your session token. Try again, ' .
59 /* We've shown the form, now post user's choice. */
60 $this->sendAuthorization();
62 if (!common_logged_in()) {
63 /* Go log in, and then come back. */
64 common_set_returnto($_SERVER['REQUEST_URI']);
66 common_redirect(common_local_url('login'));
70 $user = common_current_user();
71 $profile = $user->getProfile();
73 common_log_db_error($user, 'SELECT', __FILE__);
74 // TRANS: Error message displayed when referring to a user without a profile.
75 $this->serverError(_('User has no profile.'));
79 /* TODO: If no token is passed the user should get a prompt to enter
80 it according to OAuth Core 1.0. */
83 $srv = new OMB_Service_Provider(
84 profile_to_omb_profile($user->uri, $profile),
85 omb_oauth_datastore());
87 $remote_user = $srv->handleUserAuth();
88 } catch (Exception $e) {
90 $this->clientError($e->getMessage());
94 $this->storeParams($srv);
95 $this->showForm($remote_user);
99 function showForm($params, $error=null)
101 $this->params = $params;
102 $this->error = $error;
108 // TRANS: Page title.
109 return _('Authorize subscription');
112 function showPageNotice()
114 // TRANS: Page notice on "Authorize subscription" page.
115 $this->element('p', null, _('Please check these details to make sure '.
116 'that you want to subscribe to this ' .
117 'user’s notices. If you didn’t just ask ' .
118 'to subscribe to someone’s notices, '.
122 function showContent()
124 $params = $this->params;
126 $nickname = $params->getNickname();
127 $profile = $params->getProfileURL();
128 $license = $params->getLicenseURL();
129 $fullname = $params->getFullname();
130 $homepage = $params->getHomepage();
131 $bio = $params->getBio();
132 $location = $params->getLocation();
133 $avatar = $params->getAvatarURL();
135 $this->elementStart('div', 'entity_profile vcard');
138 $this->element('img', array('src' => $avatar,
139 'class' => 'photo avatar entity_depiction',
140 'width' => AVATAR_PROFILE_SIZE,
141 'height' => AVATAR_PROFILE_SIZE,
142 'alt' => $nickname));
145 // TRANS: Label for nickname on user authorisation page.
146 $this->element('div', 'entity_nickname', _('Nickname'));
148 $hasFN = ($fullname !== '') ? 'nickname' : 'fn nickname';
150 // XXX: why are these raw() instead of escaped...?
152 $this->elementStart('a', array('href' => $profile,
153 'class' => 'url '.$hasFN));
154 $this->raw($nickname);
155 $this->elementEnd('a');
157 if (!is_null($fullname)) {
158 $this->elementStart('div', 'fn entity_fn');
159 $this->raw($fullname);
160 $this->elementEnd('div');
163 if (!is_null($location)) {
164 $this->elementStart('div', 'label entity_location');
165 $this->raw($location);
168 if (!is_null($homepage)) {
169 $this->elementStart('a', array('href' => $homepage,
170 'class' => 'url entity_url'));
171 $this->raw($homepage);
172 $this->elementEnd('a');
175 if (!is_null($bio)) {
176 $this->elementStart('div', 'note entity_note');
178 $this->elementEnd('dd');
181 if (!is_null($license)) {
182 $this->element('a', array('href' => $license,
183 'class' => 'license entity_license'),
187 $this->elementEnd('div');
189 $this->elementStart('div', 'entity_actions');
190 $this->elementStart('ul');
191 $this->elementStart('li', 'entity_subscribe');
192 $this->elementStart('form', array('method' => 'post',
193 'id' => 'userauthorization',
194 'class' => 'form_user_authorization',
195 'name' => 'userauthorization',
196 'action' => common_local_url(
197 'userauthorization')));
198 $this->hidden('token', common_session_token());
200 $this->submit('accept',
201 // TRANS: Button text on Authorise Subscription page.
202 _m('BUTTON','Accept'), 'submit accept', null,
203 // TRANS: Title for button on Authorise Subscription page.
204 _('Subscribe to this user.'));
205 $this->submit('reject',
206 // TRANS: Button text on Authorise Subscription page.
207 _m('BUTTON','Reject'), 'submit reject', null,
208 // TRANS: Title for button on Authorise Subscription page.
209 _('Reject this subscription.'));
210 $this->elementEnd('form');
211 $this->elementEnd('li');
212 $this->elementEnd('ul');
213 $this->elementEnd('div');
216 function sendAuthorization()
218 $srv = $this->getStoredParams();
221 // TRANS: Client error displayed for an empty authorisation request.
222 $this->clientError(_('No authorization request!'));
226 $accepted = $this->arg('accept');
228 list($val, $token) = $srv->continueUserAuth($accepted);
229 } catch (Exception $e) {
230 $this->clientError($e->getMessage());
233 if ($val !== false) {
234 common_redirect($val, 303);
235 } elseif ($accepted) {
236 $this->showAcceptMessage($token);
238 $this->showRejectMessage();
242 function showAcceptMessage($tok)
244 // TRANS: Accept message header from Authorise subscription page.
245 common_show_header(_('Subscription authorized'));
246 $this->element('p', null,
247 // TRANS: Accept message text from Authorise subscription page.
248 _('The subscription has been authorized, but no '.
249 'callback URL was passed. Check with the site\'s ' .
250 'instructions for details on how to authorize the ' .
251 'subscription. Your subscription token is:'));
252 $this->element('blockquote', 'token', $tok);
253 common_show_footer();
256 function showRejectMessage()
258 // TRANS: Reject message header from Authorise subscription page.
259 common_show_header(_('Subscription rejected'));
260 $this->element('p', null,
261 // TRANS: Reject message from Authorise subscription page.
262 _('The subscription has been rejected, but no '.
263 'callback URL was passed. Check with the site\'s ' .
264 'instructions for details on how to fully reject ' .
265 'the subscription.'));
266 common_show_footer();
269 function storeParams($params)
271 common_ensure_session();
272 $_SESSION['userauthorizationparams'] = serialize($params);
275 function clearParams()
277 common_ensure_session();
278 unset($_SESSION['userauthorizationparams']);
281 function getStoredParams()
283 common_ensure_session();
284 $params = unserialize($_SESSION['userauthorizationparams']);
288 function validateOmb()
290 $listener = $_GET['omb_listener'];
291 $listenee = $_GET['omb_listenee'];
292 $nickname = $_GET['omb_listenee_nickname'];
293 $profile = $_GET['omb_listenee_profile'];
295 $user = User::staticGet('uri', $listener);
297 // TRANS: Exception thrown when no valid user is found for an authorisation request.
298 // TRANS: %s is a listener URI.
299 throw new Exception(sprintf(_('Listener URI "%s" not found here.'),
303 if (strlen($listenee) > 255) {
304 // TRANS: Exception thrown when listenee URI is too long for an authorisation request.
305 // TRANS: %s is a listenee URI.
306 throw new Exception(sprintf(_('Listenee URI "%s" is too long.'),
310 $other = User::staticGet('uri', $listenee);
312 // TRANS: Exception thrown when listenee URI is a local user for an authorisation request.
313 // TRANS: %s is a listenee URI.
314 throw new Exception(sprintf(_('Listenee URI "%s" is a local user.'),
318 $remote = Remote_profile::staticGet('uri', $listenee);
320 $sub = new Subscription();
321 $sub->subscriber = $user->id;
322 $sub->subscribed = $remote->id;
323 if ($sub->find(true)) {
324 // TRANS: Exception thrown when already subscribed.
325 throw new Exception('You are already subscribed to this user.');
329 if ($profile == common_profile_url($nickname)) {
330 // TRANS: Exception thrown when profile URL is a local user for an authorisation request.
331 // TRANS: %s is a profile URL.
332 throw new Exception(sprintf(_('Profile URL "%s" is for a local user.'),
337 $license = $_GET['omb_listenee_license'];
338 $site_license = common_config('license', 'url');
339 if (!common_compatible_license($license, $site_license)) {
340 // TRANS: Exception thrown when licenses are not compatible for an authorisation request.
341 // TRANS: %1$s is the license for the listenee, %2$s is the license for "this" StatusNet site.
342 throw new Exception(sprintf(_('Listenee stream license "%1$s" is not ' .
343 'compatible with site license "%2$s".'),
344 $license, $site_license));
347 $avatar = $_GET['omb_listenee_avatar'];
349 if (!common_valid_http_url($avatar) || strlen($avatar) > 255) {
350 // TRANS: Exception thrown when avatar URL is invalid for an authorisation request.
351 // TRANS: %s is an avatar URL.
352 throw new Exception(sprintf(_('Avatar URL "%s" is not valid.'),
355 $size = @getimagesize($avatar);
357 // TRANS: Exception thrown when avatar URL could not be read for an authorisation request.
358 // TRANS: %s is an avatar URL.
359 throw new Exception(sprintf(_('Cannot read avatar URL "%s".'),
362 if (!in_array($size[2], array(IMAGETYPE_GIF, IMAGETYPE_JPEG,
364 // TRANS: Exception thrown when avatar URL return an invalid image type for an authorisation request.
365 // TRANS: %s is an avatar URL.
366 throw new Exception(sprintf(_('Wrong image type for avatar URL '.