#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | Copyright (C) 2008-2010 OpenCFD Ltd.
#    \\/     M anipulation  |
#-------------------------------------------------------------------------------
# License
#     This file is part of OpenFOAM.
#
#     OpenFOAM 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 3 of the License, or
#     (at your option) any later version.
#
#     OpenFOAM 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 OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
#
# Script
#     foamEtcFile
#
# Description
#     Locate user/group/shipped file with semantics similar to the
#     ~OpenFOAM/fileName expansion.
#
#     The -mode option can be used to allow chaining from
#     personal settings to site-wide settings.
#
#     For example, within the user ~/.OpenFOAM/<VER>/prefs.sh:
#     @verbatim
#        foamPrefs=`$WM_PROJECT_DIR/bin/foamEtcFile -m go prefs.sh` \
#            && _foamSource $foamPrefs
#     @endverbatim
#
#-------------------------------------------------------------------------------
unset listOpt quietOpt

usage() {
    [ "$quietOpt" = true ] && exit 1

    exec 1>&2
    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
    cat<<USAGE

Usage: ${0##*/} [OPTION] fileName
       ${0##*/} [OPTION] -list
options:
  -list             list the directories to be searched
  -mode <mode>      any combination of u(user), g(group), o(other)
  -quiet            suppress all normal output
  -help             print the usage

  Locate user/group/shipped file with semantics similar to the
  ~OpenFOAM/fileName expansion.

  The options can also be specified as a single character
  (eg, '-q' instead of '-quiet'), but must not be grouped.

  Exit status
      0  when the file is found. Print resolved path to stdout.
      1  for miscellaneous errors.
      2  when the file is not found.

USAGE
    exit 1
}


# default mode is 'ugo'
mode=ugo

# parse options
while [ "$#" -gt 0 ]
do
    case "$1" in
    -h | -help)
        usage
        ;;
    -l | -list)
        listOpt=true
        shift
        ;;
    -m | -mode)
        [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
        mode="$2"

        # sanity check:
        case "$mode" in
        *u* | *g* | *o* )
           ;;
        *)
           usage "'$1' option with invalid mode '$mode'"
           ;;
        esac
        shift 2
        ;;
    -q | -quiet)
        quietOpt=true
        shift
        ;;
    -*)
        usage "unknown option: '$*'"
        ;;
    *)
        break
        ;;
    esac
done

# Save the essential bits of information:
nArgs=$#
fileName="$1"

# Define the various places to be searched:
unset dirList
case "$mode" in
*u*)  # user
    dirList="$dirList $HOME/.${WM_PROJECT:-OpenFOAM}/$WM_PROJECT_VERSION"
    dirList="$dirList $HOME/.${WM_PROJECT:-OpenFOAM}"
    ;;
esac

case "$mode" in
*g*)  # group
    dirList="$dirList $WM_PROJECT_INST_DIR/site/$WM_PROJECT_VERSION"
    dirList="$dirList $WM_PROJECT_INST_DIR/site"
    ;;
esac

case "$mode" in
*o*)  # other
    dirList="$dirList $WM_PROJECT_DIR/etc"
    ;;
esac
set -- $dirList


#
# The main routine
#

if [ "$listOpt" = true ]
then

    # list directories, or potential file locations
    [ "$nArgs" -le 1 ] || usage

    # a silly combination, but -quiet has precedence
    [ "$quietOpt" = true ] && exit 0

    for dir
    do
        if [ "$nArgs" -eq 1 ]
        then
            echo "$dir/$fileName"
        else
            echo "$dir"
        fi
    done
    exit 0

else

    [ "$nArgs" -eq 1 ] || usage

    for dir
    do
        if [ -f "$dir/$fileName" ]
        then
            [ "$quietOpt" = true ] || echo "$dir/$fileName"
            exit 0
        fi
    done

fi


# general error, eg file not found
exit 2

#------------------------------------------------------------------------------