Commit | Line | Data |
---|---|---|
bb0727ea VZ |
1 | <?php |
2 | /*************************************************************************** | |
9f5bd98e | 3 | * Copyright (C) 2003-2010 Polytechnique.org * |
bb0727ea VZ |
4 | * http://opensource.polytechnique.org/ * |
5 | * * | |
6 | * This program is free software; you can redistribute it and/or modify * | |
7 | * it under the terms of the GNU General Public License as published by * | |
8 | * the Free Software Foundation; either version 2 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 General Public License for more details. * | |
15 | * * | |
16 | * You should have received a copy of the GNU General Public License * | |
17 | * along with this program; if not, write to the Free Software * | |
18 | * Foundation, Inc., * | |
19 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * | |
20 | ***************************************************************************/ | |
21 | ||
f5c4bf30 | 22 | // Post-processes the successful Google Apps account creation queue job. |
bb0727ea VZ |
23 | function post_queue_u_create($job) { |
24 | global $globals; | |
25 | ||
1bf36cd1 | 26 | // Retrieves the user parameters (GoogleApps username and uid). |
bb0727ea | 27 | $parameters = json_decode($job['j_parameters'], true); |
d56cb887 VZ |
28 | $username = isset($parameters['username']) ? $parameters['username'] : null; |
29 | if (!($user = User::getSilent($username))) { | |
bb0727ea VZ |
30 | return; |
31 | } | |
32 | ||
f5c4bf30 VZ |
33 | // Adds a redirection to the Google Apps delivery address, if requested by |
34 | // the user at creation time. | |
d56cb887 | 35 | $account = new GoogleAppsAccount($user); |
bb0727ea VZ |
36 | if ($account->activate_mail_redirection) { |
37 | require_once('emails.inc.php'); | |
12a587df | 38 | $storage = new EmailStorage($user, 'googleapps'); |
94c6c788 | 39 | $storage->activate(); |
bb0727ea VZ |
40 | } |
41 | ||
f5c4bf30 | 42 | // Sends the 'account created' email to the user, with basic documentation. |
bb0727ea VZ |
43 | $mailer = new PlMailer('googleapps/create.mail.tpl'); |
44 | $mailer->assign('account', $account); | |
d56cb887 | 45 | $mailer->assign('email', $user->bestEmail()); |
bb0727ea | 46 | $mailer->assign('googleapps_domain', $globals->mailstorage->googleapps_domain); |
35accc05 FB |
47 | $mailer->assign('prenom', $user->displayName()); |
48 | $mailer->assign('sexe', $user->isFemale()); | |
bb0727ea VZ |
49 | $mailer->send(); |
50 | } | |
51 | ||
f5c4bf30 | 52 | // Post-processes the successful Google Apps account update queue job. |
bb0727ea VZ |
53 | function post_queue_u_update($job) { |
54 | global $globals; | |
55 | ||
56 | // If the u_update job was an unsuspend request, re-adds the redirection | |
57 | // to the Google Apps delivery address, provided the account is active (it might | |
58 | // have been deleted between the unsuspension and the post-queue processing). | |
59 | $parameters = json_decode($job['j_parameters'], true); | |
d56cb887 VZ |
60 | $username = isset($parameters['username']) ? $parameters['username'] : null; |
61 | if (!($user = User::getSilent($username))) { | |
bb0727ea VZ |
62 | return; |
63 | } | |
64 | ||
65 | if (isset($parameters['suspended']) && $parameters['suspended'] == false) { | |
66 | require_once('emails.inc.php'); | |
d56cb887 | 67 | $account = new GoogleAppsAccount($user); |
f5c4bf30 | 68 | if ($account->active()) { |
bb0727ea VZ |
69 | // Re-adds the email redirection (if the user did request it). |
70 | if ($account->activate_mail_redirection) { | |
12a587df | 71 | $storage = new EmailStorage($user, 'googleapps'); |
94c6c788 | 72 | $storage->activate(); |
bb0727ea VZ |
73 | } |
74 | ||
75 | // Sends an email to the account owner. | |
bb0727ea VZ |
76 | $mailer = new PlMailer('googleapps/unsuspend.mail.tpl'); |
77 | $mailer->assign('account', $account); | |
d56cb887 | 78 | $mailer->assign('email', $user->bestEmail()); |
35accc05 FB |
79 | $mailer->assign('prenom', $user->displayName()); |
80 | $mailer->assign('sexe', $user->isFemale()); | |
bb0727ea VZ |
81 | $mailer->send(); |
82 | } | |
83 | } | |
84 | } | |
85 | ||
86 | // Reprensentation of an SQL-stored Google Apps account. | |
f5c4bf30 VZ |
87 | // This class is the interface with the gappsd SQL tables: gappsd is the python |
88 | // daemon which deals with Google Apps provisioning APIs. | |
89 | // TODO(vincent.zanotti): add the url of gappsd, when available. | |
bb0727ea VZ |
90 | class GoogleAppsAccount |
91 | { | |
90c614cd | 92 | // User identification: user id, and hruid. |
d56cb887 | 93 | private $user; |
bb0727ea VZ |
94 | public $g_account_name; |
95 | ||
f5c4bf30 | 96 | // Local account parameters. |
bb0727ea VZ |
97 | public $sync_password; |
98 | public $activate_mail_redirection; | |
f5c4bf30 VZ |
99 | |
100 | // Account status, obtained from Google Apps provisioning & reporting APIs. | |
0089e594 | 101 | public $g_account_id; |
bb0727ea VZ |
102 | public $g_status; |
103 | public $g_suspension; | |
104 | public $r_disk_usage; | |
105 | public $r_creation; | |
106 | public $r_last_login; | |
107 | public $r_last_webmail; | |
108 | public $reporting_date; | |
109 | ||
0536df80 VZ |
110 | // Nicknames (aliases) registered for that user, lazily loaded. |
111 | public $nicknames; | |
112 | ||
f5c4bf30 | 113 | // Pending requests in the gappsd job queue (cf. top note). |
bb0727ea VZ |
114 | public $pending_create; |
115 | public $pending_delete; | |
116 | public $pending_update; | |
117 | public $pending_update_admin; | |
118 | public $pending_update_other; | |
119 | public $pending_update_password; | |
120 | public $pending_update_suspension; | |
121 | ||
f5c4bf30 | 122 | // Pending requests in plat/al validation queue. |
bb0727ea VZ |
123 | public $pending_validation_unsuspend; |
124 | ||
f5c4bf30 VZ |
125 | // Constructs the account object, by retrieving all informations from the |
126 | // GApps account table, from GApps job queue, and from plat/al validation queue. | |
d56cb887 | 127 | public function __construct(User &$user) |
bb0727ea | 128 | { |
d56cb887 VZ |
129 | $this->user = &$user; |
130 | if (!$this->user || !$this->user->login()) { | |
131 | return; | |
f5c4bf30 VZ |
132 | } |
133 | ||
d56cb887 VZ |
134 | // TODO: switch to multi-domain Google Apps, and use $this->user->forlifeEmail() |
135 | // as Google Apps idenfiant (requires changes in gappsd). | |
136 | $this->g_account_name = $this->user->login(); | |
bb0727ea VZ |
137 | $this->g_status = NULL; |
138 | ||
139 | $res = XDB::query( | |
140 | "SELECT l_sync_password, l_activate_mail_redirection, | |
0089e594 | 141 | g_account_name, g_account_id, g_status, g_suspension, r_disk_usage, |
bb0727ea VZ |
142 | UNIX_TIMESTAMP(r_creation) as r_creation, |
143 | UNIX_TIMESTAMP(r_last_login) as r_last_login, | |
144 | UNIX_TIMESTAMP(r_last_webmail) as r_last_webmail | |
145 | FROM gapps_accounts | |
d56cb887 | 146 | WHERE g_account_name = {?}", $this->g_account_name); |
bb0727ea VZ |
147 | if ($account = $res->fetchOneAssoc()) { |
148 | $this->sync_password = $account['l_sync_password']; | |
149 | $this->activate_mail_redirection = $account['l_activate_mail_redirection']; | |
0089e594 | 150 | $this->g_account_id = $account['g_account_id']; |
bb0727ea VZ |
151 | $this->g_status = $account['g_status']; |
152 | $this->g_suspension = $account['g_suspension']; | |
153 | $this->r_disk_usage = $account['r_disk_usage']; | |
154 | $this->r_creation = $account['r_creation']; | |
155 | $this->r_last_login = $account['r_last_webmail']; | |
156 | $this->r_last_webmail = $account['r_last_webmail']; | |
157 | ||
158 | $this->load_pending_counts(); | |
159 | $this->load_pending_validations(); | |
160 | if ($this->pending_update) { | |
161 | $this->load_pending_updates(); | |
162 | } | |
163 | ||
164 | $res = XDB::query("SELECT MAX(date) FROM gapps_reporting"); | |
165 | $this->reporting_date = $res->fetchOneCell(); | |
166 | } | |
167 | } | |
168 | ||
f5c4bf30 VZ |
169 | // Determines if changes to the Google Account are currently waiting in the |
170 | // GApps job queue, and initializes the local values accordingly. | |
bb0727ea VZ |
171 | private function load_pending_counts() |
172 | { | |
bb0727ea VZ |
173 | $res = XDB::query( |
174 | "SELECT SUM(j_type = 'u_create') AS pending_create, | |
175 | SUM(j_type = 'u_update') AS pending_update, | |
176 | SUM(j_type = 'u_delete') AS pending_delete | |
177 | FROM gapps_queue | |
178 | WHERE q_recipient_id = {?} AND | |
179 | p_status IN ('idle', 'active', 'softfail') | |
d56cb887 | 180 | GROUP BY j_type", $this->user->id()); |
bb0727ea VZ |
181 | $pending = $res->fetchOneAssoc(); |
182 | $this->pending_create = $pending['pending_create']; | |
183 | $this->pending_update = $pending['pending_update']; | |
184 | $this->pending_delete = $pending['pending_delete']; | |
185 | ||
186 | $this->pending_update_admin = false; | |
187 | $this->pending_update_other = false; | |
188 | $this->pending_update_password = false; | |
189 | $this->pending_update_suspension = false; | |
190 | } | |
191 | ||
f5c4bf30 VZ |
192 | // Checks for unsuspend requests waiting for validation in plat/al |
193 | // validation queue. | |
bb0727ea VZ |
194 | private function load_pending_validations() |
195 | { | |
bb0727ea | 196 | $this->pending_validation_unsuspend = |
d56cb887 | 197 | Validate::get_typed_requests_count($this->user->id(), 'gapps-unsuspend'); |
bb0727ea VZ |
198 | } |
199 | ||
f5c4bf30 VZ |
200 | // Retrieves all the pending update job in the gappsd queue for the current |
201 | // user, and analyzes the scope of the update (ie. the fields in the user | |
202 | // account which are going to be updated). | |
bb0727ea VZ |
203 | private function load_pending_updates() |
204 | { | |
bb0727ea VZ |
205 | $res = XDB::iterator( |
206 | "SELECT j_parameters | |
207 | FROM gapps_queue | |
208 | WHERE q_recipient_id = {?} AND | |
209 | p_status IN ('idle', 'active', 'softfail') AND | |
d56cb887 | 210 | j_type = 'u_update'", $this->user->id()); |
bb0727ea VZ |
211 | while ($update = $res->next()) { |
212 | $update_data = json_decode($update["j_parameters"], true); | |
213 | ||
214 | if (isset($update_data["suspended"])) { | |
215 | $this->pending_update_suspension = true; | |
216 | } elseif (isset($update_data["password"])) { | |
217 | $this->pending_update_password = true; | |
218 | } elseif (isset($update_data["admin"])) { | |
219 | $this->pending_update_admin = true; | |
220 | } else { | |
221 | $this->pending_update_other = true; | |
222 | } | |
223 | } | |
224 | } | |
225 | ||
226 | // Creates a queue job of the @p type, for the user represented by this | |
f5c4bf30 VZ |
227 | // GoogleAppsAccount object, using @p parameters. @p parameters is supposed |
228 | // to be a one-dimension array of key-value mappings. | |
d93451de | 229 | // The created job as a 'immediate' priority, and is scheduled for immediate |
f5c4bf30 | 230 | // execution. |
bb0727ea VZ |
231 | private function create_queue_job($type, $parameters) { |
232 | $parameters["username"] = $this->g_account_name; | |
233 | XDB::execute( | |
234 | "INSERT INTO gapps_queue | |
235 | SET q_owner_id = {?}, q_recipient_id = {?}, | |
236 | p_entry_date = NOW(), p_notbefore_date = NOW(), | |
d93451de | 237 | p_priority = 'immediate', |
bb0727ea VZ |
238 | j_type = {?}, j_parameters = {?}", |
239 | S::v('uid'), | |
d56cb887 | 240 | $this->user->id(), |
bb0727ea VZ |
241 | $type, |
242 | json_encode($parameters)); | |
243 | } | |
244 | ||
f5c4bf30 VZ |
245 | |
246 | // Returns true if the account is currently active. | |
247 | public function active() | |
248 | { | |
249 | return $this->g_status == 'active'; | |
250 | } | |
251 | ||
252 | // Returns true if the account exists in Google Apps. | |
253 | public function provisioned() | |
254 | { | |
255 | return $this->g_status == 'active' or $this->g_status == 'disabled'; | |
256 | } | |
257 | ||
258 | // Returns true if the account exists, but cannot be used (user-requested | |
259 | // suspension, or Google-requested suspension). | |
260 | public function suspended() | |
261 | { | |
262 | return $this->g_status == 'disabled'; | |
263 | } | |
264 | ||
0536df80 VZ |
265 | // Loads and returns the list of nicknames for the user. |
266 | public function nicknames() | |
267 | { | |
268 | if ($this->nicknames == null) { | |
269 | $res = XDB::query( | |
270 | "SELECT g_nickname | |
271 | FROM gapps_nicknames | |
272 | WHERE g_account_name = {?} | |
273 | ORDER BY g_nickname", | |
274 | $this->g_account_name); | |
275 | $this->nicknames = $res->fetchColumn(); | |
276 | } | |
277 | return $this->nicknames; | |
278 | } | |
279 | ||
f5c4bf30 | 280 | |
bb0727ea VZ |
281 | // Changes the GoogleApps password. |
282 | public function set_password($password) { | |
f5c4bf30 | 283 | if (!$this->provisioned()) { |
bb0727ea VZ |
284 | return; |
285 | } | |
286 | ||
287 | if (!$this->pending_update_password) { | |
288 | $this->create_queue_job('u_update', array('password' => $password)); | |
d73f885f | 289 | $this->pending_update_password = true; |
bb0727ea VZ |
290 | } |
291 | } | |
292 | ||
f5c4bf30 | 293 | |
bb0727ea VZ |
294 | // Changes the password synchronization status ("sync = true" means that the |
295 | // Polytechnique.org password will be replicated to the Google Apps account). | |
296 | public function set_password_sync($sync) { | |
f5c4bf30 | 297 | if (!$this->provisioned()) { |
bb0727ea VZ |
298 | return; |
299 | } | |
300 | ||
301 | $this->sync_password = $sync; | |
302 | XDB::execute( | |
303 | "UPDATE gapps_accounts | |
304 | SET l_sync_password = {?} | |
305 | WHERE g_account_name = {?}", | |
306 | $sync, | |
307 | $this->g_account_name); | |
308 | } | |
309 | ||
310 | // Suspends the Google Apps account. | |
311 | public function suspend() { | |
f5c4bf30 | 312 | if (!$this->provisioned()) { |
bb0727ea VZ |
313 | return; |
314 | } | |
315 | ||
316 | if (!$this->pending_update_suspension) { | |
317 | $this->create_queue_job('u_update', array('suspended' => true)); | |
318 | $this->pending_update_suspension = true; | |
5656271f VZ |
319 | XDB::execute( |
320 | "UPDATE gapps_accounts | |
321 | SET g_status = 'disabled' | |
322 | WHERE g_account_name = {?} AND g_status = 'active'", | |
323 | $this->g_account_name); | |
bb0727ea VZ |
324 | } |
325 | } | |
326 | ||
327 | // Adds an unsuspension request to the validation queue (used on user-request). | |
328 | public function unsuspend($activate_mail_redirection = NULL) { | |
f5c4bf30 | 329 | if (!$this->provisioned()) { |
bb0727ea VZ |
330 | return; |
331 | } | |
332 | if ($activate_mail_redirection !== NULL) { | |
333 | $this->activate_mail_redirection = $activate_mail_redirection; | |
334 | XDB::execute( | |
335 | "UPDATE gapps_accounts | |
336 | SET l_activate_mail_redirection = {?} | |
337 | WHERE g_account_name = {?}", | |
f5c4bf30 VZ |
338 | $activate_mail_redirection, |
339 | $this->g_account_name); | |
bb0727ea VZ |
340 | } |
341 | ||
342 | if (!$this->pending_update_suspension && !$this->pending_validation_unsuspend) { | |
5daf68f6 | 343 | $unsuspend = new GoogleAppsUnsuspendReq($this->user); |
bb0727ea VZ |
344 | $unsuspend->submit(); |
345 | $this->pending_validation_unsuspend = true; | |
346 | } | |
347 | } | |
348 | ||
349 | // Unsuspends the Google Apps account (used on admin-request, or on validation of | |
350 | // an user-request). | |
351 | public function do_unsuspend() { | |
f5c4bf30 | 352 | if (!$this->provisioned()) { |
bb0727ea VZ |
353 | return; |
354 | } | |
355 | ||
356 | if (!$this->pending_update_suspension) { | |
357 | if ($this->sync_password) { | |
7679a55a | 358 | $this->create_queue_job('u_update', array('suspended' => false, 'password' => $this->user->password())); |
bb0727ea VZ |
359 | } else { |
360 | $this->create_queue_job('u_update', array('suspended' => false)); | |
361 | } | |
362 | $this->pending_update_suspension = true; | |
363 | return true; | |
364 | } | |
365 | return false; | |
366 | } | |
367 | ||
f5c4bf30 | 368 | // Creates a new Google Apps account with the @p local parameters. |
38c6fe96 FB |
369 | public function create($password_sync, $password, $redirect_mails) |
370 | { | |
bb0727ea VZ |
371 | if ($this->g_status != NULL) { |
372 | return; | |
373 | } | |
374 | ||
375 | if (!$this->pending_create) { | |
376 | // Retrieves information on the new account. | |
80fc062d SJ |
377 | if (!$this->user->hasProfile()) { |
378 | $prenom = $this->user->displayName(); | |
379 | $nom = $this->user->fullName(); | |
0c1e3a66 | 380 | } else { |
80fc062d SJ |
381 | $prenom = $this->user->profile()->firstName(); |
382 | $nom = $this->user->profile()->lastName(); | |
0c1e3a66 | 383 | } |
bb0727ea | 384 | |
f5c4bf30 | 385 | // Adds an 'unprovisioned' entry in the gapps_accounts table. |
bb0727ea VZ |
386 | XDB::execute( |
387 | "INSERT INTO gapps_accounts | |
388 | SET l_userid = {?}, | |
389 | l_sync_password = {?}, | |
390 | l_activate_mail_redirection = {?}, | |
391 | g_account_name = {?}, | |
392 | g_first_name = {?}, | |
393 | g_last_name = {?}, | |
394 | g_status = 'unprovisioned'", | |
d56cb887 | 395 | $this->user->id(), |
bb0727ea VZ |
396 | $password_sync, |
397 | $redirect_mails, | |
398 | $this->g_account_name, | |
0c1e3a66 | 399 | $prenom, $nom); |
bb0727ea VZ |
400 | |
401 | // Adds the creation job in the GApps queue. | |
402 | $this->create_queue_job( | |
403 | 'u_create', | |
404 | array( | |
405 | 'username' => $this->g_account_name, | |
406 | 'first_name' => $prenom, | |
0c1e3a66 | 407 | 'last_name' => $nom, |
bb0727ea VZ |
408 | 'password' => $password, |
409 | )); | |
410 | ||
411 | // Updates the GoogleAppsAccount status. | |
d56cb887 | 412 | $this->__construct($this->user); |
bb0727ea VZ |
413 | } |
414 | } | |
f5c4bf30 VZ |
415 | |
416 | ||
417 | // Returns the status of the Google Apps account for @p user, or false | |
418 | // when no account exists. | |
419 | static public function account_status($uid) { | |
420 | $res = XDB::query( | |
421 | "SELECT g_status | |
422 | FROM gapps_accounts | |
423 | WHERE l_userid = {?}", $uid); | |
424 | return ($res->numRows() > 0 ? $res->fetchOneCell() : false); | |
425 | } | |
426 | ||
427 | // Returns true if the @p user is an administrator of the Google Apps domain. | |
428 | static public function is_administrator($uid) { | |
429 | $res = XDB::query( | |
430 | "SELECT g_admin | |
431 | FROM gapps_accounts | |
432 | WHERE l_userid = {?} AND g_status = 'active'", $uid); | |
4b67332c | 433 | return ($res->numRows() > 0 ? (bool)$res->fetchOneCell() : false); |
f5c4bf30 | 434 | } |
bb0727ea VZ |
435 | } |
436 | ||
437 | // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: | |
438 | ?> |