lib/ZOOM/IRSpy/Utils.pm

   1 # $Id: Utils.pm,v 1.14 2006-11-14 16:21:49 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, $fallback) = @_;
  30
  31     $text = $fallback if !defined $text;
  32     use Carp;
  33     confess "xml_encode(): text and fallback both undefined"
  34         if !defined $text;
  35
  36     $text =~ s/&/&amp;/g;
  37     $text =~ s/</&lt;/g;
  38     $text =~ s/>/&gt;/g;
  39     $text =~ s/['']/&apos;/g;
  40     $text =~ s/[""]/&quot;/g;
  41     return $text;
  42 }
  43
  44
  45 # PRIVATE to irspy_namespace() and irspy_xpath_context()
  46 my %_namespaces = (
  47                    e => 'http://explain.z3950.org/dtd/2.0/',
  48                    i => $IRSPY_NS,
  49                    );
  50
  51
  52 sub irspy_namespace {
  53     my($prefix) = @_;
  54
  55     use Carp;
  56     confess "irspy_namespace(undef)" if !defined $prefix;
  57     my $uri = $_namespaces{$prefix};
  58     die "irspy_namespace(): no URI for namespace prefix '$prefix'"
  59         if !defined $uri;
  60
  61     return $uri;
  62 }
  63
  64
  65 sub irspy_xpath_context {
  66     my($record) = @_;
  67
  68     my $xml = ref $record ? $record->render() : $record;
  69     my $parser = new XML::LibXML();
  70     my $doc = $parser->parse_string($xml);
  71     my $root = $doc->getDocumentElement();
  72     my $xc = XML::LibXML::XPathContext->new($root);
  73     foreach my $prefix (keys %_namespaces) {
  74         $xc->registerNs($prefix, $_namespaces{$prefix});
  75     }
  76     return $xc;
  77 }
  78
  79
  80 sub modify_xml_document {
  81     my($xc, $fieldsByKey, $data) = @_;
  82
  83     my $nchanges = 0;
  84     foreach my $key (keys %$data) {
  85         my $value = $data->{$key};
  86         my $ref = $fieldsByKey->{$key} or die "no field '$key'";
  87         my($name, $nlines, $caption, $xpath, @addAfter) = @$ref;
  88         #print "Considering $key='$value' ($xpath)<br/>\n";
  89         my @nodes = $xc->findnodes($xpath);
  90         if (@nodes) {
  91             warn scalar(@nodes), " nodes match '$xpath'" if @nodes > 1;
  92             my $node = $nodes[0];
  93
  94             if ($node->isa("XML::LibXML::Attr")) {
  95                 if ($value ne $node->getValue()) {
  96                     $node->setValue($value);
  97                     $nchanges++;
  98                     #print "Attr $key: '", $node->getValue(), "' -> '$value' ($xpath)<br/>\n";
  99                 }
 100             } elsif ($node->isa("XML::LibXML::Element")) {
 101                 # The contents could be any mixture of text and
 102                 # comments and maybe even other crud such as processing
 103                 # instructions.  The simplest thing is just to throw it all
 104                 # away and start again, making a single Text node the
 105                 # canonical representation.  But before we do that,
 106                 # we'll check whether the element is already
 107                 # canonical, to determine whether our change is a
 108                 # no-op.
 109                 my $old = "???";
 110                 my @children = $node->childNodes();
 111                 if (@children == 1) {
 112                     my $child = $node->firstChild();
 113                     if (ref $child && ref $child eq "XML::LibXML::Text") {
 114                         $old = $child->getData();
 115                         next if $value eq $old;
 116                     }
 117                 }
 118
 119                 $node->removeChildNodes();
 120                 my $child = new XML::LibXML::Text($value);
 121                 $node->appendChild($child);
 122                 $nchanges++;
 123                 #print "Elem $key: '$old' -> '$value' ($xpath)<br/>\n";
 124             } else {
 125                 warn "unexpected node type $node";
 126             }
 127
 128         } else {
 129             next if !$value; # No need to create a new empty node
 130             my($ppath, $selector) = $xpath =~ /(.*)\/(.*)/;
 131             dom_add_node($xc, $ppath, $selector, $value, @addAfter);
 132             #print "New $key ($xpath) = '$value'<br/>\n";
 133             $nchanges++;
 134         }
 135     }
 136
 137     return $nchanges;
 138 }
 139
 140
 141 sub dom_add_node {
 142     my($xc, $ppath, $selector, $value, @addAfter) = @_;
 143
 144     #print "Adding $selector='$value' at '$ppath' after (", join(", ", map { "'$_'" } @addAfter), ")<br/>\n";
 145     my $node = find_or_make_node($xc, $ppath, 0);
 146     die "couldn't find or make node '$node'" if !defined $node;
 147
 148     my $is_attr = ($selector =~ s/^@//);
 149     my(undef, $prefix, $simpleSel) = $selector =~ /((.*?):)?(.*)/;
 150     #warn "selector='$selector', prefix='$prefix', simpleSel='$simpleSel'";
 151     if ($is_attr) {
 152         if (defined $prefix) {
 153             ### This seems to no-op (thank, DOM!) but I have have no
 154             # idea, and it's not needed for IRSpy, so I am not going
 155             # to debug it now.
 156             $node->setAttributeNS(irspy_namespace($prefix),
 157                                   $simpleSel, $value);
 158         } else {
 159             $node->setAttribute($simpleSel, $value);
 160         }
 161         return;
 162     }
 163
 164     my $new = new XML::LibXML::Element($simpleSel);
 165     $new->setNamespace(irspy_namespace($prefix), $prefix)
 166         if defined $prefix;
 167
 168     $new->appendText($value);
 169     foreach my $predecessor (reverse @addAfter) {
 170         my($child) = $xc->findnodes($predecessor, $node);
 171         if (defined $child) {
 172             $node->insertAfter($new, $child);
 173             #warn "Added after '$predecessor'";
 174             return;
 175         }
 176     }
 177
 178     # Didn't find any of the nodes that are supposed to precede the
 179     # new one, so we need to insert the new node as the first of the
 180     # parent's children.  However *sigh* there is no prependChild()
 181     # analogous to appendChild(), so we have to go the long way round.
 182     my @children = $node->childNodes();
 183     if (@children) {
 184         $node->insertBefore($new, $children[0]);
 185         #warn "Added new first child";
 186     } else {
 187         $node->appendChild($new);
 188         #warn "Added new only child";
 189     }
 190
 191     if (0) {
 192         my $text = xml_encode(inheritance_tree($xc));
 193         $text =~ s/\n/<br\/>$&/sg;
 194         print "<pre>$text</pre>\n";
 195     }
 196 }
 197
 198
 199 sub find_or_make_node {
 200     my($xc, $path, $recursion_level) = @_;
 201
 202     die "deep recursion in find_or_make_node($path)"
 203         if $recursion_level == 10;
 204     $path = "." if $path eq "";
 205
 206     my @nodes = $xc->findnodes($path);
 207     if (@nodes == 0) {
 208         # Oh dear, the parent node doesn't exist.  We could make it,
 209         my(undef, $ppath, $element) = $path =~ /((.*)\/)?(.*)/;
 210         $ppath = "" if !defined $ppath;
 211         #warn "path='$path', ppath='$ppath', element='$element'";
 212         #warn "no node '$path': making it";
 213         my $parent = find_or_make_node($xc, $ppath, $recursion_level-1);
 214
 215         my(undef, $prefix, $nsElem) = $element =~ /((.*?):)?(.*)/;
 216         #warn "element='$element', prefix='$prefix', nsElem='$nsElem'";
 217         my $new = new XML::LibXML::Element($nsElem);
 218         if (defined $prefix) {
 219             #warn "setNamespace($prefix)";
 220             $new->setNamespace(irspy_namespace($prefix), $prefix);
 221         }
 222
 223         $parent->appendChild($new);
 224         return $new;
 225     }
 226     warn scalar(@nodes), " nodes match parent '$path'" if @nodes > 1;
 227     return $nodes[0];
 228 }
 229
 230
 231 sub inheritance_tree {
 232     my($type, $level) = @_;
 233     $level = 0 if !defined $level;
 234     return "Woah!  Too deep, man!\n" if $level > 20;
 235
 236     $type = ref $type if ref $type;
 237     my $text = "";
 238     $text = "--> " if $level == 0;
 239     $text .= ("\t" x $level) . "$type\n";
 240     my @ISA = eval "\@${type}::ISA";
 241     foreach my $superclass (@ISA) {
 242         $text .= inheritance_tree($superclass, $level+1);
 243     }
 244
 245     return $text;
 246 }
 247
 248
 249 #print "Loaded ZOOM::IRSpy::Utils.pm";
 250
 251
 252 1;