Cách xác định tập lệnh shell sẽ có nguồn gốc không chạy

Tôi đang xác định một tập lệnh shell mà người dùng nên sourcethực hiện.

Có một cách thông thường hoặc thông minh để gợi ý cho người dùng rằng đây là trường hợp, ví dụ thông qua một phần mở rộng tập tin?

Có mã shell nào tôi có thể tự viết trong tệp, điều này sẽ khiến nó lặp lại một tin nhắn và thoát nếu nó được thực thi thay vì nguồn gốc, để tôi có thể giúp người dùng tránh sai lầm rõ ràng này?

Giả sử rằng bạn đang chạy bash, hãy đặt đoạn mã sau gần đầu tập lệnh mà bạn muốn có nguồn gốc nhưng không được thực thi:

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

Trong bash, ${BASH_SOURCE[0]}sẽ chứa tên của tệp hiện tại mà trình bao đang đọc bất kể nó có nguồn gốc hay được thực thi.

Ngược lại, $0là tên của tệp hiện tại đang được thực thi.

-efkiểm tra nếu hai tập tin này là cùng một tập tin. Nếu có, chúng tôi cảnh báo người dùng và thoát.

Cả POSIX -efcũng không BASH_SOURCE. Trong khi -efđược hỗ trợ bởi ksh, yash, zsh và Dash, BASH_SOURCEyêu cầu bash. Trongzsh , tuy nhiên, ${BASH_SOURCE[0]}có thể được thay thế bởi ${(%):-%N}.

Một tập tin không thể thực thi có thể có nguồn gốc nhưng không được thực thi, vì vậy, như là một tuyến phòng thủ đầu tiên, không đặt cờ thực thi nên là một gợi ý tốt ...

Chỉnh sửa: mẹo tôi vừa vấp ngã: làm cho shebang trở thành bất kỳ thực thi nào không phải là trình thông dịch shell, /bin/falselàm cho tập lệnh trả về lỗi (rc! = 0)

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

Có một số phương pháp được đề xuất trong bài viết Stack Overflow này , trong đó, tôi thích phương pháp dựa trên chức năng được đề xuất bởi WiINA Purwanto và mr.spuratic :

Cách mạnh mẽ nhất, như được đề xuất bởi WiINA Purwanto, là kiểm tra FUNCNAME[1] trong một chức năng :

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

Sau đó:

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

Điều này tương đương với việc kiểm tra đầu ra của caller, các giá trị mainvà sourcephân biệt bối cảnh của người gọi. Sử dụng FUNCNAME[]giúp bạn nắm bắt và phân tích callerđầu ra. Bạn cần phải biết hoặc tính toán độ sâu cuộc gọi địa phương của bạn để được chính xác mặc dù. Các trường hợp như một tập lệnh được lấy nguồn từ bên trong một chức năng hoặc tập lệnh khác sẽ làm cho mảng (ngăn xếp) sâu hơn. ( FUNCNAMElà một biến mảng bash đặc biệt, nó nên có các chỉ mục liền kề tương ứng với ngăn xếp cuộc gọi, miễn là không bao giờ unset.)

Vì vậy, bạn có thể thêm vào đầu tập lệnh:

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

Giả sử nó chỉ là vô dụng, thay vì có hại, để thực thi tập lệnh, bạn có thể thêm

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

đến cuối kịch bản. returnbên ngoài hàm có mã thoát khác không trừ khi tệp đang được lấy nguồn.

Khi bạn lấy một tập lệnh shell, dòng shebang sẽ bị bỏ qua. Bằng cách đặt một shebang không hợp lệ, bạn có thể cảnh báo người dùng rằng tập lệnh đã được thực thi sai:

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

Thông báo lỗi sẽ là:

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

Tên đối số (tùy ý) đã cung cấp một gợi ý mạnh mẽ, nhưng thông báo lỗi vẫn không rõ ràng 100%. Chúng tôi có thể khắc phục điều này bằng một tập lệnh tiện ích source-this-scriptđược đặt ở đâu đó trong PATH:

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

Bây giờ, thông báo lỗi sẽ là:

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

So sánh với các phương pháp khác

So với các câu trả lời khác, cách tiếp cận này chỉ yêu cầu thay đổi tối thiểu cho mỗi tập lệnh (và có một dòng shebang giúp phát hiện loại tệp trong trình chỉnh sửa và chỉ định phương ngữ tập lệnh shell, do đó thậm chí còn có lợi ích). Nhược điểm là một thông báo lỗi không rõ ràng hoặc bổ sung (một lần) của một tập lệnh shell khác.

Tuy nhiên, điều đó không ngăn cản việc gọi rõ ràng bash path/to/script.sh(cảm ơn @muru!).