3 // install the default timezone as defined in php.ini
4 date_default_timezone_set(ini_get('date.timezone'));
6 # note: this needs to be consistent with the value in Monitor/monitor/wrapper/plc.py
7 global $PENDING_CONSORTIUM_ID;
8 $PENDING_CONSORTIUM_ID = 0;
9 # this one does not matter that much, just picking one
10 global $APPROVED_CONSORTIUM_ID;
11 $APPROVED_CONSORTIUM_ID = 999999;
14 function my_is_int ($x) {
15 return (is_numeric($x) ? intval($x) == $x : false);
18 //////////////////////////////////////////////////////////// roles & other checks on global $plc
19 function plc_is_admin () {
21 return in_array( 10, $plc->person['role_ids']);
23 function plc_is_pi () {
25 return in_array( 20, $plc->person['role_ids']);
27 function plc_is_user () {
29 return in_array( 30, $plc->person['role_ids']);
31 function plc_is_tech () {
33 return in_array( 40, $plc->person['role_ids']);
35 function plc_in_site ($site_id) {
37 return in_array( $site_id, $plc->person['site_ids']);
40 function plc_my_site_ids () {
42 return $plc->person['site_ids'];
44 function plc_my_sites () {
47 return $api->GetSites($plc->person['site_ids'], array('site_id', 'abbreviated_name'));
50 function plc_my_site_id () {
52 return $plc->person['site_ids'][0];
55 function plc_my_person () {
58 function plc_my_person_id () {
60 return $plc->person['person_id'];
63 //////////////////////////////////////////////////////////// links
64 function href ($url,$text) { return "<a href='" . $url . "'>" . $text . "</a>"; }
67 // l_objects() -> the url to the page that list objects
68 // l_object($object_id) -> the url to hte page thas details object with given id
69 // l_object_t($object_id,text) -> an <a> tag that shows text and links to the above
70 // l_object_add () -> the url to that object-afding page
72 function l_actions () { return "/db/common/actions.php"; }
73 // some complex node actions are kept separate, e.g. the ones related to getbootmedium
74 function l_actions_download () { return "/db/nodes/node_downloads.php"; }
75 function l_register_node () { return "/registerwizard/index.php"; }
76 function l_pcu_add () { return "/registerwizard/index.php/register/stage1_addpcu"; }
77 function l_pcu ($pcu_id) { return "/db/sites/pcu.php?id=$pcu_id"; }
79 function l_nodes () { return "/db/nodes/index.php"; }
80 function l_nodes_peer ($peer_id) { return "/db/nodes/index.php?peerscope=$peer_id"; }
81 function l_node ($node_id) { return "/db/nodes/node.php?id=$node_id"; }
82 function l_node_interfaces ($node_id) { return "/db/nodes/node.php?id=$node_id%show_details=0&show_interfaces=1"; }
83 function l_node_tags ($node_id) { return "/db/nodes/node.php?id=$node_id%show_details=0&show_tags=1"; }
84 function l_node_t ($node_id,$text) { return href (l_node($node_id),$text); }
85 function l_node_obj($node) { return href(l_node($node['node_id']),$node['hostname']); }
86 function l_node_add () { return "/db/nodes/node_add.php"; }
87 function l_nodes_site ($site_id) { return "/db/nodes/index.php?site_id=$site_id"; }
88 function l_nodes_my_site () { return l_nodes_site(plc_my_site_id()) . "&active_line_tab=My site nodes"; }
89 function l_nodes_all_my_site () { return l_nodes_person(plc_my_person_id()) . "&active_line_tab=All My site nodes"; }
90 function l_nodes_person ($person_id) { return "/db/nodes/index.php?person_id=$person_id"; }
91 function l_nodes_slice ($slice_id) { return "/db/nodes/index.php?slice_id=$slice_id"; }
93 function l_interface ($interface_id) { return "/db/nodes/interface.php?id=$interface_id"; }
94 function l_interface_tags($interface_id){ return "/db/nodes/interface.php?id=$interface_id&show_details=0&show_tags=1"; }
95 function l_interface_t ($interface_id,$text) {
96 return href (l_interface($interface_id),$text); }
97 function l_interface_add($node_id) { return "/db/nodes/interface.php?node_id=$node_id"; }
99 function l_sites () { return "/db/sites/index.php"; }
100 function l_sites_peer ($peer_id) { return "/db/sites/index.php?peerscope=$peer_id"; }
101 function l_site ($site_id) { return "/db/sites/index.php?id=$site_id"; }
102 function l_site_t ($site_id,$text) { return href (l_site($site_id),$text); }
103 function l_site_obj($site) { return href (l_site($site['site_id']),$site['name']); }
105 function l_slices () { return "/db/slices/index.php"; }
106 function l_slices_peer ($peer_id) { return "/db/slices/index.php?peerscope=$peer_id"; }
107 function l_slice ($slice_id) { return "/db/slices/index.php?id=$slice_id"; }
108 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"; }
109 function l_slice_t ($slice_id,$text) { return href (l_slice($slice_id),$text); }
110 function l_slice_add () { return "/db/slices/slice_add.php"; }
111 function l_slices_site($site_id) { return "/db/slices/index.php?site_id=$site_id"; }
112 function l_slices_my_site() { return l_slices_site(plc_my_site_id()) . "&active_line_tab=My site slices"; }
113 function l_slices_person($person_id) { return "/db/slices/index.php?person_id=$person_id"; }
114 function l_slices_local() { return "/db/slices/index.php?peerscope=local"; }
116 function l_slice_obj ($slice) { return l_slice_t ($slice['slice_id'],$slice['name']); }
118 function l_sliver ($node_id,$slice_id) { return "/db/nodes/slivers.php?node_id=$node_id&slice_id=$slice_id"; }
119 function l_sliver_t ($node_id,$slice_id,$text) {
120 return href (l_sliver($node_id,$slice_id),$text) ; }
122 function l_persons () { return "/db/persons/index.php&active_line_tab=All Accounts"; }
123 function l_persons_peer ($peer_id) { return "/db/persons/index.php?peerscope=$peer_id&active_line_tab=Local Accounts"; }
124 function l_person ($person_id) { return "/db/persons/index.php?id=$person_id"; }
125 function l_person_roles ($person_id) { return "/db/persons/index.php?id=$person_id&show_details=0&show_roles=1"; }
126 function l_person_t ($person_id,$text) { return href (l_person($person_id),$text); }
127 function l_persons_site ($site_id) { return "/db/persons/index.php?site_id=$site_id"; }
128 function l_persons_slice ($slice_id) { return "/db/persons/index.php?slice_id=$slice_id"; }
129 function l_person_obj ($person) { return l_person_t($person['person_id'],$person['email']); }
131 function l_tags () { return "/db/tags/index.php"; }
132 function l_tag ($tag_type_id) { return "/db/tags/index.php?id=$tag_type_id"; }
133 function l_tag_obj ($tag) { return href(l_tag($tag['tag_type_id']),$tag['tagname']); }
134 function l_tag_roles ($tag_type_id) { return "/db/tags/index.php?id=$tag_type_id&show_details=0&show_roles=1"; }
136 function l_nodegroups () { return "/db/tags/nodegroups.php"; }
137 function l_nodegroup ($nodegroup_id) { return "/db/tags/nodegroup.php?id=$nodegroup_id"; }
138 function l_nodegroup_t ($nodegroup_id,$text) {
139 return href(l_nodegroup($nodegroup_id),$text); }
140 function l_nodegroup_obj ($nodegroup) {
141 return href(l_nodegroup($nodegroup['nodegroup_id']),$nodegroup['groupname']); }
143 function l_events () { return "/db/events/index.php"; }
144 function l_event ($type,$param,$id) { return "/db/events/index.php?type=$type&$param=$id"; }
146 function l_peers() { return "/db/peers/index.php"; }
147 function l_peer($peer_id) { return "/db/peers/index.php?id=$peer_id"; }
148 function l_peer_t($peer_id,$text) { return href(l_peer($peer_id),$text); }
150 function l_comon($id_name,$id_value) { return "/db/nodes/comon.php?$id_name=$id_value"; }
151 function l_sirius() { return "/db/sirius/index.php"; }
152 function l_about() { return "/db/common/about.php"; }
153 function l_doc_plcapi() { return "/db/doc/PLCAPI.php"; }
154 function l_doc_nmapi() { return "/db/doc/NMAPI.php"; }
155 function l_admin() { return "/db/common/adminsearch.php"; }
157 function l_login() { return "/db/common/login.php"; }
158 function l_logout() { return "/planetlab/common/logout.php"; }
159 function l_sulogout() { return "/planetlab/common/sulogout.php"; }
160 function l_reset_password() { return "/db/persons/reset_password.php"; }
161 function l_person_register() { return "/db/persons/register.php"; }
162 function l_site_register() { return "/db/sites/register.php"; }
163 function l_sites_pending() { return "/db/sites/join_request.php"; }
164 function l_site_review_pending($site_id){ return "/db/sites/join_request.php?review=t&site_id=$site_id"; }
167 //////////////////////////////////////////////////////////// nav tabs
168 function tab_nodes () { return array ('label'=>'All nodes','url'=>l_nodes(),
169 'bubble'=>'Display nodes from all peers'); }
170 function tab_nodes_local () { return array ('label'=>'Local nodes', 'url'=>l_nodes_peer('local'),
171 'bubble'=>'Display all nodes local to this peer'); }
172 function tab_nodes_site($site_id){ return array ('label'=>'Site nodes', 'url'=>l_nodes_site($site_id),
173 'bubble'=>'Display nodes on that site'); }
174 function tab_nodes_slice($slice_id){ return array ('label'=>'Slice nodes', 'url'=>l_nodes_slice($slice_id),
175 'bubble'=>'Display nodes for that slice'); }
176 function tab_nodes_mysite () { return array ('label'=>'My site nodes', 'url'=>l_nodes_my_site(),
177 'bubble'=>'Display nodes on my site'); }
178 function tab_nodes_all_mysite (){ return array ('label'=>'All My site nodes', 'url'=>l_nodes_all_my_site(),
179 'bubble'=>'Display nodes on all my sites'); }
180 function tab_node($node) { return array ('label'=>'Node '.$node['hostname'], 'url'=>l_node($node['node_id']),
181 'bubble'=>'Details for ' . $node['hostname']); }
183 function tab_site($site) { return array ('label'=>'Site '.$site['login_base'], 'url'=>l_site($site['site_id']),
184 'bubble'=>'Details for ' . $site['name']); }
185 function tab_mysite() { return array ('label'=>'My site', 'url'=>l_site(plc_my_site_id()),
186 'bubble'=>'Details for site ' . plc_my_site_id()); }
187 function tab_sites () { return array ('label'=>'All sites' , 'url'=>l_sites(), 'bubble'=> 'Display all sites'); }
188 function tab_sites_local () { return array ('label'=>'Local sites' , 'url'=>l_sites_peer('local'),
189 'bubble'=> 'Display all siteslocal to this peer'); }
191 function tab_slices() { return array ('label'=>'All slices', 'url'=>l_slices(),
192 'bubble' => 'Display all slices'); }
193 function tab_slices_person() { return array ('label'=>'My slices', 'url'=>l_slices_person(plc_my_person_id()),
194 'bubble' => 'Display my all slices'); }
195 function tab_slices_mysite () { return array ('label'=>'My site slices', 'url'=>l_slices_my_site(),
196 'bubble'=>'Display all slices on my site'); }
197 function tab_slices_local () { return array ('label'=>'Local slices', 'url'=>l_slices_local(),
198 'bubble'=>'Display all slices local to this peer'); }
199 function tab_slice($slice) { return array ('label'=>'Slice '.$slice['name'], 'url'=>l_slice($slice['slice_id']),
200 'bubble' => 'Details for ' . $slice['name']); }
202 function tab_persons() { return array ('label'=>'All Accounts', 'url'=>l_persons(),
203 'bubble'=>'Display users from all peers'); }
204 function tab_persons_local() { return array ('label'=>'Local Accounts', 'url'=>l_persons_peer('local'),
205 'bubble'=>'Display all users local to this peer'); }
206 function tab_persons_mysite() { return array ('label'=>'My site accounts' , 'url'=>l_persons_site(plc_my_site_id()),
207 'bubble'=>'Display accounts on site ' . plc_my_site_id()); }
208 function tab_person($person) { return array ('label'=>'Account '.$person['email'], 'url'=>l_person($person['person_id']),
209 'bubble'=>'Details for ' . $person['email']); }
211 function tab_tags() { return array ('label'=>'Tag Types', 'url'=>l_tags(),
212 'bubble' => 'Display and create tag types'); }
213 function tab_nodegroups() { return array ('label'=>'Nodegroups', 'url'=>l_nodegroups(),
214 'bubble' => 'Display and create nodegroups'); }
217 function tablook_event() { return array('image'=>'/planetlab/icons/event.png','height'=>18);}
218 function tablook_comon() { return array('image'=>'/planetlab/icons/comon.png','height'=>18);}
222 //////////////////////////////////////////////////////////// validation functions
223 function topdomain ($hostname) {
224 $exploded=array_reverse(explode(".",$hostname));
228 //// with php-5.3 on f12, ereg is marked deprecated, using PCRE instead
230 // function is_valid_email_addr ($email) {
231 // if (preg_match("/^.+@.+\\..+$/", $email) ) {
239 //function is_valid_url ($url) {
240 // if (preg_match("/^(http|https):\/\/.+\..+$/", strtolower($url) ) ) {
247 function is_valid_ip ($ip) {
248 if (preg_match("/^([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})$/", $ip ) ) {
249 // it's at least in the right format, now check to see if
250 // each part is equal to less than 255
251 $parts= explode( '.', $ip );
252 $count= count($parts);
254 for( $i= 0; $i < $count; $i++ ) {
255 if( intval($parts[$i]) > 255 )
265 function is_valid_network_addr($network_addr,$mask) {
266 $lNetwork= ip2long($network_addr);
267 $lMask= ip2long($mask);
269 // are they the correct format?
270 if( $lNetwork == -1 || $lMask == -1 )
273 // is network address valid for the mask?
274 if( ($lNetwork & $lMask) != $lNetwork )
281 // returns whether or not a network address is in the reserved space
282 // in the case of a invalid network address, false will be returned.
283 function is_reserved_network_addr($network_addr) {
284 $lNetwork= ip2long($network_addr);
286 if( $lNetwork == -1 )
289 // does the network address fall in a reserved block?
290 $reserved_ips = array (
291 array('10.0.0.0','10.255.255.255'),
292 array('172.16.0.0','172.31.0.0'),
293 array('192.168.0.0','192.168.255.0')
295 foreach ($reserved_ips as $r) {
296 $min = ip2long($r[0]);
297 $max = ip2long($r[1]);
299 if (($lNetwork >= $min) && ($lNetwork <= $max))
306 //////////////////////////////////////////////////////////// roles
307 function plc_role_global_hash ($api) {
309 $roles=$api->GetRoles();
310 foreach ($roles as $role) {
311 $hash[$role['role_id']]=$role['name'];
316 // because GetRoles does not correctly support filters, it's really painful to do this
317 function sort_roles ($r1, $r2) { return $r2['role_id'] - $r1['role_id']; }
318 function roles_except ($roles, $exception_ids) {
320 if ($roles) foreach ($roles as $role) {
321 if ( ! in_array ($role['role_id'],$exception_ids) ) {
325 usort($result,sort_roles);
329 //////////////////////////////////////////////////////////// nodegroups
330 // hash by 'tagname=value'
331 function plc_nodegroup_global_hash ($api,$tagnames=NULL) {
333 // xxx somehow this does not work; I've checked that the feature is working from plcsh
334 // but I suspect the php marshalling or something; no time to fix, get all nodegroups for now
335 // if ($tagnames) $filter=array("tagname"=>$tagnames);
336 $nodegroups=$api->GetNodeGroups($filter);
338 if ($nodegroups) foreach ($nodegroups as $nodegroup) {
339 $key=$nodegroup['tagname']."=".$nodegroup['value'];
340 $hash[$key]=$nodegroup;
345 //////////////////////////////////////////////////////////// titles
346 function t_site($site) { return " on site " . $site['name'] . " (" . $site['login_base'] .")"; }
347 function t_slice ($slice) { return " running slice " . $slice['name'] . " (" . $slice['slice_id'] . ")"; }
348 function t_person ($person) { return " belonging to " . $person['email'] . " (" . $person['person_id'] . ")"; }
350 //////////////////////////////////////////////////////////// html fragments
351 function plc_vertical_table ($messages, $class="") {
352 if ( empty( $messages) ) return "";
354 $formatted .= "<table";
355 if ($class) $formatted .= " class='" . $class . "'";
357 foreach ($messages as $message) {
358 $formatted .= "<tr><td>" . $message . "</td></tr>";
360 $formatted .= "</table>";
363 function plc_itemize ($messages, $class="") {
364 if ( empty( $messages) ) return "";
367 if ($class) $formatted .= " class='" . $class . "'";
369 foreach ($messages as $message) {
370 $formatted .= "<li>" . $message . "</li>";
372 $formatted .= "</ul>";
376 ////////// just return a truncated text
377 function truncate ($text,$numb,$etc = "...") {
378 if (strlen($text) <= $numb) return $text;
379 return substr($text, 0, $numb).$etc;
381 // ditto but in case the text is too lare, returns a <span> with its 'title' set to the full value
382 function truncate_and_popup ($text,$numb,$etc = "...") {
383 if (strlen($text) <= $numb) return $text;
384 $display=substr($text, 0, $numb).$etc;
385 return sprintf("<span title='%s'>%s</span>",$text,$display);
388 // generates <(atom) class=(class)> (text) </(atom)>
389 function html_atom ($atom,$text,$class="") {
391 if ($class) $html .= " class='$class'";
392 $html .= ">$text</$atom>";
395 function html_div ($text,$class="") { return html_atom ('div',$text,$class); }
396 function html_span ($text,$class="") { return html_atom ('span',$text,$class); }
398 // should use the same channel as the php errors..
399 function plc_error_html ($text) { return html_div ($text,'plc-error'); }
400 function plc_error ($text) { print plc_error_html ("Error " . $text); }
402 function errors_init() { return array();}
403 function errors_record ($adm, $errors) {
411 function errors_display ($errors) {
413 print( "<div class='plc-error'>" );
414 print( "<p>The following errors occured:</p>" );
416 foreach( $errors as $error )
417 print( "<li>$error</li>\n" );
418 print( "</ul></div>\n" );
422 function plc_warning_html ($text) { return html_span($text,'plc-warning'); }
423 function plc_warning ($text) { print plc_warning_html("Warning " . $text); }
425 function bold_html ($text) { return html_span($text,'bold'); }
427 // shows a php variable verbatim with a heading message
428 function plc_debug ($message,$object) {
429 print "<br />" . $message . "<pre>";
437 function plc_debug_prof_start () {
438 global $plc_prof_counter, $plc_prof_start, $plc_prof_time;
440 plc_debug(strftime("[0] %T (start)") ,"heating up");
441 $plc_prof_time=microtime(true);
442 $plc_prof_start=$plc_prof_time;
444 function plc_debug_prof ($message,$object) {
445 global $plc_prof_counter, $plc_prof_start, $plc_prof_time;
446 $plc_prof_counter+=1;
447 $now=microtime(true);
448 $timelabel=strftime("%T");
449 $prof_message=sprintf("[%d] %s (%2.3f s -- %2.3f s) ",$plc_prof_counter,$timelabel,
450 ($now-$plc_prof_time),($now-$plc_prof_start));
451 plc_debug($prof_message.$message,$object);
454 function plc_debug_prof_end () {
455 plc_debug_prof ("end","cooling down");
458 if (! function_exists ("drupal_set_error")) {
459 function drupal_set_error ($text) {
460 drupal_set_message ("<span class=error>$text</span>");
464 //////////////////////////////////////////////////////////// sort out for obsolete / trash
465 // builds a table from an array of strings, with the given class
466 // attempt to normalize the delete buttons and confirmations
467 function plc_delete_icon($width=15) {
468 return "<img width='$width' src='/planetlab/icons/delete.png'>";
471 function plc_add_icon($width=15) {
472 return "<img width='$width' src='/planetlab/icons/add.png'>";
475 function plc_bubble($text,$bubble) {
476 return "<span title='$bubble'>$text</span>";
478 function plc_delete_icon_bubble ($bubble,$width=15) {
479 return plc_bubble(plc_delete_icon($width),$bubble);
482 function plc_event_button($type,$param,$id) {
483 return '<a href="' . l_event($type,$param,$id) . '"> <span title="Related events"> <img src="/planetlab/icons/event.png" width=18></span></a>';
486 function plc_comon_button ($id_name, $id_value,$target="") {
488 if (!empty($target)) {
489 $result.='target="' . $target . '" ';
491 $result.='href="' . l_comon($id_name,$id_value) . '">';
492 $result.='<span title="Link to Comon"> <img src="/planetlab/icons/comon.png" width="18"></span></a>';
497 function plc_redirect ($url) {
498 header ("Location: " . $url);
502 //////////////////// the options for an interface - suitable for plekit/form
503 //>>> GetNetworkMethods()
504 //[u'static', u'dhcp', u'proxy', u'tap', u'ipmi', u'unknown']
505 function interface_method_selectors ($api, $method, $primary) {
507 $builtin_methods=array("static"=>"Static",
510 $builtin_methods=array("static"=>"Static",
517 foreach ($builtin_methods as $value=>$display) {
518 $selector=array('display'=>$display, 'value'=>$value);
519 if ($value == $method) $selector['selected']=true;
520 $selectors []= $selector;
525 // displays bandwidth with kbps Mbps Gbps as needed
526 function pretty_bandwidth ($bw) {
527 if ($bw < 1000) return $bw;
528 if ($bw < 1000000) return strval($bw/1000) . " kbps";
529 if ($bw < 1000000000) return strval($bw/1000000) . " Mbps";
530 else return strval($bw/1000000000) . " Gbps";
534 function instantiation_label ($slice) {
535 $instantiation_labels = array ('not-instantiated'=>'NOT',
536 'plc-instantiated'=>'PLC',
537 'delegated' => 'DEL',
538 'nm-controller' => 'NM');
539 $result=$instantiation_labels[$slice['instantiation']];
540 if (!$result) $result = $slice['instantiation'];
541 if (!$result) $result = '??';
545 //////////////////// toggle areas
546 // get_arg ('show_persons',false) returns $_GET['show_persons'] if set and false otherwise
547 function get_arg ($name,$default,$method='get') {
548 if ($method == 'get') $var=$_GET; else $var=$_POST;
549 if (isset ($var[$name])) return $var[$name];
550 else return $default;
553 //////////////////// number of ...
554 function count_english ($objs,$name) {
556 if ($count == 0) return 'No ' . $name;
557 else if ($count == 1) return 'One ' . $name;
558 else return $count . ' ' . $name . 's';
560 function count_english_warning ($objs, $name) {
561 $x=count_english ($objs,$name);
562 if (count ($objs) == 0) $x=plc_warning_html($x . ' !!');
566 //////////////////// outlining reservable nodes
567 function reservable_mark () { return "-R-";}
568 function reservable_legend () { return "reservable nodes are marked with " . reservable_mark (); }