]> git.madduck.net Git - code/vcsh.git/blobdiff - vcsh

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Add hook post-clone-cleared
[code/vcsh.git] / vcsh
diff --git a/vcsh b/vcsh
index a57848743ccc4589d5e7195912a43702222c2bf3..c6257fe184be734c129fb84a37be5036ffe9ba9a 100755 (executable)
--- a/vcsh
+++ b/vcsh
 #!/bin/sh
 
 # This program is licensed under the GNU GPL version 2 or later.
-# (c) Richard "RichiH" Hartmann <richih.mailinglist@gmail.com>, 2011-2012
+# (c) Richard "RichiH" Hartmann <richih.mailinglist@gmail.com>, 2011-2013
 # For details, see LICENSE. To submit patches, you have to agree to
 # license your code under the GNU GPL version 2 or later.
 
+# While the following is not legally binding, the author would like to
+# explain the choice of GPLv2+ over GPLv3+.
+# The author prefers GPLv3+ over GPLv2+ but feels it's better to maintain
+# full compatibility's with git. In case git ever changes its licensing terms,
+# which is admittedly extremely unlikely to the point of being impossible,
+# this software will most likely follow suit.
+
+# This should always be the first line of code to facilitate debugging
+[ -n "$VCSH_DEBUG" ] && set -vx
+
+basename() {
+       # Implemented in shell to avoid spawning another process
+       local file
+       file="${1##*/}"
+       [ -z "$2" ] || file="${file%$2}"
+       echo "$file"
+}
+
+SELF=$(basename $0)
+VERSION='1.20130614'
 
+fatal() {
+       echo "$SELF: fatal: $1" >&2
+       exit $2
+}
+
+# We need to run getops as soon as possible so we catch -d and other
+# options that will modify our behaviour.
+# Commands are handled at the end of this script.
+while getopts "c:dv" flag; do
+       if [ "$1" = '-d' ] || [ "$1" = '--debug' ]; then
+               set -vx
+               VCSH_DEBUG=1
+               echo "$SELF $VERSION"
+       elif [ "$1" = '-v' ];then
+               VCSH_VERBOSE=1
+               echo "$SELF $VERSION"
+       elif [ "$1" = '-c' ];then
+               VCSH_OPTION_CONFIG=$OPTARG
+       fi
+       shift 1
+done
+
+source_all() {
+       # Source file even if it's in $PWD and does not have any slashes in it
+       case "$1" in
+               */*) . "$1";;
+               *)   . "$PWD/$1";;
+       esac;
+}
+
+
+# Read configuration and set defaults if anything's not set
 [ -n "$VCSH_DEBUG" ]                  && set -vx
 [ -z "$XDG_CONFIG_HOME" ]             && XDG_CONFIG_HOME="$HOME/.config"
+
+# Read configuration files if there are any
+[ -r "/etc/vcsh/config" ]             && . "/etc/vcsh/config"
 [ -r "$XDG_CONFIG_HOME/vcsh/config" ] && . "$XDG_CONFIG_HOME/vcsh/config"
+if [ -n "$VCSH_OPTION_CONFIG" ]; then
+       # Source $VCSH_OPTION_CONFIG if it can be read and is in $PWD of $PATH
+       if [ -r "$VCSH_OPTION_CONFIG" ]; then
+               source_all "$VCSH_OPTION_CONFIG"
+       else
+               fatal "Can not read configuration file '$VCSH_OPTION_CONFIG'" 1
+       fi
+fi
 [ -n "$VCSH_DEBUG" ]                  && set -vx
+
+# Read defaults
 [ -z "$VCSH_REPO_D" ]                 && VCSH_REPO_D="$XDG_CONFIG_HOME/vcsh/repo.d"
 [ -z "$VCSH_HOOK_D" ]                 && VCSH_HOOK_D="$XDG_CONFIG_HOME/vcsh/hooks-enabled"
 [ -z "$VCSH_BASE" ]                   && VCSH_BASE="$HOME"
 [ -z "$VCSH_GITIGNORE" ]              && VCSH_GITIGNORE='exact'
 
-SELF=$(basename $0)
 
 help() {
-       echo "usage: $SELF <args>
+       echo "usage: $SELF <options> <command>
+
+   options:
+   -c <file>            Source file
+   -d                   Enable debug mode
+   -v                   Enable verbose mode
 
+   commands:
    clone <remote> \\
          [<repo>]       Clone from an existing repository
+   delete <repo>        Delete an existing repository
+   enter <repo>         Enter repository; spawn new instance of \$SHELL
    help                 Display this help text
-   delete               Delete an existing repository
-   enter                Enter repository; spawn new instance of \$SHELL
    init <repo>          Initialize a new repository
    list                 List all repositories
    list-tracked         List all files tracked by vcsh
    list-tracked-by \\
         <repo>          List files tracked by a repository
+   pull                 Pull from all vcsh remotes
+   push                 Push to vcsh remotes
    rename <repo> \\
           <newname>     Rename repository
    run <repo> \\
        <command>        Use this repository
-   setup                Set up repository with recommended settings
+   upgrade <repo>       Upgrade repository to currently recommended settings
+   version              Print version information
+   which <substring>    Find substring in name of any tracked file
    write-gitignore \\
    <repo>               Write .gitignore.d/<repo> via git ls-files
 
@@ -50,11 +124,6 @@ verbose() {
        if [ -n "$VCSH_DEBUG" ] || [ -n "$VCSH_VERBOSE" ]; then echo "$SELF: verbose: $@"; fi
 }
 
-fatal() {
-       echo "$SELF: fatal: $1" >&2
-       exit $2
-}
-
 error() {
        echo "$SELF: error: $1" >&2
 }
@@ -64,6 +133,7 @@ info() {
 }
 
 clone() {
+       hook pre-clone
        init
        git remote add origin "$GIT_REMOTE"
        git config branch.master.remote origin
@@ -82,12 +152,15 @@ clone() {
                fatal "will stop after fetching and not try to merge!
   Once this situation has been resolved, run 'vcsh run $VCSH_REPO_NAME git pull' to finish cloning.\n" 17
        git merge origin/master
+       hook post-clone
+       retire
+       hook post-clone-retired
 }
 
 delete() {
        cd "$VCSH_BASE" || fatal "could not enter '$VCSH_BASE'" 11
        use
-       info "This operation WILL DETROY DATA!"
+       info "This operation WILL DESTROY DATA!"
        files=$(git ls-files)
        echo "These files will be deleted:
 
@@ -100,7 +173,7 @@ To continue, type 'Yes, do as I say'"
        for file in $files; do
                rm -f $file || info "could not delete '$file', continuing with deletion"
        done
-       rm -r "$GIT_DIR" || error "could not delete '$GIT_DIR'"
+       rm -rf "$GIT_DIR" || error "could not delete '$GIT_DIR'"
 }
 
 enter() {
@@ -117,7 +190,7 @@ git_dir_exists() {
 hook() {
        for hook in $VCSH_HOOK_D/$1* $VCSH_HOOK_D/$VCSH_REPO_NAME.$1*; do
                [ -x "$hook" ] || continue
-               info "executing '$hook'"
+               verbose "executing '$hook'"
                "$hook"
        done
 }
@@ -128,12 +201,12 @@ init() {
        mkdir -p "$GIT_WORK_TREE" || fatal "could not create '$GIT_WORK_TREE'" 50
        cd "$GIT_WORK_TREE" || fatal "could not enter '$GIT_WORK_TREE'" 11
        git init
-       setup
+       upgrade
 }
 
 list() {
-       for i in "$VCSH_REPO_D"/*.git; do
-               echo $(basename "$i" .git)
+       for repo in "$VCSH_REPO_D"/*.git; do
+               [ -d "$repo" ] && [ -r "$repo" ] && echo $(basename "$repo" .git)
        done
 }
 
@@ -153,6 +226,33 @@ list_tracked_by() {
        git ls-files | sort -u
 }
 
+pull() {
+       hook pre-pull
+       for VCSH_REPO_NAME in $(list); do
+               echo -n "$VCSH_REPO_NAME: "
+               export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
+               use
+               git pull
+       done
+       hook post-pull
+}
+
+push() {
+       hook pre-push
+       for VCSH_REPO_NAME in $(list); do
+               echo -n "$VCSH_REPO_NAME: "
+               export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
+               use
+               git push
+       done
+       hook post-push
+}
+
+retire() {
+       unset GIT_WORK_TREE
+       unset VCSH_DIRECTORY
+}
+
 rename() {
        git_dir_exists
        [ -d "$GIT_DIR_NEW" ] && fatal "'$GIT_DIR_NEW' exists" 54
@@ -163,18 +263,18 @@ rename() {
 run() {
        hook pre-run
        use
-       $VCSH_EXTERNAL_COMMAND
+       "$@"
        hook post-run
 }
 
-setup() {
-       hook pre-setup
+upgrade() {
+       hook pre-upgrade
        use
        git config core.worktree     "$GIT_WORK_TREE"
        git config core.excludesfile ".gitignore.d/$VCSH_REPO_NAME"
        git config vcsh.vcsh         'true'
        [ -e "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME" ] && git add -f "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME"
-       hook post-setup
+       hook post-upgrade
 }
 
 use() {
@@ -183,6 +283,14 @@ use() {
        export VCSH_DIRECTORY="$VCSH_REPO_NAME"
 }
 
+which() {
+       for VCSH_REPO_NAME in $(list); do
+               for VCSH_FILE in $(get_files); do
+                       echo $VCSH_FILE | grep -q "$VCSH_COMMAND_PARAMETER" && echo "$VCSH_REPO_NAME: $VCSH_FILE"
+               done
+       done | sort -u
+}
+
 write_gitignore() {
        use
        cd "$VCSH_BASE" || fatal "could not enter '$VCSH_BASE'" 11
@@ -196,9 +304,9 @@ write_gitignore() {
        tempfile=$(mktemp) || fatal "could not create tempfile" 51
        echo '*' > "$tempfile" || fatal "could not write to '$tempfile'" 57
        for gitignore in $gitignores; do
-               echo "$gitignore" | sed 's/^/!/' >> "$tempfile" || fatal "could not write to '$tempfile'" 57
+               echo "$gitignore" | sed 's@^@!/@' >> "$tempfile" || fatal "could not write to '$tempfile'" 57
                if [ x$VCSH_GITIGNORE = x'recursive' ] && [ -d "$gitignore" ]; then
-                       { echo "$gitignore/*" | sed 's/^/!/' >> "$tempfile" || fatal "could not write to '$tempfile'" 57; }
+                       { echo "$gitignore/*" | sed 's@^@!/@' >> "$tempfile" || fatal "could not write to '$tempfile'" 57; }
                fi
        done
        if diff -N "$tempfile" "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME" > /dev/null; then
@@ -219,19 +327,27 @@ if [ ! "x$VCSH_GITIGNORE" = 'xexact' ] && [ ! "x$VCSH_GITIGNORE" = 'xrecursive'
 fi
 
 if [ "$1" = 'clone' ]; then
-       [ -z $2 ] && fatal "$1: please specify a remote" 1
+       [ -z "$2" ] && fatal "$1: please specify a remote" 1
        export VCSH_COMMAND="$1"
        GIT_REMOTE="$2"
        [ -n "$3" ] && VCSH_REPO_NAME="$3" || VCSH_REPO_NAME=$(basename "$GIT_REMOTE" .git)
        export VCSH_REPO_NAME
        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
-elif [ "$1" = 'delete' ]          ||
-     [ "$1" = 'enter' ]           ||
-     [ "$1" = 'init' ]            ||
-     [ "$1" = 'list-tracked-by' ] ||
-     [ "$1" = 'rename' ]          ||
-     [ "$1" = 'run' ]             ||
-     [ "$1" = 'setup' ]           ||
+elif [ "$1" = 'version' ]; then
+       echo "$SELF $VERSION"
+       exit
+elif [ "$1" = 'which' ]; then
+       [ -z "$2" ] && fatal "$1: please specify a filename" 1
+       [ -n "$3" ] && fatal "$1: too many parameters" 1
+       export VCSH_COMMAND="$1"
+       export VCSH_COMMAND_PARAMETER="$2"
+elif [ "$1" = 'delete' ]           ||
+     [ "$1" = 'enter' ]            ||
+     [ "$1" = 'init' ]             ||
+     [ "$1" = 'list-tracked-by' ]  ||
+     [ "$1" = 'rename' ]           ||
+     [ "$1" = 'run' ]              ||
+     [ "$1" = 'upgrade' ]          ||
      [ "$1" = 'write-gitignore' ]; then
        [ -z $2 ]                      && fatal "$1: please specify repository to work on" 1
        [ "$1" = 'rename' -a -z "$3" ] && fatal "$1: please specify a target name" 1
@@ -240,10 +356,12 @@ elif [ "$1" = 'delete' ]          ||
        export VCSH_REPO_NAME="$2"
        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
        [ "$VCSH_COMMAND" = 'rename' ]         && export GIT_DIR_NEW="$VCSH_REPO_D/$3.git"
-       [ "$VCSH_COMMAND" = 'run' ] && shift 2 && export VCSH_EXTERNAL_COMMAND="$*"
+       [ "$VCSH_COMMAND" = 'run' ] && shift 2
        [ "$VCSH_COMMAND" = 'write-gitignore' ]
 elif [ "$1" = 'list' ] ||
-     [ "$1" = 'list-tracked' ]; then
+     [ "$1" = 'list-tracked' ] ||
+     [ "$1" = 'pull' ] ||
+     [ "$1" = 'push' ]; then
        export VCSH_COMMAND="$1"
 elif [ -n "$2" ]; then
        export VCSH_COMMAND='run'
@@ -251,7 +369,7 @@ elif [ -n "$2" ]; then
        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
        [ -d $GIT_DIR ] || { help; exit 1; }
        shift 1
-       export VCSH_EXTERNAL_COMMAND="git $*"
+       set -- "git" "$@"
 elif [ -n "$1" ]; then
        export VCSH_COMMAND='enter'
        export VCSH_REPO_NAME="$1"
@@ -284,5 +402,7 @@ done
 
 verbose "$VCSH_COMMAND begin"
 export VCSH_COMMAND=$(echo $VCSH_COMMAND | sed 's/-/_/g')
-$VCSH_COMMAND
+hook pre-command
+$VCSH_COMMAND "$@"
+hook post-command
 verbose "$VCSH_COMMAND end, exiting"