View source for Perl:executing external commands

From SME Server

You do not have permission to edit this page, for the following reason:

The action you have requested is limited to users in the group: Users.

You can view and copy the source of this page.

There are many ways to execute external commands from Perl. The most commons are:

    system function
    exec function
    backticks (``) operator
    open function

All of these methods have different behaviour, so you should choose which one to use depending of your particular need. In brief, these are the recommendations:

method	use if ...
 system()	you want to execute a command and don't want to capture its output
 exec	you don't want to return to the calling perl script
 backticks	you want to capture the output of the command
 open	you want to pipe the command (as input or output) to your script



More detailed explanations of each method follows:

* Using system()

system() executes the command specified. It doesn't capture the output of the command.

system() accepts as argument either a scalar or an array. If the argument is a scalar, system() uses a shell to execute the command ("/bin/sh -c command"); if the argument is an array it executes the command directly, considering the first element of the array as the command name and the remaining array elements as arguments to the command to be executed.

For that reason, it's highly recommended for efficiency and safety reasons (specially if you're running a cgi script) that you use an array to pass arguments to system()

Example:

 #-- calling 'command' with arguments
 system("command arg1 arg2 arg3");
 
 #-- better way of calling the same command
 system("command", "arg1", "arg2", "arg3");

The return value is set in $?; this value is the exit status of the command as returned by the 'wait' call; to get the real exit status of the command you have to shift right by 8 the value of $? ($? >> 8).

If the value of $? is -1, then the command failed to execute, in that case you may check the value of $! for the reason of the failure.

Example:

 system("command", "arg1");
 if ( $? == -1 )
 {
  print "command failed: $!\n";
 }
 else
 {
  printf "command exited with value %d", $? >> 8;
 }

* Using exec()

The exec() function executes the command specified and never returns to the calling program, except in the case of failure because the specified command does not exist AND the exec argument is an array.

Like in system(), is recommended to pass the arguments of the functions as an array.

* Using backticks (``)

In this case the command to be executed is surrounded by backticks. The command is executed and the output of the command is returned to the calling script.

In scalar context it returns a single (possibly multiline) string, in list context it returns a list of lines or an empty list if the command failed.

The exit status of the executed command is stored in $? (see system() above for details).

Example:

 #-- scalar context
 $result = `command arg1 arg2`;
 
 #-- the same command in list context
 @result = `command arg2 arg2`;

Notice that the only output captured is STDOUT, to collect messages sent to STDERR you should redirect STDERR to STDOUT

Example:

 #-- capture STDERR as well as STDOUT
 $result = `command 2>&1`;

* Using open()

Use open() when you want to:

- capture the data of a command (syntax: open("command |"))

- feed an external command with data generated from the Perl script (syntax: open("| command"))

Examples:

 #-- list the processes running on your system
 open(PS,"ps -e -o pid,stime,args |") || die "Failed: $!\n";
 while ( <PS> )
 {
  #-- do something here
 }
 
 #-- send an email to user@localhost
 open(MAIL, "| /bin/mailx -s test user\@localhost ") || die "mailx failed: $!\n";
 print MAIL "This is a test message";
[[Category:Developer]]

Return to Perl:executing external commands.

Retrieved from "https://wiki.koozali.org/Perl:executing_external_commands"

View source for Perl:executing external commands

Navigation menu

Page actions

Page actions

Personal tools

Koozali SME Server

Recent activities

Koozali resources

Koozali SME Server wiki

Tools

Search