fewer highlevel bullets
[plewww.git] / modules / planetlab.module
1 <?php // -*-php-*-
2   //
3   // PlanetLab authentication and integration with Drupal
4   //
5   // Mark Huang <mlhuang@cs.princeton.edu>
6   // Copyright (C) 2006 The Trustees of Princeton University
7   //
8   // $Id$
9   //
10
11 require_once 'plc_config.php';
12 require_once 'plc_session.php';
13 require_once 'plc_functions.php';
14
15 function planetlab_help($section) {
16   switch ($section) {
17   case 'admin/modules#description':
18     return t('Enables authenticated login via a PlanetLab API server.');
19   }
20 }
21
22 function planetlab_info($field = 0) {
23   $info['name'] = 'PlanetLab';
24
25   if ($field) {
26     return $info[$field];
27   } else {
28     return $info;
29   }
30 }
31
32 function planetlab_menu($may_cache) {
33   $items = array();
34
35   if ($may_cache) {
36     $items[] = array(
37                      'path' => 'planetlab/logout',
38                      'title' => t('Log out of %s', array('%s' => variable_get('site_name', 'local'))),
39                      'callback' => 'planetlab_logout',
40                      'access' => TRUE,
41                      'type' => MENU_CALLBACK
42                      );
43     $items[] = array(
44                      'path' => 'db',
45                      'title' => variable_get('site_name', 'local'),
46                      'callback' => 'planetlab_page',
47                      'access' => TRUE,
48                      'type' => MENU_CALLBACK
49                      );
50   }
51
52   return $items;
53 }
54
55 // formatting helpers
56 function ul_start () { return '<ul class=menu>'; }
57 function ul_end () { return '</ul>'; }
58 function leaf($text) { return '<li class=leaf>' . $text . '</li>'; }
59 function expanded($text) { return '<li class=expanded>' . $text . '</li>'; }
60 function p($text) { return '<p>' . $text . '</p>'; }
61 // fake theme to look like menu
62 function menu_theme ($menu) {
63   $result = '';
64   $result .= ul_start();
65   foreach ($menu as $item) $result .= $item;
66   $result .= ul_end();
67   return $result;
68 }
69
70 function planetlab_block($op = 'list', $delta = 0, $edit = array()) {
71   global $user, $plc;
72
73   if ($op == 'list') {
74     $blocks[0]['info'] = t('PlanetLab login');
75
76     return $blocks;
77
78   } else if ($op == 'view') {
79     $block = array();
80
81     if (!$plc->person) {
82       // Force login via HTTPS
83       unset($_GET['time']);
84       $form['#action'] = "https://" . $_SERVER['HTTP_HOST'] . url($_GET['q'], drupal_get_destination());
85       $form['#id'] = 'planetlab-login-form';
86       $form['name'] = array('#type' => 'textfield',
87                             '#title' => t('E-mail'),
88                             '#maxlength' => 60,
89                             '#size' => 25,
90                             '#required' => TRUE,
91                             );
92       $form['pass'] = array('#type' => 'password',
93                             '#title' => t('Password'),
94                             '#size' => 25,
95                             '#required' => TRUE,
96                             );
97       $form['submit'] = array('#type' => 'submit',
98                               '#value' => t('Log in'),
99                               );
100
101       $block['subject'] = t('%s login', array('%s' => variable_get('site_name', 'local')));
102       $block['content'] = drupal_get_form('planetlab_login_block', $form, 'planetlab_login');
103       $block['content'] .= p('');
104       $block['content'] .= p( href (l_reset_password(),"Forgot your password?") );
105       $block['content'] .= p( href(l_person_register(),"Create an account") );
106       $block['content'] .= p( href(l_site_register(),"File a site registration") );
107     } else {
108       $block['subject'] = $plc->person['email'];
109       $is_admin = in_array(10,$plc->person['role_ids']);
110       $is_pi    = in_array(20,$plc->person['role_ids']);
111       $is_user  = in_array(30,$plc->person['role_ids']);
112       $is_tech  = in_array(40,$plc->person['role_ids']);
113
114       $site_item = '';
115       $site_item .= href(l_sites(),"Sites");
116       $site_item .= ul_start();
117       $site_item .= leaf( href(l_site(plc_my_site_id()),"My site"));
118       if ( $is_admin ) 
119         $site_item .= leaf( href(l_site_pending(),"Pending Requests"));
120       $site_item .= ul_end();
121       $items[] = expanded($site_item);
122
123       $user_item = '';
124       $user_item .= href(l_persons(),'Users');
125       $user_item .= ul_start();
126       $user_item .= leaf( l_person_t(plc_my_person_id(),"My account"));
127       if (is_pi) 
128         $user_item .= leaf( href( l_persons_site(plc_my_site_id()), "My users"));
129       if ( $plc->alt_person && $plc->alt_auth) {
130         $email = $plc->person['email']; 
131         $user_item .= leaf( href( l_sulogout(),"Log out of $email"));
132       } 
133       $user_item .= ul_end();
134       $items [] = expanded($user_item);
135
136       $node_item = '';
137       $node_item .= href(l_nodes(),"Nodes");
138       $node_item .= ul_start();
139       $node_item .= leaf( href (l_nodes_site (plc_my_site_id()),"My Site Nodes"));
140       $node_item .= leaf( href (l_node_add(),"Add Node"));
141       if ( $is_admin) 
142         $node_item .= leaf (href(l_peers(),'Peers'));
143       $node_item .= ul_end();
144       $items [] = expanded($node_item);
145
146       $slice_item = '';
147       //if( !( $is_tech && ! $is_user && ! $is_pi && ! $is_admin ) ) 
148       $slice_item .= href(l_slices(),"Slices");
149       $slice_item .= ul_start();
150       if( $is_admin || $is_pi ) {
151         $slice_item .= leaf(href(l_slice_add(),"Create Slice"));
152       }
153       if( !( $is_tech && ! $is_user && ! $is_pi && ! $is_admin ) ) 
154         $slice_item .= leaf(href(l_sirius(),"Sirius"));
155       $slice_item .= ul_end();
156       $items [] = expanded($slice_item);
157
158       if( $is_admin || $is_pi ) {
159         $tag_item = '';
160         $tag_item .= href(l_tags(),"All Tag Types");
161         $tag_item .= ul_start();
162         $tag_item .= leaf( href( l_tags_slice(),"Slice Tags"));
163         $tag_item .= leaf( href( l_tags_interface(),"Interface Tags"));
164         $tag_item .= leaf( href (l_tags_interface(),"Setting Types (dup xxx)"));
165         $tag_item .= leaf( href( l_tags_node(),"Node Tags"));
166         $tag_item .= leaf( href( l_nodegroups(),"Node groups (xxx)"));
167         $tag_item .= ul_end();
168         $items [] = expanded($tag_item);
169       }
170
171       $doc_item = '';
172       $doc_item .= href(l_about(),'About MyPLC');
173       $doc_item .= ul_start();
174       $doc_item .= leaf ( href (l_doc_plcapi(),"PLCAPI doc"));
175       $doc_item .= leaf ( href (l_doc_nmapi(),"NMAPI doc"));
176       if ( $is_admin )
177         $doc_item .= leaf (href(l_events(),'Events'));
178       $doc_item .= ul_end();
179       $items[] = expanded($doc_item);
180
181       if ($user->uid) {
182         // Drupal logout (destroys the session and cleans up $user)
183         // Thierry unclear when this triggers, I suspect this is obsolete
184         $items[] = leaf (l(t('Log out of %s', 
185                              array('%s' => variable_get('site_name', 'local'))), 'logout'));
186       } else {
187         // PlanetLab logout (just destroy the session)
188         $items[] = leaf ( href (l_logout(),'Log out'));
189       }
190       
191       //$block['content'] = theme('list_item', $items);
192       $block['content'] = menu_theme($items);
193       //      plc_debug("content",$block['content']);
194     }
195
196     /*
197      ob_start();
198      print '<pre>';
199      print_r($_SESSION);
200      print '</pre>';
201      $block['content'] .= ob_get_contents();
202      ob_end_clean();
203     */
204
205     return $block;
206   }
207 }
208
209 function planetlab_login_validate($form_id, $form_values) {
210   global $user, $plc;
211
212   if ($form_values['name'] && $form_values['pass']) {
213     // Drupal login succeeded
214     if (($user = user_authenticate($form_values['name'], trim($form_values['pass']))) &&
215         $user->uid) {
216       return;
217     }
218
219     $plc = new PLCSession($form_values['name'], $form_values['pass']);
220
221     // PlanetLab login failed
222     if (!$plc->person) {
223       form_set_error('login', t('Sorry. Unrecognized username or password.'));
224       watchdog('planetlab', t('Login attempt failed for %user.', array('%user' => theme('placeholder', $form_values['name']))));
225     }
226
227     // PlanetLab login succeeded
228     else {
229       // Login admins to Drupal as the superuser
230       if (in_array('admin', $plc->person['roles'])) {
231         $user = user_load(array('uid' => 1));
232       }
233     }
234   }
235 }
236
237 function planetlab_login_submit($form_id, $form_values) {
238   global $plc;
239
240   // Our referring page is encased in a query string of the form
241   // "destination=referrer".
242   parse_str(drupal_get_destination()); // => $destination
243
244   // The referrer itself is a URL path with the original query string,
245   // e.g. "referer.php?query".
246   extract(parse_url($destination)); // => $query
247
248   // Which we then have to parse again as a query string.
249   parse_str($query); // => $url
250
251   if ($plc->person) {
252     // To handle the edge case where this function is called during a
253     // bootstrap, check for the existence of t().
254     if (function_exists('t')) {
255       $message = t('Session opened for %name.', array('%name' => theme('placeholder', $plc->person['email'])));
256     }
257     else {
258       $message = "Session opened for ". check_plain($person['email']);
259     }
260     watchdog('planetlab', $message);
261
262     if (empty($url)) {
263       // Create a timestamped final URL so that browsers don't return the user to
264       // a cached page (where it would appear as if they never logged in or out).
265       return array('time='. time());
266     } else {
267       // Make sure that redirections are always local
268       $url = urldecode($url);
269       if ($url[0] != "/") {
270         $url = "/$url";
271       }
272       Header("Location: $url");
273       exit();
274     }
275   }
276 }
277
278 function planetlab_logout() {
279   global $plc;
280
281   if ($plc->person) {
282     // Invalidate PlanetLab session
283     $plc->logout();
284     watchdog('planetlab', t('Session closed for %name.', array('%name' => theme('placeholder', $plc->person['email']))));
285   }
286
287   // Destroy the current session:
288   session_destroy();
289
290   // The time prevents caching.
291   drupal_goto(NULL, 'time='. time());
292 }
293
294 function planetlab_user($type, &$edit, &$user, $category = NULL) {
295   switch ($type) {
296   case 'logout':
297     if ($plc->person) {
298       $plc->logout();
299       watchdog('planetlab', t('Session closed for %name.', array('%name' => theme('placeholder', $plc->person['email']))));
300     }
301     break;
302   }
303 }
304
305 function planetlab_page() {
306   $path = $_SERVER['DOCUMENT_ROOT'] . preg_replace('/^db\//', '/planetlab/', $_GET['q']);
307
308   // error_log("Requested " . $_GET['q'] . " -> $path");
309
310   if (is_dir($path)) {
311     foreach (array('index.php', 'index.html', 'index.htm') as $index) {
312       if (is_file($path . "/$index")) {
313         $path .= "/$index";
314         break;
315       }
316     }
317   }
318
319   if (is_file($path)) {
320     if (preg_match('/.php$/', $path)) {
321       ob_start();
322       include $path;
323       $output = ob_get_contents();
324       ob_end_clean();
325     } else {
326       $output = file_get_contents($path);
327     }
328     return $output;
329   }
330             
331   drupal_not_found();
332 }
333
334 function theme_planetlab($content) {
335   return $content;
336 }
337
338 ?>