3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('LACONICA')) { exit(1); }
22 require_once(INSTALLDIR.'/lib/openid.php');
24 class FinishopenidloginAction extends Action {
26 function handle($args) {
27 parent::handle($args);
28 if (common_logged_in()) {
29 common_user_error(_t('Already logged in.'));
30 } else if ($_SERVER['REQUEST_METHOD'] == 'POST') {
31 if ($this->arg('create')) {
32 $this->create_new_user();
33 } else if ($this->arg('connect')) {
34 $this->connect_user();
36 common_debug(print_r($this->args, true), __FILE__);
37 $this->show_form(_t('Something weird happened.'),
38 $this->trimmed('newname'));
45 function show_form($error=NULL, $username=NULL) {
46 common_show_header(_t('OpenID Account Setup'));
48 common_element('div', array('class' => 'error'), $error);
51 common_element('div', 'instructions',
52 _t('This is the first time you\'ve logged into ') .
53 $config['site']['name'] .
54 _t(' so we must connect your OpenID to a local account. ' .
55 ' You can either create a new account, or connect with ' .
56 ' your existing account, if you have one.'));
58 common_element_start('form', array('method' => 'POST',
59 'id' => 'account_connect',
60 'action' => common_local_url('finishopenidlogin')));
61 common_element('h2', NULL,
62 'Create new account');
63 common_element('p', NULL,
64 _t('Create a new user with this nickname.'));
65 common_input('newname', _t('New nickname'),
66 ($username) ? $username : '',
67 _t('1-64 lowercase letters or numbers, no punctuation or spaces'));
68 common_submit('create', _t('Create'));
69 common_element('h2', NULL,
70 'Connect existing account');
71 common_element('p', NULL,
72 _t('If you already have an account, login with your username and password '.
73 'to connect it to your OpenID.'));
74 common_input('nickname', _t('Existing nickname'));
75 common_password('password', _t('Password'));
76 common_submit('connect', _t('Connect'));
77 common_element_end('form');
81 function try_login() {
83 $consumer = oid_consumer();
85 $response = $consumer->complete(common_local_url('finishopenidlogin'));
87 if ($response->status == Auth_OpenID_CANCEL) {
88 $this->message(_t('OpenID authentication cancelled.'));
90 } else if ($response->status == Auth_OpenID_FAILURE) {
91 // Authentication failed; display the error message.
92 $this->message(_t('OpenID authentication failed: ') . $response->message);
93 } else if ($response->status == Auth_OpenID_SUCCESS) {
94 // This means the authentication succeeded; extract the
95 // identity URL and Simple Registration data (if it was
97 $display = $response->getDisplayIdentifier();
98 $canonical = ($response->endpoint->canonicalID) ?
99 $response->endpoint->canonicalID : $response->getDisplayIdentifier();
101 $sreg_resp = Auth_OpenID_SRegResponse::fromSuccessResponse($response);
104 $sreg = $sreg_resp->contents();
107 $user = $this->get_user($canonical);
110 $this->update_user($user, $sreg);
111 common_set_user($user->nickname);
112 $this->go_home($user->nickname);
114 $this->save_values($display, $canonical, $sreg);
115 $this->show_form(NULL, $this->best_new_nickname($display, $sreg));
120 function message($msg) {
121 common_show_header(_t('OpenID Login'));
122 common_element('p', NULL, $msg);
123 common_show_footer();
126 function get_user($canonical) {
128 $oid = User_openid::staticGet('canonical', $canonical);
130 $user = User::staticGet('id', $oid->user_id);
135 function update_user($user, $sreg) {
137 $profile = $user->getProfile();
139 $orig_profile = clone($profile);
141 if ($sreg['fullname'] && strlen($sreg['fullname']) <= 255) {
142 $profile->fullname = $sreg['fullname'];
145 if ($sreg['country']) {
146 if ($sreg['postcode']) {
147 # XXX: use postcode to get city and region
148 # XXX: also, store postcode somewhere -- it's valuable!
149 $profile->location = $sreg['postcode'] . ', ' . $sreg['country'];
151 $profile->location = $sreg['country'];
155 # XXX save language if it's passed
156 # XXX save timezone if it's passed
158 if (!$profile->update($orig_profile)) {
159 common_server_error(_t('Error saving the profile.'));
163 $orig_user = clone($user);
165 if ($sreg['email'] && Validate::email($sreg['email'], true)) {
166 $user->email = $sreg['email'];
169 if (!$user->update($orig_user)) {
170 common_server_error(_t('Error saving the user.'));
175 function save_values($display, $canonical, $sreg) {
176 common_ensure_session();
177 $_SESSION['openid_display'] = $display;
178 $_SESSION['openid_canonical'] = $canonical;
179 $_SESSION['openid_sreg'] = $sreg;
182 function get_saved_values() {
183 return array($_SESSION['openid_display'],
184 $_SESSION['openid_canonical'],
185 $_SESSION['openid_sreg']);
188 function create_new_user() {
190 $nickname = $this->trimmed('newname');
192 if (!Validate::string($nickname, array('min_length' => 1,
194 'format' => VALIDATE_NUM . VALIDATE_ALPHA_LOWER))) {
195 $this->show_form(_t('Nickname must have only letters and numbers and no spaces.'));
199 if (User::staticGet('nickname', $nickname)) {
200 $this->show_form(_t('Nickname already in use. Try another one.'));
204 list($display, $canonical, $sreg) = $this->get_saved_values();
206 if (!$display || !$canonical) {
207 common_server_error(_t('Stored OpenID not found.'));
211 # Possible race condition... let's be paranoid
213 $other = $this->get_user($canonical);
216 common_server_error(_t('Creating new account for OpenID that already has a user.'));
220 $profile = new Profile();
222 $profile->nickname = $nickname;
224 if ($sreg['fullname'] && strlen($sreg['fullname']) <= 255) {
225 $profile->fullname = $sreg['fullname'];
228 if ($sreg['country']) {
229 if ($sreg['postcode']) {
230 # XXX: use postcode to get city and region
231 # XXX: also, store postcode somewhere -- it's valuable!
232 $profile->location = $sreg['postcode'] . ', ' . $sreg['country'];
234 $profile->location = $sreg['country'];
238 # XXX save language if it's passed
239 # XXX save timezone if it's passed
241 $profile->created = DB_DataObject_Cast::dateTime(); # current time
243 $id = $profile->insert();
245 common_server_error(_t('Error saving the profile.'));
251 $user->nickname = $nickname;
252 $user->uri = common_mint_tag('user:'.$id);
254 if ($sreg['email'] && Validate::email($sreg['email'], true)) {
255 $user->email = $sreg['email'];
258 $user->created = DB_DataObject_Cast::dateTime(); # current time
260 $result = $user->insert();
267 $oid = new User_openid();
268 $oid->display = $display;
269 $oid->canonical = $canonical;
271 $oid->created = DB_DataObject_Cast::dateTime();
273 $result = $oid->insert();
281 common_set_user($user->nickname);
282 common_redirect(common_local_url('profilesettings'));
285 function connect_user() {
287 $nickname = $this->trimmed('nickname');
288 $password = $this->trimmed('password');
290 if (!common_check_user($nickname, $password)) {
291 $this->show_form(_t('Invalid username or password.'));
297 $user = User::staticGet('nickname', $nickname);
299 list($display, $canonical, $sreg) = $this->get_saved_values();
301 if (!$display || !$canonical) {
302 common_server_error(_t('Stored OpenID not found.'));
306 $oid = new User_openid();
307 $oid->display = $display;
308 $oid->canonical = $canonical;
309 $oid->user_id = $user->id;
310 $oid->created = DB_DataObject_Cast::dateTime();
312 if (!$oid->insert()) {
313 common_server_error(_t('Error connecting OpenID.'));
317 $this->update_user($user, $sreg);
318 common_set_user($user->nickname);
319 $this->go_home($user->nickname);
322 function go_home($nickname) {
323 $url = common_get_returnto();
325 # We don't have to return to it again
326 common_set_returnto(NULL);
328 $url = common_local_url('all',
332 common_redirect($url);
335 function best_new_nickname($display, $sreg) {
337 # Try the passed-in nickname
340 if ($sreg['nickname']) {
341 $nickname = $this->nicknamize($sreg['nickname']);
342 if ($this->is_new_nickname($nickname)) {
349 if ($sreg['fullname']) {
350 $fullname = $this->nicknamize($sreg['fullname']);
351 if ($this->is_new_nickname($fullname)) {
358 $from_url = $this->openid_to_nickname($display);
360 if ($from_url && $this->is_new_nickname($from_url)) {
369 function is_new_nickname($str) {
370 if (!Validate::string($str, array('min_length' => 1,
372 'format' => VALIDATE_NUM . VALIDATE_ALPHA_LOWER))) {
375 if (User::staticGet('nickname', $str)) {
381 function openid_to_nickname($openid) {
382 if (Auth_Yadis_identifierScheme($openid) == 'XRI') {
383 return $this->xri_to_nickname($openid);
385 return $this->url_to_nickname($openid);
389 # We try to use an OpenID URL as a legal Laconica user name in this order
390 # 1. Plain hostname, like http://evanp.myopenid.com/
391 # 2. One element in path, like http://profile.typekey.com/EvanProdromou/
392 # or http://getopenid.com/evanprodromou
394 function url_to_nickname($openid) {
395 static $bad = array('query', 'user', 'password', 'port', 'fragment');
397 $parts = parse_url($openid);
399 # If any of these parts exist, this won't work
401 foreach ($bad as $badpart) {
402 if (array_key_exists($badpart, $parts)) {
407 # We just have host and/or path
409 # If it's just a host...
410 if (array_key_exists('host', $parts) &&
411 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
413 $hostparts = explode('.', $parts['host']);
415 # Try to catch common idiom of nickname.service.tld
417 if ((count($hostparts) > 2) &&
418 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
419 (strcmp($hostparts[0], 'www') != 0))
421 return $this->nicknamize($hostparts[0]);
423 # Do the whole hostname
424 return $this->nicknamize($parts['host']);
427 if (array_key_exists('path', $parts)) {
428 # Strip starting, ending slashes
429 $path = preg_replace('@/$@', '', $parts['path']);
430 $path = preg_replace('@^/@', '', $path);
431 if (strpos($path, '/') === false) {
432 return $this->nicknamize($path);
440 function xri_to_nickname($xri) {
441 $base = $this->xri_base($xri);
447 # or @gratis*evan.prodromou
448 $parts = explode('*', substr($base, 1));
449 return $this->nicknamize(array_pop($parts));
453 function xri_base($xri) {
454 if (substr($xri, 0, 6) == 'xri://') {
455 return substr($xri, 6);
461 # Given a string, try to make it work as a nickname
463 function nicknamize($str) {
464 $str = preg_replace('/\W/', '', $str);
465 return strtolower($str);