build.sh

   1 #!/usr/bin/env bash
   2
   3 # Programs returning != 0 will not cause script to exit
   4 set +e
   5
   6 # Case insensitive string comparison
   7 shopt -s nocaseglob
   8 #shopt -s nocasematch
   9
  10 ECHO="echo"
  11 OS=
  12 ARCH=
  13 WORD=
  14 GIT_PROTOCOL=${GIT_PROTOCOL:="https"}
  15 GIT_URL=${GIT_URL:=$GIT_PROTOCOL"://github.com/factor/factor.git"}
  16 SCRIPT_ARGS="$*"
  17
  18 test_program_installed() {
  19     command -v "$1" >/dev/null 2>&1
  20 }
  21
  22 # return 1 on found
  23 test_programs_installed() {
  24     local installed=0;
  25     $ECHO -n "Checking for all($*)..."
  26     for cmd in "$@" ;
  27     do
  28         if test_program_installed "$cmd"; then
  29             ((installed++))
  30         fi
  31     done
  32     if [[ $installed -eq $# ]] ; then
  33         $ECHO "found!"
  34         return 0
  35     fi
  36     return 1
  37 }
  38
  39 exit_script() {
  40     if [[ $FIND_MAKE_TARGET = true ]] ; then
  41         # not $ECHO here
  42         echo "$MAKE_TARGET"
  43     fi
  44     exit "$1"
  45 }
  46
  47 ensure_program_installed() {
  48     local installed=0;
  49     $ECHO -n "Checking for any($*)..."
  50     for cmd in "$@" ;
  51     do
  52         if test_program_installed "$cmd"; then
  53             $ECHO "found $cmd!"
  54             ((installed++))
  55             return
  56         fi
  57     done
  58     $ECHO "none found."
  59     $ECHO -n "Install "
  60     if [[ $# -eq 1 ]] ; then
  61         $ECHO -n "$1"
  62     else
  63         $ECHO -n "any of [ $* ]"
  64     fi
  65     $ECHO " and try again."
  66     if [[ $OS == macosx ]] ; then
  67         $ECHO "If you have Xcode 4.3 or higher installed, you must install the"
  68         $ECHO "Command Line Tools from Xcode Preferences > Downloads in order"
  69         $ECHO "to build Factor."
  70     fi
  71     exit_script 1
  72 }
  73
  74 check_ret() {
  75     # Can't execute any commands before saving $?
  76     # $1 is the name of the command we are checking
  77     RET=$?
  78     if [[ $RET -ne 0 ]] ; then
  79        $ECHO "$1" failed
  80        exit_script 2
  81     fi
  82 }
  83
  84 set_downloader() {
  85     if test_program_installed wget; then
  86         DOWNLOADER="wget -nd --prefer-family=IPv4"
  87         DOWNLOADER_NAME=wget
  88         return
  89     fi
  90     if test_program_installed curl; then
  91         DOWNLOADER="curl -L -f -O"
  92         DOWNLOADER_NAME=curl
  93         return
  94     fi
  95     $ECHO "error: wget or curl required"
  96     exit_script 11
  97 }
  98
  99 set_md5sum() {
 100     if test_program_installed md5sum; then
 101         MD5SUM=md5sum
 102     else
 103         MD5SUM="md5 -r"
 104     fi
 105 }
 106
 107 set_cc() {
 108     # on Cygwin we MUST use the MinGW "cross-compiler", therefore check these first
 109     # furthermore, we prefer 64 bit over 32 bit versions if both are available
 110
 111     # we need this condition so we don't find a mingw32 compiler on linux
 112     if [[ $OS == windows ]] ; then
 113         if test_programs_installed x86_64-w64-mingw32-gcc x86_64-w64-mingw32-g++; then
 114             [ -z "$CC" ] && CC=x86_64-w64-mingw32-gcc
 115             [ -z "$CXX" ] && CXX=x86_64-w64-mingw32-g++
 116             return
 117         fi
 118
 119         if test_programs_installed i686-w64-mingw32-gcc i686-w64-mingw32-g++; then
 120             [ -z "$CC" ] && CC=i686-w64-mingw32-gcc
 121             [ -z "$CXX" ] && CXX=i686-w64-mingw32-g++
 122             return
 123         fi
 124     fi
 125
 126     if test_programs_installed clang clang++ ; then
 127         [ -z "$CC" ] && CC=clang
 128         [ -z "$CXX" ] && CXX=clang++
 129         return
 130     fi
 131
 132     # gcc and g++ will fail to correctly build Factor on Cygwin
 133     if test_programs_installed gcc g++ ; then
 134         [ -z "$CC" ] && CC=gcc
 135         [ -z "$CXX" ] && CXX=g++
 136         return
 137     fi
 138
 139     $ECHO "error: high enough version of either (clang/clang++) or (gcc/g++) required!"
 140     exit_script 10
 141 }
 142
 143 set_make() {
 144     case $OS in
 145         freebsd) MAKE="gmake" ;;
 146         *) MAKE="make" ;;
 147     esac
 148     if [[ $MAKE = "gmake" ]] ; then
 149         ensure_program_installed gmake
 150     fi
 151 }
 152
 153 check_installed_programs() {
 154     ensure_program_installed chmod
 155     ensure_program_installed uname
 156     ensure_program_installed git
 157     ensure_program_installed wget curl
 158     ensure_program_installed clang x86_64-w64-mingw32-gcc i686-w64-mingw32-gcc gcc
 159     ensure_program_installed clang++ x86_64-w64-mingw32-g++ i686-w64-mingw32-g++ g++ cl
 160     ensure_program_installed make gmake
 161     ensure_program_installed md5sum md5
 162     ensure_program_installed cut
 163 }
 164
 165 check_library_exists() {
 166     GCC_TEST=factor-library-test.c
 167     GCC_OUT=factor-library-test.out
 168     $ECHO -n "Checking for library $1..."
 169     $ECHO "int main(){return 0;}" > $GCC_TEST
 170     if $CC $GCC_TEST -o $GCC_OUT -l "$1" 2>&- ; then
 171         $ECHO "not found."
 172     else
 173         $ECHO "found."
 174     fi
 175     rm -f $GCC_TEST
 176     check_ret rm
 177     rm -f $GCC_OUT
 178     check_ret rm
 179 }
 180
 181 check_X11_libraries() {
 182     check_library_exists GL
 183     check_library_exists X11
 184     check_library_exists pango-1.0
 185 }
 186
 187 check_gtk_libraries() {
 188     check_library_exists gobject-2.0
 189     check_library_exists gtk-x11-2.0
 190     check_library_exists gdk-x11-2.0
 191     check_library_exists gdk_pixbuf-2.0
 192     check_library_exists gtkglext-x11-1.0
 193     check_library_exists atk-1.0
 194     check_library_exists gio-2.0
 195     check_library_exists gdkglext-x11-1.0
 196     check_library_exists pango-1.0
 197 }
 198
 199
 200 check_libraries() {
 201     case $OS in
 202         linux) check_X11_libraries
 203                check_gtk_libraries ;;
 204         unix) check_gtk_libraries ;;
 205     esac
 206 }
 207
 208 check_factor_exists() {
 209     if [[ -d "factor" ]] ; then
 210         $ECHO "A directory called 'factor' already exists."
 211         $ECHO "Rename or delete it and try again."
 212         exit_script 4
 213     fi
 214 }
 215
 216 find_os() {
 217     if [[ -n $OS ]] ; then return; fi
 218     $ECHO "Finding OS..."
 219     local uname_s
 220     uname_s=$(uname -s)
 221     check_ret uname
 222     case $uname_s in
 223         CYGWIN_NT-5.2-WOW64) OS=windows ;;
 224         *CYGWIN_NT*) OS=windows ;;
 225         *CYGWIN*) OS=windows ;;
 226         MINGW32*) OS=windows ;;
 227         MINGW64*) OS=windows ;;
 228         MSYS_NT*) OS=windows ;;
 229         *darwin*) OS=macosx ;;
 230         *Darwin*) OS=macosx ;;
 231         *linux*) OS=linux ;;
 232         *Linux*) OS=linux ;;
 233         FreeBSD) OS=freebsd ;;
 234         Haiku) OS=haiku ;;
 235     esac
 236 }
 237
 238 find_architecture() {
 239     if [[ -n $ARCH ]] ; then return; fi
 240     $ECHO "Finding ARCH..."
 241     uname_m=$(uname -m)
 242     check_ret uname
 243     case $uname_m in
 244        i386) ARCH=x86 ;;
 245        i686) ARCH=x86 ;;
 246        i86pc) ARCH=x86 ;;
 247        amd64) ARCH=x86 ;;
 248        ppc64) ARCH=ppc ;;
 249        *86) ARCH=x86 ;;
 250        *86_64) ARCH=x86 ;;
 251        aarch64) ARCH=arm ;;
 252        arm64) ARCH=arm ;;
 253        iPhone5*[3-9]) ARCH=arm ;;
 254        iPhone[6-9]*) ARCH=arm ;;
 255        iPhone[1-9][0-9]*) ARCH=arm ;;
 256        iPad[4-9]*) ARCH=arm ;;
 257        iPad[1-9][0-9]*) ARCH=arm ;;
 258        AppleTV[5-9]*) ARCH=arm ;;
 259        AppleTV[1-9][0-9]*) ARCH=arm ;;
 260        "Power Macintosh") ARCH=ppc ;;
 261     esac
 262 }
 263
 264 find_num_cores() {
 265     $ECHO "Finding NUM_CORES..."
 266     NUM_CORES=1
 267     uname_s=$(uname -s)
 268     check_ret uname
 269     case $uname_s in
 270         CYGWIN_NT-5.2-WOW64 | *CYGWIN_NT* | *CYGWIN* | MINGW32*) NUM_CORES=$NUMBER_OF_PROCESSORS ;;
 271         *linux* | *Linux*) NUM_CORES=$(getconf _NPROCESSORS_ONLN || nproc) ;;
 272         *darwin* | *Darwin* | freebsd) NUM_CORES=$(sysctl -n hw.ncpu) ;;
 273     esac
 274 }
 275
 276 find_word_size() {
 277     if [[ -n $WORD ]] ; then return; fi
 278     $ECHO "Finding WORD..."
 279     WORD=$(getconf LONG_BIT || find_word_size_cpp || find_word_size_c)
 280 }
 281
 282 find_word_size_cpp() {
 283     SIXTY_FOUR='defined(__aarch64__) || defined(__x86_64__) || defined(_M_AMD64) || defined(__PPC64__) || defined(__64BIT__)'
 284     THIRTY_TWO='defined(i386) || defined(__i386) || defined(__i386__) || defined(_MIX86)'
 285     $CC -E -xc <(echo -e "#if ${SIXTY_FOUR}\n64\n#elif ${THIRTY_TWO}\n32\n#endif") | tail -1
 286 }
 287
 288 find_word_size_c() {
 289     C_WORD="factor-word-size"
 290     TEST_PROGRAM="int main(){ return (long)(8*sizeof(void*)); }"
 291     echo "$TEST_PROGRAM" | $CC -o $C_WORD -xc -
 292     check_ret "$CC"
 293     ./$C_WORD
 294     WORD_OUT=$?
 295     case $WORD_OUT in
 296         32) ;;
 297         64) ;;
 298         *)
 299             echo "Word size should be 32/64, got '$WORD_OUT'"
 300             exit_script 15 ;;
 301     esac
 302     rm -f $C_WORD
 303     echo "$WORD_OUT"
 304 }
 305
 306 set_factor_binary() {
 307     case $OS in
 308         windows) FACTOR_BINARY=factor.com ;;
 309         *) FACTOR_BINARY=factor ;;
 310     esac
 311 }
 312
 313 set_factor_library() {
 314     case $OS in
 315         windows) FACTOR_LIBRARY=factor.dll ;;
 316         macosx) FACTOR_LIBRARY=libfactor.dylib ;;
 317         *) FACTOR_LIBRARY=libfactor.a ;;
 318     esac
 319 }
 320
 321 set_factor_image() {
 322     FACTOR_IMAGE=factor.image
 323     FACTOR_IMAGE_FRESH=factor.image.fresh
 324 }
 325
 326 echo_build_info() {
 327     $ECHO "OS=$OS"
 328     $ECHO "ARCH=$ARCH"
 329     $ECHO "NUM_CORES=$NUM_CORES"
 330     $ECHO "WORD=$WORD"
 331     $ECHO "DEBUG=$DEBUG"
 332     $ECHO "REPRODUCIBLE=$REPRODUCIBLE"
 333     $ECHO "CURRENT_BRANCH=$CURRENT_BRANCH"
 334     $ECHO "CURRENT_BRANCH_FULL=$CURRENT_BRANCH_FULL"
 335     $ECHO "FACTOR_BINARY=$FACTOR_BINARY"
 336     $ECHO "FACTOR_LIBRARY=$FACTOR_LIBRARY"
 337     $ECHO "FACTOR_IMAGE=$FACTOR_IMAGE"
 338     $ECHO "MAKE_TARGET=$MAKE_TARGET"
 339     $ECHO "BOOT_IMAGE=$BOOT_IMAGE"
 340     $ECHO "MAKE_IMAGE_TARGET=$MAKE_IMAGE_TARGET"
 341     $ECHO "GIT_PROTOCOL=$GIT_PROTOCOL"
 342     $ECHO "GIT_URL=$GIT_URL"
 343     $ECHO "CHECKSUM_URL=$CHECKSUM_URL"
 344     $ECHO "BOOT_IMAGE_URL=$BOOT_IMAGE_URL"
 345     $ECHO "DOWNLOADER=$DOWNLOADER"
 346     $ECHO "CC=$CC"
 347     $ECHO "CXX=$CXX"
 348     $ECHO "MAKE=$MAKE"
 349 }
 350
 351 check_os_arch_word() {
 352     if ! [[ -n $OS && -n $ARCH && -n $WORD ]] ; then
 353         $ECHO "OS: $OS"
 354         $ECHO "ARCH: $ARCH"
 355         $ECHO "WORD: $WORD"
 356         $ECHO "OS, ARCH, or WORD is empty.  Please report this."
 357
 358         $ECHO $MAKE_TARGET
 359         exit_script 5
 360     fi
 361 }
 362
 363 set_build_info() {
 364     check_os_arch_word
 365     if [[ $OS == "windows" ]] ; then
 366         MAKE_IMAGE_TARGET=windows-$ARCH.$WORD
 367         MAKE_TARGET=$OS-$ARCH-$WORD
 368     else
 369         MAKE_IMAGE_TARGET=unix-$ARCH.$WORD
 370         MAKE_TARGET=$OS-$ARCH-$WORD
 371     fi
 372     BOOT_IMAGE=boot.$MAKE_IMAGE_TARGET.image
 373 }
 374
 375 parse_build_info() {
 376     ensure_program_installed cut
 377     $ECHO "Parsing make target from command line: $1"
 378     OS=$(echo "$1" | cut -d '-' -f 1)
 379     ARCH=$(echo "$1" | cut -d '-' -f 2)
 380     WORD=$(echo "$1" | cut -d '-' -f 3)
 381
 382     if [[ $OS == linux && $ARCH == ppc ]] ; then WORD=32; fi
 383     if [[ $OS == linux && $ARCH == arm ]] ; then WORD=32; fi
 384     if [[ $OS == macosx && $ARCH == ppc ]] ; then WORD=32; fi
 385
 386     $ECHO "OS=$OS"
 387     $ECHO "ARCH=$ARCH"
 388     $ECHO "WORD=$WORD"
 389 }
 390
 391 prepare_build_info() {
 392     find_os
 393     find_architecture
 394     find_num_cores
 395     set_cc
 396     find_word_size
 397     set_current_branch
 398     set_factor_binary
 399     set_factor_library
 400     set_factor_image
 401     set_build_info
 402     set_downloader
 403     set_boot_image_vars
 404     set_make
 405 }
 406
 407 find_build_info() {
 408     prepare_build_info
 409     echo_build_info
 410 }
 411
 412 invoke_git() {
 413     git "$@"
 414     check_ret git
 415 }
 416
 417 git_clone() {
 418     $ECHO "Downloading the git repository from github.com..."
 419     invoke_git clone "$GIT_URL"
 420 }
 421
 422 update_script_name() {
 423     $ECHO "$(dirname "$0")/_update.sh"
 424 }
 425
 426 update_script() {
 427   set_current_branch
 428   local -r update_script=$(update_script_name)
 429   local -r shell_path=$(echo "$SHELL")
 430   {
 431     echo "#!$shell_path"
 432     echo "set -ex"
 433     echo "git pull ${GIT_URL} ${CURRENT_BRANCH}"
 434     echo "exit 0"
 435   } > "$update_script"
 436   chmod 755 "$update_script"
 437   $ECHO "Running the build.sh updater script: $update_script"
 438   exec "$update_script"
 439 }
 440
 441 update_script_changed() {
 442     invoke_git diff --stat "$(invoke_git merge-base HEAD FETCH_HEAD)" FETCH_HEAD | grep "build.sh" >/dev/null
 443 }
 444
 445 git_fetch() {
 446     $ECHO "Fetching the git repository from github.com..."
 447     set_current_branch
 448
 449     rm -f "$(update_script_name)"
 450     $ECHO git fetch "$GIT_URL" "${CURRENT_BRANCH}"
 451     invoke_git fetch "$GIT_URL" "${CURRENT_BRANCH}"
 452
 453     if update_script_changed; then
 454         $ECHO "Updating and restarting the build.sh script..."
 455         update_script
 456     else
 457         $ECHO "Updating the working tree..."
 458         invoke_git pull "$GIT_URL" "${CURRENT_BRANCH}"
 459     fi
 460 }
 461
 462 cd_factor() {
 463     cd "factor" || exit 12
 464     check_ret cd
 465 }
 466
 467 backup_factor() {
 468     $ECHO "Backing up factor..."
 469     cp "$FACTOR_BINARY" "$FACTOR_BINARY.bak"
 470     cp "$FACTOR_LIBRARY" "$FACTOR_LIBRARY.bak"
 471     cp "$BOOT_IMAGE" "$BOOT_IMAGE.bak"
 472     cp "$FACTOR_IMAGE" "$FACTOR_IMAGE.bak"
 473     $ECHO "Done with backup."
 474 }
 475
 476 check_makefile_exists() {
 477     if [[ ! -e "GNUmakefile" ]] ; then
 478         $ECHO ""
 479         $ECHO "***GNUmakefile not found***"
 480         $ECHO "You are likely in the wrong directory."
 481         $ECHO "Run this script from your factor directory:"
 482         $ECHO "     ./build.sh"
 483         exit_script 6
 484     fi
 485 }
 486
 487 invoke_make() {
 488     check_makefile_exists
 489     if [ -n "$MAKE_OPTS" ]; then
 490         "$MAKE" "$MAKE_OPTS" "$@"
 491     else
 492         "$MAKE" "$@"
 493     fi
 494     check_ret $MAKE
 495 }
 496
 497 make_clean() {
 498     invoke_make clean
 499 }
 500
 501 make_factor() {
 502     $ECHO "Building factor with $NUM_CORES cores"
 503     invoke_make "CC=$CC" "CXX=$CXX" "$MAKE_TARGET" "-j$NUM_CORES"
 504 }
 505
 506 make_clean_factor() {
 507     make_clean
 508     make_factor
 509 }
 510
 511 current_git_branch() {
 512     # git rev-parse --abbrev-ref HEAD # outputs HEAD for detached head
 513     # outputs nothing for detached HEAD, which is fine for ``git fetch``
 514     git describe --all --exact-match 2>/dev/null
 515 }
 516
 517 check_url() {
 518     if [[ $DOWNLOADER_NAME == 'wget' ]]; then
 519     if wget -S --spider --prefer-family=IPv4 "$1" 2>&1 | grep -q 'HTTP/1.1 200 OK'; then
 520             return 0
 521         else
 522             return 1
 523         fi
 524     elif [[ $DOWNLOADER_NAME == 'curl' ]]; then
 525         local code
 526         code=$(curl -4 -sL -w "%{http_code}\\n" "$1" -o /dev/null)
 527         if [[ $code -eq 200 ]]; then return 0; else return 1; fi
 528     else
 529         $ECHO "error: wget or curl required in check_url"
 530         exit_script 12
 531     fi
 532 }
 533
 534 # If we are on a branch, first try to get a boot image for that branch.
 535 # Otherwise, just use `master`
 536 set_boot_image_vars() {
 537     set_current_branch
 538     local url="https://downloads.factorcode.org/images/${CURRENT_BRANCH}/checksums.txt"
 539     $ECHO "Getting checksum from ${url}"
 540     check_url $url
 541     if [[ $? -eq 0 ]]; then
 542         $ECHO "got checksum!"
 543         CHECKSUM_URL="$url"
 544         BOOT_IMAGE_URL="https://downloads.factorcode.org/images/${CURRENT_BRANCH}/${BOOT_IMAGE}"
 545     else
 546         $ECHO "boot image for branch \`${CURRENT_BRANCH}\` is not on server, trying master instead"
 547         $ECHO "  tried nonexistent url: ${url}"
 548         CHECKSUM_URL="https://downloads.factorcode.org/images/master/checksums.txt"
 549         BOOT_IMAGE_URL="https://downloads.factorcode.org/images/master/${BOOT_IMAGE}"
 550     fi
 551 }
 552
 553 set_current_branch() {
 554     if [ -n "${CI_BRANCH}" ]; then
 555         CURRENT_BRANCH="${CI_BRANCH}"
 556     else
 557         CURRENT_BRANCH_FULL=$(current_git_branch)
 558         CURRENT_BRANCH=$($ECHO "$CURRENT_BRANCH_FULL" | sed 's=heads/==;s=remotes/==')
 559     fi
 560 }
 561
 562 update_boot_image() {
 563     set_boot_image_vars
 564     $ECHO "Deleting old images..."
 565     rm -f "checksums.txt*" > /dev/null 2>&1
 566     rm -f "$BOOT_IMAGE.{?,??}" > /dev/null 2>&1
 567     rm -f "temp/staging.*.image" > /dev/null 2>&1
 568     if [[ -f $BOOT_IMAGE ]] ; then
 569         get_url "$CHECKSUM_URL"
 570         local factorcode_md5
 571         factorcode_md5=$(grep "$BOOT_IMAGE" checksums.txt | cut -f2 -d' ')
 572         set_md5sum
 573         local disk_md5
 574         disk_md5=$($MD5SUM "$BOOT_IMAGE" | cut -f1 -d' ')
 575         $ECHO "Factorcode md5: $factorcode_md5";
 576         $ECHO "Disk md5: $disk_md5";
 577         if [[ "$factorcode_md5" == "$disk_md5" ]] ; then
 578             $ECHO "Your disk boot image matches the one on downloads.factorcode.org."
 579         else
 580             rm -f "$BOOT_IMAGE" > /dev/null 2>&1
 581             get_boot_image
 582         fi
 583     else
 584         get_boot_image
 585     fi
 586 }
 587
 588 get_boot_image() {
 589     $ECHO "Downloading boot image $BOOT_IMAGE."
 590     get_url "${BOOT_IMAGE_URL}"
 591 }
 592
 593 get_url() {
 594     if [[ -z $DOWNLOADER ]] ; then
 595         set_downloader;
 596     fi
 597     $ECHO "$DOWNLOADER" "$1" ;
 598     $DOWNLOADER "$1"
 599     check_ret "$DOWNLOADER"
 600 }
 601
 602 get_config_info() {
 603     find_build_info
 604     check_installed_programs
 605     check_libraries
 606 }
 607
 608 copy_fresh_image() {
 609     $ECHO "Copying $FACTOR_IMAGE to $FACTOR_IMAGE_FRESH..."
 610     cp "$FACTOR_IMAGE" "$FACTOR_IMAGE_FRESH"
 611 }
 612
 613 check_launch_factor() {
 614     ./$FACTOR_BINARY -e=
 615     check_ret "Could not launch ./$FACTOR_BINARY"
 616 }
 617
 618 is_boot_image_outdated() {
 619     ./$FACTOR_BINARY "-e=USE: system \"\" to-refresh 2drop length 0 > 1 0 ? exit"
 620     return $?
 621 }
 622
 623 info_boot_image() {
 624     prepare_build_info
 625     if [[ -f $BOOT_IMAGE ]] ; then
 626         get_url "$CHECKSUM_URL"
 627         local factorcode_md5
 628         factorcode_md5=$(grep "$BOOT_IMAGE" checksums.txt | cut -f2 -d' ')
 629         set_md5sum
 630         local disk_md5
 631         disk_md5=$($MD5SUM "$BOOT_IMAGE" | cut -f1 -d' ')
 632         $ECHO "Boot image @factorcode.org md5: $factorcode_md5";
 633         $ECHO "Boot image @local disk     md5: $disk_md5";
 634         if [[ "$factorcode_md5" == "$disk_md5" ]] ; then
 635             $ECHO "Your disk boot image matches the one on downloads.factorcode.org."
 636         else
 637             $ECHO "Your disk boot image and the one on downloads.factorcode.org mismatch"
 638         fi
 639     fi
 640
 641     check_launch_factor
 642     is_boot_image_outdated
 643     if [[ $? -eq 0 ]]; then
 644         $ECHO "Your disk boot image is up-to-date"
 645     else
 646         $ECHO "Your disk boot image needs to be updated"
 647     fi
 648 }
 649
 650 bootstrap() {
 651     ./$FACTOR_BINARY -i="$BOOT_IMAGE"
 652     check_ret "./$FACTOR_BINARY bootstrap failed"
 653     copy_fresh_image
 654 }
 655
 656 install() {
 657     check_factor_exists
 658     get_config_info
 659     git_clone
 660     cd_factor
 661     make_factor
 662     set_boot_image_vars
 663     get_boot_image
 664     bootstrap
 665 }
 666
 667 update() {
 668     get_config_info
 669     git_fetch
 670     backup_factor
 671     make_clean_factor
 672 }
 673
 674 download_and_bootstrap() {
 675     update_boot_image
 676     bootstrap
 677 }
 678
 679 net_bootstrap_no_pull() {
 680     get_config_info
 681     make_clean_factor
 682     download_and_bootstrap
 683 }
 684
 685 refresh_image() {
 686     ./$FACTOR_BINARY -e="USING: vocabs.loader vocabs.refresh system memory ; refresh-all save 0 exit"
 687     check_ret factor
 688 }
 689
 690 make_boot_image() {
 691     ./$FACTOR_BINARY -run="bootstrap.image" "$MAKE_IMAGE_TARGET"
 692     check_ret factor
 693 }
 694
 695 install_deps_apt() {
 696     sudo apt install --yes libc6-dev libpango1.0-dev libx11-dev xorg-dev libgtk2.0-dev gtk2-engines-pixbuf libgtkglext1-dev wget git git-doc rlwrap clang make screen tmux libssl-dev
 697     check_ret sudo
 698 }
 699
 700 install_deps_pacman() {
 701     sudo pacman --noconfirm -Syu gcc clang make rlwrap git wget pango glibc gtk2 gtk3 gtkglext gtk-engines gdk-pixbuf2 libx11 screen tmux
 702     check_ret sudo
 703 }
 704
 705 install_deps_dnf() {
 706     sudo dnf --assumeyes install gcc gcc-c++ glibc-devel binutils libX11-devel pango-devel gtk3-devel gdk-pixbuf2-devel gtkglext-devel tmux rlwrap wget
 707     check_ret sudo
 708 }
 709
 710 install_deps_pkg() {
 711     sudo pkg install --yes bash git gmake gcc rlwrap ripgrep curl gmake x11-toolkits/gtk30 x11-toolkits/gtkglext pango cairo vim
 712 }
 713
 714
 715 install_deps_macosx() {
 716     if test_program_installed git; then
 717         ensure_program_installed yes
 718         $ECHO "git not found."
 719         $ECHO "This script requires either git-core or port."
 720         $ECHO "If it fails, install git-core or port and try again."
 721         ensure_program_installed port
 722         $ECHO "Installing git-core with port...this will take awhile."
 723         yes | sudo port install git-core
 724     fi
 725 }
 726
 727 usage() {
 728     $ECHO "usage: $0 command [optional-target]"
 729     $ECHO "  install - git clone, compile, bootstrap"
 730     $ECHO "  deps-apt - install required packages for Factor on Linux using apt"
 731     $ECHO "  deps-pacman - install required packages for Factor on Linux using pacman"
 732     $ECHO "  deps-dnf - install required packages for Factor on Linux using dnf"
 733     $ECHO "  deps-pkg - install required packages for Factor on FreeBSD using pkg"
 734     $ECHO "  deps-macosx - install git on MacOSX using port"
 735     $ECHO "  info-boot-image - print remote and disk boot image MD5, status disk boot image"
 736     $ECHO "  self-bootstrap - make local boot image, bootstrap"
 737     $ECHO "  self-update - git pull, recompile, make local boot image, bootstrap"
 738     $ECHO "  quick-update - git pull, refresh-all, save"
 739     $ECHO "  update|latest - git pull, recompile, download a boot image, bootstrap"
 740     $ECHO "  compile - compile the binary"
 741     $ECHO "  recompile - recompile the binary"
 742     $ECHO "  bootstrap - bootstrap with existing boot image"
 743     $ECHO "  net-bootstrap - recompile, download a boot image, bootstrap"
 744     $ECHO "  make-target - find and print the os-arch-cpu string"
 745     $ECHO "  report|info - print the build variables"
 746     $ECHO "  full-report - print the build variables, check programs and libraries"
 747     $ECHO "  update-boot-image - get the boot image for the current branch"
 748     $ECHO ""
 749     $ECHO "If you are behind a firewall, invoke as:"
 750     $ECHO "env GIT_PROTOCOL=http $0 <command>"
 751     $ECHO ""
 752     $ECHO "Example for overriding the default target:"
 753     $ECHO "    $0 update macosx-x86-32"
 754 }
 755
 756 MAKE_TARGET=unknown
 757
 758 # -n is nonzero length, -z is zero length
 759 if [[ -n "$2" ]] ; then
 760     parse_build_info "$2"
 761 fi
 762
 763 if [ "$#" -gt 3 ]; then
 764     usage
 765     $ECHO "error: too many arguments"
 766     exit 1
 767 fi
 768
 769 case "$1" in
 770     install) install ;;
 771     deps-apt) install_deps_apt ;;
 772     deps-pacman) install_deps_pacman ;;
 773     deps-macosx) install_deps_macosx ;;
 774     deps-dnf) install_deps_dnf ;;
 775     deps-pkg) install_deps_pkg ;;
 776     info-boot-image) info_boot_image ;;
 777     self-bootstrap) get_config_info; make_boot_image; bootstrap  ;;
 778     self-update) update; make_boot_image; bootstrap  ;;
 779     quick-update) update; refresh_image ;;
 780     update|latest) update; download_and_bootstrap ;;
 781     compile) find_build_info; make_factor ;;
 782     recompile) find_build_info; make_clean; make_factor ;;
 783     bootstrap) get_config_info; bootstrap ;;
 784     net-bootstrap) net_bootstrap_no_pull ;;
 785     make-target) FIND_MAKE_TARGET=true; ECHO=false; find_build_info; exit_script 0;;
 786     report|info) find_build_info ;;
 787     full-report) find_build_info; check_installed_programs; check_libraries ;;
 788     update-boot-image) find_build_info; check_installed_programs; update_boot_image ;;
 789     update-script) update_script ;;
 790     *) usage ;;
 791 esac
 792