check_variant.sh 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  1. #!/bin/bash
  2. # LinuxGSM check_variant.sh module
  3. # Author: Daniel Gibbs
  4. # Contributors: https://linuxgsm.com/contrib
  5. # Website: https://linuxgsm.com
  6. # Description: Handles server variants and the --variant and --version options.
  7. moduleselfname="$(basename "$(readlink -f "${BASH_SOURCE[0]}")")"
  8. # Variants available for this game server. The first is the default.
  9. fn_variant_list() {
  10. variants=()
  11. variantnames=()
  12. if [ "${shortname}" == "mc" ]; then
  13. variants=("vanilla" "fabric" "paper" "purpur" "folia" "leaf")
  14. variantnames=("Vanilla" "Fabric" "PaperMC" "Purpur" "Folia" "Leaf")
  15. fi
  16. }
  17. # Settings that change with the variant.
  18. fn_variant_settings() {
  19. if [ "${shortname}" == "mc" ]; then
  20. if [ "${variant}" == "vanilla" ]; then
  21. variantexecutable="./minecraft_server.jar"
  22. elif [ "${variant}" == "fabric" ]; then
  23. variantexecutable="./fabric-server-launch.jar"
  24. elif [ "${variant}" == "paper" ]; then
  25. variantexecutable="./paper.jar"
  26. elif [ "${variant}" == "purpur" ]; then
  27. variantexecutable="./purpur.jar"
  28. elif [ "${variant}" == "folia" ]; then
  29. variantexecutable="./folia.jar"
  30. elif [ "${variant}" == "leaf" ]; then
  31. variantexecutable="./leaf.jar"
  32. fi
  33. fi
  34. if [ "${variant}" != "${variants[0]}" ] && [ -n "${variantexecutable}" ]; then
  35. executable="${variantexecutable}"
  36. fi
  37. }
  38. # The config setting that --version changes.
  39. fn_variant_versionvar() {
  40. versionvar=""
  41. if [ "${shortname}" == "mc" ] || [ "${shortname}" == "pmc" ]; then
  42. versionvar="mcversion"
  43. fi
  44. }
  45. # Writes a setting to the config that already sets it, otherwise to common.cfg.
  46. fn_variant_set_config() {
  47. local key="${1}"
  48. local value="${2}"
  49. local cfgfile=""
  50. local checkcfg
  51. for checkcfg in "${configdirserver}/secrets-${selfname}.cfg" "${configdirserver}/${selfname}.cfg" "${configdirserver}/secrets-common.cfg"; do
  52. if [ -f "${checkcfg}" ] && grep -qE "^[[:blank:]]*${key}=" "${checkcfg}"; then
  53. cfgfile="${checkcfg}"
  54. break
  55. fi
  56. done
  57. if [ -z "${cfgfile}" ]; then
  58. cfgfile="${configdirserver}/common.cfg"
  59. fi
  60. if grep -qE "^[[:blank:]]*${key}=" "${cfgfile}"; then
  61. sed -i -E "s|^[[:blank:]]*${key}=.*|${key}=\"${value}\"|" "${cfgfile}"
  62. else
  63. if [ -s "${cfgfile}" ] && [ -n "$(tail -c 1 "${cfgfile}")" ]; then
  64. echo "" >> "${cfgfile}"
  65. fi
  66. echo "${key}=\"${value}\"" >> "${cfgfile}"
  67. fi
  68. printf -v "${key}" '%s' "${value}"
  69. fn_print_ok_nl "Setting ${key} to ${value} in ${cfgfile##*/}"
  70. fn_script_log_pass "Setting ${key} to ${value} in ${cfgfile}"
  71. }
  72. fn_variant_parse_args() {
  73. local argcommands=(i install ai auto-install u update fu force-update)
  74. local argcommand
  75. local acceptargs=0
  76. local index
  77. local arg
  78. for argcommand in "${argcommands[@]}"; do
  79. if [ "${getopt}" == "${argcommand}" ]; then
  80. acceptargs=1
  81. fi
  82. done
  83. if [ "${acceptargs}" != "1" ]; then
  84. return
  85. fi
  86. # Scripts installed before options were supported do not pass them on.
  87. if ! declare -p lgsmargs > /dev/null 2>&1; then
  88. if [[ "${userinput2}" == --* ]]; then
  89. fn_print_fail_nl "Options need a newer ${selfname} script: run ./${selfname} update-lgsm first"
  90. fn_script_log_fail "Options need a newer ${selfname} script"
  91. core_exit.sh
  92. fi
  93. return
  94. fi
  95. for ((index = 1; index < ${#lgsmargs[@]}; index++)); do
  96. arg="${lgsmargs[index]}"
  97. if [[ "${arg}" == --variant=* ]]; then
  98. argvariant="${arg#*=}"
  99. elif [ "${arg}" == "--variant" ]; then
  100. ((index++))
  101. argvariant="${lgsmargs[index]}"
  102. elif [[ "${arg}" == --version=* ]]; then
  103. argversion="${arg#*=}"
  104. elif [ "${arg}" == "--version" ]; then
  105. ((index++))
  106. argversion="${lgsmargs[index]}"
  107. else
  108. fn_print_fail_nl "Unknown option: ${arg}"
  109. fn_script_log_fail "Unknown option: ${arg}"
  110. core_exit.sh
  111. fi
  112. done
  113. }
  114. fn_variant_prompt() {
  115. local answer
  116. local checkcfg
  117. local variantindex
  118. if [ "${getopt}" != "i" ] && [ "${getopt}" != "install" ]; then
  119. return
  120. fi
  121. if [ "${#variants[@]}" -lt 2 ] || [ -n "${argvariant+x}" ]; then
  122. return
  123. fi
  124. for checkcfg in "${configdirserver}/secrets-${selfname}.cfg" "${configdirserver}/${selfname}.cfg" "${configdirserver}/secrets-common.cfg" "${configdirserver}/common.cfg"; do
  125. if [ -f "${checkcfg}" ] && grep -qE "^[[:blank:]]*variant=" "${checkcfg}"; then
  126. return
  127. fi
  128. done
  129. echo -e ""
  130. echo -e "${bold}${lightyellow}Select ${gamename} Server Variant${default}"
  131. fn_messages_separator
  132. for variantindex in "${!variants[@]}"; do
  133. if [ "${variantindex}" -eq 0 ]; then
  134. echo -e "$((variantindex + 1))) ${variantnames[variantindex]} (default)"
  135. else
  136. echo -e "$((variantindex + 1))) ${variantnames[variantindex]}"
  137. fi
  138. done
  139. while true; do
  140. answer=""
  141. if ! read -e -p "Variant [1]: " -r answer && [ -z "${answer}" ]; then
  142. echo -e ""
  143. fi
  144. answer="${answer:-1}"
  145. if [[ "${answer}" =~ ^[0-9]+$ ]] && [ "${answer}" -ge 1 ] && [ "${answer}" -le "${#variants[@]}" ]; then
  146. argvariant="${variants[answer - 1]}"
  147. break
  148. elif [[ " ${variants[*]} " == *" ${answer} "* ]]; then
  149. argvariant="${answer}"
  150. break
  151. fi
  152. fn_print_warning_nl "Enter a number from 1 to ${#variants[@]}"
  153. done
  154. fn_variant_versionvar
  155. if [ -n "${versionvar}" ] && [ -z "${argversion+x}" ]; then
  156. while true; do
  157. answer=""
  158. if ! read -e -p "Version [${!versionvar:-latest}]: " -r answer && [ -z "${answer}" ]; then
  159. echo -e ""
  160. fi
  161. if [ -z "${answer}" ]; then
  162. break
  163. elif [[ "${answer}" =~ ^[A-Za-z0-9._+-]+$ ]]; then
  164. argversion="${answer}"
  165. break
  166. fi
  167. fn_print_warning_nl "Invalid version: ${answer}"
  168. done
  169. fi
  170. }
  171. fn_variant_apply_args() {
  172. if [ -n "${argvariant+x}" ]; then
  173. if [ "${#variants[@]}" -eq 0 ]; then
  174. fn_print_fail_nl "${gamename} has no variants"
  175. fn_script_log_fail "${gamename} has no variants"
  176. core_exit.sh
  177. fi
  178. if [[ " ${variants[*]} " != *" ${argvariant} "* ]]; then
  179. fn_print_fail_nl "Unknown variant: ${argvariant}. Available variants: ${variants[*]}"
  180. fn_script_log_fail "Unknown variant: ${argvariant}"
  181. core_exit.sh
  182. fi
  183. fn_variant_set_config "variant" "${argvariant}"
  184. fi
  185. if [ -n "${argversion+x}" ]; then
  186. fn_variant_versionvar
  187. if [ -z "${versionvar}" ]; then
  188. fn_print_fail_nl "${gamename} does not support --version"
  189. fn_script_log_fail "${gamename} does not support --version"
  190. core_exit.sh
  191. fi
  192. if [[ ! "${argversion}" =~ ^[A-Za-z0-9._+-]+$ ]]; then
  193. fn_print_fail_nl "Invalid version: ${argversion}"
  194. fn_script_log_fail "Invalid version: ${argversion}"
  195. core_exit.sh
  196. fi
  197. fn_variant_set_config "${versionvar}" "${argversion}"
  198. fi
  199. }
  200. # Records the variant now installed in serverfiles.
  201. fn_variant_record() {
  202. if [ -n "${variant}" ] && [ -d "${serverfiles}" ]; then
  203. echo "${variant}" > "${serverfiles}/variant.txt"
  204. installedvariant="${variant}"
  205. fi
  206. }
  207. # Warns about data that does not carry across a variant change.
  208. fn_variant_change_warning() {
  209. if [ "${shortname}" == "mc" ]; then
  210. if [[ "${installedvariant}" =~ ^(paper|purpur|folia|leaf)$ ]] && [[ "${variant}" =~ ^(vanilla|fabric)$ ]]; then
  211. fn_print_warning_nl "${installedvariantname} keeps the Nether and End in world_nether and world_the_end. ${variantname} does not load them from there."
  212. fn_script_log_warn "${installedvariantname} keeps the Nether and End in world_nether and world_the_end. ${variantname} does not load them from there."
  213. fi
  214. if [ "${installedvariant}" == "fabric" ] || [ "${variant}" == "fabric" ]; then
  215. fn_print_warning_nl "Mods and plugins are not shared between ${installedvariantname} and ${variantname}."
  216. fn_script_log_warn "Mods and plugins are not shared between ${installedvariantname} and ${variantname}."
  217. fi
  218. if [ "${variant}" == "folia" ]; then
  219. fn_print_warning_nl "Folia only loads plugins that declare Folia support."
  220. fn_script_log_warn "Folia only loads plugins that declare Folia support."
  221. fi
  222. fi
  223. fn_print_info_nl "Take a backup before changing variant: ./${selfname} backup"
  224. }
  225. fn_variant_list
  226. fn_variant_parse_args
  227. fn_variant_prompt
  228. fn_variant_apply_args
  229. if [ "${#variants[@]}" -gt 0 ]; then
  230. if [ -z "${variant}" ]; then
  231. variant="${variants[0]}"
  232. fi
  233. variantname=""
  234. installedvariant="$(head -n 1 "${serverfiles}/variant.txt" 2> /dev/null)"
  235. installedvariant="${installedvariant:-${variants[0]}}"
  236. for variantindex in "${!variants[@]}"; do
  237. if [ "${variants[variantindex]}" == "${variant}" ]; then
  238. variantname="${variantnames[variantindex]}"
  239. fi
  240. if [ "${variants[variantindex]}" == "${installedvariant}" ]; then
  241. installedvariantname="${variantnames[variantindex]}"
  242. fi
  243. done
  244. if [ -z "${variantname}" ]; then
  245. fn_print_fail_nl "Unknown variant: ${variant}. Available variants: ${variants[*]}"
  246. fn_script_log_fail "Unknown variant: ${variant}"
  247. core_exit.sh
  248. fi
  249. fn_variant_settings
  250. else
  251. unset variant
  252. fi