use strict;
use Digest::MD5 qw(md5_hex);
=head1 NAME
SWISH::Filters::ImageToMD5Xml - Adds MD5 information when filtering an image for SWISHE.
=head1 VERSION
Version 0.04
=cut
our $VERSION = '0.05';
=head1 SYNOPSIS
A L<SWISH::Filter> that takes an incoming image XML and applies a MD5 checksum
against the binary content of the image.
The XML structure this filter expects includes an C<b64_data> element containing
the Base64 string representing the image. If that element (tag) is not found,
no filter is applied.
=head1 METHODS
=head2 new ( $class )
Constructor.
=cut
sub new {
my ( $class ) = @_;
$class = ref $class || $class;
my $self = bless { }, $class;
return $self->_init;
}
sub _init {
my ( $self ) = @_;
$self->use_modules(qw/MIME::Base64 Search::Tools::XML XML::Simple/);
my @mimetypes = (
'application/xml'
);
$self->{mimetypes} = \@mimetypes;
return $self;
}
sub _parse_xml {
my ( $self, $xml ) = @_;
if ( $xml ) {
return XMLin($xml);
}
}
=head2 filter( $self, $doc )
Generates XML meta data for indexing. If I<$doc> contains the C<b64_data> element (tag)
then a MD5 checksum string will be added to the XML and returned with a new root element C<image_data>.
=cut
sub filter {
my ( $self, $doc ) = @_;
return if $doc->is_binary;
if ( my $xml = $doc->fetch_filename ) {
if ( my $ds = $self->_parse_xml($xml) ) {
return unless exists $ds->{b64_data};
$ds->{md5} = md5_hex($ds->{b64_data});
my $xml = Search::Tools::XML->perl_to_xml($ds, { root => 'image_data' });
$doc->set_content_type('application/xml');
return ( \$xml );
}
}
return;
}
=head1 AUTHOR
Logan Bell, C<< <loganbell at gmail.com> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-swish-filters-imagetomd5xml at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Filters-ImageToMD5Xml>. 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 SWISH::Filters::ImageToMD5Xml
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker (report bugs here)
=item * AnnoCPAN: Annotated CPAN documentation
=item * CPAN Ratings
=item * Search CPAN
=back
=head1 ACKNOWLEDGEMENTS
=head1 LICENSE AND COPYRIGHT
Copyright 2011 Logan Bell.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
1; # End of SWISH::Filters::ImageToMD5Xml