GeniXML.pm.in 24.3 KB
Newer Older
1
2
#!/usr/bin/perl -w
#
Leigh B Stoller's avatar
Leigh B Stoller committed
3
# Copyright (c) 2010-2013 University of Utah and the Flux Group.
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# 
# {{{GENIPUBLIC-LICENSE
# 
# GENI Public License
# 
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and/or hardware specification (the "Work") to
# deal in the Work without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Work, and to permit persons to whom the Work
# is furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Work.
# 
# THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
# IN THE WORK.
# 
# }}}
29
30
31
32
33
34
35
36
#
package GeniXML;

use strict;
use Exporter;
use vars qw(@ISA @EXPORT);

@ISA = "Exporter";
37
@EXPORT = qw(Parse ParseFile GetXmlVersion IsVersion0 FindNodes FindNodesNS
38
FindFirst FindElement FindAttr GetNodeByVirtualId GetLinkByVirtualId
39
IsLanNode IsLocalNode IsTunnel GetExpires GetBandwidth GetIp GetVnodeId
40
GetNodeId GetVirtualId GetInterfaceId GetInterfaceNodeId GetSliverId
41
GetManagerId GetColocate GetSubnodeOf GetStartupCommand GetTarball
42
GetVirtualizationType SetVirtualizationSubtype GetVirtualizationSubtype
Jonathon Duerig's avatar
Jonathon Duerig committed
43
GetExclusive SetExclusive GetLinkManager SetText GetText Serialize
44
CreateDocument AddElement RemoveChild PolicyExists GetMask
45
46
GetDiskImage IsUntaggedLan IsTaggedLan GetHopLinkID GetCapabilitySection
GetSuggestedVlanFromHop SetVlanTagInHop);
47
48
49

use English;
use XML::LibXML;
50
51
use XML::LibXML::XPathContext;
use XML::LibXML::NodeList;
52
use GeniHRN;
53
use GeniResponse;
54
use GeniUtil;
55
56
use Carp qw(cluck carp);

57
use vars qw($RSPEC_0_1 $RSPEC_0_2 $RSPEC_2 $RSPEC_3
58
            $RSPEC_0_1_NS $RSPEC_0_2_NS $RSPEC_2_NS
59
            $EMULAB_NS $XSI_NS $STITCH_NS $SHAREDVLAN_NS
60
61
            $REQUEST_2_URL $MANIFEST_2_URL
            $REQUEST_3_URL $MANIFEST_3_URL);
62
$RSPEC_0_1 = "0.1";
Jonathon Duerig's avatar
Jonathon Duerig committed
63
$RSPEC_0_2 = "0.2";
Jonathon Duerig's avatar
Jonathon Duerig committed
64
$RSPEC_2 = "2";
65
$RSPEC_3 = "3";
66

67
68
69
our $RSPEC_0_1_NS = "http://www.protogeni.net/resources/rspec/0.1";
our $RSPEC_0_2_NS = "http://www.protogeni.net/resources/rspec/0.2";
our $RSPEC_2_NS = "http://www.protogeni.net/resources/rspec/2";
70
our $RSPEC_3_NS = "http://www.geni.net/resources/rspec/3";
71
72
73
our $EMULAB_NS = "http://www.protogeni.net/resources/rspec/ext/emulab/1";
our $XSI_NS = "http://www.w3.org/2001/XMLSchema-instance";
our $STITCH_NS = "http://hpn.east.isi.edu/rspec/ext/stitch/0.1/";
74
75
our $SHAREDVLAN_NS = "http://www.geni.net/resources/rspec/ext/shared-vlan/1";
our $SHAREDVLAN_PG_NS = "http://www.protogeni.net/resources/rspec/ext/shared-vlan/1";
76

77
78
79
80
$REQUEST_2_URL = "http://www.protogeni.net/resources/rspec/2/request.xsd";
$MANIFEST_2_URL = "http://www.protogeni.net/resources/rspec/2/manifest.xsd";
$REQUEST_3_URL = "http://www.geni.net/resources/rspec/3/request.xsd";
$MANIFEST_3_URL = "http://www.geni.net/resources/rspec/3/manifest.xsd";
81

82
83
84
85
# Configure variables
my $TB		   = "@prefix@";
my $TBOPS          = "@TBOPSEMAIL@";

86
87
88
# Name Space stuff
my $DELAY_NS = "http://www.protogeni.net/resources/rspec/ext/delay/1";

89
90
91
92
93
94
95
96
97
98
99
# Returns the document element by parsing a given string. If the
# string fails to parse, returns undefined.
sub Parse($)
{
    my ($xml) = @_;
    my $parser = XML::LibXML->new;
    my $doc;
    eval {
        $doc = $parser->parse_string($xml);
    };
    if ($@) {
100
	carp("Failed to parse xml string: $@\nXML: $xml\n\n");
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
	return undef;
    } else {
	return $doc->documentElement();
    }
}

sub ParseFile($)
{
    my ($file) = @_;
    my $parser = XML::LibXML->new;
    my $doc;
    eval {
        $doc = $parser->parse_file($file);
    };
    if ($@) {
116
	carp("Failed to parse xml string: $@");
117
118
119
120
121
122
	return undef;
    } else {
	return $doc->documentElement();
    }
}

123
# Determines the rspec version of a node by examining is namespace URI
124
sub GetXmlVersion($)
125
126
{
    my ($node) = @_;
127
    my $result = undef;
128
129
    my $ns = $node->namespaceURI();
    if (defined($ns)) {
130
	if ($ns =~ /protogeni.net\/resources\/rspec\/0.1$/) {
131
	    $result = $RSPEC_0_1;
132
	} elsif ($ns =~ /protogeni.net\/resources\/rspec\/0.2$/) {
Jonathon Duerig's avatar
Jonathon Duerig committed
133
	    $result = $RSPEC_0_2;
134
	} elsif ($ns =~ /protogeni.net\/resources\/rspec\/2$/) {
135
	    $result = $RSPEC_2;
136
137
	} elsif ($ns =~ /geni.net\/resources\/rspec\/3$/) {
	    $result = $RSPEC_3;
138
139
140
141
142
143
144
145
	} else {
	    carp("Unknown rspec namespace: " . $ns);
	    $result = $RSPEC_0_1;
	}
    }
    return $result;
}

Jonathon Duerig's avatar
Jonathon Duerig committed
146
147
sub IsVersion0($)
{
148
149
150
    my $version = GetXmlVersion($_[0]);
    return defined($version)
	&& ($version eq $RSPEC_0_1 || $version eq $RSPEC_0_2);
Jonathon Duerig's avatar
Jonathon Duerig committed
151
152
}

153
154
155
156
157
158
159
160
161
162
163
164
# Returns a NodeList for a given XPath using a given node as
# context. 'n' is defined to be the prefix for the namespace of the
# node.
sub FindNodes($$)
{
    my ($path, $node) = @_;
    my $result = undef;
    my $ns = undef;
    eval {
	my $xc = XML::LibXML::XPathContext->new();
	$ns = $node->namespaceURI();
	if (defined($ns)) {
165
	    $xc->registerNs('n', $ns);
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
	} else {
	    $path =~ s/\bn://g;
	}
	$result = $xc->findnodes($path, $node);
    };
    if ($@) {
	if (! defined($ns)) {
	    $ns = "undefined";
	}
        cluck "Failed to find nodes using XPath path='$path', ns='$ns': $@\n";
	return XML::LibXML::NodeList->new();
    } else {
	return $result;
    }
}

182
183
184
185
186
187
# Returns a NodeList for a given XPath using a given namespace as
# context. 'n' is defined to be the prefix for the given namespace.
sub FindNodesNS($$$)
{
    my ($path, $node, $nsURI) = @_;
    my $result = undef;
188
189
    return XML::LibXML::NodeList->new()
        if (!defined($node));
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
    eval { 
  my $xc = XML::LibXML::XPathContext->new();
  if (defined($nsURI)) {
      $xc->registerNs('n', $nsURI);
  } else {
      $path =~ s/\bn://g;
  }
  $result = $xc->findnodes($path, $node);
    };
    if ($@) {
  if (! defined($nsURI)) {
      $nsURI = "undefined";
  }
        cluck "Failed to find nodes using XPath path='$path', nsURI='$nsURI': $@\n";        
  return XML::LibXML::NodeList->new();
    } else { 
  return $result;
    } 
}


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# Returns the first Node which matches a given XPath against a given
# node. If that node is not of the specified type, returns
# undefined. Works like FindNodes.
sub FindNodeType($$$)
{
    my ($path, $node, $type) = @_;
    my $result = FindNodes($path, $node)->pop();
    if (defined($result) && $result->nodeType() != $type) {
	$result = undef;
    }
    return $result;
}

# Returns the first Node which matches a given XPath.
sub FindFirst($$)
{
    my ($path, $node) = @_;
    return FindNodes($path, $node)->pop();
}

# Returns the first Element which matches a given XPath.
sub FindElement($$)
{
    my ($path, $node) = @_;
    return FindNodeType($path, $node, XML_ELEMENT_NODE);
}

# Returns the first Attribute which matches a given XPath.
sub FindAttr($$)
{
    my ($path, $node) = @_;
    return FindNodeType($path, $node, XML_ATTRIBUTE_NODE);
}

245
246
247
248
249
sub GetElementByVirtualId($$$)
{
    my ($name, $type, $node) = @_;
    my @list = FindNodes('n:'.$type.'[@virtual_id = "'.$name.'"]',
			 $node)->get_nodelist();
250
251
252
253
254
255
256
257
    if (scalar(@list) == 0) {
	@list = FindNodes('n:'.$type.'[@nickname = "'.$name.'"]',
			  $node)->get_nodelist();
    }
    if (scalar(@list) == 0) {
	@list = FindNodes('n:'.$type.'[@client_id = "'.$name.'"]',
			  $node)->get_nodelist();
    }
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
    my $result = undef;
    if (scalar(@list) > 0)
    {
	$result = $list[0];
    }
    if (scalar(@list) > 1)
    {
	cluck("WARNING: Multiple $type with virtual_id $name found");
    }
    return $result;
}

sub GetNodeByVirtualId($$)
{
    my ($name, $node) = @_;
    return GetElementByVirtualId($name, 'node', $node);
}

sub GetLinkByVirtualId($$)
{
    my ($name, $node) = @_;
    return GetElementByVirtualId($name, 'link', $node);    
}

282
283
284
285
286
287
# Returns true if a given XML Node is an RSpec node and is of type lan
sub IsLanNode($)
{
    my ($node) = @_;
    my $result = 0;
    if (defined($node) && $node->localname() eq "node") {
288
	foreach my $lan (FindNodes("n:hardware_type",
289
				   $node)->get_nodelist()) {
290
	    my $typeName = GetFirstText($lan, "type_name", "name");
291
	    if (defined($typeName) && $typeName eq "lan") {
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
		$result = 1;
		last;
	    }
	}
    }
    return $result;
}

# Returns true if a given XML Node is an RSpec node and either has
# the current CM as a 'component_manager_urn' or
# 'component_manager_uuid or no component_manager defined.
sub IsLocalNode($)
{
    my ($node) = @_;
    my $result = 0;
    if (defined($node) && $node->localname() eq "node") {
308
	my $manager_uuid  = GetManagerId($node);
309
310
311
312
313
314
315
316
317
318
	if (! defined($manager_uuid) ||
	    GeniHRN::Equal($manager_uuid, $ENV{'MYURN'}) ||
	    $manager_uuid eq $ENV{'MYUUID'}) {

	    $result = 1;
	}
    }
    return $result;
}

Jonathon Duerig's avatar
Jonathon Duerig committed
319
320
321
322
323
324
325
326
sub IsTunnel($)
{
    my ($link) = @_;
    my $result = 0;
    if (IsVersion0($link)) {
	my $link_type = GetText("link_type", $link);
	$result = (defined($link_type) && $link_type eq "tunnel");
    } else {
327
	my @types = FindNodes("n:link_type", $link)->get_nodelist();
Jonathon Duerig's avatar
Jonathon Duerig committed
328
329
	foreach my $current (@types) {
	    my $name = GetText("name", $current);
330
	    if (defined($name) && $name eq "gre-tunnel") {
Jonathon Duerig's avatar
Jonathon Duerig committed
331
332
333
334
335
336
337
338
339
340
341
		$result = 1;
		last;
	    }
	}
    }
    return $result;
}

sub GetExpires($)
{
    my ($node) = @_;
342
343
344
345
346
347
348
349
350
351
352
353
    my $result = undef;
    my $text = GetFirstText($node, "valid_until", "expires");
    if (defined($text)) {
	if ($text =~
	  /[0-9]{4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/) {
	    $result = $text;
	} else {
	    $result = GeniResponse->Create(GENIRESPONSE_ERROR, undef,
					   "$text: Invalid Datetime Format");
	}
    }
    return $result;
Jonathon Duerig's avatar
Jonathon Duerig committed
354
355
356
357
358
359
360
361
362
363
364
365
}

sub SetExpires($$)
{
    my ($node, $arg) = @_;
    if (IsVersion0($node)) {
	SetText("valid_until", $node, $arg);
    } else {
	SetText("expires", $node, $arg);
    }
}

366
367
368
369
370
371
372
373
sub GetBandwidth($)
{
    my ($link) = @_;
    my $result = undef;
    if (IsVersion0($link)) {
	$result = GeniXML::GetText("bandwidth", $link);
    } else {
	my $prop = FindFirst("n:property", $link);
374
375
376
	if (defined($prop)) {
	    $result = GeniXML::GetText("capacity", $prop);
	}
377
378
379
380
    }
    return $result;
}

381
sub GetMask($$)
382
383
384
385
386
387
{
    my ($ifaceref, $node) = @_;
    my $result = undef;
    if (IsVersion0($ifaceref)) {
	$result = GetText("tunnel_ip", $ifaceref);
    } else {
388
389
390
391
392
393
394
	my $id = GetInterfaceId($ifaceref);
	my @ifaces = FindNodes("n:interface", $node)->get_nodelist();
	foreach my $iface (@ifaces) {
	    my $testid = GetInterfaceId($iface);
	    if (defined($id) && defined($testid) && $testid eq $id) {
		my $ip = FindFirst("n:ip", $iface);
		if (defined($ip)) {
395
		    $result = GetFirstText($ip, "netmask", "mask");
396
397
398
399
400
401
402
403
404
405
406
407
		}
		last;
	    }
	}
    }
    return $result;
}

sub GetIp($$)
{
    my ($ifaceref, $node) = @_;
    my $result = undef;
408
409
410
    if (IsVersion0($ifaceref)) {
	$result = GetText("tunnel_ip", $ifaceref);
    } else {
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
	my $id = GetInterfaceId($ifaceref);
	my @ifaces = FindNodes("n:interface", $node)->get_nodelist();
	foreach my $iface (@ifaces) {
	    my $testid = GetInterfaceId($iface);
	    if (defined($id) && defined($testid) && $testid eq $id) {
		my $ip = FindFirst("n:ip", $iface);
		if (defined($ip)) {
		    $result = GetText("address", $ip);
		}
		last;
	    }
	}
    }
    return $result;
}

427
428
429
430
431
432
433
434
# Returns the vnode id in the emulab extension or failing that the component_id
sub GetVnodeId($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
	$result = GetNodeId($node);
    } else {
435
	my $vnoderef = GeniXML::FindNodesNS("n:vnode", $node,
436
437
438
439
440
441
442
443
444
445
446
					    $EMULAB_NS)->pop();
	if (defined($vnoderef)) {
	    $result = GetText("name", $vnoderef);
	}
	if (! defined($result)) {
	    $result = GetNodeId($node);
	}
    }
    return $result;
}

447
448
449
450
# Returns the uuid or urn of an RSpec node or undef if it is not a node.
sub GetNodeId($)
{
    my ($node) = @_;
451
452
    my $result = GetFirstText($node, "component_urn", "component_id",
			      "component_uuid", "uuid");
453
    if (defined($result) && $result eq "") {
454
455
456
	$result = undef;
    }
    return $result;
457
458
459
460
461
}

sub GetVirtualId($)
{
    my ($node) = @_;
462
463
464
465
466
467
468
469
470
471
472
473
474
475
    return GetFirstText($node, "virtual_id", "nickname", "client_id");
}

sub GetInterfaceId($)
{
    my ($node) = @_;
    return GetFirstText($node, "virtual_interface_id", "iface_name",
			"client_id", "virtual_port_id", "virtual_id");
}

sub GetInterfaceNodeId($)
{
    my ($node) = @_;
    return GetFirstText($node, "virtual_node_id", "node_nickname");
476
477
}

478
479
480
sub GetSliverId($)
{
    my ($node) = @_;
481
    return GetFirstText($node, "sliver_urn", "sliver_id");
482
483
}

484
485
486
sub GetManagerId($)
{
    my ($node) = @_;
487
488
489
    my $result = GetFirstText($node, "component_manager_urn",
			      "component_manager_id",
			      "component_manager_uuid");
490
    if (defined($result) && $result eq "") {
491
492
493
	$result = undef;
    }
    return $result;
494
495
}

Jonathon Duerig's avatar
Jonathon Duerig committed
496
497
498
sub GetColocate($)
{
    my ($node) = @_;
499
    my $result = GetFirstText($node, "colocate", "phys_nickname");
Jonathon Duerig's avatar
Jonathon Duerig committed
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
    return $result;
}

sub GetSubnodeOf($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
	$result = GetText("subnode_of", $node);
    } else {
	my @relations = FindNodes("n:relation", $node)->get_nodelist();
	foreach my $current (@relations) {
	    if (GetText("type", $current) == "subnode_of") {
		$result = GetText("client_id", $current);
		last;
	    }
	}
    }
    return $result;
}

521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
sub GetServices($)
{
    my ($node) = @_;
    my @result = ();
    my @services = FindNodes("n:services", $node)->get_nodelist();

    foreach my $service (@services) {
	foreach my $current ($service->childNodes()) {
	    my $item;
	    my $type = $current->nodeName();
	
	    if ($type eq "execute") {
		$type = "execute";
		my $cmd  = GetText("command", $current);
		my $shell= GetText("shell", $current);
		$item = {"type"   => $type,
			 "cmd"    => $cmd,
			 "shell"  => $shell};
	    }
	    elsif ($type eq "install") {
		$type = "install";
		my $dir = GetText("install_path", $current);
		my $url = GetText("url", $current);
		$item = {"type"   => $type,
			 "dir"    => $dir,
			 "url"    => $url};
	    }
	    else {
		next;
	    }
	    push(@result, $item);
	}
    }
    return @result;
}

557
558
559
560
561
562
563
564
sub GetStartupCommand($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
        $result = GetText("startup_command", $node);
    } else {
	my $execute = FindFirst("n:services/n:execute", $node);
565
566
567
	if (defined($execute)) {
	    $result = GetText("command", $execute);
	}
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
    }
    return $result;
}

sub GetTarball($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
        $result = GetText("tarfiles", $node);
    } else {
	$result = "";
	my @tarlist = FindNodes("n:services/n:install",
				$node)->get_nodelist();
	foreach my $current (@tarlist) {
	    my $url = GetText("url", $current);
	    my $install = GetText("install_path", $current);
	    if (defined($url) && defined($install)) {
		# TODO: Make sure url/install don't have semicolons or spaces
		# TODO: Flag an error if either one is not defined
		if ($result ne "") {
		    $result .= ";";
		}
		$result .= $install . " " . $url;
	    }
	}
594
	if (defined($result) && $result eq "") {
595
596
597
598
599
600
	    $result = undef;
	}
    }
    return $result;
}

Jonathon Duerig's avatar
Jonathon Duerig committed
601
602
603
604
605
606
607
608
609
610
sub GetVirtualizationType($)
{
    my ($node) = @_;
    my $result = "emulab-vnode";
    if (IsVersion0($node)) {
	$result = GetText("virtualization_type", $node);
    }
    return $result;
}

611
sub SetVirtualizationSubtype($$)
Jonathon Duerig's avatar
Jonathon Duerig committed
612
613
614
615
{
    my ($node, $arg) = @_;
    my $result = 1;
    if (IsVersion0($node)) {
616
617
618
619
620
621
622
	$result = SetText("virtualization_subtype", $node, $arg);
    } else {
	my $type = FindFirst("n:sliver_type", $node);
	if (! defined($type)) {
	    $type = AddElement("sliver_type", $node);
	}
	SetText("name", $type, $arg);
Jonathon Duerig's avatar
Jonathon Duerig committed
623
624
625
626
627
628
629
630
631
    }
    return $result;
}

sub GetVirtualizationSubtype($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
632
	$result = GetText("virtualization_subtype", $node);
Jonathon Duerig's avatar
Jonathon Duerig committed
633
    } else {
634
	my $type = FindFirst("n:sliver_type", $node);
635
636
637
	if (defined($type)) {
	    $result = GetText("name", $type);
	}
Jonathon Duerig's avatar
Jonathon Duerig committed
638
639
640
641
    }
    return $result;
}

642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
sub GetDiskImage($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
	$result = FindFirst("n:disk_image", $node);
    } else {
	my $type = FindFirst("n:sliver_type", $node);
	if (defined($type)) {
	    $result = FindFirst("n:disk_image", $type);
	}
    }
    return $result;
}

Jonathon Duerig's avatar
Jonathon Duerig committed
657
658
659
660
661
662
663
664
665
666
667
sub GetExclusive($)
{
    my ($node) = @_;
    my $exclusive = GetText("exclusive", $node);
    my $result = $exclusive;
    if (defined($exclusive) && ! IsVersion0($node)) {
	$result = ($exclusive eq "true");
    }
    return $result;
}

668
sub SetExclusive($$)
Jonathon Duerig's avatar
Jonathon Duerig committed
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
{
    my ($node, $arg) = @_;
    my $result = 1;
    if (IsVersion0($node)) {
	$result = SetText("exclusive", $node, $arg);
    } else {
	my $textArg = "false";
	if ($arg) {
	    $textArg = "true";
	}
	$result = SetText("exclusive", $node, $textArg);
    }
    return $result;
}

sub GetLinkManager($)
{
    my ($link) = @_;
687
    return GetFirstText($link, "id", "name");
Jonathon Duerig's avatar
Jonathon Duerig committed
688
689
}

690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
sub GetDelayPipes($)
{
    my ($node) = @_;
    my @result = ();
    
    if (! IsVersion0($node)) {
	my $type = FindFirst("n:sliver_type", $node);
	if (defined($type)) {
	    my $name = GetText("name", $type);
	    if (defined($name) && $name eq "delay") {
		@result = FindNodesNS("n:sliver_type_shaping/n:pipe", $type,
				      $DELAY_NS)->get_nodelist();
	    }
	}
    }
    return @result;
}

708
709
710
711
712
713
714
715
sub HasTagSetting($)
{
    my ($link) = @_;
    my @tagged = FindNodesNS("n:vlan_tagging", $link,
			     $EMULAB_NS)->get_nodelist();
    return scalar(@tagged);
}

716
717
718
sub IsUntaggedLan($)
{
    my ($link) = @_;
719
    my $result = 0;
Leigh B Stoller's avatar
Leigh B Stoller committed
720
    my @tagged = FindNodesNS("n:vlan_tagging", $link,
Jonathon Duerig's avatar
Jonathon Duerig committed
721
			     $EMULAB_NS)->get_nodelist();
722
723
724
725
726
727
728
729
730
731
732
    if (scalar(@tagged) > 0) {
	my $enabled = GetText("enabled", $tagged[0]);
	$result = defined($enabled) && $enabled eq "false";
    }
    return $result;
}

sub IsTaggedLan($)
{
    my ($link) = @_;
    my $result = 0;
Leigh B Stoller's avatar
Leigh B Stoller committed
733
    my @tagged = FindNodesNS("n:vlan_tagging", $link,
734
735
736
737
738
739
			     $EMULAB_NS)->get_nodelist();
    if (scalar(@tagged) > 0) {
	my $enabled = GetText("enabled", $tagged[0]);
	$result = defined($enabled) && $enabled eq "true";
    }
    return $result;
740
741
}

742
743
744
745
746
sub GetSharedLanName($)
{
    my ($iface) = @_;

    if (! IsVersion0($iface)) {
747
	my $interface_name = FindNodesNS("n:link_shared_vlan", $iface,
748
					 $SHAREDVLAN_NS)->pop();
749
	if (! defined($interface_name)) {
750
751
	    $interface_name = FindNodesNS("n:link_shared_vlan", $iface,
					  $SHAREDVLAN_PG_NS)->pop();
752
	}
753
754
755
756
757
758
759
760
761
762
	if (defined($interface_name)) {
	    my $name = GetText("name", $interface_name);
	    if (defined($name) and $name ne "") {
		return $name;
	    }
	}
    }
    return undef;
}

763
764
765
766
767
768
769
770
771
# Takes an attribute/element name, *NOT AN XPATH* and a node and sets
# the text of that node to a particular value. If the node is an
# attribute, the value is set. If it is an element with just a text
# node child, that node is replaced.
# Returns 1 on success and 0 on failure.
sub SetText($$$)
{
    my ($name, $node, $text) = @_;
    my $result = 0;
772
773
774
775
    my $child = FindFirst('@n:'.$name, $node);
    if (! defined($child)) {
	$child = FindFirst('@'.$name, $node);
    }
776
777
778
779
    if (defined($child)) {
	if ($child->nodeType() == XML_ATTRIBUTE_NODE) {
	    $child->setValue($text);
	    $result = 1;
780
781
	}
    } else {
782
	$child = FindFirst('n:'.$name, $node);
783
	if (defined($child)) {
784
785
786
787
788
789
790
791
	    my @grand = $child->childNodes();
	    if (scalar(@grand) == 1
		&& $grand[0]->nodeType() == XML_TEXT_NODE) {
		$grand[0]->setData($text);
		$result = 1;
	    } elsif (scalar(@grand) == 0
		     && $child->nodeType() == XML_ELEMENT_NODE) {
		$child->appendText($text);
792
		$result = 1;
793
	    }
794
	} elsif ($node->nodeType() == XML_ELEMENT_NODE) {
795
796
	    my $ns = $node->namespaceURI();
	    if (defined($ns)) {
797
798
799
# TODO: Submit bug report for the library. This call is bugged.
#		$node->setAttributeNS($ns, "rs:$name", $text);
		$node->setAttribute($name, $text);
800
801
802
	    } else {
		$node->setAttribute($name, $text);
	    }
803
	    $result = 1;
804
805
806
807
808
	}
    }
    return $result;
}

809
810
# Get the text contents of a child of a node with a particular
# name. This can be either an attribute or an element.
811
812
sub GetText($$)
{
813
    my ($name, $node) = @_;
814
    my $result = undef;
815
816
817
818
    my $child = FindFirst('@n:'.$name, $node);
    if (! defined($child)) {
	$child = FindFirst('@'.$name, $node);
    }
819
820
821
    if (! defined($child)) {
	$child = FindFirst('n:'.$name, $node);
    }
822
823
824
    if (defined($child)) {
	$result = $child->textContent();
    }
825
826
827
    if (defined($result)) {
	$result =~ s/^\s*(.*)\s*$/$1/s;
    }
828
829
830
    return $result;
}

831
832
833
834
835
836
837
838
# Run GetText serially using the initial argument as an XML node
# reference and the remaining arguments as names and return the first
# defined result. Returns undefined if there are no names or if all
# GetText calls return undefined.
sub GetFirstText($@)
{
    my $node = shift(@_);
    my $result = undef;
839
    foreach my $name (@_) {
840
841
842
843
844
845
846
847
	$result = GetText($name, $node);
	if (defined($result)) {
	    last;
	}
    }
    return $result;
}

848
849
# Converts the XML representation of a node to a UTF-8 string and
# outputs it as a complete XML document.
850
sub Serialize($;$)
851
{
852
853
    my ($node, $format) = @_;
    $format = 0 if (!defined($format));
854
    my $newnode = $node->cloneNode(1);
855
    return $newnode->toString($format);
856
857
858
859
}

# Create a new XML document with a given namespace URI and document
# element name.
860
861
862
863
sub CreateDocument($$)
{
    my ($ns, $name) = @_;
    my $doc = XML::LibXML::Document->createDocument("1.0", "UTF-8");
864
    my $root = $doc->createElementNS($ns, "$name");
865
866
    $doc->setDocumentElement($root);
    return $doc;
867
868
}

869
870
# Add a new element to a node. The new element will have the given
# name and be otherwise empty.
871
sub AddElement($$;$)
872
{
873
874
875
876
877
    my ($name, $node, $namespace) = @_;
    my $ns = $namespace;
    if (! defined($namespace)) {
	$ns = $node->namespaceURI();
    }
878
879
    my $child = $node->addNewChild($ns, "rs:$name");
    return $child;
880
881
}

882
883
# Remove a node with a given name from a node. It will be removed
# whether it is an attribute or an element. The name is not an xpath.
884
885
886
887
888
889
890
891
892
893
894
895
sub RemoveChild($$)
{
    my ($name, $node) = @_;
    my $child = FindFirst('@n:'.$name, $node);
    if (! defined($child)) {
	$child = FindFirst('n:'.$name, $node);
    }
    if (defined($child)) {
	$node->removeChild($child);
    }
}

896
897
898
899
900
901
# Replaces a node (oldnode) with a copy of another node (newnode)
sub ReplaceNode($$)
{
    my ($oldnode, $newnode) = @_;
    my $copy = $newnode->cloneNode(1);
    $oldnode->replaceNode($copy);
902
    return $copy;
903
904
}

905
906
907
908
# checks for the existense of policy in extensions of the given
# credential.
sub PolicyExists($$)
{
909
910
    my ($policy, $credential) = @_;
    my $exists = 0;
911

912
913
914
915
916
917
    return 0
        if (!ref($credential) or !defined($policy));
    my $extensions_elem = $credential->extensions();
    return 0
        if (!defined($extensions_elem));
    my $policies = GeniXML::FindNodesNS("//n:policy_exceptions/*",
918
          $extensions_elem, $GeniUtil::EXTENSIONS_NS);
919
920
921
922
923
924
    foreach my $epolicy ($policies->get_nodelist) {
        if ($policy eq $epolicy->string_value) {
            $exists = 1;
            last;
        }      
    }       
925
  
926
    return $exists;
927
928
}

929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
sub GetHopLinkID($)
{
    my ($ref)  = @_;
    my $result = "";
			
    my $link = FindFirst("n:link", $ref);
    if (defined($link)) {
	$result = GetText("id", $link);
    }
    return $result;
}

sub GetHopCapabilitySection($)
{
    my ($hopref) = @_;
    
    #
    # Dig out the section we need from the hop.
    #
    my $tmp = FindFirst("n:link", $hopref);
    $tmp = (FindFirst("n:switchingCapabilityDescriptor", $tmp) ||
	    FindFirst("n:switchingCapabilityDescriptors", $tmp))
	if (defined($tmp));
    $tmp = FindFirst("n:switchingCapabilitySpecificInfo", $tmp)
	if (defined($tmp));
    if (defined($tmp) &&
	FindFirst("n:switchingCapabilitySpecificInfo_L2sc", $tmp)) {
	$tmp = FindFirst("n:switchingCapabilitySpecificInfo_L2sc", $tmp)
    }
    return $tmp;
}

sub GetSuggestedVlanFromHop($)
{
    my ($hopref) = @_;
    my $capref   = GetHopCapabilitySection($hopref);
    return undef
	if (!defined($capref));

    my $tag = GeniXML::GetText("suggestedVLANRange", $capref);
    $tag = undef
	if (defined($tag) && ! looks_like_number($tag));
    return $tag;
}

sub SetVlanTagInHop($$)
{
    my ($hopref, $tag) = @_;

    my $capref = GetHopCapabilitySection($hopref);
    return undef
	if (!defined($capref));

    GeniXML::SetText("vlanRangeAvailability", $capref, "$tag");
    GeniXML::SetText("suggestedVLANRange", $capref, "$tag");
    return 0;
}

987
988
# _Always_ make sure that this 1 is at the end of the file...
1;