gitManager.sh

#!/bin/bash
#
# gitManager.sh - Script that will pull from a git repo every X minutes
#
# Usage: ./gitManager.sh [options] [git_directory]
#
# Recommended crontab entry:
#      */15 * * * * /home/$USER/linux-pref/gitManager.sh --daemon &>/dev/null
# Syncs every 15 mins. Becareful which user script gets run as; should be owner of folder, or have read/write/execute access!
#
# Relies on the .git folder in the directory to be able to pull, therefore must be setup beforehand!
#
# Changes:
# v2.1.3
# - Fixed folder updating
#
# v2.1.2
# - Fixed cloneRepo()
# - Various other small tweaks
#
# v2.1.1
# - Added pullRepo() to make life easier with new capabilities
# - Updated various functions/calls to use it
# - Fixed a bug that was probably preventing the whole script from working for some time
#
# v2.1.0
# - Added folder scanning capabilites
# - Updated related functions for support
# - Fixed bug not allowing the sanity check from previous update to work
#
# v2.0.13
# - Took me long enough, added sanity check for added folders
# - Checks for absolute path instead of relative, now
#
# v2.0.12
# - Removed some changelog for new rules
#
# v2.0.11
# - Fixed a typo I noticed weeks ago but never bothered to fix til now
#
# v2.0.10
# - Simply added shortName for better debugging
#
# v2.0.9
# - Made the daemon check less confusing
#
# v2.0.8
# - Foiled by an incorrect variable! This is what happens when I program while tired lol
#
# v2.0.7
# - Added $longName for logging purposes
#
# v2.0.6
# - Script will check that no changes will be overwritten before pulling each repo
# - Finished writing --list, it works
# - Script is now 100% functional! Tested and working!
#
# v2.0.5
# - Script will now check to make sure it is linked to /usr/bin
# - setupGit() will now check if cronjob has been setup or not
# - I have run the script a few times, tested all the functions, and everything is working! *crosses fingers*
#
# v2.0.4
# - Added listRepos(), does nothing for now
# - Made the main bulk into pullRepo(), while loop to call it
# - Script will remove old 'gitcheck' refrences now
# - addRepo(), while small, works
#
# v2.0.3
# - Added the -i option to reintsall git options, instead of just "first run"
# - Added a failsafe to cloneRepo() in case folder could not be found
# - setupGit() created, and ready to go
# - Added the rest of the options from processArgs
#
# v2.0.2
# - Updated processArgs a bit with planned functions
# - Created functions cloneRepo() and addRepo()
# - cloneRepo() is ready for use! (untested, but ready)
#
# v2.0.1
# - Added displayHelp() and processArgs() from defaultScriptTemplate
# - Updated displayHelp with planned functions
#
# v2.0.0
# - Starting work on an improved version of this script that can do more
# - Changed name of script from gitCheck.sh -> gitManager.sh
#
# v1.1.0
# - You can now download/install git repos with this script
# - Script will ask to setup cron job for new repo as well
#
# TODO:
# - Output git status to log if push/pull unsuccessful
#   ~ Also output git diff to a tmp file (shortName_repo_date.txt)
# - https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository
#
# v2.1.3, 03 Dec. 2017, 20:21 PST

### Variables

directoryList="$HOME/.gitDirectoryList"
daemonMode=0
updateTime=15 # Time between updates, in minutes. Used when setting up a cronjob
longName="gitManager"
shortName="gm"
folderMode=0 # Whether to scan 

### Functions

if [[ -f commonFunctions.sh ]]; then
	source commonFunctions.sh
elif [[ -f /usr/share/commonFunctions.sh ]]; then
	source /usr/share/commonFunctions.sh
else
	echo "commonFunctions.sh could not be located!"

	# Comment/uncomment below depending on if script actually uses common functions
	echo "Script will now exit, please put file in same directory as script, or link to /usr/share!"
	exit 1
fi

function displayHelp() {
# The following will read all text between the words 'helpVar' into the variable $helpVar
# The echo at the end will output it, exactly as shown, to the user
read -d '' helpVar <<"endHelp"

gitManager.sh - A script that will update and manage various git repositories
Meant to be run as a cronjob, but can be run standalone as well.
Run script once to complete setup!

Usage: ./gitManager.sh [options] [git_repository]

Options:
-h | --help                         : Display this help message and exit
-v | --verbose                      : Enable verbose debug messages. (Note: MUST be first argument!)
-c | --clone <git_URL> [folder]     : Clone a remote repository, and add it to the update list, then exit
-a | --add <git_folder> [parent     : Add an existing git folder to the update list and exit
-d | --daemon                       : Run script in daemon mode, no interactive elements
-l | --list                         : Display locations and info of installed repositories and exit
-i | --install                      : Setup or re-setup the git parameters and exit
-f | --folder [folder]              : Scans each folder of given parent folder, and updates each found repository. Exits when done.

Information from "git pull" command is not shown by default; run the script with the verbose flag to see the data, or check the log!
Add the word "parent" to the end of an -a|--add to indicate it is a parent folder of Git repositories

endHelp
echo "$helpVar"
}

function processArgs() {
	# Runs standalone, so leave function if there are no arguments given
	if [[ $# -le 0 ]]; then
		debug "INFO: No arguments given, running script with default options!"
		return 0
	fi
	
	argCount=1
	args="$#"
	while [[ $loopFlag -eq 0 ]]; do
		key="$1"
		
		case "$key" in
			-h|--help)
			displayHelp
			exit 0
			;;
			-c|--clone)
			gitURL="$2"
			if [[ ! -z $3 ]]; then
				gitFolder="$3"
			else
				gitFolder="pwd"
			fi
			cloneRepo "$gitURL" "$gitFolder"
			exit 0 # Shouldn't get here, but just in case
			;;
			-f|--folder)
			#debug "l2" "INFO: Attempting to update parent directory of Git repos!"
			#folderMode=1
			if [[ -z $2 ]]; then
				debug "l2" "FATAL: No folder given with $key argument! Please fix and re-run"
				exit 1
			fi
			debug "l2" "INFO: Updating parent directory $2!"
			processFolder "$2"
			exit $?
			;;
			-d|--daemon)
			debug "INFO: Daemon mode enabled"
			daemonMode=1
			;;
			-i|--install)
			debug "INFO: Setting up git per user's request"
			setupGit
			exit 0
			;;
			-l|--list)
			debug "INFO: Listing directory information to user"
			listRepos
			exit 0
			;;
			-a|--add)
			if [[ "$2" == "fo*" ]]; then
				debug "l2" "INFO: Adding parent folder $3 without checking!"
				addRepo "$3" "folder"
			else
				debug "INFO: Attempting to add repo from $2"
				addRepo "$2"
			fi
			exit 0
			;;
			*)
			# Anything here is undocumented or uncoded
			debug "l2" "ERROR: Unknown option given: $key! Please fix and re-run"
			displayHelp
			exit 1
			;;
		esac
		
		((argCount++))
		if [[ $argCount -ge $args ]]; then
			loopFlag=1
		fi
		shift
	done
}

function addRepo() {
	if [[ "$2" == "folder" ]]; then
		debug "l2" "WARN: Parent directory $1 is being added, subdirectories will NOT be checked!"
	else
		# Check if git directory is valid
		if [[ ! -d "$1"/.git ]]; then
			debug "l2" "ERROR: $folder is not a valid git directory! Unable to add to list! Exiting..."
			exit 1
		fi
	fi
	
	# Make sure path is absolute, not relative
	if [[ "$1" != /* ]]; then
		newFolder="$(pwd)/$1"
	else
		newFolder="$1"
	fi
	
	# Indicate if folder is a parent or not
	if [[ "$2" == "folder" ]]; then
		newFolder="folder $newFolder"
	fi
	# Valid directory at this point
	echo "$newFolder" >>"$directoryList"
}

function cloneRepo() {
	# Clone into current directory (getting folder name from URL) if set to pwd mode. Else, clone into second argument
	if [[ "$2" == "pwd" ]]; then
		folder="$(echo "$1" | rev | cut -d'.' -f1 --complement | cut -d'/' -f1 | rev)"
		debug "INFO: Attemping to clone git repo $1 into current directory!"
		git clone "$1"
		value="$?"
	else
		folder="$2"
		debug "INFO: Attempting to clone git repo $1 into folder $2 !"
		git clone "$1" "$2"
		value="$?"
	fi
	
	# Warn user and exit if something goes wrong; continue otherwise
	if [[ $value -ne 0 ]]; then
		debug "l2" "ERROR: There was an error attemping to clone the repository! Exit code: $value"
		exit 1
	else
		if [[ ! -d "$folder" ]]; then
			debug "l2" "WARN: Repo was successfully cloned, but folder $folder could not be found! Please add to list manually!"
			exit 1
		fi
		addRepo "$folder"
		exit 0
	fi
}

function setupGit() {
	# Return if in daemon mode, no interactivity allowed!
	if [[ $daemonMode -ne 0 ]]; then
		return
	else
		debug "l2" "INFO: Initializing git defaults for user! This is interactive, so pay attention!"
	fi
	
	# Interactive part of the setup
	announce "Setting up Git for this system!" "Please follow the interactive prompts."
	read -p "Please enter the email you would like to use: " varEmail
	git config --global user.email "$varEmail"
	read -p "Please enter the display name you would like to use: " varUser
	git config --global user.name "$varUser"
	read -p "Please enter the default editor you wish to use (nano, vim, emacs, etc.): " varEditor
	git config --global core.editor "$varEditor"
	debug "INFO: Git set up as follows - Name: $varUser, Email: $varEmail, Editor: $varEditor"
	
	# Static config now
	git config --global credential.helper store
	debug "INFO: Git credential storage enabled"
	announce "Git credential storage has been enabled." "This means you will only have to login once to upload merges"
	git config --global push.default simple
	debug "INFO: Simple push behavior has been enabled"
	announce "Git has been configured to use simple push behavior (default since git v2.0+)" "This means that only the current working branch will be pushed, not all!"
	
	# Cronjob stuff
	if [[  -z "$(crontab -l | grep /usr/bin/gm)" ]]; then
		debug "l2" "WARN: No cronjob detected for current user!"
		getUserAnswer "Would you like to add a new job now? (WARNING: Be careful with this!)"
		case $? in
			0)
			getUserAnswer "Default is to check every 15 minutes, would you like to change this?" updateTime "How often would you like to check, in minutes?"
			addCronJob "$updateTime" "min" "/usr/bin/gm --daemon" # No matter what, user decided to install cronjob; doesn't matter if they changed the time or not
			;;
			1)
			debug "WARN: User chose not to install cronjob despite one not being setup"
			;;
			*)
			debug "l2" "FATAL: Unexpected output from getUserAnswer! Exiting now..."
			exit 1
			;;
		esac
	else	
		debug "INFO: Cronjob already setup for current user"
	fi
}

function listRepos() {
	OPWD="$(pwd)"
	while read -r directory;
	do
		printf "\nRepo location: %s\nGit status output:\n\n" "$directory"
		cd "$directory"
		git status
		headVar="$(head -n5 READ* 2>/dev/null)" # Sends errors to null so string is empty if README* is missing
		if [[ -z $headVar ]]; then
			debug "l2" "WARN: No README file found for repo $directory"
		else
			printf "\nTop 5 lines of repo's README file:\n\n"
			printf "%s\n" "$headVar"
		fi
		#printf "\n"
		sleep 2
	done <"$directoryList"
	cd "$OPWD"
}

function pullRepo() {
	debug "INFO: Attempting to update repo $1 on current branch"
	oldPWD="$(pwd)"
	cd "$1"
	
	# First, check if repo is ready to pul; warn if there are errors
	if [[ ! -z "$(git status | grep ahead)" ]]; then
		debug "l2" "ERROR: Repo at $1 is not ready, there are uncommited changes!"
		cd "$oldPWD"
		return
	fi
	if [[ ! -z "$(git status | grep "not staged")" ]]; then
		debug "l2" "FATAL: There are uncommitted changes for repo $1 ! Please fix, leaving for now..."
		cd "$oldPWD"
		return
	fi
	
	# If it makes it this far, it is safe to pull
	git pull >.gitTmp
	value="$?"
	
	# Decide what to do with git output info
	if [[ $debugFlag -ne 0 && $daemonMode -ne 0 ]]; then
		cat .gitTmp
	fi
	cat .gitTmp >>$logFile
	rm .gitTmp
	cd "$oldPWD"
	
	# Warn user of any errors
	if [[ $value -ne 0 ]]; then
		debug "l2" "WARN: There was an error attempting to pull $1 - Exit code: $value"
	else
		debug "l5" "INFO: Repo $1 was updated successfully for current branch!"
	fi
}

# $1 = folder; return value 1 if error, 0 if successful (input dependent, not result dependent)
function processFolder() {
	if [[ -z $1 ]]; then
		debug "l2" "ERROR: Incorrect call for processFolder()!"
		return 1
	elif [[ ! -d "$1" ]]; then
		debug "l2" "ERROR: $1 is not a directory, incorrect usage of folder argument!"
		return 1
	fi
	
	# Folder exists and is a folder, continue working with it
	debug "INFO: Attempting to pull parent Git folder $1"
	OOPWD="$(pwd)"
	cd "$1"
	for dir in **
	do
		if [[ -d "$dir" && "$dir" != ".*" ]]; then # As long as directory isn't hidden
			pullRepo "$(pwd)"/"$dir"
		else
			if [[ "$dir" == ".*" && -d "$dir" ]]; then
				debug "WARN: Not attempting to pull hidden directory $dir"
			fi
		fi
	done
	cd "$OOPWD"
	return 0
}

### Main Script

# Get rid of old symlink if it exists
if [[ -e /usr/bin/gitcheck ]]; then
	debug "l2" "WARN: Legacy program info found! Please give sudo privileges to remove!"
	sudo rm /usr/bin/gitcheck
fi

# Make sure current symlink is setup, just in case
if [[ ! -e /usr/bin/gm ]]; then
	debug "l2" "WARN: This script is not linked to /usr/bin, please provide sudo privilege to do this!"
	sudo ln -s "$(pwd)"/gitManager.sh /usr/bin/gm
fi

processArgs "$@"

# Check to see if git has been setup. Run if not
if [[ -e ~/.git-credentials || -e ~/.git-credential-cache ]]; then
	debug "l5" "INFO: Git has already been setup, moving to next step."
else
	debug "l3" "WARN: Git has not been initialized on this system!"
	setupGit
fi

# Update all the installed repos
[[ ! -f "$directoryList" ]] && touch "$directoryList"
OPWD="$(pwd)"
while read -r directory;
do
	if [[ "$(echo "$directory" | cut -d' ' -f1)" == [Ff][Oo][Ll][Dd][Ee][Rr]* ]]; then
		processFolder "$(echo "$directory" | cut -d' ' -f1 --complement)"
		#debug "l2" "INFO: Updating parent directory $directory!"
	else
		pullRepo "$directory"
	fi
done <"$directoryList"
cd "$OPWD"

debug "l3" "Done with script!"

#EOF