From cbc346b279b5c08b281c9901b994a58eb037a60d Mon Sep 17 00:00:00 2001
From: Edd Salkield <edd@salkield.uk>
Date: Sat, 18 Jan 2020 18:40:45 +0000
Subject: Fix shell globbing bugs

There are several problems leading to the unintentional globbing issue:

Firstly, within `rcup` and `rcdn`, when constructing arguments to pass
to `lsrc`, the _for_ loops over the arguments do not have quoted
variables, leading to globbing.  I have quoted these accordingly.

Secondly, `lsrc` is invoked as follows:

```sh
dests_and_srcs="$(lsrc $LS_ARGS)"
```

When shells use command substitution like this, they go through two stages:

- Word expansion. This is useful because it splits `LS_ARGS` back up
into its constituent strings.
- File name expansion. The side effect of this is to introduce globbing.

You can read more about how this works [here](https://www.tldp.org/LDP/Bash-Beginners-Guide/html/sect_03_04.html#sect_03_04_07).

To fix this, I have passed `lsrc` and its arguments to `eval`.  This
involves quoting the relevant arguments, so:

```sh
for dotfiles_dir in "$DOTFILES_DIRS"; do
  LS_ARGS="$LS_ARGS -d $dotfiles_dir"
done
```

becomes

```sh
for dotfiles_dir in "$DOTFILES_DIRS"; do
  LS_ARGS="$LS_ARGS -d \"$dotfiles_dir\""
done
```

Then `lsrc` is invoked as follows:

```sh
dests_and_srcs="$(eval "lsrc $LS_ARGS")"
```

There is one final non-globbing issue: the parsing of arguments can
introduce extra spaces in the variables, which then trip up the
`dotfiles_dir_excludes` function. For example:

```sh
I) includes="$includes $OPTARG";;
```

introduces a space if `includes` is empty or null.

I have introduced the function `append_variable`, which allows two
variables to be appended without introducing unnecessary whitespace.
Then the additional whitespace is never added in the first place.

Fixes #256.
---
 test/lsrc-globs.t | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 test/lsrc-globs.t

(limited to 'test/lsrc-globs.t')

diff --git a/test/lsrc-globs.t b/test/lsrc-globs.t
new file mode 100644
index 0000000..cf04385
--- /dev/null
+++ b/test/lsrc-globs.t
@@ -0,0 +1,7 @@
+  $ . "$TESTDIR/helper.sh"
+
+Keeps globs as globs
+
+  $ mkdir vimulator
+  > lsrc -vvv -x '*vim*' 2>&1 | grep exclude_file_globs
+  exclude_file_globs: *vim*
-- 
cgit v1.2.3