So definieren Sie ein Shell-Skript, das nicht ausgeführt werden soll

Ich definiere ein Shell-Skript, das ein Benutzer sourceausführen soll, anstatt es auszuführen.

Gibt es eine herkömmliche oder intelligente Möglichkeit, dem Benutzer anzuzeigen, dass dies der Fall ist, beispielsweise über eine Dateierweiterung?

Gibt es Shell-Code, den ich in die Datei selbst schreiben kann, wodurch eine Meldung ausgegeben und die Datei beendet wird, wenn sie anstelle von sourced ausgeführt wird, damit der Benutzer diesen offensichtlichen Fehler vermeiden kann?

Angenommen, Sie führen bash aus, platzieren Sie den folgenden Code in der Nähe des Starts des Skripts, dessen Quelle Sie verwenden möchten, der jedoch nicht ausgeführt wird:

if [ "${BASH_SOURCE[0]}" -ef "$0" ]
then
    echo "Hey, you should source this script, not execute it!"
    exit 1
fi

Enthält unter Bash ${BASH_SOURCE[0]}den Namen der aktuellen Datei, die von der Shell gelesen wird, unabhängig davon, ob sie bezogen oder ausgeführt wird.

Im Gegensatz dazu $0ist der Name der aktuell ausgeführten Datei.

-eftestet, ob diese beiden Dateien dieselbe Datei sind. Wenn dies der Fall ist, benachrichtigen wir den Benutzer und beenden das Programm.

Weder POSIX -efnoch BASH_SOURCEPOSIX. Während -efvon ksh, yash, zsh und Dash unterstützt wird, ist BASH_SOURCEbash erforderlich. Inzsh jedoch ${BASH_SOURCE[0]}könnte ersetzt werden durch ${(%):-%N}.

Eine nicht ausführbare Datei kann aus dem Internet bezogen, aber nicht ausgeführt werden. Daher sollte es ein guter Hinweis sein, das Flag für die ausführbare Datei nicht zu setzen.

Edit: Trick, über den ich gerade gestolpert bin: mache den Shebang zu einer ausführbaren Datei, die kein Shell-Interpreter ist, und /bin/falselasse das Skript einen Fehler zurückgeben (rc! = 0)

#!/bin/false "This script should be sourced in a shell, not executed directly"

In diesem Beitrag zum Stapelüberlauf werden mehrere Methoden vorgeschlagen , von denen mir die von Wirawan Purwanto und mr.spuratic vorgeschlagene funktionsbasierte am besten gefallen hat :

Der robusteste Weg, wie von Wirawan Purwanto vorgeschlagen, ist die Überprüfung FUNCNAME[1] innerhalb einer Funktion :

function mycheck() { declare -p FUNCNAME; }
mycheck

Dann:

$ bash sourcetest.sh
declare -a FUNCNAME='([0]="mycheck" [1]="main")'
$ . sourcetest.sh
declare -a FUNCNAME='([0]="mycheck" [1]="source")'

Dies ist das Äquivalent zur Überprüfung der Ausgabe caller, der Werte mainund der sourceUnterscheidung des Kontextes des Aufrufers. Mit FUNCNAME[]sparen Sie sich das Erfassen und Parsen von callerAusgaben. Sie müssen jedoch Ihre lokale Anruftiefe kennen oder berechnen, um korrekt zu sein. Fälle wie ein Skript, das aus einer anderen Funktion oder einem anderen Skript stammt, führen dazu, dass das Array (der Stapel) tiefer liegt. ( FUNCNAMEDies ist eine spezielle Bash-Array-Variable. Sie sollte zusammenhängende Indizes aufweisen, die dem Aufrufstapel entsprechen, sofern dies niemals der Fall ist unset.)

So können Sie am Anfang des Skripts Folgendes hinzufügen:

function check()
{
    if [[ ${FUNCNAME[-1]} != "source" ]]   # bash 4.2+, use ${FUNCNAME[@]: -1} for older
    then
        printf "Usage: source %s\n" "$0"
        exit 1
    fi
}
check

Angenommen, es ist nicht schädlich, das Skript auszuführen, können Sie hinzufügen

return 0 || printf 'Must be sourced, not executed\n' >&2

bis zum Ende des Skripts. returnaußerhalb einer Funktion hat einen Exit-Code ungleich Null, es sei denn, die Datei wird bezogen.

Wenn Sie ein Shell-Skript erstellen , wird die Shebang- Zeile ignoriert. Indem Sie einen ungültigen Shebang eingeben, können Sie den Benutzer darauf hinweisen, dass das Skript fälschlicherweise ausgeführt wurde:

#!/bin/bash source-this-script
# ...

Die Fehlermeldung lautet wie folgt:

/bin/bash: source-this-script: No such file or directory

Der (willkürliche) Argumentname gibt bereits einen starken Hinweis, aber die Fehlermeldung ist immer noch nicht 100% klar. Wir können dies mit einem Hilfsprogramm beheben source-this-script, das sich irgendwo in Ihrem befindet PATH:

#!/bin/sh
echo >&2 "This script must be sourced, not executed${1:+: }${1:-!}"
exit 1

Nun lautet die Fehlermeldung wie folgt:

This script must be sourced, not executed: path/to/script.sh

Vergleich zu anderen Ansätzen

Im Vergleich zu den anderen Antworten erfordert dieser Ansatz nur minimale Änderungen an jedem Skript (und eine Shebang-Zeile hilft bei der Erkennung von Dateitypen in Editoren und gibt den Shell-Skript-Dialekt an, sodass es sogar Vorteile gibt). Der Nachteil ist eine etwas unklare Fehlermeldung oder das (einmalige) Hinzufügen eines anderen Shell-Skripts.

Es verhindert jedoch nicht den expliziten Aufruf über bash path/to/script.sh(danke @muru!).