X-Git-Url: https://git.sommitrealweird.co.uk/bpgallery.git/blobdiff_plain/104efc9eed8f557a3a92f6fc1dd10913b71ff4aa..29a8c024297766b5b4d78424afddaae9a0365db7:/bpgallery.sh diff --git a/bpgallery.sh b/bpgallery.sh index 63a27e8..ade52a5 100755 --- a/bpgallery.sh +++ b/bpgallery.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -# makegallery.sh - builds a simple 'gallery' from a collection of images +# bpgallery.sh - builds a simple 'gallery' from a collection of images # Copyright (C) 2004 Brett Parker # # This program is free software; you can redistribute it and/or modify @@ -17,22 +17,470 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -VERSION="0.9.2" +set -f + +VERSION="1.1.1+arch" + +function bpgallery_default_head() { +cat < + + + + ${TITLE} + + + +END +} + +declare -rf bpgallery_default_head + +function bpgallery_default_description() { +cat <${TITLE} + ${DESCRIPTION} +END +} + +declare -rf bpgallery_default_description + +function bpgallery_default_thumbsline() { +if [[ -z $caption ]]; then + caption_alt=Unknown +else + caption_alt=$caption +fi +cat << END +
$caption_alt
$caption
+END +} + +declare -rf bpgallery_default_thumbsline + +function bpgallery_default_tail() { +cat << END + + +END +} + +declare -rf bpgallery_default_tail + +function bpgallery_default_stylesheet() { +cat <${caption} + +
+ ${linkstart}${caption}${linkend} +
+END + $BPGALLERY_TAIL_FUNCTION +} + +declare -rf bpgallery_default_page + +function bpgallery_escape_url() { + temp=$1 + temp=${temp//\%/%25} + temp=${temp//:/%3A} + temp=${temp//;/%3B} + temp=${temp// /%20} + temp=${temp//$/%24} + temp=${temp//&/%26} + temp=${temp//+/%2B} + temp=${temp//,/%2C} + temp=${temp//\//%2F} + temp=${temp//=/%3D} + temp=${temp//\?/%3F} + temp=${temp//@/%40} + temp=${temp//\"/%22} + $ECHOCOMMAND $temp +} + +function bpgallery_cleanup_directory_name() { + temp=$1 + temp=${temp//\%/_} + temp=${temp//:/_} + temp=${temp//;/_} + temp=${temp// /_} + temp=${temp//$/_} + temp=${temp//&/_} + temp=${temp//+/_} + temp=${temp//,/_} + temp=${temp//\//_} + temp=${temp//=/_} + temp=${temp//\?/_} + temp=${temp//@/_} + temp=${temp//\"/_} + $ECHOCOMMAND $temp +} + +declare -rf bpgallery_escape_url + +if [[ ! -z ${BPGALLERY_THEME} ]] ; then + declare -r BPGALLERY_THEME +fi + +if [[ ! -z ${TITLE} ]] ; then + declare -r TITLE +fi + +if [[ -e /usr/local/etc/bpgallery/config ]] ; then + . /usr/local/etc/bpgallery/config 2>/dev/null +fi + +if [[ -e /etc/bpgallery/config ]] ; then + . /etc/bpgallery/config 2>/dev/null +fi + +if [[ -e $HOME/.bpgallery.rc ]]; then + . $HOME/.bpgallery.rc 2>/dev/null +fi + +if [[ -e $1 && -d $1 && -e $1/.bpgallery.rc ]]; then + . $1/.bpgallery.rc 2>/dev/null +fi + +if [[ -z ${BPGALLERY_THEME} ]]; then + BPGALLERY_THEME=default +fi + +if [[ ! -z ${BPGALLERY_THEME_DIR} ]] && \ + [[ -e ${BPGALLERY_THEME_DIR}/${BPGALLERY_THEME} ]]; then + . ${BPGALLERY_THEME_DIR}/${BPGALLERY_THEME} 2>/dev/null +elif [[ -e $HOME/.bpgallery.themes/${BPGALLERY_THEME} ]]; then + . $HOME/.bpgallery.themes/${BPGALLERY_THEME} 2>/dev/null +elif [[ -e /usr/local/etc/bpgallery/themes/${BPGALLERY_THEME} ]]; then + . /usr/local/etc/bpgallery/themes/${BPGALLERY_THEME} 2>/dev/null +elif [[ -e /etc/bpgallery/themes/${BPGALLERY_THEME} ]]; then + . /etc/bpgallery/themes/${BPGALLERY_THEME} 2>/dev/null +fi if [[ -z $TITLE ]]; then TITLE="Photo Gallery" fi if [[ -z $CONVERTTOOL ]]; then - CONVERTTOOL="/usr/bin/convert" + hash convert + if [[ $? != 0 ]]; then + echo "Can't find convert, exiting" + exit 3 + fi + CONVERTTOOL=$(hash -t convert) +else + if [[ ! -x $CONVERTTOOL ]]; then + echo "Can't find convert at location $CONVERTTOOL, exiting" + exit 3 + fi +fi + +if [[ -z $FINDCOMMAND ]]; then + hash find + if [[ $? != 0 ]]; then + echo "Can't find find, exiting" + exit 3 + fi + FINDCOMMAND=$(hash -t find) +else + if [[ ! -x $FINDCOMMAND ]]; then + echo "Can't find find at $FINDCOMMAND, exiting" + exit 3 + fi +fi + +if [[ -z $XARGSCOMMAND ]]; then + hash xargs + if [[ $? != 0 ]]; then + echo "Can't find xargs, exiting" + exit 3 + fi + XARGSCOMMAND=$(hash -t xargs) +else + if [[ ! -x $XARGSCOMMAND ]]; then + echo "Can't find xargs at $XARGSCOMMAND, exiting" + exit 3 + fi +fi + +if [[ -z $ECHOCOMMAND ]]; then + ECHOCOMMAND=echo +else + if [[ ! -x $ECHOCOMMAND ]]; then + echo "Can't find echo at $ECHOCOMMAND, exiting" + exit 3 + fi +fi + +if [[ -z $SORTCOMMAND ]]; then + hash sort + if [[ $? != 0 ]]; then + echo "Can't find sort, exiting" + exit 3 + fi + SORTCOMMAND=$(hash -t sort) +else + if [[ ! -x $SORTCOMMAND ]]; then + echo "Can't find sort, exiting" + exit 3 + fi +fi + +if [[ -z $IDENTIFYCOMMAND ]]; then + hash identify + if [[ $? != 0 ]]; then + echo "Can't find indentify, exiting" + exit 3 + fi + IDENTIFYCOMMAND=$(hash -t identify) +else + if [[ ! -x $IDENTIFYCOMMAND ]]; then + echo "Can't find identify at $IDENTIFYCOMMAND, exiting" + exit 3 + fi +fi + +if [[ -z $HEADCOMMAND ]]; then + hash head + if [[ $? != 0 ]]; then + echo "Can't find head, exiting" + exit 3 + fi + HEADCOMMAND=$(hash -t head) +else + if [[ ! -x $HEADCOMMAND ]]; then + echo "Can't find head at $HEADCOMMAND, exiting" + exit 3 + fi +fi + +if [[ -z $GREPCOMMAND ]]; then + hash grep + if [[ $? != 0 ]]; then + echo "Can't find grep, exiting" + exit 3 + fi + GREPCOMMAND=$(hash -t grep) +else + if [[ ! -x $GREPCOMMAND ]]; then + echo "Can't find grep at $GREPCOMMAND, exiting" + exit 3 + fi +fi + +if [[ -z $SEDCOMMAND ]]; then + hash sed + if [[ $? != 0 ]]; then + echo "Can't find sed, exiting" + exit 3 + fi + SEDCOMMAND=$(hash -t sed) +else + if [[ ! -x $SEDCOMMAND ]]; then + echo "Can't find sed at $SEDCOMMAND, exiting" + exit 3 + fi +fi + +if [[ -z $WCCOMMAND ]]; then + hash wc + if [[ $? != 0 ]]; then + echo "Can't find wc, exiting" + exit 3 + fi + WCCOMMAND=$(hash -t wc) + WCCOMMAND="$WCCOMMAND -l" +else + if [[ ! -x $WCCOMMAND ]]; then + echo "Can't find wc at $WCCOMMAND, exiting" + exit 3 + fi + WCCOMMAND="$WCCOMMAND -l" fi if [[ -z $WIDTH ]]; then WIDTH=100 fi -usage() { - cat < /dev/null ; then + BPGALLERY_PAGE_FUNCTION="bpgallery_${BPGALLERY_THEME}_page" +else + BPGALLERY_PAGE_FUNCTION="bpgallery_default_page" +fi + +if declare -F "bpgallery_${BPGALLERY_THEME}_head" > /dev/null ; then + BPGALLERY_HEAD_FUNCTION="bpgallery_${BPGALLERY_THEME}_head" +else + BPGALLERY_HEAD_FUNCTION="bpgallery_default_head" +fi + +if declare -F "bpgallery_${BPGALLERY_THEME}_description" > /dev/null ; then + BPGALLERY_DESCRIPTION_FUNCTION="bpgallery_${BPGALLERY_THEME}_description" +else + BPGALLERY_DESCRIPTION_FUNCTION="bpgallery_default_description" +fi + +if declare -F "bpgallery_${BPGALLERY_THEME}_thumbsline" > /dev/null ; then + BPGALLERY_THUMBSLINE_FUNCTION="bpgallery_${BPGALLERY_THEME}_thumbsline" +else + BPGALLERY_THUMBSLINE_FUNCTION="bpgallery_default_thumbsline" +fi + +if declare -F "bpgallery_${BPGALLERY_THEME}_tail" > /dev/null ; then + BPGALLERY_TAIL_FUNCTION="bpgallery_${BPGALLERY_THEME}_tail" +else + BPGALLERY_TAIL_FUNCTION="bpgallery_default_tail" +fi + +if declare -F "bpgallery_${BPGALLERY_THEME}_stylesheet" > /dev/null ; then + BPGALLERY_STYLESHEET_FUNCTION="bpgallery_${BPGALLERY_THEME}_stylesheet" +else + BPGALLERY_STYLESHEET_FUNCTION="bpgallery_default_stylesheet" +fi + +FINDIMAGESOPTIONS="" + +for imageext in $IMAGEEXTENSIONS; do + FINDIMAGESOPTIONS=$FINDIMAGESOPTIONS' -o -type f -iname '*.$imageext' -print0' +done + +FINDIMAGESOPTIONS=${FINDIMAGESOPTIONS## -o } +FINDIMAGESOPTIONS='-maxdepth 1 '${FINDIMAGESOPTIONS} + +function usage() { +cat <] @@ -40,18 +488,232 @@ Usage: displays this help screen --version displays the version and exits - + +This can also takes some environment variables, these will use defaults if not +set. + + TITLE + the title of the gallery + + WIDTH + the width to make the icons + + MEDIUMWIDTH + set the width of images in the medium size pages + + BPGALLERY_THEME + set the theme to use (described below) + + BPGALLERY_THEME_DIR + set an extra location to look for themes + + OUTPUTHTML + sets the script output to be wrapped in a
 block
+
+        GENERATEPAGESFORMEDIUMSIZE
+            generate medium sized images and pages
+
+        GENERATEPAGESFORFULLSIZE
+            decide wether to generate pages for the full size images or not
+
+        INDEXDOCUMENT
+            name of the index page (e.g. index.html)
+
+Example:
+	TITLE="My Funky Gallery" WIDTH=200 INDEXDOCUMENT="welcome.html" GENERATEPAGESFORFULLSIZE=1 GENERATEPAGESFORMEDIUMSIZE=1 MEDIUMWIDTH=400 $0 /path/to/image/folder
 END
 }
 
-version() {
-	cat <&1 | while read throwout; do $ECHOCOMMAND done: $currentimage/$imagestoupdate images; currentimage=$((currentimage+1)); done
+	$ECHOCOMMAND done: $imagestoupdate/$imagestoupdate images
+	$ECHOCOMMAND "Completed generating $2 for $totalimages images"
+}
+
+function generate_thumbs() {
+	if [[ ! -z $HEIGHT ]]; then
+		generate_resized_images "${WIDTH}x${HEIGHT}" $ICONSDIRECTORY
+	else
+    	generate_resized_images $WIDTH $ICONSDIRECTORY
+	fi
+}
+
+function generate_medium() {
+	if [[ ! -z $MEDIUMHEIGHT ]]; then
+		generate_resized_images "${WIDTH}x${HEIGHT}" $MEDIUMDIRECTORY
+	else
+		generate_resized_images $MEDIUMWIDTH $MEDIUMDIRECTORY
+	fi
+}
+
+function generate_pages() {
+	$ECHOCOMMAND "Generating Pages"
+	previouspage=""
+	currentpage=""
+	nextpage=""
+	previousimage=""
+	currentimage=""
+	nextimage=""
+	extra=""
+	extradir=""
+	addlinks=0
+	
+	if [ ! -z $1 ]; then
+		extra=$1
+	fi
+
+	if [ ! -z $2 ]; then
+		extradir=$2/
+		addlinks=1
+	fi
+
+	if [ -z $2 ] && [[ $GENERATEPAGESFORMEDIUMSIZE != 0 ]]; then
+		addlinks=2
+	fi
+	
+	$FINDCOMMAND . $FINDIMAGESOPTIONS | \
+	$XARGSCOMMAND -0 -I {} $ECHOCOMMAND {} | \
+	$SORTCOMMAND -g | \
+	while read imagefilename; do
+		previousimage=$currentimage
+		currentimage=$nextimage
+		nextimage=${imagefilename#./}
+		addlink=""
+		
+		if [[ $GENERATEPAGESFORFULLSIZE != 0 ]]; then
+			if [[ $addlinks == 1 ]]; then
+				addlink=${currentimage}.html
+			else
+				addlink=${currentimage}${extra}.html
+			fi
+		else
+			addlink=${currentimage}
+		fi
+
+		previouspage=$currentpage
+		currentpage=$nextpage
+		if [[ $addlinks == 1 ]]; then
+			nextpage=${nextimage}${extra}.html
+		else
+			nextpage=${nextimage}.html
+		fi
+
+		if [[ "x$PAGESDIRECTORY" != "x" ]]; then
+			filename=../${extradir}${currentimage}
+		else
+			filename=${extradir}${currentimage}
+		fi
+		if [ "x$currentpage" != "x" ]; then
+			generate_general_page "$previouspage" "$currentpage" "$nextpage" $addlink
+		fi
+		$ECHOCOMMAND $nextimage
+	done | tail -n 2 | (
+		read previouspage
+		read currentpage
+		addlink=""
+
+		if [[ $GENERATEPAGESFORFULLSIZE != 0 ]]; then
+			if [[ $addlinks == 1 ]]; then
+				addlink=${currentpage}.html
+			else
+				addlink=${currentpage}${extra}.html
+			fi
+		else
+			addlink=${currentpage}
+		fi
+		
+		if [[ "x$PAGESDIRECTORY" != "x" ]]; then
+			filename=../${extradir}${currentpage}
+		else
+			filename=${extradir}${currentpage}
+		fi
+		if [[ $addlinks == 1 ]]; then
+			currentpage=${currentpage}${extra}.html
+			previouspage=${previouspage}${extra}.html
+		else
+			currentpage=${currentpage}.html
+			previouspage=${previouspage}.html
+		fi
+		nextpage=""
+		generate_general_page "$previouspage" "$currentpage" "" $addlink
+	)
+}
+
+function generate_medium_pages() {
+	generate_pages __${MEDIUMDIRECTORY} ${MEDIUMDIRECTORY}
+}
+
+function generate_general_page() {
+
+	if [[ -z $1 ]]; then
+		previouspage=""
+	fi
+
+	if [[ -z $2 ]]; then
+		currentpage=""
+		return
+	fi
+
+	if [[ -z $3 ]]; then
+		nextpage=""
+	fi
+
+	if [[ ! -z $4 ]]; then
+		linklocation=$4
+	fi
+
+	if [ -r captions.txt ]; then
+		imagefilename=${filename##*/}
+		caption=$($GREPCOMMAND -E "^${imagefilename}	" captions.txt); caption=${caption#*	}
+	else
+		caption=""
+	fi
+	
+	$BPGALLERY_PAGE_FUNCTION > "${UNIXPAGESDIRECTORY}$currentpage"
+}
+
+if [[ $OUTPUTHTML != 0 ]]; then
+	$ECHOCOMMAND "
"
+fi
+
 if [[ -z $1 ]]; then
-	echo "No path given"
+	$ECHOCOMMAND "No path given"
 	usage
 	exit 1
 fi
@@ -67,96 +729,106 @@ if [[ "$1" == "--version" || "$1" == "-v" ]]; then
 fi
 
 if [[ ! -d $1 ]]; then
-	echo "$1 is not a directory"
+	$ECHOCOMMAND "$1 is not a directory"
 	usage
 	exit 2
 fi
 
 cd "$1"
 
-if ( ! find . -name '*.jpg' -o -name '*.png' -o -name '*.gif' > /dev/null 2>/dev/null ); then
-	echo "$1 does not contain any images. Quitting."
+if ( ! $FINDCOMMAND . $FINDIMAGESOPTIONS > /dev/null 2>/dev/null ); then
+	$ECHOCOMMAND "$1 does not contain any images. Quitting."
 	exit 4
 fi
 
-if [ ! -d icons ]; then
-	mkdir icons
-else
-	echo "$1 already contains an icons folder, stopping"
-	exit 3
+if [ ! -w . ]; then
+	$ECHOCOMMAND "Can't write to images directory, exiting"
+	exit 8
 fi
 
-find . -type f -name \*.jpg -print0 -or -type f -name \*.gif -print0 -or -type f -name \*.png -print0 -maxdepth 1 | xargs -0 --replace $CONVERTTOOL -resize $WIDTH "{}" "icons/{}"
+if [ -e ${INDEXDOCUMENT} ] && [ ! -w ${INDEXDOCUMENT} ]; then
+	$ECHOCOMMAND "Can't write ${INDEXDOCUMENT}, exiting"
+	exit 8
+fi
 
-cat < index.html
-
-
-
-
-	${TITLE}
-	
-
-
-END
+if [ -e style.css ] && [ ! -w style.css ]; then
+	$ECHOCOMMAND "Can't write style.css, exiting"
+	exit 8
+fi
 
+generate_thumbs
 
-find . -type f -name \*.jpg -maxdepth 1 -print -or -type f -name \*.gif -maxdepth 1 -print -or -type f -name \*.png -maxdepth 1 -print | sed -e 's#^./\(.*\)$#
#' >> index.html +if [[ "x$PAGESDIRECTORY" != "x" ]]; then + if [ ! -d $PAGESDIRECTORY ]; then + mkdir -p $PAGESDIRECTORY + fi -cat <> index.html - - -END + if [ ! -w $PAGESDIRECTORY ]; then + $ECHOCOMMAND "Can't write to $PAGESDIRECTORY directory, exiting" + exit 16 + fi + UNIXPAGESDIRECTORY=$PAGESDIRECTORY/ + PAGESDIRECTORY=$(bpgallery_escape_url $PAGESDIRECTORY)/ + BASEURL="../" +else + BASEURL="" + UNIXPAGESDIRECTORY="" +fi -cd icons -if ( ls *.jpg > /dev/null 2>/dev/null ); then - TEMPMAX=$(identify *.jpg | sed -r 's#^.*?[0-9]+x([0-9]+)\+.*$#\1#' | sort -g -r | head -n 1) - if [[ $TEMPMAX -gt $MAXHEIGHT ]]; then - MAXHEIGHT=$TEMPMAX - fi +if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then + generate_medium + generate_medium_pages fi -if ( ls *.gif > /dev/null 2>/dev/null ); then - TEMPMAX=$(identify *.gif | sed -r 's#^.*?[0-9]+x([0-9]+)\+.*$#\1#' | sort -g -r | head -n 1) - - if [[ $TEMPMAX -gt $MAXHEIGHT ]]; then - MAXHEIGHT=$TEMPMAX +if [ $GENERATEPAGESFORFULLSIZE != 0 ]; then + if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then + generate_pages __${MEDIUMDIRECTORY} + else + generate_pages fi fi -if ( ls *.png > /dev/null 2>/dev/null ); then - TEMPMAX=$(identify *.png | sed -r 's#^.*?[0-9]+x([0-9]+)\+.*$#\1#' | sort -g -r | head -n 1) - if [[ $TEMPMAX -gt $MAXHEIGHT ]]; then - MAXHEIGHT=$TEMPMAX - fi +if [ -r description.txt ] ; then + DESCRIPTION=$($SEDCOMMAND -e '1 { s/^/

/; }; /^$/ { s,$,

,; }; $ { s,$,

, };' description.txt) +else + DESCRIPTION="" fi -cd .. - +BASEURL="" +$ECHOCOMMAND "Starting to generate page" -cat < style.css -body { - background: white; - color: black; - font-family: sans-serif; - font-size: 12pt; -} +$BPGALLERY_HEAD_FUNCTION > ${INDEXDOCUMENT} +$BPGALLERY_DESCRIPTION_FUNCTION >> ${INDEXDOCUMENT} -div.thumbnail { - float: left; - padding: 20px; - border: 0px; - width: ${WIDTH}px; - height: ${MAXHEIGHT}px; -} +$ECHOCOMMAND "Adding Captions" -a { - border: 0px; -} +extra="" +if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then + extra=__${MEDIUMDIRECTORY} +fi -img { - border: 0px; -} -END +$FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 -I {} $ECHOCOMMAND {} | $SORTCOMMAND -g | while read filename; do filename=${filename#./}; if [ -r captions.txt ]; then caption=$($GREPCOMMAND -E "^$filename " captions.txt); caption=${caption#* }; else caption=""; fi; if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then link=${PAGESDIRECTORY}$(bpgallery_escape_url "${filename}${extra}.html"); elif [ $GENERATEPAGESFORFULLSIZE != 0 ]; then link=${PAGESDIRECTORY}$(bpgallery_escape_url "${filename}.html"); else link=$(bpgallery_escape_url "$filename"); fi; filename=$(bpgallery_escape_url "$filename"); $BPGALLERY_THUMBSLINE_FUNCTION; done >> ${INDEXDOCUMENT} + +$BPGALLERY_TAIL_FUNCTION >> ${INDEXDOCUMENT} +$ECHOCOMMAND "Finished generating the page" +$ECHOCOMMAND "Generating stylesheet" +cd $ICONSDIRECTORY + +MAXHEIGHT=$($FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 $IDENTIFYCOMMAND -format "%h\n" | $GREPCOMMAND -v "^$" | $SORTCOMMAND -g -r | $HEADCOMMAND -n 1) +MAXWIDTH=$($FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 $IDENTIFYCOMMAND -format "%w\n" | $GREPCOMMAND -v "^$" | $SORTCOMMAND -g -r | $HEADCOMMAND -n 1) + +cd .. + +# add a bit to the maxheight for the size of the caption +MAXHEIGHT=$((MAXHEIGHT+$CAPTIONHEIGHT)) + +$BPGALLERY_STYLESHEET_FUNCTION > style.css + +$ECHOCOMMAND "All done" + +if [[ $OUTPUTHTML != 0 ]]; then + $ECHOCOMMAND "
" +fi