lib/ZOOM/IRSpy/Utils.pm

   1 # $Id: Utils.pm,v 1.11 2006-11-13 18:03:34 mike Exp $
   2
   3 package ZOOM::IRSpy::Utils;
   4
   5 use 5.008;
   6 use strict;
   7 use warnings;
   8
   9 use Exporter 'import';
  10 our @EXPORT_OK = qw(xml_encode
  11                     irspy_xpath_context
  12                     modify_xml_document
  13                     inheritance_tree);
  14
  15 use XML::LibXML;
  16 use XML::LibXML::XPathContext;
  17
  18 our $IRSPY_NS = 'http://indexdata.com/irspy/1.0';
  19
  20
  21 # Utility functions follow, exported for use of web UI
  22
  23 # I can't -- just can't, can't, can't -- believe that this function
  24 # isn't provided by one of the core XML modules.  But the evidence all
  25 # says that it's not: among other things, XML::Generator and
  26 # Template::Plugin both roll their own.  So I will do likewise.  D'oh!
  27 #
  28 sub xml_encode {
  29     my ($text) = @_;
  30     $text =~ s/&/&amp;/g;
  31     $text =~ s/</&lt;/g;
  32     $text =~ s/>/&gt;/g;
  33     $text =~ s/['']/&apos;/g;
  34     $text =~ s/[""]/&quot;/g;
  35     return $text;
  36 }
  37
  38
  39 # PRIVATE to irspy_namespace() and irspy_xpath_context()
  40 my %_namespaces = (
  41                    e => 'http://explain.z3950.org/dtd/2.0/',
  42                    i => $IRSPY_NS,
  43                    );
  44
  45
  46 sub irspy_namespace {
  47     my($prefix) = @_;
  48
  49     my $uri = $_namespaces{$prefix};
  50     die "irspy_namespace(): no URI for namespace prefix '$prefix'"
  51         if !defined $uri;
  52
  53     return $uri;
  54 }
  55
  56
  57 sub irspy_xpath_context {
  58     my($record) = @_;
  59
  60     my $xml = ref $record ? $record->render() : $record;
  61     my $parser = new XML::LibXML();
  62     my $doc = $parser->parse_string($xml);
  63     my $root = $doc->getDocumentElement();
  64     my $xc = XML::LibXML::XPathContext->new($root);
  65     foreach my $prefix (keys %_namespaces) {
  66         $xc->registerNs($prefix, $_namespaces{$prefix});
  67     }
  68     return $xc;
  69 }
  70
  71
  72 sub modify_xml_document {
  73     my($xc, $fieldsByKey, $data) = @_;
  74
  75     my $nchanges = 0;
  76     foreach my $key (keys %$data) {
  77         my $value = $data->{$key};
  78         my $ref = $fieldsByKey->{$key} or die "no field '$key'";
  79         my($name, $nlines, $caption, $xpath, @addAfter) = @$ref;
  80         #print "Considering $key='$value' ($xpath)<br/>\n";
  81         my @nodes = $xc->findnodes($xpath);
  82         if (@nodes) {
  83             warn scalar(@nodes), " nodes match '$xpath'" if @nodes > 1;
  84             my $node = $nodes[0];
  85
  86             if ($node->isa("XML::LibXML::Attr")) {
  87                 if ($value ne $node->getValue()) {
  88                     $node->setValue($value);
  89                     $nchanges++;
  90                     #print "Attr $key: '", $node->getValue(), "' -> '$value' ($xpath)<br/>\n";
  91                 }
  92             } elsif ($node->isa("XML::LibXML::Element")) {
  93                 # The contents could be any mixture of text and
  94                 # comments and maybe even other crud such as processing
  95                 # instructions.  The simplest thing is just to throw it all
  96                 # away and start again, making a single Text node the
  97                 # canonical representation.  But before we do that,
  98                 # we'll check whether the element is already
  99                 # canonical, to determine whether our change is a
 100                 # no-op.
 101                 my $old = "???";
 102                 my @children = $node->childNodes();
 103                 if (@children == 1) {
 104                     my $child = $node->firstChild();
 105                     if (ref $child && ref $child eq "XML::LibXML::Text") {
 106                         $old = $child->getData();
 107                         next if $value eq $old;
 108                     }
 109                 }
 110
 111                 $node->removeChildNodes();
 112                 my $child = new XML::LibXML::Text($value);
 113                 $node->appendChild($child);
 114                 $nchanges++;
 115                 #print "Elem $key: '$old' -> '$value' ($xpath)<br/>\n";
 116             } else {
 117                 warn "unexpected node type $node";
 118             }
 119
 120         } else {
 121             next if !$value; # No need to create a new empty node
 122             my($ppath, $element) = $xpath =~ /(.*)\/(.*)/;
 123             dom_add_element($xc, $ppath, $element, $value, @addAfter);
 124             #print "New $key ($xpath) = '$value'<br/>\n";
 125             $nchanges++;
 126         }
 127     }
 128
 129     return $nchanges;
 130 }
 131
 132
 133 sub dom_add_element {
 134     my($xc, $ppath, $element, $value, @addAfter) = @_;
 135
 136     #print "Adding $element='$value' at '$ppath' after (", join(", ", map { "'$_'" } @addAfter), ")<br/>\n";
 137     my $node = find_or_make_node($xc, $ppath, 0);
 138     return if !defined $node;   ### should be a "can't happen"
 139
 140     my(undef, $prefix, $nsElem) = $element =~ /((.*?):)?(.*)/;
 141     my $new = new XML::LibXML::Element($nsElem);
 142     $new->setNamespace(irspy_namespace($prefix), $prefix)
 143         if $prefix ne "";
 144
 145     $new->appendText($value);
 146     foreach my $predecessor (reverse @addAfter) {
 147         my($child) = $xc->findnodes($predecessor, $node);
 148         if (defined $child) {
 149             $node->insertAfter($new, $child);
 150             #print "Added after '$predecessor'<br/>\n";
 151             return;
 152         }
 153     }
 154
 155     # Didn't find any of the nodes that are supposed to precede the
 156     # new one, so we need to insert the new node as the first of the
 157     # parent's children.  However *sigh* there is no prependChild()
 158     # analogous to appendChild(), so we have to go the long way round.
 159     my @children = $node->childNodes();
 160     if (@children) {
 161         $node->insertBefore($new, $children[0]);
 162         #print "Added new first child<br/>\n";
 163     } else {
 164         $node->appendChild($new);
 165         #print "Added new only child<br/>\n";
 166     }
 167
 168     if (0) {
 169         my $text = xml_encode(inheritance_tree($xc));
 170         $text =~ s/\n/<br\/>$&/sg;
 171         print "<pre>$text</pre>\n";
 172     }
 173 }
 174
 175
 176 sub find_or_make_node {
 177     my($xc, $path, $recursion_level) = @_;
 178
 179     die "deep recursion in find_or_make_node($path)"
 180         if $recursion_level == 10;
 181
 182     my @nodes = $xc->findnodes($path);
 183     if (@nodes == 0) {
 184         # Oh dear, the parent node doesn't exist.  We could make it,
 185         my($ppath, $element) = $path =~ /(.*)\/(.*)/;
 186         warn "no node '$path': making it";
 187         my $parent = find_or_make_node($xc, $ppath, $recursion_level-1);
 188
 189         my(undef, $prefix, $nsElem) = $element =~ /((.*?):)?(.*)/;
 190         my $new = new XML::LibXML::Element($nsElem);
 191         $new->setNamespace(irspy_namespace($prefix), $prefix)
 192             if $prefix ne "";
 193
 194         $parent->appendChild($new);
 195         return $new;
 196     }
 197     warn scalar(@nodes), " nodes match parent '$path'" if @nodes > 1;
 198     return $nodes[0];
 199 }
 200
 201
 202 sub inheritance_tree {
 203     my($type, $level) = @_;
 204     $level = 0 if !defined $level;
 205     return "Woah!  Too deep, man!\n" if $level > 20;
 206
 207     $type = ref $type if ref $type;
 208     my $text = "";
 209     $text = "--> " if $level == 0;
 210     $text .= ("\t" x $level) . "$type\n";
 211     my @ISA = eval "\@${type}::ISA";
 212     foreach my $superclass (@ISA) {
 213         $text .= inheritance_tree($superclass, $level+1);
 214     }
 215
 216     return $text;
 217 }
 218
 219
 220 #print "Loaded ZOOM::IRSpy::Utils.pm";
 221
 222
 223 1;