file::policy::default(3pm) [debian man page]

File::Policy::Default(3pm)				User Contributed Perl Documentation				File::Policy::Default(3pm)

NAME

       File::Policy::Default - Default policy for file I/O functions

SYNOPSIS

	       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();

DESCRIPTION

       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 $

AUTHOR

       John Alden <cpan _at_ bbc _dot_ co _dot_ uk>

COPYRIGHT

       (c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL.

       See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt

perl v5.8.8							    2005-06-15						File::Policy::Default(3pm)

Perl::Critic::Policy::InputOutput::ProhibitTwoArgOpen(3pUser Contributed Perl DocumentatPerl::Critic::Policy::InputOutput::ProhibitTwoArgOpen(3pm)

NAME

       Perl::Critic::Policy::InputOutput::ProhibitTwoArgOpen - Write "open $fh, q{<}, $filename;" instead of "open $fh, "<$filename";".

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       The three-argument form of "open" (introduced in Perl 5.6) prevents subtle bugs that occur when the filename starts with funny characters
       like '>' or '<'.  The IO::File module provides a nice object-oriented interface to filehandles, which I think is more elegant anyway.

	 open( $fh, '>output.txt' );	      # not ok
	 open( $fh, q{>}, 'output.txt' );     # ok

	 use IO::File;
	 my $fh = IO::File->new( 'output.txt', q{>} ); # even better!

       It's also more explicitly clear to define the input mode of the file, as in the difference between these two:

	 open( $fh, 'foo.txt' );       # BAD: Reader must think what default mode is
	 open( $fh, '<', 'foo.txt' );  # GOOD: Reader can see open mode

       This policy will not complain if the file explicitly states that it is compatible with a version of perl prior to 5.6 via an include
       statement, e.g. by having "require 5.005" in it.

CONFIGURATION

       This Policy is not configurable except for the standard options.

NOTES

       There are two cases in which you are forced to use the two-argument form of open. When re-opening STDIN, STDOUT, or STDERR, and when doing
       a safe pipe open, as described in perlipc.

SEE ALSO

       IO::Handle

       IO::File

AUTHOR

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights reserved.

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

perl v5.14.2							    2012-06-07		Perl::Critic::Policy::InputOutput::ProhibitTwoArgOpen(3pm)