NAME

LCFG::Om::Environment - Sanitises the om environment before method invocation

VERSION

This documentation refers to LCFG::Om::Environment version 0.6.0

SYNOPSIS

 my $env_system = LCFG::Om::Environment->new();
 
 $env_system->initialise();

DESCRIPTION

This is a module which can be loaded to sanitise the om(1) environment prior to invoking a method for an LCFG component.

Immediately before issuing the command to call the component method the om command examines the value of the om_environment resource for the relevant LCFG component. If a value has been set this is used as a Perl module name and if it matches the regular expression for permitted names it will be loaded. The initialise() method will then be called to configure the calling environment. Note that om will die() if a module name does not match the permitted regular expression or the module fails to load.

SUBROUTINES/METHODS

There are only two methods in this module, the important one being initialise()

• new()

  Creates and returns a new LCFG::Om::Environment object.

• initialise()

  This is a simple environment initialisation method which does the following:

  1. Clears all environment variables

  2. Sets the PATH variable to something sane

  3. Changes working directory to /

  4. Sets the umask to 0022

  If you need to do more than this, for instance to also switch to a new PAG when using AFS, you will need to write your own environment module which inherits from this module and overrides the initialise() method.

DEPENDENCIES

This module requires the Readonly Perl module.

SEE ALSO

om(1)

PLATFORMS

This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.

Darwin, Fedora12, Fedora13, Scientific5, Scientific6

BUGS AND LIMITATIONS

There are no known bugs in this application. Please report any problems to bugs@lcfg.org or via https://bugs.lcfg.org/, feedback and patches are also always very welcome.

AUTHOR

Simon Wilkinson <simon@sxw.org.uk>, Stephen Quinney <squinney@inf.ed.ac.uk>

LICENSE AND COPYRIGHT

Unless otherwise stated all code is copyright (C) 2009 by University of Edinburgh.

This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 54:

=back doesn't take any parameters, but you said =back 4