strings.subr revision 258420
1238438Sdteskeif [ ! "$_STRINGS_SUBR" ]; then _STRINGS_SUBR=1 2238438Sdteske# 3247280Sdteske# Copyright (c) 2006-2013 Devin Teske 4252980Sdteske# All rights reserved. 5238438Sdteske# 6238438Sdteske# Redistribution and use in source and binary forms, with or without 7238438Sdteske# modification, are permitted provided that the following conditions 8238438Sdteske# are met: 9238438Sdteske# 1. Redistributions of source code must retain the above copyright 10238438Sdteske# notice, this list of conditions and the following disclaimer. 11238438Sdteske# 2. Redistributions in binary form must reproduce the above copyright 12238438Sdteske# notice, this list of conditions and the following disclaimer in the 13238438Sdteske# documentation and/or other materials provided with the distribution. 14238438Sdteske# 15238438Sdteske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16252987Sdteske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17238438Sdteske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18238438Sdteske# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19238438Sdteske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20252987Sdteske# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21238438Sdteske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22238438Sdteske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23238438Sdteske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24238438Sdteske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25238438Sdteske# SUCH DAMAGE. 26238438Sdteske# 27238438Sdteske# $FreeBSD: stable/10/usr.sbin/bsdconfig/share/strings.subr 258420 2013-11-21 03:38:47Z dteske $ 28249751Sdteske# 29256361Sdteske############################################################ INCLUDES 30256361Sdteske 31256361SdteskeBSDCFG_SHARE="/usr/share/bsdconfig" 32256361Sdteske. $BSDCFG_SHARE/common.subr || exit 1 33256361Sdteske 34249751Sdteske############################################################ GLOBALS 35238438Sdteske 36249751Sdteske# 37249751Sdteske# Valid characters that can appear in an sh(1) variable name 38249751Sdteske# 39249751Sdteske# Please note that the character ranges A-Z and a-z should be avoided because 40249751Sdteske# these can include accent characters (which are not valid in a variable name). 41249751Sdteske# For example, A-Z matches any character that sorts after A but before Z, 42249751Sdteske# including A and Z. Although ASCII order would make more sense, that is not 43249751Sdteske# how it works. 44249751Sdteske# 45249751SdteskeVALID_VARNAME_CHARS="0-9ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_" 46249751Sdteske 47249751Sdteske############################################################ FUNCTIONS 48249751Sdteske 49258420Sdteske# f_substr "$string" $start [$length] 50238438Sdteske# 51238438Sdteske# Simple wrapper to awk(1)'s `substr' function. 52238438Sdteske# 53238438Sdteskef_substr() 54238438Sdteske{ 55238438Sdteske local string="$1" start="${2:-0}" len="${3:-0}" 56238438Sdteske echo "$string" | awk "{ print substr(\$0, $start, $len) }" 57238438Sdteske} 58238438Sdteske 59258420Sdteske# f_snprintf $var_to_set $size $format [$arguments ...] 60250701Sdteske# 61250701Sdteske# Similar to snprintf(3), write at most $size number of bytes into $var_to_set 62258420Sdteske# using printf(1) syntax (`$format [$arguments ...]'). The value of $var_to_set 63258420Sdteske# is NULL unless at-least one byte is stored from the output. 64250701Sdteske# 65250701Sdteskef_snprintf() 66250701Sdteske{ 67250701Sdteske local __var_to_set="$1" __size="$2" 68258420Sdteske shift 2 # var_to_set size 69258420Sdteske eval "$__var_to_set"=\$\( printf -- \"\$@\" \| \ 70258420Sdteske awk -v max=\"\$__size\" \'' 71250701Sdteske { 72250701Sdteske len = length($0) 73250701Sdteske max -= len 74250701Sdteske print substr($0,0,(max > 0 ? len : max + len)) 75250701Sdteske if ( max < 0 ) exit 76250701Sdteske max-- 77250701Sdteske }'\' \) 78250701Sdteske} 79250701Sdteske 80258420Sdteske# f_sprintf $var_to_set $format [$arguments ...] 81258420Sdteske# 82258420Sdteske# Similar to sprintf(3), write a string into $var_to_set using printf(1) syntax 83258420Sdteske# (`$format [$arguments ...]'). 84258420Sdteske# 85258420Sdteskef_sprintf() 86258420Sdteske{ 87258420Sdteske local __var_to_set="$1" 88258420Sdteske shift 1 # var_to_set 89258420Sdteske eval "$__var_to_set"=\$\( printf -- \"\$@\" \) 90258420Sdteske} 91258420Sdteske 92251278Sdteske# f_vsnprintf $var_to_set $size $format $format_args 93251278Sdteske# 94251278Sdteske# Similar to vsnprintf(3), write at most $size number of bytes into $var_to_set 95251278Sdteske# using printf(1) syntax (`$format $format_args'). The value of $var_to_set is 96251278Sdteske# NULL unless at-least one byte is stored from the output. 97251278Sdteske# 98251278Sdteske# Example 1: 99251278Sdteske# 100251278Sdteske# limit=7 format="%s" 101251278Sdteske# format_args="'abc 123'" # 3-spaces between abc and 123 102251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[abc 1] 103251278Sdteske# 104251278Sdteske# Example 2: 105251278Sdteske# 106251278Sdteske# limit=12 format="%s %s" 107251278Sdteske# format_args=" 'doghouse' 'foxhound' " 108251278Sdteske# # even more spaces added to illustrate escape-method 109251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[doghouse fox] 110251278Sdteske# 111251278Sdteske# Example 3: 112251278Sdteske# 113251278Sdteske# limit=13 format="%s %s" 114251278Sdteske# f_shell_escape arg1 'aaa"aaa' # arg1=[aaa"aaa] (no change) 115251278Sdteske# f_shell_escape arg2 "aaa'aaa" # arg2=[aaa'\''aaa] (escaped s-quote) 116251278Sdteske# format_args="'$arg1' '$arg2'" # use single-quotes to surround args 117251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[aaa"aaa aaa'a] 118251278Sdteske# 119251278Sdteske# In all of the above examples, the call to f_vsnprintf() does not change. Only 120251278Sdteske# the contents of $limit, $format, and $format_args changes in each example. 121251278Sdteske# 122251278Sdteskef_vsnprintf() 123251278Sdteske{ 124251278Sdteske eval f_snprintf \"\$1\" \"\$2\" \"\$3\" $4 125251278Sdteske} 126251278Sdteske 127258420Sdteske# f_vsprintf $var_to_set $format $format_args 128258420Sdteske# 129258420Sdteske# Similar to vsprintf(3), write a string into $var_to_set using printf(1) 130258420Sdteske# syntax (`$format $format_args'). 131258420Sdteske# 132258420Sdteskef_vsprintf() 133258420Sdteske{ 134258420Sdteske eval f_sprintf \"\$1\" \"\$2\" $3 135258420Sdteske} 136258420Sdteske 137238438Sdteske# f_longest_line_length 138238438Sdteske# 139238438Sdteske# Simple wrapper to an awk(1) script to print the length of the longest line of 140238438Sdteske# input (read from stdin). Supports the newline escape-sequence `\n' for 141238438Sdteske# splitting a single line into multiple lines. 142238438Sdteske# 143238438Sdteskef_longest_line_length_awk=' 144238438SdteskeBEGIN { longest = 0 } 145238438Sdteske{ 146238438Sdteske if (split($0, lines, /\\n/) > 1) 147238438Sdteske { 148238438Sdteske for (n in lines) 149238438Sdteske { 150238438Sdteske len = length(lines[n]) 151238438Sdteske longest = ( len > longest ? len : longest ) 152238438Sdteske } 153238438Sdteske } 154238438Sdteske else 155238438Sdteske { 156238438Sdteske len = length($0) 157238438Sdteske longest = ( len > longest ? len : longest ) 158238438Sdteske } 159238438Sdteske} 160238438SdteskeEND { print longest } 161238438Sdteske' 162238438Sdteskef_longest_line_length() 163238438Sdteske{ 164238438Sdteske awk "$f_longest_line_length_awk" 165238438Sdteske} 166238438Sdteske 167238438Sdteske# f_number_of_lines 168238438Sdteske# 169238438Sdteske# Simple wrapper to an awk(1) script to print the number of lines read from 170238438Sdteske# stdin. Supports newline escape-sequence `\n' for splitting a single line into 171238438Sdteske# multiple lines. 172238438Sdteske# 173238438Sdteskef_number_of_lines_awk=' 174238438SdteskeBEGIN { num_lines = 0 } 175238438Sdteske{ 176241700Sdteske num_lines += split(" "$0, unused, /\\n/) 177238438Sdteske} 178238438SdteskeEND { print num_lines } 179238438Sdteske' 180238438Sdteskef_number_of_lines() 181238438Sdteske{ 182238438Sdteske awk "$f_number_of_lines_awk" 183238438Sdteske} 184238438Sdteske 185238438Sdteske# f_isinteger $arg 186238438Sdteske# 187238438Sdteske# Returns true if argument is a positive/negative whole integer. 188238438Sdteske# 189238438Sdteskef_isinteger() 190238438Sdteske{ 191238438Sdteske local arg="$1" 192238438Sdteske 193238438Sdteske # Prevent division-by-zero 194238438Sdteske [ "$arg" = "0" ] && return $SUCCESS 195238438Sdteske 196238438Sdteske # Attempt to perform arithmetic divison (an operation which will exit 197238438Sdteske # with error unless arg is a valid positive/negative whole integer). 198238438Sdteske # 199240783Sdteske ( : $((0/$arg)) ) > /dev/null 2>&1 200238438Sdteske} 201238438Sdteske 202247280Sdteske# f_uriencode [$text] 203247280Sdteske# 204247280Sdteske# Encode $text for the purpose of embedding safely into a URL. Non-alphanumeric 205247280Sdteske# characters are converted to `%XX' sequence where XX represents the hexa- 206247280Sdteske# decimal ordinal of the non-alphanumeric character. If $text is missing, data 207247280Sdteske# is instead read from standard input. 208247280Sdteske# 209247280Sdteskef_uriencode_awk=' 210247280SdteskeBEGIN { 211247280Sdteske output = "" 212247280Sdteske for (n = 0; n < 256; n++) pack[sprintf("%c", n)] = sprintf("%%%02x", n) 213247280Sdteske} 214247280Sdteske{ 215247280Sdteske sline = "" 216247280Sdteske slen = length($0) 217247280Sdteske for (n = 1; n <= slen; n++) { 218247280Sdteske char = substr($0, n, 1) 219247280Sdteske if ( char !~ /^[[:alnum:]_]$/ ) char = pack[char] 220247280Sdteske sline = sline char 221247280Sdteske } 222247280Sdteske output = output ( output ? "%0a" : "" ) sline 223247280Sdteske} 224247280SdteskeEND { print output } 225247280Sdteske' 226247280Sdteskef_uriencode() 227247280Sdteske{ 228247280Sdteske if [ $# -gt 0 ]; then 229247280Sdteske echo "$1" | awk "$f_uriencode_awk" 230247280Sdteske else 231247280Sdteske awk "$f_uriencode_awk" 232247280Sdteske fi 233247280Sdteske} 234247280Sdteske 235247280Sdteske# f_uridecode [$text] 236247280Sdteske# 237247280Sdteske# Decode $text from a URI. Encoded characters are converted from their `%XX' 238247280Sdteske# sequence into original unencoded ASCII sequences. If $text is missing, data 239247280Sdteske# is instead read from standard input. 240247280Sdteske# 241247280Sdteskef_uridecode_awk=' 242247280SdteskeBEGIN { for (n = 0; n < 256; n++) chr[n] = sprintf("%c", n) } 243247280Sdteske{ 244247280Sdteske sline = "" 245247280Sdteske slen = length($0) 246247280Sdteske for (n = 1; n <= slen; n++) 247247280Sdteske { 248247280Sdteske seq = substr($0, n, 3) 249247280Sdteske if ( seq ~ /^%[[:xdigit:]][[:xdigit:]]$/ ) { 250247280Sdteske hex = substr(seq, 2, 2) 251247280Sdteske sline = sline chr[sprintf("%u", "0x"hex)] 252247280Sdteske n += 2 253247280Sdteske } else 254247280Sdteske sline = sline substr(seq, 1, 1) 255247280Sdteske } 256247280Sdteske print sline 257247280Sdteske} 258247280Sdteske' 259247280Sdteskef_uridecode() 260247280Sdteske{ 261247280Sdteske if [ $# -gt 0 ]; then 262247280Sdteske echo "$1" | awk "$f_uridecode_awk" 263247280Sdteske else 264247280Sdteske awk "$f_uridecode_awk" 265247280Sdteske fi 266247280Sdteske} 267247280Sdteske 268249751Sdteske# f_replaceall $string $find $replace [$var_to_set] 269249751Sdteske# 270250702Sdteske# Replace all occurrences of $find in $string with $replace. If $var_to_set is 271249751Sdteske# either missing or NULL, the variable name is produced on standard out for 272249751Sdteske# capturing in a sub-shell (which is less recommended due to performance 273249751Sdteske# degradation). 274249751Sdteske# 275249751Sdteskef_replaceall() 276249751Sdteske{ 277249751Sdteske local __left="" __right="$1" 278249751Sdteske local __find="$2" __replace="$3" __var_to_set="$4" 279249751Sdteske while :; do 280249751Sdteske case "$__right" in *$__find*) 281249751Sdteske __left="$__left${__right%%$__find*}$__replace" 282249751Sdteske __right="${__right#*$__find}" 283249751Sdteske continue 284249751Sdteske esac 285249751Sdteske break 286249751Sdteske done 287249751Sdteske __left="$__left${__right#*$__find}" 288249751Sdteske if [ "$__var_to_set" ]; then 289249751Sdteske setvar "$__var_to_set" "$__left" 290249751Sdteske else 291249751Sdteske echo "$__left" 292249751Sdteske fi 293249751Sdteske} 294249751Sdteske 295249751Sdteske# f_str2varname $string [$var_to_set] 296249751Sdteske# 297249751Sdteske# Convert a string into a suitable value to be used as a variable name 298249751Sdteske# by converting unsuitable characters into the underscrore [_]. If $var_to_set 299249751Sdteske# is either missing or NULL, the variable name is produced on standard out for 300249751Sdteske# capturing in a sub-shell (which is less recommended due to performance 301249751Sdteske# degradation). 302249751Sdteske# 303249751Sdteskef_str2varname() 304249751Sdteske{ 305249751Sdteske local __string="$1" __var_to_set="$2" 306249751Sdteske f_replaceall "$__string" "[!$VALID_VARNAME_CHARS]" "_" "$__var_to_set" 307249751Sdteske} 308249751Sdteske 309249751Sdteske# f_shell_escape $string [$var_to_set] 310249751Sdteske# 311249751Sdteske# Escape $string for shell eval statement(s) by replacing all single-quotes 312249751Sdteske# with a special sequence that creates a compound string when interpolated 313249751Sdteske# by eval with surrounding single-quotes. 314249751Sdteske# 315249751Sdteske# For example: 316249751Sdteske# 317249751Sdteske# foo="abc'123" 318249751Sdteske# f_shell_escape "$foo" bar # bar=[abc'\''123] 319251272Sdteske# eval echo \'$bar\' # produces abc'123 320249751Sdteske# 321249751Sdteske# This is helpful when processing an argument list that has to retain its 322249751Sdteske# escaped structure for later evaluations. 323249751Sdteske# 324249751Sdteske# WARNING: Surrounding single-quotes are not added; this is the responsibility 325249751Sdteske# of the code passing the escaped values to eval (which also aids readability). 326249751Sdteske# 327249751Sdteskef_shell_escape() 328249751Sdteske{ 329249751Sdteske local __string="$1" __var_to_set="$2" 330249751Sdteske f_replaceall "$__string" "'" "'\\''" "$__var_to_set" 331249751Sdteske} 332249751Sdteske 333249751Sdteske# f_shell_unescape $string [$var_to_set] 334249751Sdteske# 335249751Sdteske# The antithesis of f_shell_escape(), this function takes an escaped $string 336249751Sdteske# and expands it. 337249751Sdteske# 338249751Sdteske# For example: 339249751Sdteske# 340249751Sdteske# foo="abc'123" 341249751Sdteske# f_shell_escape "$foo" bar # bar=[abc'\''123] 342249751Sdteske# f_shell_unescape "$bar" # produces abc'123 343249751Sdteske# 344249751Sdteskef_shell_unescape() 345249751Sdteske{ 346249751Sdteske local __string="$1" __var_to_set="$2" 347249751Sdteske f_replaceall "$__string" "'\\''" "'" "$__var_to_set" 348249751Sdteske} 349249751Sdteske 350256361Sdteske# f_expand_number $string [$var_to_set] 351256361Sdteske# 352256361Sdteske# Unformat $string into a number, optionally to be stored in $var_to_set. This 353256361Sdteske# function follows the SI power of two convention. 354256361Sdteske# 355256361Sdteske# The prefixes are: 356256361Sdteske# 357256361Sdteske# Prefix Description Multiplier 358256361Sdteske# k kilo 1024 359256361Sdteske# M mega 1048576 360256361Sdteske# G giga 1073741824 361256361Sdteske# T tera 1099511627776 362256361Sdteske# P peta 1125899906842624 363256361Sdteske# E exa 1152921504606846976 364256361Sdteske# 365256361Sdteske# NOTE: Prefixes are case-insensitive. 366256361Sdteske# 367256392Sdteske# Upon successful completion, success status is returned; otherwise the number 368256392Sdteske# -1 is produced ($var_to_set set to -1 or if $var_to_set is NULL or missing) 369256392Sdteske# on standard output. In the case of failure, the error status will be one of: 370256361Sdteske# 371256392Sdteske# Status Reason 372256392Sdteske# 1 Given $string contains no digits 373256392Sdteske# 2 An unrecognized prefix was given 374256392Sdteske# 3 Result too large to calculate 375256361Sdteske# 376256361Sdteskef_expand_number() 377256361Sdteske{ 378256361Sdteske local __string="$1" __var_to_set="$2" 379256392Sdteske local __cp __num __bshift __maxinput 380256361Sdteske 381256361Sdteske # Remove any leading non-digits 382256361Sdteske while :; do 383256361Sdteske __cp="$__string" 384256361Sdteske __string="${__cp#[!0-9]}" 385256361Sdteske [ "$__string" = "$__cp" ] && break 386256361Sdteske done 387256361Sdteske 388256392Sdteske # Produce `-1' if string didn't contain any digits 389256361Sdteske if [ ! "$__string" ]; then 390256361Sdteske if [ "$__var_to_set" ]; then 391256361Sdteske setvar "$__var_to_set" -1 392256361Sdteske else 393256361Sdteske echo -1 394256361Sdteske fi 395256392Sdteske return 1 # 1 = "Given $string contains no digits" 396256361Sdteske fi 397256361Sdteske 398256361Sdteske # Store the numbers 399256361Sdteske __num="${__string%%[!0-9]*}" 400256361Sdteske 401256361Sdteske # Shortcut 402256361Sdteske if [ $__num -eq 0 ]; then 403256361Sdteske if [ "$__var_to_set" ]; then 404256361Sdteske setvar "$__var_to_set" 0 405256361Sdteske else 406256361Sdteske echo 0 407256361Sdteske fi 408256361Sdteske return $SUCCESS 409256361Sdteske fi 410256361Sdteske 411256361Sdteske # Remove all the leading numbers from the string to get at the prefix 412256361Sdteske while :; do 413256361Sdteske __cp="$__string" 414256361Sdteske __string="${__cp#[0-9]}" 415256361Sdteske [ "$__string" = "$__cp" ] && break 416256361Sdteske done 417256361Sdteske 418256392Sdteske # 419256392Sdteske # Test for invalid prefix (and determine bitshift length) 420256392Sdteske # 421256361Sdteske case "$__string" in 422256392Sdteske ""|[[:space:]]*) # Shortcut 423256392Sdteske if [ "$__var_to_set" ]; then 424256392Sdteske setvar "$__var_to_set" $__num 425256392Sdteske else 426256392Sdteske echo $__num 427256392Sdteske fi 428256392Sdteske return $SUCCESS ;; 429256392Sdteske [Kk]*) __bshift=10 ;; 430256392Sdteske [Mm]*) __bshift=20 ;; 431256392Sdteske [Gg]*) __bshift=30 ;; 432256392Sdteske [Tt]*) __bshift=40 ;; 433256392Sdteske [Pp]*) __bshift=50 ;; 434256392Sdteske [Ee]*) __bshift=60 ;; 435256361Sdteske *) 436256361Sdteske # Unknown prefix 437256361Sdteske if [ "$__var_to_set" ]; then 438256361Sdteske setvar "$__var_to_set" -1 439256361Sdteske else 440256361Sdteske echo -1 441256361Sdteske fi 442256392Sdteske return 2 # 2 = "An unrecognized prefix was given" 443256361Sdteske esac 444256361Sdteske 445256392Sdteske # Determine if the wheels fall off 446256392Sdteske __maxinput=$(( 0x7fffffffffffffff >> $__bshift )) 447256392Sdteske if [ $__num -gt $__maxinput ]; then 448256392Sdteske # Input (before expanding) would exceed 64-bit signed int 449256361Sdteske if [ "$__var_to_set" ]; then 450256361Sdteske setvar "$__var_to_set" -1 451256361Sdteske else 452256361Sdteske echo -1 453256361Sdteske fi 454256392Sdteske return 3 # 3 = "Result too large to calculate" 455256361Sdteske fi 456256361Sdteske 457256392Sdteske # Shift the number out and produce it 458256392Sdteske __num=$(( $__num << $__bshift )) 459256361Sdteske if [ "$__var_to_set" ]; then 460256361Sdteske setvar "$__var_to_set" $__num 461256361Sdteske else 462256361Sdteske echo $__num 463256361Sdteske fi 464256361Sdteske} 465256361Sdteske 466249751Sdteske############################################################ MAIN 467249751Sdteske 468244675Sdteskef_dprintf "%s: Successfully loaded." strings.subr 469244675Sdteske 470238438Sdteskefi # ! $_STRINGS_SUBR 471