GeniXML.pm.in 22.6 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
GetDiskImage IsUntaggedLan IsTaggedLan);
46
47
48

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

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

65
66
67
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";
68
our $RSPEC_3_NS = "http://www.geni.net/resources/rspec/3";
69
70
71
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/";
72
73
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";
74

75
76
77
78
$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";
79

80
81
82
83
# Configure variables
my $TB		   = "@prefix@";
my $TBOPS          = "@TBOPSEMAIL@";

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

87
88
89
90
91
92
93
94
95
96
97
# 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 ($@) {
98
	carp("Failed to parse xml string: $@\nXML: $xml\n\n");
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
	return undef;
    } else {
	return $doc->documentElement();
    }
}

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

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

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

151
152
153
154
155
156
157
158
159
160
161
162
# 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)) {
163
	    $xc->registerNs('n', $ns);
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
	} 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;
    }
}

180
181
182
183
184
185
# 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;
186
187
    return XML::LibXML::NodeList->new()
        if (!defined($node));
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
    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;
    } 
}


209
210
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
# 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);
}

243
244
245
246
247
sub GetElementByVirtualId($$$)
{
    my ($name, $type, $node) = @_;
    my @list = FindNodes('n:'.$type.'[@virtual_id = "'.$name.'"]',
			 $node)->get_nodelist();
248
249
250
251
252
253
254
255
    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();
    }
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
    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);    
}

280
281
282
283
284
285
# 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") {
286
	foreach my $lan (FindNodes("n:hardware_type",
287
				   $node)->get_nodelist()) {
288
	    my $typeName = GetFirstText($lan, "type_name", "name");
289
	    if (defined($typeName) && $typeName eq "lan") {
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
		$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") {
306
	my $manager_uuid  = GetManagerId($node);
307
308
309
310
311
312
313
314
315
316
	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
317
318
319
320
321
322
323
324
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 {
325
	my @types = FindNodes("n:link_type", $link)->get_nodelist();
Jonathon Duerig's avatar
Jonathon Duerig committed
326
327
	foreach my $current (@types) {
	    my $name = GetText("name", $current);
328
	    if (defined($name) && $name eq "gre-tunnel") {
Jonathon Duerig's avatar
Jonathon Duerig committed
329
330
331
332
333
334
335
336
337
338
339
		$result = 1;
		last;
	    }
	}
    }
    return $result;
}

sub GetExpires($)
{
    my ($node) = @_;
340
    return GetFirstText($node, "valid_until", "expires");
Jonathon Duerig's avatar
Jonathon Duerig committed
341
342
343
344
345
346
347
348
349
350
351
352
}

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

353
354
355
356
357
358
359
360
sub GetBandwidth($)
{
    my ($link) = @_;
    my $result = undef;
    if (IsVersion0($link)) {
	$result = GeniXML::GetText("bandwidth", $link);
    } else {
	my $prop = FindFirst("n:property", $link);
361
362
363
	if (defined($prop)) {
	    $result = GeniXML::GetText("capacity", $prop);
	}
364
365
366
367
    }
    return $result;
}

368
sub GetMask($$)
369
370
371
372
373
374
{
    my ($ifaceref, $node) = @_;
    my $result = undef;
    if (IsVersion0($ifaceref)) {
	$result = GetText("tunnel_ip", $ifaceref);
    } else {
375
376
377
378
379
380
381
	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)) {
382
		    $result = GetFirstText($ip, "netmask", "mask");
383
384
385
386
387
388
389
390
391
392
393
394
		}
		last;
	    }
	}
    }
    return $result;
}

sub GetIp($$)
{
    my ($ifaceref, $node) = @_;
    my $result = undef;
395
396
397
    if (IsVersion0($ifaceref)) {
	$result = GetText("tunnel_ip", $ifaceref);
    } else {
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
	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;
}

414
415
416
417
418
419
420
421
# 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 {
422
	my $vnoderef = GeniXML::FindNodesNS("n:vnode", $node,
423
424
425
426
427
428
429
430
431
432
433
					    $EMULAB_NS)->pop();
	if (defined($vnoderef)) {
	    $result = GetText("name", $vnoderef);
	}
	if (! defined($result)) {
	    $result = GetNodeId($node);
	}
    }
    return $result;
}

434
435
436
437
# Returns the uuid or urn of an RSpec node or undef if it is not a node.
sub GetNodeId($)
{
    my ($node) = @_;
438
439
    my $result = GetFirstText($node, "component_urn", "component_id",
			      "component_uuid", "uuid");
440
    if (defined($result) && $result eq "") {
441
442
443
	$result = undef;
    }
    return $result;
444
445
446
447
448
}

sub GetVirtualId($)
{
    my ($node) = @_;
449
450
451
452
453
454
455
456
457
458
459
460
461
462
    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");
463
464
}

465
466
467
sub GetSliverId($)
{
    my ($node) = @_;
468
    return GetFirstText($node, "sliver_urn", "sliver_id");
469
470
}

471
472
473
sub GetManagerId($)
{
    my ($node) = @_;
474
475
476
    my $result = GetFirstText($node, "component_manager_urn",
			      "component_manager_id",
			      "component_manager_uuid");
477
    if (defined($result) && $result eq "") {
478
479
480
	$result = undef;
    }
    return $result;
481
482
}

Jonathon Duerig's avatar
Jonathon Duerig committed
483
484
485
sub GetColocate($)
{
    my ($node) = @_;
486
    my $result = GetFirstText($node, "colocate", "phys_nickname");
Jonathon Duerig's avatar
Jonathon Duerig committed
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
    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;
}

508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
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;
}

544
545
546
547
548
549
550
551
sub GetStartupCommand($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
        $result = GetText("startup_command", $node);
    } else {
	my $execute = FindFirst("n:services/n:execute", $node);
552
553
554
	if (defined($execute)) {
	    $result = GetText("command", $execute);
	}
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
    }
    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;
	    }
	}
581
	if (defined($result) && $result eq "") {
582
583
584
585
586
587
	    $result = undef;
	}
    }
    return $result;
}

Jonathon Duerig's avatar
Jonathon Duerig committed
588
589
590
591
592
593
594
595
596
597
sub GetVirtualizationType($)
{
    my ($node) = @_;
    my $result = "emulab-vnode";
    if (IsVersion0($node)) {
	$result = GetText("virtualization_type", $node);
    }
    return $result;
}

598
sub SetVirtualizationSubtype($$)
Jonathon Duerig's avatar
Jonathon Duerig committed
599
600
601
602
{
    my ($node, $arg) = @_;
    my $result = 1;
    if (IsVersion0($node)) {
603
604
605
606
607
608
609
	$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
610
611
612
613
614
615
616
617
618
    }
    return $result;
}

sub GetVirtualizationSubtype($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
619
	$result = GetText("virtualization_subtype", $node);
Jonathon Duerig's avatar
Jonathon Duerig committed
620
    } else {
621
	my $type = FindFirst("n:sliver_type", $node);
622
623
624
	if (defined($type)) {
	    $result = GetText("name", $type);
	}
Jonathon Duerig's avatar
Jonathon Duerig committed
625
626
627
628
    }
    return $result;
}

629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
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
644
645
646
647
648
649
650
651
652
653
654
sub GetExclusive($)
{
    my ($node) = @_;
    my $exclusive = GetText("exclusive", $node);
    my $result = $exclusive;
    if (defined($exclusive) && ! IsVersion0($node)) {
	$result = ($exclusive eq "true");
    }
    return $result;
}

655
sub SetExclusive($$)
Jonathon Duerig's avatar
Jonathon Duerig committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
{
    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) = @_;
674
    return GetFirstText($link, "id", "name");
Jonathon Duerig's avatar
Jonathon Duerig committed
675
676
}

677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
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;
}

695
696
697
698
699
700
701
702
sub HasTagSetting($)
{
    my ($link) = @_;
    my @tagged = FindNodesNS("n:vlan_tagging", $link,
			     $EMULAB_NS)->get_nodelist();
    return scalar(@tagged);
}

703
704
705
sub IsUntaggedLan($)
{
    my ($link) = @_;
706
    my $result = 0;
Leigh B Stoller's avatar
Leigh B Stoller committed
707
    my @tagged = FindNodesNS("n:vlan_tagging", $link,
Jonathon Duerig's avatar
Jonathon Duerig committed
708
			     $EMULAB_NS)->get_nodelist();
709
710
711
712
713
714
715
716
717
718
719
    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
720
    my @tagged = FindNodesNS("n:vlan_tagging", $link,
721
722
723
724
725
726
			     $EMULAB_NS)->get_nodelist();
    if (scalar(@tagged) > 0) {
	my $enabled = GetText("enabled", $tagged[0]);
	$result = defined($enabled) && $enabled eq "true";
    }
    return $result;
727
728
}

729
730
731
732
733
sub GetSharedLanName($)
{
    my ($iface) = @_;

    if (! IsVersion0($iface)) {
734
	my $interface_name = FindNodesNS("n:link_shared_vlan", $iface,
735
					 $SHAREDVLAN_NS)->pop();
736
	if (! defined($interface_name)) {
737
738
	    $interface_name = FindNodesNS("n:link_shared_vlan", $iface,
					  $SHAREDVLAN_PG_NS)->pop();
739
	}
740
741
742
743
744
745
746
747
748
749
	if (defined($interface_name)) {
	    my $name = GetText("name", $interface_name);
	    if (defined($name) and $name ne "") {
		return $name;
	    }
	}
    }
    return undef;
}

750
751
752
753
754
755
756
757
758
# 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;
759
760
761
762
    my $child = FindFirst('@n:'.$name, $node);
    if (! defined($child)) {
	$child = FindFirst('@'.$name, $node);
    }
763
764
765
766
    if (defined($child)) {
	if ($child->nodeType() == XML_ATTRIBUTE_NODE) {
	    $child->setValue($text);
	    $result = 1;
767
768
	}
    } else {
769
	$child = FindFirst('n:'.$name, $node);
770
	if (defined($child)) {
771
772
773
774
775
776
777
778
	    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);
779
		$result = 1;
780
	    }
781
	} elsif ($node->nodeType() == XML_ELEMENT_NODE) {
782
783
	    my $ns = $node->namespaceURI();
	    if (defined($ns)) {
784
785
786
# TODO: Submit bug report for the library. This call is bugged.
#		$node->setAttributeNS($ns, "rs:$name", $text);
		$node->setAttribute($name, $text);
787
788
789
	    } else {
		$node->setAttribute($name, $text);
	    }
790
	    $result = 1;
791
792
793
794
795
	}
    }
    return $result;
}

796
797
# Get the text contents of a child of a node with a particular
# name. This can be either an attribute or an element.
798
799
sub GetText($$)
{
800
    my ($name, $node) = @_;
801
    my $result = undef;
802
803
804
805
    my $child = FindFirst('@n:'.$name, $node);
    if (! defined($child)) {
	$child = FindFirst('@'.$name, $node);
    }
806
807
808
    if (! defined($child)) {
	$child = FindFirst('n:'.$name, $node);
    }
809
810
811
    if (defined($child)) {
	$result = $child->textContent();
    }
812
813
814
    if (defined($result)) {
	$result =~ s/^\s*(.*)\s*$/$1/s;
    }
815
816
817
    return $result;
}

818
819
820
821
822
823
824
825
# 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;
826
    foreach my $name (@_) {
827
828
829
830
831
832
833
834
	$result = GetText($name, $node);
	if (defined($result)) {
	    last;
	}
    }
    return $result;
}

835
836
# Converts the XML representation of a node to a UTF-8 string and
# outputs it as a complete XML document.
837
sub Serialize($;$)
838
{
839
840
    my ($node, $format) = @_;
    $format = 0 if (!defined($format));
841
    my $newnode = $node->cloneNode(1);
842
    return $newnode->toString($format);
843
844
845
846
}

# Create a new XML document with a given namespace URI and document
# element name.
847
848
849
850
sub CreateDocument($$)
{
    my ($ns, $name) = @_;
    my $doc = XML::LibXML::Document->createDocument("1.0", "UTF-8");
851
    my $root = $doc->createElementNS($ns, "$name");
852
853
    $doc->setDocumentElement($root);
    return $doc;
854
855
}

856
857
# Add a new element to a node. The new element will have the given
# name and be otherwise empty.
858
sub AddElement($$;$)
859
{
860
861
862
863
864
    my ($name, $node, $namespace) = @_;
    my $ns = $namespace;
    if (! defined($namespace)) {
	$ns = $node->namespaceURI();
    }
865
866
    my $child = $node->addNewChild($ns, "rs:$name");
    return $child;
867
868
}

869
870
# 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.
871
872
873
874
875
876
877
878
879
880
881
882
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);
    }
}

883
884
885
886
887
888
# Replaces a node (oldnode) with a copy of another node (newnode)
sub ReplaceNode($$)
{
    my ($oldnode, $newnode) = @_;
    my $copy = $newnode->cloneNode(1);
    $oldnode->replaceNode($copy);
889
    return $copy;
890
891
}

892
893
894
895
# checks for the existense of policy in extensions of the given
# credential.
sub PolicyExists($$)
{
896
897
    my ($policy, $credential) = @_;
    my $exists = 0;
898

899
900
901
902
903
904
    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/*",
905
          $extensions_elem, $GeniUtil::EXTENSIONS_NS);
906
907
908
909
910
911
    foreach my $epolicy ($policies->get_nodelist) {
        if ($policy eq $epolicy->string_value) {
            $exists = 1;
            last;
        }      
    }       
912
  
913
    return $exists;
914
915
}

916
917
# _Always_ make sure that this 1 is at the end of the file...
1;