package XML::Rules;
use warnings;
no warnings qw(uninitialized);
use strict;
use Carp;
require Exporter;
our @ISA = qw(Exporter);
our @EXPORT_OK = qw(paths2rules);
use XML::Parser::Expat;
=head1 NAME
XML::Rules - parse XML and specify what and how to keep/process for individual tags
=head1 VERSION
Version 1.05
=cut
our $VERSION = '1.05';
=head1 SYNOPSIS
use XML::Rules;
$xml = <<'*END*';
<doc>
<person>
<fname>...</fname>
<lname>...</lname>
<email>...</email>
<address>
<street>...</street>
<city>...</city>
<country>...</country>
<bogus>...</bogus>
</address>
<phones>
<phone type="home">123-456-7890</phone>
<phone type="office">663-486-7890</phone>
<phone type="fax">663-486-7000</phone>
</phones>
</person>
<person>
<fname>...</fname>
<lname>...</lname>
<email>...</email>
<address>
<street>...</street>
<city>...</city>
<country>...</country>
<bogus>...</bogus>
</address>
<phones>
<phone type="office">663-486-7891</phone>
</phones>
</person>
</doc>
*END*
@rules = (
_default => sub {$_[0] => $_[1]->{_content}},
# by default I'm only interested in the content of the tag, not the attributes
bogus => undef,
# let's ignore this tag and all inner ones as well
address => sub {address => "$_[1]->{street}, $_[1]->{city} ($_[1]->{country})"},
# merge the address into a single string
phone => sub {$_[1]->{type} => $_[1]->{_content}},
# let's use the "type" attribute as the key and the content as the value
phones => sub {delete $_[1]->{_content}; %{$_[1]}},
# remove the text content and pass along the type => content from the child nodes
person => sub { # lets print the values, all the data is readily available in the attributes
print "$_[1]->{lname}, $_[1]->{fname} <$_[1]->{email}>\n";
print "Home phone: $_[1]->{home}\n" if $_[1]->{home};
print "Office phone: $_[1]->{office}\n" if $_[1]->{office};
print "Fax: $_[1]->{fax}\n" if $_[1]->{fax};
print "$_[1]->{address}\n\n";
return; # the <person> tag is processed, no need to remember what it contained
},
);
$parser = XML::Rules->new(rules => \@rules);
$parser->parse( $xml);
=head1 INTRODUCTION
There are several ways to extract data from XML. One that's often used is to read the whole file and transform it into a huge maze of objects and then write code like
foreach my $obj ($XML->forTheLifeOfMyMotherGiveMeTheFirstChildNamed("Peter")->pleaseBeSoKindAndGiveMeAllChildrenNamedSomethingLike("Jane")) {
my $obj2 = $obj->sorryToKeepBotheringButINeedTheChildNamed("Theophile");
my $birth = $obj2->whatsTheValueOfAttribute("BirthDate");
print "Theophile was bort at $birth\n";
}
I'm exagerating of course, but you probably know what I mean. You can of course shorten the path and call just one method ... that is if you spend the time to learn one more "cool" thing starting with X. XPath.
You can also use XML::Simple and generate an almost equaly huge maze of hashes and arrays ... which may make the code more or less complex. In either case you need to have enough memory
to store all that data, even if you only need a piece here and there.
Another way to parse the XML is to create some subroutines that handle the start and end tags and the text and whatever else may appear in the XML. Some modules will let you specify just one for start tag, one for text and one for end tag, others will let you install different handlers for different tags. The catch is that you have to build your data structures yourself, you have to know where you are, what tag is just open and what is the parent and it's parent etc. so that you could add the attributes and especially the text to the right place. And the handlers have to do everything as their side effect. Does anyone remember what do they say about side efects? They make the code hard to debug, they tend to change the code into a maze of interdependent snippets of code.
So what's the difference in the way XML::Rules works? At the first glance, not much. You can also specify subroutines to be called for the tags encountered while parsing the XML, just like the other even based XML parsers. The difference is that you do not have to rely on sideeffects if all you want is to store the value of a tag. You simply return whatever you need from the current tag and the module will add it at the right place in the data structure it builds and will provide it to the handlers for the parent tag. And if the parent tag does return that data again it will be passed to its parent and so forth. Until we get to the level at which it's convenient to handle all the data we accumulated from the twig.
Do we want to keep just the content and access it in the parent tag handler under a specific name?
foo => sub {return 'foo' => $_[1]->{_content}}
Do we want to ornament the content a bit and add it to the parent tag's content?
u => sub {return '_' . $_[1]->{_content} . '_'}
strong => sub {return '*' . $_[1]->{_content} . '*'}
uc => sub {return uc($_[1]->{_content})}
Do we want to merge the attributes into a string and access the string from the parent tag under a specified name?
address => sub {return 'Address' => "Street: $_[1]->{street} $_[1]->{bldngNo}\nCity: $_[1]->{city}\nCountry: $_[1]->{country}\nPostal code: $_[1]->{zip}"}
and in this case the $_[1]->{street} may either be an attribute of the <address> tag or it may be ther result of the handler (rule)
street => sub {return 'street' => $_[1]->{_content}}
and thus come from a child tag <street>. You may also use the rules to convert codes to values
our %states = (
AL => 'Alabama',
AK => 'Alaska',
...
);
...
state => sub {return 'state' => $states{$_[1]->{_content}}; }
or
address => sub {
if (exists $_[1]->{id}) {
$sthFetchAddress->execute($_[1]->{id});
my $addr = $sthFetchAddress->fetchrow_hashref();
$sthFetchAddress->finish();
return 'address' => $addr;
} else {
return 'address' => $_[1];
}
}
so that you do not have to care whether there was
<address id="147"/>
or
<address><street>Larry Wall's St.</street><streetno>478</streetno><city>Core</city><country>The Programming Republic of Perl</country></address>
At each level in the tree structure serialized as XML you can decide what to keep, what to throw away, what to transform and then just return the stuff you care about and it will be available to the handler at the next level.
=head1 CONSTRUCTOR
my $parser = XML::Rules->new(
rules => \@rules,
[ start_rules => \@start_rules, ]
[ stripspaces => 0 / 1 / 2 / 3 + 0 / 4 + 0 / 8, ]
[ normalisespaces => 0 / 1, ]
[ style => 'parser' / 'filter', ]
[ ident => ' ', [reformat_all => 0 / 1] ],
[ encode => 'encoding specification', ]
[ output_encoding => 'encoding specification', ]
[ namespaces => \%namespace2alias_mapping, ]
# and optionaly parameters passed to XML::Parser::Expat
);
Options passed to XML::Parser::Expat : ProtocolEncoding Namespaces NoExpand Stream_Delimiter ErrorContext ParseParamEnt Base
The "stripspaces" controls the handling of whitespace. Please see the C<Whitespace handling> bellow.
The "style" specifies whether you want to build a parser used to extract stuff from the XML or filter/modify the XML. If you specify
style => 'filter' then all tags for which you do not specify a subroutine rule or that occure inside such a tag are copied to the output filehandle
passed to the ->filter() or ->filterfile() methods.
The "ident" specifies what character(s) to use to ident the tags when filtering, by default the tags are not formatted in any way. If the
"reformat_all" is not set then this affects only the tags that have a rule and their subtags. And in case of subtags only those that were
added into the attribute hash by their rules, not those left in the _content array!
The "warnoverwrite" instructs XML::Rules to issue a warning whenever the rule cause a key in a tag's hash to be overwritten by new
data produced by the rule of a subtag. This happens eg. if a tag is repeated and its rule doesn't expect it.
The "encode" allows you to ask the module to run all data through Encode::encode( 'encoding_specification', ...)
before being passed to the rules. Otherwise all data comes as UTF8.
The "output_encoding" on the other hand specifies in what encoding is the resulting data going to be, the default is again UTF8.
This means that if you specify
encode => 'windows-1250',
output_encoding => 'utf8',
and the XML is in ISO-8859-2 (Latin2) then the filter will 1) convert the content and attributes of the tags you are not interested in from Latin2
directly to utf8 and output and 2) convert the content and attributes of the tags you want to process from Latin2 to Windows-1250, let you mangle
the data and then convert the results to utf8 for the output.
The C<encode> and C<output_enconding> affects also the C<$parser->toXML(...)>, if they are different then the data are converted from
one encoding to the other.
=head2 The Rules
The rules option may be either an arrayref or a hashref, the module doesn't care, but if you want to use regexps to specify the groups of tags to be handled
by the same rule you should use the array ref. The rules array/hash is made of pairs in form
tagspecification => action
where the tagspecification may be either a name of a tag, a string containing comma or pipe ( "|" ) delimited list of tag names
or a string containing a regexp enclosed in // with optional parameters or a qr// compiled regular expressions. The tag names and tag name lists
take precedence to the regexps, the regexps are (in case of arrayref only!!!) tested in the order in which they are specified.
These rules are evaluated/executed whenever a tag if fully parsed including all the content and child tags and they may access the content and attributes of the
specified tag plus the stuff produced by the rules evaluated for the child tags.
The action may be either
an undef or empty string = ignore the tag and all its children
a subroutine reference = the subroutine will be called to handle the tag data&contents
sub { my ($tagname, $attrHash, $contexArray, $parentDataArray, $parser) = @_; ...}
'content' = only the content of the tag is preserved and added to
the parent tag's hash as an attribute named after the tag
sub { $_[0] => $_[1]->{_content}}
'content trim' = only the content of the tag is preserved, trimmed and added to
the parent tag's hash as an attribute named after the tag
sub { s/^\s+//,s/\s+$// for ($_[1]->{_content}); $_[0] => $_[1]->{_content}}
'content array' = only the content of the tag is preserved and pushed
to the array pointed to by the attribute
sub { '@' . $_[0] => $_[1]->{_content}}
'as is' = the tag's hash is added to the parent tag's hash
as an attribute named after the tag
sub { $_[0] => $_[1]}
'as is trim' = the tag's hash is added to the parent tag's hash
as an attribute named after the tag, the content is trimmed
sub { $_[0] => $_[1]}
'as array' = the tag's hash is pushed to the attribute named after the tag
in the parent tag's hash
sub { '@'.$_[0] => $_[1]}
'as array trim' = the tag's hash is pushed to the attribute named after the tag
in the parent tag's hash, the content is trimmed
sub { '@'.$_[0] => $_[1]}
'no content' = the _content is removed from the tag's hash and the hash
is added to the parent's hash into the attribute named after the tag
sub { delete $_[1]->{_content}; $_[0] => $_[1]}
'no content array' = similar to 'no content' except the hash is pushed
into the array referenced by the attribute
'as array no content' = same as 'no content array'
'pass' = the tag's hash is dissolved into the parent's hash,
that is all tag's attributes become the parent's attributes.
The _content is appended to the parent's _content.
sub { %{$_[0]}}
'pass no content' = the _content is removed and the hash is dissolved
into the parent's hash.
sub { delete $_[1]->{_content}; %{$_[0]}}
'pass without content' = same as 'pass no content'
'raw' = the [tagname => attrs] is pushed to the parent tag's _content.
You would use this style if you wanted to be able to print
the parent tag as XML preserving the whitespace or other textual content
sub { [$_[0] => $_[1]]}
'raw extended' = the [tagname => attrs] is pushed to the parent tag's _content
and the attrs are added to the parent's attribute hash with ":$tagname" as the key
sub { (':'.$_[0] => $_[1], [$_[0] => $_[1]])};
'raw extended array' = the [tagname => attrs] is pushed to the parent tag's _content
and the attrs are pushed to the parent's attribute hash with ":$tagname" as the key
sub { ('@:'.$_[0] => $_[1], [$_[0] => $_[1]])};
'by <attrname>' = uses the value of the specified attribute as the key when adding the
attribute hash into the parent tag's hash. You can specify more names, in that case
the first found is used.
sub {delete($_[1]->{name}) => $_[1]}
'content by <attrname>' = uses the value of the specified attribute as the key when adding the
tags content into the parent tag's hash. You can specify more names, in that case
the first found is used.
sub {$_[1]->{name} => $_[1]->{_content}}
'no content by <attrname>' = uses the value of the specified attribute as the key when adding the
attribute hash into the parent tag's hash. The content is dropped. You can specify more names,
in that case the first found is used.
sub {delete($_[1]->{_content}); delete($_[1]->{name}) => $_[1]}
'==...' = replace the tag by the specified string. That is the string will be added to
the parent tag's _content
sub { return '...' }
'=...' = replace the tag contents by the specified string and forget the attributes.
sub { return $_[0] => '...' }
You may also add " no xmlns" at the end of all those predefined rules to strip the namespace
alias from the $_[0] (tag name).
The subroutines in the rules specification receive five parameters:
$rule->( $tag_name, \%attrs, \@context, \@parent_data, $parser)
It's OK to destroy the first two parameters, but you should treat the other three as read only
or at least treat them with care!
$tag_name = string containing the tag name
\%attrs = hash containing the attributes of the tag plus the _content key
containing the text content of the tag. If it's not a leaf tag it may
also contain the data returned by the rules invoked for the child tags.
\@context = an array containing the names of the tags enclosing the current
one. The parent tag name is the last element of the array.
\@parent_data = an array containing the hashes with the attributes
and content read&produced for the enclosing tags so far.
You may need to access this for example to find out the version
of the format specified as an attribute of the root tag. You may
safely add, change or delete attributes in the hashes, but all bets
are off if you change the number or type of elements of this array!
$parser = the parser object.
The subroutine may decide to handle the data and return nothing or
tweak the data as necessary and return just the relevant bits. It may also
load more information from elsewhere based on the ids found in the XML
and provide it to the rules of the ancestor tags as if it was part of the XML.
The possible return values of the subroutines are:
1) nothing or undef or "" - nothing gets added to the parent tag's hash
2) a single string - if the parent's _content is a string then the one produced by this rule is appended to the parent's _content.
If the parent's _content is an array, then the string is push()ed to the array.
3) a single reference - if the parent's _content is a string then it's changed to an array containing the original string and this reference.
If the parent's _content is an array, then the string is push()ed to the array.
4) an even numbered list - it's a list of key & value pairs to be added to the parent's hash.
The handling of the attributes may be changed by adding '@', '%', '+', '*' or '.' before the attribute name.
Without any "sigil" the key & value is added to the hash overwriting any previous values.
The values for the keys starting with '@' are push()ed to the arrays referenced by the key name
without the @. If there already is an attribute of the same name then the value will be preserved and will become
the first element in the array.
The values for the keys starting with '%' have to be either hash or array references. The key&value pairs
in the referenced hash or array will be added to the hash referenced by the key. This is nice for rows of tags like this:
<field name="foo" value="12"/>
<field name="bar" value="24"/>
if you specify the rule as
field => sub { '%fields' => [$_[1]->{name} => $_[1]->{value}]}
then the parent tag's has will contain
fields => {
foo => 12,
bar => 24,
}
The values for the keys starting with '+' are added to the current value, the ones starting with '.' are
appended to the current value and the ones starting with '*' multiply the current value.
5) an odd numbered list - the last element is appended or push()ed to the parent's _content, the rest is handled as in the previous case.
Since 0.19 it's possible to specify several actions for a tag if you need to do something different based on the path to the tag like this:
tagname => [
'tag/path' => action,
'/root/tag/path' => action,
'/root/*/path' => action,
qr{^root/ns:[^/]+/par$} => action,
default_action
],
The path is matched against the list of parent tags joined by slashes.
=head2 The Start Rules
Apart from the normal rules that get invoked once the tag is fully parsed, including the contents and child tags, you may want to
attach some code to the start tag to (optionaly) skip whole branches of XML or set up attributes and variables. You may set up
the start rules either in a separate parameter to the constructor or in the rules=> by prepending the tag name(s) by ^.
These rules are in form
tagspecification => undef / '' / 'skip' --> skip the element, including child tags
tagspecification => 1 / 'handle' --> handle the element, may be needed
if you specify the _default rule.
tagspecification => \&subroutine
The subroutines receive the same parameters as for the "end tag" rules except of course the _content, but their return value is treated differently.
If the subroutine returns a false value then the whole branch enclosed by the current tag is skipped, no data are stored and no rules are
executed. You may modify the hash referenced by $attr.
Both types of rules are free to store any data they want in $parser->{pad}. This property is NOT emptied
after the parsing!
=head2 Whitespace handling
There are two options that affect the whitespace handling: stripspaces and normalisespaces. The normalisespaces is a simple flag that controls
whether multiple spaces/tabs/newlines are collapsed into a single space or not. The stripspaces is more complex, it's a bit-mask,
an ORed combination of the following options:
0 - don't remove whitespace around tags
(around tags means before the opening tag and after the closing tag, not in the tag's content!)
1 - remove whitespace before tags whose rules did not return any text content
(the rule specified for the tag caused the data of the tag to be ignored,
processed them already or added them as attributes to parent's \%attr)
2 - remove whitespace around tags whose rules did not return any text content
3 - remove whitespace around all tags
0 - remove only whitespace-only content
(that is remove the whitespace around <foo/> in this case "<bar> <foo/> </bar>"
but not this one "<bar>blah <foo/> blah</bar>")
4 - remove trailing/leading whitespace
(remove the whitespace in both cases above)
0 - don't trim content
8 - do trim content
(That is for "<foo> blah </foo>" only pass to the rule {_content => 'blah'})
That is if you have a data oriented XML in which each tag contains either text content or subtags, but not both,
you want to use stripspaces => 3 or stripspaces => 3|4. This will not only make sure you don't need to bother
with the whitespace-only _content of the tags with subtags, but will also make sure you do not keep on wasting
memory while parsing a huge XML and processing the "twigs". Without that option the parent tag of
the repeated tag would keep on accumulating unneeded whitespace in its _content.
=cut
sub new {
my $class = shift;
my %params = @_;
croak "Please specify the rules=> for the parser!" unless $params{rules} and ref($params{rules});
my $self = {rules => {}, start_rules => {}};
bless $self, $class;
my @rules = (ref($params{rules}) eq 'HASH' ? %{$params{rules}} : @{$params{rules}}); # dereference and copy
delete $params{rules};
my @start_rules;
if ($params{start_rules} and ref($params{start_rules})) {
@start_rules = ref($params{start_rules}) eq 'HASH' ? %{$params{start_rules}} : @{$params{start_rules}}; # dereference and copy
};
delete $params{start_rules};
for (my $i=0; $i <= $#rules; $i+=2) {
next unless $rules[$i] =~ s/^\^//;
push @start_rules, splice( @rules, $i, 2);
$i-=2;
}
$self->_split_rules( \@rules, 'rules', 'as is');
$self->_split_rules( \@start_rules, 'start_rules', 'handle');
$self->{for_parser} = {};
{ # extract the params for the XML::Parser::Expat constructor
my @for_parser = grep exists($params{$_}), qw(ProtocolEncoding Namespaces NoExpand Stream_Delimiter ErrorContext ParseParamEnt Base);
if (@for_parser) {
@{$self->{for_parser}}{@for_parser} = @params{@for_parser};
delete @params{@for_parser};
}
}
$self->{namespaces} = delete($params{namespaces});
if (defined($self->{namespaces})) {
croak 'XML::Rules->new( ... , namespaces => ...HERE...) must be a hash reference!'
unless ref($self->{namespaces}) eq 'HASH';
$self->{xmlns_map} = {};
}
$self->{style} = delete($params{style}) || 'parser';
$self->{opt}{lc $_} = $params{$_} for keys %params;
delete $self->{opt}{encode} if $self->{opt}{encode} =~ /^utf-?8$/i;
delete $self->{opt}{output_encoding} if $self->{opt}{output_encoding} =~ /^utf-?8$/i;
for (qw(normalisespace normalizespace normalizespaces)) {
last if defined($self->{opt}{normalisespaces});
$self->{opt}{normalisespaces} = $self->{opt}{$_};
delete $self->{opt}{$_};
}
$self->{opt}{normalisespaces} = 0 unless(defined($self->{opt}{normalisespaces}));
$self->{opt}{stripspaces} = 0 unless(defined($self->{opt}{stripspaces}));
require 'Encode.pm' if $self->{opt}{encode};
require 'Encode.pm' if $self->{opt}{output_encoding};
return $self;
}
sub _split_rules {
my ($self, $rules, $type, $default) = @_;
$self->{$type}{_default} = $default unless exists($self->{$type}{_default});
while (@$rules) {
my ($tag, $code) = (shift(@$rules), shift(@$rules));
if (ref($code) eq 'ARRAY') {
for( my $i = 0; $i < $#$code; $i+=2) {
$code->[$i] = _xpath2re($code->[$i]);
}
push @$code, $self->{$type}{_default} if @$code % 2 == 0; # add the default type if there's even number of items (path => code, path => code)
}
if ($tag =~ m{^/([^/].*)/([imosx]*)$}) { # string with a '/regexp/'
if ($2) {
push @{$self->{$type.'_re'}}, qr/(?$2)$1/;
} else {
push @{$self->{$type.'_re'}}, qr/$1/;
}
push @{$self->{$type.'_re_code'}}, $code;
} elsif (ref($tag) eq 'Regexp') { # a qr// created regexp
push @{$self->{$type.'_re'}}, $tag;
push @{$self->{$type.'_re_code'}}, $code;
} elsif ($tag =~ /[,\|]/) { # a , or | separated list
if ($tag =~ s/^\^//) {
my @tags = split(/\s*[,\|]\s*/, $tag);
$self->{$type}{'^'.$_} = $code for (@tags);
} else {
my @tags = split(/\s*[,\|]\s*/, $tag);
$self->{$type}{$_} = $code for (@tags);
}
} else { # a single tag
$self->{$type}{$tag} = $code;
}
}
}
sub _xpath2re {
my $s = shift;
return $s if ref($s);
for ($s) {
s/([\.\[\]+{}\-])/\\$1/g;
s{\*}{.+}g;
s{^//}{}s;
s{^/}{^}s;
}
return qr{$s$};
}
sub skip_rest {
die "[XML::Rules] skip rest\n";
}
sub return_nothing {
die "[XML::Rules] return nothing\n";
}
sub _run {
my $self = shift;
my $string = shift;
$self->{parameters} = shift;
$self->{parser} = XML::Parser::Expat->new( %{$self->{for_parser}});
$self->{parser}->setHandlers(
Start => _Start($self),
End => _End($self),
Char => _Char($self),
XMLDecl => _XMLDecl($self),
);
$self->{data} = [];
$self->{context} = [];
$self->{_ltrim} = [0];
if (! eval {
$self->{parser}->parse($string) and 1;
}) {
my $err = $@;
undef $@;
if ($err =~ /^\[XML::Rules\] skip rest/) {
my (undef, $handler) = $self->{parser}->setHandlers(End => undef);
foreach my $tag (reverse @{$self->{context} = []}) {
$handler->( $self->{parser}, $tag);
}
} else {
delete $self->{normal_handlers};
delete $self->{ignore_handlers};
delete $self->{parameters};
$self->{parser}->release();
$self->{data} = [];
$self->{context} = [];
if ($err =~ /^\[XML::Rules\] return nothing/) {
return;
}
$err =~ s/at \S+Rules\.pm line \d+$//
and croak $err or die $err;
}
};
delete $self->{normal_handlers};
delete $self->{ignore_handlers};
$self->{parser}->release();
delete $self->{parameters};
my $data; # return the accumulated data, without keeping a copy inside the object
($data, $self->{data}) = ($self->{data}[0], undef);
if (!defined(wantarray()) or ! keys(%$data)) {
return;
} elsif (keys(%$data) == 1 and exists(${$data}{_content})) {
if (ref(${$data}{_content}) eq 'ARRAY' and @{${$data}{_content}} == 1) {
return ${${$data}{_content}}[0]
} else {
return ${$data}{_content}
}
} else {
return $data;
}
}
sub parsestring;
*parsestring = \&parse;
sub parse {
my $self = shift;
croak("This XML::Rules object may only be used as a filter!") if ($self->{style} eq 'filter');
$self->_run(@_);
}
sub parsefile {
my $self = shift;
croak("This XML::Rules object may only be used as a filter!") if ($self->{style} eq 'filter');
my $filename = shift;
open my $IN, '<', $filename or croak "Cannot open '$filename' for reading: $^E";
return $self->_run($IN, @_);
}
sub filterstring;
*filterstring = \&filter;
sub filter {
my $self = shift;
croak("This XML::Rules object may only be used as a parser!") unless ($self->{style} eq 'filter');
my $XML = shift;
$self->{FH} = shift || select(); # either passed or the selected filehandle
if (!ref($self->{FH})) {
if ($self->{FH} =~ /^main::(?:STDOUT|STDERR)$/) {
# yeah, select sometimes returns the name of the filehandle, not the filehandle itself. eg. "main::STDOUT"
no strict;
$self->{FH} = \*{$self->{FH}};
} else {
open my $FH, '>', $self->{FH} or croak(qq{Failed to open "$self->{FH}" for writing: $^E});
$self->{FH} = $FH;
}
} elsif (ref($self->{FH}) eq 'SCALAR') {
open my $FH, '>', $self->{FH};
$self->{FH} = $FH;
}
if ($self->{opt}{output_encoding}) {
print {$self->{FH}} qq{<?xml version="1.0" encoding="$self->{opt}{output_encoding}"?>\n};
} else {
print {$self->{FH}} qq{<?xml version="1.0"?>\n};
}
$self->_run($XML, @_);
print {$self->{FH}} "\n";
delete $self->{FH};
}
sub filterfile {
my $self = shift;
croak("This XML::Rules object may only be used as a parser!") unless ($self->{style} eq 'filter');
my $filename = shift;
open my $IN, '<', $filename or croak "Cannot open '$filename' for reading: $^E";
$self->{FH} = shift || select(); # either passed or the selected filehandle
if (!ref($self->{FH})) {
if ($self->{FH} =~ /^main::(?:STDOUT|STDERR)$/) {
# yeah, select sometimes returns the name of the filehandle, not the filehandle itself. eg. "main::STDOUT"
no strict;
$self->{FH} = \*{$self->{FH}};
} else {
open my $FH, '>', $self->{FH} or croak(qq{Failed to open "$self->{FH}" for writing: $^E});
$self->{FH} = $FH;
}
} elsif (ref($self->{FH}) eq 'SCALAR') {
open $self->{FH}, '>', $self->{FH};
}
if ($self->{opt}{output_encoding}) {
print {$self->{FH}} qq{<?xml version="1.0" encoding="$self->{opt}{output_encoding}"?>\n};
} else {
print {$self->{FH}} qq{<?xml version="1.0"?>\n};
}
$self->_run($IN, @_);
print {$self->{FH}} "\n";
delete $self->{FH};
}
sub _XMLDecl {
my $self = shift;
return sub {
my ( $Parser, $Version, $Encoding, $Standalone) = @_;
$self->{opt}{original_encoding} = $Encoding
}
}
=begin comment
start tag
& 3 = 3 -> rtrim parent's _content
& 8 = 8 -> $ltrim = 1
string content
$ltrim -> ltrim the string, if not completely whitespace set $ltrim 0
end tag
& 8 = 8 -> rtrim own content
& 3 = 3 -> $ltrim = 1
empty_returned_content and & 3 in (1,2) -> rtrim parent content
empty_returned_content and & 3 = 2 -> $ltrim
=end comment
=cut
sub _rtrim {
my ($self, $attr, $more) = @_;
if ($more) {
if (ref $attr->{_content}) {
if (!ref($attr->{_content}[-1])) {
$attr->{_content}[-1] =~ s/\s+$//s;
pop @{$attr->{_content}} if $attr->{_content}[-1] eq '';
delete $attr->{_content} unless @{$attr->{_content}};
}
} else {
$attr->{_content} =~ s/\s+$//s;
delete $attr->{_content} if $attr->{_content} eq '';
}
} else {
if (ref $attr->{_content}) {
if (!ref($attr->{_content}[-1]) and $attr->{_content}[-1] =~ /^\s*$/s) {
pop @{$attr->{_content}} ;
delete $attr->{_content} unless @{$attr->{_content}};
}
} else {
delete $attr->{_content} if $attr->{_content} =~ /^\s*$/s;
}
}
}
sub _Start {
my $self = shift;
my $encode = $self->{opt}{encode};
my $output_encoding = $self->{opt}{output_encoding};
return sub {
my ( $Parser, $Element , %Attr) = @_;
if (($self->{opt}{stripspaces} & 3) == 3) {
#rtrim parent
#print "rtrim parent content in _Start\n";
if ($self->{data}[-1] and $self->{data}[-1]{_content}) {
$self->_rtrim( $self->{data}[-1], ($self->{opt}{stripspaces} & 4));
}
}
if ($self->{opt}{stripspaces} & 8) {
#print "ltrim own content in _Start\n";
push @{$self->{_ltrim}}, 2;
} else {
push @{$self->{_ltrim}}, 0;
}
if ($self->{namespaces}) {
my %restore;
if (exists $Attr{xmlns}) { # find the default namespace
#print "Found a xmlns attribute in $Element!\n";
$restore{''} = $self->{xmlns_map}{''};
if (!exists($self->{namespaces}{ $Attr{xmlns} })) {
warn qq{Unexpected namespace "$Attr{xmlns}" found in the XML!\n} unless exists $self->{namespaces}{'*'};
delete $self->{xmlns_map}{''};
delete $restore{''} unless defined($restore{''});
delete($Attr{xmlns});
} else {
$self->{xmlns_map}{''} = $self->{namespaces}{ delete($Attr{xmlns}) };
}
}
foreach my $attr (keys %Attr) { # find the namespace aliases
next unless $attr =~ /^xmlns:(.*)$/;
$restore{$1} = $self->{xmlns_map}{$1};
if (!exists($self->{namespaces}{ $Attr{$attr} })) {
warn qq{Unexpected namespace "$Attr{$attr}" found in the XML!\n} unless exists $self->{namespaces}{'*'};
delete $self->{xmlns_map}{$1};
delete $restore{$1} unless defined($restore{$1});
delete($Attr{$attr});
} else {
$self->{xmlns_map}{$1} = $self->{namespaces}{ delete($Attr{$attr}) };
}
}
if (%restore) {
push @{$self->{xmlns_restore}}, \%restore;
} else {
push @{$self->{xmlns_restore}}, undef;
}
if (%{$self->{xmlns_map}}) {
#print "About to map aliases for $Element\n";
# add or map the alias for the tag
if ($Element =~ /^([^:]+):(.*)$/) {
#print "Mapping an alias $1 for tag $Element\n";
if (exists($self->{xmlns_map}{$1})) {
if ($self->{xmlns_map}{$1} eq '') {
$Element = $2 ;
} else {
$Element = $self->{xmlns_map}{$1} . ':' . $2 ;
}
}
#print " -> $Element\n";
} elsif (defined($self->{xmlns_map}{''}) and $self->{xmlns_map}{''} ne '') { # no namespace alias in the tag and there's a default
#print "Adding default alias $self->{xmlns_map}{''}:\n";
$Element = $self->{xmlns_map}{''} . ':' . $Element;
#print " -> $Element\n";
}
# map the aliases for the attributes
foreach my $attr (keys %Attr) {
next unless $attr =~ /^([^:]+):(.*)$/; # there's an alias
next unless exists($self->{xmlns_map}{$1}); # and there's a mapping
if ($self->{xmlns_map}{$1} eq '') {
$Attr{$2} = delete($Attr{$attr}); # rename the attribute
} else {
$Attr{$self->{xmlns_map}{$1} . ':' . $2} = delete($Attr{$attr}); # rename the attribute
}
}
}
} # /of namespace handling
my ( $start_rule, $end_rule) = map {
if ($self->{$_}{$Element} and ref($self->{$_}{$Element}) ne 'ARRAY') {
$self->{$_}{$Element}
} else {
$self->_find_rule( $_, $Element, $self->{context})
}
} ( 'start_rules', 'rules');
if ($start_rule ne 'handle'
and (
!$start_rule
or $start_rule eq 'skip'
or !$start_rule->($Element,\%Attr, $self->{context}, $self->{data}, $self)
)
) {
# ignore the tag and the ones below
if (exists $self->{ignore_handlers}) {
#print "SETHANDLERS!\n";
$Parser->setHandlers(@{$self->{ignore_handlers}})
} else {
$self->{ignore_handlers} = [
Start => _StartIgnore($self),
Char => undef,
End => _EndIgnore($self),
];
#print "SETHANDLERS2\n";
$self->{normal_handlers} = [$Parser->setHandlers(@{$self->{ignore_handlers}})];
}
$self->{ignore_level}=1;
} else {
# process the tag and the ones below
if ($encode) {
foreach my $value (values %Attr) {
$value = Encode::encode( $encode, $value);
}
}
push @{$self->{context}}, $Element;
push @{$self->{data}}, \%Attr;
$self->{lastempty} = 0;
if ($self->{style} eq 'filter') {
$self->{in_interesting}++ if ref($end_rule) or $end_rule =~ /^=/s; # is this tag interesting?
if (! $self->{in_interesting}) { # it neither this tag not an acestor is interesting, just copy the tag
#print "Start:R ".$Parser->recognized_string()."\n";
#print "Start:O ".$Parser->original_string()."\n";
#print "Start:R ".$Parser->recognized_string()."\n";
#print "Start:O ".$Parser->original_string()."\n";
if (! $output_encoding) {
print {$self->{FH}} $Parser->recognized_string();
} elsif ($output_encoding eq $self->{opt}{original_encoding}) {
print {$self->{FH}} $Parser->original_string();
} else {
print {$self->{FH}} $self->toXML($Element, \%Attr, "don't close");
}
}
}
}
}
}
sub _find_rule {
my ($self, $type, $Element, $path) = @_;
if (exists($self->{$type.'_re'})) {
for(my $i = 0; $i < @{$self->{$type.'_re'}}; $i++) {
if ($Element =~ $self->{$type.'_re'}[$i]) {
$self->{$type}{$Element} = $self->{$type.'_re_code'}[$i];
last;
}
}
}
if (! exists $self->{$type}{$Element}) {
$self->{$type}{$Element} = $self->{$type}{_default};
}
if (ref $self->{$type}{$Element} eq 'ARRAY') {
$path = join( '/', @$path);
for(my $i=0; $i < $#{$self->{$type}{$Element}}; $i+=2) {
if ($path =~ $self->{$type}{$Element}[$i]) {
return $self->{$type}{$Element}[$i+1];
}
}
return $self->{$type}{$Element}[-1];
} else {
return $self->{$type}{$Element};
}
}
sub _Char {
my $self = shift;
my $encode = $self->{opt}{encode};
return sub {
my ( $Parser, $String) = @_;
if ($self->{style} eq 'filter' and ! $self->{in_interesting}) {
if (! $self->{opt}{output_encoding}) {
print {$self->{FH}} $Parser->recognized_string();
} elsif ($self->{opt}{output_encoding} eq $self->{opt}{original_encoding}) {
print {$self->{FH}} $Parser->original_string();
} else {
print {$self->{FH}} encode($self->{opt}{output_encoding}, $Parser->recognized_string());
}
return;
}
if ($encode) {
$String = Encode::encode( $encode, $String);
}
if ($self->{_ltrim}[-1]) {
#print "ltrim in $self->{context}[-1] ($String)\n";
if ($self->{_ltrim}[-1] == 2) {
$String =~ s/^\s+//s;
return if $String eq '';
} else {
return if $String =~ /^\s*$/s;
}
$self->{_ltrim}[-1] = 0;
#print " ($String)\n";
}
$String =~ s/\s+/ /gs if ($self->{opt}{normalisespaces});
if (!exists $self->{data}[-1]{_content}) {
$self->{data}[-1]{_content} = $String;
} elsif (!ref $self->{data}[-1]{_content}) {
if ($self->{opt}{normalisespaces} and $self->{data}[-1]{_content} =~ /\s$/ and $String =~ /^\s/) {
$String =~ s/^\s+//s;
}
$self->{data}[-1]{_content} .= $String;
} else {
if (ref $self->{data}[-1]{_content}[-1]) {
push @{$self->{data}[-1]{_content}}, $String;
} else {
if ($self->{opt}{normalisespaces} and $self->{data}[-1]{_content}[-1] =~ /\s$/ and $String =~ /^\s/) {
$String =~ s/^\s+//s;
}
$self->{data}[-1]{_content}[-1] .= $String;
}
}
}
}
sub _End {
my $self = shift;
return sub {
my ( $Parser, $Element) = @_;
$Element = pop @{$self->{context}}; # the element name may have been mangled by XMLNS aliasing
if ($self->{opt}{stripspaces} & 8) {
#print "rtrim own content\n";
if ($self->{data}[-1] and $self->{data}[-1]{_content}) {
$self->_rtrim( $self->{data}[-1], 1);
}
}
pop(@{$self->{_ltrim}});
if ($self->{namespaces}) {
if (my $restore = pop @{$self->{xmlns_restore}}) { # restore the old default namespace and/or alias mapping
while (my ($their, $our) = each %$restore) {
if (defined($our)) {
$self->{xmlns_map}{$their} = $our;
} else {
delete $self->{xmlns_map}{$their};
}
}
}
}
my ($rule) = map {
if ($self->{$_}{$Element} and ref($self->{$_}{$Element}) ne 'ARRAY') {
$self->{$_}{$Element}
} else {
$self->_find_rule( $_, $Element, $self->{context})
}
} ('rules');
my $data = pop @{$self->{data}};
my @results;
if (ref $rule or $rule =~ /^=/s) {
if ($rule =~ /^==(.*)$/s) { # change the whole tag to a string
@results = ($1);
} elsif ($rule =~ /^=(.*)$/s) { # change the contents to a string
@results = ($Element => $1);
} else {
@results = $rule->($Element, $data, $self->{context}, $self->{data}, $self);
}
if ($self->{style} eq 'filter') {
$self->{in_interesting}--;
if (!$self->{in_interesting}) {
if (@{$self->{data}}) {
print {$self->{FH}} $self->escape_value($self->{data}[-1]{_content});
delete $self->{data}[-1]{_content};
}
my $base;
if ($self->{opt}{ident} ne '') {
$base = $self->{opt}{ident} x scalar(@{$self->{context}});
}
@results and $results[0] =~ s/^[\@%\+\*\.]//;
while (@results) {
#use Data::Dumper;
#print "\@results=".Dumper(\@results)."\n";
if (ref($results[0])) {
croak(ref($results[0]) . " not supported as the return value of a filter") unless ref($results[0]) eq 'ARRAY';
if (@{$results[0]} ==2 and ref($results[0][1]) eq 'HASH') {
print {$self->{FH}} $self->toXML(@{$results[0]}[0,1], 0, $self->{opt}{ident}, $base);
} else {
foreach my $item (@{$results[0]}) {
if (ref($item)) {
croak(ref($item) . " not supported in the return value of a filter") unless ref($item) eq 'ARRAY';
croak("Empty array not supported in the return value of a filter") unless @$item;
if (@$item <= 2) {
print {$self->{FH}} $self->toXML(@{$item}[0,1], 0, $self->{opt}{ident}, $base);
} else { # we suppose the 3rd and following elements are parameters to ->toXML()
print {$self->{FH}} $self->toXML(@$item);
}
} else {
print {$self->{FH}} $self->escape_value($item);
}
}
}
shift(@results);
} else {
if (@results == 1) {
print {$self->{FH}} $self->escape_value($results[0]);
@results = ();last;
} else {
print {$self->{FH}} $self->toXML(shift(@results), shift(@results), 0, $self->{opt}{ident}, $base);
}
}
}
}
}
} elsif ($self->{style} eq 'filter' and ! $self->{in_interesting}) {
#print "End: \$Element=$Element; \$Parser->recognized_string()=".$Parser->recognized_string()."; \$Parser->original_string()=".$Parser->original_string()."\n";
die "Unexpected \$data->{content}={$data->{_content}} in filter outside interesting nodes!\n" if $data->{_content} ne '';
if (! $self->{opt}{output_encoding}) {
print {$self->{FH}} $Parser->recognized_string();
} elsif ($self->{opt}{output_encoding} eq $self->{opt}{original_encoding}) {
print {$self->{FH}} $Parser->original_string();
} else {
print {$self->{FH}} encode($self->{opt}{output_encoding}, $Parser->recognized_string());
}
# print {$self->{FH}} $self->escape_value($data->{_content})."</$Element>";
} else { # a predefined rule
if ($rule =~ s/(?:^| )no xmlns$//) {
$Element =~ s/^\w+://;
$rule = 'as_is' if $rule eq '';
}
if ($rule eq '') {
@results = ();
} elsif ($rule eq 'content') {
@results = ($Element => $data->{_content});
} elsif ($rule eq 'content trim') {
s/^\s+//,s/\s+$// for ($data->{_content});
@results = ($Element => $data->{_content});
} elsif ($rule eq 'content array') {
@results = ('@'.$Element => $data->{_content});
} elsif ($rule eq 'as is') {
@results = ($Element => $data);
} elsif ($rule eq 'as is trim') {
s/^\s+//,s/\s+$// for ($data->{_content});
@results = ($Element => $data);
} elsif ($rule eq 'as array') {
@results = ('@'.$Element => $data);
} elsif ($rule eq 'as array trim') {
s/^\s+//,s/\s+$// for ($data->{_content});
@results = ('@'.$Element => $data);
} elsif ($rule eq 'no content') {
delete ${$data}{_content}; @results = ($Element => $data);
} elsif ($rule eq 'no content array' or $rule eq 'as array no content') {
delete ${$data}{_content}; @results = ('@' . $Element => $data);
} elsif ($rule eq 'pass') {
@results = (%$data);
} elsif ($rule eq 'pass trim') {
s/^\s+//,s/\s+$// for ($data->{_content});
@results = (%$data);
} elsif ($rule eq 'pass no content' or $rule eq 'pass without content') {
delete ${$data}{_content}; @results = (%$data);
} elsif ($rule eq 'raw') {
@results = [$Element => $data];
} elsif ($rule eq 'raw extended') {
@results = (':'.$Element => $data, [$Element => $data]);
} elsif ($rule eq 'raw extended array') {
@results = ('@:'.$Element => $data, [$Element => $data]);
} elsif ($rule =~ /^((?:no )?content )?by\s+(\S+)$/) {
my ($cnt,$attr) = ($1,$2);
if ($cnt eq 'no content ') {
delete $data->{_content};
}
if ($attr =~ /,/) {
my @attr = split /,/, $attr;
foreach (@attr) {
next unless exists ($data->{$_});
if ($cnt eq 'content ') {
@results = ($data->{$_} => $data->{_content})
} else {
@results = (delete $data->{$_} => $data)
}
last;
}
} else {
if ($cnt eq 'content ') {
@results = ($data->{$attr} => $data->{_content})
} else {
@results = (delete $data->{$attr} => $data);
}
}
} else {
croak "Unknown predefined rule '$rule'!";
}
}
if (! @results or (@results % 2 == 0) or $results[-1] eq '') {
if ($self->{opt}{stripspaces} & 3 and @{$self->{data}} and $self->{data}[-1]{_content}) { # stripping some spaces, it's not root and it did not return content
#print "maybe stripping some spaces in $Element, it's not root and it did not return content\n";
if (($self->{opt}{stripspaces} & 3) < 3 and $self->{data}[-1]{_content}) {
# rtrim parent content
#print " yes, rtrim parent '$self->{data}[-1]{_content}'\n";
$self->_rtrim( $self->{data}[-1], ($self->{opt}{stripspaces} & 4));
#print " result '$self->{data}[-1]{_content}'\n";
}
$self->{_ltrim}[-1] = (($self->{opt}{stripspaces} & 4) ? 2 : 1)
if ($self->{opt}{stripspaces} & 3) == 2;
}
} else {
$self->{_ltrim}[-1] = 0;
}
if (($self->{opt}{stripspaces} & 3) == 3) {
$self->{_ltrim}[-1] = (($self->{opt}{stripspaces} & 4) ? 2 : 1);
}
return unless scalar(@results) or scalar(@results) == 1 and ($results[0] eq '' or !defined($results[0]));
@{$self->{data}} = ({}) unless @{$self->{data}}; # oops we are already closing the root tag! We do need there to be at least one hashref in $self->{data}
if (scalar(@results) % 2) {
# odd number of items, last is content
my $value = pop(@results);
_add_content( $self->{data}[-1], $value);
}
while (@results) {
my ($key, $value) = ( shift(@results), shift(@results));
if ($key eq '_content') {
_add_content( $self->{data}[-1], $value);
} elsif ($key =~ s/^\@//) {
if (exists($self->{data}[-1]{$key}) and ref($self->{data}[-1]{$key}) ne 'ARRAY') {
$self->{data}[-1]{$key} = [$self->{data}[-1]{$key}, $value];
} else {
push @{$self->{data}[-1]{$key}}, $value;
}
} elsif ($key =~ s/^\+//) {
if (exists($self->{data}[-1]{$key})) {
$self->{data}[-1]{$key} += $value;
} else {
$self->{data}[-1]{$key} = $value;
}
} elsif ($key =~ s/^\*//) {
if (exists($self->{data}[-1]{$key})) {
$self->{data}[-1]{$key} *= $value;
} else {
$self->{data}[-1]{$key} = $value;
}
} elsif ($key =~ s/^\.//) {
if (exists($self->{data}[-1]{$key})) {
$self->{data}[-1]{$key} .= $value;
} else {
$self->{data}[-1]{$key} = $value;
}
} elsif ($key =~ s/^\%//) {
if (exists($self->{data}[-1]{$key})) {
if (ref($value) eq 'HASH') {
%{$self->{data}[-1]{$key}} = (%{$self->{data}[-1]{$key}}, %$value);
} elsif (ref($value) eq 'ARRAY') {
%{$self->{data}[-1]{$key}} = (%{$self->{data}[-1]{$key}}, @$value);
} else {
croak "The value of the rule return \%$key must be a hash or array ref!";
}
} else {
if (ref($value) eq 'HASH') {
$self->{data}[-1]{$key} = $value;
} elsif (ref($value) eq 'ARRAY') {
$self->{data}[-1]{$key} = {@$value};
} else {
croak "The value of the rule return \%$key must be a hash or array ref!";
}
}
} else {
warn "The attribute '$key' already exists for tag $self->{context}[-1].\n old value: $self->{data}[-1]{$key}\n new value: $value\n"
if ($self->{opt}{warnoverwrite} and exists $self->{data}[-1]{$key} and $self->{data}[-1]{$key} ne $value);
$self->{data}[-1]{$key} = $value;
}
}
}
}
sub _StartIgnore {
my ($self) = shift;
return sub {
$self->{ignore_level}++
}
}
sub _EndIgnore {
my ($self) = shift;
return sub {
return if --$self->{ignore_level};
$self->{parser}->setHandlers(@{$self->{normal_handlers}})
}
}
sub _add_content {
my ($hash, $value) = @_;
if (ref($value)) {
if (ref($hash->{_content})) {
# both are refs, push to @_content
push @{$hash->{_content}}, $value;
} elsif (exists($hash->{_content})) {
# result is ref, _content is not -> convert to an arrayref containing old _content and result
$hash->{_content} = [ $hash->{_content}, $value]
} else {
# result is ref, _content is not present
$hash->{_content} = [ $value]
}
} else {
if (ref($hash->{_content})) {
# _content is an arrayref, value is a string
if (ref $hash->{_content}[-1]) {
# the last element is a ref -> push
push @{$hash->{_content}}, $value;
} else {
# the last element is a string -> concatenate
$hash->{_content}[-1] .= $value;
}
} else {
# neither is ref, concatenate
$hash->{_content} .= $value;
}
}
}
=head1 METHODS
=head2 parse
$parser->parse( $string [, $parameters]);
$parser->parse( $IOhandle [, $parameters]);
Parses the XML in the string or reads and parses the XML from the opened IO handle,
executes the rules as it encounters the closing tags and returns the resulting structure.
The scalar or reference passed as the second parameter to the parse() method is assigned to
$parser->{parameters} for the parsing of the file or string. Once the XML is parsed the key is
deleted. This means that the $parser does not retain a reference to the $parameters after the parsing.
=head2 parsestring
$parser->parsestring( $string [, $parameters]);
Just an alias to ->parse().
=head2 parsefile
$parser->parsefile( $filename [, $parameters]);
Opens the specified file and parses the XML and executes the rules as it encounters
the closing tags and returns the resulting structure.
=head2 filter
$parser->filter( $string);
$parser->filter( $string, $OutputIOhandle [, $parameters]);
$parser->filter( $InputIOhandle, $OutputIOhandle [, $parameters]);
$parser->filter( $string, $OutputFilename [, $parameters]);
$parser->filter( $InputIOhandle, $OutputFilename [, $parameters]);
$parser->filter( $string, $StringReference [, $parameters]);
$parser->filter( $InputIOhandle, $StringReference [, $parameters]);
Parses the XML in the string or reads and parses the XML from the opened IO handle,
copies the tags that do not have a subroutine rule specified and do not occure under such a tag,
executes the specified rules and prints the results to select()ed filehandle, $OutputFilename or
$OutputIOhandle or stores them in the scalar referenced by $StringReference.
The scalar or reference passed as the third parameter to the filter() method is assigned to
$parser->{parameters} for the parsing of the file or string. Once the XML is parsed the key is
deleted. This means that the $parser does not retain a reference to the $parameters after the parsing.
=head2 filterstring
$parser->filterstring( ...);
Just an alias to ->filter().
=head2 filterfile
$parser->filterfile( $filename, $OutputIOhandle [, $parameters]);
$parser->filterfile( $filename, $OutputFilename [, $parameters]);
Parses the XML in the specified file, copies the tags that do not have a subroutine rule specified
and do not occure under such a tag, executes the specified rules and prints the results to select()ed
filehandle, $OutputFilename or $OutputIOhandle or stores them in the scalar
referenced by $StringReference.
The scalar or reference passed as the third parameter to the filter() method is assigned to
$parser->{parameters} for the parsing of the file or string. Once the XML is parsed the key is
deleted. This means that the $parser does not retain a reference to the $parameters after the parsing.
=cut
sub escape_value {
my($self, $data, $level) = @_;
return '' unless(defined($data) and $data ne '');
if ($self->{opt}{output_encoding} ne $self->{opt}{encode}) {
$data = Encode::decode( $self->{opt}{encode}, $data) if $self->{opt}{encode};
$data = Encode::encode( $self->{opt}{output_encoding}, $data) if $self->{opt}{output_encoding};
}
$data =~ s/&/&/sg;
$data =~ s/</</sg;
$data =~ s/>/>/sg;
$data =~ s/"/"/sg;
$level = $self->{opt}->{numericescape} unless defined $level;
return $data unless $level;
return $self->_numeric_escape($data, $level);
}
sub _numeric_escape {
my($self, $data, $level) = @_;
use utf8; # required for 5.6
if($self->{opt}->{numericescape} eq '2') {
$data =~ s/([^\x00-\x7F])/'&#' . ord($1) . ';'/gse;
}
else {
$data =~ s/([^\x00-\xFF])/'&#' . ord($1) . ';'/gse;
}
return $data;
}
=head2 escape_value
$parser->escape_value( $data [, $numericescape])
This method escapes the $data for inclusion in XML, the $numericescape may be 0, 1 or 2
and controls whether to convert 'high' (non ASCII) characters to XML entities.
0 - default: no numeric escaping (OK if you're writing out UTF8)
1 - only characters above 0xFF are escaped (ie: characters in the 0x80-FF range are not escaped), possibly useful with ISO8859-1 output
2 - all characters above 0x7F are escaped (good for plain ASCII output)
You can also specify the default value in the constructor
my $parser = XML::Rules->new(
...
NumericEscape => 2,
);
=cut
sub ToXML;*ToXML=\&toXML;
sub toXML {
my ($self, $tag, $attrs, $no_close, $ident, $base) = @_;
my $prefix = (defined ($ident) ? "\n$base" : '');
$attrs = undef if (ref $attrs eq 'HASH' and ! %{$attrs}); # ->toXML( $tagname, {}, ...)
if ($tag eq '') {
if (! ref($attrs)) { # ->toXML( '', $string_content, ...)
return $self->escape_value($attrs);
} elsif (ref($attrs) eq 'ARRAY') {
if (@$attrs) {
return join( '', map {
if (!ref($_)) {
$self->escape_value($_)
} elsif (ref($_) eq 'ARRAY' and @$_ == 2) {
$self->toXML($_->[0], $_->[1])
} else {
croak "The content in XML::Rules->ToXML( '', here) must be a string or an arrayref containing strings and two element arrayrefs!";
}
} @$attrs);
} else {
return "<$attrs/>"
}
}
}
if (! ref($attrs)) { # ->toXML( $tagname, $string_content, ...)
if ($no_close) {
return "<$tag>" . $self->escape_value($attrs);
} elsif (! defined $attrs) {
return "<$tag/>";
} else {
return "<$tag>" . $self->escape_value($attrs) . "</$tag>";
}
} elsif (ref($attrs) eq 'ARRAY') {
return join( $prefix, map $self->toXML($tag, $_, 0, $ident, $base), @$attrs);
}
my $content = $attrs->{_content};
my $result = "<$tag";
my $subtags = '';
foreach my $key (sort keys %$attrs) {
next if $key =~ /^:/ or $key eq '_content';
if (ref $attrs->{$key}) {
if (ref $attrs->{$key} eq 'ARRAY') {
if (@{$attrs->{$key}}) {
foreach my $subtag (@{$attrs->{$key}}) {
$subtags .= $prefix . $ident . $self->toXML($key, $subtag, 0, $ident, $base.$ident);
}
} else {
$subtags .= $prefix . $ident . "<$key/>";
}
} elsif (ref $attrs->{$key} eq 'HASH') {
$subtags .= $prefix . $ident . $self->toXML($key, $attrs->{$key}, 0, $ident, $base.$ident)
} else {
croak(ref($attrs->{$key}) . " attributes not supported in XML::Rules->toXML()!");
}
} else {
$result .= qq{ $key="} . $self->escape_value($attrs->{$key}) . qq{"};
}
}
if (! defined $content and $subtags eq '') {
if ($no_close) {
return $result.">";
} else {
return $result."/>";
}
} elsif (!ref($content)) { # content is a string, not an array of strings and subtags
if ($no_close) {
return "$result>$subtags" . $self->escape_value($content);
} elsif ($content eq '' and $subtags ne '') {
return "$result>$subtags$prefix</$tag>";
} else {
return "$result>$subtags" . $self->escape_value($content) ."</$tag>";
}
} elsif (ref($content) eq 'ARRAY') {
$result .= ">$subtags";
foreach my $snippet (@$content) {
if (!ref($snippet)) {
$result .= $self->escape_value($snippet);
} elsif (ref($snippet) eq 'ARRAY') {
if (@$snippet == 2) {
$result .= $self->toXML($snippet->[0], $snippet->[1]);
} else {
croak("Arrays in _content must be in format [\$tagname => \\\%attrs, ...] in XML::Rules->toXML()!");
}
} else {
croak(ref($snippet) . " not supported in _content in XML::Rules->toXML()!");
}
}
if ($no_close) {
return $result;
} else {
return $result."</$tag>";
}
} else {
croak(ref($content) . " _content not supported in XML::Rules->toXML()!");
}
}
sub parentsToXML {
my ($self, $level) = @_;
my $tag_names = $self->{context};
my $tag_attrs = $self->{data};
$level = scalar(@$tag_names) unless $level;
my $result = '';
for (my $i = -1; -$i <= $level; $i--) {
$result = $self->toXML( ${$tag_names}[$i], ${$tag_attrs}[$i], 1) . $result;
}
return $result;
}
sub closeParentsToXML {
my ($self, $level) = @_;
my $tag_names = $self->{context};
if ($level) {
return '</' . join( '></', (reverse(@{$tag_names}))[0..$level-1]) . '>';
} else {
return '</' . join( '></', reverse(@$tag_names)) . '>';
}
}
=head2 toXML / ToXML
$xml = $parser->toXML( $tagname, \%attrs[, $do_not_close, $ident, $base])
You may use this method to convert the datastructures created by parsing the XML into the XML format.
Not all data structures may be printed! I'll add more docs later, for now please do experiment.
The $ident and $base, if defined, turn on and control the pretty-printing. The $ident specifies the character(s)
used for one level of identation, the base contains the identation of the current tag. That is if you want to include the data inside of
<data>
<some>
<subtag>$here</subtag>
</some>
</data>
you will call
$parser->toXML( $tagname, \%attrs, 0, "\t", "\t\t\t");
The method does NOT validate that the $ident and $base are whitespace only, but of course if it's not you end up with invalid
XML. Newlines are added only before the start tag and (if the tag has only child tags and no content) before the closing tag,
but not after the closing tag! Newlines are added even if the $ident is an empty string.
=head2 parentsToXML
$xml = $parser->parentsToXML( [$level])
Prints all or only the topmost $level ancestor tags, including the attributes and content (parsed so far),
but without the closing tags. You may use this to print the header of the file you are parsing,
followed by calling toXML() on a structure you build and then by closeParentsToXML() to close
the tags left opened by parentsToXML(). You most likely want to use the style => 'filter' option
for the constructor instead.
=head2 closeParentsToXML
$xml = $parser->closeParentsToXML( [$level])
Prints the closing tags for all or the topmost $level ancestor tags of the one currently processed.
=head2 paths2rules
my $parser = XML::Rules->new(
rules => paths2rules {
'/root/subtag/tag' => sub { ...},
'/root/othertag/tag' => sub {...},
'tag' => sub{ ... the default code for this tag ...},
...
}
);
This helper function converts a hash of "somewhat xpath-like" paths and subs/rules into the format required by the module.
Due to backwards compatibility and efficiency I can't directly support paths in the rules and the direct syntax for their
specification is a bit awkward. So if you need the paths and not the regexps, you may use this helper instead of:
my $parser = XML::Rules->new(
rules => {
'tag' => [
'/root/subtag' => sub { ...},
'/root/othertag' => sub {...},
sub{ ... the default code for this tag ...},
],
...
}
);
=cut
sub paths2rules {
my ($paths) = @_;
my %rules;
while ( my ($tag, $val) = each %$paths) {
if ($tag =~ m{^(.*)/(.*)$}) {
my ($path, $tagname) = ($1, $2);
if (exists $rules{$tagname} and ref($rules{$tagname}) eq 'ARRAY') {
if (@{$rules{$tagname}} % 2) {
push @{$rules{$tagname}}, $path, $val;
} else {
splice @{$rules{$tagname}}, -1, 0, $path, $val;
}
} else {
$rules{$tagname} = [ $path => $val]
}
} elsif (exists $rules{$tag} and ref($rules{$tag}) eq 'ARRAY') {
push @{$rules{$tag}}, $val;
} else {
$rules{$tag} = $val
}
}
return \%rules;
}
=head2 return_nothing
Stop parsing the XML, forget any data we already have and return from the $parser->parse().
This is only supposed to be used within rules and may be called both as a method and as
an ordinary function (it's not exported).
=head2 skip_rest
Stop parsing the XML and return whatever data we already have from the $parser->parse().
The rules for the currently opened tags are evaluated as if the XML contained all
the closing tags in the right order.
These two work via raising an exception, the exception is caught within the $parser->parse() and do not propagate outside.
It's also safe to raise any other exception within the rules, the exception will be caught as well, the internal state of the $parser object
is cleaned and the exception is rethrown.
=head2 inferRulesFromExample
Dumper(XML::Rules::inferRulesFromExample( $fileOrXML, $fileOrXML, $fileOrXML, ...)
Dumper(XML::Rules->inferRulesFromExample( $fileOrXML, $fileOrXML, $fileOrXML, ...)
Dumper($parser->inferRulesFromExample( $fileOrXML, $fileOrXML, $fileOrXML, ...)
The subroutine parses the listed files and infers the rules that would produce the minimal, but complete datastructure.
It finds out what tags may be repeated, whether they contain text content, attributes etc. You may want to give
the subroutine several examples to make sure it knows about all possibilities. You should use this once and store
the generated rules in your script or even take this as the basis of a more specific set of rules.
=cut
sub inferRulesFromExample {
shift(@_) if $_[0] eq 'XML::Rules' or ref($_[0]);
my @files = @_;
my %rules;
my $parser = XML::Rules->new(
namespaces => { '*' => ''},
rules => {
_default => sub {
my ($tag, $attrs, $context, $parent_data, $parser) = @_;
my $repeated = (exists $parent_data->[-1] and exists $parent_data->[-1]{$tag});
my $has_content = (exists $attrs->{_content});
my $has_children = grep ref($_) eq 'HASH', values %$attrs;
my $has_attr = grep {$_ ne '_content' and !ref($attrs->{$_})} keys %$attrs;
my $rule = do {
if ($repeated) {
if ($has_content) {
if ($has_attr or $has_children) {
'as array'
} else {
'content array'
}
} else {
if ($has_attr or $has_children) {
'as array no content'
} else {
'content array'
}
}
} else {
if ($has_content) {
if ($has_attr or $has_children) {
'as is'
} else {
'content'
}
} else {
if ($has_attr or $has_children) {
'no content'
} else {
'content'
}
}
}
};
if (not exists $rules{$tag}) {
$rules{$tag} = $rule
} elsif($rules{$tag} ne $rule) {
# we've already seen the tag and it had different type
if ($rules{$tag} eq 'raw extended array') {
} elsif ($rule eq 'raw extended array') {
$rules{$tag} = 'raw extended array';
} elsif ($rules{$tag} eq 'raw extended' and $rule =~ /array/
or $rule eq 'raw extended' and $rules{$tag} =~ /array/) {
$rules{$tag} = 'raw extended array'
} elsif ($rules{$tag} eq 'as array' or $rule eq 'as array') {
$rules{$tag} = 'as array'
} elsif ($rules{$tag} eq 'content array' and $rule eq 'content'
or $rule eq 'content array' and $rules{$tag} eq 'content') {
$rules{$tag} = 'content array'
} elsif ($rules{$tag} eq 'content array' and $rule eq 'as array no content'
or $rule eq 'content array' and $rules{$tag} eq 'as array no content') {
$rules{$tag} = 'as array'
} elsif ($rules{$tag} eq 'content array' and $rule eq 'as is'
or $rule eq 'content array' and $rules{$tag} eq 'as is') {
$rules{$tag} = 'as array'
} elsif ($rules{$tag} eq 'content array' and $rule eq 'no content'
or $rule eq 'content array' and $rules{$tag} eq 'no content') {
$rules{$tag} = 'as array'
} elsif ($rules{$tag} eq 'as array no content' and $rule eq 'as is'
or $rule eq 'as array no content' and $rules{$tag} eq 'as is') {
$rules{$tag} = 'as array'
} elsif ($rules{$tag} eq 'as array no content' and $rule eq 'content'
or $rule eq 'as array no content' and $rules{$tag} eq 'content') {
$rules{$tag} = 'as array'
} elsif ($rules{$tag} eq 'as array no content' and $rule eq 'no content'
or $rule eq 'as array no content' and $rules{$tag} eq 'no content') {
$rules{$tag} = 'as array no content'
} elsif ($rules{$tag} eq 'as is' and ($rule eq 'no content' or $rule eq 'content')
or $rule eq 'as is' and ($rules{$tag} eq 'no content' or $rules{$tag} eq 'content')) {
$rules{$tag} = 'as is'
} elsif ($rules{$tag} eq 'content' and $rule eq 'no content'
or $rule eq 'content' and $rules{$tag} eq 'no content') {
$rules{$tag} = 'as is'
} else {
die "Unexpected combination of rules: old=$rules{$tag}, new=$rule for tag $tag\n";
}
}
if ($has_content and $has_children) { # the tag contains both text content and subtags!, need to use the raw extended rules
foreach my $child (grep ref($attrs->{$_}) eq 'HASH', keys %$attrs) {
next if $rules{$child} =~ /^raw extended/;
if ($rules{$child} =~ /array/) {
$rules{$child} = 'raw extended array'
} else {
$rules{$child} = 'raw extended'
}
}
}
return $tag => {};
}
},
stripspaces => 7,
);
for (@files) {
eval {
if (! ref($_) and $_ !~ /\n/ and $_ !~ /^\s*</) {
$parser->parsefile($_);
} else {
$parser->parse($_);
}
} or croak "Error parsing $_: $@\n";
}
my %short_rules;
foreach my $tag (sort keys %rules) {
push @{$short_rules{$rules{$tag}}}, $tag
}
foreach my $tags (values %short_rules) {
$tags = join ',', @$tags;
}
%short_rules = reverse %short_rules;
return \%short_rules;
}
=head2 inferRulesFromDTD
Dumper(XML::Rules::inferRulesFromDTD( $DTDfile, [$enableExtended]))
Dumper(XML::Rules->inferRulesFromDTD( $DTDfile, [$enableExtended]))
Dumper($parser->inferRulesFromDTD( $DTDfile, [$enableExtended]))
The subroutine parses the DTD and infers the rules that would produce the minimal, but complete datastructure.
It finds out what tags may be repeated, whether they contain text content, attributes etc. You may use this
each time you are about to parse the XML, once and store the generated rules in your script or even take this
as the basis of a more specific set of rules.
With the second parameter set to a true value, the tags included in a mixed content will use the "raw extended"
or "raw extended array" types instead of just "raw". This makes sure the tag data both stay at the right place in
the content and are accessible easily from the parent tag's atrribute hash.
This subroutine requires the XML::DTDParser module!
=cut
sub inferRulesFromDTD {
require XML::DTDParser;
my ($DTDfile, $enable_extended) = @_;
my $DTD = XML::DTDParser::ParseDTDFile($DTDfile);
my $has_mixed = 0;
foreach my $tag (values %$DTD) {
$tag->{is_mixed} = (($tag->{content} and $tag->{children}) ? 1 : 0)
and $has_mixed = 1;
}
my %settings;
foreach my $tagname (keys %$DTD) {
my $tag = $DTD->{$tagname};
my $repeated = ($tag->{option} =~ /^[+*]$/ ? 1 : 0);
my $has_content = $tag->{content};
my $in_mixed = grep {$DTD->{$_}{is_mixed}} @{$tag->{parent}};
if ($in_mixed) {
if ($enable_extended) {
if ($repeated) {
$settings{$tagname} = "raw extended array"
} else {
$settings{$tagname} = "raw extended"
}
} else {
$settings{$tagname} = "raw"
}
} else {
if (exists $DTD->{attributes} or exists $tag->{children}) {
my @ids ;
if (exists $DTD->{attributes}) {
@ids = grep {$DTD->{attributes}{$_}[0] eq 'ID' and $DTD->{attributes}{$_}[0] eq '#REQUIRED'} keys %{$DTD->{attributes}};
}
if (scalar(@ids) == 1) {
if ($has_content) {
$settings{$tagname} = "by $ids[0]"
} else {
$settings{$tagname} = "no content by $ids[0]"
}
} else {
if ($has_content) {
if ($repeated) {
$settings{$tagname} = "as array"
} else {
$settings{$tagname} = "as is"
}
} else {
if ($repeated) {
$settings{$tagname} = "as array no content"
} else {
$settings{$tagname} = "no content"
}
}
}
} elsif ($repeated) {
$settings{$tagname} = "content array"
} else {
$settings{$tagname} = "content array"
}
}
}
# use Data::Dumper;
# print Dumper(\%settings);
my %compressed;
{
my %tmp;
while (my ($tag, $option) = each %settings) {
push @{$tmp{$option}}, $tag;
}
while (my ($option, $tags) = each %tmp) {
$compressed{join ',', @$tags} = $option
}
}
if ($has_mixed) {
$compressed{"#stripspaces"} = 0;
} else {
$compressed{"#stripspaces"} = 7;
}
return \%compressed;
}
=head1 Properties
=head2 parameters
You can pass a parameter (scalar or reference) to the parse...() or filter...() methods, this parameter
is later available to the rules as $parser->{parameters}. The module will never use this parameter for
any other purpose so you are free to use it for any purposes provided that you expect it to be reset by
each call to parse...() or filter...() first to the passed value and then, after the parsing is complete, to undef.
=head2 pad
The $parser->{pad} key is specificaly reserved by the module as a place where the module users can
store their data. The module doesn't and will not use this key in any way, doesn't set or reset it under any
circumstances. If you need to share some data between the rules and do not want to use the structure built
by applying the rules you are free to use this key.
You should refrain from modifying or accessing other properties of the XML::Rules object!
=head1 Namespace support
By default the module doesn't handle namespaces in any way, it doesn't check for
xmlns or xmlns:alias attributes and it doesn't strip or mangle the namespace aliases
in tag or attribute names. This means that if you know for sure what namespace
aliases will be used you can set up rules for tags including the aliases and unless
someone decides to use a different alias or makes use of the default namespace
change your script will work.
If you do specify any namespace to alias mapping in the constructor it does
start processing the namespace stuff. The xmlns and xmlns:alias attributes
are stripped from the datastructures and the aliases are transformed from
whatever the XML author decided to use to whatever your namespace mapping
specifies. Aliases are also added to all tags that belong to a default namespace.
Assuming the constructor parameters contain
namespaces => {
'http://my.namespaces.com/foo' => 'foo',
'http://my.namespaces.com/bar' => 'bar',
}
and the XML looks like this:
<root>
<Foo xmlns="http://my.namespaces.com/foo">
<subFoo>Hello world</subfoo>
</Foo>
<other xmlns:b="http://my.namespaces.com/bar">
<b:pub>
<b:name>NaRuzku</b:name>
<b:address>at any crossroads</b:address>
<b:desc>Fakt <b>desnej</b> pajzl.</b:desc>
</b:pub>
</other>
</root>
then the rules wil be called as if the XML looked like this:
<root>
<foo:Foo>
<foo:subFoo>Hello world</foo:subfoo>
</foo:Foo>
<other>
<bar:pub>
<bar:name>NaRuzku</bar:name>
<bar:address>at any crossroads</bar:address>
<bar:desc>Fakt <b>desnej</b> pajzl.</bar:desc>
</bar:pub>
</other>
</root>
This means that the namespace handling will only normalize the aliases used.
It is possible to specify an empty alias, so eg. in case you are processing a SOAP XML
and know the tags defined by SOAP do not colide with the tags in the enclosed XML
you may simplify the parsing by removing all namespace aliases.
If the XML references a namespace not present in the map you will get a warning
and the alias used for that namespace will be left intact! If you do not want to get the warnings specify
a namespace with URI "*".
=head1 HOW TO USE
You may view the module either as a XML::Simple on steriods and use it to build a data structure
similar to the one produced by XML::Simple with the added benefit of being able
to specify what tags or attributes to ignore, when to take just the content, what to store as an array etc.
Or you could view it as yet another event based XML parser that differs from all the others only in one thing.
It stores the data for you so that you do not have to use globals or closures and wonder where to attach
the snippet of data you just received onto the structure you are building.
You can use it in a way similar to XML::Twig with simplify(), specify the rules to transform the lower
level tags into a XML::Simple like (simplify()ed) structure and then handle the structure in the rule for
the tag(s) you'd specify in XML::Twig's twig_roots.
=head1 Unrelated tricks
If you need to parse a XML file without the top-most tag (something that each and any sane person would allow,
but the XML comitee did not), you can parse
<!DOCTYPE doc [<!ENTITY real_doc SYSTEM "$the_file_name">]><doc>&real_doc;</doc>
instead.
=head1 AUTHOR
Jan Krynicky, C<< <Jenda at CPAN.org> >>
=head1 BUGS
Please report any bugs or feature requests to
C<bug-xml-rules at rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=XML-Rules>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc XML::Rules
You can also look for information at:
=over 4
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/XML-Rules>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/XML-Rules>
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=XML-Rules>
=item * Search CPAN
L<http://search.cpan.org/dist/XML-Rules>
=item * PerlMonks
Please see L<http://www.perlmonks.org/?node_id=581313> or
L<http://www.perlmonks.org/?node=XML::Rules> for discussion.
=back
=head1 SEE ALSO
L<XML::Twig>, L<XML::LibXML>, L<XML::Pastor>
=head1 ACKNOWLEDGEMENTS
The escape_value() method is taken with minor changes from XML::Simple.
=head1 COPYRIGHT & LICENSE
Copyright 2006-2007 Jan Krynicky, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
1; # End of XML::Rules