ConfigReader-0.5/ 40755 625 4 0 6112117237 11330 5ustar amwadmConfigReader-0.5/Values.pm100644 625 4 16625 6112121171 13244 0ustar amwadm# ConfigReader/Values.pm: stores a set of configuration values # # Copyright 1996 by Andrew Wilcox . # All rights reserved. # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Library General Public # License as published by the Free Software Foundation; either # version 2 of the License, or (at your option) any later version. # # This library is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Library General Public License for more details. # # You should have received a copy of the GNU Library General Public # License along with this library; if not, write to the Free # Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. package ConfigReader::Values; $VERSION = "0.5"; require ConfigReader::Spec; use strict; =head1 NAME ConfigReader::Values - stores a set of configuration values =head1 DESCRIPTION This class stores a set of configuration values that have been read from a configuration file. Methods are provided to define directives, assign and retrieve values, and to create accessor subroutines. As this class will usually be subclassed to implement a reader for a specific style of configuration files, the user-oriented methods will be described first. Methods used to help implement a subclass are described later. =head1 USER METHODS =head2 C{'spec'}->directive($directive, $parser, $default, $whence); } =head2 C{'spec'}->required(@_); } =head2 C Defines a directive which will be accepted but ignored in the configuration file. =cut sub ignore { my $s = shift; $s->{'spec'}->ignore(@_); } =head2 C Returns an array of the configuration directive names. =cut sub directives { my $s = shift; $s->{'spec'}->directives(@_); } =head2 C Returns the value of the configuration directive $directive. =cut sub value { my ($self, $directive, $whence) = @_; unless (defined $whence) { my ($package, $filename, $line) = caller; $whence = "at $filename line $line"; } my $spec = $self->{'spec'}; my $values = $self->{'values'}; return $spec->value($directive, $values, $whence); } =head2 C Creates subroutines in the caller's package to access configuration values. For example, if one of the configuration directives is named "Input_File", you can do: $config->define_accessors(); ... open(IN, Input_File()); The names of the created subroutines is returned in an array. If you'd like to export the accessor subroutines, you can say: push @EXPORT, $config->define_accessors(); You can specify the package in which to create the subroutines with the optional $package argument. You may also specify which configuration directives to create accessor subroutines for. By default, subroutines will be created for all the directives. =cut sub define_accessors { my ($self, $package, @names) = @_; @names = $self->directives() unless @names; $package = (caller)[0] unless defined $package; my $name; foreach $name (@names) { $self->_define_accessor($name, $package); } @names; } sub _define_accessor { my ($self, $name, $package) = @_; $package = (caller)[0] unless defined $package; no strict 'refs'; *{ $package . "::" . $name } = $self->_make_accessor($name); return $name; } sub _make_accessor { my ($self, $name) = @_; return sub { my ($package, $filename, $line) = caller; $self->value($name, "at $filename line $line") }; } =head1 IMPLEMENTATION METHODS The following methods will probably be called by a subclass implementing a reader for a particular style of configuration files. =head2 new( [$spec] ) The static method new() creates and returns a new ConfigReader::Values object. Unless the optional $spec argument is present, a new ConfigReader::Spec object will be created to store the configuration specification. The directive(), required(), ignore(), value(), and directive() methods described above are passed through to the spec object. By setting $spec, you can use a different class (perhaps a subclass) to store the specification. You can also set $spec if you want to use one specification for multiple sets of values. Files like /etc/termcap describe a configuration for multiple objects (terminals, in this case), but use the same directives to describe each object. =cut sub new { my ($class, $spec) = @_; $spec = new ConfigReader::Spec unless defined $spec; my $self = {spec => $spec, values => {}}; return bless $self, $class; } =head2 C Returns the hash ref which actually stores the configuration directive values. The key of the hash ref is the directive name. =cut sub values { my ($self) = @_; return $self->{'values'}; } =head2 C Returns the internal spec object used to store the configuration specification. =cut sub spec { my ($self) = @_; return $self->{'spec'}; } =head2 C Normally called while reading the configuration file, assigns a value to the directive named $directive. The $value_string will be parsed by the directive's parsing function or method, if any. $whence should describe the line in the configuration file which contained the value string. =cut sub assign { my ($self, $directive, $value_string, $whence) = @_; my $spec = $self->{'spec'}; my $values = $self->{'values'}; return $spec->assign($directive, $value_string, $values, $whence); } =head2 C After the configuration file is read, the assign_defaults() method is called to assign the default values for directives which were not specified in the configuration file. $whence should describe the name of the configuration file. =cut sub assign_defaults { my ($self, $whence) = @_; my $values = $self->{'values'}; my $spec = $self->{'spec'}; return $spec->assign_defaults($values, $whence); } 1; ConfigReader-0.5/DirectiveStyle.pm100644 625 4 21574 6112121201 14735 0ustar amwadm# ConfigReader/DirectiveStyle.pm: Reads a configuration file of # directives and values. # # Copyright 1996 by Andrew Wilcox . # All rights reserved. # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Library General Public # License as published by the Free Software Foundation; either # version 2 of the License, or (at your option) any later version. # # This library is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Library General Public License for more details. # # You should have received a copy of the GNU Library General Public # License along with this library; if not, write to the Free # Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. package ConfigReader::DirectiveStyle; $VERSION = "0.5"; require ConfigReader::Values; @ISA = qw(ConfigReader::Values); my $Tainted_empty_string = substr($0, 0, 0); use Carp; use strict; =head1 NAME ConfigReader::DirectiveStyle Reads a configuration file of directives and values. =head1 CONFIGURATION FILE SYNOPSIS # comments start with a #, and blank lines are ignored Input /etc/data_source # the value follows the directive name HomePage http://www.w3.org/ # values can be quoted Comment "here is a value with trailing spaces " =head1 CODE SYNOPSIS my $c = new ConfigReader::DirectiveStyle; directive $c 'Input', undef, '~/input'; # specify default value, # but no parsing needed required $c 'HomePage', 'new URI::URL'; # create URI::URL object ignore $c 'Comment'; # Ignore this directive. $c->load('my.config'); open(IN, $c->value("Input")); $c->define_accessors(); # creates Input() and HomePage() retrieve(HomePage()); =head1 DESCRIPTION This class reads a common style of configuration files, where directive names are followed by a value. For each directive you can specify whether it has a default value or is required, and a function or method to use to parse the value. Errors and warnings are caught while parsing, and the location where the offending value came from (either from the configuration file, or your Perl source for default values) is reported. DirectiveStyle is a subclass of L. The methods to define the directives in the configuration file are documented there. Comments are introduced by the "#" character, and continue until the end of line. Like in Perl, the backslash character "\" may be used in the directive values for the various standard sequences: \t tab \n newline \r return \f form feed \v vertical tab, whatever that is \b backspace \a alarm (bell) \e escape \033 octal char \x1b hex char The value may also be quoted, which lets you include leading or trailing spaces. The quotes are stripped off before the value is returned. DirectiveStyle itself only reads the configuration file. Most of the hard work of defining the directives and parsing the values is done in its superclass, ConfigReader::Values. You should be able to easily modify or subclass DirectiveStyle to read a different style of configuration file. =head1 PUBLIC METHODS =head2 C This static method creates and returns a new DirectiveStyle object. For information about the optional $spec argument, see DirectiveStyle::new(). =head2 C Before calling load(), you'll want to define the directives using the methods described in ConfigReader::Values. Reads a configuration from $file. The default values for any directives not present in the file are assigned. Normally configuration values are tainted like any data read from a file. If the configuration file comes from a trusted source, you can untaint all the values by setting the optional $untaint argument to a true value (such as C<'UNTAINT'>). =cut sub load { my ($self, $file, $untaint) = @_; my ($whence, $directive, $value); local $/ = "\n"; local ($_, $., $!); open(IN, $file) or croak "Could not open configuration file '$file' for reading: $!"; while () { chomp; $whence = "in line $. of the configuration file '$file':\n> $_\n"; ($directive, $value) = $self->parse_line($_, $whence, $untaint); $self->assign($directive, $value, $whence) if defined $directive; } close(IN); $self->assign_defaults("in the configuration file '$file'"); } =head1 SUBCLASSABLE METHODS You can stop reading here if you just want to use DirectiveStyle. The following methods could be overridden in a subclass to provide additional or alternate functionality. =head2 C Parses $line. $whence is a string describing the source of the line. Returns a two-element array of the directive and the value string, or the empty array () if the line is blank or only contains a comment. =cut sub parse_line { my ($self, $line, $whence, $untaint) = @_; my ($directive, $rest); return () if $line =~ m/^ [\s\cZ]* $/x; return () if $line =~ m/^ [\s\cZ]* \# /x; ($directive, $rest) = ($line =~ m/^ [\s\cZ]* ([\w\-]+) [\s\cZ]* (.*)/x) or die "Syntax error in directive name $whence"; my $value = $self->parse_value_string($rest, $whence); if ($untaint) { $value =~ m/(.*)/; return ($directive, $1); } else { # ensure that it is tainted, even after regex matching return ($directive, $value . $Tainted_empty_string); } } =head2 C Interprets quotes, backslashes, and comments in the value part. (Note that after the value string is returned, it will still get passed to the directive's parsing function of method if one is defined). =cut # Just taking it step by step. sub parse_value_string { my ($self, $str, $whence) = @_; my ($value, $p); $str =~ s,[\s\cZ]+$,,; # trim trailing whitespace $value = ''; # string quoted with double quote if ($str =~ m/^ \" /gx) { # parse through, looking for \, #, and closing " for (;;) { $p = pos($str); # pick up everything until next \ or " if ($str =~ m/\G ([^\\\"]+) /gx) { $value .= $1; next; } pos($str) = $p; # reset search, since last match failed # looking at \ if ($str =~ m/\G \\ /gx) { $value .= $self->match_backslash(\$str); next; } pos($str) = $p; # looking at " if ($str =~ m/\G \" /gx) { # got closing quote, so only thing left should be a comment # if any. m/\G$/ doesn't match, so check position manually pos($str) < length($str) and $str !~ m/\G (\s* \# .*)? $/gx and die "Extra characters after closing quote $whence"; last; } die "No closing quote $whence"; } } # ditto, but for single quote elsif ($str =~ m/^ \' /gx) { for (;;) { $p = pos($str); if ($str =~ m/\G ([^\\\']+) /gx) { $value .= $1; next; } pos($str) = $p; if ($str =~ m/\G \\ /gx) { $value .= $self->match_backslash(\$str); next; } pos($str) = $p; if ($str =~ m/\G \' /gx) { pos($str) < length($str) and $str !~ m/\G (\s* \# .*)? $/gx and die "Extra characters after closing quote $whence"; last; } die "No closing quote $whence"; } } # ok, not quoted else { for (;;) { $p = pos($str); # pick up everything up to \ or comment # if ($str =~ m/\G ([^\\\#]+) /gx) { $value .= $1; next; } pos($str) = $p; if ($str =~ m/\G \\ /gx) { $value .= $self->match_backslash(\$str); next; } # either end of string or comment last; } # trim trailing whitespace $value =~ s,[\s\cZ]+$,,; } return $value; } sub match_backslash { my ($self, $str_ref) = @_; my $p = pos($$str_ref); if ($$str_ref =~ m/\G ((?:\d\d\d) | (?:x\w\w) | (?:[A-Za-z])) /gx) { # untainted and considered safe return eval '"\\' . $1 . '"'; } # return next character verbatim, bumping match position pos($$str_ref) = $p; $$str_ref =~ m/\G (.)/gx; return $1; } 1; ConfigReader-0.5/COPYING.LIB100644 625 4 61261 6111220505 13103 0ustar amwadm GNU LIBRARY GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the library GPL. It is numbered 2 because it goes with version 2 of the ordinary GPL.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Library General Public License, applies to some specially designated Free Software Foundation software, and to any other libraries whose authors decide to use it. You can use it for your libraries, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library, or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link a program with the library, you must provide complete object files to the recipients so that they can relink them with the library, after making changes to the library and recompiling it. And you must show them these terms so they know their rights. Our method of protecting your rights has two steps: (1) copyright the library, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the library. Also, for each distributor's protection, we want to make certain that everyone understands that there is no warranty for this free library. If the library is modified by someone else and passed on, we want its recipients to know that what they have is not the original version, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that companies distributing free software will individually obtain patent licenses, thus in effect transforming the program into proprietary software. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License, which was designed for utility programs. This license, the GNU Library General Public License, applies to certain designated libraries. This license is quite different from the ordinary one; be sure to read it in full, and don't assume that anything in it is the same as in the ordinary license. The reason we have a separate public license for some libraries is that they blur the distinction we usually make between modifying or adding to a program and simply using it. Linking a program with a library, without changing the library, is in some sense simply using the library, and is analogous to running a utility program or application program. However, in a textual and legal sense, the linked executable is a combined work, a derivative of the original library, and the ordinary General Public License treats it as such. Because of this blurred distinction, using the ordinary General Public License for libraries did not effectively promote software sharing, because most developers did not use the libraries. We concluded that weaker conditions might promote sharing better. However, unrestricted linking of non-free programs would deprive the users of those programs of all benefit from the free status of the libraries themselves. This Library General Public License is intended to permit developers of non-free programs to use free libraries, while preserving your freedom as a user of such programs to change the free libraries that are incorporated in them. (We have not seen how to achieve this as regards changes in header files, but we have achieved it as regards changes in the actual functions of the Library.) The hope is that this will lead to faster development of free libraries. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, while the latter only works together with the library. Note that it is possible for a library to be covered by the ordinary General Public License rather than by this special one. GNU LIBRARY GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Library General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also compile or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. c) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. d) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Library General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! ConfigReader-0.5/Spec.pm100644 625 4 22751 6112121004 12667 0ustar amwadm# ConfigReader/Spec.pm: specifies a set of configuration directives # # Copyright 1996 by Andrew Wilcox . # All rights reserved. # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Library General Public # License as published by the Free Software Foundation; either # version 2 of the License, or (at your option) any later version. # # This library is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Library General Public License for more details. # # You should have received a copy of the GNU Library General Public # License along with this library; if not, write to the Free # Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. package ConfigReader::Spec; $VERSION = "0.5"; my $This_file = __FILE__; # used to get our filename out of error msgs require 5.001; use Carp; use strict; =head1 NAME ConfigReader::Spec =head1 DESCRIPTION The ConfigReader::Spec class stores a specification about configuration directives: their names, whether they are required or if they have default values, and what parsing function or method to use. =cut ## Public methods sub new { my ($class) = @_; my $self = {directives => {}, # directive name => 1 alias_to_directive => {}, # map alias to name default => {}, # name => default value whence_default => {}, # name => source location of default parser => {}, # name => value parser name => {}, # name => 1, ignore this directive required => {} # name => 1, required directive }; return bless $self, $class; } sub directives { my ($self) = @_; return keys %{$self->{'directives'}}; } sub value { my ($self, $directive, $values, $whence) = @_; $directive = $self->canonical_name($directive); my $name = $self->{'alias_to_directive'}{$directive}; $self->_error("Undefined directive '$directive'", $whence) unless defined $name; $self->_error("The directive '$directive' has not been assigned a value", $whence) unless exists($values->{$name}); return $values->{$name}; } sub alias { my ($self, $directive, @aliases) = @_; $directive = $self->canonical_name($directive); my $alias; foreach $alias (@aliases) { $self->{'alias_to_directive'}{$self->canonical_name($alias)} = $directive; } } sub define_directive { my ($self, $directive, $parser, $whence) = @_; my ($name, @aliases); my $ref = ref($directive); if (defined $ref and $ref eq 'ARRAY') { $name = shift @$directive; @aliases = @$directive; } else { $name = $directive; @aliases = ($directive); } $name = $self->canonical_name($name); $self->{'directives'}{$name} = 1; $self->alias($name, @aliases); if (defined $parser) { $self->{'parser'}{$name} = $self->_resolve_code($parser, 'specified as parser', $whence); } else { delete $self->{'parser'}; } return $name; } sub required { my ($self, $directive, $parser, $whence) = @_; my $name = $self->define_directive($directive, $parser, $whence); $self->{'required'}{$name} = 1; } sub directive { my ($self, $directive, $parser, $default, $whence) = @_; my $name = $self->define_directive($directive, $parser, $whence); $self->{'default'}{$name} = $default; $self->{'whence_default'}{$name} = $whence; return $name; } sub ignore { my ($self, $directive, $whence) = @_; my $name = $self->define_directive($directive, undef, undef, $whence); $self->{'ignore'}{$name} = 1; } sub assign { my ($self, $directive, $value_string, $values, $whence) = @_; $directive = $self->canonical_name($directive); my $name = $self->{'alias_to_directive'}{$directive}; $self->undefined_directive($directive, $value_string, $whence) unless defined $name; return undef if $self->{'ignore'}{$name}; $self->duplicate_directive($directive, $value_string, $whence) if defined $values and exists $values->{$name}; if (not defined $value_string) { $values->{$name} = undef if defined $values; return undef; } my $parser = $self->{parser}{$name}; my $value; if (defined $parser) { my @warnings = (); local $SIG{'__WARN__'} = sub { push @warnings, $_[0] }; my $saved_eval_error = $@; eval { $value = &$parser($value_string) }; my $error = $@; $@ = $saved_eval_error; my $warning; foreach $warning (@warnings) { $warning =~ s/ at $This_file line \d+$//o; # uncarp if (defined $whence) { warn "While parsing '$value_string' as the value for the '$directive' directive as specified $whence, I got this warning: $warning"; } else { $warning =~ s/\n?$/\n/; carp $warning . " while parsing '$value_string' as the value for the '$directive' directive"; } } if ($error) { $error =~ s/ at $This_file line \d+$//o; # uncroak if (defined $whence) { $whence =~ s,\n$,,; die "I tried to parse '$value_string' as the value for the '$directive' directive as specified $whence but the following error occurred: $error"; } else { $error =~ s/\n?$/\n/; croak $error."while parsing '$value_string' as the value for the '$directive' directive"; } } } else { $value = $value_string; } $values->{$name} = $value if defined $values; return $value; } sub assign_defaults { my ($self, $values, $whence) = @_; my $name; foreach $name ($self->directives()) { $self->assign_default($name, $values, $whence); } } sub assign_default { my ($self, $directive, $values, $whence) = @_; $directive = $self->canonical_name($directive); my $name = $self->{'alias_to_directive'}{$directive}; $self->_error("Undefined directive '$directive'", $whence) unless defined $name; return $values->{$name} if defined $values and exists $values->{$name}; if ($self->{'required'}{$name}) { $self->_error("Please specify the '$name' directive", $whence); } elsif ($self->{'ignore'}{$name}) { return undef; } my $default = $self->{'default'}{$name}; # "as the default value " my $whence_default = $self->{'whence_default'}{$name}; my $value; if (not defined $default) { return $self->assign($name, undef, $values, $whence_default); } elsif (not ref $default) { return $self->assign($name, $default, $values, $whence_default); } elsif (ref($default) eq 'CODE') { local $SIG{'__DIE__'} = sub { $self->_error("$_[0]\nwhile assigning the default value for the '$name' directive", $whence_default); }; $value = &$default(); $values->{$name} = $value if defined $values; return $value; } else { $value = $default; $values->{$name} = $value if defined $values; return $value; } } ## subclass hooks sub canonical_name { my ($self, $directive) = @_; return $directive; } sub undefined_directive { my ($self, $directive, $value_string, $whence) = @_; $self->_error("Unknown directive '$directive' specified", $whence); } sub duplicate_directive { my ($self, $directive, $value_string, $whence) = @_; $self->_error("Duplicate directive '$directive' specified", $whence); } ## Internal methods # Allows the user to specify code to run in several different ways. # Returns a code ref that will run the desired code. # 'new URI::URL' calls static method 'new' in class 'URI::URL' # $coderef calls the code ref # [new => 'URI::URL'] calls new URI::URL # [parse => $obj] calls $obj->parse() sub _resolve_code { my ($self, $sub, $purpose, $whence) = @_; my ($r, $class, $static_method, $function); $r = ref($sub); if (not $r) { if (($static_method, $class) = ($sub =~ m/^(\w+) \s+ ([\w:]+)$/x)) { return sub { $class->$static_method(@_); }; } else { $self->_error("Syntax error in function name '$sub' $purpose", $whence); } } elsif ($r eq 'CODE') { return $sub; } elsif ($r eq 'ARRAY') { my ($method, $class_or_obj) = @$sub; $self->_error("Empty array used to $purpose", $whence) unless defined $method; $self->_error("Class or object not specified in array used to $purpose", $whence) unless defined $class_or_obj; return sub { $class_or_obj->$method(@_); }; } else { $self->_error("Unknown object $purpose", $whence); } } sub _error { my ($self, $msg, $whence) = @_; if (defined $whence) { $whence =~ s,\n?$,\n,; die "$msg $whence"; } else { croak $msg; } } 1; ConfigReader-0.5/README100644 625 4 4150 6112117145 12303 0ustar amwadmThis is ConfigReader 0.5. I'm calling it an alpha release, as I'd like to get feedback on the interface. ConfigReader is a set of classes for reading configuration files. The programmer can easily specify the directives to be read, as well as their default values and a parsing function or method to use. A lot of work went into error handling. The class implementation means that a simple subclass can be written to parse a different style of configuration file, and it will automatically get the specifying, error handling, and parser features of ConfigReader. You'll find documentation in ConfigReader.pod, as well as in the source files. The *.pm files should be installed in a "ConfigReader" subdirectory on your Perl include path. Copyright terms are under the GLPL (the GNU *Library* Public License which is less restrictive than the more well known GPL. I like the GLPL, as I think it does a good job of expressing my wish that the end-user can see and use my source code, without restricting the rest of the program. But please let me know if the GLPL would cause a problem for you. (Especially if you'd like to write some additional ConfigReader subclasses :-). There is one point of terminology in the documentation which I now realize is confusing. The config file parser class specifies the syntax of how directives and values are written in the config file: Verbose yes Verbose=yes {Verbose => 'yes'} The programmer can create a "parsing function or method", which converts a string representation into a Perl value (or object). This code can than be used transparently with any of the file parsing classes. sub yes_no { my ($val) = @_; if ($val =~ m/^y/i) { return 1; } else { return 0; } } directive $c, 'Verbose', undef, \&yes_no; directive $c, 'HomePage', undef, 'new URI::URL'; I think it might be clearer if "parsing" where used for parsing the configuration file into directive and value string pairs, and the "parsing function or method" was called something else. Suggestions are welcome. Andrew Wilcox awilcox@world.std.com ConfigReader-0.5/ConfigReader.pod100644 625 4 4570 6110244744 14471 0ustar amwadm=head1 NAME ConfigReader - Read directives from a configuration file. =head1 DESCRIPTION The ConfigReader library is a set of classes which reads directives from a configuration file. The library is completely object oriented, and it is envisioned that parsers for new styles of configuration files can be easily added. ConfigReader::Spec encapsulates a specification for configuration directives. You can specify which directives can be in the configuration file, aliases for the directive, whether the directive is required or has a default value, and how to parse the directive value. Here's an example of how one directive might be specified: required $spec 'HomePage', 'new URI::URL'; This defines a required directive called 'HomePage'. To parse the value from the configuration file, the URI::URL::new() method will be called with the string value as its argument. If the directive name is a simple string, it will be used both to refer to the directive in the Perl program, and as the name in the configuration file. You can also specify an alias by using an array ref. For example, suppose you wanted to use "index" as the name of the directive in the configuration file, but to avoid confusion with Perl's index() function you wanted to refer to the directive inside the program as the "file_index". This will do the trick: ['file_index', 'index'] You can specify any number of aliases for the directive: ['file_index', 'index', 'file_index', 'contents', ...] The parsing function or method is called to translate the value string from the configuration file into the value used by the program. It can be specified in several different ways: code ref static method object method undefined You can also specify a default value to be used if a directive is not specified in the configuration file. string value code ref undefined ConfigReader::Values stores a set of directive values that have been read from a configuration file. It stores a reference to an associated Spec as a member variable. Separating the specification from the values makes it possible to use a single specification for multiple sets of values. ConfigReader::DirectiveStyle implements a reader for a common style of configuration file. It is a subclass of ConfigReader::Values. Directive names are followed by their value, one per line: HomePage http://www.w3.org/ Services /etc/services