foamPack

#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
#    \\/     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
#     foamPack [OPTION]
#
# Description
#     Pack and compress the OpenFOAM directory for release
#
#------------------------------------------------------------------------------
packDir=$WM_PROJECT-$WM_PROJECT_VERSION
toolsDir="${0%/*}/tools"  # this script is located in the tools/ parent dir

usage() {
    exec 1>&2
    while [ "$#" -gt 0 ]; do echo "$1"; shift; done
cat <<USAGE
Usage: ${0##*/} [OPTION]
options:
  -o, -output <dir>     specify alternative output directory
  -nogit                bypass using 'git archive'

* Pack and compress OpenFOAM directory for release

USAGE
    exit 1
}

unset outputDir nogit
# parse options
while [ "$#" -gt 0 ]
do
    case "$1" in
    -h | -help)
        usage
        ;;
    -nogit)
        nogit=true
        shift
        ;;
    -o | -output)
        [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
        outputDir=${2%%/}
        shift 2
        ;;
    -*)
        usage "unknown option: '$*'"
        ;;
    *)
        break
        ;;
    esac
done

# check for essential directories
[ -d $packDir ] || {
    echo "Error: directory $packDir does not exist" 1>&2
    exit 1
}


#------------------------------------------------------------------------------
timeStamp=$(date +%Y-%m-%d)
packExt=tgz
packBase=${packDir}_${timeStamp}

# add optional output directory
[ -d "$outputDir" ] && packBase="$outputDir/$packBase"
packFile=$packBase.$packExt

# avoid overwriting old pack file
if [ -f $packFile ]
then
    echo "Error: $packFile already exists" 1>&2
    exit 1
fi

# add time-stamp file before packing
echo $timeStamp 2>/dev/null > $packDir/.timeStamp

# check for git (program and .git directory)
(cd $packDir && git branch) > /dev/null 2>&1 || nogit=true

if [ "$nogit" = true ]
then
    echo "pack manually" 1>&2
    foamPackSource $packDir $packFile
else
    if [ ! -f $packDir/.build ]
    then
        echo "Error: $packDir/.build does not exists" 1>&2
        echo "       Please update this by running e.g. 'wmakePrintBuild -update' in $packDir" 1>&2
        exit 2
    fi


    echo "pack with git-archive" 1>&2 &&
    ( cd $packDir && git archive --format=tar --prefix=$packDir/ HEAD) > $packBase.tar &&

    echo "add in time-stamp and lnInclude directories" 1>&2 &&
    tar cf $packBase.tar2 $packDir/.timeStamp $packDir/.build `find -H $packDir -type d -name lnInclude` &&
    tar Af $packBase.tar $packBase.tar2 &&

    echo "gzip tar file" 1>&2 &&
    gzip -c9 $packBase.tar > $packFile &&
    rm -f $packBase.tar $packBase.tar2 2>/dev/null
fi

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