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: planetlab.module 809 2007-09-03 09:47:40Z thierry $
   9   //
  10
  11 require_once 'plc_config.php';
  12 require_once 'plc_session.php';
  13
  14 function planetlab_help($section)
  15 {
  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 {
  24   $info['name'] = 'PlanetLab';
  25
  26   if ($field) {
  27     return $info[$field];
  28   }
  29   else {
  30     return $info;
  31   }
  32 }
  33
  34 function planetlab_menu($may_cache)
  35 {
  36   $items = array();
  37
  38   if ($may_cache) {
  39     $items[] = array(
  40                      'path' => 'planetlab/logout',
  41                      'title' => t('Log out of %s', array('%s' => variable_get('site_name', 'local'))),
  42                      'callback' => 'planetlab_logout',
  43                      'access' => TRUE,
  44                      'type' => MENU_CALLBACK
  45                      );
  46     $items[] = array(
  47                      'path' => 'db',
  48                      'title' => variable_get('site_name', 'local'),
  49                      'callback' => 'planetlab_page',
  50                      'access' => TRUE,
  51                      'type' => MENU_CALLBACK
  52                      );
  53   }
  54
  55   return $items;
  56 }
  57
  58 function planetlab_block($op = 'list', $delta = 0, $edit = array())
  59 {
  60   global $user, $plc;
  61
  62   if ($op == 'list') {
  63     $blocks[0]['info'] = t('PlanetLab login');
  64
  65     return $blocks;
  66   }
  67   else if ($op == 'view') {
  68     $block = array();
  69
  70     if (!$plc->person) {
  71       // Force login via HTTPS
  72       unset($_GET['time']);
  73       $form['#action'] = "https://" . $_SERVER['HTTP_HOST'] . url($_GET['q'], drupal_get_destination());
  74       $form['#id'] = 'planetlab-login-form';
  75       $form['name'] = array('#type' => 'textfield',
  76                             '#title' => t('E-mail'),
  77                             '#maxlength' => 60,
  78                             '#size' => 25,
  79                             '#required' => TRUE,
  80                             );
  81       $form['pass'] = array('#type' => 'password',
  82                             '#title' => t('Password'),
  83                             '#size' => 25,
  84                             '#required' => TRUE,
  85                             );
  86       $form['submit'] = array('#type' => 'submit',
  87                               '#value' => t('Log in'),
  88                               );
  89
  90       $block['subject'] = t('%s login', array('%s' => variable_get('site_name', 'local')));
  91       $block['content'] = drupal_get_form('planetlab_login_block', $form, 'planetlab_login');
  92       $block['content'] .= '<p><p><a href="/db/persons/reset_password.php">Forgot your password?</a></p>';
  93       $block['content'] .= '<p><a href="/db/persons/register.php">Create an account</a></p>';
  94       $block['content'] .= '<p><a href="/db/sites/register.php">File a site registration</a></p>';
  95     } else {
  96       $block['subject'] = $plc->person['email'];
  97       $is_admin = in_array(10,$plc->person['role_ids']);
  98       $is_pi =    in_array(20,$plc->person['role_ids']);
  99       $is_user =  in_array(30,$plc->person['role_ids']);
 100       $is_tech =  in_array(40,$plc->person['role_ids']);
 101
 102       $site_item = '';
 103       $site_item .= '<a href="/db/sites/">Sites</a>';
 104       $site_item .= '<ul>';
 105       $site_item .= '<li><a href="/db/sites/index.php?id='. $plc->person['site_ids'][0] .'">My Site</a></li>';
 106       if ( $is_admin )
 107         $site_item .= "<li><a href='/db/sites/join_request.php'>Join Requests</a></li>";
 108       if( $is_admin )
 109         $site_item .= "<li><a href='/db/sites/peers.php'>Migration Status</a></li>";
 110       $site_item .= "</ul>";
 111       $items[] = $site_item;
 112
 113       $user_item = '';
 114       $user_item .= '<a href="/db/persons/">Users</a>';
 115       $user_item .= '<ul>';
 116       $user_item .= '<li><a href="/db/persons/index.php?id='. $plc->person['person_id'] .'">My account</a></li>';
 117       if (is_pi)
 118         $user_item .= '<li><a href="/db/persons/index.php?site_id='. $plc->person['site_ids'][0] .'">My users</a></li>';
 119       if ( $plc->alt_person && $plc->alt_auth) {
 120         $email = $plc->person['email'];
 121         $user_item .= "<li><a href='/db/sulogout.php'>Log out of $email </a></li>";
 122       }
 123
 124
 125       $user_item .= '</ul>';
 126       $items [] = $user_item;
 127
 128       $node_item = '';
 129       $node_item .= '<a href="/db/nodes/">Nodes</a>';
 130       $node_item .= '<ul>';
 131       $node_item .= '<li><a href="/db/nodes/index.php?site_id='. $plc->person['site_ids'][0] .'">My Site Nodes</a></li>';
 132       if( $is_admin || $is_pi || $is_user )
 133         $node_item .= "<li><a href='/db/nodes/add_node.php'>Add Node</a></li>";
 134       if ( $is_admin)
 135         $node_item .= "<li> <a href='/db/nodes/settings.php'> Setting Types </a> </li>";
 136       $node_item .= '</ul>';
 137       $items [] = $node_item;
 138
 139       $slice_item = '';
 140       //if( !( $is_tech && ! $is_user && ! $is_pi && ! $is_admin ) )
 141       $slice_item .= '<a href="/db/slices/">Slices</a>';
 142       $slice_item .= '<ul>';
 143       if( $is_admin || $is_pi ) {
 144         $slice_item .= "<li><a href='/db/slices/add_slice.php'>Create Slice</a></li>";
 145         $slice_item .= "<li><a href='/db/slices/attributes.php'>Attribute Types</a></li>";
 146       }
 147       if( !( $is_tech && ! $is_user && ! $is_pi && ! $is_admin ) )
 148         $slice_item .= '<li><a href="/db/sirius/index.php">Sirius</a></li>';
 149       $slice_item .= '</ul>';
 150       $items [] = $slice_item;
 151
 152       if ( $is_admin )
 153         $items[] = l(t('Peers'),'db/peers/');
 154
 155       if ( $is_admin )
 156         $items[] = l(t('Events'),'db/events/');
 157
 158       $items[] = l(t('About'),'db/about.php');
 159
 160       if ($user->uid) {
 161         // Drupal logout (destroys the session and cleans up $user)
 162         $items[] = l(t('Log out of %s', array('%s' => variable_get('site_name', 'local'))), 'logout');
 163       } else {
 164         // PlanetLab logout (just destroy the session)
 165         $items[] = l(t('Log out'), 'planetlab/logout');
 166       }
 167
 168       $block['content'] = theme('item_list', $items);
 169     }
 170
 171     /*
 172      ob_start();
 173      print '<pre>';
 174      print_r($_SESSION);
 175      print '</pre>';
 176      $block['content'] .= ob_get_contents();
 177      ob_end_clean();
 178     */
 179
 180     return $block;
 181   }
 182 }
 183
 184 function planetlab_login_validate($form_id, $form_values)
 185 {
 186   global $user, $plc;
 187
 188   if ($form_values['name'] && $form_values['pass']) {
 189     // Drupal login succeeded
 190     if (($user = user_authenticate($form_values['name'], trim($form_values['pass']))) &&
 191         $user->uid) {
 192       return;
 193     }
 194
 195     $plc = new PLCSession($form_values['name'], $form_values['pass']);
 196
 197     // PlanetLab login failed
 198     if (!$plc->person) {
 199       form_set_error('login', t('Sorry. Unrecognized username or password.'));
 200       watchdog('planetlab', t('Login attempt failed for %user.', array('%user' => theme('placeholder', $form_values['name']))));
 201     }
 202
 203     // PlanetLab login succeeded
 204     else {
 205       // Login admins to Drupal as the superuser
 206       if (in_array('admin', $plc->person['roles'])) {
 207         $user = user_load(array('uid' => 1));
 208       }
 209     }
 210   }
 211 }
 212
 213 function planetlab_login_submit($form_id, $form_values)
 214 {
 215   global $plc;
 216
 217   // Our referring page is encased in a query string of the form
 218   // "destination=referrer".
 219   parse_str(drupal_get_destination()); // => $destination
 220
 221   // The referrer itself is a URL path with the original query string,
 222   // e.g. "referer.php?query".
 223   extract(parse_url($destination)); // => $query
 224
 225   // Which we then have to parse again as a query string.
 226   parse_str($query); // => $url
 227
 228   if ($plc->person) {
 229     // To handle the edge case where this function is called during a
 230     // bootstrap, check for the existence of t().
 231     if (function_exists('t')) {
 232       $message = t('Session opened for %name.', array('%name' => theme('placeholder', $plc->person['email'])));
 233     }
 234     else {
 235       $message = "Session opened for ". check_plain($person['email']);
 236     }
 237     watchdog('planetlab', $message);
 238
 239     if (empty($url)) {
 240       // Create a timestamped final URL so that browsers don't return the user to
 241       // a cached page (where it would appear as if they never logged in or out).
 242       return array('time='. time());
 243     } else {
 244       // Make sure that redirections are always local
 245       $url = urldecode($url);
 246       if ($url[0] != "/") {
 247         $url = "/$url";
 248       }
 249       Header("Location: $url");
 250       exit();
 251     }
 252   }
 253 }
 254
 255 function planetlab_logout()
 256 {
 257   global $plc;
 258
 259   if ($plc->person) {
 260     // Invalidate PlanetLab session
 261     $plc->logout();
 262     watchdog('planetlab', t('Session closed for %name.', array('%name' => theme('placeholder', $plc->person['email']))));
 263   }
 264
 265   // Destroy the current session:
 266   session_destroy();
 267
 268   // The time prevents caching.
 269   drupal_goto(NULL, 'time='. time());
 270 }
 271
 272 function planetlab_user($type, &$edit, &$user, $category = NULL)
 273 {
 274   switch ($type) {
 275   case 'logout':
 276     if ($plc->person) {
 277       $plc->logout();
 278       watchdog('planetlab', t('Session closed for %name.', array('%name' => theme('placeholder', $plc->person['email']))));
 279     }
 280     break;
 281   }
 282 }
 283
 284 function planetlab_page()
 285 {
 286   $path = $_SERVER['DOCUMENT_ROOT'] . preg_replace('/^db\//', '/planetlab/', $_GET['q']);
 287
 288   // error_log("Requested " . $_GET['q'] . " -> $path");
 289
 290   if (is_dir($path)) {
 291     foreach (array('index.php', 'index.html', 'index.htm') as $index) {
 292       if (is_file($path . "/$index")) {
 293         $path .= "/$index";
 294         break;
 295       }
 296     }
 297   }
 298
 299   if (is_file($path)) {
 300     if (preg_match('/.php$/', $path)) {
 301       ob_start();
 302       include $path;
 303       $output = ob_get_contents();
 304       ob_end_clean();
 305     } else {
 306       $output = file_get_contents($path);
 307     }
 308     return $output;
 309   }
 310
 311   drupal_not_found();
 312 }
 313
 314 function theme_planetlab($content)
 315 {
 316   return $content;
 317 }
 318
 319 ?>