strings.subr revision 256392
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 256392 2013-10-12 19:54:12Z 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 49238438Sdteske# 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 59250701Sdteske# f_snprintf $var_to_set $size $format ... 60250701Sdteske# 61250701Sdteske# Similar to snprintf(3), write at most $size number of bytes into $var_to_set 62250701Sdteske# using printf(1) syntax (`$format ...'). The value of $var_to_set is NULL 63250701Sdteske# unless at-least one byte is stored from the output. 64250701Sdteske# 65250701Sdteskef_snprintf() 66250701Sdteske{ 67250701Sdteske local __var_to_set="$1" __size="$2" 68250701Sdteske shift 2 # var_to_set/size 69250701Sdteske eval "$__var_to_set"=\$\( printf \"\$@\" \| awk -v max=\"\$__size\" \'' 70250701Sdteske { 71250701Sdteske len = length($0) 72250701Sdteske max -= len 73250701Sdteske print substr($0,0,(max > 0 ? len : max + len)) 74250701Sdteske if ( max < 0 ) exit 75250701Sdteske max-- 76250701Sdteske }'\' \) 77250701Sdteske} 78250701Sdteske 79251278Sdteske# f_vsnprintf $var_to_set $size $format $format_args 80251278Sdteske# 81251278Sdteske# Similar to vsnprintf(3), write at most $size number of bytes into $var_to_set 82251278Sdteske# using printf(1) syntax (`$format $format_args'). The value of $var_to_set is 83251278Sdteske# NULL unless at-least one byte is stored from the output. 84251278Sdteske# 85251278Sdteske# Example 1: 86251278Sdteske# 87251278Sdteske# limit=7 format="%s" 88251278Sdteske# format_args="'abc 123'" # 3-spaces between abc and 123 89251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[abc 1] 90251278Sdteske# 91251278Sdteske# Example 2: 92251278Sdteske# 93251278Sdteske# limit=12 format="%s %s" 94251278Sdteske# format_args=" 'doghouse' 'foxhound' " 95251278Sdteske# # even more spaces added to illustrate escape-method 96251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[doghouse fox] 97251278Sdteske# 98251278Sdteske# Example 3: 99251278Sdteske# 100251278Sdteske# limit=13 format="%s %s" 101251278Sdteske# f_shell_escape arg1 'aaa"aaa' # arg1=[aaa"aaa] (no change) 102251278Sdteske# f_shell_escape arg2 "aaa'aaa" # arg2=[aaa'\''aaa] (escaped s-quote) 103251278Sdteske# format_args="'$arg1' '$arg2'" # use single-quotes to surround args 104251278Sdteske# f_vsnprintf foo $limit "$format" "$format_args" # foo=[aaa"aaa aaa'a] 105251278Sdteske# 106251278Sdteske# In all of the above examples, the call to f_vsnprintf() does not change. Only 107251278Sdteske# the contents of $limit, $format, and $format_args changes in each example. 108251278Sdteske# 109251278Sdteskef_vsnprintf() 110251278Sdteske{ 111251278Sdteske eval f_snprintf \"\$1\" \"\$2\" \"\$3\" $4 112251278Sdteske} 113251278Sdteske 114238438Sdteske# f_longest_line_length 115238438Sdteske# 116238438Sdteske# Simple wrapper to an awk(1) script to print the length of the longest line of 117238438Sdteske# input (read from stdin). Supports the newline escape-sequence `\n' for 118238438Sdteske# splitting a single line into multiple lines. 119238438Sdteske# 120238438Sdteskef_longest_line_length_awk=' 121238438SdteskeBEGIN { longest = 0 } 122238438Sdteske{ 123238438Sdteske if (split($0, lines, /\\n/) > 1) 124238438Sdteske { 125238438Sdteske for (n in lines) 126238438Sdteske { 127238438Sdteske len = length(lines[n]) 128238438Sdteske longest = ( len > longest ? len : longest ) 129238438Sdteske } 130238438Sdteske } 131238438Sdteske else 132238438Sdteske { 133238438Sdteske len = length($0) 134238438Sdteske longest = ( len > longest ? len : longest ) 135238438Sdteske } 136238438Sdteske} 137238438SdteskeEND { print longest } 138238438Sdteske' 139238438Sdteskef_longest_line_length() 140238438Sdteske{ 141238438Sdteske awk "$f_longest_line_length_awk" 142238438Sdteske} 143238438Sdteske 144238438Sdteske# f_number_of_lines 145238438Sdteske# 146238438Sdteske# Simple wrapper to an awk(1) script to print the number of lines read from 147238438Sdteske# stdin. Supports newline escape-sequence `\n' for splitting a single line into 148238438Sdteske# multiple lines. 149238438Sdteske# 150238438Sdteskef_number_of_lines_awk=' 151238438SdteskeBEGIN { num_lines = 0 } 152238438Sdteske{ 153241700Sdteske num_lines += split(" "$0, unused, /\\n/) 154238438Sdteske} 155238438SdteskeEND { print num_lines } 156238438Sdteske' 157238438Sdteskef_number_of_lines() 158238438Sdteske{ 159238438Sdteske awk "$f_number_of_lines_awk" 160238438Sdteske} 161238438Sdteske 162238438Sdteske# f_isinteger $arg 163238438Sdteske# 164238438Sdteske# Returns true if argument is a positive/negative whole integer. 165238438Sdteske# 166238438Sdteskef_isinteger() 167238438Sdteske{ 168238438Sdteske local arg="$1" 169238438Sdteske 170238438Sdteske # Prevent division-by-zero 171238438Sdteske [ "$arg" = "0" ] && return $SUCCESS 172238438Sdteske 173238438Sdteske # Attempt to perform arithmetic divison (an operation which will exit 174238438Sdteske # with error unless arg is a valid positive/negative whole integer). 175238438Sdteske # 176240783Sdteske ( : $((0/$arg)) ) > /dev/null 2>&1 177238438Sdteske} 178238438Sdteske 179247280Sdteske# f_uriencode [$text] 180247280Sdteske# 181247280Sdteske# Encode $text for the purpose of embedding safely into a URL. Non-alphanumeric 182247280Sdteske# characters are converted to `%XX' sequence where XX represents the hexa- 183247280Sdteske# decimal ordinal of the non-alphanumeric character. If $text is missing, data 184247280Sdteske# is instead read from standard input. 185247280Sdteske# 186247280Sdteskef_uriencode_awk=' 187247280SdteskeBEGIN { 188247280Sdteske output = "" 189247280Sdteske for (n = 0; n < 256; n++) pack[sprintf("%c", n)] = sprintf("%%%02x", n) 190247280Sdteske} 191247280Sdteske{ 192247280Sdteske sline = "" 193247280Sdteske slen = length($0) 194247280Sdteske for (n = 1; n <= slen; n++) { 195247280Sdteske char = substr($0, n, 1) 196247280Sdteske if ( char !~ /^[[:alnum:]_]$/ ) char = pack[char] 197247280Sdteske sline = sline char 198247280Sdteske } 199247280Sdteske output = output ( output ? "%0a" : "" ) sline 200247280Sdteske} 201247280SdteskeEND { print output } 202247280Sdteske' 203247280Sdteskef_uriencode() 204247280Sdteske{ 205247280Sdteske if [ $# -gt 0 ]; then 206247280Sdteske echo "$1" | awk "$f_uriencode_awk" 207247280Sdteske else 208247280Sdteske awk "$f_uriencode_awk" 209247280Sdteske fi 210247280Sdteske} 211247280Sdteske 212247280Sdteske# f_uridecode [$text] 213247280Sdteske# 214247280Sdteske# Decode $text from a URI. Encoded characters are converted from their `%XX' 215247280Sdteske# sequence into original unencoded ASCII sequences. If $text is missing, data 216247280Sdteske# is instead read from standard input. 217247280Sdteske# 218247280Sdteskef_uridecode_awk=' 219247280SdteskeBEGIN { for (n = 0; n < 256; n++) chr[n] = sprintf("%c", n) } 220247280Sdteske{ 221247280Sdteske sline = "" 222247280Sdteske slen = length($0) 223247280Sdteske for (n = 1; n <= slen; n++) 224247280Sdteske { 225247280Sdteske seq = substr($0, n, 3) 226247280Sdteske if ( seq ~ /^%[[:xdigit:]][[:xdigit:]]$/ ) { 227247280Sdteske hex = substr(seq, 2, 2) 228247280Sdteske sline = sline chr[sprintf("%u", "0x"hex)] 229247280Sdteske n += 2 230247280Sdteske } else 231247280Sdteske sline = sline substr(seq, 1, 1) 232247280Sdteske } 233247280Sdteske print sline 234247280Sdteske} 235247280Sdteske' 236247280Sdteskef_uridecode() 237247280Sdteske{ 238247280Sdteske if [ $# -gt 0 ]; then 239247280Sdteske echo "$1" | awk "$f_uridecode_awk" 240247280Sdteske else 241247280Sdteske awk "$f_uridecode_awk" 242247280Sdteske fi 243247280Sdteske} 244247280Sdteske 245249751Sdteske# f_replaceall $string $find $replace [$var_to_set] 246249751Sdteske# 247250702Sdteske# Replace all occurrences of $find in $string with $replace. If $var_to_set is 248249751Sdteske# either missing or NULL, the variable name is produced on standard out for 249249751Sdteske# capturing in a sub-shell (which is less recommended due to performance 250249751Sdteske# degradation). 251249751Sdteske# 252249751Sdteskef_replaceall() 253249751Sdteske{ 254249751Sdteske local __left="" __right="$1" 255249751Sdteske local __find="$2" __replace="$3" __var_to_set="$4" 256249751Sdteske while :; do 257249751Sdteske case "$__right" in *$__find*) 258249751Sdteske __left="$__left${__right%%$__find*}$__replace" 259249751Sdteske __right="${__right#*$__find}" 260249751Sdteske continue 261249751Sdteske esac 262249751Sdteske break 263249751Sdteske done 264249751Sdteske __left="$__left${__right#*$__find}" 265249751Sdteske if [ "$__var_to_set" ]; then 266249751Sdteske setvar "$__var_to_set" "$__left" 267249751Sdteske else 268249751Sdteske echo "$__left" 269249751Sdteske fi 270249751Sdteske} 271249751Sdteske 272249751Sdteske# f_str2varname $string [$var_to_set] 273249751Sdteske# 274249751Sdteske# Convert a string into a suitable value to be used as a variable name 275249751Sdteske# by converting unsuitable characters into the underscrore [_]. If $var_to_set 276249751Sdteske# is either missing or NULL, the variable name is produced on standard out for 277249751Sdteske# capturing in a sub-shell (which is less recommended due to performance 278249751Sdteske# degradation). 279249751Sdteske# 280249751Sdteskef_str2varname() 281249751Sdteske{ 282249751Sdteske local __string="$1" __var_to_set="$2" 283249751Sdteske f_replaceall "$__string" "[!$VALID_VARNAME_CHARS]" "_" "$__var_to_set" 284249751Sdteske} 285249751Sdteske 286249751Sdteske# f_shell_escape $string [$var_to_set] 287249751Sdteske# 288249751Sdteske# Escape $string for shell eval statement(s) by replacing all single-quotes 289249751Sdteske# with a special sequence that creates a compound string when interpolated 290249751Sdteske# by eval with surrounding single-quotes. 291249751Sdteske# 292249751Sdteske# For example: 293249751Sdteske# 294249751Sdteske# foo="abc'123" 295249751Sdteske# f_shell_escape "$foo" bar # bar=[abc'\''123] 296251272Sdteske# eval echo \'$bar\' # produces abc'123 297249751Sdteske# 298249751Sdteske# This is helpful when processing an argument list that has to retain its 299249751Sdteske# escaped structure for later evaluations. 300249751Sdteske# 301249751Sdteske# WARNING: Surrounding single-quotes are not added; this is the responsibility 302249751Sdteske# of the code passing the escaped values to eval (which also aids readability). 303249751Sdteske# 304249751Sdteskef_shell_escape() 305249751Sdteske{ 306249751Sdteske local __string="$1" __var_to_set="$2" 307249751Sdteske f_replaceall "$__string" "'" "'\\''" "$__var_to_set" 308249751Sdteske} 309249751Sdteske 310249751Sdteske# f_shell_unescape $string [$var_to_set] 311249751Sdteske# 312249751Sdteske# The antithesis of f_shell_escape(), this function takes an escaped $string 313249751Sdteske# and expands it. 314249751Sdteske# 315249751Sdteske# For example: 316249751Sdteske# 317249751Sdteske# foo="abc'123" 318249751Sdteske# f_shell_escape "$foo" bar # bar=[abc'\''123] 319249751Sdteske# f_shell_unescape "$bar" # produces abc'123 320249751Sdteske# 321249751Sdteskef_shell_unescape() 322249751Sdteske{ 323249751Sdteske local __string="$1" __var_to_set="$2" 324249751Sdteske f_replaceall "$__string" "'\\''" "'" "$__var_to_set" 325249751Sdteske} 326249751Sdteske 327256361Sdteske# f_expand_number $string [$var_to_set] 328256361Sdteske# 329256361Sdteske# Unformat $string into a number, optionally to be stored in $var_to_set. This 330256361Sdteske# function follows the SI power of two convention. 331256361Sdteske# 332256361Sdteske# The prefixes are: 333256361Sdteske# 334256361Sdteske# Prefix Description Multiplier 335256361Sdteske# k kilo 1024 336256361Sdteske# M mega 1048576 337256361Sdteske# G giga 1073741824 338256361Sdteske# T tera 1099511627776 339256361Sdteske# P peta 1125899906842624 340256361Sdteske# E exa 1152921504606846976 341256361Sdteske# 342256361Sdteske# NOTE: Prefixes are case-insensitive. 343256361Sdteske# 344256392Sdteske# Upon successful completion, success status is returned; otherwise the number 345256392Sdteske# -1 is produced ($var_to_set set to -1 or if $var_to_set is NULL or missing) 346256392Sdteske# on standard output. In the case of failure, the error status will be one of: 347256361Sdteske# 348256392Sdteske# Status Reason 349256392Sdteske# 1 Given $string contains no digits 350256392Sdteske# 2 An unrecognized prefix was given 351256392Sdteske# 3 Result too large to calculate 352256361Sdteske# 353256361Sdteskef_expand_number() 354256361Sdteske{ 355256361Sdteske local __string="$1" __var_to_set="$2" 356256392Sdteske local __cp __num __bshift __maxinput 357256361Sdteske 358256361Sdteske # Remove any leading non-digits 359256361Sdteske while :; do 360256361Sdteske __cp="$__string" 361256361Sdteske __string="${__cp#[!0-9]}" 362256361Sdteske [ "$__string" = "$__cp" ] && break 363256361Sdteske done 364256361Sdteske 365256392Sdteske # Produce `-1' if string didn't contain any digits 366256361Sdteske if [ ! "$__string" ]; then 367256361Sdteske if [ "$__var_to_set" ]; then 368256361Sdteske setvar "$__var_to_set" -1 369256361Sdteske else 370256361Sdteske echo -1 371256361Sdteske fi 372256392Sdteske return 1 # 1 = "Given $string contains no digits" 373256361Sdteske fi 374256361Sdteske 375256361Sdteske # Store the numbers 376256361Sdteske __num="${__string%%[!0-9]*}" 377256361Sdteske 378256361Sdteske # Shortcut 379256361Sdteske if [ $__num -eq 0 ]; then 380256361Sdteske if [ "$__var_to_set" ]; then 381256361Sdteske setvar "$__var_to_set" 0 382256361Sdteske else 383256361Sdteske echo 0 384256361Sdteske fi 385256361Sdteske return $SUCCESS 386256361Sdteske fi 387256361Sdteske 388256361Sdteske # Remove all the leading numbers from the string to get at the prefix 389256361Sdteske while :; do 390256361Sdteske __cp="$__string" 391256361Sdteske __string="${__cp#[0-9]}" 392256361Sdteske [ "$__string" = "$__cp" ] && break 393256361Sdteske done 394256361Sdteske 395256392Sdteske # 396256392Sdteske # Test for invalid prefix (and determine bitshift length) 397256392Sdteske # 398256361Sdteske case "$__string" in 399256392Sdteske ""|[[:space:]]*) # Shortcut 400256392Sdteske if [ "$__var_to_set" ]; then 401256392Sdteske setvar "$__var_to_set" $__num 402256392Sdteske else 403256392Sdteske echo $__num 404256392Sdteske fi 405256392Sdteske return $SUCCESS ;; 406256392Sdteske [Kk]*) __bshift=10 ;; 407256392Sdteske [Mm]*) __bshift=20 ;; 408256392Sdteske [Gg]*) __bshift=30 ;; 409256392Sdteske [Tt]*) __bshift=40 ;; 410256392Sdteske [Pp]*) __bshift=50 ;; 411256392Sdteske [Ee]*) __bshift=60 ;; 412256361Sdteske *) 413256361Sdteske # Unknown prefix 414256361Sdteske if [ "$__var_to_set" ]; then 415256361Sdteske setvar "$__var_to_set" -1 416256361Sdteske else 417256361Sdteske echo -1 418256361Sdteske fi 419256392Sdteske return 2 # 2 = "An unrecognized prefix was given" 420256361Sdteske esac 421256361Sdteske 422256392Sdteske # Determine if the wheels fall off 423256392Sdteske __maxinput=$(( 0x7fffffffffffffff >> $__bshift )) 424256392Sdteske if [ $__num -gt $__maxinput ]; then 425256392Sdteske # Input (before expanding) would exceed 64-bit signed int 426256361Sdteske if [ "$__var_to_set" ]; then 427256361Sdteske setvar "$__var_to_set" -1 428256361Sdteske else 429256361Sdteske echo -1 430256361Sdteske fi 431256392Sdteske return 3 # 3 = "Result too large to calculate" 432256361Sdteske fi 433256361Sdteske 434256392Sdteske # Shift the number out and produce it 435256392Sdteske __num=$(( $__num << $__bshift )) 436256361Sdteske if [ "$__var_to_set" ]; then 437256361Sdteske setvar "$__var_to_set" $__num 438256361Sdteske else 439256361Sdteske echo $__num 440256361Sdteske fi 441256361Sdteske} 442256361Sdteske 443249751Sdteske############################################################ MAIN 444249751Sdteske 445244675Sdteskef_dprintf "%s: Successfully loaded." strings.subr 446244675Sdteske 447238438Sdteskefi # ! $_STRINGS_SUBR 448