Bash-Parameter-Anführungszeichen und Eval

Question

Ich habe eine Bash-Logging-Bibliothek geschrieben, um mit einigen komplexen Skripten implementiert werden, die meine Firma derzeit verwendet. Ich war todadset auf den Skript-Dateinamen ($ {BASH_SOURCE}) und die Zeilennummer ($ {LINENO}) des aufrufenden Skripts bei den Protokollaufrufen. Ich wollte mich jedoch nicht auf den Benutzer oder das Implementierungsscript verlassen müssen, um diese beiden Variablen als Parameter zu übergeben. Wenn dies C/C++ wäre, würde ich einfach ein Makro erstellen, das "__FILE__" und "__LINE__" der Parameterliste vorstellt.

Ich konnte endlich diesen Teil arbeiten. Hier sind einige viel vereinfachte Abstracts als Proof of Concept:

Hier ist die Logging-Bibliothek:

# log.sh 

LOG="eval _log \${BASH_SOURCE} \${LINENO}" 

_log() { 
    _BASH_SOURCE=`basename "${1}"` && shift 
    _LINENO=${1} && shift 

    echo "(${_BASH_SOURCE}:${_LINENO}) $@" 
} 

Und eine Implementierung Testskript:

# MyTest.sh 

. ./log.sh 

${LOG} "This is a log message" 
# (test.sh:5) This is a log message 

Das funktioniert ziemlich gut (und ich war begeistert, dass es zuerst funktioniert). Dies hat jedoch ein eklatantes Problem: Die Interaktion zwischen Anführungszeichen und eval. Wenn ich den Anruf mache:

${LOG} "I'm thrilled that I got this working" 
# ./test.sh: eval: line 5: unexected EOF while looking for matching `'' 
# ./test.sh: eval: line 6: syntax error: unexpected end of file 

Jetzt glaube ich, dass ich verstehe, warum das passiert. Die in Anführungszeichen gesetzten Parameter bleiben intakt, wenn sie an eval übergeben werden. Zu diesem Zeitpunkt wird der Inhalt unverändert in die resultierende Befehlszeichenfolge eingefügt. Ich weiß, dass ich das beheben kann, indem ich etwas entfliehe; aber ich WIRKLICH wollen nicht die Implementierungsskripts zu zwingen, dies zu tun haben. Bevor ich diese "eval macro" -Funktionalität implementiert habe, ließ ich Benutzer direkt zu "_log" aufrufen und erlaubte ihnen, optional "$ {LINENO}" zu übergeben. Mit dieser Implementierung funktionierte der obige fehlgeschlagene Aufruf (mit nur einem Satz in Anführungszeichen) einwandfrei.

Auf der untersten Ebene, alles, was ich wirklich will, ist für einen Skript in der Lage sein aufrufe [Funktion/Makro lügt] „String mit speziellem characers anmelden“ und die resultierenden Protokollmeldung enthalten hat die Dateinamen und Zeile Nummer des aufrufenden Skripts, gefolgt von der Protokollnachricht. Wenn es möglich ist, würde ich annehmen, dass ich sehr nahe bin, aber wenn etwas, das ich übersehe, etwas anderes erfordert, bin ich auch dafür offen. Ich kann die Benutzer nicht zwingen, allen ihren Nachrichten zu entkommen, da dies wahrscheinlich dazu führen wird, dass sie diese Bibliothek nicht benutzen. Das ist solch ein Problem, dass, wenn ich keine Lösung dafür finden kann, ich wahrscheinlich zu der alten Fähigkeit zurückkehren werde (die $ {LINENO} erforderte, um als Funktionsparameter übergeben zu werden - das war viel weniger aufdringlich).

TLDR: Gibt es eine Möglichkeit, eval dazu zu bringen, Sonderzeichen innerhalb eines in Anführungszeichen gesetzten Parameters zu respektieren, ohne ihnen entkommen zu müssen?

Answer 1

Ich empfehle, eval zu vermeiden, wenn möglich. Für Ihren Anwendungsfall für die Protokollierung können Sie sich die Shell caller ansehen. Wenn Sie weitere Informationen benötigen, können Sie die Variablen BASH_SOURCE, BASH_LINENO und FUNCNAME verwenden. Beachten Sie, dass alle diese Variablen Arrays sind und den vollständigen Aufruf-Stack enthalten.Siehe das folgende Beispiel:

#! /bin/bash  

function log() { 
    echo "[$(caller)] $*" >&2 
    echo "BASH_SOURCE: ${BASH_SOURCE[*]}" 
    echo "BASH_LINENO: ${BASH_LINENO[*]}" 
    echo "FUNCNAME: ${FUNCNAME[*]}" 
} 

function foobar() { 
    log "failed:" "$@" 
} 

foobar "$@" 

Answer 2

(Anmerkung: diese das unmittelbare Problem zu zitieren löst, aber @ nosid Antwort über den Call-Stack Zugriff ist viel besser)

ändern Ihre Definition von _log leicht zu lesen, die Protokollmeldung von Positionsparametern von der Standardeingabe statt unter:

_log() { 
    # Set up _BASH_SOURCE and _LINENO the same way 

    cat <(echo -n "$(_BASH_SOURCE:$_LINENO) ") - 
} 

Dann Ihre Log-Nachricht über die Standardeingabe ein hier doc oder eine hier Zeichenfolge mit übergeben:

${LOG} <<<"This is a log message" 
${LOG} <<<"I'm thrilled this works, too!" 
${LOG} <<HERE 
Even this long 
message works as 
intended! 
HERE