check_variant.sh 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  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 used when no variant is set.
  9. # variantinstalldefault is offered and saved on new installs, when it differs from the first.
  10. fn_variant_list() {
  11. variants=()
  12. variantnames=()
  13. variantinstalldefault=""
  14. if [ "${shortname}" == "mc" ]; then
  15. variants=("vanilla" "fabric" "paper" "purpur" "folia" "leaf")
  16. variantnames=("Vanilla" "Fabric" "PaperMC" "Purpur" "Folia" "Leaf")
  17. elif [ "${shortname}" == "mohaa" ]; then
  18. variants=("alliedassault-reborn" "alliedassault-vanilla" "alliedassault-openmohaa" "spearhead-vanilla" "spearhead-openmohaa" "breakthrough-openmohaa")
  19. variantnames=("Allied Assault (Reborn)" "Allied Assault (Vanilla)" "Allied Assault (OpenMoHAA)" "Spearhead (Vanilla)" "Spearhead (OpenMoHAA)" "Breakthrough (OpenMoHAA)")
  20. variantinstalldefault="alliedassault-openmohaa"
  21. fi
  22. }
  23. # Settings that change with the variant.
  24. fn_variant_settings() {
  25. if [ "${shortname}" == "mc" ]; then
  26. if [ "${variant}" == "vanilla" ]; then
  27. variantexecutable="./minecraft_server.jar"
  28. elif [ "${variant}" == "fabric" ]; then
  29. variantexecutable="./fabric-server-launch.jar"
  30. elif [ "${variant}" == "paper" ]; then
  31. variantexecutable="./paper.jar"
  32. elif [ "${variant}" == "purpur" ]; then
  33. variantexecutable="./purpur.jar"
  34. elif [ "${variant}" == "folia" ]; then
  35. variantexecutable="./folia.jar"
  36. elif [ "${variant}" == "leaf" ]; then
  37. variantexecutable="./leaf.jar"
  38. fi
  39. elif [ "${shortname}" == "mohaa" ]; then
  40. if [ "${variant}" == "alliedassault-reborn" ]; then
  41. variantexecutable="./mohaa_lnxded"
  42. elif [ "${variant}" == "alliedassault-vanilla" ]; then
  43. variantexecutable="./mohaa_lnxded"
  44. variantexecutabledir="${serverfiles}/vanilla"
  45. variantbasepath="${serverfiles}/vanilla"
  46. elif [ "${variant}" == "spearhead-vanilla" ]; then
  47. variantexecutable="./spearhead_lnxded"
  48. elif [[ "${variant}" == *-openmohaa ]]; then
  49. variantexecutable="./omohaaded"
  50. variantexecutabledir="${serverfiles}/openmohaa"
  51. if [ "${variant}" == "alliedassault-openmohaa" ]; then
  52. variantstartparameters="+set com_target_game 0"
  53. elif [ "${variant}" == "spearhead-openmohaa" ]; then
  54. variantstartparameters="+set com_target_game 1"
  55. elif [ "${variant}" == "breakthrough-openmohaa" ]; then
  56. variantstartparameters="+set com_target_game 2"
  57. fi
  58. fi
  59. fi
  60. if [ "${variant}" != "${variants[0]}" ] && [ -n "${variantexecutable}" ]; then
  61. executable="${variantexecutable}"
  62. fi
  63. if [ -n "${variantexecutabledir}" ]; then
  64. executabledir="${variantexecutabledir}"
  65. fi
  66. }
  67. # Installs files a variant needs that an existing install does not have.
  68. fn_variant_files() {
  69. if [ "${shortname}" == "mohaa" ] && [ -d "${serverfiles}/main" ]; then
  70. if [[ "${variant}" == *-openmohaa ]] && [ ! -f "${serverfiles}/openmohaa/omohaaded" ]; then
  71. install_openmohaa.sh
  72. elif [ "${variant}" == "alliedassault-vanilla" ] && { [ ! -f "${serverfiles}/vanilla/mohaa_lnxded" ] || [ ! -L "${serverfiles}/vanilla/main" ]; }; then
  73. fn_print_dots "Setting up ${variantname}"
  74. if mkdir -p "${serverfiles}/vanilla" && cp -f "${serverfiles}/dedicated_server_binaries_anticrash/mohaa/linux/mohaa_lnxded" "${serverfiles}/vanilla/mohaa_lnxded" && cp -f "${serverfiles}/fgamededmohaa.so" "${serverfiles}/vanilla/fgameded.so" && ln -sfn ../main "${serverfiles}/vanilla/main"; then
  75. chmod +x "${serverfiles}/vanilla/mohaa_lnxded"
  76. fn_print_ok_nl "Setting up ${variantname}"
  77. fn_script_log_pass "Setting up ${variantname}"
  78. else
  79. fn_print_fail_nl "Setting up ${variantname}"
  80. fn_script_log_fail "Setting up ${variantname}"
  81. core_exit.sh
  82. fi
  83. fi
  84. fi
  85. }
  86. # Checks whether any config file sets the variant.
  87. fn_variant_configured() {
  88. local checkcfg
  89. for checkcfg in "${configdirserver}/secrets-${selfname}.cfg" "${configdirserver}/${selfname}.cfg" "${configdirserver}/secrets-common.cfg" "${configdirserver}/common.cfg"; do
  90. if [ -f "${checkcfg}" ] && grep -qE "^[[:blank:]]*variant=" "${checkcfg}"; then
  91. return 0
  92. fi
  93. done
  94. return 1
  95. }
  96. # The config setting that --version changes.
  97. fn_variant_versionvar() {
  98. versionvar=""
  99. if [ "${shortname}" == "mc" ] || [ "${shortname}" == "pmc" ]; then
  100. versionvar="mcversion"
  101. fi
  102. }
  103. # Writes a setting to the config that already sets it, otherwise to common.cfg.
  104. fn_variant_set_config() {
  105. local key="${1}"
  106. local value="${2}"
  107. local cfgfile=""
  108. local checkcfg
  109. for checkcfg in "${configdirserver}/secrets-${selfname}.cfg" "${configdirserver}/${selfname}.cfg" "${configdirserver}/secrets-common.cfg"; do
  110. if [ -f "${checkcfg}" ] && grep -qE "^[[:blank:]]*${key}=" "${checkcfg}"; then
  111. cfgfile="${checkcfg}"
  112. break
  113. fi
  114. done
  115. if [ -z "${cfgfile}" ]; then
  116. cfgfile="${configdirserver}/common.cfg"
  117. fi
  118. if grep -qE "^[[:blank:]]*${key}=" "${cfgfile}"; then
  119. sed -i -E "s|^[[:blank:]]*${key}=.*|${key}=\"${value}\"|" "${cfgfile}"
  120. else
  121. if [ -s "${cfgfile}" ] && [ -n "$(tail -c 1 "${cfgfile}")" ]; then
  122. echo "" >> "${cfgfile}"
  123. fi
  124. echo "${key}=\"${value}\"" >> "${cfgfile}"
  125. fi
  126. printf -v "${key}" '%s' "${value}"
  127. fn_print_ok_nl "Setting ${key} to ${value} in ${cfgfile##*/}"
  128. fn_script_log_pass "Setting ${key} to ${value} in ${cfgfile}"
  129. }
  130. fn_variant_parse_args() {
  131. local argcommands=(i install ai auto-install u update fu force-update)
  132. local argcommand
  133. local acceptargs=0
  134. local index
  135. local arg
  136. for argcommand in "${argcommands[@]}"; do
  137. if [ "${getopt}" == "${argcommand}" ]; then
  138. acceptargs=1
  139. fi
  140. done
  141. if [ "${acceptargs}" != "1" ]; then
  142. return
  143. fi
  144. # Scripts installed before options were supported do not pass them on.
  145. if ! declare -p lgsmargs > /dev/null 2>&1; then
  146. if [[ "${userinput2}" == --* ]]; then
  147. fn_print_fail_nl "Options need a newer ${selfname} script: run ./${selfname} update-lgsm first"
  148. fn_script_log_fail "Options need a newer ${selfname} script"
  149. core_exit.sh
  150. fi
  151. return
  152. fi
  153. for ((index = 1; index < ${#lgsmargs[@]}; index++)); do
  154. arg="${lgsmargs[index]}"
  155. if [[ "${arg}" == --variant=* ]]; then
  156. argvariant="${arg#*=}"
  157. elif [ "${arg}" == "--variant" ]; then
  158. ((index++))
  159. argvariant="${lgsmargs[index]}"
  160. elif [[ "${arg}" == --version=* ]]; then
  161. argversion="${arg#*=}"
  162. elif [ "${arg}" == "--version" ]; then
  163. ((index++))
  164. argversion="${lgsmargs[index]}"
  165. else
  166. fn_print_fail_nl "Unknown option: ${arg}"
  167. fn_script_log_fail "Unknown option: ${arg}"
  168. core_exit.sh
  169. fi
  170. done
  171. }
  172. fn_variant_prompt() {
  173. local answer
  174. local defaultanswer=1
  175. local variantindex
  176. if [ "${getopt}" != "i" ] && [ "${getopt}" != "install" ]; then
  177. return
  178. fi
  179. if [ "${#variants[@]}" -lt 2 ] || [ -n "${argvariant+x}" ] || fn_variant_configured; then
  180. return
  181. fi
  182. for variantindex in "${!variants[@]}"; do
  183. if [ "${variants[variantindex]}" == "${variantinstalldefault}" ]; then
  184. defaultanswer="$((variantindex + 1))"
  185. fi
  186. done
  187. echo -e ""
  188. echo -e "${bold}${lightyellow}Select ${gamename} Server Variant${default}"
  189. fn_messages_separator
  190. for variantindex in "${!variants[@]}"; do
  191. if [ "$((variantindex + 1))" -eq "${defaultanswer}" ]; then
  192. echo -e "$((variantindex + 1))) ${variantnames[variantindex]} (default)"
  193. else
  194. echo -e "$((variantindex + 1))) ${variantnames[variantindex]}"
  195. fi
  196. done
  197. while true; do
  198. answer=""
  199. if ! read -e -p "Variant [${defaultanswer}]: " -r answer && [ -z "${answer}" ]; then
  200. echo -e ""
  201. fi
  202. answer="${answer:-${defaultanswer}}"
  203. if [[ "${answer}" =~ ^[0-9]+$ ]] && [ "${answer}" -ge 1 ] && [ "${answer}" -le "${#variants[@]}" ]; then
  204. argvariant="${variants[answer - 1]}"
  205. break
  206. elif [[ " ${variants[*]} " == *" ${answer} "* ]]; then
  207. argvariant="${answer}"
  208. break
  209. fi
  210. fn_print_warning_nl "Enter a number from 1 to ${#variants[@]}"
  211. done
  212. fn_variant_versionvar
  213. if [ -n "${versionvar}" ] && [ -z "${argversion+x}" ]; then
  214. while true; do
  215. answer=""
  216. if ! read -e -p "Version [${!versionvar:-latest}]: " -r answer && [ -z "${answer}" ]; then
  217. echo -e ""
  218. fi
  219. if [ -z "${answer}" ]; then
  220. break
  221. elif [[ "${answer}" =~ ^[A-Za-z0-9._+-]+$ ]]; then
  222. argversion="${answer}"
  223. break
  224. fi
  225. fn_print_warning_nl "Invalid version: ${answer}"
  226. done
  227. fi
  228. }
  229. fn_variant_apply_args() {
  230. if [ "${getopt}" == "ai" ] || [ "${getopt}" == "auto-install" ]; then
  231. if [ -n "${variantinstalldefault}" ] && [ -z "${argvariant+x}" ] && ! fn_variant_configured; then
  232. argvariant="${variantinstalldefault}"
  233. fi
  234. fi
  235. if [ -n "${argvariant+x}" ]; then
  236. if [ "${#variants[@]}" -eq 0 ]; then
  237. fn_print_fail_nl "${gamename} has no variants"
  238. fn_script_log_fail "${gamename} has no variants"
  239. core_exit.sh
  240. fi
  241. if [[ " ${variants[*]} " != *" ${argvariant} "* ]]; then
  242. fn_print_fail_nl "Unknown variant: ${argvariant}. Available variants: ${variants[*]}"
  243. fn_script_log_fail "Unknown variant: ${argvariant}"
  244. core_exit.sh
  245. fi
  246. fn_variant_set_config "variant" "${argvariant}"
  247. fi
  248. if [ -n "${argversion+x}" ]; then
  249. fn_variant_versionvar
  250. if [ -z "${versionvar}" ]; then
  251. fn_print_fail_nl "${gamename} does not support --version"
  252. fn_script_log_fail "${gamename} does not support --version"
  253. core_exit.sh
  254. fi
  255. if [[ ! "${argversion}" =~ ^[A-Za-z0-9._+-]+$ ]]; then
  256. fn_print_fail_nl "Invalid version: ${argversion}"
  257. fn_script_log_fail "Invalid version: ${argversion}"
  258. core_exit.sh
  259. fi
  260. fn_variant_set_config "${versionvar}" "${argversion}"
  261. fi
  262. }
  263. # Records the variant now installed in serverfiles.
  264. fn_variant_record() {
  265. if [ -n "${variant}" ] && [ -d "${serverfiles}" ]; then
  266. echo "${variant}" > "${serverfiles}/variant.txt"
  267. installedvariant="${variant}"
  268. fi
  269. }
  270. # Warns about data that does not carry across a variant change.
  271. fn_variant_change_warning() {
  272. if [ "${shortname}" == "mc" ]; then
  273. if [[ "${installedvariant}" =~ ^(paper|purpur|folia|leaf)$ ]] && [[ "${variant}" =~ ^(vanilla|fabric)$ ]]; then
  274. fn_print_warning_nl "${installedvariantname} keeps the Nether and End in world_nether and world_the_end. ${variantname} does not load them from there."
  275. fn_script_log_warn "${installedvariantname} keeps the Nether and End in world_nether and world_the_end. ${variantname} does not load them from there."
  276. fi
  277. if [ "${installedvariant}" == "fabric" ] || [ "${variant}" == "fabric" ]; then
  278. fn_print_warning_nl "Mods and plugins are not shared between ${installedvariantname} and ${variantname}."
  279. fn_script_log_warn "Mods and plugins are not shared between ${installedvariantname} and ${variantname}."
  280. fi
  281. if [ "${variant}" == "folia" ]; then
  282. fn_print_warning_nl "Folia only loads plugins that declare Folia support."
  283. fn_script_log_warn "Folia only loads plugins that declare Folia support."
  284. fi
  285. fi
  286. fn_print_info_nl "Take a backup before changing variant: ./${selfname} backup"
  287. }
  288. fn_variant_list
  289. fn_variant_parse_args
  290. fn_variant_prompt
  291. fn_variant_apply_args
  292. if [ "${#variants[@]}" -gt 0 ]; then
  293. if [ -z "${variant}" ]; then
  294. variant="${variants[0]}"
  295. fi
  296. variantname=""
  297. installedvariant="$(head -n 1 "${serverfiles}/variant.txt" 2> /dev/null)"
  298. installedvariant="${installedvariant:-${variants[0]}}"
  299. for variantindex in "${!variants[@]}"; do
  300. if [ "${variants[variantindex]}" == "${variant}" ]; then
  301. variantname="${variantnames[variantindex]}"
  302. fi
  303. if [ "${variants[variantindex]}" == "${installedvariant}" ]; then
  304. installedvariantname="${variantnames[variantindex]}"
  305. fi
  306. done
  307. if [ -z "${variantname}" ]; then
  308. fn_print_fail_nl "Unknown variant: ${variant}. Available variants: ${variants[*]}"
  309. fn_script_log_fail "Unknown variant: ${variant}"
  310. core_exit.sh
  311. fi
  312. fn_variant_settings
  313. fn_variant_files
  314. else
  315. unset variant
  316. fi