Cara mendefinisikan skrip shell yang akan bersumber tidak berjalan

Saya mendefinisikan skrip shell yang harus sourcedieksekusi oleh pengguna.

Apakah ada cara konvensional atau cerdas untuk memberi petunjuk kepada pengguna bahwa ini adalah kasusnya, misalnya melalui ekstensi file?

Apakah ada kode shell yang dapat saya tulis di file itu sendiri, yang akan menyebabkannya mengulangi pesan dan berhenti jika dieksekusi alih-alih bersumber, sehingga saya dapat membantu pengguna menghindari kesalahan yang jelas ini?

Dengan asumsi bahwa Anda menjalankan bash, letakkan kode berikut di dekat awal skrip yang ingin Anda gunakan tetapi tidak dijalankan:

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

Di bawah bash, ${BASH_SOURCE[0]}akan berisi nama file saat ini yang dibaca oleh shell terlepas dari apakah itu bersumber atau dieksekusi.

Sebaliknya, $0adalah nama file saat ini sedang dieksekusi.

-efmenguji apakah kedua file ini adalah file yang sama. Jika ya, kami memperingatkan pengguna dan keluar.

Baik -efatau BASH_SOURCEyang POSIX. Sementara -efdidukung oleh ksh, yash, zsh dan Dash, BASH_SOURCEmembutuhkan bash. Dalamzsh Namun, ${BASH_SOURCE[0]}bisa diganti oleh ${(%):-%N}.

File yang tidak dapat dieksekusi dapat bersumber tetapi tidak dieksekusi, jadi, sebagai garis pertahanan pertama, tidak menetapkan bendera yang dapat dieksekusi harus menjadi petunjuk yang baik ...

Sunting: trik Saya baru saja menemukan: membuat shebang menjadi executable yang bukan shell interpreter, /bin/falsemembuat skrip mengembalikan kesalahan (rc! = 0)

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

Ada beberapa metode yang disarankan dalam posting Stack Overflow ini , di antaranya, saya menyukai yang berbasis fungsi yang disarankan oleh Wirawan Purwanto dan mr.spuratic best:

Cara yang paling kuat, seperti yang disarankan oleh Wirawan Purwanto, adalah memeriksa FUNCNAME[1] dalam suatu fungsi :

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

Kemudian:

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

Ini setara dengan memeriksa output caller, nilai-nilai maindan sourcemembedakan konteks pemanggil. Menggunakan FUNCNAME[]save yang Anda ambil dan parsing calleroutput. Anda perlu tahu atau menghitung kedalaman panggilan lokal Anda untuk menjadi benar. Kasus-kasus seperti skrip yang bersumber dari dalam fungsi atau skrip lain akan menyebabkan array (tumpukan) menjadi lebih dalam. ( FUNCNAMEadalah variabel array bash khusus, harus memiliki indeks berdekatan yang sesuai dengan tumpukan panggilan, selama tidak pernah unset.)

Jadi, Anda dapat menambahkan ke awal skrip:

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

Anggap saja tidak ada gunanya, daripada merusak, untuk mengeksekusi skrip, Anda dapat menambahkan

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

sampai akhir skrip. returndi luar fungsi memiliki kode keluar non-nol kecuali file tersebut bersumber.

Saat Anda mendapatkan skrip shell, garis shebang diabaikan. Dengan memasukkan shebang yang tidak valid, Anda dapat memberi tahu pengguna bahwa skrip itu dieksekusi dengan keliru:

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

Pesan kesalahannya adalah ini:

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

Nama argumen (sewenang-wenang) sudah memberikan petunjuk yang kuat, tetapi pesan kesalahan masih belum 100% jelas. Kami dapat memperbaikinya dengan skrip utilitas source-this-scriptyang ditempatkan di suatu tempat di Anda PATH:

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

Sekarang, pesan kesalahannya adalah ini:

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

Perbandingan dengan pendekatan lain

Dibandingkan dengan jawaban lain, pendekatan ini hanya memerlukan perubahan minimal untuk setiap skrip (dan memiliki garis shebang membantu dengan deteksi tipe file di editor dan menentukan dialek skrip shell, sehingga bahkan ada manfaatnya). Kelemahannya adalah pesan kesalahan yang agak tidak jelas, atau penambahan (satu kali) dari skrip shell lain.

Itu tidak mencegah permintaan eksplisit melalui bash path/to/script.sh, (terima kasih @muru!).