ChangelogSH

#!/bin/sh
CHANGELOGSH_NAME="ChangelogSH"
CHANGELOGSH_VERSION=0.0.6
CHANGELOGSH_AUTHOR="Hu Liupeng <liupeng.hu@gmail.com>"
CHANGELOGSH_COPYRIGHT="Copyright (C) 2012, ${CHANGELOGSH_AUTHOR}"
CHANGELOGSH_LICENSE="This is free software; see the source for copying conditions."

# configuration
if [ -z ${CHANGELOG_FILE} ]; then
	CHANGELOG_FILE="changelog.txt"
fi
if [ -z ${CHANGELOG_EDITOR} ]; then
	CHANGELOG_EDITOR="vi"
fi
if [ -z ${CHANGELOG_EDITFILE} ]; then
	CHANGELOG_EDITFILE="CHANGELOG_EDITMSG"
fi
if [ -z ${CHANGELOG_COLOR} ];then
    CHANGELOG_COLOR="on"
fi
# template
if [ -z ${V_LABLE} ]; then
V_LABLE="version     :"
fi
if [ -z ${D_LABLE} ]; then
D_LABLE="date        :"
fi
if [ -z ${M_LABLE} ]; then
M_LABLE="md5sum      :"
fi
if [ -z ${S_LABLE} ]; then
S_LABLE="file size   :"
fi
if [ -z ${B_LABLE} ]; then
B_LABLE="bugfix      :"
fi
if [ -z ${F_LABLE} ]; then
F_LABLE="new feature :"
fi
if [ -z ${P_LABLE} ]; then
P_LABLE="platform    :"
fi
if [ -z ${N_LABLE} ]; then
N_LABLE="notes       :"
fi
if [ -z ${SEPARATOR} ]; then
SEPARATOR="--------------------------------------------------------------------------------"
fi

if [ ${CHANGELOG_COLOR} == "on" ];then
	# underline, blue
	KEY_COLOR_S="\033[04m\033[42m"
	KEY_COLOR_E="\033[0m"
fi

# show key
show_key() {
	echo -e "   ${KEY_COLOR_S}$1${KEY_COLOR_E}:"
	echo -e "        $2"
	return 0
}
# usage
usage() {
cat << EOF
${CHANGELOGSH_NAME} ${CHANGELOGSH_VERSION}
${CHANGELOGSH_COPYRIGHT}

Usage: ${CHANGELOGSH_NAME} [GNU style options] version_id version_files
   version_id must be fit with format "^[0-9]\+\.[0-9]\+\.[0-9]\+$", eg: 2.6.32
GNU long options:
   --version show version info
   --help    show this help message

Some variables can be set to change configurations of this ${CHANGELOGSH_NAME}:
   variable           description
   --------------------------------------------------------------------------------
EOF
show_key "CHANGELOG_FILE" "output changelog file name, 'changelog.txt' as default."
show_key "CHANGELOG_EDITOR" "changelog file editor, 'vi' as default."
show_key "CHANGELOG_EDITFILE" "temp file used to edit changelog, 'CHANGELOG_EDITMSG' as default"
show_key "CHANGELOG_COLOR" "key words display colors, 'on' as default"
show_key "V_LABLE" "\"version     :\""
show_key "D_LABLE" "\"date        :\""
show_key "M_LABLE" "\"md5sum      :\""
show_key "S_LABLE" "\"file size   :\""
show_key "B_LABLE" "\"bugfix      :\""
show_key "F_LABLE" "\"new feature :\""
show_key "P_LABLE" "\"platform    :\""
show_key "N_LABLE" "\"notes       :\""
show_key "SEPARATOR" "80 '-' chars"

cat << EOF

${CHANGELOGSH_NAME} is a efficiency tool to update changelog file.
Examples:
   CHANGELOG_COLOR="off" CHANGELOG_EDITOR="vi" ./${CHANGELOGSH_NAME} ${CHANGELOGSH_VERSION} ${CHANGELOGSH_NAME}
EOF
	return 0
}

# function to check if tools are valid in the host environment
is_cmd_valid() {
	valid=1
	for i in "$@"
	do
		# 0: valid
		# 1: not valid
		valid=`$i --version 1>/dev/null 2>&1 && echo 0 || echo 1`
		if [ ${valid} -eq 1 ];then
			echo "cmd $i not found"
			return ${valid}
		fi
	done
	return ${valid}
}

# check version id format, must be "^[0-9]\+\.[0-9]\+\.[0-9]\+$", eg: 2.6.3
check_version_id () {
	valid=1
	if [ $# -eq 1 ];then
		echo "$1" | grep "^[0-9]\+\.[0-9]\+\.[0-9]\+$" >/dev/null 2>&1
		return $?
	fi
	return ${valid}
}

# check file list
check_file_exist () {
	for i in "$@"
	do
		# 0: valid
		# 1: not valid
		if [ ! -f $i ]; then
			echo "file $i not found"
			return 1
		fi
	done
	return 0
}

if [ $# -lt 1 ]; then
	usage
	exit 0
fi

case "$1" in
    --version)
cat << EOF
${CHANGELOGSH_NAME} ${CHANGELOGSH_VERSION}
${CHANGELOGSH_COPYRIGHT}
${CHANGELOGSH_LICENSE}
EOF
        shift;;
    --help)
        usage;
        shift;;
esac

if [ $# -lt 2 ]; then
    exit 0
fi

V_ID=$1

if ! check_version_id ${V_ID}; then
	echo "version_id not valid."
	echo "abort"
	exit 1
fi

shift
V_FILE_LIST="$@"
if ! check_file_exist ${V_FILE_LIST}; then
	echo "abort"
	exit 5
fi

# check gnu tools we need
if ! is_cmd_valid "date" "awk" "stat" "md5sum" "${CHANGELOG_EDITOR}"; then 
	echo "abort"
	exit 2
fi

DATE=`date +"%Y/%m/%d %H:%M:%S"`
MD5SUM=`md5sum ${V_FILE_LIST} | awk '{printf "%36s %s\n",$1,$2}'`
SIZE=`LANG= ls -l ${V_FILE_LIST} | awk '{printf "%36s %s\n",$5,$9}'`

cat << EOF > ${CHANGELOG_EDITFILE}
${V_LABLE} ${V_ID}
${D_LABLE} ${DATE}
${M_LABLE} 
${MD5SUM}
${S_LABLE}
${SIZE}
${B_LABLE}
${F_LABLE}
${P_LABLE}
${N_LABLE}
${SEPARATOR}
EOF
time1=`stat -c %Z ${CHANGELOG_EDITFILE}`
${CHANGELOG_EDITOR} ${CHANGELOG_EDITFILE}
time2=`stat -c %Z ${CHANGELOG_EDITFILE}`

#echo "${time1} -> ${time2}"
if [ ${time2} -le ${time1} ];then
	echo "changelog has not been confirmed."
	echo "abort"
	exit 3
fi

echo "changelog has been confirmed."
echo "commit"

if [ -f ${CHANGELOG_FILE} ];then
	cat ${CHANGELOG_FILE} >> ${CHANGELOG_EDITFILE}
fi
mv ${CHANGELOG_EDITFILE} ${CHANGELOG_FILE}