src/env_parallel.sh

   1 #!/usr/bin/env sh
   2
   3 # This file must be sourced in sh:
   4 #
   5 #   . `which env_parallel.sh`
   6 #
   7 # after which 'env_parallel' works
   8 #
   9 #
  10 # Copyright (C) 2016-2019
  11 # Ole Tange and Free Software Foundation, Inc.
  12 #
  13 # This program is free software; you can redistribute it and/or modify
  14 # it under the terms of the GNU General Public License as published by
  15 # the Free Software Foundation; either version 3 of the License, or
  16 # (at your option) any later version.
  17 #
  18 # This program is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, see <http://www.gnu.org/licenses/>
  25 # or write to the Free Software Foundation, Inc., 51 Franklin St,
  26 # Fifth Floor, Boston, MA 02110-1301 USA
  27
  28 env_parallel() {
  29     # env_parallel.sh
  30
  31     _names_of_ALIASES() {
  32         # alias fails on Unixware 5
  33         for _i in `alias 2>/dev/null | perl -ne 's/^alias //;s/^(\S+)=.*/$1/ && print' 2>/dev/null`; do
  34             # Check if this name really is an alias
  35             # or just part of a multiline alias definition
  36             if alias $_i >/dev/null 2>/dev/null; then
  37                 echo $_i
  38             fi
  39         done
  40     }
  41     _bodies_of_ALIASES() {
  42         # alias may return:
  43         #   myalias='definition' (GNU/Linux ash)
  44         #   alias myalias='definition' (FreeBSD ash)
  45         # so remove 'alias ' from first line
  46         for _i in "$@"; do
  47                 echo 'alias '"`alias $_i | perl -pe '1..1 and s/^alias //'`"
  48         done
  49     }
  50     _names_of_maybe_FUNCTIONS() {
  51         set | perl -ne '/^([A-Z_0-9]+)\s*\(\)\s*\{?$/i and print "$1\n"'
  52     }
  53     _names_of_FUNCTIONS() {
  54         # myfunc is a function
  55         LANG=C type `_names_of_maybe_FUNCTIONS` |
  56             perl -ne '/^(\S+) is a function$/ and not $seen{$1}++ and print "$1\n"'
  57     }
  58     _bodies_of_FUNCTIONS() {
  59         LANG=C type "$@" | perl -ne '/^(\S+) is a function$/ or print'
  60     }
  61     _names_of_VARIABLES() {
  62         # This may screw up if variables contain \n and =
  63         set | perl -ne 's/^(\S+?)=.*/$1/ and print;'
  64     }
  65     _bodies_of_VARIABLES() {
  66         # Crappy typeset -p
  67         for _i in "$@"
  68         do
  69             perl -e 'print @ARGV' "$_i="
  70             eval echo \"\$$_i\" | perl -e '$/=undef; $a=<>; chop($a); print $a' |
  71                 perl -pe 's/[\002-\011\013-\032\\\#\?\`\(\)\{\}\[\]\^\*\<\=\>\~\|\; \"\!\$\&\202-\377]/\\$&/go;'"s/'/\\\'/g; s/[\n]/'\\n'/go;";
  72             echo
  73         done
  74     }
  75     _ignore_HARDCODED() {
  76         # These names cannot be detected
  77         echo '(_|TIMEOUT)'
  78     }
  79     _ignore_READONLY() {
  80         readonly | perl -e '@r = map {
  81                 chomp;
  82                 # sh on UnixWare: readonly TIMEOUT
  83                 # ash: readonly var='val'
  84                 # ksh: var='val'
  85                 s/^(readonly )?([^= ]*)(=.*|)$/$2/ or
  86                 # bash: declare -ar BASH_VERSINFO=([0]="4" [1]="4")
  87                 # zsh: typeset -r var='val'
  88                   s/^\S+\s+\S+\s+(\S[^=]*)(=.*|$)/$1/;
  89                 $_ } <>;
  90             $vars = join "|",map { quotemeta $_ } @r;
  91             print $vars ? "($vars)" : "(,,nO,,VaRs,,)";
  92             '
  93     }
  94     _remove_bad_NAMES() {
  95         # Do not transfer vars and funcs from env_parallel
  96         _ignore_RO="`_ignore_READONLY`"
  97         _ignore_HARD="`_ignore_HARDCODED`"
  98         # Macos-grep does not like long patterns
  99         # Old Solaris grep does not support -E
 100         # Perl Version of:
 101         # grep -Ev '^(...)$' |
 102         perl -ne '/^(
 103                      PARALLEL_ENV|
 104                      PARALLEL_TMP|
 105                      _alias_NAMES|
 106                      _bodies_of_ALIASES|
 107                      _bodies_of_FUNCTIONS|
 108                      _bodies_of_VARIABLES|
 109                      _error_PAR|
 110                      _function_NAMES|
 111                      _get_ignored_VARS|
 112                      _grep_REGEXP|
 113                      _ignore_HARD|
 114                      _ignore_HARDCODED|
 115                      _ignore_READONLY|
 116                      _ignore_RO|
 117                      _ignore_UNDERSCORE|
 118                      _list_alias_BODIES|
 119                      _list_function_BODIES|
 120                      _list_variable_VALUES|
 121                      _make_grep_REGEXP|
 122                      _names_of_ALIASES|
 123                      _names_of_FUNCTIONS|
 124                      _names_of_VARIABLES|
 125                      _names_of_maybe_FUNCTIONS|
 126                      _parallel_exit_CODE|
 127                      _prefix_PARALLEL_ENV|
 128                      _prefix_PARALLEL_ENV|
 129                      _remove_bad_NAMES|
 130                      _remove_readonly|
 131                      _variable_NAMES|
 132                      _warning_PAR|
 133                      _which_PAR)$/x and next;
 134             # Filter names matching --env
 135             /^'"$_grep_REGEXP"'$/ or next;
 136             /^'"$_ignore_UNDERSCORE"'$/ and next;
 137             # Remove readonly variables
 138             /^'"$_ignore_RO"'$/ and next;
 139             /^'"$_ignore_HARD"'$/ and next;
 140             print;'
 141     }
 142     _get_ignored_VARS() {
 143         perl -e '
 144             for(@ARGV){
 145                 $next_is_env and push @envvar, split/,/, $_;
 146                 $next_is_env=/^--env$/;
 147             }
 148             if(grep { /^_$/ } @envvar) {
 149                 if(not open(IN, "<", "$ENV{HOME}/.parallel/ignored_vars")) {
 150                     print STDERR "parallel: Error: ",
 151                     "Run \"parallel --record-env\" in a clean environment first.\n";
 152                 } else {
 153                     chomp(@ignored_vars = <IN>);
 154                 }
 155             }
 156             if($ENV{PARALLEL_IGNORED_NAMES}) {
 157                 push @ignored_vars, split/\s+/, $ENV{PARALLEL_IGNORED_NAMES};
 158                 chomp @ignored_vars;
 159             }
 160             $vars = join "|",map { quotemeta $_ } @ignored_vars;
 161             print $vars ? "($vars)" : "(,,nO,,VaRs,,)";
 162             ' -- "$@"
 163     }
 164
 165     # Get the --env variables if set
 166     # --env _ should be ignored
 167     # and convert  a b c  to (a|b|c)
 168     # If --env not set: Match everything (.*)
 169     _make_grep_REGEXP() {
 170         perl -e '
 171             for(@ARGV){
 172                 /^_$/ and $next_is_env = 0;
 173                 $next_is_env and push @envvar, split/,/, $_;
 174                 $next_is_env = /^--env$/;
 175             }
 176             $vars = join "|",map { quotemeta $_ } @envvar;
 177             print $vars ? "($vars)" : "(.*)";
 178             ' -- "$@"
 179     }
 180     _which_PAR() {
 181         # type returns:
 182         #   ll is an alias for ls -l (in ash)
 183         #   bash is a tracked alias for /bin/bash
 184         #   true is a shell builtin (in bash)
 185         #   myfunc is a function (in bash)
 186         #   myfunc is a shell function (in zsh)
 187         #   which is /usr/bin/which (in sh, bash)
 188         #   which is hashed (/usr/bin/which)
 189         #   gi is aliased to `grep -i' (in bash)
 190         # Return 0 if found, 1 otherwise
 191         LANG=C type "$@" |
 192             perl -pe '$exit += (s/ is an alias for .*// ||
 193                                 s/ is aliased to .*// ||
 194                                 s/ is a function// ||
 195                                 s/ is a shell function// ||
 196                                 s/ is a shell builtin// ||
 197                                 s/.* is hashed .(\S+).$/$1/ ||
 198                                 s/.* is (a tracked alias for )?//);
 199                       END { exit not $exit }'
 200     }
 201     _warning_PAR() {
 202         echo "env_parallel: Warning: $@" >&2
 203     }
 204     _error_PAR() {
 205         echo "env_parallel: Error: $@" >&2
 206     }
 207
 208     if _which_PAR parallel >/dev/null; then
 209         true parallel found in path
 210     else
 211         _error_PAR 'parallel must be in $PATH.'
 212         return 255
 213     fi
 214
 215     # Grep regexp for vars given by --env
 216     _grep_REGEXP="`_make_grep_REGEXP \"$@\"`"
 217
 218     # Deal with --env _
 219     _ignore_UNDERSCORE="`_get_ignored_VARS \"$@\"`"
 220
 221     # --record-env
 222     if perl -e 'exit grep { /^--record-env$/ } @ARGV' -- "$@"; then
 223         true skip
 224     else
 225         (_names_of_ALIASES;
 226          _names_of_FUNCTIONS;
 227          _names_of_VARIABLES) |
 228             cat > $HOME/.parallel/ignored_vars
 229         return 0
 230     fi
 231
 232     # --session
 233     if perl -e 'exit grep { /^--session$/ } @ARGV' -- "$@"; then
 234         true skip
 235     else
 236         PARALLEL_IGNORED_NAMES="`_names_of_ALIASES;
 237          _names_of_FUNCTIONS;
 238          _names_of_VARIABLES`"
 239         export PARALLEL_IGNORED_NAMES
 240         return 0
 241     fi
 242
 243     # Grep alias names
 244     _alias_NAMES="`_names_of_ALIASES | _remove_bad_NAMES | xargs echo`"
 245     _list_alias_BODIES="_bodies_of_ALIASES $_alias_NAMES"
 246     if [ "$_alias_NAMES" = "" ] ; then
 247         # no aliases selected
 248         _list_alias_BODIES="true"
 249     fi
 250     unset _alias_NAMES
 251
 252     # Grep function names
 253     _function_NAMES="`_names_of_FUNCTIONS | _remove_bad_NAMES | xargs echo`"
 254     _list_function_BODIES="_bodies_of_FUNCTIONS $_function_NAMES"
 255     if [ "$_function_NAMES" = "" ] ; then
 256         # no functions selected
 257         _list_function_BODIES="true"
 258     fi
 259     unset _function_NAMES
 260
 261     # Grep variable names
 262     _variable_NAMES="`_names_of_VARIABLES | _remove_bad_NAMES | xargs echo`"
 263     _list_variable_VALUES="_bodies_of_VARIABLES $_variable_NAMES"
 264     if [ "$_variable_NAMES" = "" ] ; then
 265         # no variables selected
 266         _list_variable_VALUES="true"
 267     fi
 268     unset _variable_NAMES
 269
 270     PARALLEL_ENV="`
 271         $_list_alias_BODIES;
 272         $_list_function_BODIES;
 273         $_list_variable_VALUES;
 274     `"
 275     export PARALLEL_ENV
 276     unset _list_alias_BODIES
 277     unset _list_variable_VALUES
 278     unset _list_function_BODIES
 279     unset _grep_REGEXP
 280     unset _ignore_UNDERSCORE
 281     # Test if environment is too big
 282     if `_which_PAR true` >/dev/null 2>/dev/null ; then
 283         parallel "$@";
 284         _parallel_exit_CODE=$?
 285         unset PARALLEL_ENV;
 286         return $_parallel_exit_CODE
 287     else
 288         unset PARALLEL_ENV;
 289         _error_PAR "Your environment is too big."
 290         _error_PAR "You can try 3 different approaches:"
 291         _error_PAR "1. Run 'env_parallel --session' before you set"
 292         _error_PAR "   variables or define functions."
 293         _error_PAR "2. Use --env and only mention the names to copy."
 294         _error_PAR "3. Try running this in a clean environment once:"
 295         _error_PAR "     env_parallel --record-env"
 296         _error_PAR "   And then use '--env _'"
 297         _error_PAR "For details see: man env_parallel"
 298         return 255
 299     fi
 300 }
 301
 302 parset() {
 303     _parset_PARALLEL_PRG=parallel
 304     _parset_main "$@"
 305 }
 306
 307 env_parset() {
 308     _parset_PARALLEL_PRG=env_parallel
 309     _parset_main "$@"
 310 }
 311
 312 _parset_main() {
 313     # If $1 contains ',' or space:
 314     #   Split on , to get the destination variable names
 315     # If $1 is a single destination variable name:
 316     #   Treat it as the name of an array
 317     #
 318     #   # Create array named myvar
 319     #   parset myvar echo ::: {1..10}
 320     #   echo ${myvar[5]}
 321     #
 322     #   # Put output into $var_a $var_b $var_c
 323     #   varnames=(var_a var_b var_c)
 324     #   parset "${varnames[*]}" echo ::: {1..3}
 325     #   echo $var_c
 326     #
 327     #   # Put output into $var_a4 $var_b4 $var_c4
 328     #   parset "var_a4 var_b4 var_c4" echo ::: {1..3}
 329     #   echo $var_c4
 330
 331     _make_TEMP() {
 332         # mktemp does not exist on some OS
 333         perl -e 'use File::Temp qw(tempfile);
 334                  $ENV{"TMPDIR"} ||= "/tmp";
 335                  print((tempfile(DIR=>$ENV{"TMPDIR"}, TEMPLATE => "parXXXXX"))[1])'
 336     }
 337
 338     _parset_NAME="$1"
 339     if [ "$_parset_NAME" = "" ] ; then
 340         echo parset: Error: No destination variable given. >&2
 341         echo parset: Error: Try: >&2
 342         echo parset: Error: ' ' parset myarray echo ::: foo bar >&2
 343         return 255
 344     fi
 345     shift
 346     echo "$_parset_NAME" |
 347         perl -ne 'chomp;for (split /[, ]/) {
 348             # Allow: var_32 var[3]
 349             if(not /^[a-zA-Z_][a-zA-Z_0-9]*(\[\d+\])?$/) {
 350                 print STDERR "parset: Error: $_ is an invalid variable name.\n";
 351                 print STDERR "parset: Error: Variable names must be letter followed by letters or digits.\n";
 352                 $exitval = 255;
 353             }
 354         }
 355         exit $exitval;
 356         ' || return 255
 357     _exit_FILE=`_make_TEMP`
 358     if perl -e 'exit not grep /,| /, @ARGV' "$_parset_NAME" ; then
 359         # $_parset_NAME contains , or space
 360         # Split on , or space to get the names
 361         eval "`
 362             # Compute results into files
 363             ($_parset_PARALLEL_PRG --files -k "$@"; echo $? > "$_exit_FILE") |
 364                 # var1= cat tmpfile1; rm tmpfile1
 365                 # var2= cat tmpfile2; rm tmpfile2
 366                 parallel -q echo {2}='\`cat {1}; rm {1}\`' :::: - :::+ \`
 367                     echo "$_parset_NAME" |
 368                         perl -pe 's/,/ /g'
 369                          \`
 370             `"
 371     else
 372         # $_parset_NAME does not contain , or space
 373         # => $_parset_NAME is the name of the array to put data into
 374         # Supported in: bash zsh ksh mksh
 375         # Arrays do not work in: sh ash dash
 376         eval "$_parset_NAME=( $(
 377             # Compute results into files. Save exit value
 378             ($_parset_PARALLEL_PRG --files -k "$@"; echo $? > "$_exit_FILE") |
 379                 perl -pe 'chop;$_="\"\`cat $_; rm $_\`\" "'
 380             ) )"
 381     fi
 382     return `cat "$_exit_FILE"; rm "$_exit_FILE"`
 383 }