]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/openid.php
Help OpenID module make its little form
[quix0rs-gnu-social.git] / lib / openid.php
1 <?php
2 /*
3  * Laconica - a distributed open-source microblogging tool
4  * Copyright (C) 2008, Controlez-Vous, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 if (!defined('LACONICA')) { exit(1); }
21
22 require_once(INSTALLDIR.'/classes/User_openid.php');
23
24 require_once('Auth/OpenID.php');
25 require_once('Auth/OpenID/Consumer.php');
26 require_once('Auth/OpenID/SReg.php');
27 require_once('Auth/OpenID/MySQLStore.php');
28
29 # About one year cookie expiry
30
31 define('OPENID_COOKIE_EXPIRY', round(365.25 * 24 * 60 * 60));
32 define('OPENID_COOKIE_KEY', 'lastusedopenid');
33
34 function oid_store()
35 {
36     static $store = null;
37     if (!$store) {
38         # Can't be called statically
39         $user = new User();
40         $conn = $user->getDatabaseConnection();
41         $store = new Auth_OpenID_MySQLStore($conn);
42     }
43     return $store;
44 }
45
46 function oid_consumer()
47 {
48     $store = oid_store();
49     $consumer = new Auth_OpenID_Consumer($store);
50     return $consumer;
51 }
52
53 function oid_clear_last()
54 {
55     oid_set_last('');
56 }
57
58 function oid_set_last($openid_url)
59 {
60     common_set_cookie(OPENID_COOKIE_KEY,
61                      $openid_url,
62                      time() + OPENID_COOKIE_EXPIRY);
63 }
64
65 function oid_get_last()
66 {
67     $openid_url = $_COOKIE[OPENID_COOKIE_KEY];
68     if ($openid_url && strlen($openid_url) > 0) {
69         return $openid_url;
70     } else {
71         return null;
72     }
73 }
74
75 function oid_link_user($id, $canonical, $display)
76 {
77
78     $oid = new User_openid();
79     $oid->user_id = $id;
80     $oid->canonical = $canonical;
81     $oid->display = $display;
82     $oid->created = DB_DataObject_Cast::dateTime();
83
84     if (!$oid->insert()) {
85         $err = PEAR::getStaticProperty('DB_DataObject','lastError');
86         common_debug('DB error ' . $err->code . ': ' . $err->message, __FILE__);
87         return false;
88     }
89
90     return true;
91 }
92
93 function oid_get_user($openid_url)
94 {
95     $user = null;
96     $oid = User_openid::staticGet('canonical', $openid_url);
97     if ($oid) {
98         $user = User::staticGet('id', $oid->user_id);
99     }
100     return $user;
101 }
102
103 function oid_check_immediate($openid_url, $backto=null)
104 {
105     if (!$backto) {
106         $action = $_REQUEST['action'];
107         $args = common_copy_args($_GET);
108         unset($args['action']);
109         $backto = common_local_url($action, $args);
110     }
111     common_debug('going back to "' . $backto . '"', __FILE__);
112
113     common_ensure_session();
114
115     $_SESSION['openid_immediate_backto'] = $backto;
116     common_debug('passed-in variable is "' . $backto . '"', __FILE__);
117     common_debug('session variable is "' . $_SESSION['openid_immediate_backto'] . '"', __FILE__);
118
119     oid_authenticate($openid_url,
120                      'finishimmediate',
121                      true);
122 }
123
124 function oid_authenticate($openid_url, $returnto, $immediate=false)
125 {
126
127     $consumer = oid_consumer();
128
129     if (!$consumer) {
130         common_server_error(_('Cannot instantiate OpenID consumer object.'));
131         return false;
132     }
133
134     common_ensure_session();
135
136     $auth_request = $consumer->begin($openid_url);
137
138     // Handle failure status return values.
139     if (!$auth_request) {
140         return _('Not a valid OpenID.');
141     } else if (Auth_OpenID::isFailure($auth_request)) {
142         return sprintf(_('OpenID failure: %s'), $auth_request->message);
143     }
144
145     $sreg_request = Auth_OpenID_SRegRequest::build(// Required
146                                                    array(),
147                                                    // Optional
148                                                    array('nickname',
149                                                          'email',
150                                                          'fullname',
151                                                          'language',
152                                                          'timezone',
153                                                          'postcode',
154                                                          'country'));
155
156     if ($sreg_request) {
157         $auth_request->addExtension($sreg_request);
158     }
159
160     $trust_root = common_local_url('public');
161     $process_url = common_local_url($returnto);
162
163     if ($auth_request->shouldSendRedirect()) {
164         $redirect_url = $auth_request->redirectURL($trust_root,
165                                                    $process_url,
166                                                    $immediate);
167         if (!$redirect_url) {
168         } else if (Auth_OpenID::isFailure($redirect_url)) {
169             return sprintf(_('Could not redirect to server: %s'), $redirect_url->message);
170         } else {
171             common_redirect($redirect_url);
172         }
173     } else {
174         // Generate form markup and render it.
175         $form_id = 'openid_message';
176         $form_html = $auth_request->formMarkup($trust_root, $process_url,
177                                                $immediate, array('id' => $form_id));
178
179         # XXX: This is cheap, but things choke if we don't escape ampersands
180         # in the HTML attributes
181
182         $form_html = preg_replace('/&/', '&amp;', $form_html);
183
184         // Display an error if the form markup couldn't be generated;
185         // otherwise, render the HTML.
186         if (Auth_OpenID::isFailure($form_html)) {
187             common_server_error(sprintf(_('Could not create OpenID form: %s'), $form_html->message));
188         } else {
189             $action = new AutosubmitAction(); // see below
190             $action->form_html = $form_html;
191             $action->form_id = $form_id;
192             $action->prepare(array('action' => 'autosubmit'));
193             $action->handle(array('action' => 'autosubmit'));
194         }
195     }
196 }
197
198 # Half-assed attempt at a module-private function
199
200 function _oid_print_instructions()
201 {
202     common_element('div', 'instructions',
203                    _('This form should automatically submit itself. '.
204                       'If not, click the submit button to go to your '.
205                       'OpenID provider.'));
206 }
207
208 # update a user from sreg parameters
209
210 function oid_update_user(&$user, &$sreg)
211 {
212
213     $profile = $user->getProfile();
214
215     $orig_profile = clone($profile);
216
217     if ($sreg['fullname'] && strlen($sreg['fullname']) <= 255) {
218         $profile->fullname = $sreg['fullname'];
219     }
220
221     if ($sreg['country']) {
222         if ($sreg['postcode']) {
223             # XXX: use postcode to get city and region
224             # XXX: also, store postcode somewhere -- it's valuable!
225             $profile->location = $sreg['postcode'] . ', ' . $sreg['country'];
226         } else {
227             $profile->location = $sreg['country'];
228         }
229     }
230
231     # XXX save language if it's passed
232     # XXX save timezone if it's passed
233
234     if (!$profile->update($orig_profile)) {
235         common_server_error(_('Error saving the profile.'));
236         return false;
237     }
238
239     $orig_user = clone($user);
240
241     if ($sreg['email'] && Validate::email($sreg['email'], true)) {
242         $user->email = $sreg['email'];
243     }
244
245     if (!$user->update($orig_user)) {
246         common_server_error(_('Error saving the user.'));
247         return false;
248     }
249
250     return true;
251 }
252
253 class AutosubmitAction extends Action
254 {
255     var $form_html = null;
256     var $form_id = null;
257
258     function handle($args)
259     {
260         parent::handle($args);
261         $this->showPage();
262     }
263
264     function title()
265     {
266         return _('OpenID Auto-Submit');
267     }
268
269     function showContent()
270     {
271         $this->raw($this->form_html);
272         $this->element('script', null,
273                        '$(document).ready(function() { ' .
274                        '    $(\'#'. $this->form_id .'\').submit(); '.
275                        '});');
276     }
277 }