source: common/libs/func_validate_configs.sh@ 38d2de6

2.3 2.3.x 2.4 ablfs ablfs-more legacy new_features trunk
Last change on this file since 38d2de6 was 93346ee, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

LFS: Added support for installed files logs.
Should be ported to other books when verified that works as expected.
  • Property mode set to 100644
File size: 9.6 KB
Line 
1# $Id$
2
3declare -r dotSTR=".................."
4
5
6#----------------------------#
7validate_config() { # Are the config values sane (within reason)
8#----------------------------#
9: <<inline_doc
10 Validates the configuration parameters. The global var PROGNAME selects the
11 parameter list.
12
13 input vars: none
14 externals: color constants
15 PROGNAME (lfs,clfs,hlfs)
16 modifies: none
17 returns: nothing
18 on error: write text to console and dies
19 on success: write text to console and returns
20inline_doc
21
22 # First internal variables, then the ones that change the book's flavour, and lastly system configuration variables
23 local -r hlfs_PARAM_LIST="BOOK BUILDDIR SRC_ARCHIVE GETPKG RUNMAKE MODEL GRSECURITY_HOST TEST BOMB_TEST OPTIMIZE REPORT COMPARE RUN_ICA RUN_FARCE ITERATIONS STRIP FSTAB CONFIG GETKERNEL PAGE TIMEZONE LANG LC_ALL LUSER LGROUP LHOME BLFS_TOOL CUSTOM_TOOLS REBUILD_MAKEFILE"
24 local -r clfs_PARAM_LIST="BOOK BUILDDIR SRC_ARCHIVE GETPKG RUNMAKE METHOD ARCH TARGET TARGET32 TEST BOMB_TEST OPTIMIZE REPORT COMPARE RUN_ICA RUN_FARCE ITERATIONS STRIP FSTAB BOOT_CONFIG CONFIG GETKERNEL VIMLANG PAGE TIMEZONE LANG LUSER LGROUP LHOME BLFS_TOOL CUSTOM_TOOLS REBUILD_MAKEFILE"
25 local -r clfs2_PARAM_LIST="BOOK BUILDDIR SRC_ARCHIVE GETPKG RUNMAKE ARCH TARGET REPORT STRIP FSTAB CONFIG GETKERNEL VIMLANG PAGE TIMEZONE LANG LUSER LGROUP LHOME BLFS_TOOL CUSTOM_TOOLS REBUILD_MAKEFILE"
26 local -r clfs3_PARAM_LIST="BOOK BUILDDIR SRC_ARCHIVE GETPKG RUNMAKE ARCH PLATFORM TARGET MIPS_LEVEL REPORT FSTAB CONFIG GETKERNEL VIMLANG PAGE TIMEZONE LANG LUSER LGROUP LHOME CUSTOM_TOOLS REBUILD_MAKEFILE"
27 local -r lfs_PARAM_LIST="BOOK BUILDDIR SRC_ARCHIVE GETPKG RUNMAKE TEST BOMB_TEST INSTALL_LOG OPTIMIZE REPORT COMPARE RUN_ICA RUN_FARCE ITERATIONS STRIP FSTAB CONFIG GETKERNEL VIMLANG PAGE TIMEZONE LANG LUSER LGROUP LHOME BLFS_TOOL CUSTOM_TOOLS REBUILD_MAKEFILE"
28 local -r blfs_PARAM_LIST="BRANCH_ID BLFS_ROOT BLFS_XML TRACKING_DIR"
29
30 local -r blfs_tool_PARAM_LIST="BLFS_BRANCH_ID BLFS_ROOT BLFS_XML TRACKING_DIR DEP_LIBXML DEP_LIBXSLT DEP_TIDY DEP_UNZIP DEP_DBXML DEP_DBXSL DEP_LINKS DEP_SUDO DEP_WGET DEP_SVN DEP_GPM"
31 local -r custom_tool_PARAM_LIST="TRACKING_DIR"
32
33 local -r ERROR_MSG_pt1='The variable \"${L_arrow}${config_param}${R_arrow}\" value ${L_arrow}${BOLD}${!config_param}${R_arrow} is invalid,'
34 local -r ERROR_MSG_pt2='rerun make and fix your configuration settings${OFF}'
35 local -r PARAM_VALS='${config_param}${dotSTR:${#config_param}} ${L_arrow}${BOLD}${!config_param}${OFF}${R_arrow}'
36
37 local PARAM_LIST=
38 local config_param
39 local validation_str
40 local save_param
41
42 write_error_and_die() {
43 echo -e "\n${DD_BORDER}"
44 echo -e "`eval echo ${ERROR_MSG_pt1}`" >&2
45 echo -e "`eval echo ${ERROR_MSG_pt2}`" >&2
46 echo -e "${DD_BORDER}\n"
47 exit 1
48 }
49
50 validate_file() {
51 # For parameters ending with a '+' failure causes a warning message only
52 echo -n "`eval echo $PARAM_VALS`"
53 while test $# -gt 0 ; do
54 case $1 in
55 # Failures caused program exit
56 "-z") [[ -z "${!config_param}" ]] && echo "${tab_}<-- NO file name given" && write_error_and_die ;;
57 "-e") [[ ! -e "${!config_param}" ]] && echo "${tab_}<-- file does not exist" && write_error_and_die ;;
58 "-s") [[ ! -s "${!config_param}" ]] && echo "${tab_}<-- file has zero bytes" && write_error_and_die ;;
59 "-r") [[ ! -r "${!config_param}" ]] && echo "${tab_}<-- no read permission " && write_error_and_die ;;
60 "-w") [[ ! -w "${!config_param}" ]] && echo "${tab_}<-- no write permission" && write_error_and_die ;;
61 "-x") [[ ! -x "${!config_param}" ]] && echo "${tab_}<-- file cannot be executed" && write_error_and_die ;;
62 # Warning messages only
63 "-z+") [[ -z "${!config_param}" ]] && echo && return ;;
64 esac
65 shift 1
66 done
67 echo
68 }
69
70 validate_dir() {
71 # For parameters ending with a '+' failure causes a warning message only
72 echo -n "`eval echo $PARAM_VALS`"
73 while test $# -gt 0 ; do
74 case $1 in
75 "-z") [[ -z "${!config_param}" ]] && echo "${tab_}NO directory name given" && write_error_and_die ;;
76 "-d") [[ ! -d "${!config_param}" ]] && echo "${tab_}This is NOT a directory" && write_error_and_die ;;
77 "-w") if [[ ! -w "${!config_param}" ]]; then
78 echo "${nl_}${DD_BORDER}"
79 echo "${tab_}${RED}You do not have ${L_arrow}write${R_arrow}${RED} access to the directory${OFF}"
80 echo "${tab_}${BOLD}${!config_param}${OFF}"
81 echo "${DD_BORDER}${nl_}"
82 exit 1
83 fi ;;
84 # Warnings only
85 "-w+") if [[ ! -w "${!config_param}" ]]; then
86 echo "${nl_}${DD_BORDER}"
87 echo "${tab_}WARNING-- You do not have ${L_arrow}write${R_arrow} access to the directory${OFF}"
88 echo "${tab_} -- ${BOLD}${!config_param}${OFF}"
89 echo "${DD_BORDER}"
90 fi ;;
91 "-z+") [[ -z "${!config_param}" ]] && echo "${tab_}<-- NO directory name given" && return
92 esac
93 shift 1
94 done
95 echo
96 }
97
98 set +e
99 PARAM_GROUP=${PROGNAME}_PARAM_LIST
100 for config_param in ${!PARAM_GROUP}; do
101 case $config_param in
102 # Allways display this, if found in ${PROGNAME}_PARAM_LIST
103 GETPKG | \
104 RUNMAKE | \
105 TEST | \
106 OPTIMIZE | \
107 STRIP | \
108 VIMLANG | \
109 MODEL | \
110 METHOD | \
111 ARCH | \
112 PLATFORM | \
113 TARGET | \
114 GRSECURITY_HOST | \
115 BLFS_TOOL | \
116 CUSTOM_TOOLS | \
117 TIMEZONE | \
118 PAGE | \
119 INSTALL_LOG | \
120 REBUILD_MAKEFILE ) echo -e "`eval echo $PARAM_VALS`" ;;
121
122 # Envvars that depend on other settings to be displayed
123 GETKERNEL ) if [[ -z "$CONFIG" ]] && [[ -z "$BOOT_CONFIG" ]] ; then
124 [[ "$GETPKG" = "y" ]] && echo -e "`eval echo $PARAM_VALS`"
125 fi ;;
126 COMPARE) [[ ! "$COMPARE" = "y" ]] && echo -e "`eval echo $PARAM_VALS`" ;;
127 RUN_ICA) [[ "$COMPARE" = "y" ]] && echo -e "`eval echo $PARAM_VALS`" ;;
128 RUN_FARCE) [[ "$COMPARE" = "y" ]] && echo -e "`eval echo $PARAM_VALS`" ;;
129 ITERATIONS) [[ "$COMPARE" = "y" ]] && echo -e "`eval echo $PARAM_VALS`" ;;
130 BOMB_TEST) [[ ! "$TEST" = "0" ]] && echo -e "`eval echo $PARAM_VALS`" ;;
131 TARGET32) [[ -n "${TARGET32}" ]] && echo -e "`eval echo $PARAM_VALS`" ;;
132 MIPS_LEVEL) [[ "${ARCH}" = "mips" ]] && echo -e "`eval echo $PARAM_VALS`" ;;
133
134 # Envars that requires some validation
135 LUSER) echo -e "`eval echo $PARAM_VALS`"
136 [[ "${!config_param}" = "**EDIT ME**" ]] && write_error_and_die
137 ;;
138 LGROUP) echo -e "`eval echo $PARAM_VALS`"
139 [[ "${!config_param}" = "**EDIT ME**" ]] && write_error_and_die
140 ;;
141 REPORT) echo -e "`eval echo $PARAM_VALS`"
142 if [[ "${!config_param}" = "y" ]]; then
143 if [[ `type -p bc` ]]; then
144 continue
145 else
146 echo -e " ${BOLD}The bc binary was not found${OFF}"
147 echo -e " The SBU and disk usage report creation will be skiped"
148 REPORT=n
149 continue
150 fi
151 fi ;;
152
153 # BOOK validation. Very ugly, need be fixed
154 BOOK) if [[ "${WORKING_COPY}" = "y" ]] ; then
155 validate_dir -z -d
156 else
157 echo -e "`eval echo $PARAM_VALS`"
158 fi ;;
159
160 # Validate directories, testable states:
161 # fatal -z -d -w,
162 # warning -z+ -w+
163 SRC_ARCHIVE) [[ "$GETPKG" = "y" ]] && validate_dir -z+ -d -w+ ;;
164 # The build directory/partition MUST exist and be writable by the user
165 BUILDDIR) validate_dir -z -d -w
166 [[ "xx x/x" =~ x${!config_param}x ]] && write_error_and_die ;;
167 LHOME) validate_dir -z -d ;;
168
169 # Validate files, testable states:
170 # fatal -z -e -s -w -x -r,
171 # warning -z+
172 FSTAB) validate_file -z+ -e -s ;;
173 CONFIG) validate_file -z+ -e -s ;;
174 BOOT_CONFIG) [[ "${METHOD}" = "boot" ]] && validate_file -z -e -s ;;
175
176 # Treatment of 'special' parameters
177 LANG | \
178 LC_ALL) # See it the locale values exist on this machine
179 echo -n "`eval echo $PARAM_VALS`"
180 [[ -z "${!config_param}" ]] &&
181 echo " -- Variable $config_param cannot be empty!" &&
182 write_error_and_die
183 echo
184 ;;
185
186 # BLFS params.
187 BRANCH_ID | BLFS_ROOT | BLFS_XML ) echo "`eval echo $PARAM_VALS`" ;;
188 TRACKING_DIR ) validate_dir -z -d -w ;;
189
190 esac
191 done
192
193 if [[ "${BLFS_TOOL}" = "y" ]] ; then
194 echo "${nl_} ${BLUE}blfs-tool settings${OFF}"
195 for config_param in ${blfs_tool_PARAM_LIST}; do
196 echo -e "`eval echo $PARAM_VALS`"
197 done
198 fi
199
200 if [[ "${CUSTOM_TOOLS}" = "y" ]] && [[ "${BLFS_TOOL}" = "n" ]] ; then
201 for config_param in ${custom_tool_PARAM_LIST}; do
202 echo -e "`eval echo $PARAM_VALS`"
203 done
204 fi
205
206 set -e
207 echo "${nl_}***${BOLD}${GREEN} ${PARAM_GROUP%%_*T} config parameters look good${OFF} ***${nl_}"
208}
Note: See TracBrowser for help on using the repository browser.