git.functions

# This file is part of shellfire git. It is subject to the licence terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/shellfire-dev/git/master/COPYRIGHT. No part of shellfire git, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
# Copyright © 2014-2015 The developers of shellfire git. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/shellfire-dev/git/master/COPYRIGHT.


core_dependency_requires '*' git
git_withOutputSilencedIfQuiet()
{
	local verbosityLevel=$1
	local gitCommand="$2"
	shift 2

	if [ "$(core_init_verbosity)" -lt $verbosityLevel ]; then
		set -- -q "$@"
	else
		set -- "$@"
	fi
	
	git "$gitCommand" "$@"
}

git_inRepository()
{
	local repositoryFolderPath="$1"
	shift 1

	pushd "$repositoryFolderPath"
	
		"$@"
	
	popd
}

git_inRepositorySilently()
{
	local repositoryFolderPath="$1"
	shift 1
	
	git_inRepository "$repositoryFolderPath" git_withOutputSilencedIfQuiet 2 "$@"
}

core_dependency_requires '*' git
git_doesNotHaveTagPattern()
{
	local repositoryFolderPath="$1"
	local tagName="$2"
	
	local tags="$(git_inRepository "$repositoryFolderPath" git tag --list "$tagName")"
	
	if [ -z "$tags" ]; then
		return 0
	else
		return 1
	fi
}

core_dependency_requires '*' git
git_isPathSomewhereInsideGitRepository()
{
	local repositoryFolderPath="$1"
	
	pushd "$repositoryFolderPath"
		
		set +e
		git log -n 0 2>/dev/null
		local exitCode=$?
		set -e
		
	popd
	
	return $exitCode
}

# If in a submodule, walks up the directory hierarchy to the '.git' folder
# If no repository found, returns ''
git_findAbsolutePathOfTopLevelOfRepository()
{
	local repositoryFolderPath="$1"
	
	pushd "$repositoryFolderPath"
	
		local currentFolderPath="$(pwd)"
	
	popd
	
	while ! core_path_isReadableAndSearchableFolderPath "$currentFolderPath"/.git
	do
		if [ "$currentFolderPath" = '/' ]; then
			printf ''
			return 0
		fi
		
		pushd "$currentFolderPath"/..
			currentFolderPath="$(pwd)"
		popd
	done
	
	printf '%s' "$currentFolderPath"
}

core_dependency_requires '*' grep
git_hasRemote()
{
	local repositoryFolderPath="$1"
	local remoteName="$2"
	
	git_inRepository "$repositoryFolderPath" git remote | grep -q '^'"$remoteName"'$'
}

git_checkout()
{
	local repositoryFolderPath="$1"
	shift 1
	
	git_inRepositorySilently "$repositoryFolderPath" checkout "$@"
}

git_push()
{
	local repositoryFolderPath="$1"
	shift 1
	
	if core_variable_isSet _git_pushDryRun; then
		if $_git_pushDryRun; then
			core_message WARN "Dry run of git push $@"
			return 0
		fi
	fi
	
	git_inRepositorySilently "$repositoryFolderPath" push "$@"
}

git_pull()
{
	local repositoryFolderPath="$1"
	shift 1
	
	git_inRepositorySilently "$repositoryFolderPath" pull "$@"
}

git_commit()
{
	local repositoryFolderPath="$1"
	shift 1
	
	git_inRepositorySilently "$repositoryFolderPath" commit "$@"
}

git_branch()
{
	local repositoryFolderPath="$1"
	shift 1
	
	git_inRepositorySilently "$repositoryFolderPath" branch "$@"
}

core_dependency_requires '*' git
git_mostRecentCommit()
{
	local repositoryFolderPath="$1"
	
	git_mostRecent "$repositoryFolderPath" '%H'
}

git_mostRecent()
{
	local repositoryFolderPath="$1"
	local format="$2"
	
	git_inRepository "$repositoryFolderPath" git log -n 1 --format="format:$format"
}

core_dependency_requires '*' git
git_commitToTagOrCommit()
{
	local repositoryFolderPath="$1"
	local commit="$2"
	
	pushd "$repositoryFolderPath"
		set +e
		local tag="$(git describe --tags --exact-match "$commit" 2>/dev/null)"
		set -e
	popd
	
	if [ -n "$tag" ]; then
		printf '%s' "$tag"
	else
		printf '%s' "$commit"
	fi
}

git_cleanIfGitPresent()
{
	local repositoryFolderPath="$1"
	local repositoryCommit="$2"
	
	if core_compatibility_whichNoOutput git; then
		if git_isPathSomewhereInsideGitRepository "$repositoryFolderPath"; then
			git_clean "$repositoryFolderPath" "$repositoryCommit"
		fi
	fi
}

git_clean()
{
	local repositoryFolderPath="$1"
	local repositoryCommit="$2"
	
	git_inRepositorySilently "$repositoryFolderPath" clean -d -f -x
	git_inRepositorySilently "$repositoryFolderPath" reset --hard "$repositoryCommit"
		
	pushd "$repositoryFolderPath"
		
		local submodule
		local sha1
		while IFS= read -r submodule sha1
		do
			if [ -n "$submodule" ]; then
				git_clean "$submodule" "$sha1"
			fi
		done <<-EOF
			$(git submodule foreach --quiet 'echo "$path" "$sha1"')
		EOF
		
	popd
}

core_dependency_requires '*' git
git_tag()
{
	local repositoryFolderPath="$1"
	local tagName="$2"
	local tagMessage="$3"
	
	if git_doesNotHaveTagPattern "$repositoryFolderPath" "$tagName"; then
		
		git_inRepository "$repositoryFolderPath" git tag -a -m "$tagMessage" "$tagName"
		
	fi
	
	git_push "$repositoryFolderPath" origin "$tagName"
}

git_tagUsingBaseName()
{
	local repositoryFolderPath="$1"
	local tagBaseName="$2"
	local tagMessage="$3"
	
	local tagName
	local count=1
	while true
	do
		tagName="$tagBaseName"-$count
		if git_doesNotHaveTagPattern "$repositoryFolderPath" "$tagName"; then
			break
		fi
		
		count=$((count+1))
	done
	
	git_tag "$repositoryFolderPath" "$tagName" "$tagMessage"
	
	_git_tagNameChosen="$tagName"
}

core_dependency_requires '*' git
git_tagUpstream()
{
	local repositoryFolderPath="$1"

	local upstreamTagName="upstream-$(git_mostRecent "$repositoryFolderPath" '%at-%H')"
	local longCommitHash="$(git_mostRecentCommit "$repositoryFolderPath")"
	local iso8601Date="$(git_mostRecent "$repositoryFolderPath" '%aI')"
	local upstreamTagMessage="Imported from upstream at '$iso8601Date' from revision '$longCommitHash'"
	
	git_tag "$repositoryFolderPath" "$upstreamTagName" "$upstreamTagMessage"
}

core_dependency_requires '*' git md5sum
git_localModificationHashOrEmptyString()
{
	local repositoryFolderPath="$1"
	
	local hashSum
	local notWanted
	read -r hashSum notWanted <<-EOF
		$(git_inRepository "$repositoryFolderPath" git diff --minimal --no-color | md5sum)
	EOF
	
	local emptyStringHash='d41d8cd98f00b204e9800998ecf8427e'
	if [ "$hashSum" = "$emptyStringHash" ]; then
		printf ''
	else
		printf '%s' "$hashSum"
	fi
}

core_dependency_requires '*' cat
git_patchAm()
{
	local repositoryFolderPath="$1"
	local patchFilePath="$2"

	cat "$patchFilePath" | git_inRepositorySilently "$repositoryFolderPath" am --3way
}

git_addAll()
{
	local repositoryFolderPath="$1"
	shift 1
	
	git_inRepository "$repositoryFolderPath" git add -A .
}

git_cherrypicks()
{
	local repositoryFolderPath="$1"
	local rationale="$2"
	shift 2
	
	git_inRepositorySilently "$repositoryFolderPath" cherry-pick --strategy=recursive -X theirs "$@"
}

git_addGitCloneOrFetchFromOriginRemote()
{
	local repositoryParentPath="$1"
	local cloneUrl="$2"
	local folderName="$3"

	local repositoryFolderPath="$repositoryParentPath"/"$folderName"
	
	if [ -d "$repositoryFolderPath"/.git ]; then
		git_inRepositorySilently "$repositoryFolderPath" submodule update --init --recursive
		git_fetchFromOriginRemote "$repositoryFolderPath"
		return 0
	fi
	
	if [ -f "$repositoryFolderPath"/.git ]; then
		core_exitError $core_commandLine_exitCode_CANTCREAT "Clone '$repositoryName' already exists as git submodule (not repository) in path '$repositoryParentPath'"
	fi
	
	if [ -e "$repositoryFolderPath" ]; then
		core_exitError $core_commandLine_exitCode_CANTCREAT "Clone '$repositoryName' already exists as something (not repository) in path '$repositoryParentPath'"
	fi
	
	pushd "$repositoryParentPath"
		
		git_withOutputSilencedIfQuiet 2 clone --recursive "$cloneUrl" "$folderName"
		
	popd
}

git_addGitHubSubmodule()
{
	local repositoryParentPath="$1"
	local repositoryUser="$2"
	local repositoryName="$3"

	local repositoryFolderPath="$repositoryParentPath"/"$repositoryName"
	
	if [ -f "$repositoryFolderPath"/.git ]; then
		return 0
	fi
	
	if [ -d "$repositoryFolderPath"/.git ]; then
		core_exitError $core_commandLine_exitCode_CANTCREAT "Submodule '$repositoryName' already exists as git repository (not submodule) in path '$repositoryParentPath'"
	fi
	
	if [ -e "$repositoryFolderPath" ]; then
		core_exitError $core_commandLine_exitCode_CANTCREAT "Submodule '$repositoryName' already exists as something (not submodule) in path '$repositoryParentPath'"
	fi
	
	pushd "$repositoryParentPath"
		
		git_withOutputSilencedIfQuiet 2 submodule add https://github.com/"$repositoryUser"/"$repositoryName".git
		
	popd
	
	git_inRepositorySilently "$repositoryFolderPath" submodule update --init --recursive
}

git_addGitHubInit()
{
	local repositoryParentPath="$1"
	local repositoryUser="$2"
	local repositoryName="$3"
	
	pushd "$repositoryParentPath"
		
		if [ -d "$repositoryName"/.git ]; then
			git_addOriginRemoteIdempotently "$repositoryParentPath"/"$repositoryName" git@github.com:"$repositoryUser"/"$repositoryName".git
			return 0
		fi
		
		if [ -f "$repositoryName"/.git ]; then
			core_exitError $core_commandLine_exitCode_CANTCREAT "Init '$repositoryName' already exists as git submodule (not submodule) in path '$repositoryParentPath'"
		fi
		
		if [ -e "$repositoryName" ]; then
			core_exitError $core_commandLine_exitCode_CANTCREAT "Init '$repositoryName' already exists as something in path '$repositoryParentPath'"
		fi
		
		git_withOutputSilencedIfQuiet 2 init "$repositoryName"
		
	popd
	
	git_addOriginRemoteIdempotently "$repositoryParentPath"/"$repositoryName" git@github.com:"$repositoryUser"/"$repositoryName".git
}

core_dependency_requires '*' git
git_addUpstreamRemoteIdempotently()
{
	local repositoryFolderPath="$1"
	local upstreamRemote="$2"
	
	git_inRepository "$repositoryFolderPath" git remote add -f --tags upstream "$upstreamRemote" 1>/dev/null 2>/dev/null || git_fetchFromUpstreamRemote "$repositoryFolderPath"
}

core_dependency_requires '*' git
git_addOriginRemoteIdempotently()
{
	local repositoryFolderPath="$1"
	local originRemote="$2"
	
	git_inRepository "$repositoryFolderPath" git remote add -f --tags origin "$originRemote" 1>/dev/null 2>/dev/null || git_fetchFromOriginRemote "$repositoryFolderPath"
}

git_fetchFromUpstreamRemote()
{
	local repositoryFolderPath="$1"
	
	git_fetchFromRemote "$repositoryFolderPath" upstream
}

git_fetchFromOriginRemote()
{
	local repositoryFolderPath="$1"
	
	git_fetchFromRemote "$repositoryFolderPath" origin
}

git_fetchFromRemote()
{
	local repositoryFolderPath="$1"
	local remote="$2"
	
	git_inRepositorySilently "$repositoryFolderPath" fetch --tags "$remote"	
}

core_dependency_requires '*' git
git_removeAllLocalTags()
{
	local repositoryFolderPath="$1"
	
	pushd "$repositoryFolderPath"
	
		# Note, absence of quotes is correct
		# 2>/dev/null because there is no -q option
		git tag -d $(git tag) 2>/dev/null
		
		local remote
		while IFS= read -r remote
		do
			if [ -n "$remote" ]; then
				git fetch --tags "$remote"
			fi
		done <<-EOF
			$(git remote)
		EOF
		
	popd
}

core_dependency_requires '*' cat git awk sed touch env
git_changeTimestampsToLastCommit()
{
	local repositoryFolderPath="$1"
		
	pushd "$repositoryFolderPath"
		
		local submodule
		while IFS= read -r submodule
		do
			if [ -n "$submodule" ]; then
				git_changeTimestampsToLastCommit "$submodule"
			fi
		done <<-EOF
			$(git submodule foreach -q 'echo "$path"')
		EOF

	
		local TMP_FILE
		core_temporaryFiles_newFileToRemoveOnExit
		local _git_changeTimestampsToLastCommit_awkScript="$TMP_FILE"
		cat >"$_git_changeTimestampsToLastCommit_awkScript" <<EOF
BEGIN {
	FS="\n"
	RS=""
	ORS=""
	filesCount=0
	$(git ls-files | sed 's/^\(.*\)$/files["\1"]=1;filesCount++/')
}
EOF
		cat >>"$_git_changeTimestampsToLastCommit_awkScript" <<'EOF'
{
	timestamp=$1

	touch=""
	n=2
	while(n<=NF) {
		if (files[$n] == 1) {
			files[$n]=2
			filesCount--
			touch=touch " '" $n "'"
		}
		n++
	}

	if (length(touch)>0) {
		# awk system() call invokes the shell which is (a) a security risk (b) slow (happens each time) and (c) requires daemons to have a shell
		# Instead we pass the output to sh, which means one invocation and execution happens as-we-go
		print "touch -d '" timestamp "'" touch " 2>/dev/null" " || true \n"
	}

	if(filesCount == 0)
	{
		exit 0
	}
}
EOF
		git whatchanged --format=format:%cI --name-only | awk -f "$_git_changeTimestampsToLastCommit_awkScript" - | env sh -s
		
	popd
}