2 /***************************************************************************
3 * Copyright (C) 2003-2008 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
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. *
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. *
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 *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
22 // Post-processes the successful Google Apps account creation queue job.
23 function post_queue_u_create($job) {
26 // Retrieves the user parameters (userid and forlife).
27 $parameters = json_decode($job['j_parameters'], true
);
28 $forlife = isset($parameters['username']) ?
$parameters['username'] : null
;
29 $userid = $job['q_recipient_id'];
30 if (!$forlife ||
!$userid) {
34 // Adds a redirection to the Google Apps delivery address, if requested by
35 // the user at creation time.
36 $account = new GoogleAppsAccount($userid, $forlife);
37 if ($account->activate_mail_redirection
) {
38 require_once('emails.inc.php');
39 $storage = new EmailStorage($userid, 'googleapps');
43 // Sends the 'account created' email to the user, with basic documentation.
45 "SELECT FIND_IN_SET('femme', u.flags), prenom
46 FROM auth_user_md5 AS u
47 INNER JOIN aliases AS a ON (a.id = u.user_id)
50 list($sexe, $prenom) = $res->fetchOneRow();
52 $mailer = new PlMailer('googleapps/create.mail.tpl');
53 $mailer->assign('account', $account);
54 $mailer->assign('email', $forlife . '@' . $globals->mail
->domain
);
55 $mailer->assign('googleapps_domain', $globals->mailstorage
->googleapps_domain
);
56 $mailer->assign('prenom', $prenom);
57 $mailer->assign('sexe', $sexe);
61 // Post-processes the successful Google Apps account update queue job.
62 function post_queue_u_update($job) {
65 // If the u_update job was an unsuspend request, re-adds the redirection
66 // to the Google Apps delivery address, provided the account is active (it might
67 // have been deleted between the unsuspension and the post-queue processing).
68 $parameters = json_decode($job['j_parameters'], true
);
69 $forlife = isset($parameters['username']) ?
$parameters['username'] : null
;
70 $userid = $job['q_recipient_id'];
71 if (!$forlife ||
!$userid) {
75 if (isset($parameters['suspended']) && $parameters['suspended'] == false
) {
76 require_once('emails.inc.php');
77 $account = new GoogleAppsAccount($userid, $forlife);
78 if ($account->active()) {
79 // Re-adds the email redirection (if the user did request it).
80 if ($account->activate_mail_redirection
) {
81 $storage = new EmailStorage($userid, 'googleapps');
85 // Sends an email to the account owner.
87 "SELECT FIND_IN_SET('femme', u.flags), prenom
88 FROM auth_user_md5 AS u
89 INNER JOIN aliases AS a ON (a.id = u.user_id)
92 list($sexe, $prenom) = $res->fetchOneRow();
94 $mailer = new PlMailer('googleapps/unsuspend.mail.tpl');
95 $mailer->assign('account', $account);
96 $mailer->assign('email', $forlife . '@' . $globals->mail
->domain
);
97 $mailer->assign('prenom', $prenom);
98 $mailer->assign('sexe', $sexe);
104 // Reprensentation of an SQL-stored Google Apps account.
105 // This class is the interface with the gappsd SQL tables: gappsd is the python
106 // daemon which deals with Google Apps provisioning APIs.
107 // TODO(vincent.zanotti): add the url of gappsd, when available.
108 class GoogleAppsAccount
110 // User identification: user id, and forlife.
112 public $g_account_name;
114 // Local account parameters.
115 public $sync_password;
116 public $activate_mail_redirection;
118 // Account status, obtained from Google Apps provisioning & reporting APIs.
119 public $g_account_id;
121 public $g_suspension;
122 public $r_disk_usage;
124 public $r_last_login;
125 public $r_last_webmail;
126 public $reporting_date;
128 // Pending requests in the gappsd job queue (cf. top note).
129 public $pending_create;
130 public $pending_delete;
131 public $pending_update;
132 public $pending_update_admin;
133 public $pending_update_other;
134 public $pending_update_password;
135 public $pending_update_suspension;
137 // Pending requests in plat/al validation queue.
138 public $pending_validation_unsuspend;
140 // Constructs the account object, by retrieving all informations from the
141 // GApps account table, from GApps job queue, and from plat/al validation queue.
142 public function __construct($uid, $account_name = NULL
)
144 if ($account_name == NULL
) {
145 require_once 'user.func.inc.php';
146 $account_name = get_user_forlife($uid, '_silent_user_callback');
150 $this->g_account_name
= $account_name;
151 $this->g_status
= NULL
;
154 "SELECT l_sync_password, l_activate_mail_redirection,
155 g_account_name, g_account_id, g_status, g_suspension, r_disk_usage,
156 UNIX_TIMESTAMP(r_creation) as r_creation,
157 UNIX_TIMESTAMP(r_last_login) as r_last_login,
158 UNIX_TIMESTAMP(r_last_webmail) as r_last_webmail
160 WHERE g_account_name = {?}",
162 if ($account = $res->fetchOneAssoc()) {
163 $this->sync_password
= $account['l_sync_password'];
164 $this->activate_mail_redirection
= $account['l_activate_mail_redirection'];
165 $this->g_account_id
= $account['g_account_id'];
166 $this->g_status
= $account['g_status'];
167 $this->g_suspension
= $account['g_suspension'];
168 $this->r_disk_usage
= $account['r_disk_usage'];
169 $this->r_creation
= $account['r_creation'];
170 $this->r_last_login
= $account['r_last_webmail'];
171 $this->r_last_webmail
= $account['r_last_webmail'];
173 $this->load_pending_counts();
174 $this->load_pending_validations();
175 if ($this->pending_update
) {
176 $this->load_pending_updates();
179 $res = XDB
::query("SELECT MAX(date) FROM gapps_reporting");
180 $this->reporting_date
= $res->fetchOneCell();
184 // Determines if changes to the Google Account are currently waiting in the
185 // GApps job queue, and initializes the local values accordingly.
186 private function load_pending_counts()
189 "SELECT SUM(j_type = 'u_create') AS pending_create,
190 SUM(j_type = 'u_update') AS pending_update,
191 SUM(j_type = 'u_delete') AS pending_delete
193 WHERE q_recipient_id = {?} AND
194 p_status IN ('idle', 'active', 'softfail')
197 $pending = $res->fetchOneAssoc();
198 $this->pending_create
= $pending['pending_create'];
199 $this->pending_update
= $pending['pending_update'];
200 $this->pending_delete
= $pending['pending_delete'];
202 $this->pending_update_admin
= false
;
203 $this->pending_update_other
= false
;
204 $this->pending_update_password
= false
;
205 $this->pending_update_suspension
= false
;
208 // Checks for unsuspend requests waiting for validation in plat/al
210 private function load_pending_validations()
212 require_once('validations.inc.php');
213 $this->pending_validation_unsuspend
=
214 Validate
::get_typed_requests_count($this->uid
, 'gapps-unsuspend');
217 // Retrieves all the pending update job in the gappsd queue for the current
218 // user, and analyzes the scope of the update (ie. the fields in the user
219 // account which are going to be updated).
220 private function load_pending_updates()
222 $res = XDB
::iterator(
225 WHERE q_recipient_id = {?} AND
226 p_status IN ('idle', 'active', 'softfail') AND
227 j_type = 'u_update'",
229 while ($update = $res->next()) {
230 $update_data = json_decode($update["j_parameters"], true
);
232 if (isset($update_data["suspended"])) {
233 $this->pending_update_suspension
= true
;
234 } elseif (isset($update_data["password"])) {
235 $this->pending_update_password
= true
;
236 } elseif (isset($update_data["admin"])) {
237 $this->pending_update_admin
= true
;
239 $this->pending_update_other
= true
;
244 // Creates a queue job of the @p type, for the user represented by this
245 // GoogleAppsAccount object, using @p parameters. @p parameters is supposed
246 // to be a one-dimension array of key-value mappings.
247 // The created job as a 'normal' priority, and is scheduled for immediate
249 private function create_queue_job($type, $parameters) {
250 $parameters["username"] = $this->g_account_name
;
252 "INSERT INTO gapps_queue
253 SET q_owner_id = {?}, q_recipient_id = {?},
254 p_entry_date = NOW(), p_notbefore_date = NOW(),
255 p_priority = 'normal',
256 j_type = {?}, j_parameters = {?}",
260 json_encode($parameters));
264 // Returns true if the account is currently active.
265 public function active()
267 return $this->g_status
== 'active';
270 // Returns true if the account exists in Google Apps.
271 public function provisioned()
273 return $this->g_status
== 'active' or $this->g_status
== 'disabled';
276 // Returns true if the account exists, but cannot be used (user-requested
277 // suspension, or Google-requested suspension).
278 public function suspended()
280 return $this->g_status
== 'disabled';
284 // Changes the GoogleApps password.
285 public function set_password($password) {
286 if (!$this->provisioned()) {
290 if (!$this->pending_update_password
) {
291 $this->create_queue_job('u_update', array('password' => $password));
292 $this->pending_update_password
= true
;
297 // Changes the password synchronization status ("sync = true" means that the
298 // Polytechnique.org password will be replicated to the Google Apps account).
299 public function set_password_sync($sync) {
300 if (!$this->provisioned()) {
304 $this->sync_password
= $sync;
306 "UPDATE gapps_accounts
307 SET l_sync_password = {?}
308 WHERE g_account_name = {?}",
310 $this->g_account_name
);
313 // Suspends the Google Apps account.
314 public function suspend() {
315 if (!$this->provisioned()) {
319 if (!$this->pending_update_suspension
) {
320 $this->create_queue_job('u_update', array('suspended' => true
));
321 $this->pending_update_suspension
= true
;
323 "UPDATE gapps_accounts
324 SET g_status = 'disabled'
325 WHERE g_account_name = {?} AND g_status = 'active'",
326 $this->g_account_name
);
330 // Adds an unsuspension request to the validation queue (used on user-request).
331 public function unsuspend($activate_mail_redirection = NULL
) {
332 if (!$this->provisioned()) {
335 if ($activate_mail_redirection !== NULL
) {
336 $this->activate_mail_redirection
= $activate_mail_redirection;
338 "UPDATE gapps_accounts
339 SET l_activate_mail_redirection = {?}
340 WHERE g_account_name = {?}",
341 $activate_mail_redirection,
342 $this->g_account_name
);
345 if (!$this->pending_update_suspension
&& !$this->pending_validation_unsuspend
) {
346 require_once('validations.inc.php');
347 $unsuspend = new GoogleAppsUnsuspendReq($this->uid
);
348 $unsuspend->submit();
349 $this->pending_validation_unsuspend
= true
;
353 // Unsuspends the Google Apps account (used on admin-request, or on validation of
355 public function do_unsuspend() {
356 if (!$this->provisioned()) {
360 if (!$this->pending_update_suspension
) {
361 if ($this->sync_password
) {
365 WHERE user_id = {?}",
367 $password = ($res->numRows() > 0 ?
$res->fetchOneCell() : false
);
373 $this->create_queue_job('u_update', array('suspended' => false
, 'password' => $password));
375 $this->create_queue_job('u_update', array('suspended' => false
));
377 $this->pending_update_suspension
= true
;
383 // Creates a new Google Apps account with the @p local parameters.
384 public function create($password_sync, $password, $redirect_mails) {
385 if ($this->g_status
!= NULL
) {
389 if (!$this->pending_create
) {
390 // Retrieves information on the new account.
392 "SELECT nom, nom_usage, prenom
394 WHERE user_id = {?}",
396 list($nom, $nom_usage, $prenom) = $res->fetchOneRow();
398 // Adds an 'unprovisioned' entry in the gapps_accounts table.
400 "INSERT INTO gapps_accounts
402 l_sync_password = {?},
403 l_activate_mail_redirection = {?},
404 g_account_name = {?},
407 g_status = 'unprovisioned'",
411 $this->g_account_name
,
413 ($nom_usage ?
$nom_usage : $nom));
415 // Adds the creation job in the GApps queue.
416 $this->create_queue_job(
419 'username' => $this->g_account_name
,
420 'first_name' => $prenom,
421 'last_name' => ($nom_usage ?
$nom_usage : $nom),
422 'password' => $password,
425 // Updates the GoogleAppsAccount status.
426 $this->__construct($this->uid
, $this->g_account_name
);
431 // Returns the status of the Google Apps account for @p user, or false
432 // when no account exists.
433 static public function account_status($uid) {
437 WHERE l_userid = {?}", $uid);
438 return ($res->numRows() > 0 ?
$res->fetchOneCell() : false
);
441 // Returns true if the @p user is an administrator of the Google Apps domain.
442 static public function is_administrator($uid) {
446 WHERE l_userid = {?} AND g_status = 'active'", $uid);
447 return ($res->numRows() > 0 ?
(bool
)$res->fetchOneRow() : false
);
451 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: