#! /usr/local/bin/perl
#
# $Id: webmagick.in,v 1.154 2006/07/26 03:36:05 ache Exp $
#
# You are looking at the main PERL script for WebMagick, a package to
# intelligently create HTML and JavaScript index files and imagemaps
# corresponding to a directory tree of image files.
#
# Copyright Bob Friesenhahn (bfriesen@simple.dallas.tx.us) 1996, 1997,
# 1998, 1999, 2000
#
# This work may be used for any purpose, public or private, provided
# that this work or derivations thereof are attributed to its author.
# Full copyrights to this work are maintained by its author to ensure
# that rights so bestowed are not abridged.
#
# NOTE: This program has a substantial manual. Considerable time has
# been spent writing it so please at least skim through it before
# asking questions.
#
# Requires the ImageMagick, PerlMagick, and PERL 5 packages. May
# possibly execute correctly (but with reduced performance) with
# package versions as old as:
# ImageMagick -- 3.8.4
# PerlMagick -- 1.12
# PERL -- 5.003
#
# But always tested by the author with recent versions. At the last
# update of these notes (December 19, 1998) the latest versions tested
# were:
# ImageMagick -- 4.1.6
# PerlMagick -- 1.55
# PERL -- 5.004_04
#
# While some effort is made to ensure that WebMagick will execute under
# older package versions, the author does not use these versions so
# he will only know to correct incompatabilities if they are brought
# to his attention.
#
# The latest version of WebMagick is always available from the URL
# "ftp://ftp.simplesystems.org/pub/WebMagick". Keep track of
# the latest WebMagick developments by visiting the WebMagick web page
# at "http://webmagick.sourceforge.net/".
#
# Obtain ImageMagick from "ftp://ftp.wizards.dupont.com/pub/ImageMagick"
# or visit the ImageMagick web page at
# "http://www.wizards.dupont.com/cristy/ImageMagick.html".
#
# Obtain PerlMagick from
# "ftp://ftp.wizards.dupont.com/pub/ImageMagick/perl" or visit the
# PerlMagick web page at
# "http://www.wizards.dupont.com/cristy/www/perl.html".
#
# ImageMagick and PerlMagick are written by John Cristy (cristy@dupont.com).
# WebMagick would not be possible without his wonderful software. The
# author greatly appreciates Cristy's assistance with ironing out PerlMagick's
# (or WebMagick's bugs) during the development of WebMagick.
#
# Suggestions, moral support, and patches were provided by Anthony
# Thyssen (anthony@cit.gu.edu.au). His help is very much appreciated.
#
use locale;
use POSIX qw(strftime _exit);
use Cwd;
# If your PERL barfs, you may need to comment one or more of the following
# lines out:
use strict 'refs'; # Be picky about references
use strict 'subs'; # Be picky about subroutines
use strict 'vars'; # Be picky about variable scope (explicit globals)
#
# Global variable declarations
#
my (
%RGBDB, # RGB color database
@allFiles, # List of files in current directory
@allImageFiles, # List of all source file names in directory
@cacheFiles, # List of files in the image cache
@lowresFiles, # List of files in the image lowres cache
$currentDirectory, # Current directory (absolute)
$doMontage, # Set to true if montage must be generated
$doPageHtml, # Set to true if per-page HTML files must be generated
%dirOrder, # Order directories are listed in dirindex file
%dirTitles, # Directory name to title index
%fileNames, # Hash of generated file names
%frameTargets, # Frame targets
@global_option_files, # List of rc files to source before all others
$haveImages, # Set to true if there are images in directory
$haveReadme, # Set to true if there is a README file in directory
%htmlOpts, # Options that effect HTML output
$htmlParams, # String form of HTML parameters
%iconImageSizes, # Size of icons
%iconImageUrls, # URLs for icons
$icon_base_url, # URL to icon directory
$icon_dir_path, # Path to icon directory
%icon_paths, # Paths to icon files
@imageThumbCoords, # Thumbnail imagemap coordinates
$imageFrameLink, # URL to use as source for image frame
%imageLabels, # Labels to use for images (if specified)
%imageCaptions, # Captions for perimage HTML
%tableImageLabels, # labels to use in tables
%imageOrder, # Order that images occur in imgindex file
$inChild, # Set to true if this process is a child
$currentDate,
@montageImages, # List of per-page montage image names
@montageImageSizes, # List of per-page montage image sizes
$montageArguments, # PerlMagick Montage() arguments
$montageParameters, # Montage() arguments plus others that effect montage output
$netscapeColormap, # PerlMagick image object representing Netscape color cube
$numPages, # Number of pages to represent current directory
$opt_address,
$opt_allowconfig,
$opt_anonymous,
$opt_cache,
$opt_cachedir,
$opt_cacheformat,
$opt_cachegeom,
$opt_cachemin,
$opt_centerfooter,
$opt_lowres,
$opt_lowresdir,
$opt_lowresformat,
$opt_lowresgeom,
$opt_lowresmin,
$opt_coloralink,
$opt_colorback,
$opt_colorfore,
$opt_colorlink,
$opt_colorvlink,
$opt_columns,
$opt_date,
$opt_debug,
$opt_dircoloralink,
$opt_dircolorback,
$opt_dircolorfore,
$opt_dircolorlink,
$opt_dircolorvlink,
$opt_dirfmt,
$opt_dirhtmlext,
$opt_dirindexname,
$opt_forcecache,
$opt_forcelowres,
$opt_forcegif,
$opt_forcejpeg,
$opt_forcehtml,
$opt_forcemontage,
$opt_forcenouplink,
$opt_forceuplink,
$opt_frame_name_dirview,
$opt_frame_name_imageview,
$opt_frame_name_thumbview,
$opt_frame_name_top,
$opt_frameborder,
$opt_frameddirfmt,
%opt_framefmt,
%opt_framefmt_frames,
$opt_framemarginheight,
$opt_framemarginwidth,
$opt_frames,
$opt_framestyle,
$opt_htmlext,
$opt_header,
$opt_footer,
$opt_help,
$opt_htimage,
$opt_iconbase,
$opt_iconpath,
%opt_icons,
$opt_ignore,
$opt_ignorefp,
$opt_indexinfo,
$opt_imgindexname,
$opt_indexname,
$opt_javascript,
$opt_jpegquality,
$opt_lockfile,
$opt_mapnetscape,
$opt_maptype,
$opt_maxgif,
$opt_metaauthor,
$opt_metacharset,
$opt_metaclassification,
$opt_metadescription,
$opt_metaexpires,
$opt_metakeywords,
$opt_msg_copyright,
$opt_msg_date_format,
$opt_msg_directories,
$opt_msg_directory_navigator,
$opt_msg_images,
$opt_msg_index_of_directory,
$opt_msg_index_of_files,
$opt_msg_index_through,
$opt_msg_next,
$opt_msg_pause,
$opt_msg_page_navigator,
$opt_msg_page_updated_on,
$opt_msg_prev,
$opt_msg_produced_by,
$opt_msg_readme,
$opt_msg_up,
$opt_pageindexname,
$opt_prefixpath,
$opt_prune,
$opt_readfailhook,
$opt_readme,
$opt_readmevisible,
$opt_recurse,
$opt_rgbdb,
$opt_rootpath,
$opt_rows,
$opt_serversidemap,
$opt_skip,
$opt_srcdir,
$opt_stylesheet, # URL to a CSS to use
$opt_tables,
$opt_tablebackcolor,
$opt_fancytables,
$opt_fancytableheight,
$opt_tables_bottom,
$opt_tables_params,
$opt_tables_top,
$opt_thumbbackground,
$opt_thumbbordercolor,
$opt_thumbborderwidth,
$opt_thumbcompose,
$opt_thumbfont,
$opt_thumbforeground,
$opt_thumbframe,
$opt_thumbframebgcolor,
$opt_thumbframecolor,
$opt_thumbgeometry,
$opt_thumbgravity,
$opt_thumblabel,
$opt_thumblabelwidth,
$opt_thumbmattecolor,
$opt_thumbposthook,
$opt_thumbprehook,
$opt_thumbshadow,
$opt_thumbtexture,
$opt_thumbtransparent,
$opt_title,
$opt_verbose,
$opt_version,
$opt_webmagickrc, # Per-directory WebMagick rc file name
$opt_zoomfilter,
$opt_pichtml,
$opt_pichtmlaltend,
$opt_pichtmlaltstart,
$opt_pichtmlbottom,
$opt_pichtmlext,
$opt_pichtmllink,
$opt_pichtmlnav,
$opt_pichtmlupfirst,
$opt_pichtmlputtitle,
$opt_pichtmltitletop,
$opt_pichtmltarget,
$opt_pichtmltitleend,
$opt_pichtmltitlestart,
$opt_pichtmltop,
$opt_edgelinksindex,
$pageStatusTime, # Time status file last modified
$pageNumber, # Current page number
$pathSep, # OS-specific path separator
$perlVarsLoaded, # Set to one when directory status file sourced
$perlVarsVersion, # version used for last file generation
$prefix, # installation directory
$requiredPerlVarsVersion, # version required. If less than this, regenerate
%relativePathCache, # Relative path cache
$sourceDirectory, # Directory to process
%thumbImageSizes, # thumbnail image sizes
@imageNames, # List of source file names for current page
$startTime, # Clock time when program started
%dirJsLink, # Link name to use when changing directories via JavaScript
@dirNames, # List of directories under this directory
$pageTitle, # Title for current page
%webmagickInfo # WebMagick version information as a hash
);
###########################################################################
# Internal Default Options
###########################################################################
#
#WebMagickRcTop -- Don't remove this line
#
# Copy the webmagickrc file to your home directory under the name
# .webmagickrc. Any default definitions you want to override should be
# uncommented in this file and modified.
#
# Navigation Icon Paths and URLs
# Specify the path and file name for the navigation icons.
# !!!MUST EDIT OR OVERRIDE!!!
#
$opt_rootpath = '/usr/local/www/data'; # Directory Path to top of html tree
# Needed to determine relative paths to images
$opt_prefixpath = ''; # Path or URL to prepend to root URL
# Not used if local relative paths used
$opt_iconpath = 'webmagick';
# Relative path under rootpath / prefixpath
$opt_iconbase = '';
# Global icons base URL, if not empty
$prefix = '/usr/local'; # installation directory
#
# Server-side imagemap settings
# !!!MAY NEED TO EDIT OR OVERRIDE!!!
#
$opt_htimage=''; # Base URL to server-side imagemap CGI
# On some systems this is /cgi-bin/imagemap
# Set to '' to use a ".map" URL with relative
# URLs (latest NCSA & Apache)
$opt_maptype='ncsa'; # Maptype must be 'cern' or 'ncsa'. If you are
# using Apache, specify 'ncsa'.
$opt_serversidemap = 0; # Enable server-side maps writting
$perlVarsVersion = 0; # default this to 0 for it to be overidden by appropriate status files
$requiredPerlVarsVersion = 2.3; # need this version to avoid regeneration of files
#
# RC files
#
#
# Name of per-directory rc file
$opt_webmagickrc = '.webmagickrc';
# global rc files
@global_option_files = ("${prefix}/etc/webmagickrc", "$ENV{'HOME'}/${opt_webmagickrc}");
#
# Lockfile to keep from doing same directory in two processes
#
$opt_lockfile = '.webmagick.lockfile';
# File naming
$opt_indexname = 'index.html'; # Per-directory master index file
$opt_readme = 'README.html';# Name of welcome page README file ('' = none)
$opt_pageindexname = '.index'; # Base name of secondary index files
$opt_dirindexname = '.dirindex'; # Subdirectory Title cross-reference
# dirname Directory Title
$opt_dirhtmlext = '.html'; # Use .shtml for SSI
$opt_imgindexname = '.imgindex'; # Image name to label cross-reference file
if ($^O eq "MSWin32")
{$pathSep = "\\"; }
else
{$pathSep = "/"; }
#
# HTML color and background image related options
#
# X11 RBG color database (rgb.txt) location
# Entries in this file have the form:
# Red Green Blue Color-name
# where color intensities are specified in decimal.
# e.g. 250 240 230 linen
$opt_rgbdb='/usr/X11R6/lib/X11/rgb.txt';
#
# Page Frame & non-framed pages
$opt_colorback = '#CCCCCC'; # Color -- Background
$opt_colorfore = 'black'; # Color -- Foreground
$opt_coloralink = '#FF0000'; # Color -- Active link
$opt_colorlink = '#0000EE'; # Color -- Link
$opt_colorvlink = '#551A8B'; # Color -- Visited link
#
# Directory frame (Leave options empty ('') to use page frame colors
$opt_dircolorback = '#B2B2B2'; # Color -- Background
$opt_dircolorfore = 'black'; # Color -- Foreground
$opt_dircoloralink = ''; # Color -- Active link
$opt_dircolorlink = ''; # Color -- Link
$opt_dircolorvlink = ''; # Color -- Visited link
$opt_stylesheet = ''; # no default stylesheet
$opt_allowconfig = 0; # default to not allowing configuration
# General options
$opt_anonymous = 0; # Don't show address & copyright info on pages
$opt_debug = 0; # Debug flag (default off)
$opt_recurse = 0; # Recursivally apply webmagick (default off)
$opt_prune = 0; # Do Not recurse into subdirectories (off)
$opt_ignore = 0; # Do not webmagick this directory
# but still recurse into sub-directories
$opt_ignorefp = 1; # ignore _* special FrontPage directories (on)
$opt_indexinfo = 1; # Put "Index of files"
$opt_srcdir = '.'; # Source directory path (current directory)
$opt_verbose = 0; # Verbose flag (default off)
$opt_forcecache = 0; # Force update of cached thumbnails
$opt_forcelowres = 0; # Force update of cached low resolution images
$opt_forcehtml = 0; # Force HTML files to be generated (default off)
$opt_forcemontage = 0; # Force montage (default off)
$opt_forcegif = 0; # Force GIF imagemaps (default off)
$opt_forcejpeg = 0; # Force JPEG imagemaps (default off)
$opt_forcenouplink = 0; # Force there to be no uplink in directory index list
$opt_forceuplink = 0; # Force there to be an uplink in directory index list
# (i.e. even if we didn't generate ../index.html)
$opt_jpegquality = 70; # Quality for JPEG imagemaps
$opt_help = 0; # Display usage message
$opt_version = 0; # Display version info
$opt_htmlext = '.html'; # Use .shtml for SSI
$opt_header = '
'; # Imagemap extra page header (HTML)
$opt_footer = '
'; # Imagemap extra page footer (HTML)
$opt_javascript = 0; # Enable JavaScript output
$opt_readmevisible = 0; # Make README.html be first page.
$opt_title = ''; # Page title (blank provides default title)
$opt_tables = 0; # disable tables
$opt_tablebackcolor = '#000000'; # table background color
$opt_fancytables = 0; # use a fancier table for index pages
$opt_fancytableheight = 28; # the height of the fancy table border
$opt_tables_bottom = ''; # HTML after table contents
$opt_tables_params = 'WIDTH="90%"'; # table HTML parameters
$opt_tables_top = ''; # HTML before table contents
$opt_address = ''; # Additonal address info for bottom of
# imagemap page
$opt_centerfooter = 0; # Center the footer text
$opt_date = 1; # Output updates date
$opt_pichtml = 0; # Write separate HTML for each picture
$opt_pichtmlaltend = ''; # Some words to append to ALT
$opt_pichtmlaltstart = ''; # Some words to prepend to ALT
$opt_pichtmlbottom = '';
$opt_pichtmlext = '.html'; # Use .shtml for SSI
$opt_pichtmllink = ''; # Where to link pic
$opt_pichtmlnav = 0; # Write navigation into pic's HTML
$opt_pichtmlupfirst = 1; # Put up button before next/prev
$opt_edgelinksindex = 0; # End links link back to index
$opt_pichtmlputtitle = 1; # Write picture title
$opt_pichtmltitletop = 1; # Put picture title at top
$opt_pichtmltarget = '';
$opt_pichtmltitleend = ''; # End tags for picture title
$opt_pichtmltitlestart = '
'; # Start tags for picture title
$opt_pichtmltop = '
';
#
# ImageMagick Montage settings
#
$opt_maxgif = 30000; # Maximum GIF imagemap size before
# trying JPEG
$opt_columns = 6; # Max number of columns in montage grid
$opt_rows = 4; # Max number of rows in montage grid
$opt_mapnetscape = 0; # Map GIFs to Netscape 216-color cube
$opt_thumbtexture = 'false'; # Texture to tile onto the image background
$opt_thumbbackground = '#CCCCCC'; # Montage background color
$opt_thumbborderwidth = 0; # Thumbnail border width (pixels)
$opt_thumbframebgcolor = 'black'; # Inside of Frame color. Unused if no frame
$opt_thumbframecolor = '#CCCCCC'; # Color -- Frame Color
$opt_thumbtransparent = $opt_thumbbackground; # Color -- Image Transparency
$opt_thumbcompose = 'atop'; # Thumbnail image composition operation
$opt_thumbfont = 'courier'; # Label font
$opt_thumbforeground = 'black'; # Montage foreground color
$opt_thumbframe = 'false'; # Geometry of frame around thumbnail
# (default false)
$opt_thumbgeometry = '106x80+2+2>'; # Size of thumbnail images (width x height)
$opt_thumbgravity = 'Center'; # Direction thumbnail gravitates to
# (default Center)
$opt_thumblabel = '%f\n%wx%h\n%b'; # Default format for thumbnail text label
$opt_thumblabelwidth = 13; # Label width past which truncation occurs
$opt_thumbshadow = 'false'; # Enable decorative shadow under thumbnail
# (default disabled)
$opt_zoomfilter = 'Mitchell'; # Zoom (size reduction) filter
# (Box/Triangle/Mitchell)
#
# Hooks to add code to key places in WebMagick
#
$opt_thumbprehook = ''; # PerlMagick commands to execute on original
# prior reducing to thumbnail size
$opt_thumbposthook = ''; # PerlMagick commands to execute on image
# after reduction to thumbnail size
$opt_readfailhook = ''; # PERL commands to execute if reading image
# fails due to image corruption
#
# Caching related options
#
# Note: See below about sharing cache with 'xv'
# If caching is turned on, the montage grid will continue to be
# controlled by opt_thumbgeometry but the thumbnail size will be
# controlled by opt_cachegeom
$opt_cache = 1; # Cache thumbnails
$opt_cachedir = '.cache'; # Subdirectory to cache thumbnails in
$opt_cacheformat = 'JPEG'; # Format to use for thumbnails
$opt_cachegeom = $opt_thumbgeometry; # Thumbnail geometry
$opt_cachemin = 300*200; # Smallest image to cache in total pixels
# (width * height). Images smaller than
# this size will not be cached.
#PMF: I have added a low resolution of the pictures, by default 640x480
$opt_lowres = 1; # Cache low resolution images
$opt_lowresdir = '.640x480'; # Subdirectory to cache low resolution images in
$opt_lowresformat = 'JPEG'; # Format to use for low resolution images
$opt_lowresgeom = '640x480+2+2>'; # Size of low resolution images (width x height)
$opt_lowresmin = 640*480; # Smallest image to cache in total pixels
# (width * height). Images smaller than
# this size will not be cached.
# Uncomment these options to share cache with John Bradley's 'xv'
# (Visual Schnauzer format) NOTE: The 'xv' thumbnail format only
# supports 128 absolute colors so expect some montage thumbnail
# degradation when using 'xv' thumbnails.
#
#
# $opt_cacheformat = 'P7'; # 'xv's thumbnail format
# $opt_cachegeom = '80x60'; # 'xv's default thumbnail geometry is 80x60
# $opt_cachedir = '.xvpics'; # 'xv's thumbnail cache directory
# $opt_cachemin = 0; # Cache all thumbnails
#
# Uncomment remaining to obtain 'xv's Visual Schnauzer "look and feel"
#
# $opt_thumbgeometry = '92x72+2+2>';
# $opt_thumblabel = '%f';
# $opt_thumblabelwidth = 12;
# $opt_thumbgravity = 'South';
#
# Frame related options
#
$opt_frames = 1; # Use frames
$opt_framemarginwidth = 1; # Pixels allocated to frame margin in horizontal direction
$opt_framemarginheight = 1; # Pixels allocated to frame margin in vertical direction
$opt_frameborder = 1; # Enable (1) or disable (0) decorative frame borders
$opt_framestyle = 1; # Frame style to use (out of those available)
#
# Meta-tag defaults
#
$opt_metaauthor = ''; # Page author
$opt_metacharset = ''; # Page character set
$opt_metaclassification = ''; # Page classification
$opt_metadescription = ''; # Page description
$opt_metaexpires = ''; # Date page expires (e.g "Tue, 20 Aug 1996 14:25:27 GMT")
$opt_metakeywords = 'WebMagick'; # Key words
#
# Messages customization defaults
#
$opt_msg_copyright = 'Copyright ';
$opt_msg_date_format = '%B %e, %Y'; # See strftime(3)
$opt_msg_directories = 'Directories';
$opt_msg_directory_navigator = 'Directory Navigator';
$opt_msg_images = 'Images';
$opt_msg_index_of_directory = 'Index of directory';
$opt_msg_index_of_files = 'Index of files ';
$opt_msg_index_through = 'through';
$opt_msg_next = 'Next';
$opt_msg_pause = 'Pause';
$opt_msg_page_navigator = 'Page Navigator';
$opt_msg_page_updated_on = 'Page updated on';
$opt_msg_prev = 'Prev';
$opt_msg_produced_by = 'Produced by';
$opt_msg_readme = 'ReadMe';
$opt_msg_up = 'Up';
#
# Hash table of images used -- image size read internally by webmagick
#
# $opt_icons{'background'} = 'thumbs.jpg'; # Thumbnail frame background image
# $opt_icons{'dirbackground'} = 'dir.jpg'; # Directory frame background image
$opt_icons{'config'} = 'blue_c.gif'; # Configuration button
$opt_icons{'prev'} = 'blue_prev.gif'; # Previous
$opt_icons{'prev_gray'} = 'gray_prev.gif'; # Previous (grayed out)
$opt_icons{'next'} = 'blue_next.gif'; # Next
$opt_icons{'pause'} = 'blue_pause.gif'; # Next
$opt_icons{'next_gray'} = 'gray_next.gif'; # Next (grayed out)
$opt_icons{'up'} = 'blue_up.gif'; # Up
$opt_icons{'help'} = 'blue_readme.gif'; # Help Readme File
# $opt_icons{'ft_top'} = 'ft_top.gif'; # Fancy table top
# $opt_icons{'help'} = 'blue_help.gif'; # Help Alternative (Question)
# $opt_icons{'dir'} = 'blue_dir.gif'; # Directory List Icon (See below)
# $opt_icons{'ball'} = 'blue_ball.gif'; # A ball matching other icons
$opt_icons{'frame-style-1'} = 'frame-style-1.jpg';
$opt_icons{'frame-style-2'} = 'frame-style-2.jpg';
$opt_icons{'frame-style-3'} = 'frame-style-3.jpg';
$opt_icons{'frame-style-4'} = 'frame-style-4.jpg';
#
# WebMagickRcBottom -- Don't remove this line
#
# Format Templates
#
# WARNING: This is for expert web and perl programmers only do not
# modify unless you know what you are doing. To learn how frames work,
# read the pages under the URL
# http://home.netscape.com/assist/net_sites/frames.html
#
# Extra Images can be added to the above hash table and then used in
# the following format options. For example the 'dir' icon above can
# be uncommented then the following lines added below. WARNING: this
# is only useful if $opt_indexname is something else.
#
#
#
#
# Dir Listing
#
#
# Template for the Frame definition
# This allows adding frames, changing geometry, etc.
#
# Frame Target Names
$opt_frame_name_top="_top"; # Reload frames entirely
#$opt_frame_name_self="_self"; # Link to this (same) frame
#$opt_frame_name_parent="_parent"; # Link to parent frame
$opt_frame_name_dirview="dirview"; # Directory nav frame
$opt_frame_name_thumbview="thumbview"; # Imagemap (image selection) frame
$opt_frame_name_imageview="imageview"; # Image viewing frame (three frames)
#
# Simple two frame screen with directories listed in the left
# frame and imagemap/README displayed in the right frame.
#
# -------------
# | | |
# | | |
# | | |
# | | |
# | | |
# | | |
# -------------
$opt_framefmt{1}=
'
![\"\"](\"$iconImageUrls{dir}.gif\")
# Dir Listing