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_u(plc_my_site_id()),"My site"));
 118       if ( $is_admin )
 119         $site_item .= leaf( href(l_site_pending(),"Pending Requests"));
 120       if( $is_admin )
 121         $site_item .= leaf( href(l_site_status(),"Migration Status"));
 122       $site_item .= ul_end();
 123       $items[] = expanded($site_item);
 124
 125       $user_item = '';
 126       $user_item .= href(l_persons(),'Users');
 127       $user_item .= ul_start();
 128       $user_item .= leaf( href(l_person_u(plc_my_person_id()),"My account"));
 129       if (is_pi)
 130         $user_item .= leaf( href( l_persons_site(plc_my_site_id()), "My users"));
 131       if ( $plc->alt_person && $plc->alt_auth) {
 132         $email = $plc->person['email'];
 133         $user_item .= leaf( href( l_sulogout(),"Log out of $email"));
 134       }
 135       $user_item .= ul_end();
 136       $items [] = expanded($user_item);
 137
 138       $node_item = '';
 139       $node_item .= href(l_nodes(),"Nodes");
 140       $node_item .= ul_start();
 141       $node_item .= leaf( href (l_nodes_site (plc_my_site_id()),"My Site Nodes"));
 142       $node_item .= leaf( href (l_node_add(),"Add Node"));
 143       if ( $is_admin)
 144         $node_item .= leaf (href(l_peers(),'Peers'));
 145       $node_item .= ul_end();
 146       $items [] = expanded($node_item);
 147
 148       $slice_item = '';
 149       //if( !( $is_tech && ! $is_user && ! $is_pi && ! $is_admin ) )
 150       $slice_item .= href(l_slices(),"Slices");
 151       $slice_item .= ul_start();
 152       if( $is_admin || $is_pi ) {
 153         $slice_item .= leaf(href(l_slice_add(),"Create Slice"));
 154       }
 155       if( !( $is_tech && ! $is_user && ! $is_pi && ! $is_admin ) )
 156         $slice_item .= leaf(href(l_sirius(),"Sirius"));
 157       $slice_item .= ul_end();
 158       $items [] = expanded($slice_item);
 159
 160       if( $is_admin || $is_pi ) {
 161         $tag_item = '';
 162         $tag_item .= href(l_tags(),"All Tag Types");
 163         $tag_item .= ul_start();
 164         $tag_item .= leaf( href( l_tags_slice(),"Slice Tags"));
 165         $tag_item .= leaf( href( l_tags_interface(),"Interface Tags"));
 166         $tag_item .= leaf( href (l_tags_interface(),"Setting Types (dup xxx)"));
 167         $tag_item .= leaf( href( l_tags_node(),"Node Tags"));
 168         $tag_item .= leaf( href( l_nodegroups(),"Node groups (xxx)"));
 169         $tag_item .= ul_end();
 170         $items [] = expanded($tag_item);
 171       }
 172
 173       $doc_item = '';
 174       $doc_item .= href(l_about(),'About MyPLC');
 175       $doc_item .= ul_start();
 176       $doc_item .= leaf ( href (l_doc_plcapi(),"PLCAPI doc"));
 177       $doc_item .= leaf ( href (l_doc_nmapi(),"NMAPI doc"));
 178       $doc_item .= ul_end();
 179       $items[] = expanded($doc_item);
 180
 181       if ( $is_admin )
 182         $items[] = leaf (href(l_events(),'Events'));
 183
 184       if ($user->uid) {
 185         // Drupal logout (destroys the session and cleans up $user)
 186         // Thierry unclear when this triggers, I suspect this is obsolete
 187         $items[] = leaf (l(t('Log out of %s',
 188                              array('%s' => variable_get('site_name', 'local'))), 'logout'));
 189       } else {
 190         // PlanetLab logout (just destroy the session)
 191         $items[] = leaf ( href (l_logout(),'Log out'));
 192       }
 193
 194       //$block['content'] = theme('list_item', $items);
 195       $block['content'] = menu_theme($items);
 196       //      plc_debug("content",$block['content']);
 197     }
 198
 199     /*
 200      ob_start();
 201      print '<pre>';
 202      print_r($_SESSION);
 203      print '</pre>';
 204      $block['content'] .= ob_get_contents();
 205      ob_end_clean();
 206     */
 207
 208     return $block;
 209   }
 210 }
 211
 212 function planetlab_login_validate($form_id, $form_values) {
 213   global $user, $plc;
 214
 215   if ($form_values['name'] && $form_values['pass']) {
 216     // Drupal login succeeded
 217     if (($user = user_authenticate($form_values['name'], trim($form_values['pass']))) &&
 218         $user->uid) {
 219       return;
 220     }
 221
 222     $plc = new PLCSession($form_values['name'], $form_values['pass']);
 223
 224     // PlanetLab login failed
 225     if (!$plc->person) {
 226       form_set_error('login', t('Sorry. Unrecognized username or password.'));
 227       watchdog('planetlab', t('Login attempt failed for %user.', array('%user' => theme('placeholder', $form_values['name']))));
 228     }
 229
 230     // PlanetLab login succeeded
 231     else {
 232       // Login admins to Drupal as the superuser
 233       if (in_array('admin', $plc->person['roles'])) {
 234         $user = user_load(array('uid' => 1));
 235       }
 236     }
 237   }
 238 }
 239
 240 function planetlab_login_submit($form_id, $form_values) {
 241   global $plc;
 242
 243   // Our referring page is encased in a query string of the form
 244   // "destination=referrer".
 245   parse_str(drupal_get_destination()); // => $destination
 246
 247   // The referrer itself is a URL path with the original query string,
 248   // e.g. "referer.php?query".
 249   extract(parse_url($destination)); // => $query
 250
 251   // Which we then have to parse again as a query string.
 252   parse_str($query); // => $url
 253
 254   if ($plc->person) {
 255     // To handle the edge case where this function is called during a
 256     // bootstrap, check for the existence of t().
 257     if (function_exists('t')) {
 258       $message = t('Session opened for %name.', array('%name' => theme('placeholder', $plc->person['email'])));
 259     }
 260     else {
 261       $message = "Session opened for ". check_plain($person['email']);
 262     }
 263     watchdog('planetlab', $message);
 264
 265     if (empty($url)) {
 266       // Create a timestamped final URL so that browsers don't return the user to
 267       // a cached page (where it would appear as if they never logged in or out).
 268       return array('time='. time());
 269     } else {
 270       // Make sure that redirections are always local
 271       $url = urldecode($url);
 272       if ($url[0] != "/") {
 273         $url = "/$url";
 274       }
 275       Header("Location: $url");
 276       exit();
 277     }
 278   }
 279 }
 280
 281 function planetlab_logout() {
 282   global $plc;
 283
 284   if ($plc->person) {
 285     // Invalidate PlanetLab session
 286     $plc->logout();
 287     watchdog('planetlab', t('Session closed for %name.', array('%name' => theme('placeholder', $plc->person['email']))));
 288   }
 289
 290   // Destroy the current session:
 291   session_destroy();
 292
 293   // The time prevents caching.
 294   drupal_goto(NULL, 'time='. time());
 295 }
 296
 297 function planetlab_user($type, &$edit, &$user, $category = NULL) {
 298   switch ($type) {
 299   case 'logout':
 300     if ($plc->person) {
 301       $plc->logout();
 302       watchdog('planetlab', t('Session closed for %name.', array('%name' => theme('placeholder', $plc->person['email']))));
 303     }
 304     break;
 305   }
 306 }
 307
 308 function planetlab_page() {
 309   $path = $_SERVER['DOCUMENT_ROOT'] . preg_replace('/^db\//', '/planetlab/', $_GET['q']);
 310
 311   // error_log("Requested " . $_GET['q'] . " -> $path");
 312
 313   if (is_dir($path)) {
 314     foreach (array('index.php', 'index.html', 'index.htm') as $index) {
 315       if (is_file($path . "/$index")) {
 316         $path .= "/$index";
 317         break;
 318       }
 319     }
 320   }
 321
 322   if (is_file($path)) {
 323     if (preg_match('/.php$/', $path)) {
 324       ob_start();
 325       include $path;
 326       $output = ob_get_contents();
 327       ob_end_clean();
 328     } else {
 329       $output = file_get_contents($path);
 330     }
 331     return $output;
 332   }
 333
 334   drupal_not_found();
 335 }
 336
 337 function theme_planetlab($content) {
 338   return $content;
 339 }
 340
 341 ?>