]> git.sommitrealweird.co.uk Git - bpgallery.git/blobdiff - bpgallery.sh
Make icons and medium image directories non-hardcoded
[bpgallery.git] / bpgallery.sh
index f1dcee7908c88894a68eca2702c9787cf68dd527..3350f209d8a4d09f7b67300e7cef71114c35a576 100755 (executable)
@@ -19,7 +19,7 @@
 
 set -f
 
-VERSION="1.0.0+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="$filename"><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
 }
 
@@ -70,18 +70,18 @@ declare -rf bpgallery_default_tail
 function bpgallery_default_stylesheet() {
 cat <<END
 body {
-        background: white;
-        color: black;
-        font-family: sans-serif;
-        font-size: 10pt;
+       background: white;
+       color: black;
+       font-family: sans-serif;
+       font-size: 10pt;
 }
 
 div.thumbnail {
-        float: left;
-        padding: 20px;
-        border: 0px;
-        width: ${WIDTH}px;
-        height: ${MAXHEIGHT}px;
+       float: left;
+       padding: 20px;
+       border: 0px;
+       width: ${WIDTH}px;
+       height: ${MAXHEIGHT}px;
 }
 
 div.caption {
@@ -90,18 +90,74 @@ div.caption {
        font-weight: bold;
 }
 
+div.navigation {
+       margin: 0;
+}
+
+div.navigation ul {
+       display: inline;
+       margin: 0;
+       padding: 0;
+       text-align: center;
+}
+
+div.navigation ul li {
+       display: inline;
+       margin: 2em;
+}
+
 a {
-        border: 0px;
+       border: 0px;
 }
 
 img {
-        border: 0px;
+       border: 0px;
 }
 END
 }
 
 declare -rf bpgallery_default_stylesheet
 
+function bpgallery_default_page() {
+       $BPGALLERY_HEAD_FUNCTION
+
+       linkstart=""
+       linkend=""
+
+       if [[ ! -z $linklocation ]]; then
+               linkstart="<a href='$linklocation'>"
+               linkend="</a>"
+       fi
+       
+       cat <<END
+<h1>${caption}</h1>
+<div class="navigation">
+       <ul>
+               <li><a href='${BASEURL}${INDEXDOCUMENT}'>Thumbnails</a></li>
+END
+       if [[ ! -z $previouspage ]]; then
+               $ECHOCOMMAND "<li><a href='${previouspage}'>Previous</a></li>"
+       else
+               $ECHOCOMMAND "<li>Previous</li>"
+       fi
+
+       if [[ ! -z $nextpage ]]; then
+               $ECHOCOMMAND "<li><a href='${nextpage}'>Next</a></li>"
+       else
+               $ECHOCOMMAND "<li>Next</li>"
+       fi
+cat <<END
+       </ul>
+</div>
+<div class="mainimage">
+       ${linkstart}<img src="${filename}" alt="${caption}" />${linkend}
+</div>
+END
+       $BPGALLERY_TAIL_FUNCTION
+}
+
+declare -rf bpgallery_default_page
+
 function bpgallery_escape_url() {
        temp=$1
        temp=${temp//\%/%25}
@@ -117,7 +173,25 @@ function bpgallery_escape_url() {
        temp=${temp//\?/%3F}
        temp=${temp//@/%40}
        temp=${temp//\"/%22}
-       echo $temp
+       $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
@@ -142,11 +216,18 @@ 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 [[ -e $HOME/.bpgallery.themes/${BPGALLERY_THEME} ]]; then
+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
@@ -210,6 +291,58 @@ if [[ -z $CAPTIONHEIGHT ]]; then
        CAPTIONHEIGHT=75
 fi
 
+if [[ -z $OUTPUTHTML ]]; then
+       OUTPUTHTML=0
+fi
+
+if [[ -z $GENERATEPAGESFORFULLSIZE ]]; then
+       GENERATEPAGESFORFULLSIZE=0
+fi
+
+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
+
+if [[ -z $INDEXDOCUMENT ]]; then
+       INDEXDOCUMENT=index.html
+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
        BPGALLERY_HEAD_FUNCTION="bpgallery_${BPGALLERY_THEME}_head"
 else
@@ -258,7 +391,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
 }
 
@@ -268,8 +433,182 @@ Version: $VERSION
 END
 }
 
+function generate_resized_images() {
+       $ECHOCOMMAND "Generating $2"
+       currentimage=0
+       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
+               $ECHOCOMMAND "No Updated $2, not regenerating"
+               return
+       else
+               $ECHOCOMMAND "Generating $imagestoupdate of $totalimages $2"
+       fi
+       
+       $FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 -I {} $ECHOCOMMAND {} | while read filename; do tempfilename=${filename//\"/\\\"/}; if [ ! -r "$2/$tempfilename" ] || [ "$tempfilename" -nt "$2/$tempfilename" ] || [ $($IDENTIFYCOMMAND -format "%w" "$2/$filename") -ne $1 ]; then $ECHOCOMMAND -n $filename; $ECHOCOMMAND -n -e "\000"; fi; done | $XARGSCOMMAND -0 --verbose --max-procs=4 -I {} $CONVERTTOOL -resize $1 '{}' $2/'{}' 2>&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() {
+       generate_resized_images $WIDTH $ICONSDIRECTORY
+}
+
+function generate_medium() {
+       generate_resized_images $MEDIUMWIDTH $MEDIUMDIRECTORY
+}
+
+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 "<pre>"
+fi
+
 if [[ -z $1 ]]; then
-       echo "No path given"
+       $ECHOCOMMAND "No path given"
        usage
        exit 1
 fi
@@ -285,7 +624,7 @@ 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
@@ -293,31 +632,56 @@ fi
 cd "$1"
 
 if ( ! $FINDCOMMAND . $FINDIMAGESOPTIONS > /dev/null 2>/dev/null ); then
-       echo "$1 does not contain any images. Quitting."
+       $ECHOCOMMAND "$1 does not contain any images. Quitting."
        exit 4
 fi
 
-if [ ! -d icons ]; then
-       mkdir icons
+if [ ! -w . ]; then
+       $ECHOCOMMAND "Can't write to images directory, exiting"
+       exit 8
+fi
 
-       totalimages=$($FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 --replace echo {} | $WCCOMMAND);
-       currentimage=0
-       
-       $FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 --verbose --max-procs=4 --replace $CONVERTTOOL -resize $WIDTH '{}' 'icons/{}' 2>&1 | while read throwout; do $ECHOCOMMAND done: $currentimage/$totalimages images; currentimage=$((currentimage+1)); done
-       
-       echo done: $totalimages/$totalimages images
-else
-       echo "$1 already contains an icons folder, updating."
+if [ -e ${INDEXDOCUMENT} ] && [ ! -w ${INDEXDOCUMENT} ]; then
+       $ECHOCOMMAND "Can't write ${INDEXDOCUMENT}, exiting"
+       exit 8
+fi
 
-       imagestoupdate=$($FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 --replace $ECHOCOMMAND {} | while read filename; do filename=${filename//\"/\\\"}; if [ ! -r "icons/$filename" ] || [ "$filename" -nt "icons/$filename" ]; then $ECHOCOMMAND $filename; fi; done | $WCCOMMAND)
+if [ -e style.css ] && [ ! -w style.css ]; then
+       $ECHOCOMMAND "Can't write style.css, exiting"
+       exit 8
+fi
 
-       echo "images to update: $imagestoupdate"
-       
-       
-       currentimage=0
+generate_thumbs
+
+if [[ "x$PAGESDIRECTORY" != "x" ]]; then
+       if [ ! -d $PAGESDIRECTORY ]; then
+               mkdir -p $PAGESDIRECTORY
+       fi
 
-       $FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 --replace $ECHOCOMMAND {} | while read filename; do tempfilename=${filename//\"/\\\"/}; if [ ! -r "icons/$tempfilename" ] || [ "$tempfilename" -nt "icons/$tempfilename" ] ; then $ECHOCOMMAND -n $filename; $ECHOCOMMAND -n -e "\000"; fi; done | $XARGSCOMMAND -0 --verbose --max-procs=4 --replace $CONVERTTOOL -resize $WIDTH '{}' 'icons/{}' 2>&1 | while read throwout; do $ECHOCOMMAND done: $currentimage/$imagestoupdate images; echo $throwout; currentimage=$((currentimage+1)); done
-       echo done: $imagestoupdate/$imagestoupdate images
+       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
+       if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then
+               generate_pages __${MEDIUMDIRECTORY}
+       else
+               generate_pages
+       fi
 fi
 
 if [ -r description.txt ] ; then
@@ -326,15 +690,27 @@ else
        DESCRIPTION=""
 fi
 
+BASEURL=""
 
-$BPGALLERY_HEAD_FUNCTION > index.html
-$BPGALLERY_DESCRIPTION_FUNCTION >> index.html
+$ECHOCOMMAND "Starting to generate page"
 
-$FINDCOMMAND . $FINDIMAGESOPTIONS | $XARGSCOMMAND -0 --replace $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; filename=$(bpgallery_escape_url "$filename"); $BPGALLERY_THUMBSLINE_FUNCTION; done >> index.html
+$BPGALLERY_HEAD_FUNCTION > ${INDEXDOCUMENT}
+$BPGALLERY_DESCRIPTION_FUNCTION >> ${INDEXDOCUMENT}
 
-$BPGALLERY_TAIL_FUNCTION >> index.html
+$ECHOCOMMAND "Adding Captions"
 
-cd icons
+extra=""
+if [ $GENERATEPAGESFORMEDIUMSIZE != 0 ]; then
+       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 [ $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)
@@ -346,3 +722,8 @@ MAXHEIGHT=$((MAXHEIGHT+$CAPTIONHEIGHT))
 
 $BPGALLERY_STYLESHEET_FUNCTION > style.css
 
+$ECHOCOMMAND "All done"
+
+if [[ $OUTPUTHTML != 0 ]]; then
+       $ECHOCOMMAND "</pre>"
+fi