perlfunc gods open - open a file, pipe, or descriptor <HR> open FILEHANDLE,EXPR open FILEHANDLE <HR> Opens the file whose filename is given by EXPR, and associates it with FILEHANDLE. If FILEHANDLE is an expression, its value is used as the name of the real filehandle wanted. If EXPR is omitted, the scalar variable of the same name as the FILEHANDLE contains the filename. (Note that lexical variables--those declared with [perlfunc:my|my()]--will not work for this purpose; so if you're using [perlfunc:my|my()], specify EXPR in your call to open.) If the filename begins with <CODE>'<'</CODE> or nothing, the file is opened for input. If the filename begins with <CODE>'>'</CODE>, the file is truncated and opened for output, being created if necessary. If the filename begins with <CODE>'>>'</CODE>, the file is opened for appending, again being created if necessary. You can put a <CODE>'+'</CODE> in front of the <CODE>'>'</CODE> or <CODE>'<'</CODE> to indicate that you want both read and write access to the file; thus <CODE>'+<'</CODE> is almost always preferred for read/write updates--the <CODE>'+>'</CODE> mode would clobber the file first. You can't usually use either read-write mode for updating textfiles, since they have variable length records. See the -i switch in [perlman:perlrun|the perlrun manpage] for a better approach. The prefix and the filename may be separated with spaces. These various prefixes correspond to the <CODE>fopen(3)</CODE> modes of <CODE>'r'</CODE>, <CODE>'r+'</CODE>, <CODE>'w'</CODE>, <CODE>'w+'</CODE>, <CODE>'a'</CODE>, and <CODE>'a+'</CODE>. If the filename begins with <CODE>'|'</CODE>, the filename is interpreted as a command to which output is to be piped, and if the filename ends with a <CODE>'|'</CODE>, the filename is interpreted See [%linkNodeTitle "perlman:perlipc|Using open() for IPC", $NODE, "Using open() for IPC",{anchor=>"Using_open_for_IPC"};%] for more examples of this. (You are not allowed to [perlfunc:open|open()] to a command that pipes both in and out, but see [perlfunc:../../lib/IPC/Open2|Open2], [perlfunc:../../lib/IPC/Open3|Open3], and [%linkNodeTitle "perlman:perlipc|Bidirectional Communication", $NODE, "Bidirectional Communication",{anchor=>"Bidirectional_Communication"};%] for alternatives.) Opening <CODE>'-'</CODE> opens STDIN and opening <CODE>'>-'</CODE> opens STDOUT. Open returns nonzero upon success, the undefined value otherwise. If the [perlfunc:open|open()] involved a pipe, the return value happens to be the pid of the subprocess. If you're unfortunate enough to be running Perl on a system that distinguishes between text files and binary files (modern operating systems don't care), then you should check out [perlfunc:binmode|binmode] for tips for dealing with this. The key distinction between systems that need [perlfunc:binmode|binmode()] and those that don't is their text file formats. Systems like Unix, MacOS, and Plan9, which delimit lines with a single character, and which encode that character in C as <CODE>"\n"</CODE>, do not need [perlfunc:binmode|binmode()]. The rest need it. When opening a file, it's usually a bad idea to continue normal execution if the request failed, so [perlfunc:open|open()] is frequently used in connection with [perlfunc:die|die()]. Even if [perlfunc:die|die()] won't do what you want (say, in a CGI script, where you want to make a nicely formatted error message (but there are modules that can help with that problem)) you should always check the return value from opening a file. The infrequent exception is when working with an unopened filehandle is actually what you want to do. Examples: <PRE> $ARTICLE = 100; open ARTICLE or die "Can't find article $ARTICLE: $!\n"; while (<ARTICLE>) {... </PRE> <PRE> open(LOG, '>>/usr/spool/news/twitlog'); # (log is reserved) # if the open fails, output is discarded </PRE> <PRE> open(DBASE, '+<dbase.mine') # open for update or die "Can't open 'dbase.mine' for update: $!"; </PRE> <PRE> open(ARTICLE, "caesar <$article |") # decrypt article or die "Can't start caesar: $!"; </PRE> <PRE> open(EXTRACT, "|sort >/tmp/Tmp$$") # $$ is our process id or die "Can't start sort: $!"; </PRE> <PRE> # process argument list of files along with any includes </PRE> <PRE> foreach $file (@ARGV) { process($file, 'fh00'); } </PRE> <PRE> sub process { my($filename, $input) = @_; $input++; # this is a string increment unless (open($input, $filename)) { print STDERR "Can't open $filename: $!\n"; return; } </PRE> <PRE> local $_; while (<$input>) { # note use of indirection if (/^#include "(.*)"/) { process($1, $input); next; } #... # whatever } } </PRE> You may also, in the Bourne shell tradition, specify an EXPR beginning with <CODE>'>&'</CODE>, in which case the rest of the string is interpreted as the name of a filehandle (or file descriptor, if numeric) to be duped and opened. You may use <CODE>&</CODE> after <CODE>></CODE>, <CODE>>></CODE>, <CODE><</CODE>, <CODE>+></CODE>, <CODE>+>></CODE>, and <CODE>+<</CODE>. The mode you specify should match the mode of the original filehandle. (Duping a filehandle does not take into account any existing contents of stdio buffers.) Here is a script that saves, redirects, and restores STDOUT and STDERR: <PRE> #!/usr/bin/perl open(OLDOUT, ">&STDOUT"); open(OLDERR, ">&STDERR"); </PRE> <PRE> open(STDOUT, ">foo.out") || die "Can't redirect stdout"; open(STDERR, ">&STDOUT") || die "Can't dup stdout"; </PRE> <PRE> select(STDERR); $| = 1; # make unbuffered select(STDOUT); $| = 1; # make unbuffered </PRE> <PRE> print STDOUT "stdout 1\n"; # this works for print STDERR "stderr 1\n"; # subprocesses too </PRE> <PRE> close(STDOUT); close(STDERR); </PRE> <PRE> open(STDOUT, ">&OLDOUT"); open(STDERR, ">&OLDERR"); </PRE> <PRE> print STDOUT "stdout 2\n"; print STDERR "stderr 2\n"; </PRE> If you specify <CODE>'<&=N'</CODE>, where <CODE>N</CODE> is a number, then Perl will do an equivalent of C's <CODE>fdopen()</CODE> of that file descriptor; this is more parsimonious of file descriptors. For example: <PRE> open(FILEHANDLE, "<&=$fd") </PRE> If you open a pipe on the command <CODE>'-'</CODE>, i.e., either <CODE>'|-'</CODE> or <CODE>'-|'</CODE>, then there is an implicit fork done, and the return value of open is the pid of the child within the parent process, and <CODE>0</CODE> within the child process. (Use [perlfunc:defined|defined($pid)] to determine whether the open was successful.) The filehandle behaves normally for the parent, but i/o to that filehandle is piped from/to the STDOUT/STDIN of the child process. In the child process the filehandle isn't opened--i/o happens from/to the new STDOUT or STDIN. Typically this is used like the normal piped open when you want to exercise more control over just how the pipe command gets executed, such as when you are running setuid, and don't want to have to scan shell commands for metacharacters. The following pairs are more or less equivalent: <PRE> open(FOO, "|tr '[a-z]' '[A-Z]'"); open(FOO, "|-") || exec 'tr', '[a-z]', '[A-Z]'; </PRE> <PRE> open(FOO, "cat -n '$file'|"); open(FOO, "-|") || exec 'cat', '-n', $file; </PRE> See [%linkNodeTitle "perlman:perlipc|Safe Pipe Opens", $NODE, "Safe Pipe Opens",{anchor=>"Safe_Pipe_Opens"};%] for more examples of this. NOTE: On any operation that may do a fork, any unflushed buffers remain unflushed in both processes, which means you may need to set <CODE>$|</CODE> to avoid duplicate output. Closing any piped filehandle causes the parent process to wait for the child to finish, and returns the status value in <CODE>$?</CODE>. The filename passed to open will have leading and trailing whitespace deleted, and the normal redirection characters honored. This property, known as ``magic open'', can often be used to good effect. A user could specify a filename of "rsh cat file |", or you could change certain filenames as needed: <PRE> $filename =~ s/(.*\.gz)\s*$/gzip -dc < $1|/; open(FH, $filename) or die "Can't open $filename: $!"; </PRE> However, to open a file with arbitrary weird characters in it, it's necessary to protect any leading and trailing whitespace: <PRE> $file =~ s#^(\s)#./$1#; open(FOO, "< $file\0"); </PRE> If you want a ``real'' C [perlfunc:open|open()] (see open(2) on your system), then you should use the <CODE>sysopen()</CODE> function, which involves no such magic. This is another way to protect your filenames from interpretation. For example: <PRE> use IO::Handle; sysopen(HANDLE, $path, O_RDWR|O_CREAT|O_EXCL) or die "sysopen $path: $!"; $oldfh = select(HANDLE); $| = 1; select($oldfh); print HANDLE "stuff $$\n"); seek(HANDLE, 0, 0); print "File contains: ", <HANDLE>; </PRE> Using the constructor from the <CODE>IO::Handle</CODE> package (or one of its subclasses, such as <CODE>IO::File</CODE> or <CODE>IO::Socket</CODE>), you can generate anonymous filehandles that have the scope of whatever variables hold references to them, and automatically close whenever and however you leave that scope: <PRE> use IO::File; #... sub read_myfile_munged { my $ALL = shift; my $handle = new IO::File; open($handle, "myfile") or die "myfile: $!"; $first = <$handle> or return (); # Automatically closed here. mung $first or die "mung failed"; # Or here. return $first, <$handle> if $ALL; # Or here. $first; # Or here. } </PRE> See [perlfunc:seek|seek()] for some details about mixing reading and writing. <HR>