วิธีการกำหนดเชลล์สคริปต์ที่จะต้องจัดหาแหล่งที่มาไม่ได้ทำงาน

ฉันกำลังกำหนดเชลล์สคริปต์ซึ่งผู้ใช้ควรsourceจะดำเนินการมากกว่า

มีวิธีธรรมดาหรือชาญฉลาดในการบอกกล่าวผู้ใช้ว่าเป็นเช่นนี้ผ่านทางนามสกุลไฟล์หรือไม่?

มีรหัสเชลล์ที่ฉันสามารถเขียนในไฟล์ของตัวเองซึ่งจะทำให้มันสะท้อนข้อความและออกจากถ้ามันถูกดำเนินการแทนแหล่งที่มาเพื่อให้ฉันสามารถช่วยให้ผู้ใช้หลีกเลี่ยงข้อผิดพลาดที่เห็นได้ชัดนี้?

สมมติว่าคุณใช้ bash อยู่ให้วางโค้ดต่อไปนี้ไว้ใกล้กับจุดเริ่มต้นของสคริปต์ที่คุณต้องการให้ซอร์ส แต่ไม่ได้ถูกเรียกใช้:

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

ภายใต้ bash ${BASH_SOURCE[0]}จะมีชื่อของไฟล์ปัจจุบันที่เชลล์อ่านอยู่ไม่ว่าจะมีแหล่งที่มาหรือดำเนินการอยู่

ในทางตรงกันข้าม$0ชื่อของไฟล์ปัจจุบันที่ถูกเรียกใช้งาน

-efทดสอบว่าไฟล์ทั้งสองนี้เป็นไฟล์เดียวกันหรือไม่ หากเป็นเช่นนั้นเราจะเตือนผู้ใช้และออก

ทั้ง-efมิได้BASH_SOURCEมี POSIX ในขณะที่-efรองรับโดย ksh, yash, zsh และ Dash BASH_SOURCEต้องใช้ bash ในzshแต่จะถูกแทนที่ด้วย${BASH_SOURCE[0]}${(%):-%N}

ไฟล์ที่ไม่สามารถเรียกใช้งานได้สามารถหาแหล่งที่มาได้ แต่ไม่สามารถดำเนินการได้ดังนั้นในฐานะบรรทัดแรกของการป้องกัน

แก้ไข: เคล็ดลับที่ฉันเพิ่งพบ: ทำให้ shebang เป็นไฟล์ปฏิบัติการที่ไม่ใช่ตัวแปลเชลล์/bin/falseทำให้สคริปต์ส่งคืนข้อผิดพลาด (rc! = 0)

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

มีหลายวิธีที่แนะนำในโพสต์สแต็คโอเวอร์โฟลว์ซึ่งฉันชอบฟังก์ชั่นที่แนะนำโดยWirawan Purwantoและmr.spuraticที่สุด:

วิธีที่แข็งแกร่งที่สุดตามที่ Wirawan Purwanto แนะนำไว้คือการตรวจสอบ FUNCNAME[1] ภายในฟังก์ชั่น :

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

แล้ว:

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

นี่คือเทียบเท่ากับการตรวจสอบการส่งออกของcallerค่า mainและsourceแยกความแตกต่างบริบทของผู้โทร การใช้ FUNCNAME[]ช่วยให้คุณบันทึกและแยกวิเคราะห์callerเอาต์พุต คุณจำเป็นต้องรู้หรือคำนวณความลึกของการโทรเพื่อให้ถูกต้อง กรณีเช่นสคริปต์ที่มีที่มาจากภายในฟังก์ชั่นหรือสคริปต์อื่นจะทำให้อาร์เรย์ (สแต็ค) จะลึก ( FUNCNAMEเป็นตัวแปรอาเรย์ bash พิเศษควรมีดัชนีต่อเนื่องที่สอดคล้องกับ call stack ตราบใดที่ไม่เคยมีunset)

ดังนั้นคุณสามารถเพิ่มไปยังจุดเริ่มต้นของสคริปต์:

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

สมมติว่ามันไร้ประโยชน์แทนที่จะเป็นอันตรายในการเรียกใช้สคริปต์คุณสามารถเพิ่ม

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

ถึงจุดสิ้นสุดของสคริปต์ returnด้านนอกของฟังก์ชั่นมีรหัสออกที่ไม่เป็นศูนย์เว้นแต่ไฟล์จะถูกแหล่งที่มา

เมื่อคุณแหล่งเชลล์สคริปต์บรรทัดshebangจะถูกละเว้น ด้วยการใส่ Shebang ที่ไม่ถูกต้องคุณสามารถแจ้งเตือนผู้ใช้ว่าสคริปต์ทำงานผิดพลาด:

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

ข้อความแสดงข้อผิดพลาดจะเป็นดังนี้:

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

ชื่ออาร์กิวเมนต์ (ตามอำเภอใจ) ให้คำใบ้ไว้แล้ว แต่ข้อความแสดงข้อผิดพลาดยังไม่ชัดเจน 100% เราสามารถแก้ไขได้ด้วยสคริปต์อรรถประโยชน์source-this-scriptที่วางไว้ในที่ของคุณPATH:

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

ตอนนี้ข้อความแสดงข้อผิดพลาดจะเป็นดังนี้:

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

เปรียบเทียบกับแนวทางอื่น ๆ

เมื่อเทียบกับคำตอบอื่น ๆ วิธีการนี้ต้องการการเปลี่ยนแปลงเพียงเล็กน้อยกับแต่ละสคริปต์ (และการมีบรรทัด shebang ช่วยด้วยการตรวจจับชนิดไฟล์ในเครื่องมือแก้ไขและระบุภาษาสคริปต์เชลล์ดังนั้นจึงมีประโยชน์มาก) ข้อเสียคือข้อความแสดงข้อผิดพลาดค่อนข้างชัดเจนหรือการเพิ่ม (ครั้งเดียว) ของเชลล์สคริปต์อื่น

มันไม่ได้ป้องกันการร้องขออย่างชัดเจนผ่านทางbash path/to/script.sh(ขอบคุณ @muru!)