1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
|
#!/bin/bash
#SPDX-License-Identifier: Apache-2.0
#Copyright 2018-2025 Gliim LLC.
#Licensed under Apache License v2. See LICENSE file.
#On the web http://golf-lang.com/ - this file is part of Golf framework.
#variable names for Golf start with GG_ (GG_C_ being compiling-related) and _ (internal)
#
#
#make script for Golf application
#
#
#
#Set one or the other
#
#_BETA=""
export GG_USER=$(whoami)
#make sure HOME is available, some apps wipe it out like apache setenv
if [ "$HOME" == "" ]; then
HOME=$(eval echo ~$GG_USER)
fi
#enable "extended globs" (such as "parameter expansion" or ${!X}
shopt -s extglob
#display error context if golf has a shell error, source file bash only
set -eE -o functrace
trap 'echo "Error: status $?, $(caller), line ${BASH_SOURCE[0]}/${LINENO}"' ERR
#cannot run as run as it might mess up permissions.
if [[ $EUID -eq 0 ]]; then echo "You cannot run golf as root or sudo"; exit -1; fi
#
#
#DO NOT change these values, they are changed here by Makefile per platform when make install is done
#They will have $GG_ROOT in them
export GG_LIBRARY_PATH="/usr/lib/golf"
. "$GG_LIBRARY_PATH"/sys
#find out where this script runs from (i.e. where 'gg' actually is, minus /usr/bin)
export GG_ROOT=""
#end of DO-NOT-change
#
#
#by default, make is silent (except for messages we emit). For debugging, use -e to see everything that's going on (this shows golf execution too!)
GG_SHOW_MAKE="-s"
#location of Golf data
export GG_DATA="$GG_ROOT/var/lib/gg"
export GG_C_RESTPATH=""
export GG_C_MAXUPLOAD="25000000"
export GG_C_CPUS=$(nproc)
if (( GG_C_CPUS < 1 )); then
export GG_C_CPUS="1"
fi
export GG_C_MAXERRORS="5"
#plain diagnostics must have value, as it's passed in a script (vdiag) in vmakefile
export GG_C_PLAINDIAG="0"
FCGI_INC0="/usr/include/fastcgi"
#defaults for quick install
_PROXYPORT="80"
#display Golf usage
#
#Internal options that may go away:
#--asan build with ASAN
#--asan-opt print out ASAN option to prefix the execution with, also works with prefix mgrg for better coverage of SERVICE program
#
function use_message() {
echo "Usage: $0 OPTIONS
OPTIONS:
-k <app> create application <app> with default settings
-c clean make artifacts for a rebuild
-v show version
-s show detailed execution (script tracing)
-e N show last N program errors
-t N show trace files for N most recent processes
-o show documentation directory
-l show library directory
-m setup syntax highlighting for Vim
-u substitute environment variables in stdin
-r display shell commands to run a program
--req=\"/<request name><url payload>\"
--method=\"<request method>\"
--content=\"<file name>\"
--content-type=\"<content type>\"
--exec
--app=\"application path\"
--service
--remote=\"server IP:port\"
--socket=\"socket path\"
--arg=\"arguments\"
-q build application
--db=\"mariadb:<db name>|postgres:<db name> ...\"
--lflag=<linker flags>
--cflag=<c flags>
--trace
--c-lines
--posix-regex
--debug
--maxupload=<max upload size>
--path=\"/some/path\"
--max-errors=<max errors>
--plain-diag
--optimize-memory
--parallel=<compiling threads>
--public
--single-file
--exclude-dir=<dir list>
--ignore-warn
-i display build flags for FastCGI client
--include
displays C compile flags
--link
displays C linking flags
--man display all Golf man pages available
-h this help
Type 'man gg' for more information.
"
}
#process all command-line options
function main() {
#list of Golf options for getop
_OPT_STATUS="0"
#do NOT use optional :: args - they must always be used as -e3 for example - there can be no space. This is awkward and unwieldy.
_opts=$(getopt -a -n $0 -o k:e:t:,q,g,o,l,m,i,h,c,v,s,u,r --long ignore-warn,exclude-dir:,man,single-file,public,parallel:,db:,lflag:,cflag:,trace,arg:,plain-diag,optimize-memory,posix-regex,asan,asan-opt,content:,content-type:,silent-header,service,remote:,socket:,app:,path:,c-lines,debug,req:,exec,method:,maxupload:,max-errors:,include,link,safe -- "$@") || _OPT_STATUS=$?
if [ $_OPT_STATUS -ne 0 ]; then
use_message 1>&2
exit -1
fi
#init flags used to emit helpful messages
_DEVOPT=0
_DO_QUICK=0
#if nothing at all passed that is valid: make golf application - that is just 'golf'
eval set -- "$_opts"
while true; do
case "$1" in
--trace )
export GG_C_TRACE="1"
_DEVOPT=1
shift
;;
--c-lines )
export GG_C_SKIPLINES="1"
_DEVOPT=1
shift
;;
--plain-diag )
export GG_C_PLAINDIAG="1"
_DEVOPT=1
shift
;;
--public )
export GG_C_PUBLIC="1"
_DEVOPT=1
shift
;;
--single-file )
export GG_C_SINGLE_FILE="1"
_DEVOPT=1
shift
;;
--man )
apropos -s 2gg '.*' | sed 's/(2gg)//g'
shift
exit 0
;;
--ignore-warn )
export GG_C_IGNORE_WARN="1"
_DEVOPT=1
shift
;;
--debug )
export GG_C_DEBUG="1"
_DEVOPT=1
shift
;;
--asan-opt )
echo "ASAN_OPTIONS=log_path=asan:halt_on_error=0"
exit 0
;;
--asan )
export GG_C_ASAN="1"
_DEVOPT=1
shift
;;
#gg -r to talk to service (local socket by default)
--service )
_REQ_SRV="1"
shift
;;
--path )
export GG_C_RESTPATH="$2"
_DEVOPT=1
shift 2
;;
--maxupload )
export GG_C_MAXUPLOAD="$2"
_DEVOPT=1
shift 2
;;
--max-errors )
export GG_C_MAXERRORS="$2"
_DEVOPT=1
shift 2
;;
--posix-regex )
export GG_C_POSIXREGEX="1"
_DEVOPT=1
shift
;;
--cflag )
export GG_C_CFLAGS="$2"
_DEVOPT=1
shift 2
;;
-t )
#display last N trace files (for N most recent processes)
_SHOWTRACE="$2"
shift 2
;;
-u )
#subst env vars from stdin to stdout
"$GG_LIBRARY_PATH"/v1 -envsub
exit 0
;;
-g )
#display Golf root
echo "$GG_ROOT"
shift 1
exit 0
;;
-e )
#display last N errors from backtrace
_SHOWERROR="$2"
shift 2
;;
--lflag )
export GG_C_LFLAGS="$2"
_DEVOPT=1
shift 2
;;
--content-type )
#content type
_REQ_CONTENT_TYPE="$2"
shift 2
;;
--content )
#content file (read from file)
_REQ_CONTENT="$2"
shift 2
;;
--silent-header )
#silent-header for --exec
_REQ_SILENT_HEADER=1
shift 1
;;
--arg )
#arguments for command-line execution
_REQ_ARG="$2"
shift 2
;;
--method )
#request method (GET, POST...)
_REQ_METHOD="$2"
shift 2
;;
--exec )
#request execute
_REQ_EXEC="1"
shift 1
;;
--app )
#app name (script name) for -r
_REQ_APP="$2"
shift 2
;;
--socket )
#socket for -r --exec
_REQ_SOCK="$2"
shift 2
;;
--remote )
#serverIP:port for -r --exec
_REQ_IP="$2"
shift 2
;;
--req )
#request name+payload
_REQ_URL="$2"
shift 2
;;
-k )
#create new application
_NEWAPP="1"
_NAME="$2"
shift 2
;;
-r )
#display bash to run command-line program
_COMMRUN="1"
shift
;;
-h )
#help message
use_message
shift
exit
;;
-m )
#Vim highlighting
_DO_HIGHLIGHT="1"
shift
;;
--link )
#display FastCGI link
_DO_CLIENT_LINK="1"
shift
;;
--include )
#display FastCGI include
_DO_CLIENT_INCLUDE="1"
shift
;;
-i )
#display FastCGI client flags
_DO_CLIENT="1"
shift
;;
-q )
#quick setup
_DO_QUICK="1"
shift
;;
--exclude-dir )
#exclude directories for compilation
GG_DIR_EXCLUDE="$2"
_DEVOPT=1
shift 2
;;
--parallel )
#parallel compilation override
CPUS="$2"
if (( CPUS >= 1 && CPUS < GG_C_CPUS * 3 )); then
export GG_C_CPUS=$CPUS
fi
_DEVOPT=1
shift 2
;;
--db )
#db vendor
_ALLDB="$2"
_DEVOPT=1
shift 2
;;
-c )
#clean the project's temp and object files. This is to be able to fully recompile the project afterwards.
_DO_CLEAN="1"
shift
;;
-l )
#show lib directory
echo "$GG_LIBRARY_PATH"
shift
exit
;;
-o )
#show documentation directory
docdir
shift
exit
;;
-s )
#display golf script's execution in detail
export GG_SHOW_MAKE=
set -x
#this flag is if -s applies only to -q (i.e. compilation)
# _DEVOPT=1
shift
;;
-v )
#display version of Golf
gg_version
exit
;;
-- )
shift
break
;;
* )
use_message 1>&2
exit -1
esac
done
#we always first check if application is being created, so then afterwards it can be made etc; thus we don't exit
if [ "$_NEWAPP" == "1" ]; then
if [ "$_NAME" == "" ]; then
error "You must specify application name you wish to create"
fi
check_name "$_NAME" "application name"
ECODE=0
#for local install, we can't use sudo, nor should we
if [ "$GG_ROOT" == "" ]; then
sudo mgrg -i -u $(whoami) $_NAME || ECODE=$?
else
mgrg -i -u $(whoami) $_NAME || ECODE=$?
fi
#exit immediately if not successful
if [ "$ECODE" != "0" ]; then
exit $ECODE
fi
#otherwise check if we want to do -q too
if [ "$_DO_QUICK" != "1" ]; then
exit $ECODE
fi
fi
#handle client fastcgi app building
if [[ "$_DO_QUICK" == "1" && "$_DO_CLIENT" == "1" ]]; then
error "Cannot use both -i and -q options. Use one or the other"
fi
if [ "$_DO_CLIENT" == "1" ]; then
show_client_bld
exit 0
fi
#ask --debug to be used for tracing
if [[ "$GG_C_TRACE" == "1" && "$GG_C_DEBUG" != "1" ]]; then
error "In order to use tracing, you must use --debug option"
fi
#internal: Address Sanitizer only with debug
if [[ "$GG_C_ASAN" == "1" && "$GG_C_DEBUG" != "1" ]]; then
error "In order to use ASAN, you must use --debug option"
fi
#something extra and unexpected, complain about it, probably an error
if [ "$1" != "" ]; then
error "Unknown input [$1]"
fi
#before app name checking b/c it doesn't have anything to do with it
if [ "$_DO_HIGHLIGHT" != "" ]; then
setup_highlighting
exit 0
fi
#can run this from anywhere if has --req and (--service or --app), otherwise must be in app dir
if [[ "$_COMMRUN" != "" && ("$_REQ_APP" != "" || ("$_REQ_SRV" != "" && ("$_REQ_IP" != "" || "$_REQ_SOCK" != ""))) ]]; then
_TOEXEC=".gg_reqexec"
#need || true to remove temp file
show_run_program || true
rm -f "$_TOEXEC"
exit 0
fi
#application name created with mgrg in .vappname, which must exist
if [ -f ".vappname" ]; then
#this is special $() which doesn't create subshell, but just reads contents into a variable
export GG_C_NAME=$(<.vappname)
else
error "Golf application was not created yet. Please use mgrg to create an application first"
fi
check_name "$GG_C_NAME" "application name"
export GG_BLD0=$GG_DATA/bld
export GG_BLD=$GG_BLD0/$GG_C_NAME
export GG_H="$GG_DATA/$GG_C_NAME"
export GG_A="$GG_H/app"
#THEN perform any actions
#check for source only if compiling or cleaning up
if [[ "$_DO_QUICK" == "1" || "$_DO_CLEAN" == "1" ]]; then
GLIST_C=$(ls *.golf 2>/dev/null|wc -l)
if [ "$GLIST_C" == "0" ]; then
error "No Golf source source code found."
fi
if [[ ! -d "$GG_A" || ! -d "$GG_BLD" ]]; then
error "Golf application [$GG_C_NAME] does not exist. Use 'gg -k' to create it."
fi
fi
if [[ "$_DO_QUICK" == "0" && "$_DEVOPT" == "1" ]]; then
error "Use -q if you intend to make the application."
fi
if [ "$_SHOWERROR" != "" ]; then
showerr $_SHOWERROR
exit 0
fi
if [ "$_COMMRUN" != "" ]; then
_TOEXEC="$GG_BLD/.reqexec"
#this is if running gg -r from outside source directory
if [ ! -f $GG_BLD/.blds ]; then
error "Cannot find application, use --app option."
fi
. $GG_BLD/.blds
show_run_program
exit 0
fi
if [ "$_SHOWTRACE" != "" ]; then
showtrace $_SHOWTRACE
exit 0
fi
#perform cleaning FIRST. Must
if [ "$_DO_CLEAN" == "1" ]; then
gg_clean
exit 0
fi
#perform any actions
#autoapp make app automatically. It exits at its end
if [ "$_DO_QUICK" == "1" ]; then
#build app
autoapp
fi
#these are 'in-conclusion' actions, they happen LAST
error "No action specified."
}
#
#
#Functions used in processing
#
#
#
#
#
#Get FastCGI include dir
#
#
#
function fcgi_inc() {
#OpenSUSE has FastCGI in fastcgi directory, check in general if it exists, if it does, use it
FCGI_INC=FCGI_INC0;
if [ ! -f "$FCGI_INC" ]; then FCGI_INC="" ; else FCGI_INC="-I$FCGI_INC" ; fi
}
#
#
#
#Show flags for client FastCGI app building.
#
#
#
function show_client_bld() {
#if neither --cflag nor --lflag specified, print out both
if [[ "$_DO_CLIENT_INCLUDE" != "1" && "$_DO_CLIENT_LINK" != "1" ]]; then
_DO_CLIENT_INCLUDE=1
_DO_CLIENT_LINK=1
fi
#print the flag asked for, if both, place them on the same line
if [ "$_DO_CLIENT_INCLUDE" == "1" ]; then
fcgi_inc
echo -n "-I$GG_INCLUDE_PATH $FCGI_INC "
fi
if [ "$_DO_CLIENT_LINK" == "1" ]; then
echo -n "-L$GG_LIBRARY_PATH -lgolfcli -Wl,--rpath=$GG_LIBRARY_PATH "
fi
echo ""
}
#
#
#
#Setup keyword highlighting for Vim
#
#
#
function setup_highlighting() {
mkdir -p $HOME/.vim
mkdir -p $HOME/.vim/syntax
cp $GG_LIBRARY_PATH/golf.vim $HOME/.vim/syntax/golf.vim
#set .golf file type to use golf.vim above
_USEV="autocmd BufRead,BufNewFile *.golf set filetype=golf"
if [ ! -f "$HOME/.vimrc" ]; then
echo "$_USEV" > $HOME/.vimrc
else
E=0; grep -F "$_USEV" $HOME/.vimrc >/dev/null || E=$?
if [ "$E" != "0" ]; then
echo "$_USEV" >> $HOME/.vimrc
fi
fi
#make sure syntax is on
_SYNON="syntax on"
E=0; grep -F "$_SYNON" $HOME/.vimrc >/dev/null||E=$?
if [ "$E" != "0" ]; then
echo "$_SYNON" >> $HOME/.vimrc
fi
}
#
#
#Get last part of a path
#Fast, without using subshells
#
#
function last_path_seg() {
P="$1"
P="${P%/}"
GG_LAST_PATH_SEG="${P##*/}"
}
#
#
#
#Display bash to run command-line program
#
#
#
function show_run_program() {
#GG_C_RESTPATH is set and restored from .blds file, so even if it's not in gg -r, it was in gg -q
#and here it is now - this is so we don't have to remember the path set if we're in development build directory
if [ "$GG_C_RESTPATH" == "" ]; then
_APATH="/$GG_C_NAME"
else
#remove any trailing / with ${X%%<pattern>}
_APATH="${GG_C_RESTPATH%%+(/)}"
fi
#--app overrides current working directory application above
if [ "$_REQ_APP" != "" ]; then
_APATH="$_REQ_APP"
fi
#get app name from _APATH, it's the last path segment, since _APATH is application path
last_path_seg "$_APATH"
_ANAME="$GG_LAST_PATH_SEG"
_REQ_PATH="/<request name><url payload>"
_REQ_QUERY="<request query>"
if [ "$_REQ_URL" != "" ]; then
if [[ ! "$_REQ_URL" =~ ^/.*$ ]]; then
error "Request path (--req) must be a path (it must start with a forward slash)"
fi
if [[ "$_REQ_URL" =~ ^.*\?.*$ ]]; then
#fast parsing of path without using subshells
IFS='?' read -ra PQ <<< "$_REQ_URL"
_REQ_PATH="${PQ[0]}"
_REQ_QUERY="${PQ[1]}"
else
_REQ_PATH="$_REQ_URL"
_REQ_QUERY=""
fi
fi
if [ "$_REQ_METHOD" == "" ]; then
_REQ_METHOD="GET"
fi
_CONT=""
_CONTL=""
_CONTT="export CONTENT_TYPE="
_SHEADER="export GG_SILENT_HEADER=no"
if [ "$_REQ_SILENT_HEADER" == "1" ]; then
_SHEADER="export GG_SILENT_HEADER=yes"
else
#unset" means it's not set in bash. This is used to override any already exising yes or no in the user's environment. If that was no or yes
#then it would control, and we don't want that. Explicit silent-header will set to yes, but if not set, then server will decide what to do because
#now we have -z flag in mgrg that can do that or a request can use silent-header.
_SHEADER="unset GG_SILENT_HEADER
export GG_SILENT_HEADER"
fi
if [[ "$_REQ_CONTENT_TYPE" != "" && "$_REQ_CONTENT" == "" ]]; then
error "Cannot use --content-type without --content"
fi
if [ "$_REQ_CONTENT" != "" ]; then
if [ ! -f "$_REQ_CONTENT" ]; then
error "Cannot access file $_REQ_CONTENT"
fi
_CONT="cat '$_REQ_CONTENT' | "
_CONTL="export CONTENT_LENGTH=\$(stat -c%s '$_REQ_CONTENT')"
if [ "$_REQ_CONTENT_TYPE" != "" ]; then
_CONTT="export CONTENT_TYPE='$_REQ_CONTENT_TYPE'"
fi
else
_CONTL="export CONTENT_LENGTH="
fi
echo "$_CONTT
$_CONTL
$_SHEADER
export REQUEST_METHOD=$_REQ_METHOD
export SCRIPT_NAME=\"$_APATH\"
export PATH_INFO=\"$_REQ_PATH\"
export QUERY_STRING=\"$_REQ_QUERY\""> $_TOEXEC
if [ "$_REQ_SRV" == "1" ]; then
if [[ "$_REQ_IP" != "" && "$_REQ_SOCK" != "" ]]; then
error "Cannot use both --remote and --socket"
fi
if [ "$_REQ_IP" != "" ]; then
echo "${_CONT}cgi-fcgi -connect \"$_REQ_IP\" $_APATH" >> $_TOEXEC
else
if [ "$_REQ_SOCK" != "" ]; then
if [ ! -S "$_REQ_SOCK" ]; then
error "Cannot access socket $_REQ_SOCK or is not a socket file"
fi
echo "${_CONT}cgi-fcgi -connect $_REQ_SOCK $_APATH" >> $_TOEXEC
else
echo "${_CONT}cgi-fcgi -connect $GG_ROOT/var/lib/gg/$_ANAME/sock/sock $_APATH" >> $_TOEXEC
fi
fi
else
if [[ "$_REQ_IP" != "" || "$_REQ_SOCK" != "" ]]; then
error "Cannot use --remote or --socket without --service"
fi
#add arguments if specified for command-line run
ADD_ARG=""
if [ "$_REQ_ARG" != "" ]; then
ADD_ARG=" $_REQ_ARG"
fi
echo "${_CONT}$GG_ROOT/var/lib/gg/bld/$_ANAME/$_ANAME$ADD_ARG" >> $_TOEXEC
fi
if [[ "$_REQ_EXEC" == "1" && "$_REQ_URL" == "" ]]; then
error "Cannot use --exec without --req"
fi
if [ "$_REQ_EXEC" == "1" ]; then
chmod +x $_TOEXEC
RCODE=0
. $_TOEXEC || RCODE=$?
if [ "$RCODE" != "0" ]; then
exit $RCODE
fi
else
cat $_TOEXEC
fi
}
#
#
#
#Show last $1 trace files
#
#
#
function showtrace() {
ls -aslrt $GG_ROOT/var/lib/gg/$GG_C_NAME/app/trace/trace* |tail -n $1
echo "Backtrace: $GG_ROOT/var/lib/gg/$GG_C_NAME/app/trace/backtrace"
}
#
#
#
#Show last $1 errors from backtrace
#
#
#
function showerr() {
grep -a "ERROR:" $GG_ROOT/var/lib/gg/$GG_C_NAME/app/trace/backtrace |tail -n $1
echo "Backtrace: $GG_ROOT/var/lib/gg/$GG_C_NAME/app/trace/backtrace"
}
#
#
#
#Get database vendors and names from dbvendor:dbname ... format, which is the input ($1)
#
#
#
function getdbs() {
#database vendor/name pairs
_DBL="$1"
_j=0
for _i in $_DBL; do
#-n says do not print non-matches, p says print matches only
_DBV[$_j]=$(sed -n 's/\(.*\):\(.*\)/\1/p' <<<$_i)
_DBN[$_j]=$(sed -n 's/\(.*\):\(.*\)/\2/p' <<<$_i)
if [[ "${_DBV[$_j]}" != "mariadb" && "${_DBV[$_j]}" != "postgres" && "${_DBV[$_j]}" != "sqlite" ]]; then
error "Database [${_DBV[$_j]}] is not supported (specify database as vendor:database_name, and in case of multiple databases separated them with a space in a quoted value)"
fi
if [ "${_DBN[$_j]}" == "" ]; then
error "Database configuration file not specified"
fi
if [[ ! "$_DBVALL" =~ " ${_DBV[$_j]} " ]]; then
_DBVALL="$_DBVALL ${_DBV[$_j]} "
fi
((_j=_j+1))
done
}
#
#
#
#Autocreate settings file used to recompile if one (or more) of them changes
#File $GG_BLD/blds is used in vmakefile as a signal to recompile all (if changed)
#Sole purpose is to know when to recompile, nothing is cached as far as command-line params go.
#
#GG_C_MAXERRORS and GG_C_PLAINDIAG do not affect compilation, only the output of errors, so not
#part of mkset.
#
#
function mkset() {
echo "GG_C_TRACE='$GG_C_TRACE'
GG_C_SKIPLINES='$GG_C_SKIPLINES'
GG_C_ASAN='$GG_C_ASAN'
GG_C_IGNORE_WARN='$GG_C_IGNORE_WARN'
GG_C_DEBUG='$GG_C_DEBUG'
GG_C_PUBLIC='$GG_C_PUBLIC'
GG_C_SINGLE_FILE='$GG_C_SINGLE_FILE'
GG_C_MAXUPLOAD='$GG_C_MAXUPLOAD'
GG_C_RESTPATH='$GG_C_RESTPATH'
GG_C_CFLAGS='$GG_C_CFLAGS'
GG_C_LFLAGS='$GG_C_LFLAGS'
GG_C_LFLAGS='$GG_C_LFLAGS'
GG_C_POSIXREGEX='$GG_C_POSIXREGEX'
GG_C_MODULES='$GG_C_MODULES'
GG_C_V1_MOD='$(stat -c "%Y" $GG_LIBRARY_PATH/v1)'
GG_C_GG_MOD='$(stat -c "%Y" $(which gg))'
GG_DBS='$_ALLDB'
" > $GG_BLD/.blds
if [ ! -f "$GG_BLD/blds" ]; then
cp -f $GG_BLD/.blds $GG_BLD/blds
else
_ECODE="0"
diff $GG_BLD/.blds $GG_BLD/blds > /dev/null || _ECODE="$?"
if [ "$_ECODE" != 0 ]; then
cp -f $GG_BLD/.blds $GG_BLD/blds
fi
fi
}
#
#
#
#Show documentation directory
#
#
#
function docdir() {
echo "$GG_ROOT/usr/share/golf"
}
#
#
#
#Check if app name is valid
#
#
#
function check_name() {
#$1 is the name
#$2 is the type of it (used in error message)
if [[ ! "$1" =~ ^[-a-zA-Z0-9_]{1,30}$ ]]; then
error "$2 name can be made up of alphanumerical characters only, hyphen or underscore, and its length must be between 1 and 30 characters, found [$1]"
fi
}
#
#
#
#Emitting error messages
#
#
#
function error() {
#$1 is message
echo -e "** Error: $1" 1>&2
exit -1
}
#
#
#if GG_C_MODULES read from .cache file and available, get the usage and set modules
#
#
function read_modules() {
#Set _ISMOD_* variables and call set_modules to set variables for building of application. This is for databases only.
for _i in $GG_C_MODULES; do
if [ "$_i" == "mariadb" ]; then
_ISMOD_MARIADB="1"
elif [ "$_i" == "postgres" ]; then
_ISMOD_POSTGRES="1"
elif [ "$_i" == "sqlite" ]; then
_ISMOD_SQLITE="1"
else
error "Unknown module [$_i]"
fi
done
#
#begin automatic libs discovery
#
#figure out if there's need for these libs
#these find out if there's mention of these calls. A more native C approach was attempted
#where during v1 compilation, information was collected and then used later, however that method ended up being either same or
#slower than this due to complexities of collecting and manipulating, and having to change (now) simple Makefile rules.
#Trying to obtain modification times, save and compare later was alone more than double the time of what's below.
#This gives all files to grep, so avoid slow "for i in $(ls *.golf)", and checks for file that has other than filename:0, so
#that's where :[1-9] comes from. By far the fastest method.
#Overall, the slowdown in performance of full recompile with this is only about 0.06% for 67 .golf files and about 8000 lines of code.
#The limit here is about 100,000 file with names of 20 chars long, so unlikely to have that many source files with that long names
#This approach also scales the best. For example, adding 10 more libs put it at 0.4%, whereas the approach with grepping
#each lib separately puts it at 0.74%, or almost double.
#
#first look for all possible statements
#there can't be a comment prior to statement, v1.c will prohibit that
grep -h -o "^[[:space:]]*\(call-web \|match-regex \|[a-z]\+-tree \|xml-doc \|[a-z]\+-array \|hash-string \|hmac-string \|decrypt-data \|encrypt-data \|decode-base64 \|encode-base64 \|random-crypto \|[a-z]\+-remote \)" *.golf>$GG_BLD/.findmod || true
#then from occurrances, look for curl
E=0;grep -m 1 -o "^[[:space:]]*call-web " $GG_BLD/.findmod >/dev/null||E=$?
if [ "$E" == "0" ]; then _ISMOD_CURL="1"; fi
#then from occurrances, look for array
E=0;grep -m 1 -o "^[[:space:]]*[a-z]\+-array " $GG_BLD/.findmod > /dev/null||E=$?
if [ "$E" == "0" ]; then _ISMOD_ARRAY="1"; fi
#then from occurrances, look for xml
E=0;grep -m 1 -o "^[[:space:]]*xml-doc " $GG_BLD/.findmod > /dev/null||E=$?
if [ "$E" == "0" ]; then _ISMOD_XML="1"; fi
#then from occurrances, look for tree
E=0;grep -m 1 -o "^[[:space:]]*[a-z]\+-tree " $GG_BLD/.findmod > /dev/null||E=$?
if [ "$E" == "0" ]; then _ISMOD_TREE="1"; fi
#then from occurrances, look for pcre2
E=0;grep -m 1 -o "^[[:space:]]*match-regex " $GG_BLD/.findmod > /dev/null||E=$?
if [ "$E" == "0" ]; then _ISMOD_PCRE2="1"; fi
#then from occurrances, look for fcgi
E=0;grep -m 1 -o "^[[:space:]]*[a-z]\+-remote " $GG_BLD/.findmod > /dev/null||E=$?
if [ "$E" == "0" ]; then _ISMOD_SERVICE="1"; fi
#then from occurrances, look for crypto
E=0;grep -m 1 -o "^[[:space:]]*\(hash-string \|hmac-string \|decrypt-data \|encrypt-data \|decode-base64 \|encode-base64 \|random-crypto \)" $GG_BLD/.findmod > /dev/null||E=$?
if [ "$E" == "0" ]; then _ISMOD_CRYPTO="1"; fi
#
#end automatic libs discovery
#
GG_MOD_LIBS=
GG_MODULES=
GG_MODULES_INCLUDE=
GG_STUBS=
GG_LIST_ALL_MODULES=
#sqlite module
if [ "$_ISMOD_SQLITE" == "1" ]; then
GG_SQLITE_USED="-DGG_SQLITE_INCLUDE"
#sqlite3.h is installed in include directory, so no need to specify
#GG_MODULES_INCLUDE="$GG_MODULES_INCLUDE -I /usr/include/sqlite3.h"
GG_MODULES="$GG_MODULES -lsqlite3"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolflite"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES sqllite"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_sqlite.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES sqlite"
fi
#postgres module
if [ "$_ISMOD_POSTGRES" == "1" ]; then
GG_POSTGRES_USED="-DGG_POSTGRES_INCLUDE"
GG_C_PGCONF=$(. "$GG_LIBRARY_PATH"/sys pgconf)
if [ "$GG_C_PGCONF" == "yes" ]; then
GG_MODULES_INCLUDE="$GG_MODULES_INCLUDE -I $(pg_config --includedir)"
else
GG_MODULES_INCLUDE="$GG_MODULES_INCLUDE $(pkg-config --cflags libpq)"
fi
GG_MODULES="$GG_MODULES -lpq"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolfpg"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES postgres"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_postgres.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES postgres"
fi
#mariadb module
if [ "$_ISMOD_MARIADB" == "1" ]; then
GG_MARIADB_USED="-DGG_MARIADB_INCLUDE"
GG_MODULES_INCLUDE="$GG_MODULES_INCLUDE $(mariadb_config --include)"
GG_MODULES="$GG_MODULES $(mariadb_config --libs)"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolfmys"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES mariadb"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_mariadb.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES mariadb"
fi
#fcgi module
if [ "$_ISMOD_SERVICE" == "1" ]; then
GG_SERVICE_USED="-DGG_SERVICE_INCLUDE"
#GG_MODULES="$GG_MODULES -lfcgi" - nothing here since fcgi client implemented from scratch
fcgi_inc
GG_MODULES_INCLUDE="$GG_MODULES_INCLUDE $FCGI_INC"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolfscli"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES fcgi"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_srvc.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES curl"
fi
#pcre2 module
if [ "$_ISMOD_PCRE2" == "1" ]; then
#this is if not using plain posix regex, otherwise nothing to do
GG_PCRE2_USED="-DGG_PCRE2_INCLUDE"
GG_MODULES="$GG_MODULES $(pcre2-config --libs-posix)"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolfpcre2"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES pcre2"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_pcre2.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES pcre2"
fi
#array module
if [ "$_ISMOD_ARRAY" == "1" ]; then
GG_ARRAY_USED="-DGG_ARRAY_INCLUDE"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolfarr"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES array"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_arr.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES array"
fi
#xml module
if [ "$_ISMOD_XML" == "1" ]; then
GG_XML_USED="-DGG_XML_INCLUDE"
GG_MODULES="$GG_MODULES -lxml2"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolfxml"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES xml"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_xml.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES xml"
fi
#tree module
if [ "$_ISMOD_TREE" == "1" ]; then
GG_TREE_USED="-DGG_TREE_INCLUDE"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolftree"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES tree"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_tree.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES tree"
fi
#curl module
if [ "$_ISMOD_CURL" == "1" ]; then
GG_CURL_USED="-DGG_CURL_INCLUDE"
GG_MODULES="$GG_MODULES -lcurl"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolfcurl"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES curl"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_curl.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES curl"
fi
#crypto module
if [ "$_ISMOD_CRYPTO" == "1" ]; then
GG_CRYPTO_USED="-DGG_CRYPTO_INCLUDE"
GG_MODULES="$GG_MODULES -lssl -lcrypto"
GG_MOD_LIBS="$GG_MOD_LIBS -lgolfsec"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES crypto"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_crypto.o"
GG_LIST_ALL_MODULES="$GG_LIST_ALL_MODULES crypto"
fi
if [[ "$_ISMOD_MARIADB" == "1" || "$_ISMOD_POSTGRES" == "1" || "$_ISMOD_SQLITE" == "1" ]]; then
GG_MOD_LIBS="-lgolfdb $GG_MOD_LIBS"
else
GG_STUBS="$GG_STUBS $GG_LIBRARY_PATH/stub_gendb.o"
fi
#used in vmakecommon/install to properly link modules at link-time and to substitute stubs for those modules that are not used
export GG_MODULES
export GG_MODULES_INCLUDE
export GG_STUBS
export GG_MOD_LIBS
export GG_C_MODULES
export GG_LIST_ALL_MODULES
export GG_MARIADB_USED
export GG_SERVICE_USED
export GG_CURL_USED
export GG_TREE_USED
export GG_PCRE2_USED
export GG_CRYPTO_USED
}
#
#
#
#make generated files affect recompilation ONLY if they are different
#
#
#
function copy_if_diff () {
F="$1"
_ISDIFF=$(diff $GG_BLD/$F.new $GG_BLD/$F 2>/dev/null) || true
if [[ "$_ISDIFF" != "" || ! -f "$GG_BLD/$F" ]]; then
mv $GG_BLD/$F.new $GG_BLD/$F
else
rm -rf $GG_BLD/$F.new
fi
}
#
#
#sets a list of many source code files (source.golf, golfapp.h, gg_dispatch_request.c etc.)
#takes care of generated vs provided source code: if a certain handler is provided, then don't generate it.
#
#
function gen_src() {
#
#Files generated here are $GG_BLD/source.golf,golfapp.h,gg_dispatch_request.c.
#
#
#Setup directory for set-param'eters where all parameter names for application will go to
#
if [ ! -d $GG_BLD/.setparam ]; then
rm -rf $GG_BLD/.setparam || true
mkdir -p $GG_BLD/.setparam
fi
#
#Setup directory for where we record all request handlers called and who called them
#
if [ ! -d $GG_BLD/.calledreq ]; then
rm -rf $GG_BLD/.calledreq || true
mkdir -p $GG_BLD/.calledreq
fi
#
#Generate source.golf, all the source files needed for Golf app
#
_T="source.golf"
#this is all source files, including C files
GG_CLIST=$(ls *.c 2>/dev/null) || true
GG_GOLFLIST=$(ls *.golf 2>/dev/null) || true
GG_HLIST=$(ls *.h 2>/dev/null) || true
#GG_REQLIST is really a list of requests, which we get from the list of source files
#GG_GOLFLIST is the list of golf files - note these are "flattened" so that any directory structure works in a flat directory with / substituted for __
GG_REQLIST=""
for i in $GG_GOLFLIST; do
#we can do this since we prohibit line splitting for begin-handler or %%
RS=$(sed -n 's/^\s*\(%%\|begin\-handler\) \s*\([^ \t]\+\).*/\2/gp' $i)
for OF in $RS; do #take request paths and turn them into flat files
OF=${OF/#\//}
OF=${OF//\//__}
OF=${OF//-/_}
GG_REQLIST="$GG_REQLIST
$OF"
done
done
echo "#SPDX-License-Identifier: Apache-2.0" >> $GG_BLD/$_T.new
echo "#Copyright 2018-2025 Gliim LLC. " >> $GG_BLD/$_T.new
echo >> $GG_BLD/$_T.new
echo "#" >> $GG_BLD/$_T.new
echo "#Lists source files in your application. This is an auto-generated file." >> $GG_BLD/$_T.new
echo "#" >> $GG_BLD/$_T.new
echo >> $GG_BLD/$_T.new
echo "#Include files here:" >> $GG_BLD/$_T.new
_HFILES=$(grep -a -v golfapp.h <<<"$GG_HLIST" | xargs)
echo "GG_HEADER_FILES=$(echo $_HFILES)" >> $GG_BLD/$_T.new
echo >> $GG_BLD/$_T.new
echo "#Source files here:" >> $GG_BLD/$_T.new
echo "GG_SOURCE_FILES=$(echo $GG_GOLFLIST)" >> $GG_BLD/$_T.new
echo "GG_SOURCE_C_FILES=$(echo $GG_CLIST)" >> $GG_BLD/$_T.new
_ISDIFF=$(diff $GG_BLD/$_T.new $GG_BLD/$_T 2>/dev/null) || true
if [[ "$_ISDIFF" != "" || ! -f "$GG_BLD/$_T" ]]; then
mv $GG_BLD/$_T.new $GG_BLD/$_T
else
rm -rf $GG_BLD/$_T.new
fi
#
#Generate golfapp.h, a file that has a list of C declarations neeeded to build an app
#
_T="golfapp.h"
echo "// SPDX-License-Identifier: Apache-2.0" >> $GG_BLD/$_T.new
echo "// Copyright 2018-2025 Gliim LLC. ">> $GG_BLD/$_T.new
echo >> $GG_BLD/$_T.new
echo "// This is an auto-generated file for a GOLF application" >> $GG_BLD/$_T.new
echo >> $GG_BLD/$_T.new
echo "#ifndef _GOLFAPP" >> $GG_BLD/$_T.new
echo "#define _GOLFAPP" >> $GG_BLD/$_T.new
echo >> $GG_BLD/$_T.new
if [ "$_HFILES" != "" ]; then
for i in $_HFILES; do
sed 's/\(.*\)/#include "\1"/g' <<< $i >> $GG_BLD/$_T.new
done
echo >> $GG_BLD/$_T.new
fi
echo "// function prototypes of your code" >> $GG_BLD/$_T.new
#declare all functions, including non-request ones (whether implemented or not)
for _F in $GG_REQLIST; do
RN=${_F%.*}
#if main, cannot have that, since we have main() already. Must delete $_T.new in order to regenerate, otherwise main would remain
#NOTE: if updating here, update in v1.c in is_reserved()
CC_KEYS=" auto break bool case char const continue default do double else enum extern float for goto if int long register return short signed sizeof static struct switch typedef union unsigned void volatile while main "
if [[ " $CC_KEYS " =~ .*\ $RN\ .* ]]; then
rm -f $GG_BLD/$_T.new
error "Service handler name cannot be a C reserved word [$RN]"
fi
echo "void ${RN}();" >> $GG_BLD/$_T.new
done
echo >> $GG_BLD/$_T.new
echo "#endif" >> $GG_BLD/$_T.new
#if newly generated file is the same as the old one, don't touch the old one in order to
#prevent recompilation needlessly
_ISDIFF=$(diff $GG_BLD/$_T.new $GG_BLD/$_T 2>/dev/null) || true
if [[ "$_ISDIFF" != "" || ! -f "$GG_BLD/$_T" ]]; then
mv $GG_BLD/$_T.new $GG_BLD/$_T
else
rm -rf $GG_BLD/$_T.new
fi
#
#Generate gg_dispatch_request.c, the main request handler. Based on the source code names of handler files (.golf files)
#
_T="/.flatsrc/gg_dispatch_request.c"
#Generate request files, this is used for a dispatcher
#and for a dispatcher, only request files matter
_NUMF=$(echo $GG_REQLIST | wc -w)
if [ "$_NUMF" == "0" ]; then
error "Application must have at least one .golf file, or no begin-handler (or %%) statements found"
fi
echo "// SPDX-License-Identifier: Apache-2.0" >>$GG_BLD/$_T.new
echo "// Copyright 2018-2025 Gliim LLC. " >>$GG_BLD/$_T.new
echo >>$GG_BLD/$_T.new
echo "// GOLF auto-generated request dispatcher" >>$GG_BLD/$_T.new
echo >>$GG_BLD/$_T.new
echo "#include \"golf.h\"" >>$GG_BLD/$_T.new
echo "void gg_dispatch_request() {" >>$GG_BLD/$_T.new
#req_done used to skip before/after execution if no handler used
echo " volatile int req_done;" >>$GG_BLD/$_T.new #volatile because of longjmp, so the init below doesn't get optimized
if [ "$_NUMF" != "0" ]; then
echo " char *req=gg_get_config()->ctx.req->name;" >>$GG_BLD/$_T.new
fi
#
# Setting up longjmp must be done after ANY local variables are established so they are not lost after any exit-handler
# or errors. This is because stack pointer after sigsetjmp will be LOST. So all local vars definitions must be PRIOR to it
#
#longjmp for when a request exits via exit-handler. If return value is <>0, it means
#this is a call from longjmp, and we should proceed to right after gg_dispatch_request - that is the extent
#of unwinding, such that we rollback uncommitted transactions, shutdown request and release all memory and
#then move on to the next request.
#Cannot place setjmp within if, may not process correctly when jump happens.
#We use gg_done_setjmp to prohibit exit-handler from executing the jump unless sigsetjmp was done first at runtime.
echo " int ret_val = sigsetjmp(gg_jmp_buffer, 1);" >>$GG_BLD/$_T.new
echo " if (ret_val != 0) goto end_point_exit;" >>$GG_BLD/$_T.new
echo " gg_done_setjmp = 1;" >>$GG_BLD/$_T.new
#right now the return value is always 0 (directly or called from longjmp)
#the jump will work because all we do is go to after_handler() function, which doesn't depend on any
#automatic variables from gg_dispatch_request, and after that function exits
#
#
#
echo " req_done = 0;" >>$GG_BLD/$_T.new #must be initialized separately (not as int req_done=0;) because longjmp may return to the same function and won't be initialized again
#create file with all request names for v1 to process for the main function code. This way all request info is stored as constants to be loaded as program's data, meaning the fastest possible in huge memory blocks, without having to set up each individually
#first line is the number of lines that follow, to make code generation easier
echo $_NUMF > $GG_BLD/.reqlist.new
_F_FIRST=""
for _F in $GG_REQLIST; do
RN=${_F%.*}
if [ "$_F_FIRST" == "" ]; then _F_FIRST="$RN"; fi
echo "$RN" >>$GG_BLD/.reqlist.new
done
echo " gg_request_handler _gg_req_handler;" >>$GG_BLD/$_T.new
echo " gg_num found = GG_OKAY;" >>$GG_BLD/$_T.new
if [ "$_NUMF" == "1" ]; then
echo " if (!strcmp (req, \"$_F_FIRST\") || req[0] == 0) _gg_req_handler = $_F_FIRST; else found = GG_ERR_EXIST;" >>$GG_BLD/$_T.new
else
#get handler function that handles this request from the pre-computed hash
echo " _gg_req_handler = gg_find_hash (&gg_dispatch, req, NULL, 0, &found);" >>$GG_BLD/$_T.new
fi
#before handler executes only IF req found a handler, that's why it's not in front of if()
echo " if (found == GG_OKAY) {" >>$GG_BLD/$_T.new
echo " before_handler();" >>$GG_BLD/$_T.new
echo " req_done = 1;" >>$GG_BLD/$_T.new
echo " _gg_req_handler();" >>$GG_BLD/$_T.new
echo " } else {" >>$GG_BLD/$_T.new
echo " gg_bad_request();" >>$GG_BLD/$_T.new
echo " gg_replace_string (req, strlen(req), \"__\", \"/\", 1, NULL, 1);" >>$GG_BLD/$_T.new # subst makes for smaller string, so okay, this is to show proper path in error
echo " gg_report_error (\"Request [%s] not found\", req);" >>$GG_BLD/$_T.new
echo " }" >>$GG_BLD/$_T.new
#when exit-handler is done, this is where we must end up. Since this code is executed after
#gg_dispatch_request, we can't longjump here. We long jump to a prior point and then go to here.
echo "end_point_exit:" >>$GG_BLD/$_T.new
#set gg_done_setjmp to 0, because if we do exit-handler in after_handler(), it would go into infinite loop, coming back to after.
#this way, exit-handler in after_handler, or anywhere afterwards, will do nothing. Only when the next request comes along, and gg_done_setjmp is set to 1
#in the beginning of this function, we will actually jump to end_point_exit:
echo " gg_done_setjmp = 0;" >>$GG_BLD/$_T.new
#regardless of whether a request normally ended, or had exit-handler, it would come here, and before anything else, memory handling must be set back
#to Golf, or otherwise, and gg_* memory function will fail if set to true. after_handler() should not be affected by type of memory used.
#cannot do exit-handler in after_handler - must simply do return(s)
echo " if (req_done == 1) { after_handler(); }" >>$GG_BLD/$_T.new
#
#There can be NOTHING after .after() that uses any automatic variables from gg_dispatch_request() or
#exit-handler (and longjmp) will not work
#
echo "}" >>$GG_BLD/$_T.new
echo >>$GG_BLD/$_T.new
copy_if_diff "$_T"
copy_if_diff ".reqlist"
}
#
#
#
#Create linkage for before,after and startup events. _weak_ linkage didn't work because Golf should produce
#a program that links *only* with Golf libs. It means we only distribute a single file, which is a program,
#that has only the minimal set of code - and this program uses Golf's shared library. Hence, all is shared
#(the program between different instance and all the shared libs).
#GG_EVENT_STUBS is all the stubs used.
#So, GG_EVENT_STUBS could be "$GG_ROOT/usr/lib/golf/stub_after.o" but then available after vmakefile will be "$GG_BLD/before_handler.o $GG_BLD/startup.o"
#and all three will be present (one empty and two implemented)
#
#
#
function stub_events() {
GG_EVENT_STUBS=
if [ ! -f "before_handler.golf" ]; then
GG_EVENT_STUBS="$GG_EVENT_STUBS $GG_LIBRARY_PATH/stub_before.o"
fi
if [ ! -f "after_handler.golf" ]; then
GG_EVENT_STUBS="$GG_EVENT_STUBS $GG_LIBRARY_PATH/stub_after.o"
fi
export GG_EVENT_STUBS
}
#
#
#
#Turn path-based source into a flat __ based source files
#Cannot remove and then copy b/c this would cause make to re-make all files
#each time since their timestamp would change. So we must use -p flag of cp
#to preserve source file's timestamps.
#This converts x/y/z into x__y__z files and a-b.golf into a_b.golf
#So we can do full path URL based structure and "flatten" it as it
#always was prior to this
#
#
#
function flatten_source() {
#directory where we build is .flatsrc
if [ ! -d $GG_BLD/.flatsrc ]; then
mkdir -p $GG_BLD/.flatsrc
fi
if [ "$GG_DIR_EXCLUDE" != "" ]; then
#make a list of directories we can iterate over, it's decorated as well so we can easily compare with
#eligible files
GG_DIR_EXCLUDE_F=${GG_DIR_EXCLUDE//,/ }
fi
#delete all, b/c what happens when renaming, deleting files - they
#would still hang in .flatsrc directory, and we can copy without recompiling
#if no changes, because we use ln -s which preserves timestamps for make
rm -f $GG_BLD/.flatsrc/* || true
#use find, with maxdepth of 1 for flat dir
AF=$(find . -type f -name '*' 2>/dev/null)
#for each file remove leading ./, then convert all / to __ and
#all - to _
for i in $AF; do
OF=${i/#\.\//}
EXCL=0
for k in $GG_DIR_EXCLUDE_F; do
k="${k}/"
if [[ "$OF" == "$k"* ]]; then
EXCL=1
break
fi
done
if [ "$EXCL" == "1" ]; then continue; fi
OF=${OF//\//__}
OF=${OF//-/_}
ln -s $PWD/$i $GG_BLD/.flatsrc/$OF 2>/dev/null || true
done
#make sure app name is there too, || true is b/c find will find it and it will exist
# ln -s .vappname $GG_BLD/.flatsrc || true
}
#
#
#
#Build Golf app
#
#
#
function build_app() {
if [ ! -d $GG_BLD ]; then
error "Application does not exist, use mgrg to create it"
fi
flatten_source
#once source is flattened, go there, but in a new shell ()
#so we can switch to .flatsrc directory, and no matter where this
#compilation ends, we end up in current dir after it's done, because
#were' in subshell
(
cd $GG_BLD/.flatsrc
_VFILES=$(ls *.golf 2>/dev/null|wc -l)
if [ "$_VFILES" == "0" ]; then error "Your application must have at least one .golf file"; fi
#set .dbvendors for v1 to pickup
db_lib
#get any modules in use, and generate a list of all modules
read_modules
#generate needed source code
gen_src
#generate stubs (if needed) for events (before, after, startup..)
stub_events
#create file that tells make to recompile if options changed
mkset
#make the application (compile and link) in parallel
#if GG_SHOW_MAKE is not "-s", then it's not silent, and display what it's doing
#otherwise use -s for silent
if [ "$GG_SHOW_MAKE" == "" ]; then
make -j$GG_C_CPUS SHELL="bash -x -e" -f "$GG_LIBRARY_PATH"/vmakefile all
else
make -j$GG_C_CPUS $GG_SHOW_MAKE -f "$GG_LIBRARY_PATH"/vmakefile all
fi
)
}
#
#
#
#Command line options implementation
#
#
#
function gg_version() {
#the final year is based on the year when the last Makefile ran, which is a pretty good indicator of when was the last change done here by the author;
#of course, for those who compile from source, and don't use the provided deb/dnf packages, it will always be the current year - that is not the intention -
#in that case, change this manually to the year from the official distribution!!!! That is required under most copyright laws, in which the second year should
#be the year of the last change by the author.
echo "Golf $GG_VERSION$_BETA on $GG_PLATFORM_ID ($GG_PLATFORM_VERSION)"
echo "Copyright (c) 2018-$(date '+%Y') Gliim LLC"
}
#
#
#
#display file or empty string if it doesn't exist
#
#
#
function cat0() {
if [ ! -f "$1" ]; then echo ""; else cat "$1"; fi
}
#
#
#
#Quick auto app maker
#
#
#
function autoapp() {
build_app
exit
}
#
#
#
#Set library modules from --db. Either db_lib (-q) or init_db (-qa) is executed, but not both
#
#
#
function db_lib() {
#parse --db input
#get list of dbs - add any new db vendors here (currently mariadb and postgres)
rm -f $GG_BLD/.dbvendors
getdbs "$_ALLDB"
_TOTDB="${#_DBV[@]}"
for (( _i=0; _i<$_TOTDB; _i++ )); do
#must copy array element
_DBNAME="${_DBN[$_i]}"
_DBCONF="$_DBNAME"
#build list of all
_ALLC="$_ALLC
$_DBCONF"
_DBMAKE="${_DBV[$_i]}"
if [ "$_DBMAKE" == "sqlite" ]; then
if [ "$_DONELITE" == "" ]; then
export GG_C_MODULES="$GG_C_MODULES $_DBMAKE"
_DONELITE="1"
fi
#for v1.c to pick up
echo "${_DBCONF}=sqlite" >> $GG_BLD/.dbvendors
if [ ! -f "$_DBCONF" ]; then
error "Database configuration file [$_DBCONF] ($_DBMAKE) not found"
fi
"$GG_LIBRARY_PATH"/v1 -envsub < "$_DBCONF" > $GG_A/db/"$_DBCONF"
fi
if [ "$_DBMAKE" == "mariadb" ]; then
if [ "$_DONEMARIA" == "" ]; then
export GG_C_MODULES="$GG_C_MODULES $_DBMAKE"
_DONEMARIA="1"
fi
#for v1.c to pick up
echo "${_DBCONF}=mariadb" >> $GG_BLD/.dbvendors
if [ ! -f "$_DBCONF" ]; then
error "Database configuration file [$_DBCONF] ($_DBMAKE) not found"
fi
"$GG_LIBRARY_PATH"/v1 -envsub < "$_DBCONF" > $GG_A/db/"$_DBCONF"
fi
if [ "$_DBMAKE" == "postgres" ]; then
if [ "$_DONEPG" == "" ]; then
export GG_C_MODULES="$GG_C_MODULES $_DBMAKE"
_DONEPG="1"
fi
#for v1.c to pick up
echo "${_DBCONF}=postgres" >> $GG_BLD/.dbvendors
if [ ! -f "$_DBCONF" ]; then
error "Database configuration file [$_DBCONF] ($_DBMAKE) not found"
fi
"$GG_LIBRARY_PATH"/v1 -envsub < "$_DBCONF" > $GG_A/db/"$_DBCONF"
fi
done
#check db conf name unique
_TUNIQ=$(echo $_ALLC|sort -k 1|uniq|wc -l)
_TOT=$(echo $_ALLC|wc -l)
if [ "$_TUNIQ" != "$_TOT" ]; then
error "Database configuration names must be unique"
fi
}
#
#
#
#Clean building artifacts of Golf code to rebuilt it entirely
#
#
#
function gg_clean() {
#clean the source and other code, so the next golf app compilation will be a full rebuild
make $GG_SHOW_MAKE -f "$GG_LIBRARY_PATH"/vmakefile clean
}
main "$@"
|