e3.bash

#!/usr/bin/env bash
#
#  Copyright (c) 2017 - 2019  Jeong Han Lee
#  Copyright (c) 2017 - 2019  European Spallation Source ERIC
#
#  The program is free software: you can redistribute
#  it and/or modify it under the terms of the GNU General Public License
#  as published by the Free Software Foundation, either version 2 of the
#  License, or any newer version.
#
#  This program is distributed in the hope that it will be useful, but WITHOUT
#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
#  more details.
#
#  You should have received a copy of the GNU General Public License along with
#  this program. If not, see https://www.gnu.org/licenses/gpl-2.0.txt
#
#
#   author  : Jeong Han Lee
#   email   : jeonghan.lee@gmail.com
#   date    : Wednesday, November 27 16:59:39 CET 2019
#   version : 0.7.2

GIT_URL="https://github.com/icshwi"
GIT_CMD="git clone"

declare -gr SC_SCRIPT="$(realpath "$0")"
declare -gr SC_SCRIPTNAME=${0##*/}
declare -gr SC_TOP="${SC_SCRIPT%/*}"
declare -gr SC_LOGDATE="$(date +%y%m%d%H%M)"

# We use only ONE base, and REQUIRE even if it is used as array
declare -ga base_list=("e3-base")
declare -ga require_list=("e3-require")
declare -ga module_list=()

. ${SC_TOP}/.cfgs/.e3_functions.cfg
. ${SC_TOP}/.cfgs/.e3_modules_list.cfg


function make_init2
{
    git submodule update --init --recursive ;
    git submodule update --remote --merge;
    make checkout
}


# BASE
function init_base
{
    local rep="";

    for rep in  ${base_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make init   ||  die 1 "${FUNCNAME[*]} : MAKE init ERROR at ${rep}: Please check it" ;
	    if [ "$ANSWER" == "YES" ]; then
	    	make pkgs
	    fi
	    make patch  ||  die 1 "${FUNCNAME[*]} : MAKE patch ERROR at ${rep}: Please check it" ;
	    make vars
	    popd
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist. Please make sure \"make gbase\" first"
	fi
	printf "\n";
    done
}

# BASE
function init2_base
{
    local rep="";
    local answer="$1"; shift;
    for rep in  ${base_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    git submodule sync
	    git submodule update --init --recursive
	    make checkout
	    if [ "$ANSWER" == "YES" ]; then
	    	make pkgs
	    fi
	    make patch  ||  die 1 "${FUNCNAME[*]} : MAKE patch ERROR at ${rep}: Please check it" ;
	    make vars
	    popd
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist. Please make sure \"make gbase\" first"
	fi
	printf "\n";
    done
}



# BASE
function setup_base
{
    local git_status=$1; shift;
    clone_base "${git_status}";
    init_base;
}

# BASE
function build_base
{
    local rep="";
    for rep in  ${base_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make ${PARALLEL} build ||  die 1 "${FUNCNAME[*]} : Building Error at ${rep}: Please check the building error" ;
	    popd
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist";
	fi
    done
}



## REQUIRE
function init_require
{
    local rep="";
    for rep in  ${require_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make init ||  die 1 "${FUNCNAME[*]} : MAKE init ERROR at ${rep}: Please check it" ;
	    make vars
	    popd
	else
	    die 1 "${rep} doesn't exist. Please make sure \"make greq\" first"
	fi
	printf "\n";
    done
}



## REQUIRE
function init2_require
{
    local rep="";
    for rep in  ${require_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make_init2 ||  die 1 "${FUNCNAME[*]} : MAKE init ERROR at ${rep}: Please check it" ;
	    make vars
	    popd
	else
	    die 1 "${rep} doesn't exist. Please make sure \"make greq\" first"
	fi
	printf "\n";
    done
}


## REQUIRE
function devinit_require
{
    local rep="";
    for rep in  ${require_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make devinit ||  die 1 "${FUNCNAME[*]} : MAKE init ERROR at ${rep}: Please check it" ;
	    make devvars;
	    popd
	else
	    die 1 "${rep} doesn't exist. Please make sure \"make greq\" first"
	fi
	printf "\n";
    done
}



## REQUIRE
# $1 : "TRUE" : git clone
#    "        : skip clone
function setup_require
{
    local git_status=$1; shift;
    clone_require "${git_status}" ;
    init_require;
}


## REQUIRE
# $1 : "TRUE" : git clone
#    "        : skip clone
function devsetup_require
{
    local git_status=$1; shift;
    clone_require "${git_status}" ;
    devinit_require;
}



## REQUIRE
function build_require
{
    local rep="";
    for rep in  ${require_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make -s build   ||  die 1 "${FUNCNAME[*]} : Building Error at ${rep}: Please check the building error" ;
	    make -s install ||  die 1 "${FUNCNAME[*]} : MAKE INSTALL ERROR at ${rep}: Please check it" ;
	    popd
	else
	    die 1 "${rep} doesn't exist";
	fi
    done

    generate_setenv;
}

## REQUIRE
function devbuild_require
{
    local rep="";
    for rep in  ${require_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make devbuild   ||  die 1 "${FUNCNAME[*]} : Building Error at ${rep}: Please check the building error" ;
	    make devinstall ||  die 1 "${FUNCNAME[*]} : MAKE INSTALL ERROR at ${rep}: Please check it" ;
	    popd
	else
	    die 1 "${rep} doesn't exist";
	fi
    done
    generate_setenv;
}



## init_modules and init2_modules are needed
## to be installed before. 
function init_modules
{
    local rep="";
    # git credential cache set to 30 mins (enough) in order to minimize the same password, and username again again
    # in bitbucket and gitlab.esss.se
#    git config credential.helper 'cache --timeout=1800'
    for rep in  ${module_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make init ||  die 1 "${FUNCNAME[*]} : MAKE init ERROR at ${rep}: Please check it" ; 
	    make patch
	    make vars
	    popd
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist. Please make sure \"make -g all gmod\" first";
	fi
	printf "\n";
    done
    # git credential exit, so we clear 30 mins cache
#    git credential-cache exit
    
}


function init2_modules
{
    local rep="";
    # git credential cache set to 30 mins (enough) in order to minimize the same password, and username again again
    # in bitbucket and gitlab.esss.se
 #   git config credential.helper 'cache --timeout=1800'
    for rep in  ${module_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    isItLocal=$(find -type d -name "*loc")
	    if [[ $(checkIfVar "${isItLocal}") -eq "NON_EXIST" ]] ; then
		make_init2 ||  die 1 "${FUNCNAME[*]} : MAKE init ERROR at ${rep}: Please check it" ;
		printf ">>>>     The %s has the REMOTE sources.\n" "${rep}"
	    else
		printf ">>>>     The %s has the LOCAL sources.\n" "${rep}"
	    fi
	    make patch
	    make vars
	    popd
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist. Please make sure \"make -g all gmod\" first";
	fi
	printf "\n";
    done
    # git credential exit, so we clear 30 mins cache
  #  git credential-cache exit
    
}



function setup_modules
{
    local git_status=$1; shift;
    clone_modules "${git_status}";
    init_modules;
}

function build_modules
{
    local rep="";
    for rep in  ${module_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    make -s ${PARALLEL} build    ||  die 1 "${FUNCNAME[*]} : Building Error at ${rep}: Please check the building error" ;
	    make -s install  ||  die 1 "${FUNCNAME[*]} : MAKE INSTALL ERROR at ${rep}: Please check it" ;
	    popd
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist";
	fi
	printf "\n";
    done
    generate_setenv;

}





#
# module name, configure/MODULES,
# sometimes is different in EPICS_MODULE_NAME in module/configure/CONFIG
# for example, sequencer
# module name       is sequencer
# EPICS_MODULE_NAME is seq

function module_loading_test_on_iocsh
{
    pushd ${SC_TOP}/e3-require
    make requireconf
    source tools/setE3Env.bash
    popd
    
    local IOC_TEST=$(mktemp)
    
    {
	local PREFIX_MODULE="EPICS_MODULE_NAME:="
	local PREFIX_LIBVERSION="E3_MODULE_VERSION:="
	local mod=""
	local ver=""
	printf "var requireDebug 1\n";
	for rep in  ${module_list[@]}; do
	    while read line; do
		if [[ $line =~ "${PREFIX_LIBVERSION}" ]] ; then
		    ver=${line#$PREFIX_LIBVERSION}
		elif [[ $line =~ "${PREFIX_MODULE}" ]] ; then
		    mod=${line#$PREFIX_MODULE}
		fi
	    done < ${SC_TOP}/${rep}/configure/CONFIG_MODULE
	    if [ "${mod}" = "StreamDevice" ]; then
		mod="stream"
	    fi
	    if [ "${mod}" = "ethercatmc" ]; then
		mod="EthercatMC"
	    fi
	    printf "#\n#\n"
	    printf "# >>>>> MODULE Loading ........\n";
	    printf "# >>>>> MODULE NAME ..... ${mod}\n";
	    printf "# >>>>>        VER  ..... ${ver}\n";
	    printf "require ${mod},${ver}\n";
	    printf "# >>>>>\n";
	    printf "#\n#\n"
	done
	
    }  > ${IOC_TEST}

    exec iocsh.bash ${IOC_TEST}

    

}



function generate_startup_script
{
    
    local IOC_TEST=${SC_TOP}/.cmd

    printf "Generating a startup script ... in $IOC_TEST\n";
    
    {
	local PREFIX_MODULE="EPICS_MODULE_NAME:="
	local PREFIX_LIBVERSION="E3_MODULE_VERSION:="
	local mod=""
	local ver=""
	local etherlab_lib=/opt/etherlab/lib/libethercat.so
	local load_cmd="dlload"
	printf "${load_cmd} ${etherlab_lib}\n";
	
	for rep in  ${module_list[@]}; do
	    while read line; do
		if [[ $line =~ "${PREFIX_LIBVERSION}" ]] ; then
		    ver=${line#$PREFIX_LIBVERSION}
		elif [[ $line =~ "${PREFIX_MODULE}" ]] ; then
		    mod=${line#$PREFIX_MODULE}
		fi
	    done < ${SC_TOP}/${rep}/configure/CONFIG_MODULE
	    if [ "${mod}" = "StreamDevice" ]; then
		mod="stream"
	    fi
	    if [ "${mod}" = "ethercatmc" ]; then
		mod="EthercatMC"
	    fi
	    printf "require ${mod},${ver}\n";
	    printf "\n";
	done
	
    }  > ${IOC_TEST}

    
}


function generate_setenv
{
    local E3ENVFILE=""
    local SETENV="${SC_TOP}/tools/setenv"
    local modules_path=$(make -C ${SC_TOP}/e3-require/ vars |grep ^E3_MODULES_PATH | cut -f 3 -d ' ')
    local module_name=$(make -C ${SC_TOP}/e3-require/ vars |grep ^E3_MODULE_NAME | cut -f 3 -d ' ')
    local module_version=$(make -C ${SC_TOP}/e3-require/ vars |grep ^E3_MODULE_VERSION | cut -f 3 -d ' ')
    local E3ENVFILE=${modules_path}/${module_name}/${module_version}/bin/setE3Env.bash

    printf ">>\n"
    if [[ $(checkIfFile "${SETENV}") -eq "EXIST" ]]; then
	printf "  We've found the existent %s\n" "${SETENV}"
	printf "  Rename it to %s\n" "${SETENV}_${SC_LOGDATE}"
	printf "  Still, it can be used in order to set old existent e3.\n";
	mv ${SETENV} ${SETENV}_${SC_LOGDATE}
    fi
    printf ">>\n";
    printf "  Creating %s .... \n" ${SETENV}
    printf "  Please, source it, if one would like to activate latest installed e3.\n";
    printf "  source tools/setenv \n"
    echo "source ${E3ENVFILE}"  > ${SETENV};
}

function all_base
{
    clean_base;
    setup_base;
    build_base;
}

function all_require
{
    clean_require;
    setup_require;
    build_require;
}


function devall_require
{
    clean_require;
    devsetup_require;
    devbuild_require;
}



function all_modules
{
    local N="$1";shift;
    clean_modules;
    setup_modules;
    build_modules "$N";
}


function all2_all
{
    local answer="$1"; shift;
    local N="$1";shift;
    clean_all;
    clone_all;
    init2_base "${answer}";
    build_base;
    init2_require;
    build_require;
    init2_modules;
    build_modules "$N";
}


function all_all
{
    local answer="$1"; shift;
    local N="$1";shift;
    clean_all;
    clone_all;
    init_base "${answer}";
    build_base;
    init_require;
    build_require;
    init_modules;
    build_modules "$N";
}




function configuration_update_modules
{
    local rep="";
    for rep in  ${module_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    printf "We are updating the configuration for %s\n", "${rep}"
	    e3TemplateGenerator -u ${rep}
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist";
	fi
	printf "\n";
    done

}



function git_diff_modules
{
    local rep="";
    for rep in  ${module_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    printf "We are updating the configuration for %s\n", "${rep}"
	    pushd ${rep}
	    git diff
	    popd
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist";
	fi
	printf "\n";
    done

}




function show_tag
{
    local rep="";
    local prefix="e3-";
    
    foo=${string#"$prefix"}
    
    for rep in  ${module_list[@]}; do
	if [[ $(checkIfDir "${rep}") -eq "$EXIST" ]]; then
	    pushd ${rep}
	    atag=$(git describe --tags `git rev-list --tags --max-count=1`)
	    printf "<project path=\"0.00.000.%s\" name=\"%s\" revision=\"refs/tags/%s\" groups=\"\" />" "${rep#"$prefix"}" "$rep" "$atag";
	    popd
	else
	    die 1 "${FUNCNAME[*]} : ${rep} doesn't exist";
	fi
	printf "\n";
    done

}



function usage
{
    usage_title;
    usage_mod;

    {
	echo " < option > ";
	echo "";
      	echo "           env    : Print enabled Modules";
	echo ""
	echo "           call   : Clean all (base, require, selected module group)";
	echo "           gall   : Clone all (base, require, selected module group)";
	echo "            all   : call, gall, ibase, bbase, ireq, breq, imod, bmod";
	echo ""
	echo "           cbase  : Clean Base";
	echo "           gbase  : Clone Base";
	echo "           ibase  : Init  Base ";
	echo "           bbase  : Build, Install Base";
	echo "            base  : cbase, gbase, ibase, bbase";
	echo ""           
	echo "           creq   : Clean Require";
	echo "           greq   : Clone Require";
	echo "           ireq   : Init  Require";
	echo "           breq   : Build, Install Require";
	echo "            req   : creq, greq, ireq, breq";
	echo ""           
	echo "           cmod   : Clean Modules (selected module group)";
	echo "           gmod   : Clone Modules (selected module group)";
	echo "           imod   : Init  Modules (selected module group)";
	echo "           bmod   : Build, Install Modules (selected module group)";
	echo "            mod   : cmod, gmod, imod, bmod";
	echo ""
	echo "        co_base \"_check_out_name_\" : Checkout Base";
	echo "         co_req \"_check_out_name_\" : Checkout Require";
	echo "         co_mod \"_check_out_name_\" : Checkout Modules  (selected module group)";
	echo "         co_all \"_check_out_name_\" : co_base, co_req, co_mod";
	echo ""
	echo "          vbase   : Print BASE    Version Information in e3-*";
	echo "           vreq   : Print REQUIRE Version Information in e3-*";
	echo "           vmod   : Print MODULES Version Information in e3-*";
	echo "           vall   : Print ALL     Version Information in e3-*";
	echo "           vins   : Print INSTALLED Version Information for locally installed e3 modules";
	echo "          vdep    : Print module depedency names and versions.";
	echo "";
	echo "         allall   : Print ALL Version Information in e3-* by using \"make vars\"";
	echo "";
       	echo "           load   : Load all installed Modules into iocsh.bash";
	echo "           cmd    : create .cmd file in ${SC_TOP}";
	echo "        setenv    : create setenv in ${SC_TOP}/tools";
	echo "";
	echo "           vers   : Print Source Tag / Module Versions";
	echo "            dep   : Print DEP_VERSION information";
	echo "        plotdep   : Plot the naive module depdendency drawing";
	echo "      closeplot   : Close all active opened plots";
	echo "";
	echo "           tags   : Print the latest tag for a repo manifest";
	echo ""
	echo ""           
	echo ""    
	
	echo "  Examples : ";
	echo ""
	echo "          $0 creq "
	echo "          $0 -ctpifealb cmod";
	echo "          $0 -t env";
	echo "          $0 base";
        echo "          $0 req";
	echo "          $0 -e cmod";
	echo "          $0 -t load";
	echo "   ";       
	echo "";
	
    } 1>&2;
    exit 1; 
}




while getopts "${options}" opt; do
    case "${opt}" in
	c) common="1"  ;;
	t) timing="1"  ;;
	p) psi="1"     ;;
	i) ifcfree="1" ;;
	f) ifcnfree="1";;
	e) ecat="1"    ;;
	a) area="1"    ;;
	l) llrf="1"    ;;
	b) bi="1"      ;;
	4) epicsv4="1" ;;
	d) develop="1" ;;
	o) only="1"    ;;
	*) usage ;;
    esac
done
shift $((OPTIND-1)) # remove parsed options and args from $@ list

module_list_func


# print_list

case "$1" in

    *mod) 
	echo ">> Selected Modules are :"
	echo ${module_list[@]}
	echo ""
	;;
    *all) 
	echo ">> Selected Modules are :"
	echo ${module_list[@]}
	echo ""
	;;
    *)
	;;

esac

filter="pkg"

arg=$2

if test "${arg#*$filter}" != "$arg"; then
   ANSWER="YES"
fi

filter2="para"
if test "${arg#*$filter2}" != "$arg"; then
   PARALLEL="-j -l 4"
fi


case "$1" in
    env)   print_module_list ;;
    vars)  print_module_list ;;
    # all : clean, clone, init, build, and all
    clean) clean_all     ;;
    call)  clean_all     ;;
    gall)  clone_all     ;;
    # BASE : clean, clone, init, build, and all
    cbase) clean_base    ;;
    gbase) clone_base    ;;
    ibase)   init_base   ;;
    i2base)  init2_base  ;;
    bbase) build_base   ;;
    base)    all_base   ;;
    # REQUIRE : clean, clone, init, build, and all
    creq)      clean_require ;;
    greq)      clone_require ;;
    ireq)       init_require ;;
    i2req)     init2_require ;;
    devireq) devinit_require ;;
    breq)      build_require ;;
    req)         all_require ;;
    devreq)   devall_require ;;
    # MODULES : clean, clone, init, build, and all
    cmod)  clean_modules ;;
    gmod)  clone_modules ;;
    imod)   init_modules ;;
    i2mod) init2_modules ;;
    bmod)  build_modules ;;
    mod)     all_modules ;;
    pmod)    git_pull_modules ;;
    # Git Checkout 
    co_base) git_checkout_base    "$2";;
    co_req)  git_checkout_require "$2";;
    co_mod)  git_checkout_modules "$2";;
    co_all)  git_checkout_all     "$2";;
    # GIT Commands 
    pull)   git_pull_all    ;;
    add)    git_add    "$2" ;;
    commit) git_commit "$2" ;;
    push)   git_push        ;;
    # Module Loading Test
    load) module_loading_test_on_iocsh;;
    # Module Loading Test Startup Script for Travis-ci
    cmd)       generate_startup_script;;
    setenv)    generate_setenv;;
    # Print Version Information in e3-* directory
    vbase) print_version_info_base    ;;
    vreq)  print_version_info_require ;;
    vmod)  print_version_info_modules ;;
    vall)  print_version_info_all     ;;
    vins)  print_installed_modules    ;;
    vdep)  print_depend_modules    ;;
    # Call *make vars in each e3-* directory
    allall)    print_version_really_everything   ;;
    cupdate)   configuration_update_modules ;;
    gitdiff)   git_diff_modules ;;
    checksudo) check_sudo_permission_needed ;;
    # show version and depdendcy
    vers)      exec_makefile_rule "vers";;
    dep)       exec_makefile_rule "dep";;
    plotdep)   exec_makefile_rule "plotdep";;
    closeplot) exec_makefile_rule "closeplot";;
    # show the latest tag
    tags)      show_tag ;;
    *)         usage;;
esac

exit 0;