Check tools are available
[bpgallery.git] / bpgallery.sh
index f4aa372ee6b4588f5dbab02bff5152234aa0b84e..d26821a325a7434b866dd22238bcb0f687215743 100755 (executable)
@@ -19,7 +19,7 @@
 
 set -f
 
-VERSION="1.1+arch"
+VERSION="1.1.1+arch"
 
 function bpgallery_default_head() {
 cat <<END
@@ -28,7 +28,7 @@ cat <<END
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
        <title>${TITLE}</title>
-       <link rel="stylesheet" href="style.css" type="text/css" />
+       <link rel="stylesheet" href="${BASEURL}style.css" type="text/css" />
 </head>
 <body>
 END
@@ -52,7 +52,7 @@ else
        caption_alt=$caption
 fi
 cat << END
-<div class="thumbnail"><a href="$link"><img src="icons/$filename" alt="$caption_alt" /></a><div class="caption">$caption</div></div>
+<div class="thumbnail"><a href="$link"><img src="${ICONSDIRECTORY}/$filename" alt="$caption_alt" /></a><div class="caption">$caption</div></div>
 END
 }
 
@@ -133,18 +133,18 @@ function bpgallery_default_page() {
 <h1>${caption}</h1>
 <div class="navigation">
        <ul>
-               <li><a href='${INDEXDOCUMENT}'>Thumbnails</a></li>
+               <li><a href='${BASEURL}${INDEXDOCUMENT}'>Thumbnails</a></li>
 END
        if [[ ! -z $previouspage ]]; then
-               echo "<li><a href='${previouspage}'>Previous</a></li>"
+               $ECHOCOMMAND "<li><a href='${previouspage}'>Previous</a></li>"
        else
-               echo "<li>Previous</li>"
+               $ECHOCOMMAND "<li>Previous</li>"
        fi
 
        if [[ ! -z $nextpage ]]; then
-               echo "<li><a href='${nextpage}'>Next</a></li>"
+               $ECHOCOMMAND "<li><a href='${nextpage}'>Next</a></li>"
        else
-               echo "<li>Next</li>"
+               $ECHOCOMMAND "<li>Next</li>"
        fi
 cat <<END
        </ul>
@@ -176,6 +176,24 @@ function bpgallery_escape_url() {
        $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
@@ -222,39 +240,140 @@ if [[ -z $TITLE ]]; then
 fi
 
 if [[ -z $CONVERTTOOL ]]; then
-       CONVERTTOOL=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
-       FINDCOMMAND=find
+       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
-       XARGSCOMMAND=xargs
+       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
-       SORTCOMMAND=sort
+       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
-       IDENTIFYCOMMAND=identify
+       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
-       HEADCOMMAND=head
+       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
-       GREPCOMMAND=grep
+       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
-       SEDCOMMAND=sed
+       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
@@ -265,10 +384,6 @@ if [[ -z $IMAGEEXTENSIONS ]]; then
        IMAGEEXTENSIONS="jpeg jpg gif png";
 fi
 
-if [[ -z $WCCOMMAND ]]; then
-       WCCOMMAND="wc -l"
-fi
-
 if [[ -z $CAPTIONHEIGHT ]]; then
        CAPTIONHEIGHT=75
 fi
@@ -285,6 +400,18 @@ if [[ -z $GENERATEPAGESFORMEDIUMSIZE ]]; then
        GENERATEPAGESFORMEDIUMSIZE=1
 fi
 
+if [[ -z $PAGESDIRECTORY ]]; then
+       PAGESDIRECTORY=""
+else
+       removetrailingslashes=${PAGESDIRECTORY%/}
+       temp=$removetrailingslashes
+       while [[ $removetrailingslashes != $temp ]]; do
+               temp=$removetrailingslashes
+               removetrailingslashes=${temp%/}
+       done
+       PAGESDIRECTORY=$(bpgallery_escape_url "${PAGESDIRECTORY}")
+fi
+
 if [[ -z $MEDIUMWIDTH ]]; then
        MEDIUMWIDTH=400
 fi
@@ -293,12 +420,24 @@ if [[ -z $INDEXDOCUMENT ]]; then
        INDEXDOCUMENT=index.html
 fi
 
-if [[ $GENERATEPAGESFORFULLSIZE != 0 ]]; then
-       if declare -F "bpgallery_${BPGALLERY_THEME}_page" > /dev/null ; then
-               BPGALLERY_PAGE_FUNCTION="bpgallery_${BPGALLERY_THEME}_page"
-       else
-               BPGALLERY_PAGE_FUNCTION="bpgallery_default_page"
-       fi
+if [[ -z $MEDIUMDIRECTORY ]]; then
+       MEDIUMDIRECTORY=medium
+else
+       # Strip out anything that might be broken
+       MEDIUMDIRECTORY=$(bpgallery_cleanup_directory_name "$MEDIUMDIRECTORY")
+fi
+
+if [[ -z $ICONSDIRECTORY ]]; then
+       ICONSDIRECTORY=icons
+else
+       # Strip out anything that might be broken
+       ICONSDIRECTORY=$(bpgallery_cleanup_directory_name "$ICONSDIRECTORY")
+fi
+
+if declare -F "bpgallery_${BPGALLERY_THEME}_page" > /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
@@ -349,7 +488,39 @@ 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 <pre> 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
 }
 
@@ -365,6 +536,22 @@ function generate_resized_images() {
        totalimages=$($FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 -I {} $ECHOCOMMAND {} | $WCCOMMAND);
        imagestoupdate=$($FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 -I {} $ECHOCOMMAND {} | while read filename; do filename=${filename//\"/\\\"}; if [ ! -r "$2/$filename" ] || [ "$filename" -nt "$2/$filename" ] || [ $($IDENTIFYCOMMAND -format "%w" "$2/$filename") -ne $1 ]; then $ECHOCOMMAND $filename; fi; done | $WCCOMMAND)
        
+       if [ $totalimages -eq 0 ]; then
+               # might as well exit at this point - there are no pictures
+               $ECHOCOMMAND "No images for the gallery - exiting."
+               exit 64
+       else
+               # check if the directory exists and create it other wise
+               if [ ! -d $2 ]; then
+                       mkdir $2
+               fi
+
+               if [ ! -w $2 ]; then
+                       $ECHOCOMMAND "Can't write to $2 directory, exiting"
+                       exit 16
+               fi
+       fi
+
        if [ $totalimages -eq $imagestoupdate ]; then
                $ECHOCOMMAND "Regenerating all $2"
        elif [ $imagestoupdate -eq 0 ]; then
@@ -380,29 +567,11 @@ function generate_resized_images() {
 }
 
 function generate_thumbs() {
-       if [ ! -d icons ]; then
-               mkdir icons
-       fi
-
-       if [ ! -w icons ]; then
-               $ECHOCOMMAND "Can't write to icons directory, exiting"
-               exit 16
-       fi
-
-       generate_resized_images $WIDTH icons
+       generate_resized_images $WIDTH $ICONSDIRECTORY
 }
 
 function generate_medium() {
-       if [ ! -d medium ]; then
-               mkdir medium
-       fi
-
-       if [ ! -w medium ]; then
-               $ECHOCOMMAND "Can't write to medium directory, exiting"
-               exit 32
-       fi
-       
-       generate_resized_images $MEDIUMWIDTH medium
+       generate_resized_images $MEDIUMWIDTH $MEDIUMDIRECTORY
 }
 
 function generate_pages() {
@@ -426,10 +595,10 @@ function generate_pages() {
                addlinks=1
        fi
 
-       if [ -z $1 ] && [ -z $2 ] && [[ $GENERATEPAGESFORMEDIUMSIZE != 0 ]]; then
+       if [ -z $2 ] && [[ $GENERATEPAGESFORMEDIUMSIZE != 0 ]]; then
                addlinks=2
        fi
-
+       
        $FINDCOMMAND . $FINDIMAGESOPTIONS | \
        $XARGSCOMMAND -0 -I {} $ECHOCOMMAND {} | \
        $SORTCOMMAND -g | \
@@ -438,52 +607,68 @@ function generate_pages() {
                currentimage=$nextimage
                nextimage=${imagefilename#./}
                addlink=""
-
-               if [[ $addlinks == 1 ]]; then
-                       if [[ $GENERATEPAGESFORFULLSIZE != 0 ]]; then
+               
+               if [[ $GENERATEPAGESFORFULLSIZE != 0 ]]; then
+                       if [[ $addlinks == 1 ]]; then
                                addlink=${currentimage}.html
                        else
-                               addlink=${currentimage}
+                               addlink=${currentimage}${extra}.html
                        fi
+               else
+                       addlink=${currentimage}
                fi
 
-               if [[ $addlinks == 2 ]]; then
-                       addlink=${currentimage}__medium.html
-               fi
-               
                previouspage=$currentpage
                currentpage=$nextpage
-               nextpage=${imagefilename}${extra}.html
-               filename=${extradir}${currentimage}
-               generate_general_page "$previouspage" "$currentpage" "$nextpage" $addlink
-               echo $nextimage
+               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 [[ $addlinks == 1 ]]; then
-                       if [[ $GENERATEPAGESFORFULLSIZE ]]; then
+               if [[ $GENERATEPAGESFORFULLSIZE != 0 ]]; then
+                       if [[ $addlinks == 1 ]]; then
                                addlink=${currentpage}.html
                        else
-                               addlink=${currentpage}
+                               addlink=${currentpage}${extra}.html
                        fi
-               fi
-
-               if [[ $addlinks == 2 ]]; then
-                       addlink=${nextimage}__medium.html
+               else
+                       addlink=${currentpage}
                fi
                
-               filename=${extradir}${currentpage}
-               currentpage=${currentpage}${extra}.html
-               previouspage=${previouspage}${extra}.html
+               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 __medium medium
+       generate_pages __${MEDIUMDIRECTORY} ${MEDIUMDIRECTORY}
 }
 
 function generate_general_page() {
@@ -506,12 +691,13 @@ function generate_general_page() {
        fi
 
        if [ -r captions.txt ]; then
-               caption=$($GREPCOMMAND -E "^${filename}   " captions.txt); caption=${caption#*    }
+               imagefilename=${filename##*/}
+               caption=$($GREPCOMMAND -E "^${imagefilename}    " captions.txt); caption=${caption#*    }
        else
                caption=""
        fi
-
-       $BPGALLERY_PAGE_FUNCTION > "$currentpage"
+       
+       $BPGALLERY_PAGE_FUNCTION > "${UNIXPAGESDIRECTORY}$currentpage"
 }
 
 if [[ $OUTPUTHTML != 0 ]]; then
@@ -564,13 +750,35 @@ fi
 
 generate_thumbs
 
+if [[ "x$PAGESDIRECTORY" != "x" ]]; then
+       if [ ! -d $PAGESDIRECTORY ]; then
+               mkdir -p $PAGESDIRECTORY
+       fi
+
+       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
+
 if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then
        generate_medium
        generate_medium_pages
 fi
 
 if [ $GENERATEPAGESFORFULLSIZE != 0 ]; then
-       generate_pages
+       if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then
+               generate_pages __${MEDIUMDIRECTORY}
+       else
+               generate_pages
+       fi
 fi
 
 if [ -r description.txt ] ; then
@@ -579,6 +787,7 @@ else
        DESCRIPTION=""
 fi
 
+BASEURL=""
 
 $ECHOCOMMAND "Starting to generate page"
 
@@ -589,16 +798,16 @@ $ECHOCOMMAND "Adding Captions"
 
 extra=""
 if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then
-       extra=__medium
+       extra=__${MEDIUMDIRECTORY}
 fi
 
-$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 [ $GENERATEPAGESFORFULLSIZE != 0 ]; then link=$(bpgallery_escape_url "${filename}${extra}.html"); else link=$(bpgallery_escape_url "$filename"); fi; filename=$(bpgallery_escape_url "$filename"); $BPGALLERY_THUMBSLINE_FUNCTION; done >> ${INDEXDOCUMENT}
+$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 icons
+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)