#!/bin/bash
# =========================================================================
#   Program:   S1Tiling
#
#   Copyright 2017-2025 (c) CNES. All rights reserved.
#
#   This file is part of S1Tiling project
#       https://gitlab.orfeo-toolbox.org/s1-tiling/s1tiling
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       https://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#
# =========================================================================
#
# Authors: Thierry KOLECK (CNES)
#          Luc HERMITTE (CS Group)
#          Fabien CONTIVAL (CS Group)
#
# =========================================================================
#
# Helper script to install S1Tiling on CNES HPC clusters.
#

# Support applications requires a version of gcc > v10
ml gcc/14.2.0

## ======[ Globals {{{1
# ==[ Constant parameters {{{2
# s1tiling_version=1.1.0
# otb_ver=7.4.2
s1tiling_version=1.2.0rc2
otb_ver=9.1.1
# otb_ver=8.1.2
# git_node=develop
git_RTC_gamma0_node=main

# if HAL:
# python_ml_dep=python3.8.4-gcc8.2
# if TREX:
python_ml_dep=python3.12

repo_url=https://gitlab.orfeo-toolbox.org/s1-tiling/s1tiling.git

# ==[ Other constants {{{2

RH_FLAVOR=$(cat /etc/redhat-release)
RH_FLAVOR=${RH_FLAVOR#* release}
RH_FLAVOR=${RH_FLAVOR:1:1}

# Current date is used to install new versions as, for instance:
#     1.0.0rc2-otb7.4-20230620/
# and have a symbolic link to the exact installation path:
#     1.0rc2-otb7.4 -> 1.0rc2-otb7.4-20230620/
# This will ease the update of the version installed if need be without
# destabilising pre-existing versions.
date="$(date "+%Y%m%d")"
public_prefix="${s1tiling_version}-otb${otb_ver}"
env="${public_prefix}-${date}"

# Where it will be installed
# -> HAL
# projets_root="/softs/projets"
# -> TREX
projets_root="${projets_root:-/work/softs/projets}"

prefix_root="${projets_root}/s1tiling/rh${RH_FLAVOR}"
module_root="${projets_root}/modulefiles/s1tiling"

## ======[ Helper functions {{{1
# ==[ _verbose                          {{{2
__log_head='\033[36m$>\033[0m '
function _verbose()
{
    # if debug...
    echo -e "\n${__log_head:-}$*"
    # fi
}

# ==[ _die                              {{{2
function _die()
{
   local msg=$1
   [ -z "${msg}" ] && msg="Died"
   # echo "BASH_SOURCE: ${#BASH_SOURCE[@]}, BASH_LINENO: ${#BASH_LINENO[@]}, FUNCNAME: ${#FUNCNAME[@]}"
   printf "${BASH_SOURCE[0]:-($0 ??)}:${BASH_LINENO[0]}: ${FUNCNAME[1]}: ${msg}\n" >&2
   for i in $(seq 2 $((${#BASH_LINENO[@]} -1))) ; do
       printf "called from: ${BASH_SOURCE[$i]:-($0 ??)}:${BASH_LINENO[$(($i-1))]}: ${FUNCNAME[$i]}\n" >&2
   done
   # printf "%s\n" "${msg}" >&2
   exit 127
}

# ==[ _execute                          {{{2
# If $noexec is defined to 1, the execution is "dry" and does nothing.
function _execute()
{
    _verbose "$@"
    [ "${noexec:-0}" = "1" ] || "$@"
}


## ======[ Main installation script {{{1

[ -d "${prefix_root}" ] || _execute mkdir -p "${prefix_root}" || _die "Can't create '${prefix_root}"
_execute cd "${prefix_root}" || _die "Can't cd to installation base directory ${prefix_root}"

# ==[ Work around improper dependance of OTB on libcrypto by using git before hand
_execute mkdir -p "${env}"
_execute cd "${env}"
[ -d "repo" ] || _execute git clone "${repo_url}" "repo" || _die "Can't clone S1Tiling repository"

_execute cd "${prefix_root}/${env}" || _die "Can't cd to '${prefix_root}/${env}'"
[ -d normlim_sigma0 ] || _execute git clone https://gitlab.orfeo-toolbox.org/s1-tiling/normlim_sigma0.git || _die "Can't clone normlim_sigma0 repository"

[ -d RTC_gamma0 ] || _execute git clone https://gitlab.orfeo-toolbox.org/s1-tiling/RTC_gamma0.git || _die "Can't clone RTC_gamma0 repository"
_execute cd "${prefix_root}/${env}" || _die "Can't cd to '${prefix_root}/${env}'"
_execute cd "RTC_gamma0"            || _die "Can't cd to the RTC_gamma0 directory"
_execute git checkout ${git_RTC_gamma0_node} || _die "Can't checkout '${git_RTC_gamma0_node}'"

# ==[ Create and prepare the virtual env
_execute cd "${prefix_root}"
_verbose ml "otb/${otb_ver}-${python_ml_dep}"
ml "otb/${otb_ver}-${python_ml_dep}" || _die "Can't load module otb/${otb_ver}-${python_ml_dep}"
# Override  libcrypto overriden by OTB, if need be.
# NB: this may cause later troubles with libgdal...
cmake --version || LD_LIBRARY_PATH="/usr/lib:/usr/lib64:${LD_LIBRARY_PATH}"
cmake --version || _die "Can't execute CMake..."

[ -f "${env}/bin/activate" ] || _execute python -m venv --copies "${env}" || _die "Can't create virtual environment '${env}'"

_verbose source "${env}/bin/activate"
source "${env}/bin/activate"

_execute python -m pip install --upgrade pip                || _die "Can't upgrade pip"
# _execute python -m pip install --upgrade setuptools==57.5.0 || _die "Can't upgrade setuptools to v57.5.0"
_execute python -m pip install --upgrade setuptools         || _die "Can't upgrade setuptools"
_execute python -m pip --no-cache-dir install "numpy<2"     || _die "Can't install numpy from scratch"

# Check if GDAL fulfills all S1Tiling requirements
echo -e "\n# Check GDAL is compatible with S1Tiling requirements..."

# python -c "from osgeo import gdal ; print('GDAL version:', gdal.__version__)"
_execute python -c "from osgeo import gdal_array" || _die "GDAL (from OTB?) is not correctly installed (_GLIBCXX_USE_CXX11_ABI mismatch)"
# if mismatch, see https://github.com/OSGeo/gdal/issues/4724#issuecomment-953734163

function _test_gdal_gpkg
{
    _verbose "gdalinfo --formats | grep -qi gpkg"
    gdalinfo --formats | grep -qi gpkg
}
_test_gdal_gpkg || _die "GDAL lacks GPKG support"


# ==[ Clone S1Tiling
_execute cd "${env}" || _die "Invalid expected directory"
[ -d "repo" ] || _execute git clone "${repo_url}" "repo" || _die "Can't clone S1Tiling repository"
_execute cd repo || _die "Repository hasn't been cloned properly..."

# ==[ Install the expected version
[ -v git_node ] || git_node="tags/${s1tiling_version}"
_execute git checkout "${git_node}" || _die "Can't checkout ${git_node}"
_execute python -m pip install .    || _die "Can't install S1Tiling (from repo)"
_execute S1Processor --version      || _die "S1Tiling isn't properly installed"

# ==[ Clone and install OTB applications for NORMLIM Calibration
lia_build_dir="normlim_sigma0/_builddir"

_execute cd "${prefix_root}/${env}" || _die "Can't cd to '${prefix_root}/${env}'"
[ -d normlim_sigma0 ]         || _execute git clone https://gitlab.orfeo-toolbox.org/s1-tiling/normlim_sigma0.git || _die "Can't clone normlim_sigma0 repository"
_execute cd "normlim_sigma0"  || _die "Can't cd to the normlim_sigma0 directory"
# _execute git checkout "tags/${normlim_version}" || _die "Can't change normlim_sigma0 branch"
# Use temporary branch for applications compatible with OTB 8
_execute mkdir -p "_builddir" || _die "Can't create the build directory"
_execute cd       "_builddir" || _die "Can't cd to the build directory"
# _execute cmake -DCMAKE_CXX_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=0 -DOTB_BUILD_MODULE_AS_STANDALONE=ON -DCMAKE_INSTALL_PREFIX="${OTB_INSTALL_DIRNAME}" -DCMAKE_BUILD_TYPE=Release ..
_execute cmake -DOTB_BUILD_MODULE_AS_STANDALONE=ON -DCMAKE_INSTALL_PREFIX="${prefix_root}/${env}" -DCMAKE_BUILD_TYPE=Release .. || _die "Can't configure normlim_sigma0 compilation"
_execute make                       || _die "Can't compile normlim_sigma0"
_execute make install               || _die "Can't install normlim_sigma0"
_execute cd "${prefix_root}/${env}" || _die "Can't cd to '${prefix_root}/${env}'"
_execute rm -rf "normlim_sigma0"    || _die "Can't clean normlim_sigma0 directory"

# ==[ Clone and install OTB applications for GAMMA NAUGHT RTC Calibration
gamma_area_build_dir="RTC_gamma0/_builddir"

_execute cd "${prefix_root}/${env}" || _die "Can't cd to '${prefix_root}/${env}'"
[ -d RTC_gamma0 ]             || _execute git clone https://gitlab.orfeo-toolbox.org/s1-tiling/RTC_gamma0.git || _die "Can't clone RTC_gamma0 repository"
_execute cd "RTC_gamma0"      || _die "Can't cd to the RTC_gamma0 directory"
# Use temporary branch for applications compatible with OTB 8
_execute mkdir -p "_builddir" || _die "Can't create the build directory"
_execute cd       "_builddir" || _die "Can't cd to the build directory"
# _execute cmake -DCMAKE_CXX_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=0 -DOTB_BUILD_MODULE_AS_STANDALONE=ON -DCMAKE_INSTALL_PREFIX="${OTB_INSTALL_DIRNAME}" -DCMAKE_BUILD_TYPE=Release ..
_execute cmake -DOTB_BUILD_MODULE_AS_STANDALONE=ON -DCMAKE_INSTALL_PREFIX="${prefix_root}/${env}" -DCMAKE_BUILD_TYPE=Release .. || _die "Can't configure RTC_gamma0 compilation"
_execute make                       || _die "Can't compile RTC_gamma0"
_execute make install               || _die "Can't install RTC_gamma0"
_execute cd "${prefix_root}/${env}" || _die "Can't cd to '${prefix_root}/${env}'"
_execute rm -rf "RTC_gamma0"        || _die "Can't clean RTC_gamma0 directory"

# ==[ Commit the installation
_execute cd "${prefix_root}"
_execute chmod -R go+rX "${env}"
[ -h "${public_prefix}" ] && _execute rm "${public_prefix}"
_execute ln -s "${env}" "${public_prefix}"

# ==[ And create the modulefile!
[ -d "${module_root}" ] || _execute mkdir -p "${module_root}" || _die "Cannot create module folder for S1Tiling: '${module_root}'"
export module_file="${module_root}/${public_prefix}.lua"
_verbose "Create modulefile: ${module_file}"
cat > "${module_file}" << EOF
-- -*- lua -*-
-- Aide du module accessible avec la commande module help
help(
[[
Version disponible sous rh${RH_FLAVOR} depuis ${git_node}
]])

local function is_empty(s)
  return s == nil or s == ''
end

-- Information du modulefile
local os_disponible = "rh${RH_FLAVOR}"
local nom           = "s1tiling"
local version       = "${public_prefix}"
local installation  = "$(date)"
local informations  = system_information()
local rhos          = informations.os

-- Information du module accessible avec la commande module whatis
whatis("Nom     : "..nom)
whatis("Version : "..version)
whatis("Os      : "..os_disponible)
whatis("Date d installation : "..installation)

-- Verification du modulefile
-- check_os(os_disponible) -- on HAL only, not on TREX...

-- Variable du modulefile
local home=pathJoin("${projets_root}/s1tiling",rhos,version)

-- Dependances
depend("otb/${otb_ver}-${python_ml_dep}")

-- Action du modulefile
setenv("S1TILING_HOME",home)
prepend_path("LD_LIBRARY_PATH", pathJoin(home, "lib"))
prepend_path("OTB_APPLICATION_PATH", pathJoin(home, "lib"))

-- Emule activate des virtualenv python...
pushenv("VIRTUAL_ENV", home)
prepend_path("PATH", pathJoin(home, "bin"))
if is_empty(os.getenv("VIRTUAL_ENV_DISABLE_PROMPT")) and not is_empty(os.getenv("PS1")) then
    pushenv("PS1", "(s1tiling "..version..") ".. os.getenv("PS1"))
end
EOF

# TODO: Use ACL when bug is fixed on TREX!
_execute chmod u+rw "${module_file}"
_execute chmod go+r "${module_file}"

# }}}
# vim: set foldmethod=marker: