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