Jak zdefiniować skrypt powłoki, który ma być pozyskiwany, aby nie był uruchamiany

Definiuję skrypt powłoki, który użytkownik powinien sourceraczej wykonać niż wykonać.

Czy istnieje konwencjonalny lub inteligentny sposób, aby poinformować użytkownika, że ​​tak jest, na przykład poprzez rozszerzenie pliku?

Czy istnieje kod powłoki, który mogę napisać w samym pliku, co spowoduje, że wyświetli komunikat i zakończy działanie, jeśli zostanie wykonany zamiast źródła, aby pomóc użytkownikowi uniknąć tego oczywistego błędu?

Zakładając, że uruchamiasz bash, umieść następujący kod na początku skryptu, który chcesz pobrać, ale nie wykonać:

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

Pod bash ${BASH_SOURCE[0]}będzie zawierać nazwę bieżącego pliku, który odczytuje powłoka, niezależnie od tego, czy jest pobierana czy wykonywana.

Natomiast $0nazwa bieżącego pliku, który jest wykonywany.

-efsprawdza, czy te dwa pliki są tym samym plikiem. Jeśli tak, ostrzegamy użytkownika i wychodzimy.

POSIX też -efnie BASH_SOURCEjest. Chociaż -efjest obsługiwany przez ksh, yash, zsh i Dash, BASH_SOURCEwymaga bash. Wzsh jednakże ${BASH_SOURCE[0]}można zastąpić ${(%):-%N}.

Plik niewykonywalny może być pozyskiwany, ale nie wykonywany, więc jako pierwsza linia obrony nie ustawianie flagi wykonywalnej powinno być dobrą wskazówką ...

Edycja: trik, na który się natknąłem: spraw, aby shebang był dowolnym plikiem wykonywalnym, który nie jest interpreterem powłoki, /bin/falsepowoduje , że skrypt zwraca błąd (rc! = 0)

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

W tym wpisie przepełnienia stosu zasugerowano kilka metod , z których najbardziej podobała mi się ta oparta na funkcjach, sugerowana przez Wirawana Purwanto i mr.spuratic najlepiej:

Najbardziej niezawodny sposób, jak sugeruje Wirawan Purwanto, to sprawdzenie FUNCNAME[1] w ramach funkcji :

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

Następnie:

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

Jest to równoważne sprawdzeniu danych wyjściowych caller, wartości maini sourcerozróżnieniu kontekstu osoby dzwoniącej. Użycie FUNCNAME[]oszczędza przechwytywanie i analizowanie callerwyników. Musisz jednak znać lub obliczyć głębokość lokalnego połączenia, aby być poprawnym. Przypadki takie jak skrypt pochodzący z innej funkcji lub skryptu powodują, że tablica (stos) jest głębsza. ( FUNCNAMEjest specjalną zmienną tablicową bash, powinna mieć ciągłe indeksy odpowiadające stosowi wywołań, o ile nie jest to nigdy unset).

Możesz więc dodać na początku skryptu:

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

Zakładając, że wykonanie skryptu jest po prostu bezużyteczne, a nie szkodliwe, możesz dodać

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

do końca skryptu. returnpoza funkcją ma niezerowy kod wyjścia, chyba że plik jest pobierany.

Gdy pozyskujesz skrypt powłoki, linia shebang jest ignorowana. Wprowadzając nieprawidłowy shebang, możesz ostrzec użytkownika, że ​​skrypt został błędnie wykonany:

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

Komunikat o błędzie będzie następujący:

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

(Dowolna) nazwa argumentu już zapewnia silną wskazówkę, ale komunikat o błędzie nadal nie jest w 100% wyraźny. Możemy to naprawić za pomocą skryptu narzędzia source-this-scriptumieszczonego gdzieś w twoim PATH:

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

Teraz komunikat o błędzie będzie następujący:

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

Porównanie z innymi podejściami

W porównaniu z innymi odpowiedziami to podejście wymaga jedynie minimalnych zmian w każdym skrypcie (a posiadanie linii shebang pomaga w wykrywaniu typów plików w edytorach i określa dialekt skryptu powłoki, więc są nawet korzyści). Minusem jest nieco niejasny komunikat o błędzie lub (jednorazowe) dodanie innego skryptu powłoki.

Nie zapobiega to bash path/to/script.shjednak jawnemu wywoływaniu za pośrednictwem (dzięki @muru!).