#!/bin/bash
#
# cli_printMessage.sh -- This function outputs information in
# predifined formats. This function (cli_printMessage) is the standard
# way to output information inside centos-art.sh script.
#
# cli_printMessage $1 $2
# $1 --> The message you want to output.
# $2 --> The message format.
#
# Copyright (C) 2009-2011 Alain Reguera Delgado
# 
# This 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 (at your option) any later 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA.
# 
# ----------------------------------------------------------------------
# $Id$
# ----------------------------------------------------------------------

function cli_printMessage {

    # Define variables as local to avoid conflicts outside.
    local MESSAGE="$1"
    local FORMAT="$2"
    local Y=''
    local N=''
    local ANSWER=''

    # Reduce paths inside output messages. The main purpose for this
    # is to free horizontal space in output messages.
    MESSAGE=$(echo "$MESSAGE" \
        | sed -r 's!/home/centos/artwork/(trunk|branches|tags)/!\1/!g')

    # Remove blank spaces from lines' begining.
    MESSAGE=$(echo "$MESSAGE" | sed -r 's!^[[:space:]]+!!')

    # Define message formats.
    case $FORMAT in

        'AsHeadingLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo '----------------------------------------------------------------------'
                echo "$MESSAGE" | fmt --width=70
                echo '----------------------------------------------------------------------'
            fi
            ;;

        'AsWarningLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo '----------------------------------------------------------------------'
                echo "`gettext "WARNING"`: $MESSAGE" | fmt --width=70
                echo '----------------------------------------------------------------------'
            fi
            ;;

        'AsNoteLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo '----------------------------------------------------------------------'
                echo "`gettext "NOTE"`: $MESSAGE" | fmt --width=70
                echo '----------------------------------------------------------------------'
            fi
            ;;

        'AsUpdatingLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Updating"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsDeletingLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Deleting"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsCheckingLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Checking"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsCreatingLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Creating"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsSavedAsLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Saved as"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsLinkToLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Linked to"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsMovedToLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Moved to"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsTranslationLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Translation"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsDesignLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Design"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsConfigurationLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Configuration"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsPaletteLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "`gettext "Palette"`: $MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        'AsResponseLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "--> $MESSAGE"
            fi
            ;;

        'AsRequestLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo -n "${MESSAGE}: "
            fi
            ;;

        'AsSeparatorLine' )

            # Define separator lenght.
            local MAX=70

            if [[ $FLAG_QUIET == 'false' ]];then

                # Draw separator line.
                until [[ $MAX -eq 0 ]];do
                    echo -n "${MESSAGE}"
                    MAX=$(($MAX - 1))
                done

                # Output newline to end separator.
                echo

            fi
            ;;

        'AsYesOrNoRequestLine' )
            # Define positive answer.
            Y="`gettext "y"`"

            # Define negative answer.
            N="`gettext "N"`"

            # Define `yes or no' confirmation question.
            if [[ $FLAG_QUIET == 'false' ]] \
                && [[ $FLAG_YES == 'false' ]];then
                echo -n "$MESSAGE [${Y}/${N}]: "
                read ANSWER
            fi

            # Redefine answer based on answer flag.
            if [[ $FLAG_YES == 'true' ]];then
                ANSWER=${Y}
            fi

            # Verify answer.
            if [[ ! $ANSWER =~ "^${Y}" ]];then
                exit
            fi
            ;;

        'AsErrorLine' )
            # Add script name to message. We want to know where
            # messages come from. The `--quiet' flag doesn't suppress
            # error messages.
            echo "${CLINAME}: ${MESSAGE}"
            ;;

        'AsToKnowMoreLine' )
            # This option receives the output of bash's caller builtin
            # as message value, in order to produce the documentation
            # entry automatically. The `--quiet' flag doesn't suppress
            # `as to know more' messages.
            MESSAGE=$(dirname $(echo $MESSAGE | cut -d ' ' -f2-))
            echo "----------------------------------------------------------------------"
            echo "`gettext "To know more, run the following command"`:"
            echo "centos-art manual --read='$MESSAGE'"
            echo "----------------------------------------------------------------------"
            exit # <-- ATTENTION: Do not remove this line. We use this
                 #                case as convenction to end script
                 #                execution.
            ;;

        'AsRegularLine' )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "$MESSAGE" \
                    | awk -f /home/centos/artwork/trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
            fi
            ;;

        * )
            if [[ $FLAG_QUIET == 'false' ]];then
                echo "$MESSAGE"
            fi
            ;;

    esac

}