2 /***************************************************************************
3 * Copyright (C) 2003-2011 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 (GoogleApps username and uid).
27 $parameters = json_decode($job['j_parameters'], true
);
28 $username = isset($parameters['username']) ?
$parameters['username'] : null
;
29 if (!($user = User
::getSilent($username))) {
33 // Adds a redirection to the Google Apps delivery address, if requested by
34 // the user at creation time.
35 $account = new GoogleAppsAccount($user);
36 if ($account->activate_mail_redirection
) {
37 require_once 'emails.inc.php';
38 Email
::activate_storage($user, 'googleapps');
41 // Sends the 'account created' email to the user, with basic documentation.
42 $mailer = new PlMailer('googleapps/create.mail.tpl');
43 $mailer->assign('account', $account);
44 $mailer->assign('email', $user->bestEmail());
45 $mailer->assign('googleapps_domain', $globals->mailstorage
->googleapps_domain
);
46 $mailer->assign('prenom', $user->displayName());
47 $mailer->assign('sexe', $user->isFemale());
51 // Post-processes the successful Google Apps account update queue job.
52 function post_queue_u_update($job) {
55 // If the u_update job was an unsuspend request, re-adds the redirection
56 // to the Google Apps delivery address, provided the account is active (it might
57 // have been deleted between the unsuspension and the post-queue processing).
58 $parameters = json_decode($job['j_parameters'], true
);
59 $username = isset($parameters['username']) ?
$parameters['username'] : null
;
60 if (!($user = User
::getSilent($username))) {
64 if (isset($parameters['suspended']) && $parameters['suspended'] == false
) {
65 require_once 'emails.inc.php';
66 $account = new GoogleAppsAccount($user);
67 if ($account->active()) {
68 // Re-adds the email redirection (if the user did request it).
69 if ($account->activate_mail_redirection
) {
70 Email
::activate_storage($user, 'googleapps');
73 // Sends an email to the account owner.
74 $mailer = new PlMailer('googleapps/unsuspend.mail.tpl');
75 $mailer->assign('account', $account);
76 $mailer->assign('email', $user->bestEmail());
77 $mailer->assign('prenom', $user->displayName());
78 $mailer->assign('sexe', $user->isFemale());
84 // Reprensentation of an SQL-stored Google Apps account.
85 // This class is the interface with the gappsd SQL tables: gappsd is the python
86 // daemon which deals with Google Apps provisioning APIs.
87 // TODO(vincent.zanotti): add the url of gappsd, when available.
88 class GoogleAppsAccount
90 // User identification: user id, and hruid.
92 public $g_account_name;
94 // Local account parameters.
95 public $sync_password;
96 public $activate_mail_redirection;
98 // Account status, obtained from Google Apps provisioning & reporting APIs.
101 public $g_suspension;
102 public $r_disk_usage;
104 public $r_last_login;
105 public $r_last_webmail;
106 public $reporting_date;
108 // Nicknames (aliases) registered for that user, lazily loaded.
111 // Pending requests in the gappsd job queue (cf. top note).
112 public $pending_create;
113 public $pending_delete;
114 public $pending_update;
115 public $pending_update_admin;
116 public $pending_update_other;
117 public $pending_update_password;
118 public $pending_update_suspension;
120 // Pending requests in plat/al validation queue.
121 public $pending_validation_unsuspend;
123 // Constructs the account object, by retrieving all informations from the
124 // GApps account table, from GApps job queue, and from plat/al validation queue.
125 public function __construct(User
$user)
127 $this->user
= &$user;
128 if (!$this->user ||
!$this->user
->login()) {
132 // TODO: switch to multi-domain Google Apps, and use $this->user->forlifeEmail()
133 // as Google Apps idenfiant (requires changes in gappsd).
134 $this->g_account_name
= $this->user
->login();
135 $this->g_status
= NULL
;
138 "SELECT l_sync_password, l_activate_mail_redirection,
139 g_account_name, g_account_id, g_status, g_suspension, r_disk_usage,
140 UNIX_TIMESTAMP(r_creation) as r_creation,
141 UNIX_TIMESTAMP(r_last_login) as r_last_login,
142 UNIX_TIMESTAMP(r_last_webmail) as r_last_webmail
144 WHERE g_account_name = {?}", $this->g_account_name
);
145 if ($account = $res->fetchOneAssoc()) {
146 $this->sync_password
= $account['l_sync_password'];
147 $this->activate_mail_redirection
= $account['l_activate_mail_redirection'];
148 $this->g_account_id
= $account['g_account_id'];
149 $this->g_status
= $account['g_status'];
150 $this->g_suspension
= $account['g_suspension'];
151 $this->r_disk_usage
= $account['r_disk_usage'];
152 $this->r_creation
= $account['r_creation'];
153 $this->r_last_login
= $account['r_last_webmail'];
154 $this->r_last_webmail
= $account['r_last_webmail'];
156 $this->load_pending_counts();
157 $this->load_pending_validations();
158 if ($this->pending_update
) {
159 $this->load_pending_updates();
162 $res = XDB
::query("SELECT MAX(date) FROM gapps_reporting");
163 $this->reporting_date
= $res->fetchOneCell();
167 // Determines if changes to the Google Account are currently waiting in the
168 // GApps job queue, and initializes the local values accordingly.
169 private function load_pending_counts()
172 "SELECT SUM(j_type = 'u_create') AS pending_create,
173 SUM(j_type = 'u_update') AS pending_update,
174 SUM(j_type = 'u_delete') AS pending_delete
176 WHERE q_recipient_id = {?} AND
177 p_status IN ('idle', 'active', 'softfail')
178 GROUP BY j_type", $this->user
->id());
179 $pending = $res->fetchOneAssoc();
180 $this->pending_create
= $pending['pending_create'];
181 $this->pending_update
= $pending['pending_update'];
182 $this->pending_delete
= $pending['pending_delete'];
184 $this->pending_update_admin
= false
;
185 $this->pending_update_other
= false
;
186 $this->pending_update_password
= false
;
187 $this->pending_update_suspension
= false
;
190 // Checks for unsuspend requests waiting for validation in plat/al
192 private function load_pending_validations()
194 $this->pending_validation_unsuspend
=
195 Validate
::get_typed_requests_count($this->user
->id(), 'gapps-unsuspend');
198 // Retrieves all the pending update job in the gappsd queue for the current
199 // user, and analyzes the scope of the update (ie. the fields in the user
200 // account which are going to be updated).
201 private function load_pending_updates()
203 $res = XDB
::iterator(
206 WHERE q_recipient_id = {?} AND
207 p_status IN ('idle', 'active', 'softfail') AND
208 j_type = 'u_update'", $this->user
->id());
209 while ($update = $res->next()) {
210 $update_data = json_decode($update["j_parameters"], true
);
212 if (isset($update_data["suspended"])) {
213 $this->pending_update_suspension
= true
;
214 } elseif (isset($update_data["password"])) {
215 $this->pending_update_password
= true
;
216 } elseif (isset($update_data["admin"])) {
217 $this->pending_update_admin
= true
;
219 $this->pending_update_other
= true
;
224 // Creates a queue job of the @p type, for the user represented by this
225 // GoogleAppsAccount object, using @p parameters. @p parameters is supposed
226 // to be a one-dimension array of key-value mappings.
227 // The created job as a 'immediate' priority, and is scheduled for immediate
229 private function create_queue_job($type, $parameters) {
230 $parameters["username"] = $this->g_account_name
;
232 "INSERT INTO gapps_queue
233 SET q_owner_id = {?}, q_recipient_id = {?},
234 p_entry_date = NOW(), p_notbefore_date = NOW(),
235 p_priority = 'immediate',
236 j_type = {?}, j_parameters = {?}",
240 json_encode($parameters));
244 // Returns true if the account is currently active.
245 public function active()
247 return $this->g_status
== 'active';
250 // Returns true if the account exists in Google Apps.
251 public function provisioned()
253 return $this->g_status
== 'active' or $this->g_status
== 'disabled';
256 // Returns true if the account exists, but cannot be used (user-requested
257 // suspension, or Google-requested suspension).
258 public function suspended()
260 return $this->g_status
== 'disabled';
263 // Loads and returns the list of nicknames for the user.
264 public function nicknames()
266 if ($this->nicknames
== null
) {
270 WHERE g_account_name = {?}
271 ORDER BY g_nickname",
272 $this->g_account_name
);
273 $this->nicknames
= $res->fetchColumn();
275 return $this->nicknames
;
279 // Changes the GoogleApps password.
280 public function set_password($password) {
281 if (!$this->provisioned()) {
285 if (!$this->pending_update_password
) {
286 $this->create_queue_job('u_update', array('password' => $password));
287 $this->pending_update_password
= true
;
292 // Changes the password synchronization status ("sync = true" means that the
293 // Polytechnique.org password will be replicated to the Google Apps account).
294 public function set_password_sync($sync) {
295 if (!$this->provisioned()) {
299 $this->sync_password
= $sync;
301 "UPDATE gapps_accounts
302 SET l_sync_password = {?}
303 WHERE g_account_name = {?}",
305 $this->g_account_name
);
308 // Suspends the Google Apps account.
309 public function suspend() {
310 if (!$this->provisioned()) {
314 if (!$this->pending_update_suspension
) {
315 $this->create_queue_job('u_update', array('suspended' => true
));
316 $this->pending_update_suspension
= true
;
318 "UPDATE gapps_accounts
319 SET g_status = 'disabled'
320 WHERE g_account_name = {?} AND g_status = 'active'",
321 $this->g_account_name
);
325 // Adds an unsuspension request to the validation queue (used on user-request).
326 public function unsuspend($activate_mail_redirection = NULL
) {
327 if (!$this->provisioned()) {
330 if ($activate_mail_redirection !== NULL
) {
331 $this->activate_mail_redirection
= $activate_mail_redirection;
333 "UPDATE gapps_accounts
334 SET l_activate_mail_redirection = {?}
335 WHERE g_account_name = {?}",
336 $activate_mail_redirection,
337 $this->g_account_name
);
340 if (!$this->pending_update_suspension
&& !$this->pending_validation_unsuspend
) {
341 $unsuspend = new GoogleAppsUnsuspendReq($this->user
);
342 $unsuspend->submit();
343 $this->pending_validation_unsuspend
= true
;
347 // Unsuspends the Google Apps account (used on admin-request, or on validation of
349 public function do_unsuspend() {
350 if (!$this->provisioned()) {
354 if (!$this->pending_update_suspension
) {
355 if ($this->sync_password
) {
356 $this->create_queue_job('u_update', array('suspended' => false
, 'password' => $this->user
->password()));
358 $this->create_queue_job('u_update', array('suspended' => false
));
360 $this->pending_update_suspension
= true
;
366 // Creates a new Google Apps account with the @p local parameters.
367 public function create($password_sync, $password, $redirect_mails)
369 if ($this->g_status
!= NULL
) {
373 if (!$this->pending_create
) {
374 // Retrieves information on the new account.
375 if (!$this->user
->hasProfile()) {
376 $prenom = $this->user
->displayName();
377 $nom = $this->user
->fullName();
379 $prenom = $this->user
->profile()->firstName();
380 $nom = $this->user
->profile()->lastName();
383 // Adds an 'unprovisioned' entry in the gapps_accounts table.
385 "INSERT INTO gapps_accounts
387 l_sync_password = {?},
388 l_activate_mail_redirection = {?},
389 g_account_name = {?},
392 g_status = 'unprovisioned'",
396 $this->g_account_name
,
399 // Adds the creation job in the GApps queue.
400 $this->create_queue_job(
403 'username' => $this->g_account_name
,
404 'first_name' => $prenom,
406 'password' => $password,
409 // Updates the GoogleAppsAccount status.
410 $this->__construct($this->user
);
415 // Returns the status of the Google Apps account for @p user, or false
416 // when no account exists.
417 static public function account_status($uid) {
421 WHERE l_userid = {?}", $uid);
422 return ($res->numRows() > 0 ?
$res->fetchOneCell() : false
);
425 // Returns true if the @p user is an administrator of the Google Apps domain.
426 static public function is_administrator($uid) {
430 WHERE l_userid = {?} AND g_status = 'active'", $uid);
431 return ($res->numRows() > 0 ?
(bool
)$res->fetchOneCell() : false
);
435 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: