admins can change nodes to reservable/regular in the node page
[plewww.git] / planetlab / includes / plc_functions.php
index 8309f34..d40de74 100644 (file)
@@ -1,9 +1,14 @@
 <?php
 
-// $Id$
+// install the default timezone as defined in php.ini
+date_default_timezone_set(ini_get('date.timezone'));
 
-// will trash this eventually
-  //require_once 'plc_functions_trash.php';
+# note: this needs to be consistent with the value in Monitor/monitor/wrapper/plc.py
+global $PENDING_CONSORTIUM_ID;
+$PENDING_CONSORTIUM_ID = 0;
+# this one does not matter that much, just picking one
+global $APPROVED_CONSORTIUM_ID;
+$APPROVED_CONSORTIUM_ID = 999999;
 
 // utility
 function my_is_int ($x) {
@@ -19,6 +24,10 @@ function plc_is_pi () {
   global $plc;
   return in_array( 20, $plc->person['role_ids']);
 }
+function plc_is_user () {
+  global $plc;
+  return in_array( 30, $plc->person['role_ids']);
+}
 function plc_is_tech () {
   global $plc;
   return in_array( 40, $plc->person['role_ids']);
@@ -28,11 +37,24 @@ function plc_in_site ($site_id) {
   return in_array( $site_id, $plc->person['site_ids']);
 }
 
+function plc_my_site_ids () {
+  global $plc;
+  return $plc->person['site_ids'];
+}
+function plc_my_sites () {
+  global $plc;
+  global $api;
+  return $api->GetSites($plc->person['site_ids'], array('site_id', 'abbreviated_name'));
+}
+
 function plc_my_site_id () {
   global $plc;
   return $plc->person['site_ids'][0];
 }
 
+function plc_my_person () {
+  return $plc->person;
+}
 function plc_my_person_id () {
   global $plc;
   return $plc->person['person_id'];
@@ -50,17 +72,27 @@ function href ($url,$text) { return "<a href='" . $url . "'>" . $text . "</a>";
 function l_actions ()                  { return "/db/common/actions.php"; }
 // some complex node actions are kept separate, e.g. the ones related to getbootmedium
 function l_actions_download ()         { return "/db/nodes/node_downloads.php"; }
+function l_register_node ()            { return "/registerwizard/index.php"; }
+function l_pcu_add ()                  { return "/registerwizard/index.php/register/stage1_addpcu"; }
+function l_pcu ($pcu_id)               { return "/db/sites/pcu.php?id=$pcu_id"; }
+function l_pcu_href ($pcu_id, $text)           { return href(l_pcu($pcu_id), $text); }
 
 function l_nodes ()                    { return "/db/nodes/index.php"; }
 function l_nodes_peer ($peer_id)       { return "/db/nodes/index.php?peerscope=$peer_id"; }
 function l_node ($node_id)             { return "/db/nodes/node.php?id=$node_id"; }
+function l_node_interfaces ($node_id)  { return "/db/nodes/node.php?id=$node_id%show_details=0&show_interfaces=1"; }
+function l_node_tags ($node_id)                { return "/db/nodes/node.php?id=$node_id%show_details=0&show_tags=1"; }
 function l_node_t ($node_id,$text)     { return href (l_node($node_id),$text); }
 function l_node_obj($node)             { return href(l_node($node['node_id']),$node['hostname']); }
 function l_node_add ()                 { return "/db/nodes/node_add.php"; }
 function l_nodes_site ($site_id)       { return "/db/nodes/index.php?site_id=$site_id"; }
+function l_nodes_my_site ()             { return l_nodes_site(plc_my_site_id()) . "&active_line_tab=My site nodes"; }
+function l_nodes_all_my_site ()         { return l_nodes_person(plc_my_person_id()) . "&active_line_tab=All My site nodes"; }
+function l_nodes_person ($person_id)   { return "/db/nodes/index.php?person_id=$person_id"; }
 function l_nodes_slice ($slice_id)     { return "/db/nodes/index.php?slice_id=$slice_id"; }
 
 function l_interface ($interface_id)   { return "/db/nodes/interface.php?id=$interface_id"; }
+function l_interface_tags($interface_id){ return "/db/nodes/interface.php?id=$interface_id&show_details=0&show_tags=1"; }
 function l_interface_t ($interface_id,$text) { 
                                          return href (l_interface($interface_id),$text); }
 function l_interface_add($node_id)     { return "/db/nodes/interface.php?node_id=$node_id"; }
@@ -74,9 +106,12 @@ function l_site_obj($site)          { return href (l_site($site['site_id']),$site['name'
 function l_slices ()                   { return "/db/slices/index.php"; }
 function l_slices_peer ($peer_id)      { return "/db/slices/index.php?peerscope=$peer_id"; }
 function l_slice ($slice_id)           { return "/db/slices/index.php?id=$slice_id"; }
+function l_slice_nodes ($slice_id)     { return "/db/slices/index.php?id=$slice_id&show_details=0&show_nodes=1&show_nodes_current=1&show_nodes_add=1"; }
 function l_slice_t ($slice_id,$text)   { return href (l_slice($slice_id),$text); }
 function l_slice_add ()                        { return "/db/slices/slice_add.php"; }
 function l_slices_site($site_id)       { return "/db/slices/index.php?site_id=$site_id"; }
+function l_slices_my_site()            { return l_slices_site(plc_my_site_id()) . "&active_line_tab=My site slices"; }
+function l_slices_person($person_id)    { return "/db/slices/index.php?person_id=$person_id"; }
 function l_slices_local()              { return "/db/slices/index.php?peerscope=local"; }
 // from an object
 function l_slice_obj ($slice)          { return l_slice_t ($slice['slice_id'],$slice['name']); }
@@ -85,21 +120,26 @@ function l_sliver ($node_id,$slice_id)     { return "/db/nodes/slivers.php?node_id=$
 function l_sliver_t ($node_id,$slice_id,$text) { 
                                          return href (l_sliver($node_id,$slice_id),$text) ; }
 
-function l_persons ()                  { return "/db/persons/index.php"; }
-function l_persons_peer ($peer_id)     { return "/db/persons/index.php?peerscope=$peer_id"; }
+function l_persons ()                  { return "/db/persons/index.php&active_line_tab=All Accounts"; }
+function l_persons_peer ($peer_id)     { return "/db/persons/index.php?peerscope=$peer_id&active_line_tab=Local Accounts"; }
 function l_person ($person_id)         { return "/db/persons/index.php?id=$person_id"; }
+function l_person_roles ($person_id)   { return "/db/persons/index.php?id=$person_id&show_details=0&show_roles=1"; }
 function l_person_t ($person_id,$text) { return href (l_person($person_id),$text); }
 function l_persons_site ($site_id)     { return "/db/persons/index.php?site_id=$site_id"; }
+function l_persons_slice ($slice_id)   { return "/db/persons/index.php?slice_id=$slice_id"; }
 function l_person_obj ($person)                { return l_person_t($person['person_id'],$person['email']); }
 
 function l_tags ()                     { return "/db/tags/index.php"; }
 function l_tag ($tag_type_id)          { return "/db/tags/index.php?id=$tag_type_id"; }
 function l_tag_obj ($tag)              { return href(l_tag($tag['tag_type_id']),$tag['tagname']); }
+function l_tag_roles ($tag_type_id)    { return "/db/tags/index.php?id=$tag_type_id&show_details=0&show_roles=1"; }
 
 function l_nodegroups ()               { return "/db/tags/nodegroups.php"; }
 function l_nodegroup ($nodegroup_id)   { return "/db/tags/nodegroup.php?id=$nodegroup_id"; }
 function l_nodegroup_t ($nodegroup_id,$text) { 
                                          return href(l_nodegroup($nodegroup_id),$text); }
+function l_nodegroup_obj ($nodegroup) { 
+                                         return href(l_nodegroup($nodegroup['nodegroup_id']),$nodegroup['groupname']); }
 
 function l_events ()                   { return "/db/events/index.php"; }
 function l_event ($type,$param,$id)    { return "/db/events/index.php?type=$type&$param=$id"; }
@@ -122,19 +162,22 @@ function l_reset_password()               { return "/db/persons/reset_password.php"; }
 function l_person_register()           { return "/db/persons/register.php"; }
 function l_site_register()             { return "/db/sites/register.php"; }
 function l_sites_pending()             { return "/db/sites/join_request.php"; }
+function l_site_review_pending($site_id){ return "/db/sites/join_request.php?review=t&site_id=$site_id"; }
 
 
 //////////////////////////////////////////////////////////// nav tabs
 function tab_nodes ()          { return array ('label'=>'All nodes','url'=>l_nodes(), 
                                                'bubble'=>'Display nodes from all peers'); }
 function tab_nodes_local ()    { return array ('label'=>'Local nodes', 'url'=>l_nodes_peer('local'), 
-                                               'bubble'=>'Display local nodes only'); }
+                                               'bubble'=>'Display all nodes local to this peer'); }
 function tab_nodes_site($site_id){ return array ('label'=>'Site nodes', 'url'=>l_nodes_site($site_id), 
                                                 'bubble'=>'Display nodes on that site'); }
 function tab_nodes_slice($slice_id){ return array ('label'=>'Slice nodes', 'url'=>l_nodes_slice($slice_id), 
                                                 'bubble'=>'Display nodes for that slice'); }
-function tab_nodes_mysite ()   { return array ('label'=>'My nodes', 'url'=>l_nodes_site(plc_my_site_id()), 
+function tab_nodes_mysite ()   { return array ('label'=>'My site nodes', 'url'=>l_nodes_my_site(), 
                                                'bubble'=>'Display nodes on my site'); }
+function tab_nodes_all_mysite (){ return array ('label'=>'All My site nodes', 'url'=>l_nodes_all_my_site(),
+                                               'bubble'=>'Display nodes on all my sites'); }
 function tab_node($node)       { return array ('label'=>'Node '.$node['hostname'], 'url'=>l_node($node['node_id']),
                                                'bubble'=>'Details for ' . $node['hostname']); }
 //////////
@@ -144,24 +187,24 @@ function tab_mysite()             { return array ('label'=>'My site', 'url'=>l_site(plc_my_
                                                'bubble'=>'Details for site ' . plc_my_site_id()); }
 function tab_sites ()          { return array ('label'=>'All sites' , 'url'=>l_sites(), 'bubble'=> 'Display all sites'); }
 function tab_sites_local ()    { return array ('label'=>'Local sites' , 'url'=>l_sites_peer('local'), 
-                                               'bubble'=> 'Display local sites'); }
+                                               'bubble'=> 'Display all siteslocal to this peer'); }
 //////////
 function tab_slices()          { return array ('label'=>'All slices', 'url'=>l_slices(),
                                                'bubble' => 'Display all slices'); }
-function tab_slices_mysite ()  { return array ('label'=>'My site slices', 'url'=>l_slices_site(plc_my_site_id()), 
-                                               'bubble'=>'Display all slices on my site'); }
-function tab_slices_mine ()    { return array ('label'=>'My site slices', 'url'=>l_slices_site(plc_my_site_id()), 
+function tab_slices_person()   { return array ('label'=>'My slices', 'url'=>l_slices_person(plc_my_person_id()),
+                                               'bubble' => 'Display my all slices'); }
+function tab_slices_mysite ()  { return array ('label'=>'My site slices', 'url'=>l_slices_my_site(), 
                                                'bubble'=>'Display all slices on my site'); }
 function tab_slices_local ()   { return array ('label'=>'Local slices', 'url'=>l_slices_local(), 
-                                               'bubble'=>'Display all slices on my site'); }
+                                               'bubble'=>'Display all slices local to this peer'); }
 function tab_slice($slice)     { return array ('label'=>'Slice '.$slice['name'], 'url'=>l_slice($slice['slice_id']),
                                                'bubble' => 'Details for ' . $slice['name']); }
 //////////
-function tab_persons()         { return array ('label'=>'All accounts', 'url'=>l_persons(),
+function tab_persons()         { return array ('label'=>'All Accounts', 'url'=>l_persons(),
                                                'bubble'=>'Display users from all peers'); }
-function tab_persons_local()   { return array ('label'=>'Local accounts', 'url'=>l_persons_peer('local'),
-                                               'bubble'=>'Display local users'); }
-function tab_persons_mysite()  { return array ('label'=>'My accounts' , 'url'=>l_persons_site(plc_my_site_id()),
+function tab_persons_local()   { return array ('label'=>'Local Accounts', 'url'=>l_persons_peer('local'),
+                                               'bubble'=>'Display all users local to this peer'); }
+function tab_persons_mysite()  { return array ('label'=>'My site accounts' , 'url'=>l_persons_site(plc_my_site_id()),
                                                'bubble'=>'Display accounts on site ' . plc_my_site_id()); }
 function tab_person($person)   { return array ('label'=>'Account '.$person['email'], 'url'=>l_person($person['person_id']),
                                                'bubble'=>'Details for ' . $person['email']); }
@@ -175,7 +218,7 @@ function tab_nodegroups()   { return array ('label'=>'Nodegroups', 'url'=>l_nodegr
 function tablook_event()       { return array('image'=>'/planetlab/icons/event.png','height'=>18);}
 function tablook_comon()       { return array('image'=>'/planetlab/icons/comon.png','height'=>18);}
 
-////////////////////
+
 
 //////////////////////////////////////////////////////////// validation functions
 function topdomain ($hostname) {
@@ -183,24 +226,27 @@ function topdomain ($hostname) {
   return $exploded[0];
 }
 
-function is_valid_email_addr ($email) {
-  if (ereg("^.+@.+\\..+$", $email) ) {
-    return true;
-  } else {
-    return false;
-  }
-}
-
-function is_valid_url ($url) {
-  if (ereg("^(http|https)://.+\..+$", strtolower($url) ) ) {
-    return true;
-  } else {
-    return false;
-  }
-}
+//// with php-5.3 on f12, ereg is marked deprecated, using PCRE instead
+//// looks unused
+// function is_valid_email_addr ($email) {
+//  if (preg_match("/^.+@.+\\..+$/", $email) ) {
+//    return true;
+//  } else {
+//    return false;
+//  }
+//}
+//
+//// looks unused
+//function is_valid_url ($url) {
+//  if (preg_match("/^(http|https):\/\/.+\..+$/", strtolower($url) ) ) {
+//    return true;
+//  } else {
+//    return false;
+//  }
+//}
 
 function is_valid_ip ($ip) {
-  if (ereg("^([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})$", $ip ) ) {
+  if (preg_match("/^([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})$/", $ip ) ) {
       // it's at least in the right format, now check to see if
       // each part is equal to less than 255
       $parts= explode( '.', $ip );
@@ -268,6 +314,19 @@ function plc_role_global_hash ($api) {
   return $hash;
 }
 
+// because GetRoles does not correctly support filters, it's really painful to do this
+function sort_roles ($r1, $r2) { return $r2['role_id'] - $r1['role_id']; }
+function roles_except ($roles, $exception_ids) {
+  $result=array();
+  if ($roles) foreach ($roles as $role) {
+      if ( ! in_array ($role['role_id'],$exception_ids) ) {
+       $result[]=$role;
+      }
+    }
+  usort($result,sort_roles);
+  return $result;
+}
+
 //////////////////////////////////////////////////////////// nodegroups
 // hash by 'tagname=value'
 function plc_nodegroup_global_hash ($api,$tagnames=NULL) {
@@ -315,12 +374,42 @@ function plc_itemize ($messages, $class="") {
   return $formatted;
 }
 
-function plc_error ($text) {
-  // should use the same channel as the php errors..
-  print "<div class='plc-error'> Error " . $text . "</div>";
+////////// just return a truncated text
+function truncate ($text,$numb,$etc = "...") {
+  if (strlen($text) <= $numb)  return $text;
+  return substr($text, 0, $numb).$etc;
+}
+// ditto but in case the text is too lare, returns a <span> with its 'title' set to the full value
+function truncate_and_popup ($text,$numb,$etc = "...") {
+  if (strlen($text) <= $numb)  return $text;
+  $display=substr($text, 0, $numb).$etc;
+  return sprintf("<span title='%s'>%s</span>",$text,$display);
+}
+  
+// generates <(atom) class=(class)> (text) </(atom)>
+function html_atom ($atom,$text,$class="") {
+  $html="<$atom";
+  if ($class) $html .= " class='$class'";
+  $html .= ">$text</$atom>";
+  return $html;
+}
+function html_div ($text,$class="") { return html_atom ('div',$text,$class); }
+function html_span ($text,$class="") { return html_atom ('span',$text,$class); }
+
+// should use the same channel as the php errors..
+function plc_error_html ($text)                { return  html_div ($text,'plc-error'); }
+function plc_error ($text)             { print plc_error_html ("Error " . $text); }
+
+function errors_init() { return array();}
+function errors_record ($adm, $errors) {
+  if ($adm->error()) {
+    $tmp=$adm->error();
+    $errors []= $tmp;
+  }
+  return $errors;
 }
 
-function plc_errors ($errors) {
+function errors_display ($errors) {
   if ($errors) {
     print( "<div class='plc-error'>" );
     print( "<p>The following errors occured:</p>" );
@@ -331,29 +420,50 @@ function plc_errors ($errors) {
   }
 }
 
-function plc_warning_html ($text)      { return "<span class='plc-warning'>" . $text . "</span>";}
+function plc_warning_html ($text)      { return html_span($text,'plc-warning'); }
 function plc_warning ($text)           { print plc_warning_html("Warning " . $text); }
-function plc_foreign_html($text)       { return "<span class=plc-foreign>$text</span>"; }
+
+function bold_html ($text)             { return html_span($text,'bold'); }
 
 // shows a php variable verbatim with a heading message
 function plc_debug ($message,$object) {
-  print "<br>" . $message . "<pre>";
+  print "<br />" . $message . "<pre>";
   print_r ($object);
   print "</pre>";
 }
 
-function truncate ($text,$numb,$etc = "...") {
-  if (strlen($text) > $numb) {
-    $text = substr($text, 0, $numb);
-    $text = $text.$etc;
-  }
-  return $text;
+function plc_debug_txt ($message,$txt) {
+  print "<br />" . $message . "<pre>";
+  $txt=str_replace(" ","&lt;SPC&gt;",$txt);
+  $txt=str_replace("\t","&lt;TAB&gt;",$txt);
+  $txt=str_replace("\n","&lt;LF&gt;",$txt);
+  $txt=str_replace("\r","&lt;CR&gt;",$txt);
+  print $txt . "&lt;EOF&gt;";
+  print "</pre>";
 }
-function html_div ($text,$class="") {
-  $html="<div";
-  if ($class) $html .= " class='$class'";
-  $html .= ">$text</div>";
-  return $html;
+
+$plc_prof_start=0.;
+$plc_prof_time=0.;
+$plc_prof_counter=0;
+function plc_debug_prof_start () {
+  global $plc_prof_counter, $plc_prof_start, $plc_prof_time;
+  $plc_prof_counter=0;
+  plc_debug(strftime("[0] %T (start)") ,"heating up");
+  $plc_prof_time=microtime(true);
+  $plc_prof_start=$plc_prof_time;
+}
+function plc_debug_prof ($message,$object) {
+  global $plc_prof_counter, $plc_prof_start, $plc_prof_time;
+  $plc_prof_counter+=1;
+  $now=microtime(true);
+  $timelabel=strftime("%T");
+  $prof_message=sprintf("[%d] %s (%2.3f s -- %2.3f s) ",$plc_prof_counter,$timelabel,
+                       ($now-$plc_prof_time),($now-$plc_prof_start));
+  plc_debug($prof_message.$message,$object);
+  $plc_prof_time=$now;
+}
+function plc_debug_prof_end () {
+  plc_debug_prof ("end","cooling down");
 }
 
 if (! function_exists ("drupal_set_error")) {
@@ -369,6 +479,10 @@ function plc_delete_icon($width=15) {
   return "<img width='$width' src='/planetlab/icons/delete.png'>";
 }
 
+function plc_add_icon($width=15) {
+  return "<img width='$width' src='/planetlab/icons/add.png'>";
+}
+
 function plc_bubble($text,$bubble) {
   return "<span title='$bubble'>$text</span>";
 }
@@ -396,6 +510,27 @@ function plc_redirect ($url) {
   exit ();
 }
 
+//////////////////// the options for an nodetype - suitable for plekit/form
+global $builtin_node_types;
+$builtin_node_types = array ( "regular" => "Regular/Shared",
+                             "reservable" => "Reservable (requires to get leases)");
+function node_type_display ($api, $node_type) {
+  global $builtin_node_types;
+  $val=$builtin_node_types[$node_type];
+  if ( ! $val) $val="??undefined??";
+  return $val;
+}
+
+function node_type_selectors ($api,$node_type) {
+  global $builtin_node_types;
+  foreach ($builtin_node_types as $value=>$display) {
+    $selector=array('display'=>$display, 'value'=>$value);
+    if ($value == $node_type) $selector['selected']=true;
+    $selectors []= $selector;
+  }
+  return $selectors;
+}
+
 //////////////////// the options for an interface - suitable for plekit/form
 //>>> GetNetworkMethods()
 //[u'static', u'dhcp', u'proxy', u'tap', u'ipmi', u'unknown']
@@ -419,6 +554,14 @@ function interface_method_selectors ($api, $method, $primary) {
   return $selectors;
 }
 
+// displays bandwidth with kbps Mbps Gbps as needed
+function pretty_bandwidth ($bw) {
+  if ($bw < 1000)              return $bw;
+  if ($bw < 1000000)           return strval($bw/1000) . " kbps";
+  if ($bw < 1000000000)                return strval($bw/1000000) . " Mbps";
+  else                         return strval($bw/1000000000) . " Gbps";
+}
+
 //////////////////// 
 function instantiation_label ($slice) {
   $instantiation_labels = array ('not-instantiated'=>'NOT',
@@ -451,4 +594,10 @@ function count_english_warning ($objs, $name) {
   if (count ($objs) == 0) $x=plc_warning_html($x . ' !!');
   return $x;
 }
+
+//////////////////// outlining reservable nodes
+function reservable_mark () { return "-R-";}
+function reservable_legend () { return "reservable nodes are marked with " . reservable_mark (); }
+
+
 ?>