Как вызывать system() в Perl и не обжечься

Каждый скрипт на Perl, проживший достаточно долго, рано или поздно вызывает что-то через оболочку. И почти каждый делает это неправильно одними и теми же тремя способами: собирает командную строку, игнорирует код возврата и позволяет оболочке интерпретировать данные, которые никто не собирался интерпретировать. Вот вариант, который не кусается.

Списочная форма, а не строка

У system два соглашения о вызове, и разница между ними — это вся история.

# Wrong: one string, handed to /bin/sh
system("cp $src $dst");

# Right: a list, executed directly
system("cp", $src, $dst);

Строковая форма передаёт всю строку оболочке. Оболочка затем разбивает её по пробелам, раскрывает шаблоны, интерпретирует кавычки и уважает каждый известный ей метасимвол. Если $src — это my file.txt, вы копируете два несуществующих файла. Если это ; rm -rf ~, у вас будет куда более неприятный вечер.

Списочная форма полностью обходит оболочку. Perl вызывает execvp с аргументами ровно такими, какими вы их дали. Имя файла с пробелом — один аргумент. Имя файла с точкой с запятой — один аргумент. Ничего не интерпретируется, потому что ничего не разбирается.

Правило простое: если элементов больше одного, используйте списочную форму. Строковая форма оправданна только тогда, когда вам действительно нужна оболочка — для конвейера или перенаправления, — и даже тогда перенаправление лучше сделать в Perl.

Проверяйте код возврата, и проверяйте правильно

system не умирает при неудаче. Он возвращает значение, и это значение не то, чего ожидают люди.

my $rc = system("make", "all");

$rc — это сырой статус ожидания, то же значение, что попадает в $?. В нём упакованы три вещи: код выхода в старшем байте, сигнал, убивший потомка, в младших семи битах и флаг дампа памяти. Потомок, завершившийся со статусом 1, даёт вам 256. Потомок, убитый SIGSEGV, даёт 11. Потомок, который вообще не смог запуститься, даёт -1.

Так что распакуйте его:

my $rc = system("make", "all");
if ($rc == -1) {
    die "failed to execute make: $!";
}
elsif ($rc & 127) {
    die sprintf("make died with signal %d%s",
        ($rc & 127), ($rc & 128) ? ", core dumped" : "");
}
elsif ($rc >> 8) {
    die sprintf("make exited with status %d", $rc >> 8);
}

Это многословно, поэтому никто так не пишет, поэтому скрипты молча продолжают работу после того, как компиляция провалилась. Оберните это один раз:

sub run {
    my @cmd = @_;
    my $rc = system(@cmd);
    return if $rc == 0;
    my $desc = join(" ", @cmd);
    die "failed to execute [$desc]: $!\n" if $rc == -1;
    die sprintf("[%s] died with signal %d\n", $desc, $rc & 127) if $rc & 127;
    die sprintf("[%s] exited with status %d\n", $desc, $rc >> 8);
}

run("make", "all");
run("cp", $src, $dst);

Теперь неудачная команда останавливает скрипт с сообщением, которое говорит, что упало и как. Непроверенный вызов внешней команды — это вызов, объявленный несущественным, а будь он несущественным, вы бы его не выполняли.

Захват вывода

system возвращает статус и позволяет потомку писать в ваш stdout. Когда вам нужен сам вывод, рефлекс — обратные кавычки:

my $out = `ls $dir`;

У обратных кавычек ровно та же проблема, что у строковой формы: всё целиком идёт через оболочку. Новые версии Perl принимают списочную форму для readpipe, но переносимый ответ — открыть канал из списка:

open(my $fh, "-|", "ls", "-l", $dir)
    or die "cannot run ls: $!";
my @lines = <$fh>;
close($fh) or die "ls failed with status " . ($? >> 8);

Трёхаргументный open с режимом -| запускает команду по списку, без оболочки, и даёт вам дескриптор файла на её вывод. close возвращает ложь, если потомок завершился неудачей, а $? хранит статус, так что проверка достаётся вам бесплатно.

Для чего-то более сложного — и stdout, и stderr, подача stdin, тайм-ауты — используйте IPC::Open3 из стандартной поставки или IPC::Run из CPAN. Не собирайте строку конвейера, чтобы отдать её оболочке.

Кавычки — не решение

Кто-нибудь скажет: просто заключите переменные в кавычки.

system("cp '$src' '$dst'");   # still wrong

А если $src содержит одинарную кавычку? Вы её экранируете. А если он содержит перевод строки, или обратную косую черту, или знак доллара внутри двойных кавычек? Правила кавычек в оболочке запутаны и различаются между оболочками, и каждый добавленный слой экранирования — ещё одно место для ошибки. String::ShellQuote делает это правильно, если уж приходится, но не приходится: списочная форма заставляет всю проблему исчезнуть, а исчезнувшие проблемы лучше решённых.

Итог

  • Используйте списочную форму system, если только вы сознательно не вызываете оболочку.
  • Всегда проверяйте код возврата и распаковывайте его: -1 — не удалось запустить, младшие биты — сигнал, старший байт — статус выхода.
  • Оберните проверку один раз и вызывайте обёртку везде.
  • Чтобы захватить вывод, открывайте канал через open со списком и проверяйте close.
  • Не пытайтесь выбраться из строковой формы с помощью кавычек.

Ничего хитрого тут нет. Это то, что perldoc -f system говорит уже двадцать лет. Просто неправильный способ занимает одну строку, а правильный — пять, и пять проигрывают одной — до первого раза, когда в имени файла окажется пробел.