OpenInteract::Config::PerlFile - Read/write information from/to a perl file

OpenInteract documentation Contained in the OpenInteract distribution.

Index

Code Index:

NAME

Top

OpenInteract::Config::PerlFile - Read/write information from/to a perl file

DESCRIPTION

Top

Create a 'read_config' method to override the base Config method. See OpenInteract::Config for usage of this base object.

The information in the config file is perl, so we do not have to go through any nutty contortions with types, etc.

METHODS

Top

read_config( $filename )

Read configuration directives from $filename. The configuration directives are actually perl data structures saved in an evalable format using Data::Dumper.

save_config( $filename )

Saves the current configuration to $filename. Normally not needed since you are not always changing configurations left and right.

TO DO

Top

Nothing known.

BUGS

Top

None known.

COPYRIGHT

Top

Copyright (c) 2001-2002 intes.net, inc.. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHORS

Top

Chris Winters <chris@cwinters.com>

OpenInteract documentation Contained in the OpenInteract distribution. 
package OpenInteract::Config::PerlFile;

# $Id: PerlFile.pm,v 1.6 2002/04/17 12:44:29 lachoy Exp $

use strict;
use Data::Dumper         qw( Dumper );
use OpenInteract::Config qw( _w DEBUG );

@OpenInteract::Config::PerlFile::ISA     = qw( OpenInteract::Config );
$OpenInteract::Config::PerlFile::VERSION = sprintf("%d.%02d", q$Revision: 1.6 $ =~ /(\d+)\.(\d+)/);

sub valid_keys {
    my ( $self ) = @_;
    return grep ! /^_/, keys %{ $self };
}


sub read_config {
    my ( $class, $filename ) = @_;
    unless ( -f $filename ) {
        my $msg = 'Cannot read configuration file!';
        my $system_msg = "No valid filename ($filename) for reading configuration information!";
        OpenInteract::Error->set({ user_msg   => $msg,
                                   type       => 'config',
                                   system_msg => $system_msg,
                                   method     => 'read_config',
                                   extra      => { filename => $filename } });
        die $msg;
    }
    DEBUG && _w( 1, "Reading configuration from: ($filename)" );
    eval { open( CONF, "$filename" ) || die $! };
    if ( $@ ) {
        my $msg = 'Cannot read configuration file!';
        OpenInteract::Error->set({ user_msg   => $msg,
                                   type       => 'config',
                                   system_msg => "Error trying to open $filename: $@",
                                   method     => 'read_config',
                                   extra      => { filename => $filename } });
        die $msg;
    }
    local $/ = undef;
    my $config = <CONF>;
    close( CONF );
    my ( $data );
    eval $config;
    if ( $@ ) {
        my $msg = 'Cannot read configuration file!';
        OpenInteract::Error->set({ user_msg   => $msg,
                                   type       => 'config',
                                   system_msg => "Error trying to eval $filename: $@",
                                   method     => 'read_config',
                                   extra      => { config => $config } });
        die $msg;
    }
    DEBUG && _w( 1, "Structure of config:\n", Dumper( $data ) );
    return $data;
}



sub save_config {
    my ( $self, $filename ) = @_;
    $filename ||= join( '/', $self->get_dir( 'config' ), $self->{config_file} );
    unless ( -f $filename ) {
        my $msg = 'Cannot read configuration file!';
        my $system_msg = "No valid filename ($filename) for saving configuration information!";
        OpenInteract::Error->set({ user_msg   => $msg,
                                   type       => 'config',
                                   system_msg => $system_msg,
                                   method     => 'save_config',
                                   extra      => { filename => $filename } });
        die $msg;
    }

    DEBUG && _w( 1, "Trying to save configuration to: ($filename)" );
    eval { open( CONF, "> $filename" ) || die $! };
    if ( $@ ) {
        my $msg = 'Cannot read configuration file!';
        OpenInteract::Error->set({ user_msg   => $msg,
                                   type       => 'config',
                                   system_msg => "Error trying to write $filename: $@",
                                   method     => 'save_config',
                                   extra      => { filename => $filename } });
        die $msg;
    }
    my %data = %{ $self };
    my $config = Data::Dumper->Dump( [ \%data ], [ 'data' ] );
    print CONF $config;
    close( CONF );
    return $self;
}

1;

__END__