yadm/yadm

1083 lines
27 KiB
Plaintext
Raw Normal View History

2016-06-18 11:33:49 -04:00
#!/bin/sh
2015-07-14 08:48:47 -04:00
# yadm - Yet Another Dotfiles Manager
# Copyright (C) 2015-2017 Tim Byrne
2015-07-14 08:48:47 -04:00
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
2016-06-18 11:33:49 -04:00
#; execute script with bash (shebang line is /bin/sh for portability)
if [ -z "$BASH_VERSION" ]; then
[ "$YADM_TEST" != 1 ] && exec bash "$0" "$@"
fi
VERSION=1.11.1
2015-07-14 08:48:47 -04:00
YADM_WORK="$HOME"
YADM_DIR="$HOME/.yadm"
YADM_REPO="repo.git"
YADM_CONFIG="config"
YADM_ENCRYPT="encrypt"
YADM_ARCHIVE="files.gpg"
2017-01-23 18:23:06 -05:00
YADM_BOOTSTRAP="bootstrap"
2015-07-14 08:48:47 -04:00
HOOK_COMMAND=""
FULL_COMMAND=""
2016-08-13 18:17:16 -04:00
GPG_PROGRAM="gpg"
GIT_PROGRAM="git"
LS_PROGRAM="/bin/ls"
ENVTPL_PROGRAM="envtpl"
LSB_RELEASE_PROGRAM="lsb_release"
2016-08-13 18:17:16 -04:00
PROC_VERSION="/proc/version"
OPERATING_SYSTEM="Unknown"
#; flag causing path translations with cygpath
USE_CYGPATH=0
2015-07-14 08:48:47 -04:00
#; flag when something may have changes (which prompts auto actions to be performed)
CHANGES_POSSIBLE=0
2017-01-25 02:07:07 -05:00
#; flag when a bootstrap should be performed after cloning
#; 0: skip auto_bootstrap, 1: ask, 2: perform bootstrap, 3: prevent bootstrap
DO_BOOTSTRAP=0
2015-07-14 08:48:47 -04:00
function main() {
require_git
#; capture full command, for passing to hooks
FULL_COMMAND="$*"
2015-07-14 08:48:47 -04:00
#; create the YADM_DIR if it doesn't exist yet
2016-04-05 09:52:21 -04:00
[ -d "$YADM_DIR" ] || mkdir -p "$YADM_DIR"
2015-07-14 08:48:47 -04:00
#; parse command line arguments
local retval=0
internal_commands="^(alt|bootstrap|clean|clone|config|decrypt|encrypt|enter|help|init|introspect|list|perms|version)$"
2015-07-14 08:48:47 -04:00
if [ -z "$*" ] ; then
#; no argumnts will result in help()
help
elif [[ "$1" =~ $internal_commands ]] ; then
#; for internal commands, process all of the arguments
YADM_COMMAND="$1"
2016-04-05 09:52:21 -04:00
YADM_ARGS=()
2015-07-14 08:48:47 -04:00
shift
2016-04-05 09:52:21 -04:00
while [[ $# -gt 0 ]] ; do
2015-07-14 08:48:47 -04:00
key="$1"
case $key in
-a) #; used by list()
2015-07-14 08:48:47 -04:00
LIST_ALL="YES"
;;
-d) #; used by all commands
2015-07-14 08:48:47 -04:00
DEBUG="YES"
;;
-f) #; used by init() and clone()
2015-07-14 08:48:47 -04:00
FORCE="YES"
;;
2015-07-16 21:57:53 -04:00
-l) #; used by decrypt()
DO_LIST="YES"
;;
-w) #; used by init() and clone()
2015-07-14 08:48:47 -04:00
if [[ ! "$2" =~ ^/ ]] ; then
error_out "You must specify a fully qualified work tree"
fi
YADM_WORK="$2"
shift
;;
*) #; any unhandled arguments
2016-04-05 09:52:21 -04:00
YADM_ARGS+=("$1")
2015-07-14 08:48:47 -04:00
;;
esac
shift
done
2016-04-05 09:52:21 -04:00
[ ! -d "$YADM_WORK" ] && error_out "Work tree does not exist: [$YADM_WORK]"
HOOK_COMMAND="$YADM_COMMAND"
invoke_hook "pre"
2016-04-05 09:52:21 -04:00
$YADM_COMMAND "${YADM_ARGS[@]}"
2015-07-14 08:48:47 -04:00
else
#; any other commands are simply passed through to git
HOOK_COMMAND="$1"
invoke_hook "pre"
2015-07-14 08:48:47 -04:00
git_command "$@"
retval="$?"
2015-07-14 08:48:47 -04:00
fi
#; process automatic events
auto_alt
auto_perms
2017-01-25 02:07:07 -05:00
auto_bootstrap
2015-07-14 08:48:47 -04:00
exit_with_hook $retval
2016-03-23 20:13:04 -04:00
2015-07-14 08:48:47 -04:00
}
#; ****** yadm Commands ******
2015-07-14 08:48:47 -04:00
function alt() {
require_repo
local_class="$(config local.class)"
if [ -z "$local_class" ] ; then
match_class="%"
else
match_class="$local_class"
fi
match_class="(%|$match_class)"
local_system="$(config local.os)"
if [ -z "$local_system" ] ; then
local_system="$OPERATING_SYSTEM"
2017-01-18 20:51:28 -05:00
fi
match_system="(%|$local_system)"
2017-01-18 20:51:28 -05:00
2017-03-31 08:55:43 -04:00
local_host="$(config local.hostname)"
if [ -z "$local_host" ] ; then
local_host=$(hostname)
local_host=${local_host%%.*} #; trim any domain from hostname
2017-01-18 20:51:28 -05:00
fi
match_host="(%|$local_host)"
2017-01-18 20:51:28 -05:00
local_user="$(config local.user)"
if [ -z "$local_user" ] ; then
local_user=$(id -u -n)
2017-01-18 20:51:28 -05:00
fi
match_user="(%|$local_user)"
2017-01-18 20:51:28 -05:00
#; regex for matching "<file>##CLASS.SYSTEM.HOSTNAME.USER"
match1="^(.+)##(()|$match_system|$match_system\.$match_host|$match_system\.$match_host\.$match_user)$"
match2="^(.+)##($match_class|$match_class\.$match_system|$match_class\.$match_system\.$match_host|$match_class\.$match_system\.$match_host\.$match_user)$"
2015-07-14 08:48:47 -04:00
#; process relative to YADM_WORK
YADM_WORK=$(unix_path "$("$GIT_PROGRAM" config core.worktree)")
2016-04-05 09:52:21 -04:00
cd "$YADM_WORK" || {
debug "Alternates not processed, unable to cd to $YADM_WORK"
return
}
2015-07-14 08:48:47 -04:00
#; only be noisy if the "alt" command was run directly
2015-07-17 17:21:47 -04:00
[ "$YADM_COMMAND" = "alt" ] && loud="YES"
2015-07-14 08:48:47 -04:00
#; build a list of files from YADM_ENCRYPT
ENC_FILES=()
index=0
if [ -f "$YADM_ENCRYPT" ] ; then
while IFS='' read -r glob || [ -n "$glob" ]; do
if [[ ! $glob =~ ^# && ! $glob =~ ^[[:space:]]*$ ]] ; then
# echo "working on ->$glob<-"
local IFS=$'\n'
for matching_file in $(eval "$LS_PROGRAM" "$glob" 2>/dev/null); do
ENC_FILES[$index]="$matching_file"
((index++))
done
fi
done < "$YADM_ENCRYPT"
fi
#; decide if a copy should be done instead of a symbolic link
local do_copy=0
if [[ $OPERATING_SYSTEM == CYGWIN* ]] ; then
if [[ $(config --bool yadm.cygwin-copy) == "true" ]] ; then
do_copy=1
fi
fi
2015-07-14 08:48:47 -04:00
#; loop over all "tracked" files
#; for every file which matches the above regex, create a symlink
for match in $match1 $match2; do
last_linked=''
local IFS=$'\n'
for tracked_file in $("$GIT_PROGRAM" ls-files | sort) "${ENC_FILES[@]}"; do
tracked_file="$YADM_WORK/$tracked_file"
#; process both the path, and it's parent directory
for alt_path in "$tracked_file" "${tracked_file%/*}"; do
if [ -e "$alt_path" ] ; then
if [[ $alt_path =~ $match ]] ; then
if [ "$alt_path" != "$last_linked" ] ; then
new_link="${BASH_REMATCH[1]}"
debug "Linking $alt_path to $new_link"
[ -n "$loud" ] && echo "Linking $alt_path to $new_link"
if [ "$do_copy" -eq 1 ]; then
if [ -L "$new_link" ]; then
rm -f "$new_link"
fi
cp -f "$alt_path" "$new_link"
else
ln -nfs "$alt_path" "$new_link"
fi
last_linked="$alt_path"
fi
fi
fi
done
done
2015-07-14 08:48:47 -04:00
done
#; loop over all "tracked" files
#; for every file which is a *##yadm.j2 create a real file
local IFS=$'\n'
local match="^(.+)##yadm\\.j2$"
for tracked_file in $("$GIT_PROGRAM" ls-files | sort) $(cat "$YADM_ENCRYPT" 2>/dev/null); do
tracked_file="$YADM_WORK/$tracked_file"
if [ -e "$tracked_file" ] ; then
if [[ $tracked_file =~ $match ]] ; then
real_file="${BASH_REMATCH[1]}"
if envtpl_available; then
debug "Creating $real_file from template $tracked_file"
[ -n "$loud" ] && echo "Creating $real_file from template $tracked_file"
YADM_CLASS="$local_class" \
YADM_OS="$local_system" \
YADM_HOSTNAME="$local_host" \
YADM_USER="$local_user" \
YADM_DISTRO=$(query_distro) \
"$ENVTPL_PROGRAM" < "$tracked_file" > "$real_file"
else
debug "envtpl not available, not creating $real_file from template $tracked_file"
[ -n "$loud" ] && echo "envtpl not available, not creating $real_file from template $tracked_file"
fi
fi
fi
done
2015-07-14 08:48:47 -04:00
}
2017-01-23 18:23:06 -05:00
function bootstrap() {
bootstrap_available || error_out "Cannot execute bootstrap\n'$YADM_BOOTSTRAP' is not an executable program."
# GIT_DIR should not be set for user's bootstrap code
unset GIT_DIR
2017-01-23 18:23:06 -05:00
echo "Executing $YADM_BOOTSTRAP"
exec "$YADM_BOOTSTRAP"
}
2015-07-14 08:48:47 -04:00
function clean() {
error_out "\"git clean\" has been disabled for safety. You could end up removing all unmanaged files."
}
function clone() {
2017-01-25 02:07:07 -05:00
DO_BOOTSTRAP=1
clone_args=()
while [[ $# -gt 0 ]] ; do
key="$1"
case $key in
--bootstrap) #; force bootstrap, without prompt
DO_BOOTSTRAP=2
;;
--no-bootstrap) #; prevent bootstrap, without prompt
DO_BOOTSTRAP=3
;;
*) #; main arguments are kept intact
clone_args+=("$1")
;;
esac
shift
done
[ -n "$DEBUG" ] && display_private_perms "initial"
2015-07-14 08:48:47 -04:00
#; clone will begin with a bare repo
local empty=
init $empty
2015-07-14 08:48:47 -04:00
#; add the specified remote, and configure the repo to track origin/master
debug "Adding remote to new repo"
2017-01-25 02:07:07 -05:00
"$GIT_PROGRAM" remote add origin "${clone_args[@]}"
2015-07-14 08:48:47 -04:00
debug "Configuring new repo to track origin/master"
"$GIT_PROGRAM" config branch.master.remote origin
"$GIT_PROGRAM" config branch.master.merge refs/heads/master
2015-07-14 08:48:47 -04:00
#; fetch / merge (and possibly fallback to reset)
debug "Doing an initial fetch of the origin"
"$GIT_PROGRAM" fetch origin || {
debug "Removing repo after failed clone"
rm -rf "$YADM_REPO"
2017-01-25 02:07:07 -05:00
error_out "Unable to fetch origin ${clone_args[0]}"
}
debug "Determining if repo tracks private directories"
for private_dir in .ssh/ .gnupg/; do
found_log=$("$GIT_PROGRAM" log -n 1 origin/master -- "$private_dir" 2>/dev/null)
if [ -n "$found_log" ]; then
debug "Private directory $private_dir is tracked by repo"
assert_private_dirs "$private_dir"
fi
done
[ -n "$DEBUG" ] && display_private_perms "pre-merge"
2015-07-14 09:16:45 -04:00
debug "Doing an initial merge of origin/master"
"$GIT_PROGRAM" merge origin/master || {
debug "Merge failed, doing a reset and stashing conflicts."
"$GIT_PROGRAM" reset origin/master
if cd "$YADM_WORK"; then # necessary because of a bug in Git
"$GIT_PROGRAM" -c user.name='yadm clone' -c user.email='yadm' stash save Conflicts preserved from yadm clone command 2>&1
cat <<EOF
**NOTE**
Merging origin/master failed.
As a result, yadm did 'reset origin/master', and then
stashed the conflicting data.
This likely happened because you had files in \$HOME
which conflicted with files tracked by origin/master.
You can review the stashed conflicts with the
command 'yadm stash show -p' from within your
\$HOME directory. If you want to restore the
stashed data, you can run 'yadm stash apply' or
'yadm stash pop' and then handle the conflicts
in another way.
EOF
else
2017-01-25 02:07:07 -05:00
#; skip auto_bootstrap if conflicts could not be stashed
DO_BOOTSTRAP=0
cat <<EOF
2015-07-14 08:48:47 -04:00
**NOTE**
Merging origin/master failed.
yadm did 'reset origin/master' instead.
2015-07-14 08:48:47 -04:00
yadm did not stash these conflicts beacuse it was unable
to change to the $YADM_WORK directory.
2015-07-14 08:48:47 -04:00
Please review and resolve any differences appropriately
If you know what you're doing, and want to overwrite the
tracked files, consider 'yadm reset --hard origin/master'
EOF
fi
2015-07-14 08:48:47 -04:00
}
[ -n "$DEBUG" ] && display_private_perms "post-merge"
2015-07-14 08:48:47 -04:00
CHANGES_POSSIBLE=1
}
function config() {
use_repo_config=0
2017-03-31 08:55:43 -04:00
local_options="^local\.(class|os|hostname|user)$"
for option in "$@"; do
[[ "$option" =~ $local_options ]] && use_repo_config=1
done
if [ -z "$*" ] ; then
2015-07-14 08:48:47 -04:00
#; with no parameters, provide some helpful documentation
echo "yadm supports the following configurations:"
echo
for supported_config in $(introspect_configs); do
echo " ${supported_config}"
done
echo
cat << EOF
Please read the CONFIGURATION section in the man
page for more details about configurations, and
how to adjust them.
EOF
elif [ "$use_repo_config" -eq 1 ]; then
require_repo
#; operate on the yadm repo's configuration file
#; this is always local to the machine
git config --local "$@"
CHANGES_POSSIBLE=1
2015-07-14 08:48:47 -04:00
else
#; operate on the yadm configuration file
git config --file="$(mixed_path "$YADM_CONFIG")" "$@"
2017-01-21 12:41:14 -05:00
2015-07-14 08:48:47 -04:00
fi
}
function decrypt() {
require_gpg
require_archive
YADM_WORK=$(unix_path "$("$GIT_PROGRAM" config core.worktree)")
2015-07-14 08:48:47 -04:00
2015-07-17 17:21:47 -04:00
if [ "$DO_LIST" = "YES" ] ; then
2015-07-16 21:57:53 -04:00
tar_option="t"
else
tar_option="x"
fi
2015-07-14 08:48:47 -04:00
#; decrypt the archive
2017-01-06 18:05:06 -05:00
if ($GPG_PROGRAM -d "$YADM_ARCHIVE" || echo 1) | tar v${tar_option}f - -C "$YADM_WORK"; then
2015-07-17 17:21:47 -04:00
[ ! "$DO_LIST" = "YES" ] && echo "All files decrypted."
2015-07-14 08:48:47 -04:00
else
error_out "Unable to extract encrypted files."
fi
CHANGES_POSSIBLE=1
}
function encrypt() {
require_gpg
require_encrypt
require_ls
2015-07-14 08:48:47 -04:00
#; process relative to YADM_WORK
YADM_WORK=$(unix_path "$("$GIT_PROGRAM" config core.worktree)")
2016-04-05 09:52:21 -04:00
cd "$YADM_WORK" || {
debug "Encryption not processed, unable to cd to $YADM_WORK"
return
}
2015-07-14 08:48:47 -04:00
#; Build gpg options for gpg
GPG_KEY="$(config yadm.gpg-recipient)"
2016-04-21 08:59:43 -04:00
if [ "$GPG_KEY" = "ASK" ]; then
GPG_OPTS=("--no-default-recipient" "-e")
elif [ "$GPG_KEY" != "" ]; then
GPG_OPTS=("-e" "-r $GPG_KEY")
else
2016-04-21 08:59:43 -04:00
GPG_OPTS=("-c")
fi
#; build a list of files from YADM_ENCRYPT
ENC_FILES=()
index=0
2015-07-14 08:48:47 -04:00
while IFS='' read -r glob || [ -n "$glob" ]; do
if [[ ! $glob =~ ^# && ! $glob =~ ^[[:space:]]*$ ]] ; then
local IFS=$'\n'
for matching_file in $(eval "$LS_PROGRAM" "$glob" 2>/dev/null); do
ENC_FILES[$index]="$matching_file"
((index++))
done
2015-07-14 08:48:47 -04:00
fi
done < "$YADM_ENCRYPT"
#; report which files will be encrypted
echo "Encrypting the following files:"
"$LS_PROGRAM" -1 "${ENC_FILES[@]}"
echo
2015-07-14 08:48:47 -04:00
#; encrypt all files which match the globs
if tar -f - -c "${ENC_FILES[@]}" | $GPG_PROGRAM --yes "${GPG_OPTS[@]}" --output "$YADM_ARCHIVE"; then
2015-07-14 08:48:47 -04:00
echo "Wrote new file: $YADM_ARCHIVE"
else
error_out "Unable to write $YADM_ARCHIVE"
fi
2015-07-16 22:33:25 -04:00
#; offer to add YADM_ARCHIVE if untracked
archive_status=$("$GIT_PROGRAM" status --porcelain -uall "$(mixed_path "$YADM_ARCHIVE")" 2>/dev/null)
2015-07-16 22:33:25 -04:00
archive_regex="^\?\?"
if [[ $archive_status =~ $archive_regex ]] ; then
echo "It appears that $YADM_ARCHIVE is not tracked by yadm's repository."
echo "Would you like to add it now? (y/n)"
read -r answer < /dev/tty
2015-07-16 22:33:25 -04:00
if [[ $answer =~ ^[yY]$ ]] ; then
"$GIT_PROGRAM" add "$(mixed_path "$YADM_ARCHIVE")"
2015-07-16 22:33:25 -04:00
fi
fi
2015-07-14 08:48:47 -04:00
CHANGES_POSSIBLE=1
}
function enter() {
2017-03-30 17:30:22 -04:00
require_shell
require_repo
shell_opts=""
shell_path=""
if [[ "$SHELL" =~ bash$ ]]; then
shell_opts="--norc"
shell_path="\w"
elif [[ "$SHELL" =~ [cz]sh$ ]]; then
shell_opts="-f"
shell_path="%~"
fi
echo "Entering yadm repo"
yadm_prompt="yadm shell ($YADM_REPO) $shell_path > "
PROMPT="$yadm_prompt" PS1="$yadm_prompt" "$SHELL" $shell_opts
echo "Leaving yadm repo"
}
2015-07-14 08:48:47 -04:00
function git_command() {
require_repo
#; translate 'gitconfig' to 'config' -- 'config' is reserved for yadm
if [ "$1" = "gitconfig" ] ; then
set -- "config" "${@:2}"
fi
#; ensure private .ssh and .gnupg directories exist first
#; TODO: consider restricting this to only commands which modify the work-tree
auto_private_dirs=$(config --bool yadm.auto-private-dirs)
if [ "$auto_private_dirs" != "false" ] ; then
assert_private_dirs .gnupg/ .ssh/
fi
2015-07-14 08:48:47 -04:00
CHANGES_POSSIBLE=1
#; pass commands through to git
debug "Running git command $GIT_PROGRAM $*"
"$GIT_PROGRAM" "$@"
return "$?"
2015-07-14 08:48:47 -04:00
}
function help() {
cat << EOF
Usage: yadm <command> [options...]
2015-07-14 08:48:47 -04:00
Manage dotfiles maintained in a Git repository. Manage alternate files
for specific systems or hosts. Encrypt/decrypt private files.
Git Commands:
Any Git command or alias can be used as a <command>. It will operate
on yadm's repository and files in the work tree (usually \$HOME).
2015-07-14 08:48:47 -04:00
Commands:
yadm init [-f] - Initialize an empty repository
yadm clone <url> [-f] - Clone an existing repository
yadm config <name> <value> - Configure a setting
yadm list [-a] - List tracked files
yadm alt - Create links for alternates
yadm bootstrap - Execute \$HOME/.yadm/bootstrap
yadm encrypt - Encrypt files
2015-07-16 21:57:53 -04:00
yadm decrypt [-l] - Decrypt files
yadm perms - Fix perms for private files
Files:
\$HOME/.yadm/config - yadm's configuration file
\$HOME/.yadm/repo.git - yadm's Git repository
2015-07-14 08:48:47 -04:00
\$HOME/.yadm/encrypt - List of globs used for encrypt/decrypt
2015-07-16 21:57:53 -04:00
\$HOME/.yadm/files.gpg - Encrypted data stored here
2015-07-14 08:48:47 -04:00
Use "man yadm" for complete documentation.
EOF
exit_with_hook 1
2015-07-14 08:48:47 -04:00
}
function init() {
#; safety check, don't attempt to init when the repo is already present
[ -d "$YADM_REPO" ] && [ -z "$FORCE" ] && \
2016-03-23 20:14:25 -04:00
error_out "Git repo already exists. [$YADM_REPO]\nUse '-f' if you want to force it to be overwritten."
2015-07-14 08:48:47 -04:00
#; remove existing if forcing the init to happen anyway
[ -d "$YADM_REPO" ] && {
debug "Removing existing repo prior to init"
rm -rf "$YADM_REPO"
}
#; init a new bare repo
debug "Init new repo"
"$GIT_PROGRAM" init --shared=0600 --bare "$(mixed_path "$YADM_REPO")" "$@"
2015-07-14 08:48:47 -04:00
configure_repo
CHANGES_POSSIBLE=1
}
function introspect() {
case "$1" in
commands|configs|repo|switches)
"introspect_$1"
;;
esac
}
function introspect_commands() {
cat <<-EOF
alt
bootstrap
clean
clone
config
decrypt
encrypt
enter
gitconfig
help
init
introspect
list
perms
version
EOF
}
function introspect_configs() {
cat << EOF
local.class
local.hostname
local.os
local.user
yadm.auto-alt
yadm.auto-perms
yadm.auto-private-dirs
yadm.cygwin-copy
yadm.git-program
yadm.gpg-perms
yadm.gpg-program
yadm.gpg-recipient
yadm.ssh-perms
EOF
}
function introspect_repo() {
echo "$YADM_REPO"
}
function introspect_switches() {
cat <<-EOF
--yadm-archive
--yadm-bootstrap
--yadm-config
--yadm-dir
--yadm-encrypt
--yadm-repo
-Y
EOF
}
2015-07-14 08:48:47 -04:00
function list() {
require_repo
#; process relative to YADM_WORK when --all is specified
if [ -n "$LIST_ALL" ] ; then
YADM_WORK=$(unix_path "$("$GIT_PROGRAM" config core.worktree)")
2016-04-05 09:52:21 -04:00
cd "$YADM_WORK" || {
debug "List not processed, unable to cd to $YADM_WORK"
return
}
2015-07-14 08:48:47 -04:00
fi
#; list tracked files
"$GIT_PROGRAM" ls-files
2015-07-14 08:48:47 -04:00
}
function perms() {
require_ls
2015-07-14 08:48:47 -04:00
#; TODO: prevent repeats in the files changed
#; process relative to YADM_WORK
YADM_WORK=$(unix_path "$("$GIT_PROGRAM" config core.worktree)")
2016-04-05 09:52:21 -04:00
cd "$YADM_WORK" || {
debug "Perms not processed, unable to cd to $YADM_WORK"
return
}
2015-07-14 08:48:47 -04:00
GLOBS=()
#; include the archive created by "encrypt"
[ -f "$YADM_ARCHIVE" ] && GLOBS=("${GLOBS[@]}" "$YADM_ARCHIVE")
#; include all .ssh files (unless disabled)
if [[ $(config --bool yadm.ssh-perms) != "false" ]] ; then
GLOBS=("${GLOBS[@]}" ".ssh" ".ssh/*")
2015-07-14 08:48:47 -04:00
fi
#; include all gpg files (unless disabled)
if [[ $(config --bool yadm.gpg-perms) != "false" ]] ; then
GLOBS=("${GLOBS[@]}" ".gnupg" ".gnupg/*")
fi
2015-07-14 08:48:47 -04:00
#; include globs found in YADM_ENCRYPT (if present)
if [ -f "$YADM_ENCRYPT" ] ; then
while IFS='' read -r glob || [ -n "$glob" ]; do
if [[ ! $glob =~ ^# ]] ; then
GLOBS=("${GLOBS[@]}" $(eval "$LS_PROGRAM" "$glob" 2>/dev/null))
2015-07-14 08:48:47 -04:00
fi
done < "$YADM_ENCRYPT"
fi
#; remove group/other permissions from collected globs
2016-04-05 09:52:21 -04:00
#shellcheck disable=SC2068
#(SC2068 is disabled because in this case, we desire globbing)
chmod -f go-rwx ${GLOBS[@]} >/dev/null 2>&1
#; TODO: detect and report changing permissions in a portable way
2015-07-14 08:48:47 -04:00
}
function version() {
echo "yadm $VERSION"
exit_with_hook 0
2015-07-14 08:48:47 -04:00
}
#; ****** Utility Functions ******
function query_distro() {
distro=""
if command -v "$LSB_RELEASE_PROGRAM" >/dev/null 2>&1; then
distro=$($LSB_RELEASE_PROGRAM -si 2>/dev/null)
fi
echo "$distro"
}
function process_global_args() {
#; global arguments are removed before the main processing is done
MAIN_ARGS=()
2016-04-05 09:52:21 -04:00
while [[ $# -gt 0 ]] ; do
key="$1"
case $key in
-Y|--yadm-dir) #; override the standard YADM_DIR
if [[ ! "$2" =~ ^/ ]] ; then
error_out "You must specify a fully qualified yadm directory"
fi
YADM_DIR="$2"
shift
;;
--yadm-repo) #; override the standard YADM_REPO
if [[ ! "$2" =~ ^/ ]] ; then
error_out "You must specify a fully qualified repo path"
fi
YADM_OVERRIDE_REPO="$2"
shift
;;
--yadm-config) #; override the standard YADM_CONFIG
if [[ ! "$2" =~ ^/ ]] ; then
error_out "You must specify a fully qualified config path"
fi
YADM_OVERRIDE_CONFIG="$2"
shift
;;
--yadm-encrypt) #; override the standard YADM_ENCRYPT
if [[ ! "$2" =~ ^/ ]] ; then
error_out "You must specify a fully qualified encrypt path"
fi
YADM_OVERRIDE_ENCRYPT="$2"
shift
;;
--yadm-archive) #; override the standard YADM_ARCHIVE
if [[ ! "$2" =~ ^/ ]] ; then
error_out "You must specify a fully qualified archive path"
fi
YADM_OVERRIDE_ARCHIVE="$2"
shift
;;
2017-01-23 18:23:06 -05:00
--yadm-bootstrap) #; override the standard YADM_BOOTSTRAP
if [[ ! "$2" =~ ^/ ]] ; then
error_out "You must specify a fully qualified bootstrap path"
fi
YADM_OVERRIDE_BOOTSTRAP="$2"
shift
;;
*) #; main arguments are kept intact
MAIN_ARGS+=("$1")
;;
esac
shift
done
}
function configure_paths() {
#; change all paths to be relative to YADM_DIR
YADM_REPO="$YADM_DIR/$YADM_REPO"
YADM_CONFIG="$YADM_DIR/$YADM_CONFIG"
YADM_ENCRYPT="$YADM_DIR/$YADM_ENCRYPT"
YADM_ARCHIVE="$YADM_DIR/$YADM_ARCHIVE"
2017-01-23 18:23:06 -05:00
YADM_BOOTSTRAP="$YADM_DIR/$YADM_BOOTSTRAP"
#; independent overrides for paths
if [ -n "$YADM_OVERRIDE_REPO" ]; then
YADM_REPO="$YADM_OVERRIDE_REPO"
fi
if [ -n "$YADM_OVERRIDE_CONFIG" ]; then
YADM_CONFIG="$YADM_OVERRIDE_CONFIG"
fi
if [ -n "$YADM_OVERRIDE_ENCRYPT" ]; then
YADM_ENCRYPT="$YADM_OVERRIDE_ENCRYPT"
fi
if [ -n "$YADM_OVERRIDE_ARCHIVE" ]; then
YADM_ARCHIVE="$YADM_OVERRIDE_ARCHIVE"
fi
2017-01-23 18:23:06 -05:00
if [ -n "$YADM_OVERRIDE_BOOTSTRAP" ]; then
YADM_BOOTSTRAP="$YADM_OVERRIDE_BOOTSTRAP"
fi
#; use the yadm repo for all git operations
GIT_DIR=$(mixed_path "$YADM_REPO")
export GIT_DIR
}
2015-07-14 08:48:47 -04:00
function configure_repo() {
debug "Configuring new repo"
#; change bare to false (there is a working directory)
"$GIT_PROGRAM" config core.bare 'false'
2015-07-14 08:48:47 -04:00
#; set the worktree for the yadm repo
"$GIT_PROGRAM" config core.worktree "$(mixed_path "$YADM_WORK")"
2015-07-14 08:48:47 -04:00
#; by default, do not show untracked files and directories
"$GIT_PROGRAM" config status.showUntrackedFiles no
#; possibly used later to ensure we're working on the yadm repo
"$GIT_PROGRAM" config yadm.managed 'true'
2015-07-14 08:48:47 -04:00
}
function set_operating_system() {
#; special detection of WSL (windows subsystem for linux)
local proc_version
proc_version=$(cat "$PROC_VERSION" 2>/dev/null)
if [[ "$proc_version" =~ Microsoft ]]; then
OPERATING_SYSTEM="WSL"
else
OPERATING_SYSTEM=$(uname -s)
fi
case "$OPERATING_SYSTEM" in
CYGWIN*)
git_version=$(git --version 2>/dev/null)
if [[ "$git_version" =~ windows ]] ; then
USE_CYGPATH=1
fi
;;
*)
;;
esac
}
2015-07-14 08:48:47 -04:00
function debug() {
2016-04-05 09:52:21 -04:00
[ -n "$DEBUG" ] && echo -e "DEBUG: $*"
2015-07-14 08:48:47 -04:00
}
function error_out() {
2016-04-05 09:52:21 -04:00
echo -e "ERROR: $*"
exit_with_hook 1
}
function exit_with_hook() {
invoke_hook "post" "$1"
exit "$1"
2015-07-14 08:48:47 -04:00
}
2017-06-22 19:32:16 -04:00
function invoke_hook() {
mode="$1"
exit_status="$2"
hook_command="$YADM_DIR/hooks/${mode}_$HOOK_COMMAND"
if [ -x "$hook_command" ] ; then
debug "Invoking hook: $hook_command"
#; expose some internal data to all hooks
2017-07-05 17:21:54 -04:00
work=$(unix_path "$("$GIT_PROGRAM" config core.worktree)")
YADM_HOOK_COMMAND=$HOOK_COMMAND
YADM_HOOK_EXIT=$exit_status
YADM_HOOK_FULL_COMMAND=$FULL_COMMAND
YADM_HOOK_REPO=$YADM_REPO
2017-07-05 17:21:54 -04:00
YADM_HOOK_WORK=$work
export YADM_HOOK_COMMAND
export YADM_HOOK_EXIT
export YADM_HOOK_FULL_COMMAND
export YADM_HOOK_REPO
export YADM_HOOK_WORK
"$hook_command"
hook_status=$?
#; failing "pre" hooks will prevent commands from being run
if [ "$mode" = "pre" ] && [ "$hook_status" -ne 0 ]; then
echo "Hook $hook_command was not successful"
echo "$HOOK_COMMAND will not be run"
exit "$hook_status"
fi
2017-06-22 19:32:16 -04:00
fi
2017-06-22 19:32:16 -04:00
}
function assert_private_dirs() {
work=$(unix_path "$("$GIT_PROGRAM" config core.worktree)")
for private_dir in "$@"; do
if [ ! -d "$work/$private_dir" ]; then
debug "Creating $work/$private_dir"
#shellcheck disable=SC2174
mkdir -m 0700 -p "$work/$private_dir" >/dev/null 2>&1
fi
done
}
function display_private_perms() {
when="$1"
for private_dir in .ssh .gnupg; do
if [ -d "$YADM_WORK/$private_dir" ]; then
private_perms=$(ls -ld "$YADM_WORK/$private_dir")
debug "$when" private dir perms "$private_perms"
fi
done
}
2015-07-14 08:48:47 -04:00
#; ****** Auto Functions ******
function auto_alt() {
#; process alternates if there are possible changes
2015-07-17 17:21:47 -04:00
if [ "$CHANGES_POSSIBLE" = "1" ] ; then
auto_alt=$(config --bool yadm.auto-alt)
2015-07-14 08:48:47 -04:00
if [ "$auto_alt" != "false" ] ; then
2017-01-21 12:41:14 -05:00
[ -d "$YADM_REPO" ] && alt
2015-07-14 08:48:47 -04:00
fi
fi
}
function auto_perms() {
#; process permissions if there are possible changes
2015-07-17 17:21:47 -04:00
if [ "$CHANGES_POSSIBLE" = "1" ] ; then
auto_perms=$(config --bool yadm.auto-perms)
2015-07-14 08:48:47 -04:00
if [ "$auto_perms" != "false" ] ; then
2017-01-21 12:41:14 -05:00
[ -d "$YADM_REPO" ] && perms
2015-07-14 08:48:47 -04:00
fi
fi
}
2017-01-25 02:07:07 -05:00
function auto_bootstrap() {
bootstrap_available || return
[ "$DO_BOOTSTRAP" -eq 0 ] && return
[ "$DO_BOOTSTRAP" -eq 3 ] && return
[ "$DO_BOOTSTRAP" -eq 2 ] && bootstrap
if [ "$DO_BOOTSTRAP" -eq 1 ] ; then
echo "Found $YADM_BOOTSTRAP"
echo "It appears that a bootstrap program exists."
echo "Would you like to execute it now? (y/n)"
read -r answer < /dev/tty
2017-01-25 02:07:07 -05:00
if [[ $answer =~ ^[yY]$ ]] ; then
bootstrap
fi
fi
}
2015-07-14 08:48:47 -04:00
#; ****** Prerequisites Functions ******
function require_archive() {
[ -f "$YADM_ARCHIVE" ] || error_out "$YADM_ARCHIVE does not exist. did you forget to create it?"
}
function require_encrypt() {
[ -f "$YADM_ENCRYPT" ] || error_out "$YADM_ENCRYPT does not exist. did you forget to create it?"
}
function require_git() {
local alt_git
alt_git="$(config yadm.git-program)"
local more_info
more_info=""
if [ "$alt_git" != "" ] ; then
GIT_PROGRAM="$alt_git"
more_info="\nThis command has been set via the yadm.git-program configuration."
fi
command -v "$GIT_PROGRAM" >/dev/null 2>&1 || \
error_out "This functionality requires Git to be installed, but the command '$GIT_PROGRAM' cannot be located.$more_info"
2015-07-14 08:48:47 -04:00
}
function require_gpg() {
2016-08-13 18:17:16 -04:00
local alt_gpg
alt_gpg="$(config yadm.gpg-program)"
local more_info
more_info=""
if [ "$alt_gpg" != "" ] ; then
GPG_PROGRAM="$alt_gpg"
more_info="\nThis command has been set via the yadm.gpg-program configuration."
fi
command -v "$GPG_PROGRAM" >/dev/null 2>&1 || \
error_out "This functionality requires GPG to be installed, but the command '$GPG_PROGRAM' cannot be located.$more_info"
2015-07-14 08:48:47 -04:00
}
function require_repo() {
[ -d "$YADM_REPO" ] || error_out "Git repo does not exist. did you forget to run 'init' or 'clone'?"
}
function require_ls() {
if [ ! -f "$LS_PROGRAM" ] ; then
command -v ls >/dev/null 2>&1 || \
error_out "This functionality requires 'ls' to be installed at '$LS_PROGRAM' or listed in your \$PATH"
LS_PROGRAM=ls
fi
}
2017-03-30 17:30:22 -04:00
function require_shell() {
[ -x "$SHELL" ] || error_out "\$SHELL does not refer to an executable."
}
2017-01-23 18:23:06 -05:00
function bootstrap_available() {
[ -f "$YADM_BOOTSTRAP" ] && [ -x "$YADM_BOOTSTRAP" ] && return
return 1
}
function envtpl_available() {
command -v "$ENVTPL_PROGRAM" >/dev/null 2>&1 && return
return 1
}
2015-07-14 08:48:47 -04:00
#; ****** Directory tranlations ******
function unix_path() {
#; for paths used by bash/yadm
if [ "$USE_CYGPATH" = "1" ] ; then
cygpath -u "$1"
else
echo "$1"
fi
}
function mixed_path() {
#; for paths used by Git
if [ "$USE_CYGPATH" = "1" ] ; then
cygpath -m "$1"
else
echo "$1"
fi
}
#; ****** Main processing (when not unit testing) ******
if [ "$YADM_TEST" != 1 ] ; then
process_global_args "$@"
set_operating_system
configure_paths
main "${MAIN_ARGS[@]}"
fi