[2] | 1 | #!/bin/ksh |
---|
| 2 | |
---|
| 3 | #************************************************************** |
---|
| 4 | # Author: Patrick Brockmann |
---|
[373] | 5 | # Contact: Patrick.Brockmann__at__cea.fr |
---|
| 6 | # $Revision:: $ Revision of last commit |
---|
| 7 | # $Author:: $ Author of last commit |
---|
| 8 | # $Date:: $ Date of last commit |
---|
[2] | 9 | # IPSL (2006) |
---|
| 10 | # This software is governed by the CeCILL licence see libIGCM/libIGCM_CeCILL.LIC |
---|
| 11 | # |
---|
| 12 | #************************************************************** |
---|
| 13 | |
---|
| 14 | #================================================== |
---|
| 15 | # The documentation of this file can be automatically generated |
---|
| 16 | # if you use the prefix #D- for comments to be extracted. |
---|
| 17 | # Extract with command: cat lib* | grep "^#D-" | cut -c "4-" |
---|
| 18 | #================================================== |
---|
| 19 | |
---|
| 20 | #D-#================================================================== |
---|
| 21 | #D-libIGCM_card |
---|
| 22 | #D-This ksh library handles extraction of information from configuration file |
---|
| 23 | #D-called "card" file (en français fichier "carte"). |
---|
| 24 | #D-All function described bellow must be prefixed by IGCM_card. |
---|
| 25 | #D-A card file is organized as follows : |
---|
| 26 | #D- --------------------- |
---|
| 27 | #D-[Messages] |
---|
| 28 | #D-Option1= "Hello Earth" |
---|
| 29 | #D-Option2= "Hello Mars" |
---|
| 30 | #D- |
---|
| 31 | #D-# My comments |
---|
| 32 | #D-[Recipes] |
---|
| 33 | #D-Cake= "file1.doc" |
---|
| 34 | #D-Starter= "file2.doc" |
---|
| 35 | #D- |
---|
| 36 | #D-[ColorValues] |
---|
| 37 | #D-Red= 120 |
---|
| 38 | #D-Blue= 230 |
---|
| 39 | #D-Green= 178 |
---|
| 40 | #D- |
---|
| 41 | #D-[Couples] |
---|
| 42 | #D-List1= (up, down), \ |
---|
| 43 | #D- (humid, dry), \ |
---|
| 44 | #D- (hot, cold), \ |
---|
| 45 | #D- (far, close) |
---|
| 46 | #D-List2= (ice, fire, air, water) |
---|
| 47 | #D- --------------------- |
---|
| 48 | #D- |
---|
| 49 | |
---|
| 50 | #D-#================================================================== |
---|
| 51 | #D-function IGCM_card_PrintOption |
---|
| 52 | #D-* Purpose: Print an option from a given file.card and section |
---|
| 53 | #D-* Usage: IGCM_card_PrintOption file.card section option |
---|
[475] | 54 | #D-* Only used by IGCM_card_Test.ksh |
---|
[2] | 55 | #D- |
---|
| 56 | function IGCM_card_PrintOption |
---|
| 57 | { |
---|
| 58 | IGCM_debug_PushStack "IGCM_card_PrintOption" $@ |
---|
[475] | 59 | if ( [ -r "$1" ] && [ -f "$1" ] ) ; then |
---|
[786] | 60 | gawk -f ${libIGCM}/libIGCM_card/IGCM_card_PrintOption.awk "$@" |
---|
[2] | 61 | else |
---|
[786] | 62 | echo |
---|
| 63 | IGCM_debug_Print 1 "--Error--> IGCM_card_PrintOption $@" |
---|
| 64 | IGCM_debug_Print 1 " $1 is not readable" |
---|
| 65 | IGCM_debug_Exit "IGCM_card_PrintOption" |
---|
[2] | 66 | fi |
---|
| 67 | IGCM_debug_PopStack "IGCM_card_PrintOption" |
---|
| 68 | } |
---|
| 69 | |
---|
| 70 | #D-#================================================================== |
---|
| 71 | #D-function IGCM_card_PrintSection |
---|
| 72 | #D-* Purpose: Print all options from a given file.card and section |
---|
| 73 | #D-* Usage: IGCM_card_PrintSection file.card section |
---|
[475] | 74 | #D-* Only used by IGCM_card_Test.ksh |
---|
[2] | 75 | #D- |
---|
| 76 | function IGCM_card_PrintSection |
---|
| 77 | { |
---|
| 78 | IGCM_debug_PushStack "IGCM_card_PrintSection" $@ |
---|
[475] | 79 | if ( [ -r "$1" ] && [ -f "$1" ] ) ; then |
---|
[786] | 80 | gawk -f ${libIGCM}/libIGCM_card/IGCM_card_PrintSection.awk -- "$@" |
---|
[2] | 81 | else |
---|
[786] | 82 | IGCM_debug_Print 1 "--Error--> IGCM_card_PrintSection $@" |
---|
| 83 | IGCM_debug_Print 1 " $1 is not readable" |
---|
| 84 | IGCM_debug_Exit "IGCM_card_PrintSection" |
---|
[2] | 85 | fi |
---|
| 86 | IGCM_debug_PopStack "IGCM_card_PrintSection" |
---|
| 87 | } |
---|
| 88 | |
---|
| 89 | #D-#================================================================== |
---|
| 90 | #D-function IGCM_card_DefineVariableFromOption |
---|
| 91 | #D-* Purpose: Define a variable from a given file.card, section and option |
---|
| 92 | #D-* Variable name is automatically defined as file_section_option |
---|
| 93 | #D-* Usage: IGCM_card_DefineVariableFromOption file.card section option |
---|
| 94 | #D- |
---|
| 95 | function IGCM_card_DefineVariableFromOption |
---|
| 96 | { |
---|
| 97 | IGCM_debug_PushStack "IGCM_card_DefineVariableFromOption" $@ |
---|
[475] | 98 | if ( [ -r "$1" ] && [ -f "$1" ] ) ; then |
---|
[786] | 99 | # Get basename of card file ($1) |
---|
| 100 | typeset name1=${1##*/} |
---|
| 101 | # Build name of variable as $1_$2_$3 (cardname_Section_Option) |
---|
| 102 | typeset name=${name1%%.*}_${2}_${3} |
---|
| 103 | typeset value=$( gawk -f ${libIGCM}/libIGCM_card/IGCM_card_PrintOption.awk -- "$@" ) |
---|
[2] | 104 | |
---|
[786] | 105 | # Only if a section is missing we exit the job. |
---|
| 106 | # We must allow missing option to keep backward compatibilty. |
---|
| 107 | if [ "${value}" = "Error: Section not found" ] ; then |
---|
| 108 | echo |
---|
| 109 | IGCM_debug_Print 1 "Error with readding of ${name} variable in ${1}." |
---|
| 110 | IGCM_debug_Print 1 "Error: Section ${2} not found" |
---|
| 111 | IGCM_debug_Exit |
---|
| 112 | IGCM_debug_Verif_Exit |
---|
| 113 | fi |
---|
| 114 | eval ${name}=${value} |
---|
[2] | 115 | else |
---|
[786] | 116 | echo |
---|
| 117 | IGCM_debug_Print 1 "--Error--> IGCM_card_DefineVariableFromOption" |
---|
| 118 | IGCM_debug_Print 1 "--Error--> $1 is not readable" |
---|
| 119 | IGCM_debug_Exit "IGCM_card_DefineVariableFromOption" |
---|
| 120 | IGCM_debug_Verif_Exit |
---|
[2] | 121 | fi |
---|
| 122 | IGCM_debug_PopStack "IGCM_card_DefineVariableFromOption" |
---|
| 123 | } |
---|
| 124 | |
---|
| 125 | #D-#================================================================== |
---|
| 126 | #D-function IGCM_card_DefineArrayFromOption |
---|
| 127 | #D-* Purpose: Define an array variable from a given file.card, section and option |
---|
| 128 | #D-* Array variable is automatically defined as file_section_option |
---|
| 129 | #D-* Usage: IGCM_card_DefineArrayFromOption file.card section option |
---|
| 130 | #D- |
---|
| 131 | function IGCM_card_DefineArrayFromOption |
---|
| 132 | { |
---|
| 133 | IGCM_debug_PushStack "IGCM_card_DefineArrayFromOption" $@ |
---|
[475] | 134 | if ( [ -r "$1" ] && [ -f "$1" ] ) ; then |
---|
[786] | 135 | # Get basename of card file ($1) |
---|
| 136 | typeset name1=${1##*/} |
---|
| 137 | # Build name of array as $1_$2_$3 (cardname_Section_Option) |
---|
| 138 | typeset name=${name1%%.*}_${2}_${3} |
---|
| 139 | eval unset ${name} |
---|
| 140 | eval ${name}[0]=${NULL_STR} |
---|
| 141 | set +A ${name} -- $( gawk -f ${libIGCM}/libIGCM_card/IGCM_card_PrintOption.awk -- "$@" | gawk -- 'BEGIN {FS="[() ,]+"} {for (i=2; i <= NF-1; i++) printf("%s ",$i)}' ) |
---|
[2] | 142 | else |
---|
[786] | 143 | echo |
---|
| 144 | IGCM_debug_Print 1 "--Error--> IGCM_card_DefineArrayFromOption $@" |
---|
| 145 | IGCM_debug_Print 1 " $1 is not readable" |
---|
| 146 | IGCM_debug_Exit "IGCM_card_DefineArrayFromOption" |
---|
[2] | 147 | fi |
---|
| 148 | IGCM_debug_PopStack "IGCM_card_DefineArrayFromOption" |
---|
| 149 | } |
---|
| 150 | |
---|
| 151 | #D-#================================================================== |
---|
| 152 | #D-function IGCM_card_DefineArrayFromSection |
---|
| 153 | #D-* Purpose: Define an array variable from a given file.card and section |
---|
| 154 | #D-* Array variable is automatically defined as file_section |
---|
| 155 | #D-* Usage: IGCM_card_DefineArrayFromSection file.card section |
---|
| 156 | #D- |
---|
| 157 | function IGCM_card_DefineArrayFromSection |
---|
| 158 | { |
---|
| 159 | IGCM_debug_PushStack "IGCM_card_DefineArrayFromSection" $@ |
---|
[475] | 160 | if ( [ -r "$1" ] && [ -f "$1" ] ) ; then |
---|
[786] | 161 | # Get basename of card file ($1) |
---|
| 162 | typeset name1=${1##*/} |
---|
| 163 | # Build name of array as $1_$2 (cardname_Section) |
---|
| 164 | typeset name=${name1%%.*}_${2} |
---|
| 165 | eval unset ${name} |
---|
| 166 | eval ${name}[0]=${NULL_STR} |
---|
| 167 | set +A ${name} -- $( gawk -f ${libIGCM}/libIGCM_card/IGCM_card_PrintSection.awk -- "$@" ) |
---|
| 168 | #if [ "$( eval echo \${${name}[@]} )" = "Error: Section not found" ] ; then |
---|
| 169 | # echo |
---|
| 170 | # IGCM_debug_Print 1 "Error with readding of ${name} variable in ${1}." |
---|
| 171 | # IGCM_debug_Print 1 "Error: Section ${2} not found" |
---|
| 172 | # IGCM_debug_Exit |
---|
| 173 | # IGCM_debug_Verif_Exit |
---|
| 174 | #fi |
---|
| 175 | if [ "$( eval echo \${${name}[@]} )" = "Error: Section not found" ] ; then |
---|
| 176 | echo |
---|
| 177 | IGCM_debug_Print 1 "Warning with readding of ${name} variable in ${1}." |
---|
| 178 | IGCM_debug_Print 1 "Warning: Section ${2} not found" |
---|
| 179 | eval unset ${name} |
---|
| 180 | fi |
---|
[2] | 181 | else |
---|
[786] | 182 | IGCM_debug_Print 1 "--Error--> IGCM_card_DefineArrayFromSection $@" |
---|
| 183 | IGCM_debug_Print 1 " $1 is not readable" |
---|
| 184 | IGCM_debug_Exit "IGCM_card_DefineArrayFromSection" |
---|
[2] | 185 | fi |
---|
| 186 | IGCM_debug_PopStack "IGCM_card_DefineArrayFromSection" |
---|
| 187 | } |
---|
| 188 | |
---|
| 189 | #D-#================================================================== |
---|
| 190 | #D-function IGCM_card_WriteOption |
---|
[23] | 191 | #D-* Purpose: Write an option in a given file.card and section |
---|
[2] | 192 | #D-* Usage: IGCM_card_WriteOption file.card section newvalue |
---|
| 193 | #D-* Examples: IGCM_card_WriteOption file.card Recipes Red 150 |
---|
| 194 | #D- IGCM_card_WriteOption file.card Messages Option2 '"Hello Mercure"' |
---|
| 195 | #D- IGCM_card_WriteOption file.card Messages ListVal1 '( 1, 2, 3 )' |
---|
| 196 | #D- listname="(Sebastien, Martial, Patrick)" |
---|
| 197 | #D- IGCM_card_WriteOption NewTestFile.card Messages ListVal2 "${listname}" |
---|
| 198 | #D- |
---|
| 199 | function IGCM_card_WriteOption |
---|
| 200 | { |
---|
| 201 | IGCM_debug_PushStack "IGCM_card_WriteOption" $@ |
---|
[475] | 202 | if ( [ -r "$1" ] && [ -w "$1" ] && [ -f "$1" ] ) ; then |
---|
[786] | 203 | typeset tmpfile=tmpfile_$$ |
---|
| 204 | ( IGCM_card_PrintOption "$1" "$2" "$3" | grep "not found" ) > ${tmpfile} |
---|
| 205 | if [ $( cat ${tmpfile} | wc -l ) -gt 0 ] ; then |
---|
[898] | 206 | IGCM_debug_Print 1 "!!! Issue with IGCM_card_WriteOption !!!" |
---|
| 207 | IGCM_debug_Print 1 "We tried to write : $@" |
---|
| 208 | IGCM_debug_Exit "Must check that option $3 in section $2 exist in this file $1" |
---|
| 209 | IGCM_debug_Verif_Exit |
---|
[786] | 210 | fi |
---|
| 211 | \rm ${tmpfile} |
---|
[223] | 212 | |
---|
[786] | 213 | # The tmpfile uses now the real path of the card to be modified, |
---|
| 214 | # not just a local tmpfile with PID. |
---|
| 215 | tmpfile=$1_mutex_$$ |
---|
[223] | 216 | |
---|
[786] | 217 | IGCM_card_CheckConflict $1 |
---|
[223] | 218 | |
---|
[786] | 219 | # Do the job |
---|
| 220 | ( gawk -f ${libIGCM}/libIGCM_card/IGCM_card_WriteOption.awk -- "$@" 2> /dev/null ) > ${tmpfile} |
---|
[223] | 221 | |
---|
[786] | 222 | cp $1 $1.bak |
---|
| 223 | mv ${tmpfile} $1 |
---|
[223] | 224 | |
---|
[2] | 225 | else |
---|
[786] | 226 | echo |
---|
| 227 | IGCM_debug_Print 1 "--Error--> IGCM_card_WriteOption $@" |
---|
| 228 | IGCM_debug_Print 1 " $1 is not readable or not writable" |
---|
| 229 | IGCM_debug_Exit "IGCM_card_WriteOption" |
---|
[2] | 230 | fi |
---|
| 231 | IGCM_debug_PopStack "IGCM_card_WriteOption" |
---|
| 232 | } |
---|
| 233 | |
---|
[472] | 234 | function IGCM_card_CheckConflict |
---|
| 235 | { |
---|
| 236 | IGCM_debug_PushStack "IGCM_card_CheckConflict" $@ |
---|
| 237 | |
---|
| 238 | typeset isleep tmpfiles |
---|
| 239 | |
---|
| 240 | # Watch for possible conflics : Check for other tmpfiles. |
---|
| 241 | set +A tmpfiles -- $( ls $1_mutex_[0-9]* 2>/dev/null ) |
---|
| 242 | ((isleep=0)) |
---|
| 243 | while [ ${#tmpfiles[@]} -gt 0 ] ; do |
---|
[786] | 244 | echo "Conflict between two processes working on " $1 "!!!" ${tmpfiles[@]} |
---|
| 245 | sleep 1 |
---|
| 246 | ((isleep=isleep+1)) |
---|
[822] | 247 | if [ ${isleep} -gt 20 ] ; then |
---|
[786] | 248 | echo "Too many loops waiting for other process working on " $1 ". We continue." |
---|
| 249 | echo "You should see if one process of your run or post-treatment may have terminated suddenly." |
---|
| 250 | echo "Afer, you should erase this(those) file(s) : " ${tmpfiles[@]} |
---|
[472] | 251 | # Send a mail to USER ?? |
---|
[786] | 252 | break ; |
---|
| 253 | fi |
---|
| 254 | unset tmpfiles |
---|
| 255 | set +A tmpfiles -- $( ls $1_mutex_[0-9]* 2>/dev/null ) |
---|
[472] | 256 | done |
---|
| 257 | |
---|
| 258 | IGCM_debug_PopStack "IGCM_card_CheckConflict" |
---|
| 259 | } |
---|
| 260 | |
---|
[2] | 261 | #D-#================================================================== |
---|
[23] | 262 | #D-function IGCM_card_WriteArrayOption |
---|
| 263 | #D-* Purpose: Write an array option a given file.card and section |
---|
| 264 | #D-* Usage: IGCM_card_WriteArrayOption file.card section option newarray |
---|
| 265 | #D-* Examples: set -A MyArray -- 1 2 3 |
---|
| 266 | #D- IGCM_card_WriteArrayOption file.card Recipes List MyArray |
---|
| 267 | #D- |
---|
| 268 | function IGCM_card_WriteArrayOption |
---|
| 269 | { |
---|
| 270 | IGCM_debug_PushStack "IGCM_card_WriteArrayOption" $@ |
---|
| 271 | |
---|
[475] | 272 | if ( [ -r "$1" ] && [ -w "$1" ] && [ -f "$1" ] ) ; then |
---|
[786] | 273 | typeset tmpfile=tmpfile_$$ |
---|
| 274 | if [ X"${4}" != X"" ]; then |
---|
| 275 | tab=$4 |
---|
| 276 | IGCM_card_WriteOption $1 $2 $3 '('$( eval echo \${${tab}[@]} | sed -e 's/ /,/g' )')' |
---|
| 277 | else |
---|
| 278 | IGCM_card_WriteOption $1 $2 $3 '()' |
---|
| 279 | fi |
---|
[23] | 280 | else |
---|
[786] | 281 | echo |
---|
| 282 | IGCM_debug_Print 1 "--Error--> IGCM_card_WriteArrayOption $@" |
---|
| 283 | IGCM_debug_Print 1 " $1 is not readable or not writable" |
---|
| 284 | IGCM_debug_Exit "IGCM_card_WriteArrayOption" |
---|
[23] | 285 | fi |
---|
| 286 | IGCM_debug_PopStack "IGCM_card_WriteArrayOption" |
---|
| 287 | } |
---|
| 288 | |
---|
| 289 | #D-#================================================================== |
---|
[2] | 290 | #D-function IGCM_card_Check |
---|
| 291 | #D-* Purpose: Check the present file by comparison with a reference file |
---|
| 292 | #D-* Usage: IGCM_card_Check |
---|
| 293 | #D- |
---|
| 294 | function IGCM_card_Check |
---|
| 295 | { |
---|
| 296 | IGCM_debug_PushStack "IGCM_card_Check" |
---|
| 297 | #--------------------- |
---|
| 298 | if [ ! -n "${libIGCM}" ] ; then |
---|
[786] | 299 | echo "Check libIGCM_card ...........................................[ FAILED ]" |
---|
| 300 | echo "--Error--> libIGCM variable is not defined" |
---|
| 301 | IGCM_debug_Exit "IGCM_card_Check" |
---|
[2] | 302 | fi |
---|
| 303 | |
---|
| 304 | #--------------------- |
---|
[96] | 305 | whence -v gawk > /dev/null 2>&1 |
---|
[2] | 306 | if [ ! $? -eq 0 ] ; then |
---|
[786] | 307 | echo "Check libIGCM_card ...........................................[ FAILED ]" |
---|
| 308 | echo "--Error--> gawk command is not defined" |
---|
| 309 | IGCM_debug_Exit "IGCM_card_Check" |
---|
[2] | 310 | fi |
---|
| 311 | |
---|
| 312 | #--------------------- |
---|
[931] | 313 | ${libIGCM}/libIGCM_card/IGCM_card_Test.ksh > /tmp/IGCM_card_Test.$$.ref.failed 2>&1 |
---|
[2] | 314 | sleep 2 |
---|
| 315 | |
---|
[931] | 316 | if diff /tmp/IGCM_card_Test.$$.ref.failed ${libIGCM}/libIGCM_card/IGCM_card_Test.ref > /dev/null 2>&1 ; then |
---|
[786] | 317 | echo "Check libIGCM_card ...............................................[ OK ]" |
---|
[931] | 318 | rm -f /tmp/IGCM_card_Test.$$.ref.failed |
---|
[2] | 319 | else |
---|
[786] | 320 | echo "Check libIGCM_card ...........................................[ FAILED ]" |
---|
| 321 | echo "--Error--> Execution of ${libIGCM}/libIGCM_card/IGCM_card_Test.ksh" |
---|
| 322 | echo " has produced the file IGCM_card_Test.ref.failed" |
---|
| 323 | echo " Please analyse differences with the reference file by typing:" |
---|
| 324 | echo " diff IGCM_card_Test.ref.failed ${libIGCM}/libIGCM_card/IGCM_card_Test.ref" |
---|
| 325 | echo " Report errors to the author: Patrick.Brockmann@cea.fr" |
---|
[931] | 326 | cat /tmp/IGCM_card_Test.$$.ref.failed |
---|
[786] | 327 | IGCM_debug_Exit "IGCM_card_Check" |
---|
[2] | 328 | fi |
---|
| 329 | |
---|
| 330 | #--------------------- |
---|
| 331 | IGCM_debug_PopStack "IGCM_card_Check" |
---|
| 332 | } |
---|