git.sesse.net Git - xml-template/blob - perl-sax/XML/TemplateSAX.pm

   1 #! /usr/bin/perl
   2
   3 #
   4 # SAX version of XML::Template. Advantages over DOM: Doesn't have to load
   5 # the entire thing into memory, and you can chain filters. Disadvantages:
   6 # Slightly kludgier interface.
   7 #
   8 # Differences from the DOM version:
   9 #
  10 # - There is no process(). Instead, it works as a SAX filter, so you put it
  11 #   in the stream, usually between a parser and a writer (ie.
  12 #   parser -> XML::TemplateSAX::Handler -> writer). process_file works as
  13 #   before, but it returns a _string_, not a DOM tree.
  14 # - You can no longer insert a DOM tree. Instead, what you have is -- FIXME:
  15 #   figure out this :-)
  16 #
  17
  18 use XML::SAX::Expat;
  19 use XML::SAX::Writer;
  20 use Data::Dumper;
  21
  22 package XML::TemplateSAX::Handler;
  23 use base qw(XML::SAX::Base);
  24
  25 sub new {
  26         my $class = shift;
  27         my %options = @_;
  28
  29         my $self = {
  30                 obj => $options{'Content'},
  31                 stack => [],
  32                 Handler => $options{'Handler'}
  33         };
  34         bless($self, $class);
  35         return $self;
  36 }
  37
  38 sub start_element {
  39         my ($self, $data) = @_;
  40         my $obj = $self->{'obj'};
  41
  42         # within a replacement; just ignore everything
  43         return if (!defined($obj));
  44
  45         # substitution: see if this element matches anything. if so,
  46         # descend down into the tree.
  47         if (ref($obj) eq 'HASH') {
  48                 my $match = undef;
  49                 for my $key (keys %$obj) {
  50                         if ($key =~ /^#(.*)$/) {
  51                                 if ($data->{'NamespaceURI'} eq 'http://template.sesse.net/' && $data->{'LocalName'} eq $1) {
  52                                         $match = $obj->{$key};
  53                                         last;
  54                                 }
  55                         } else {
  56                                 if ($data->{'LocalName'} eq $key) {
  57                                         $match = $obj->{$key};
  58                                         last;
  59                                 }
  60                         }
  61                 }
  62
  63                 if (defined($match)) {
  64                         $self->SUPER::start_element($data);
  65
  66                         push @{$self->{'stack'}}, [ $data->{'Name'}, $obj ];
  67
  68                         #
  69                         # This is sort of ugly. We special-case replacement by outputting
  70                         # the string immediately, and then just ignoring the rest of the
  71                         # events until we get to the right end tag. It's not 100% technically
  72                         # correct for the case where you replace an entire document by a
  73                         # string, but that's nonsensical anyway.
  74                         #
  75                         if (!ref($match)) {
  76                                 $self->SUPER::characters({ Data => $match });
  77                                 $match = undef;
  78                         }
  79
  80                         $self->{'obj'} = $match;
  81                         return;
  82                 }
  83         }
  84
  85         $self->SUPER::start_element($data);
  86 }
  87
  88 sub characters {
  89         my ($self, $data) = @_;
  90         return if (!defined($self->{'obj'}));
  91         $self->SUPER::characters($data);
  92 }
  93
  94 sub end_element {
  95         my ($self, $data) = @_;
  96
  97         my $stack = $self->{'stack'};
  98         if (scalar @$stack > 0) {
  99                 my $top = $stack->[$#stack];
 100
 101                 if ($data->{'Name'} eq $top->[0]) {
 102                         $self->SUPER::end_element($data);
 103                         $self->{'obj'} = $top->[1];
 104                         pop @$stack;
 105                         return;
 106                 }
 107         }
 108
 109         return if (!defined($self->{'obj'}));
 110
 111         $self->SUPER::end_element($data);
 112 }
 113
 114 package XML::TemplateSAX::Cleaner;
 115 use base qw(XML::SAX::Base);
 116
 117 sub start_element {
 118         my ($self, $data) = @_;
 119         my $attrs = $data->{'Attributes'};
 120
 121         for my $a (keys %$attrs) {
 122                 if ($attrs->{$a}->{'NamespaceURI'} eq 'http://template.sesse.net/') {
 123                         delete $attrs->{$a};
 124                 }
 125         }
 126
 127         $self->SUPER::start_element($data);
 128 }
 129
 130 package XML::TemplateSAX;
 131
 132 sub process_file {
 133         my ($filename, $obj, $clean) = @_;
 134         $clean = 1 unless (defined($clean));
 135
 136         my ($writer, $cleaner, $filter, $parser);
 137         my $str = '';
 138
 139         # FIXME: hardcoding expat = not good?
 140         $writer = XML::SAX::Writer->new(Output => \$str);
 141
 142         if ($clean) {
 143                 $cleaner = XML::TemplateSAX::Cleaner->new(Handler => $writer, Content => $obj);
 144                 $filter = XML::TemplateSAX::Handler->new(Handler => $cleaner, Content => $obj);
 145         } else {
 146                 $filter = XML::TemplateSAX::Handler->new(Handler => $writer, Content => $obj);
 147         }
 148
 149         $parser = XML::SAX::Expat->new(Handler => $filter);
 150         $parser->parse_file($filename);
 151
 152         return $str;
 153 }
 154
 155 1;