functions.sh

function cleanup()
{
  if [[ -n "$host" ]]
  then
    upload_build_log
  fi
  exit
}

function usage()
{
  {
    echo "Usage: $0 [-c <revision>] [-d <revision>] [-r <revision>]"
    echo "       $0 -h"
    echo
    echo "-h          display this help message"
    echo
    echo "-c revision gnucash git revision to build. Can be a branch or a tag."
    echo "            Default: whatever is set with -r or 'maint' if -' was not specified"
    echo "-d revision gnucash-docs git revision to build. Can be a branch or a tag."
    echo "            Default: whatever is set with -r or 'maint' if -' was not specified"
    echo "-r revision git revision to build. Can be a branch or a tag."
    echo "            Can be used in multiple ways: if -c or -d options are omitted"
    echo "            the value of -r is used as default instead."
    echo "            If both -c and -d refer to a release tag, the value of -r will be used"
    echo "            additionally as name of the directory that holds the release tarballs"
    echo "            on sourceforge. This allows to handle situations where this directory name"
    echo "            is different from the release tarball versions."
    echo "            Default: 'maint'"
    echo
    echo "Examples:"
    echo
    echo "  $0 -r master"
    echo
    echo "    Create a development flatpak for the current master branches of gnucash and gnucash-docs"
    echo
    echo "  $0 -r 3.7"
    echo
    echo "    Create a release flatpak for the gnucash 3.7. This will look for tarballs on sourceforge"
    echo "    for gnucash 3.7 and gnucash-docs 3.7 in directory 3.7"
    echo
    echo "  $0 -r 3.8 -c3.8b"
    echo
    echo "    Create a release flatpak with tarballs taken from sourceforge"
    echo "    for gnucash 3.8 and gnucash-docs 3.8b in directory 3.8"
    echo
    echo "Note:"
    echo "  If you want to create a release flatpak, you will always want to set at least -r."
    echo "  That tells the scripts in which sourceforge directory to look for tarballs."
    echo "  If the tarballs have slightly different version numbers (due to release process internals)"
    echo "  you can add -c or -d to specify those."
    echo "  For development builds (that is, from git) you are free to mix and match"
    echo "  the 3 options as you see fit. In this case -r only serves as a default value"
    echo "  for the other two."
  } 1>&2
  exit 1
}

# This function will create a remote directory
# It will only run if $host is configured.
# Note it assumes the parent directory exists and it won't
# create intermediate subdirectories if that is not the case
function create_remote_dir()
{
  if [[ -n "$host" ]]
  then
    # For this hack $base_dir is just an arbitrary existing directory
    # It doesn't matter which one
    # No files will be copied from it anyway because of the exclude parameter
    rsync -a --exclude='*' "$base_dir"/ "$1"
  fi
}

function upload_build_log()
{
  if [[ -n "$host" ]]
  then
    echo "Uploading log file '$log_file'"
    create_remote_dir "$host"/build-logs
    if [[ -z "$remote_branch_dir" ]]
    then
      # We don't know the build type yet, so we can't determine
      # the final remote directory to store it
      # So let's just store it in the top-level so we have a trace
      # of the build start or very early failures
      rsync -a "$local_log_dir/$log_file" "$host"/build-logs
    else
      # Now the subdirectory to store the log file is is known
      # In addition group per month to simplify navigation even more
      month_part=$(date +%Y-%m)

      create_remote_dir "$host"/build-logs/$remote_branch_dir
      create_remote_dir "$host"/build-logs/$remote_branch_dir/$month_part

      rsync -a "$local_log_dir/$log_file" "$host"/build-logs/$remote_branch_dir/$month_part

      # Finally remove the initially start build log uploaded earlier
      # Disable fatal error handling though to prevent the complete script from exiting
      # if no early build log exists
      echo "Removing initial startup build log uploaded earlier"
      set +ex
      rsync -rv --delete --include="$log_file" --exclude='*' "$base_dir"/ "$host"/build-logs/
      set -ex
    fi
  fi
}

# Updates repo to repo_rev
# Then checks whether repo_rev is a tag
# If not a tag, reset repo to repo_rev
# Caller should pass repo_rev as first parameter
function prepare_repo()
{
  repo_rev=$1
  pushd "${repodir}"
  echo "Update repository $repodir"
  git fetch
  git checkout $repo_rev
  if git tag | grep -q "^$repo_rev\$"
  then
    echo "Detected a tag (release) build"
    if [[ "${is_release}" == "no" ]]
    then
        echo "However a previously checked repository is not set up for release builds. Falling back to development build."
        remote_branch_dir=$repo_rev
    else
        is_release="yes"
        remote_branch_dir="releases"
    fi
  else
    echo "No tag detected, assuming development build"
    is_release="no"
    # This function is run twice - once for code once for docs
    # Only set remote_branch_dir if not yet set (in other words code's setting takes precedence)
    if [[ -z $remote_branch_dir ]]
    then
      remote_branch_dir=$repo_rev
    fi
    git reset --hard origin/$repo_rev
  fi
  popd
}

function get_versions()
{
  echo "Extracting version numbers for package $package"
  pushd "${repodir}"
  gc_commit=$(git reflog | head -n1 | awk '{print $1}')
  gc_full_version=$(git describe)
  popd
}

function get_checksums()
{
  wget "http://downloads.sourceforge.net/gnucash/gnucash (stable)/${revision}/README.txt" -O "${base_dir}"/README.txt
  code_checksum=$(awk "/gnucash-${code_revision}.tar.bz2/ { print \$1;}" "${base_dir}"/README.txt)
  docs_checksum=$(awk "/gnucash-docs-${docs_revision}.tar.gz/ { print \$1;}" "${base_dir}"/README.txt)
}

function prepare_gpg()
{
  # gpg_parms will hold optional gpg parameters passed to flatpak commands later on
  gpg_parms=""
  if [[ -n "$gpg_key" ]]
  then
    gpg_parms="--gpg-sign=$gpg_key"
    if [[ -n "$gpg_dir" ]]
    then
      gpg_home="--homedir=$gpg_dir"
      gpg_parms="--gpg-homedir=$gpg_dir $gpg_parms"
    fi
    gpg2 "$gpg_home" --export $gpg_key > "$base_dir"/gnucash-flatpak.gpg

    if [[ -n "$host" ]]
    then
      echo "Uploading GPG public key 'gnucash-flatpak.gpg'"
      rsync -a "$base_dir"/gnucash-flatpak.gpg "$host"
    fi
    gpg_key64=$(base64 "$base_dir"/gnucash-flatpak.gpg | tr -d '\n')
  fi
}

function create_manifest()
{
  echo "Configuring org.gnucash.GnuCash.json manifest module files"

  # Export environment variables used in the templates in order for envsubst to find them
  export code_repodir docs_repodir code_checksum docs_checksum revision code_revision docs_revision

  # Note we explicitly pass a number of variable names to envsubst in
  # the commands below. This limits the set of variables envsubst will
  # effectively substitute
  # We do this to prevent colisions with flatpak variables in the manifest
  # and module files

  rm -f "$fp_git_dir"/gnucash-source.json
  if [[ -f "$fp_git_dir"/templates/gnucash-source-${build_type}.json.tpl ]]; then
      envsubst '$code_repodir $code_revision $revision $code_checksum' \
                < "$fp_git_dir"/templates/gnucash-source-${build_type}.json.tpl \
                > "$fp_git_dir"/gnucash-source.json
  fi

  rm -f "$fp_git_dir"/gnucash-docs-source.json
  if [[ -f "$fp_git_dir"/templates/gnucash-docs-source-${build_type}.json.tpl ]]; then
      envsubst '$docs_repodir $docs_revision $revision $docs_checksum' \
                < "$fp_git_dir"/templates/gnucash-docs-source-${build_type}.json.tpl \
                > "$fp_git_dir"/gnucash-docs-source.json
  fi

  rm -f "$fp_git_dir"/gnucash-extra-modules.json
  if [[ -f "$fp_git_dir"/templates/gnucash-extra-modules-${build_type}.json.tpl ]]; then
      cp "$fp_git_dir"/templates/gnucash-extra-modules-${build_type}.json.tpl \
         "$fp_git_dir"/gnucash-extra-modules.json
  fi
}

function setup_sdk()
{
    echo "Configuring flathub repository"
    flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo

    # Extract the required sdk from the config file
    runtime_base=$(perl -lne 'm|"runtime".*"(.*)"|g&&print "$1"' "$fp_git_dir"/org.gnucash.GnuCash.json)
    runtime_ver=$(perl -lne 'm|"runtime-version".*"(.*)"|g&&print "$1"' "$fp_git_dir"/org.gnucash.GnuCash.json)
    sdk_base=$(perl -lne 'm|"sdk".*"(.*)"|g&&print "$1"' "$fp_git_dir"/org.gnucash.GnuCash.json)
    runtime=$runtime_base//$runtime_ver
    sdk=$sdk_base//$runtime_ver
    flatpak install -y --user flathub $sdk $runtime
}

function create_flatpakref()
{
  fp_ref_file=gnucash-$fp_branch.flatpakref
  if [[ -n "$host_public" ]] || [[ -n "$gpg_key" ]]
  then
    echo "Writing $fp_ref_file"
    fp_ref_dir_local="$base_dir"/flatpakrefs
    mkdir -p "$fp_ref_dir_local"
    cp "$fp_git_dir"/templates/gnucash.flatpakref.tpl "$fp_ref_dir_local"/$fp_ref_file
    echo "Branch=$fp_branch"         >> "$fp_ref_dir_local"/$fp_ref_file
    echo "Url=$host_public/$fp_repo" >> "$fp_ref_dir_local"/$fp_ref_file
    echo "GPGKey=$gpg_key64" >> "$fp_ref_dir_local"/$fp_ref_file
  else
    echo "Mandatory variable 'host_public' or 'gpg_key' is not set."
    echo "Skipping generation of $fp_ref_file"
    fp_ref_file=""
  fi
}

function create_flatpakrepo()
{
    fp_repo_file=gnucash-nightlies.flatpakrepo
    if [[ -n "$host_public" ]] || [[ -n "$gpg_key" ]]
        then
        echo "Writing $fp_repo_file"
        fp_repo_dir_local="$base_dir"/flatpakrefs
        mkdir -p "$fp_repo_dir_local"
        cp "$fp_git_dir"/templates/gnucash-nightlies.flatpakrepo.tpl "$fp_repo_dir_local"/$fp_repo_file
        echo "Url=$host_public/$fp_repo" >> "$fp_repo_dir_local"/$fp_repo_file
        echo "GPGKey=$gpg_key64" >> "$fp_repo_dir_local"/$fp_repo_file
    else
        echo "Mandatory variable 'host_public' or 'gpg_key' is not set."
        echo "Skipping generation of $fp_repo_file"
        fp_repo_file=""
    fi
}