File::Policy::Default(3pm)

File::Policy::Default3pm

Default policy for file i/o functions

Usage

        use File::Policy;
        use File::Policy qw/check_safe/;   # to import a specific subroutine
        use File::Policy qw/:all/;         # to import all subroutines
        #Checking I/O policy
        check_safe($filename, 'r');
        check_safe($filename, 'w');
        #Portable directory locations
        $logdir = get_log_dir();
        $tmpdir = get_temp_dir();

Overview

This defines the default (unrestricted) policy for file I/O with modules such as File::Slurp::WithinPolicy. You may replace this default policy with one for your organisation.

Functions

check_safe
        check_safe( FILENAME , MODE );

Checks a filename is safe - dies if not. MODE is r (read) or w (write). Default is no restrictions on file I/O.

get_temp_dir
        $temporary_directory = get_temp_dir();

Returns the path to temporary directory from the TEMP environment variable or File::Spec::Functions::tmpdir(). Note that any return value will have been cleared of a trailing slash.

get_log_dir
        $log_directory = get_log_dir();

Returns the path to log directory from the LOGDIR environment variable or the current directory. Note that any return value will have been cleared of a trailing slash.

Version

$Revision: 1.6 $ on $Date: 2005/05/18 15:57:28 $ by $Author: johna $

Releases

9 releases since Debian 5.0 (Lenny); the text changed 3 times.

  1. 5.0–8
  2. 9–10
  3. 11
  4. 12–13

Author

John Alden <cpan _at_ bbc _dot_ co _dot_ uk>

From libfile-policy-perl 1.005-4 in Debian 13 (Trixie). Parsed by carta from the page's man source.