home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / Datafile.pm < prev    next >
Encoding:
Perl POD Document  |  2004-01-30  |  5.1 KB  |  199 lines
  1. #============================================================= -*-Perl-*-
  2. #
  3. # Template::Plugin::Datafile
  4. #
  5. # DESCRIPTION
  6. #
  7. #   Template Toolkit Plugin which reads a datafile and constructs a 
  8. #   list object containing hashes representing records in the file.
  9. #
  10. # AUTHOR
  11. #   Andy Wardley   <abw@kfs.org>
  12. #
  13. # COPYRIGHT
  14. #   Copyright (C) 1996-2000 Andy Wardley.  All Rights Reserved.
  15. #   Copyright (C) 1998-2000 Canon Research Centre Europe Ltd.
  16. #
  17. #   This module is free software; you can redistribute it and/or
  18. #   modify it under the same terms as Perl itself.
  19. #
  20. #----------------------------------------------------------------------------
  21. #
  22. # $Id: Datafile.pm,v 2.66 2004/01/13 16:20:38 abw Exp $
  23. #
  24. #============================================================================
  25.  
  26. package Template::Plugin::Datafile;
  27.  
  28. require 5.004;
  29.  
  30. use strict;
  31. use vars qw( @ISA $VERSION );
  32. use base qw( Template::Plugin );
  33. use Template::Plugin;
  34.  
  35. $VERSION = sprintf("%d.%02d", q$Revision: 2.66 $ =~ /(\d+)\.(\d+)/);
  36.  
  37. sub new {
  38.     my ($class, $context, $filename, $params) = @_;
  39.     my ($delim, $line, @fields, @data, @results);
  40.     my $self = [ ];
  41.     local *FD;
  42.     local $/ = "\n";
  43.  
  44.     $params ||= { };
  45.     $delim = $params->{'delim'} || ':';
  46.     $delim = quotemeta($delim);
  47.  
  48.     return $class->fail("No filename specified")
  49.     unless $filename;
  50.  
  51.     open(FD, $filename)
  52.     || return $class->fail("$filename: $!");
  53.  
  54.     # first line of file should contain field definitions
  55.     while (! $line || $line =~ /^#/) {
  56.     $line = <FD>;
  57.     chomp $line;
  58.         $line =~ s/\r$//;
  59.     }
  60.  
  61.     (@fields = split(/\s*$delim\s*/, $line)) 
  62.     || return $class->fail("first line of file must contain field names");
  63.  
  64.     # read each line of the file
  65.     while (<FD>) {
  66.     chomp;
  67.     s/\r$//;
  68.  
  69.     # ignore comments and blank lines
  70.     next if /^#/ || /^\s*$/;
  71.  
  72.     # split line into fields
  73.     @data = split(/\s*$delim\s*/);
  74.  
  75.     # create hash record to represent data
  76.     my %record;
  77.     @record{ @fields } = @data;
  78.  
  79.     push(@$self, \%record);
  80.     }
  81.  
  82. #    return $self;
  83.     bless $self, $class;
  84. }    
  85.  
  86.  
  87. sub as_list {
  88.     return $_[0];
  89. }
  90.  
  91.  
  92. 1;
  93.  
  94. __END__
  95.  
  96.  
  97. #------------------------------------------------------------------------
  98. # IMPORTANT NOTE
  99. #   This documentation is generated automatically from source
  100. #   templates.  Any changes you make here may be lost.
  101. # 
  102. #   The 'docsrc' documentation source bundle is available for download
  103. #   from http://www.template-toolkit.org/docs.html and contains all
  104. #   the source templates, XML files, scripts, etc., from which the
  105. #   documentation for the Template Toolkit is built.
  106. #------------------------------------------------------------------------
  107.  
  108. =head1 NAME
  109.  
  110. Template::Plugin::Datafile - Plugin to construct records from a simple data file
  111.  
  112. =head1 SYNOPSIS
  113.  
  114.     [% USE mydata = datafile('/path/to/datafile') %]
  115.     [% USE mydata = datafile('/path/to/datafile', delim = '|') %]
  116.    
  117.     [% FOREACH record = mydata %]
  118.        [% record.this %]  [% record.that %]
  119.     [% END %]
  120.  
  121. =head1 DESCRIPTION
  122.  
  123. This plugin provides a simple facility to construct a list of hash 
  124. references, each of which represents a data record of known structure,
  125. from a data file.
  126.  
  127.     [% USE datafile(filename) %]
  128.  
  129. A absolute filename must be specified (for this initial implementation at 
  130. least - in a future version it might also use the INCLUDE_PATH).  An 
  131. optional 'delim' parameter may also be provided to specify an alternate
  132. delimiter character.
  133.  
  134.     [% USE userlist = datafile('/path/to/file/users')     %]
  135.     [% USE things   = datafile('items', delim = '|') %]
  136.  
  137. The format of the file is intentionally simple.  The first line
  138. defines the field names, delimited by colons with optional surrounding
  139. whitespace.  Subsequent lines then defines records containing data
  140. items, also delimited by colons.  e.g.
  141.  
  142.     id : name : email : tel
  143.     abw : Andy Wardley : abw@cre.canon.co.uk : 555-1234
  144.     neilb : Neil Bowers : neilb@cre.canon.co.uk : 555-9876
  145.  
  146. Each line is read, split into composite fields, and then used to 
  147. initialise a hash array containing the field names as relevant keys.
  148. The plugin returns a blessed list reference containing the hash 
  149. references in the order as defined in the file.
  150.  
  151.     [% FOREACH user = userlist %]
  152.        [% user.id %]: [% user.name %]
  153.     [% END %]
  154.  
  155. The first line of the file B<must> contain the field definitions.
  156. After the first line, blank lines will be ignored, along with comment
  157. line which start with a '#'.
  158.  
  159. =head1 BUGS
  160.  
  161. Should handle file names relative to INCLUDE_PATH.
  162. Doesn't permit use of ':' in a field.  Some escaping mechanism is required.
  163.  
  164. =head1 AUTHOR
  165.  
  166. Andy Wardley E<lt>abw@andywardley.comE<gt>
  167.  
  168. L<http://www.andywardley.com/|http://www.andywardley.com/>
  169.  
  170.  
  171.  
  172.  
  173. =head1 VERSION
  174.  
  175. 2.66, distributed as part of the
  176. Template Toolkit version 2.13, released on 30 January 2004.
  177.  
  178. =head1 COPYRIGHT
  179.  
  180.   Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  181.   Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.
  182.  
  183. This module is free software; you can redistribute it and/or
  184. modify it under the same terms as Perl itself.
  185.  
  186. =head1 SEE ALSO
  187.  
  188. L<Template::Plugin|Template::Plugin>
  189.  
  190. =cut
  191.  
  192. # Local Variables:
  193. # mode: perl
  194. # perl-indent-level: 4
  195. # indent-tabs-mode: nil
  196. # End:
  197. #
  198. # vim: expandtab shiftwidth=4:
  199.