GeniXML.pm.in 19.7 KB
Newer Older
1
2
3
#!/usr/bin/perl -w
#
# GENIPUBLIC-COPYRIGHT
4
# Copyright (c) 2010-2011 University of Utah and the Flux Group.
5
6
7
8
9
10
11
12
13
# All rights reserved.
#
package GeniXML;

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

@ISA = "Exporter";
14
@EXPORT = qw(Parse ParseFile GetXmlVersion IsVersion0 FindNodes FindNodesNS
15
FindFirst FindElement FindAttr GetNodeByVirtualId GetLinkByVirtualId
16
IsLanNode IsLocalNode IsTunnel GetExpires GetBandwidth GetIp GetVnodeId
17
GetNodeId GetVirtualId GetInterfaceId GetInterfaceNodeId GetSliverId
18
GetManagerId GetColocate GetSubnodeOf GetStartupCommand GetTarball
19
GetVirtualizationType SetVirtualizationSubtype GetVirtualizationSubtype
Jonathon Duerig's avatar
Jonathon Duerig committed
20
GetExclusive SetExclusive GetLinkManager SetText GetText Serialize
21
22
CreateDocument AddElement RemoveChild PolicyExists GetMask
GetDiskImage);
23
24
25

use English;
use XML::LibXML;
26
27
use XML::LibXML::XPathContext;
use XML::LibXML::NodeList;
28
use GeniHRN;
29
use GeniUtil;
30
31
use Carp qw(cluck carp);

32
33
34
use vars qw($RSPEC_0_1 $RSPEC_0_2 $RSPEC_2
            $RSPEC_0_1_NS $RSPEC_0_2_NS $RSPEC_2_NS
            $EMULAB_NS $XSI_NS $STITCH_NS
35
            $REQUEST_URL $MANIFEST_URL);
36
$RSPEC_0_1 = "0.1";
Jonathon Duerig's avatar
Jonathon Duerig committed
37
$RSPEC_0_2 = "0.2";
Jonathon Duerig's avatar
Jonathon Duerig committed
38
$RSPEC_2 = "2";
39

40
41
42
$RSPEC_0_1_NS = "http://www.protogeni.net/resources/rspec/0.1";
$RSPEC_0_2_NS = "http://www.protogeni.net/resources/rspec/0.2";
$RSPEC_2_NS = "http://www.protogeni.net/resources/rspec/2";
43
$EMULAB_NS = "http://www.protogeni.net/resources/rspec/ext/emulab/1";
44
$XSI_NS = "http://www.w3.org/2001/XMLSchema-instance";
45
$STITCH_NS = "http://hpn.east.isi.edu/rspec/ext/stitch/0.1/";
46
47
48

$REQUEST_URL = "http://www.protogeni.net/resources/rspec/2/request.xsd";
$MANIFEST_URL = "http://www.protogeni.net/resources/rspec/2/manifest.xsd";
49

50
51
52
53
# Configure variables
my $TB		   = "@prefix@";
my $TBOPS          = "@TBOPSEMAIL@";

54
55
56
# Name Space stuff
my $DELAY_NS = "http://www.protogeni.net/resources/rspec/ext/delay/1";

57
58
59
60
61
62
63
64
65
66
67
# 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 ($@) {
68
	carp("Failed to parse xml string: $@\nXML: $xml\n\n");
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
	return undef;
    } else {
	return $doc->documentElement();
    }
}

sub ParseFile($)
{
    my ($file) = @_;
    my $parser = XML::LibXML->new;
    my $doc;
    eval {
        $doc = $parser->parse_file($file);
    };
    if ($@) {
84
	carp("Failed to parse xml string: $@");
85
86
87
88
89
90
	return undef;
    } else {
	return $doc->documentElement();
    }
}

91
# Determines the rspec version of a node by examining is namespace URI
92
sub GetXmlVersion($)
93
94
{
    my ($node) = @_;
95
    my $result = undef;
96
97
    my $ns = $node->namespaceURI();
    if (defined($ns)) {
98
	if ($ns =~ /protogeni.net\/resources\/rspec\/0.1$/) {
99
	    $result = $RSPEC_0_1;
100
	} elsif ($ns =~ /protogeni.net\/resources\/rspec\/0.2$/) {
Jonathon Duerig's avatar
Jonathon Duerig committed
101
	    $result = $RSPEC_0_2;
102
	} elsif ($ns =~ /protogeni.net\/resources\/rspec\/2$/) {
103
104
105
106
107
108
109
110
111
	    $result = $RSPEC_2;
	} else {
	    carp("Unknown rspec namespace: " . $ns);
	    $result = $RSPEC_0_1;
	}
    }
    return $result;
}

Jonathon Duerig's avatar
Jonathon Duerig committed
112
113
sub IsVersion0($)
{
114
115
116
    my $version = GetXmlVersion($_[0]);
    return defined($version)
	&& ($version eq $RSPEC_0_1 || $version eq $RSPEC_0_2);
Jonathon Duerig's avatar
Jonathon Duerig committed
117
118
}

119
120
121
122
123
124
125
126
127
128
129
130
# 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)) {
131
	    $xc->registerNs('n', $ns);
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
	} 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;
    }
}

148
149
150
151
152
153
# 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;
154
155
    return XML::LibXML::NodeList->new()
        if (!defined($node));
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
    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;
    } 
}


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# 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);
}

211
212
213
214
215
sub GetElementByVirtualId($$$)
{
    my ($name, $type, $node) = @_;
    my @list = FindNodes('n:'.$type.'[@virtual_id = "'.$name.'"]',
			 $node)->get_nodelist();
216
217
218
219
220
221
222
223
    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();
    }
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
    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);    
}

248
249
250
251
252
253
# 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") {
254
	foreach my $lan (FindNodes("n:hardware_type",
255
				   $node)->get_nodelist()) {
256
	    my $typeName = GetFirstText($lan, "type_name", "name");
257
	    if (defined($typeName) && $typeName eq "lan") {
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
		$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") {
274
	my $manager_uuid  = GetManagerId($node);
275
276
277
278
279
280
281
282
283
284
	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
285
286
287
288
289
290
291
292
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 {
293
	my @types = FindNodes("n:link_type", $link)->get_nodelist();
Jonathon Duerig's avatar
Jonathon Duerig committed
294
295
	foreach my $current (@types) {
	    my $name = GetText("name", $current);
296
	    if (defined($name) && $name eq "gre-tunnel") {
Jonathon Duerig's avatar
Jonathon Duerig committed
297
298
299
300
301
302
303
304
305
306
307
		$result = 1;
		last;
	    }
	}
    }
    return $result;
}

sub GetExpires($)
{
    my ($node) = @_;
308
    return GetFirstText($node, "valid_until", "expires");
Jonathon Duerig's avatar
Jonathon Duerig committed
309
310
311
312
313
314
315
316
317
318
319
320
}

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

321
322
323
324
325
326
327
328
sub GetBandwidth($)
{
    my ($link) = @_;
    my $result = undef;
    if (IsVersion0($link)) {
	$result = GeniXML::GetText("bandwidth", $link);
    } else {
	my $prop = FindFirst("n:property", $link);
329
330
331
	if (defined($prop)) {
	    $result = GeniXML::GetText("capacity", $prop);
	}
332
333
334
335
    }
    return $result;
}

336
sub GetMask($$)
337
338
339
340
341
342
{
    my ($ifaceref, $node) = @_;
    my $result = undef;
    if (IsVersion0($ifaceref)) {
	$result = GetText("tunnel_ip", $ifaceref);
    } else {
343
344
345
346
347
348
349
	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)) {
350
		    $result = GetFirstText($ip, "netmask", "mask");
351
352
353
354
355
356
357
358
359
360
361
362
		}
		last;
	    }
	}
    }
    return $result;
}

sub GetIp($$)
{
    my ($ifaceref, $node) = @_;
    my $result = undef;
363
364
365
    if (IsVersion0($ifaceref)) {
	$result = GetText("tunnel_ip", $ifaceref);
    } else {
366
367
368
369
370
371
372
373
374
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)) {
		    $result = GetText("address", $ip);
		}
		last;
	    }
	}
    }
    return $result;
}

382
383
384
385
386
387
388
389
# 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 {
390
	my $vnoderef = GeniXML::FindNodesNS("n:vnode", $node,
391
392
393
394
395
396
397
398
399
400
401
					    $EMULAB_NS)->pop();
	if (defined($vnoderef)) {
	    $result = GetText("name", $vnoderef);
	}
	if (! defined($result)) {
	    $result = GetNodeId($node);
	}
    }
    return $result;
}

402
403
404
405
# Returns the uuid or urn of an RSpec node or undef if it is not a node.
sub GetNodeId($)
{
    my ($node) = @_;
406
407
    my $result = GetFirstText($node, "component_urn", "component_id",
			      "component_uuid", "uuid");
408
    if (defined($result) && $result eq "") {
409
410
411
	$result = undef;
    }
    return $result;
412
413
414
415
416
}

sub GetVirtualId($)
{
    my ($node) = @_;
417
418
419
420
421
422
423
424
425
426
427
428
429
430
    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");
431
432
}

433
434
435
sub GetSliverId($)
{
    my ($node) = @_;
436
    return GetFirstText($node, "sliver_urn", "sliver_id");
437
438
}

439
440
441
sub GetManagerId($)
{
    my ($node) = @_;
442
443
444
    my $result = GetFirstText($node, "component_manager_urn",
			      "component_manager_id",
			      "component_manager_uuid");
445
    if (defined($result) && $result eq "") {
446
447
448
	$result = undef;
    }
    return $result;
449
450
}

Jonathon Duerig's avatar
Jonathon Duerig committed
451
452
453
sub GetColocate($)
{
    my ($node) = @_;
454
    my $result = GetFirstText($node, "colocate", "phys_nickname");
Jonathon Duerig's avatar
Jonathon Duerig committed
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
    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;
}

476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
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;
}

512
513
514
515
516
517
518
519
sub GetStartupCommand($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
        $result = GetText("startup_command", $node);
    } else {
	my $execute = FindFirst("n:services/n:execute", $node);
520
521
522
	if (defined($execute)) {
	    $result = GetText("command", $execute);
	}
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
    }
    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;
	    }
	}
549
	if (defined($result) && $result eq "") {
550
551
552
553
554
555
	    $result = undef;
	}
    }
    return $result;
}

Jonathon Duerig's avatar
Jonathon Duerig committed
556
557
558
559
560
561
562
563
564
565
sub GetVirtualizationType($)
{
    my ($node) = @_;
    my $result = "emulab-vnode";
    if (IsVersion0($node)) {
	$result = GetText("virtualization_type", $node);
    }
    return $result;
}

566
sub SetVirtualizationSubtype($$)
Jonathon Duerig's avatar
Jonathon Duerig committed
567
568
569
570
{
    my ($node, $arg) = @_;
    my $result = 1;
    if (IsVersion0($node)) {
571
572
573
574
575
576
577
	$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
578
579
580
581
582
583
584
585
586
    }
    return $result;
}

sub GetVirtualizationSubtype($)
{
    my ($node) = @_;
    my $result = undef;
    if (IsVersion0($node)) {
587
	$result = GetText("virtualization_subtype", $node);
Jonathon Duerig's avatar
Jonathon Duerig committed
588
    } else {
589
	my $type = FindFirst("n:sliver_type", $node);
590
591
592
	if (defined($type)) {
	    $result = GetText("name", $type);
	}
Jonathon Duerig's avatar
Jonathon Duerig committed
593
594
595
596
    }
    return $result;
}

597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
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
612
613
614
615
616
617
618
619
620
621
622
sub GetExclusive($)
{
    my ($node) = @_;
    my $exclusive = GetText("exclusive", $node);
    my $result = $exclusive;
    if (defined($exclusive) && ! IsVersion0($node)) {
	$result = ($exclusive eq "true");
    }
    return $result;
}

623
sub SetExclusive($$)
Jonathon Duerig's avatar
Jonathon Duerig committed
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
{
    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) = @_;
642
    return GetFirstText($link, "id", "name");
Jonathon Duerig's avatar
Jonathon Duerig committed
643
644
}

645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
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;
}

663
664
665
666
667
668
669
670
671
# 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;
672
673
674
675
    my $child = FindFirst('@n:'.$name, $node);
    if (! defined($child)) {
	$child = FindFirst('@'.$name, $node);
    }
676
677
678
679
    if (defined($child)) {
	if ($child->nodeType() == XML_ATTRIBUTE_NODE) {
	    $child->setValue($text);
	    $result = 1;
680
681
	}
    } else {
682
	$child = FindFirst('n:'.$name, $node);
683
	if (defined($child)) {
684
685
686
687
688
689
690
691
	    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);
692
		$result = 1;
693
	    }
694
	} elsif ($node->nodeType() == XML_ELEMENT_NODE) {
695
696
	    my $ns = $node->namespaceURI();
	    if (defined($ns)) {
697
698
699
# TODO: Submit bug report for the library. This call is bugged.
#		$node->setAttributeNS($ns, "rs:$name", $text);
		$node->setAttribute($name, $text);
700
701
702
	    } else {
		$node->setAttribute($name, $text);
	    }
703
	    $result = 1;
704
705
706
707
708
	}
    }
    return $result;
}

709
710
# Get the text contents of a child of a node with a particular
# name. This can be either an attribute or an element.
711
712
sub GetText($$)
{
713
    my ($name, $node) = @_;
714
    my $result = undef;
715
716
717
718
    my $child = FindFirst('@n:'.$name, $node);
    if (! defined($child)) {
	$child = FindFirst('@'.$name, $node);
    }
719
720
721
    if (! defined($child)) {
	$child = FindFirst('n:'.$name, $node);
    }
722
723
724
725
726
727
    if (defined($child)) {
	$result = $child->textContent();
    }
    return $result;
}

728
729
730
731
732
733
734
735
# 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;
736
    foreach my $name (@_) {
737
738
739
740
741
742
743
744
	$result = GetText($name, $node);
	if (defined($result)) {
	    last;
	}
    }
    return $result;
}

745
746
# Converts the XML representation of a node to a UTF-8 string and
# outputs it as a complete XML document.
747
sub Serialize($;$)
748
{
749
750
    my ($node, $format) = @_;
    $format = 0 if (!defined($format));
751
    my $newnode = $node->cloneNode(1);
752
    return $newnode->toString($format);
753
754
755
756
}

# Create a new XML document with a given namespace URI and document
# element name.
757
758
759
760
sub CreateDocument($$)
{
    my ($ns, $name) = @_;
    my $doc = XML::LibXML::Document->createDocument("1.0", "UTF-8");
761
    my $root = $doc->createElementNS($ns, "$name");
762
763
    $doc->setDocumentElement($root);
    return $doc;
764
765
}

766
767
# Add a new element to a node. The new element will have the given
# name and be otherwise empty.
768
sub AddElement($$;$)
769
{
770
771
772
773
774
    my ($name, $node, $namespace) = @_;
    my $ns = $namespace;
    if (! defined($namespace)) {
	$ns = $node->namespaceURI();
    }
775
776
    my $child = $node->addNewChild($ns, "rs:$name");
    return $child;
777
778
}

779
780
# 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.
781
782
783
784
785
786
787
788
789
790
791
792
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);
    }
}

793
794
795
796
797
798
# Replaces a node (oldnode) with a copy of another node (newnode)
sub ReplaceNode($$)
{
    my ($oldnode, $newnode) = @_;
    my $copy = $newnode->cloneNode(1);
    $oldnode->replaceNode($copy);
799
    return $copy;
800
801
}

802
803
804
805
# checks for the existense of policy in extensions of the given
# credential.
sub PolicyExists($$)
{
806
807
    my ($policy, $credential) = @_;
    my $exists = 0;
808

809
810
811
812
813
814
    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/*",
815
          $extensions_elem, $GeniUtil::EXTENSIONS_NS);
816
817
818
819
820
821
    foreach my $epolicy ($policies->get_nodelist) {
        if ($policy eq $epolicy->string_value) {
            $exists = 1;
            last;
        }      
    }       
822
  
823
    return $exists;
824
825
}

826
827
# _Always_ make sure that this 1 is at the end of the file...
1;