pfSense

#!/bin/sh

#-

# Copyright (c) 2010 iXsystems, Inc.  All rights reserved.

#

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions

# are met:

# 1. Redistributions of source code must retain the above copyright

#    notice, this list of conditions and the following disclaimer.

# 2. Redistributions in binary form must reproduce the above copyright

#    notice, this list of conditions and the following disclaimer in the

#    documentation and/or other materials provided with the distribution.

#

# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND

# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE

# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

# SUCH DAMAGE.

#

# $FreeBSD: src/usr.sbin/pc-sysinstall/backend/functions-parse.sh,v 1.2 2010/06/27 16:46:11 imp Exp $

# functions.sh

# Library of functions which pc-sysinstall may call upon for parsing the config

# which gets the value of a setting in the provided line

get_value_from_string()

{

  if [ ! -z "${1}" ]

  then

    VAL="`echo ${1} | cut -d '=' -f 2`"

    export VAL

  else

    echo "Error: Did we forgot to supply a string to parse?"

    exit 1

  fi

};

# Get the value from the cfg file including spaces

get_value_from_cfg_with_spaces()

{

  if [ ! -z "${1}" ]

  then

    VAL=`grep "^${1}=" ${CFGF} | head -n 1 | cut -d '=' -f 2`

    export VAL

  else

    exit_err "Error: Did we forgot to supply a setting to grab?"

  fi

};

# Get the value from the cfg file

get_value_from_cfg()

{

  if [ ! -z "${1}" ]

  then

    VAL=`grep "^${1}=" ${CFGF} | head -n 1 | cut -d '=' -f 2 | tr -d ' '`

    export VAL

  else

    exit_err "Error: Did we forgot to supply a setting to grab?"

  fi

};

# Checks the value of a setting in the provided line with supplied possibilities

# 1 = setting we are checking,  2 = list of valid values

if_check_value_exists()

{

  if [ ! -z "${1}" -a ! -z "${2}" ]

  then

    # Get the first occurance of the setting from the config, strip out whitespace

    VAL=`grep "^${1}" ${CFGF} | head -n 1 | cut -d '=' -f 2 | tr -d ' '`

    if [ -z "${VAL}" ]

    then

      # This value doesn't exist, lets return

      return 0

    fi

    VALID="1"

    for i in ${2}

    do

      if [ "$VAL" = "${i}" ]

      then 

        VALID="0"

      fi

    done 

    if [ "$VALID" = "1" ]

    then

      exit_err "Error: ${1} is set to unknown value $VAL"

    fi

  else

    exit_err "Error: Did we forgot to supply a string to parse and setting to grab?"

  fi

};

# Checks the value of a setting in the provided line with supplied possibilities

# 1 = setting we are checking,  2 = list of valid values

check_value()

{

  if [ ! -z "${1}" -a ! -z "${2}" ]

  then

    # Get the first occurance of the setting from the config, strip out whitespace

    VAL=`grep "^${1}" ${CFGF} | head -n 1 | cut -d '=' -f 2 | tr -d ' '`

    VALID="1"

    for i in ${2}

    do

      if [ "$VAL" = "${i}" ]

      then 

        VALID="0"

      fi

    done 

    if [ "$VALID" = "1" ]

    then

      exit_err "Error: ${1} is set to unknown value $VAL"

    fi

  else

    exit_err "Error: Did we forgot to supply a string to parse and setting to grab?"

  fi

};

# Checks for the presense of the supplied arguements in the config file

# 1  = values to confirm exist

file_sanity_check()

{

  if [ ! -z "$CFGF" -a ! -z "$1" ]

  then

    for i in $1

    do

       grep "^${i}=" $CFGF >/dev/null 2>/dev/null

       if [ "$?" = "0" ]

       then

         LN=`grep "^${i}=" ${CFGF} | head -n 1 | cut -d '=' -f 2 | tr -d ' '`

         if [ -z "${LN}" ]

         then

           echo "Error: Config fails sanity test! ${i}= is empty"

           exit 1

         fi

       else

         echo "Error: Config fails sanity test! Missing ${i}="

         exit 1

       fi

    done

  else

    echo "Error: Missing config file, and / or values to sanity check for!"

    exit 1

  fi

};

# Function which merges the contents of a new config into the specified old one

# Only works with <val>= type configurations

merge_config()

{

  OLDCFG="${1}"

  NEWCFG="${2}"

  FINALCFG="${3}"

  # Copy our oldcfg to the new one, which will be used as basis

  cp ${OLDCFG} ${FINALCFG}

  # Remove blank lines from new file

  cat ${NEWCFG} | sed '/^$/d' > ${FINALCFG}.tmp

  # Set our marker if we've found any

  FOUNDMERGE="NO"

  while read newline

  do

   echo ${newline} | grep "^#" >/dev/null 2>/dev/null

   if [ "$?" != "0" ] ; then

     VAL="`echo ${newline} | cut -d '=' -f 1`"

     cat ${OLDCFG} | grep ${VAL} >/dev/null 2>/dev/null

     if [ "$?" != "0" ] ; then

       if [ "${FOUNDMERGE}" = "NO" ] ; then

         echo "" >> ${FINALCFG}

         echo "# Auto-merged values from newer ${NEWCFG}" >> ${FINALCFG}

         FOUNDMERGE="YES"

       fi

       echo "${newline}" >> ${FINALCFG}

     fi

   fi

  done < ${FINALCFG}.tmp

  rm ${FINALCFG}.tmp

};

# Loop to check for a specified mount-point in a list

check_for_mount()

{

  MNTS="${1}"

  FINDMNT="${2}"

  # Check if we found a valid root partition

  for CHECKMNT in `echo ${MNTS} | sed 's|,| |g'`

  do

    if [ "${CHECKMNT}" = "${FINDMNT}" ] ; then

      return 0

    fi

  done

  return 1

};

# Function which returns the next line in the specified config file

get_next_cfg_line()

{

  CURFILE="$1"

  CURLINE="$2"

  FOUND="1"

  while read line

  do

    if [ "$FOUND" = "0" ] ; then

      VAL="$line" ; export VAL

      return

    fi

    if [ "$line" = "${CURLINE}" ] ; then

      FOUND="0"

    fi

  done <${CURFILE}

  # Got here, couldn't find this line or at end of file, set VAL to ""

  VAL="" ; export VAL

};