#!/bin/sh
#----------------------------------------------------------------------------
# /var/install/bin/add-menu - add a menu entry / modify a menu entry
#
# Creation:	    2001-11-04  fm
# Last Update:  $Id$
#
# Copyright (c) 2001-@@YEAR@@ the eisfair team, team(at)eisfair(dot)org
#
# Usage:
#
# old style version (for non XML-menus)
# -------------------------------------
#
# add-menu menu-file shell-script comment
#
#          menu-file     absolute filename of menu-file
#
#                        The new entry
#                          shell-script comment
#                        is added to the end of the menu-file
#                        if such a line does not already exist.
#
#          shell-script  absolute filename of a shell-script
#
#                        This shell-scripts is called e.g. to
#                        display a new menu.
#
#          comment       comment to display in the menu
#
# new style version (for XML-menus)
# ---------------------------------
#
# add-menu [--menu] [opt-parameter] menu-file sub-menu-file comment
# add-menu --script [opt-parameter] menu-file script-file comment
#
#          --menu         add <menu>-Tag   [default]
#          --script       add <script>-Tag instead of <menu>-Tag
#
#        optional parameter:
#          --quiet        suppress all normal output
#
#          --package package
#                         add package="package" attribute
#                         See description below!
#
#          --pre pre-skript
#                         add pre="pre-script" attribute
#
#          --post post-script
#                         add post="post-script" attribute
#
#          menu-file      filename relativ to menupath /var/install/menu
#
#                         If the entry does not exist:
#                            The new entry is added to this menu.
#                         If the entry does exists:
#                            The entry will be modified.
#
#          sub-menu-file  filename relativ to menupath /var/install/menu
#
#                         The new entry
#                             <menu file="sub-menu-file">comment</menu>
#                         is added to the end of the menu-file
#                         if such a line does not already exist.
#
#          script-file    filename relativ to /var/install/bin or absolute path
#
#                         The new entry
#                             <script file="script-file">comment</script>
#                         is added to the end of the menu-file
#                         if such a line does not already exist.
#
#          comment        text to display in the menu
#
#          menu-file and sub-menu-file/script-file and comment have to be
#          the last parameters.
#
#     Additional description:
#     A menu file (example.menu) containing the following lines
#       <package mainpackage>
#       <menu                      file="sub.menu">Handling for mainpackage configuration</menu>
#       <menu package="subpackage" file="sub.menu">Handling for subpackage configuration</menu>
#     is a valid menu.
#
#     To create the two menu lines use
#       add-menu                      example.menu sub.menu 'Handling for mainpackage configuration'
#       add-menu --package subpackage example.menu sub.menu 'Handling for subpackage configuration'
#
#     To modify the two menu lines use
#       add-menu                      example.menu sub.menu 'New handling for mainpackage configuration'
#       add-menu --package subpackage example.menu sub.menu 'Advanced handling for subpackage configuration'
#
#       The optional parameter --package becomes mandatory to identify
#       the correct line.
#
#       Result:
#       <menu                      file="sub.menu">New handling for mainpackage configuration</menu>
#       <menu package="subpackage" file="sub.menu">Advanced handling for subpackage configuration</menu>
#
#     Using --pre pre-skript and/or --post post-script you can add lines
#     containg pre="pre-skript" post="post-script" arguments.
#     These values can be modified by a following add-menu call.
#     To modify package="xxx" arguments or add a package="xxx" argument
#     you have to delete the line using del-line an add it with the
#     --package package argument or the initial --package package argument
#     using add-menu.
#
# 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.
#----------------------------------------------------------------------------

# include eislib etc
. /var/install/include/eislib

XMLSPLIT='/usr/bin/xmlsplit'
SED='/usr/bin/sed'
GREP='/usr/bin/grep'

pre_script_attr=''
post_script_attr=''
package_attr=''

tag='menu'
xml_tag='MENU' # used by xmlsplit
menu_path='/var/install/menu'
bin_path='/var/install/bin'

#debug=true

if ${debug:-false}
then
    exec 2>/tmp/$(basename ${0})-trace$$.log
    set -x
    ask_debug=true
    export ask_debug
fi

# ---------------------------------------------------------------------------
# work
# ---------------------------------------------------------------------------
work()
{
    if [ -f "${menu_path}/${menu_file}" ]
    then
        # new behavior XML-Menu

        # build new line
        new_line="<${tag} ${package_attr}${pre_script_attr}${post_script_attr}file=\"${menu_cmd}\">${menu_text}</${tag}>"

        # grep old lines
        old_line=$(${GREP} " file=\"${menu_cmd}\"" ${menu_path}/${menu_file})

        # extract correct line if <menu and <script exist, in fact not possible
        old_line=$(echo "${old_line}" | ${GREP} "<${tag} ")

        if [ -n "${package_attr}" ]
        then
            # extract correct line using package attribut
            old_line=$(echo "${old_line}" | ${GREP} "${package_attr}")
        else
        # extract line without package attribut
            old_line=$(echo "${old_line}" | ${GREP} -v 'package=')
        fi

        # check if more than ONE line
        count=$(echo "${old_line}" | wc -l)
        if [ ${count:-0} -gt 1 ]
        then
            myecho --error "Error add-menu: duplicate lines / scrambled menu-file (${count}/1)"
            exit 1
        fi

        # check if old_line discovered
        if [ -n "${old_line}" ]
        then
            # line does exist

            # split line
            temp=$(${XMLSPLIT} "${old_line}" ${xml_tag} PACKAGE FILE PRE POST)
            rc=$?
            if [ ${rc} -ne 0 ]
            then
                myecho --error "Error add-menu: splitting menu-line (${rc}/0)"
                exit 1
            fi

            # set environment variables
            eval "declare ${temp}"

            # assume no changes
            has_changes=0

            # check changes
            if [ "${XMLSPLIT_TAG}" != "${menu_text}" ]
            then
                has_changes=1
            fi
            if [ "${XMLSPLIT_ATTR_PACKAGE}" != "${package}" ]
            then
                has_changes=1
            fi
            if [ "${XMLSPLIT_ATTR_POST}" != "${post_script}" ]
            then
                has_changes=1
            fi
            if [ "${XMLSPLIT_ATTR_PRE}" != "${pre_script}" ]
            then
                has_changes=1
            fi

            if [ ${has_changes} != 0 ]
            then
                # change entry

                # delete / add mode
                # /var/install/bin/del-menu $menu_file $menu_cmd
                # echo "<$tag file=\"$menu_cmd\">$menu_text</$tag>" >>$menu_path/$menu_file

                # replace mode to preserve line position
                ${SED} -i "1,\$s|${old_line}|${new_line}|" ${menu_path}/${menu_file}
            fi
        else
            # line does not exists, add line
            echo "${new_line}" >>${menu_path}/${menu_file}
        fi

    else
        if [ -f ${menu_file} ]
        then
            # old behavior
            if ${GREP} -q "^${menu_cmd} " ${menu_file}
            then
                # tag does exist
                # check comment
                act_comment=$(${GREP} "^${menu_cmd} " ${menu_file} |
                              sed "s|${menu_cmd} ||")
                if [ "${act_comment}" = "${menu_text}" ]
                then
                    # no change
                    exit 0
                else
                    # change
                    /var/install/bin/del-menu ${menu_cmd} ${menu_file}
                    echo "${menu_cmd} ${menu_text}" >>${menu_file}
                fi
            else
                echo "${menu_cmd} ${menu_text}" >>${menu_file}
            fi
        else
            myecho --error "Error add-menu: menu-file ${menu_file} does not exist"
        exit 1
        fi
    fi
}

# ---------------------------------------------------------------------------
# myecho
# ---------------------------------------------------------------------------
myecho()
{
    if ! ${quiet:-false}
    then
        mecho ${1} "${2}"
    fi
}

# ---------------------------------------------------------------------------
# check numbers sof arguments
# ---------------------------------------------------------------------------
check_num_argv()
{
    local argv=${1}

    # check number of arguments
    if [ ${argv} -lt 3 ]
    then
        myecho --error "Error add-menu: too few arguments (${argv}/minimum 3)"
        exit 1
    fi
}

# ---------------------------------------------------------------------------
# main
# ---------------------------------------------------------------------------
main()
{
    check_num_argv ${#} 

    # check arguments
    while [ ${#} -gt 0 ]
    do
        case "${1}" in
        '--quiet')
            quiet=true
            shift
            ;;
        "--script"|"-script")
            shift
            tag='script'
            xml_tag='SCRIPT'
            ;;
        "--menu"|"-menu")
            shift
            tag='menu'
            xml_tag='MENU'
            ;;
        "--pre")
            shift
            pre_script="${1}"
            pre_script_attr="pre=\"${1}\" "
            shift
            ;;
        "--post")
            shift
            post_script="${1}"
            post_script_attr="post=\"${1}\" "
            shift
            ;;
        "--package")
            shift
            package="${1}"
            package_attr="package=\"${1}\" "
            shift
            ;;
        *)
            check_num_argv ${#} 

            menu_file="${1}"
            menu_cmd="${2}"
            shift 2
            menu_text="${*}"
            shift
            ;;
        esac
    done

    work
}

# ---------------------------------------------------------------------------
# call function main
# ---------------------------------------------------------------------------
main "${@}"

# ---------------------------------------------------------------------------
# end
# ---------------------------------------------------------------------------