Frank Seitz
and 1 contributors

NAME

Prty::Shell - Ausführung von Shell-Kommandos

BASE CLASS

Prty::Hash

METHODS

Konstruktor/Destruktor

new() - Konstruktor

Synopsis

    $sh = $class->new(@opt);

Description

Instantiiere ein Shell-Objekt, und liefere eine Referenz auf dieses Objekt zurück.

Options

cmdPrefix => $str (Default: '')

Zeichenkette, der jeder Kommandozeile im Log vorangestellt wird.

dryRun => $bool (Default: 0)

Führe Kommandos nicht aus, sondern logge sie nur (impliziert log=>1).

log => $bool (Default: 0)

Log Commands to STDOUT.

logDest => $fd (Default: *STDOUT)

Datei-Deskriptor, auf den die Logmeldungen geschrieben werden.

msgPrefix => $str (Default: '')

Zeichenkette, die jeder Meldung im Log vorangestellt wird.

time => $bool (Default: 0)

Gib nach jedem Kommando die Zeit aus, die es benötigt hat.

timePrefix => $str (Default: '')

Zeichenkette, die jeder Zeitausgabe vorangestellt wird.

timeSummary => $bool (Default: 0)

Gib zum Schluss bei der Destrukturierung des Objekts die Gesamtausführungszeit aus.

DESTROY() - Destruktor

Synopsis

    $sh->%METH;

Description

Wenn timeSummary gesetzt ist, wird im Zuge der Destruktuierung die Gesamtausführungszeit für alle Kommandos, die über das Shell-Objekt ausgeführt wurden, ausgegeben.

Kommando ausführen

exec() - Führe Kommando aus

Synopsis

    $str|@arr = $this->exec($cmd,@opt);

Description

Führe Kommando $cmd aus. Im Falle eines Fehlers löse eine Exception aus.

Beginnt das Kommando $cmd mit einem Bindestrich, wird implizit die Option -sloppy gesetzt.

Options

-capture => $channels (Default: keiner)

Liefere die die Programmausgabe auf dem Kanal bzw. den Kanälen $channels zurück. Mögliche Werte für $channels:

'stdout'

Liefere Ausgabe auf stdout, unterdrücke stderr.

'stderr'

Liefere Ausgabe auf stderr, unterdrücke stdout.

'stdout+stderr'

Liefere Ausgabe auf stdout und stderr zusammen.

'stdout,stderr'

Liefere Ausgabe auf stdout und stderr getrennt.

Für Beispiele siehe Abschnitt "exec/Examples".

-quiet => $bool (Default: 0)

Unterdrücke Programmausgabe auf stdout und stderr.

-sloppy => $bool (Default: 0)

Wirf keine Exception, wenn das Programm fehlschlägt, sondern liefere dessen Exitcode. Ist gleichzeitig die Option -capture angegeben, hat diese hinsichtlich des Rückgabewerts Priorität.

Returns

Der Rückgabewert richtet sich nach den Optionen @opt. Ist -capture definiert, wird die angegebene Programmausgabe geliefert. Ist -sloppy wahr, wird der Exitcode geliefert. Die Option -capture hat Priorität gegenüber der Option -sloppy. Sind weder -capture noch -sloppy angegeben, liefert die Methode keinen Wert.

Examples

Unterdrücke Ausgabe auf stdout und stderr:

    $this->exec($cmd,-quiet=>1);

Liefere Ausgabe auf stdout:

    $stdout = $this->exec($cmd,-capture=>'stdout');

Liefere Ausgabe auf stderr:

    $stderr = $this->exec($cmd,-capture=>'stderr');

Liefere Ausgabe auf stdout und stderr zusammen:

    $output = $this->exec($cmd,-capture=>'stdout+stderr');

Liefere Ausgabe auf stdout und stderr getrennt:

    ($stdout,$stderr) = $this->exec($cmd,-capture=>'stdout,stderr');

Keine Exception, liefere Exitcode:

    $exitCode = $this->exec($cmd,-sloppy=>1);

Arbeitsverzeichnis wechseln

cd() - Wechsele das Arbeitsverzeichnis

Synopsis

    $sh->cd($dir);

Description

Wechsle in Arbeitsverzeichnis $dir. Anmerkung: Diese Änderung gilt für den gesamten Prozess, nicht nur für das Shell-Objekt.

Returns

Die Methode liefert keinen Wert zurück.

back() - Wechsele ins vorige Arbeitsverzeichnis zurück

Synopsis

    $this->back;

Fehlerbehandlung

checkError() - Löse Exception bei Kommandofehler aus

Synopsis

    $this->checkError($code,$errMsg,@cmd);

Description

Prüfe den Status einer vorhergehenden Programmausführung und löse eine Execption aus, wenn der Status ungleich 0 ist.

Returns

nichts

Examples

Prüfe den Ausführungsstatus von system():

    system($cmd);
    Prty::Shell->checkError($?,$!,$cmd);

Prüfe den Ausführungsstatus des Backtick-Operators:

    $str = `$cmd`;
    Prty::Shell->checkError($?,$!,$cmd);

VERSION

1.108

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2017 Frank Seitz

LICENSE

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