File Coverage

lib/Templer/Plugin/FileContents.pm

Criterion	Covered	Total	%
statement	35	42	83.3
branch	7	12	58.3
condition	1	3	33.3
subroutine	6	6	100.0
pod	1	3	33.3
total	50	66	75.7

=head1 NAME

Templer::Plugin::FileContents - A plugin to read file contents.

=cut

=head1 SYNOPSIS

The following is a good example use of this plugin

  title: About my site
  passwd: read_file( /etc/passwd )
  ----
  This is my password file:


=cut

=head1 DESCRIPTION

This plugin reads the contents of files from the local system,
and allows files to be included inline in templates.

=cut

=head1 LICENSE

This module is free software; you can redistribute it and/or modify it
under the terms of either:

a) the GNU General Public License as published by the Free Software
Foundation; either version 2, or (at your option) any later version,
or

b) the Perl "Artistic License".

=cut

=head1 AUTHOR

Steve Kemp

=cut

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2012-2015 Steve Kemp .

This library is free software. You can modify and or distribute it under
the same terms as Perl itself.

=cut

=head1 METHODS

=cut


use strict;
use warnings;


package Templer::Plugin::FileContents;

use File::Basename;



=head2

Constructor.  No arguments are required/supported.

=cut

sub new
{
    my ( $proto, %supplied ) = (@_);
    my $class = ref($proto) || $proto;

    my $self = {};
    bless( $self, $class );
    return $self;
}



=head2 expand_variables

This is the method which is called by the L
to expand the variables contained in a L object.

Variables are written in the file in the form "key: value", and are
internally stored within the Page object as a hash.

This method iterates over each key & value and updates any that
seem to refer to file-inclusion.

=cut

sub expand_variables
{
    my ( $self, $site, $page, $data ) = (@_);

    #
    #  Get the page-variables in the template.
    #
    my %hash = %$data;

    #
    #  Look for a value of "read_file" in each key.
    #
    foreach my $key ( keys %hash )
    {
        if ( $hash{ $key } =~ /^read_file\((.*)\)/ )
        {

            #
            #  Get the filename specified.
            #
            my $file = $1;

            #
            #  Strip leading/trailing quotes and whitespace.
            #
            $file =~ s/['"]//g;
            $file =~ s/^\s+|\s+$//g;


            #
            #  Are we reading the input page itself?
            #
            if ( $file eq "SELF" )
            {
                $file = $page->source();
            }
            elsif ( $file =~ /^\// )
            {

                # File is absolute - no handling.
            }
            else
            {

                #
                #  Relative file.  We want to look for the file based upon the
                # global include-path with the current directory appended.
                #
                #  In the case of multiple matches the last one
                # wins.  i.e. The non-global one.
                #
                #

                #
                #  Get the global variables from the configuration object.
                #
                my $dirs = $site->get("include-path");
                my @dirs = @$dirs;

                #
                #  Append the directory from the input page.
                #
                push( @dirs, File::Basename::dirname( $page->source() ) );

                #
                #  Iterate
                #
                foreach my $dir (@dirs)
                {
                    if ( -e $dir . "/" . $file )
                    {
                        $file = $dir . "/" . $file;
                    }
                }
            }

            $hash{ $key } = $self->file_contents($file);

            #
            #  The page dependency also includes the filename now.
            #
            $page->add_dependency($file);
        }
    }

    return ( \%hash );
}


#
#  Return the contents of the named file.
#
sub file_contents
{
    my ( $self, $name ) = (@_);

    my $content = "";

    if ( -e $name )
    {
        open( my $handle, "<:utf8", $name ) or
          return "";

        binmode( $handle, ":utf8" );

        while ( my $line = <$handle> )
        {
            $content .= $line;
        }
        close($handle);
    }
    else
    {
        print "WARNING: Attempting to read a file that doesn't exist: $name\n";
    }

    $content;
}

#
#  Register the plugin.
#
Templer::Plugin::Factory->new()
  ->register_plugin("Templer::Plugin::FileContents");