5 # A.k.a 'Best web-album Of the world, Or your money back, Humerus'.
7 # The acronyn sucks, however this is a tribute to Dragon Ball by
8 # Akira Toriyama, where the last enemy beaten by heroes of Dragon
9 # Ball is named "Boo". But there was already a free software project
10 # called Boo, so this one will be it "Booh". Or whatever.
13 # Copyright (c) 2005 Guillaume Cottenceau <gc3 at bluewin.ch>
15 # This software may be freely redistributed under the terms of the GNU
16 # public license version 2.
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 require 'rexml/document'
28 require 'booh/booh-lib'
29 require 'booh/html-merges'
31 #- bind text domain as soon as possible because some _() functions are called early to build data structures
32 bindtextdomain("booh")
36 [ '--help', '-h', GetoptLong::NO_ARGUMENT, _("Get help message") ],
37 [ '--version', '-V', GetoptLong::NO_ARGUMENT, _("Print version and exit") ],
39 [ '--source', '-s', GetoptLong::REQUIRED_ARGUMENT, _("Directory which contains original images/videos as files or subdirs") ],
40 [ '--destination', '-d', GetoptLong::REQUIRED_ARGUMENT, _("Directory which will contain the web-album") ],
41 # [ '--clean', '-c', GetoptLong::NO_ARGUMENT, _("Clean destination directory") ],
43 [ '--theme', '-t', GetoptLong::REQUIRED_ARGUMENT, _("Select HTML theme to use") ],
44 [ '--config', '-C', GetoptLong::REQUIRED_ARGUMENT, _("File containing config listing images and videos within directories with captions") ],
45 [ '--config-skel', '-k', GetoptLong::REQUIRED_ARGUMENT, _("Filename where the script will output a config skeleton") ],
46 [ '--merge-config', '-M', GetoptLong::REQUIRED_ARGUMENT, _("File containing config listing, where to merge new/removed images/videos from --source, and change theme info") ],
47 [ '--merge-config-onedir', '-O', GetoptLong::REQUIRED_ARGUMENT, _("File containing config listing, for merging the subdir specified with --dir") ],
48 [ '--merge-config-subdirs', '-U', GetoptLong::REQUIRED_ARGUMENT, _("File containing config listing, for merging the new subdirs down the subdir specified with --dir") ],
49 [ '--dir', '-D', GetoptLong::REQUIRED_ARGUMENT, _("Directory for merge with --merge-config-onedir or --merge-config-subdirs") ],
50 [ '--use-config', '-u', GetoptLong::REQUIRED_ARGUMENT, _("File containing config listing, where to change theme info") ],
51 [ '--force', '-f', GetoptLong::NO_ARGUMENT, _("Force generation of album even if the GUI marked some directories as already generated") ],
53 [ '--sizes', '-S', GetoptLong::REQUIRED_ARGUMENT, _("Specify the list of images sizes to use instead of all specified in the theme (this is a comma-separated list)") ],
54 [ '--thumbnails-per-row', '-T', GetoptLong::REQUIRED_ARGUMENT, _("Specify the amount of thumbnails per row in the thumbnails page (if applicable in theme)") ],
55 [ '--optimize-for-32', '-o', GetoptLong::NO_ARGUMENT, _("Resize images with optimized sizes for 3/2 aspect ratio rather than 4/3 (typical aspect ratio of pictures from non digital cameras are 3/2 when pictures from digital cameras are 4/3)") ],
56 [ '--index-link', '-l', GetoptLong::REQUIRED_ARGUMENT, _("Specify the HTML markup to use on the bottom of pages for a small link returning to wherever you see fit in your website (or somewhere else)") ],
57 [ '--made-with', '-n', GetoptLong::REQUIRED_ARGUMENT, _("Specify the HTML markup to use on the bottom of pages for a small 'made with' message") ],
58 [ '--comments-format','-c', GetoptLong::REQUIRED_ARGUMENT, _("Specify comments format to use for images instead of only filename when creating new albums; use ImageMagick's format") ],
60 [ '--mproc', '-m', GetoptLong::REQUIRED_ARGUMENT, _("Specify the number of processors for multi-processors machines") ],
62 [ '--for-gui', '-g', GetoptLong::NO_ARGUMENT, _("Do the minimum work to be able to see the album under the GUI (don't generate all thumbnails)") ],
64 [ '--verbose-level', '-v', GetoptLong::REQUIRED_ARGUMENT, _("Set max verbosity level (0: errors, 1: warnings, 2: important messages, 3: other messages)") ],
65 [ '--info-pipe', '-i', GetoptLong::REQUIRED_ARGUMENT, _("Name a file where to write information about what's going on (used by the GUI)") ],
68 #- default values for some globals
72 $ignore_videos = false
77 puts _("Usage: %s [OPTION]...") % File.basename($0)
79 printf " %3s, %-18s %s\n", ary[1], ary[0], ary[3]
84 parser = GetoptLong.new
85 parser.set_options(*$options.collect { |ary| ary[0..2] })
87 parser.each_option do |name, arg|
94 puts _("Booh version %s
96 Copyright (c) 2005 Guillaume Cottenceau.
97 This is free software; see the source for copying conditions. There is NO
98 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.") % $VERSION
103 $source = File.expand_path(arg.sub(%r|/$|, ''))
104 if !File.directory?($source)
105 die _("Argument to --source must be a directory")
108 $dest = File.expand_path(arg.sub(%r|/$|, ''))
109 if File.exists?($dest) && !File.directory?($dest)
110 die _("If --destination exists, it must be a directory")
112 if $dest != make_dest_filename($dest)
113 die _("Sorry, destination directory can't contain non simple alphanumeric characters.")
116 # system("rm -rf #{$dest}")
121 arg = File.expand_path(arg)
122 if File.readable?(arg)
123 $xmldoc = REXML::Document.new File.new(arg)
126 die _('Config file does not exist or is unreadable.')
129 arg = File.expand_path(arg)
131 if File.directory?(arg)
132 die _("Config skeleton file (%s) already exists and is a directory! Please change the filename.") % arg
134 msg 1, _("Config skeleton file already exists, backuping to %s.backup") % arg
135 File.rename(arg, "#{arg}.backup")
138 $config_writeto = arg
140 when '--merge-config'
141 arg = File.expand_path(arg)
142 if File.readable?(arg)
143 msg 2, _("Merge config notice: backuping current config file to %s.backup") % arg
144 $xmldoc = REXML::Document.new File.new(arg)
145 File.rename(arg, "#{arg}.backup")
146 $config_writeto = arg
147 $mode = 'merge_config'
149 die _('Config file does not exist or is unreadable.')
151 when '--merge-config-onedir'
152 arg = File.expand_path(arg)
153 if File.readable?(arg)
154 msg 2, _("Merge config notice: backuping current config file to %s.backup") % arg
155 $xmldoc = REXML::Document.new File.new(arg)
156 File.rename(arg, "#{arg}.backup")
157 $config_writeto = arg
158 $mode = 'merge_config_onedir'
160 die _('Config file does not exist or is unreadable.')
162 when '--merge-config-subdirs'
163 arg = File.expand_path(arg)
164 if File.readable?(arg)
165 msg 2, _("Merge config notice: backuping current config file to %s.backup") % arg
166 $xmldoc = REXML::Document.new File.new(arg)
167 File.rename(arg, "#{arg}.backup")
168 $config_writeto = arg
169 $mode = 'merge_config_subdirs'
171 die _('Config file does not exist or is unreadable.')
174 arg = File.expand_path(arg)
175 if !File.readable?(arg)
176 die _('Specified directory to merge with --dir is not readable')
181 arg = File.expand_path(arg)
182 if File.readable?(arg)
183 msg 2, _("Use config notice: backuping current config file to %s.backup") % arg
184 $xmldoc = REXML::Document.new File.new(arg)
185 File.rename(arg, "#{arg}.backup")
186 $config_writeto = arg
187 $mode = 'use_config_changetheme'
189 die _('Config file does not exist or is unreadable.')
195 when '--thumbnails-per-row'
198 when '--optimize-for-32'
199 $optimize_for_32 = true
207 when '--comments-format'
208 $commentsformat = arg
220 when '--verbose-level'
221 $verbose_level = arg.to_i
224 $info_pipe = File.open(arg, File::WRONLY)
225 $info_pipe.sync = true
234 if !$source && $xmldoc
235 $source = from_utf8($xmldoc.root.attributes['source']).sub(%r|/$|, '')
236 $dest = from_utf8($xmldoc.root.attributes['destination']).sub(%r|/$|, '')
237 $theme ||= $xmldoc.root.attributes['theme']
238 $limit_sizes ||= $xmldoc.root.attributes['limit-sizes']
239 if $mode == 'use_config' || $mode =~ /^merge_config/
240 $optimize_for_32 = !$xmldoc.root.attributes['optimize-for-32'].nil?
241 $N_per_row = $xmldoc.root.attributes['thumbnails-per-row']
242 $madewith = $xmldoc.root.attributes['made-with']
243 $indexlink = $xmldoc.root.attributes['index-link']
247 if $mode == 'merge_config_onedir' && !$onedir
248 die _("Missing --dir for --merge-config-onedir")
250 if $mode == 'merge_config_subdirs' && !$onedir
251 die _("Missing --dir for --merge-config-subdirs")
259 die _("Missing --destination parameter.")
265 select_theme($theme, $limit_sizes, $optimize_for_32, $N_per_row)
268 additional_params = ''
270 additional_params += "limit-sizes='#{$limit_sizes}'"
273 additional_params += " optimize-for-32='true'"
276 additional_params += " thumbnails-per-row='#{$N_per_row}'"
279 additional_params += " made-with='#{$madewith}'"
282 additional_params += " index-link='#{$indexlink}'"
284 $xmldoc = Document.new "<booh version='#{$VERSION}' source='#{utf8($source)}' destination='#{utf8($dest)}' theme='#{$theme}' #{additional_params}/>"
285 $xmldoc << XMLDecl.new(XMLDecl::DEFAULT_VERSION, $CURRENT_CHARSET)
289 if $mode == 'merge_config' || $mode == 'use_config_changetheme'
290 $xmldoc.root.add_attribute('theme', $theme)
291 $xmldoc.root.add_attribute('version', $VERSION)
293 $xmldoc.root.add_attribute('limit-sizes', $limit_sizes)
295 $xmldoc.root.delete_attribute('limit-sizes')
298 $xmldoc.root.add_attribute('optimize-for-32', 'true')
300 $xmldoc.root.delete_attribute('optimize-for-32')
303 $xmldoc.root.add_attribute('thumbnails-per-row', $N_per_row)
305 $xmldoc.root.delete_attribute('thumbnails-per-row')
308 $xmldoc.root.add_attribute('made-with', $madewith)
310 $xmldoc.root.delete_attribute('made-with')
313 $xmldoc.root.add_attribute('index-link', $indexlink)
315 $xmldoc.root.delete_attribute('index-link')
320 $madewith = $madewith.gsub('%booh', '"http://zarb.org/~gc/html/booh.html"')
333 $info_pipe.puts(value)
339 $info_pipe.puts("die: " + value)
344 def check_installation
345 if !system("which convert >/dev/null 2>/dev/null")
346 die _("The program 'convert' is needed. Please install it.
347 It is generally available with the 'ImageMagick' software package.")
349 if !system("which identify >/dev/null 2>/dev/null")
350 msg 1, _("the program 'identify' is needed to get images sizes and EXIF data. Please install it.
351 It is generally available with the 'ImageMagick' software package.")
354 missing = %w(transcode mencoder).delete_if { |prg| system("which #{prg} >/dev/null 2>/dev/null") }
356 msg 1, _("the following program(s) are needed to handle videos: '%s'. Videos will be ignored.") % missing.join(', ')
357 $ignore_videos = true
361 def replace_line(surround, keyword, line)
363 contents = eval "$#{keyword}"
364 line.sub!(/#{surround}#{keyword}#{surround}/, contents)
366 die _("No '%s' found for substitution") % keyword
370 def build_html_skeletons
371 $html_images = File.open("#{$FPATH}/themes/#{$theme}/skeleton_image.html").readlines
372 $html_thumbnails = File.open("#{$FPATH}/themes/#{$theme}/skeleton_thumbnails.html").readlines
373 $html_index = File.open("#{$FPATH}/themes/#{$theme}/skeleton_index.html").readlines
374 for line in $html_images + $html_thumbnails + $html_index
375 while line =~ /~~~(\w+)~~~/
376 replace_line('~~~', $1, line)
381 def find_caption_value(xmldir, filename)
382 if cap = xmldir.elements["*[@filename='#{utf8(filename)}']"].attributes['caption']
383 return cap.gsub("\n", '<br/>')
389 def find_captions(xmldir, images)
390 return images.collect { |img| find_caption_value(xmldir, img) }
393 #- stolen from CVSspam
395 text.sub(/[^a-zA-Z0-9\-,.*_\/]/) do
396 "%#{sprintf('%2X', $&[0])}"
401 return $limit_sizes =~ /original/ ? $images_size + [ { 'name' => 'original' } ] : $images_size
404 def html_reload_to_thumbnails
405 html_reload_to_thumbnails = $preferred_size_reloader.clone
406 html_reload_to_thumbnails.gsub!(/~~theme~~/, $theme)
407 html_reload_to_thumbnails.gsub!(/~~default_size~~/, $default_size['name'])
408 html_reload_to_thumbnails.gsub!(/~~all_sizes~~/, all_images_sizes.collect { |s| "\"#{size2js(s['name'])}\"" }.join(', '))
409 size_auto_chooser = '';
410 all_images_sizes.sort { |a,b| b['optimizedforwidth'].to_i <=> a['optimizedforwidth'].to_i }.
411 each { |s| size_auto_chooser += "if (w + 50 > #{s['optimizedforwidth']}) { return 'thumbnails-#{size2js(s['name'])}.html'; }\n" }
412 html_reload_to_thumbnails.gsub!(/~~size_auto_chooser~~/, size_auto_chooser)
413 return html_reload_to_thumbnails
416 def discover_iterations(iterations, line)
417 if line =~ /~~iterate(\d)_open(_max(\d+|N))?~~/
418 for iter in iterations.values
421 iter['close_wait'] = $1.to_i
424 max = $3 == 'N' ? ($N_per_row || $default_N) : $3
425 iterations[$1.to_i] = { 'open' => true, 'max' => max, 'opening' => '', 'closing' => '' }
427 line.sub!(/.*/, '~~thumbnails~~')
431 elsif line =~ /~~iterate(\d)_close~~/
432 iterations[$1.to_i]['open'] = false;
433 iterations[$1.to_i]['close'] = true;
436 for iter in iterations.values
438 iter['opening'] += line
441 if !iter['close'] && iter['close_wait'] && iterations[iter['close_wait']]['close']
442 iter['closing'] += line
449 def reset_iterations(iterations)
450 for iter in iterations.values
455 def run_iterations(iterations, amount)
458 for level in iterations.keys.sort
459 if iterations[level]['value'] == 0
460 html += iterations[level]['opening']
461 elsif level == iterations.keys.max
462 if !iterations[level]['max'] || iterations[level]['max'] && iterations[level]['value'] + amount <= iterations[level]['max'].to_i
463 html += iterations[level]['opening']
468 iterations[level]['value'] += amount
469 if iterations[level]['max'] && iterations[level]['value'] > iterations[level]['max'].to_i
470 iterations[level]['value'] = 0
471 iterations[level-1]['value'] = 0
472 html += iterations[level-1]['closing']
476 return html + run_iterations(iterations, amount)
482 def close_iterations(iterations)
484 for level in iterations.keys.sort.reverse
485 html += iterations[level]['closing']
490 def img_element(fullpath)
491 if size = get_image_size(fullpath)
492 sizespec = 'width="' + size[:x].to_s + '" height="' + size[:y].to_s + '"'
496 return '<img src="' + File.basename(fullpath) + '" ' + sizespec + ' alt="image"/>'
500 return name.gsub(/-/, '')
503 def substitute_html_sizes(html, sizeobj, type)
505 if $images_size.length > 1 || (type == 'image' && $limit_sizes =~ /original/)
506 for sizeobj2 in $images_size
507 if sizeobj != sizeobj2
508 if type == 'thumbnails'
509 sizestrings << '<a href="thumbnails-' + size2js(sizeobj2['name']) + '.html">' + sizename(sizeobj2['name']) + '</a>'
511 sizestrings << '<a id="link' + size2js(sizeobj2['name']) + '">' + sizename(sizeobj2['name']) + '</a>'
514 sizestrings << sizename(sizeobj2['name'])
517 if type == 'image' && $limit_sizes =~ /original/
518 sizestrings << '<a id="linkoriginal" target="newframe">' + sizename('original') + '</a>'
521 html.sub!(/~~sizes~~(.+)~~/) { sizestrings.join($1) }
524 def xmldir2destdir(xmldir)
525 return make_dest_filename(from_utf8(File.basename(xmldir.attributes['path'])))
528 def find_previous_album(xmldir)
531 #- move to previous dir element if exists
532 if prevelem = xmldir.previous_element_byname_notattr('dir', 'deleted')
534 relative_pos += '../' + xmldir2destdir(xmldir) + '/'
536 #- after having moved to previous dir, we need to go down last subdir until the last one
537 while child = xmldir.elements['dir']
538 while nextchild = child.next_element_byname_notattr('dir', 'deleted')
541 relative_pos += xmldir2destdir(child) + '/'
545 #- previous dir doesn't exist, move to previous dir element if exists
546 xmldir = xmldir.parent
547 if xmldir.name == 'dir' && !xmldir.attributes['deleted']
548 relative_pos += '../'
553 end while !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
554 return File.reduce_path(relative_pos)
557 def find_next_album(xmldir)
560 #- first child dir element (catches when initial xmldir has both thumbnails and subdirs)
561 if firstchild = xmldir.child_byname_notattr('dir', 'deleted')
563 relative_pos += xmldir2destdir(xmldir) + '/'
565 elsif nextbro = xmldir.next_element_byname_notattr('dir', 'deleted')
567 relative_pos += '../' + xmldir2destdir(xmldir) + '/'
569 #- go up until we have a next brother or we are finished
571 xmldir = xmldir.parent
572 relative_pos += '../'
573 end while xmldir && !xmldir.next_element_byname_notattr('dir', 'deleted')
575 xmldir = xmldir.next_element_byname('dir')
576 relative_pos += '../' + xmldir2destdir(xmldir) + '/'
581 end while !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
582 return File.reduce_path(relative_pos)
585 def sub_previous_next_album(previous_album, next_album, html)
587 html.gsub!(/~~previous_album~~/, '<a href="' + previous_album + 'thumbnails.html">' + utf8(_('previous album')) + '</a>')
588 html.gsub!(/~~ifprevious_album\?~~(.+?)~~fi~~/) { $1 }
590 html.gsub!(/~~previous_album~~/, '')
591 html.gsub!(/~~ifprevious_album\?~~(.+?)~~fi~~/, '')
594 html.gsub!(/~~next_album~~/, '<a href="' + next_album + 'thumbnails.html">' + utf8(_('next album')) + '</a>')
595 html.gsub!(/~~ifnext_album\?~~(.+?)~~fi~~/) { $1 }
597 html.gsub!(/~~next_album~~/, '')
598 html.gsub!(/~~ifnext_album\?~~(.+?)~~fi~~/, '')
605 #- preprocess the path->dir, rexml is very slow with that; we seem to improve speed by 7%
607 $xmldoc.elements.each('//dir') { |elem|
608 optxpath[elem.attributes['path']] = elem
612 if $mode == 'merge_config_onedir'
613 examined_dirs = [ $onedir ]
614 elsif $mode == 'merge_config_subdirs'
615 examined_dirs = `find '#{$onedir}' -type d -follow`.sort.collect { |v| v.chomp }.delete_if { |v| optxpath.has_key?(utf8(v)) }
617 examined_dirs = `find '#{$source}' -type d -follow`.sort.collect { |v| v.chomp }
618 if $mode == 'merge_config'
619 $xmldoc.elements.each('//dir') { |elem|
620 if ! examined_dirs.include?(elem.attributes['path'])
621 msg 2, _("Merging config: removing directory %s from config, isn't on filesystem anymore") % elem.attributes['path']
627 info("directories: #{examined_dirs.length}, sizes: #{$images_size.length}")
629 examined_dirs.each { |dir|
631 die _("Source directory or sub-directories can't contain a single-quote character, sorry: %s") % dir
633 if $mode !~ /^use_config/
634 Dir.entries(dir).each { |file|
635 if file =~ /['"\[\]]/
636 die _("Files can't contain any of the characters ', \", [ or ], sorry: %s") % "#{dir}/#{file}"
642 examined_dirs.each { |dir|
643 if File.basename(dir) =~ /^\./
644 msg 1, _("Ignoring directory %s, begins with a dot (indicating a hidden directory)") % dir
648 dest_dir = make_dest_filename(dir.sub(/^#{Regexp.quote($source)}/, $dest))
650 #- place xml document on proper node if exists, else create
651 xmldir = optxpath[utf8(dir)]
652 if $mode == 'use_config' || $mode == 'use_config_changetheme'
653 if !xmldir || (xmldir.attributes['already-generated'] && !$force) || xmldir.attributes['deleted']
654 info("walking: #{dir}|#{$source}, 0 elements")
655 if xmldir && xmldir.attributes['deleted']
656 system("rm -rf '#{dest_dir}'")
661 if $mode == 'gen_config' || (($mode == 'merge_config' || $mode == 'merge_config_subdirs') && !xmldir)
662 #- add the <dir..> element if necessary
663 parent = File.dirname(dir)
664 xmldir = $xmldoc.elements["//dir[@path='#{utf8(parent)}']"]
666 xmldir = $xmldoc.root
668 #- need to remove the already-generated mark of the parent because of the sub-albums page containing now one more element
669 xmldir.delete_attribute('already-generated')
670 xmldir = optxpath[utf8(dir)] = xmldir.add_element('dir', { 'path' => utf8(dir) })
673 xmldir.delete_attribute('already-generated')
675 #- read images/videos entries from config or from directories depending on mode
677 if $mode == 'use_config' || $mode == 'use_config_changetheme'
678 msg 2, _("Handling %s from config list...") % dir
679 xmldir.elements.each { |element|
680 if %w(image video).include?(element.name) && !element.attributes['deleted']
681 entries << from_utf8(element.attributes['filename'])
685 msg 2, _("Examining %s...") % dir
686 entries = Dir.entries(dir).sort
687 #- populate config in case of gen_config, add new files in case of merge_config
689 if file =~ /['"\[\]]/
690 msg 1, _("Ignoring %s, contains one of forbidden characters: '\"[]") % "#{dir}/#{file}"
692 type = entry2type(file)
693 if type && !xmldir.elements["#{type}[@filename='#{utf8(file)}']"]
694 if $commentsformat && type == 'image'
695 comment = utf8(`identify -format "#{$commentsformat}" '#{dir}/#{file}'`.chomp.sub(/\.$/, ''))
697 comment = utf8cut(file.sub(/\.[^\.]+$/, ''), 18)
699 xmldir.add_element type, { "filename" => utf8(file), "caption" => comment }
703 if $mode != 'gen_config'
704 #- cleanup removed files from config and reread entries from config to get proper ordering
706 xmldir.elements.each { |element|
707 fullpath = "#{dir}/#{from_utf8(element.attributes['filename'])}"
708 if %w(image video).include?(element.name)
709 if !File.readable?(fullpath)
710 msg 1, _("Config merge: removing %s from config; use the backup file to retrieve caption info if this was a mistake") % fullpath
711 xmldir.delete(element)
712 elsif !element.attributes['deleted']
713 entries << from_utf8(element.attributes['filename'])
717 #- if there is no more elements here, there is no album here anymore
718 if !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
719 xmldir.delete_attribute('thumbnails-caption')
720 xmldir.delete_attribute('thumbnails-captionfile')
724 images = entries.find_all { |e| entry2type(e) == 'image' }
725 msg 3, _("\t%s images") % images.length
726 videos = entries.find_all { |e| entry2type(e) == 'video' }
727 msg 3, _("\t%s videos") % videos.length
728 info("walking: #{dir}|#{$source}, #{images.length + videos.length} elements")
730 system("mkdir -p '#{dest_dir}'")
732 #- generate .htaccess file
734 ios = File.open("#{dest_dir}/.htaccess", "w")
735 ios.write("AddCharset UTF-8 .html\n")
736 if auth_user_file = xmldir.attributes['password-protect']
737 msg 3, _("\tgenerating password protection file #{dest_dir}/.htaccess")
738 ios.write("AuthType Basic\nAuthName \"protected area\"\nAuthUserFile #{auth_user_file}\nrequire valid-user\n")
743 #- pass through if there are no images and videos
744 if images.size == 0 && videos.size == 0
746 #- cleanup old images/videos, especially if this directory contained images/videos previously.
747 themestuff = Dir.entries("#{$FPATH}/themes/#{$theme}").
748 find_all { |e| !%w(. .. skeleton_image.html skeleton_thumbnails.html skeleton_index.html metadata CVS).include?(e) }
749 if $mode != 'gen_config'
750 rightful_images = [ '.htaccess' ]
751 if xmldir.attributes['thumbnails-caption']
752 rightful_images << 'thumbnails-thumbnail.jpg'
754 xmldir.elements.each('dir') { |child|
755 if child.attributes['deleted']
758 subdir = make_dest_filename(from_utf8(File.basename(child.attributes['path'])))
759 rightful_images << "thumbnails-#{subdir}.jpg"
761 to_del = Dir.entries(dest_dir).find_all { |e| !File.directory?("#{dest_dir}/#{e}") && !rightful_images.include?(e) } - themestuff
763 system("rm -f " + to_del.collect { |e| "'#{dest_dir}/#{e}'" }.join(' '))
767 #- copy any resource file that goes with the theme (css, images..)
768 themestuff.each { |entry|
769 if !File.exists?("#{dest_dir}/#{entry}")
770 psys("cp '#{$FPATH}/themes/#{$theme}/#{entry}' '#{dest_dir}'")
777 msg 2, _("Outputting in %s...") % dest_dir
779 #- populate data structure with sizes from theme
780 for sizeobj in $images_size
781 fullscreen_images ||= {}
782 fullscreen_images[sizeobj['name']] = []
783 thumbnail_images ||= {}
784 thumbnail_images[sizeobj['name']] = []
785 thumbnail_videos ||= {}
786 thumbnail_videos[sizeobj['name']] = []
788 #- a special dummy size to keep 'references' to thumbnails in case of panorama, because the GUI will use the regular thumbnails
789 thumbnail_images['dont-delete-file-for-gui'] = []
790 if $limit_sizes =~ /original/
791 fullscreen_images['original'] = []
794 images.size >= 1 and msg 3, _("\tcreating images thumbnails...")
796 #- create thumbnails for images
798 info("processing element")
799 base_dest_img = dest_dir + '/' + make_dest_filename(img.sub(/\.[^\.]+$/, ''))
801 thumbnail_dest_img = base_dest_img + "-#{$default_size['thumbnails']}.jpg"
802 gen_thumbnails_element("#{dir}/#{img}", xmldir, true, [ { 'filename' => thumbnail_dest_img, 'size' => $default_size['thumbnails'] } ])
805 elem = xmldir.elements["image[@filename='#{utf8(img)}']"]
806 for sizeobj in $images_size
807 size_fullscreen = sizeobj['fullscreen']
808 size_thumbnails = sizeobj['thumbnails']
809 fullscreen_dest_img = base_dest_img + "-#{size_fullscreen}.jpg"
810 fullscreen_images[sizeobj['name']] << File.basename(fullscreen_dest_img)
811 todo << { 'filename' => fullscreen_dest_img, 'size' => size_fullscreen }
812 if pano = pano_amount(elem)
813 thumbnail_images['dont-delete-file-for-gui'] << File.basename(base_dest_img + "-#{size_thumbnails}.jpg")
814 size_thumbnails = size_thumbnails.sub(/(\d+)/) { ($1.to_i * pano).to_i }
816 thumbnail_dest_img = base_dest_img + "-#{size_thumbnails}.jpg"
817 thumbnail_images[sizeobj['name']] << File.basename(thumbnail_dest_img)
818 todo << { 'filename' => thumbnail_dest_img, 'size' => size_thumbnails }
820 gen_thumbnails_element("#{dir}/#{img}", xmldir, true, todo)
821 if $limit_sizes =~ /original/
822 fullscreen_images['original'] << img
824 destimg = "#{dest_dir}/#{img}"
825 if $limit_sizes =~ /original/ && !File.exists?(destimg)
827 if ! sys("ln '#{dir}/#{img}' '#{destimg}'")
828 $hardlinks_ok = false
832 psys("cp '#{dir}/#{img}' '#{destimg}'")
838 videos.size >= 1 and msg 3, _("\tcreating videos thumbnails...")
840 #- create thumbnails for videos
841 videos.each { |video|
842 info("processing element")
844 thumbnail_dest_img = dest_dir + '/' + make_dest_filename(video.sub(/\.[^\.]+$/, '')) + "-#{$default_size['thumbnails']}.jpg"
845 gen_thumbnails_element("#{dir}/#{video}", xmldir, true, [ { 'filename' => thumbnail_dest_img, 'size' => $default_size['thumbnails'] } ])
848 for sizeobj in $images_size
849 size_thumbnails = sizeobj['thumbnails']
850 thumbnail_dest_img = dest_dir + '/' + make_dest_filename(video.sub(/\.[^\.]+$/, '')) + "-#{size_thumbnails}.jpg"
851 thumbnail_videos[sizeobj['name']] << File.basename(thumbnail_dest_img)
852 todo << { 'filename' => thumbnail_dest_img, 'size' => size_thumbnails }
854 gen_thumbnails_element("#{dir}/#{video}", xmldir, true, todo)
856 destvideo = "#{dest_dir}/#{video}"
857 if !File.exists?(destvideo)
859 if ! sys("ln '#{dir}/#{video}' '#{destvideo}'")
860 $hardlinks_ok = false
864 psys("cp '#{dir}/#{video}' '#{destvideo}'")
870 themestuff = Dir.entries("#{$FPATH}/themes/#{$theme}").
871 find_all { |e| !%w(. .. skeleton_image.html skeleton_thumbnails.html skeleton_index.html metadata CVS).include?(e) }
873 #- cleanup old images/videos (for when removing elements or sizes)
874 all_elements = fullscreen_images.collect { |e| e[1] }.flatten.
875 concat(thumbnail_images.collect { |e| e[1] }.flatten).
876 concat(thumbnail_videos.collect { |e| e[1] }.flatten).
879 to_del = Dir.entries(dest_dir).find_all { |e| !File.directory?("#{dest_dir}/#{e}") && !all_elements.include?(e) && e !~ /^thumbnails-\w+\.jpg/ } - themestuff
881 msg 3, _("\tcleaning up: #{to_del.join(', ')}")
882 system("rm -f " + to_del.collect { |e| "#{dest_dir}/#{e}" }.join(' '))
885 #- copy any resource file that goes with the theme (css, images..)
886 themestuff.each { |entry|
887 if !File.exists?("#{dest_dir}/#{entry}")
888 psys("cp '#{$FPATH}/themes/#{$theme}/#{entry}' '#{dest_dir}'")
892 msg 3, _("\tgenerating HTML pages...")
894 #- generate thumbnails.html (page with thumbnails)
895 for sizeobj in $images_size
896 info("processing size")
897 html = $html_thumbnails.collect { |l| l.clone }
900 i.sub!(/~~run_slideshow~~/, images.size <= 1 ? '' : '<a href="image-' + size2js(sizeobj['name']) + '.html#run_slideshow=1">' + utf8(_('Run slideshow!'))+'</a>')
901 i.sub!(/~~title~~/, xmldir.attributes['thumbnails-caption'] || utf8(File.basename(dir)))
902 substitute_html_sizes(i, sizeobj, 'thumbnails')
903 discover_iterations(iterations, i)
906 reset_iterations(iterations)
908 type = images.include?(file) ? 'image' : videos.include?(file) ? 'video' : nil
910 if type == 'image' && elem = xmldir.elements["image[@filename='#{utf8(file)}']"]
911 if pano = pano_amount(elem)
912 html_thumbnails += run_iterations(iterations, pano)
913 html_thumbnails.gsub!(/~~colspan~~/) { 'colspan="' + pano.ceil.to_s + '"' }
915 html_thumbnails += run_iterations(iterations, 1)
916 html_thumbnails.gsub!(/~~colspan~~/, '')
919 html_thumbnails += run_iterations(iterations, 1)
920 html_thumbnails.gsub!(/~~colspan~~/, '')
923 index = images.index(file)
924 html_thumbnails.gsub!(/~~image_iteration~~/,
925 '<a href="image-' + size2js(sizeobj['name']) + '.html#current=' + fullscreen_images[sizeobj['name']][index] +
926 '" name="' + fullscreen_images[sizeobj['name']][index] + '">' +
927 img_element("#{dest_dir}/#{thumbnail_images[sizeobj['name']][index]}") + '</a>')
928 html_thumbnails.gsub!(/~~caption_iteration~~/,
929 find_caption_value(xmldir, images[index]) || utf8(images[index]))
930 html_thumbnails.gsub!(/~~ifimage\?~~(.+?)~~fi~~/) { $1 }
931 html_thumbnails.gsub!(/~~ifvideo\?~~(.+?)~~fi~~/, '')
932 elsif type == 'video'
933 index = videos.index(file)
934 if File.exists?("#{dest_dir}/#{thumbnail_videos[sizeobj['name']][index]}")
935 html_thumbnails.gsub!(/~~image_iteration~~/,
936 '<a href="' + videos[index] + '">' + img_element("#{dest_dir}/#{thumbnail_videos[sizeobj['name']][index]}") + '</a>')
938 html_thumbnails.gsub!(/~~image_iteration~~/,
939 '<a href="' + videos[index] + '">' + utf8(_("(no preview)")) + '</a>')
941 html_thumbnails.gsub!(/~~caption_iteration~~/,
942 find_caption_value(xmldir, videos[index]) || utf8(videos[index]))
943 html_thumbnails.gsub!(/~~ifimage\?~~(.+?)~~fi~~/, '')
944 html_thumbnails.gsub!(/~~ifvideo\?~~(.+?)~~fi~~/) { $1 }
948 html_thumbnails += close_iterations(iterations)
950 i.sub!(/~~thumbnails~~/, html_thumbnails)
951 i.gsub!(/~~theme~~/, $theme)
952 i.gsub!(/~~current_size~~/, sizeobj['name'])
953 i.gsub!(/~~current_size_js~~/, size2js(sizeobj['name']))
954 i.gsub!(/~~madewith~~/, $madewith || '')
955 i.gsub!(/~~indexlink~~/, $indexlink || '')
957 ios = File.open("#{dest_dir}/thumbnails-#{size2js(sizeobj['name'])}.html", "w")
962 info("finished processing sizes")
964 #- generate "main" thumbnails.html page that will reload to correct size thanks to cookie
965 ios = File.open("#{dest_dir}/thumbnails.html", "w")
966 ios.write(html_reload_to_thumbnails)
969 #- generate image.html (page with fullscreen images)
971 captions4js = find_captions(xmldir, images).collect { |e| e ? '"' + e.gsub('"', '\"') + '"' : '""' }.join(', ')
973 for sizeobj in $images_size
974 html = $html_images.collect { |l| l.clone }
975 images4js = fullscreen_images[sizeobj['name']].collect { |e| "\"#{e}\"" }.join(', ')
978 for sizeobj2 in all_images_sizes
979 if sizeobj != sizeobj2
980 otherimages4js += "var images_#{size2js(sizeobj2['name'])} = new Array(" + fullscreen_images[sizeobj2['name']].collect { |e| "\"#{e}\"" }.join(', ') + ")\n"
981 othersizes << "\"#{size2js(sizeobj2['name'])}\""
985 i.gsub!(/~~images~~/, images4js)
986 i.gsub!(/~~other_images~~/, otherimages4js)
987 i.gsub!(/~~other_sizes~~/, othersizes.join(', '))
988 i.gsub!(/~~captions~~/, captions4js)
989 i.gsub!(/~~title~~/, xmldir.attributes['thumbnails-caption'] || utf8(File.basename(dir)))
990 i.gsub!(/~~thumbnails~~/, '<a href="thumbnails-' + size2js(sizeobj['name']) + '.html" id="thumbnails">' + utf8(_('return to thumbnails')) + '</a>')
991 i.gsub!(/~~theme~~/, $theme)
992 i.gsub!(/~~current_size~~/, size2js(sizeobj['name']))
993 i.gsub!(/~~madewith~~/, $madewith || '')
994 i.gsub!(/~~indexlink~~/, $indexlink || '')
995 substitute_html_sizes(i, sizeobj, 'image')
997 ios = File.open("#{dest_dir}/image-#{size2js(sizeobj['name'])}.html", "w")
1007 #- add attributes to <dir..> elements needing so
1008 if $mode != 'use_config'
1009 msg 3, _("\tfixating configuration file...")
1010 $xmldoc.elements.each('//dir') { |element|
1011 path = captionpath = element.attributes['path']
1012 descendant_element = element.elements['descendant::image'] || element.elements['descendant::video']
1013 if !descendant_element
1014 msg 3, _("\t\tremoving %s, no element in it") % path
1015 element.remove #- means we have a directory with nothing interesting in it
1017 captionfile = "#{descendant_element.parent.attributes['path']}/#{descendant_element.attributes['filename']}"
1018 basename = File.basename(path)
1019 if element.elements['dir']
1020 if !element.attributes['subdirs-caption']
1021 element.add_attribute('subdirs-caption', basename)
1023 if !element.attributes['subdirs-captionfile']
1024 element.add_attribute('subdirs-captionfile', captionfile)
1027 if element.child_byname_notattr('image', 'deleted') || element.child_byname_notattr('video', 'deleted')
1028 if !element.attributes['thumbnails-caption']
1029 element.add_attribute('thumbnails-caption', basename)
1031 if !element.attributes['thumbnails-captionfile']
1032 element.add_attribute('thumbnails-captionfile', captionfile)
1039 #- write down to disk config if necessary
1041 ios = File.open($config_writeto, "w")
1042 $xmldoc.write(ios, 0)
1047 msg 3, _(" completed necessary stuff for GUI, exiting.")
1051 #- second pass to create index.html files and previous/next links
1052 info("creating index.html")
1053 msg 3, _("\trescanning directories to generate all 'index.html' files...")
1055 #- recompute the memoization because elements mights have been removed (the ones with no element in them)
1057 $xmldoc.elements.each('//dir') { |elem|
1058 optxpath[elem.attributes['path']] = elem
1061 examined_dirs.each { |dir|
1062 info("index.html: #{dir}|#{$source}")
1064 xmldir = optxpath[utf8(dir)]
1065 if !xmldir || (xmldir.attributes['already-generated'] && !$force) || xmldir.attributes['deleted']
1068 dest_dir = make_dest_filename(dir.sub(/^#{Regexp.quote($source)}/, $dest))
1070 previous_album = find_previous_album(xmldir)
1071 next_album = find_next_album(xmldir)
1073 if xmldir.elements['dir']
1074 html = $html_index.collect { |l| l.clone }
1077 caption = xmldir.attributes['subdirs-caption']
1078 i.gsub!(/~~title~~/, caption)
1079 if xmldir.parent.name == 'dir'
1082 parent = xmldir.parent
1083 while parent.name == 'dir'
1084 parentcaption = parent.attributes['subdirs-caption']
1085 nav = "<a href='#{path}/index.html'>#{parentcaption}</a> #{utf8(_(" > "))} #{nav}"
1087 parent = parent.parent
1089 i.gsub!(/~~ifnavigation\?~~(.+?)~~fi~~/) { $1 }
1090 i.gsub!(/~~navigation~~/, nav + caption)
1092 i.gsub!(/~~ifnavigation\?~~(.+?)~~fi~~/, '')
1094 discover_iterations(iterations, i)
1098 reset_iterations(iterations)
1100 #- deal with "current" album (directs to "thumbnails" page)
1101 if xmldir.attributes['thumbnails-caption']
1102 thumbnail = "#{dest_dir}/thumbnails-thumbnail.jpg"
1103 gen_thumbnails_subdir(from_utf8(xmldir.attributes['thumbnails-captionfile']), xmldir, false,
1104 [ { 'filename' => thumbnail, 'size' => $albums_thumbnail_size } ], 'thumbnails')
1105 html_index += run_iterations(iterations, 1)
1106 html_index.gsub!(/~~image_iteration~~/, "<a href='thumbnails.html'>" + img_element(thumbnail) + '</a>')
1107 html_index.gsub!(/~~caption_iteration~~/, xmldir.attributes['thumbnails-caption'])
1110 #- deal with sub-albums (direct to subdirs/index.html pages)
1111 xmldir.elements.each('dir') { |child|
1112 if child.attributes['deleted']
1115 subdir = make_dest_filename(from_utf8(File.basename(child.attributes['path'])))
1116 thumbnail = "#{dest_dir}/thumbnails-#{subdir}.jpg"
1117 html_index += run_iterations(iterations, 1)
1118 captionfile, caption = find_subalbum_caption_info(child)
1119 gen_thumbnails_subdir(captionfile, child, false,
1120 [ { 'filename' => thumbnail, 'size' => $albums_thumbnail_size } ], find_subalbum_info_type(child))
1121 html_index.gsub!(/~~caption_iteration~~/, caption)
1122 html_index.gsub!(/~~image_iteration~~/, "<a href='#{make_dest_filename(subdir)}/index.html'>" + img_element(thumbnail) + '</a>')
1125 html_index += close_iterations(iterations)
1128 i.gsub!(/~~thumbnails~~/, html_index)
1129 i.gsub!(/~~madewith~~/, $madewith || '')
1130 i.gsub!(/~~indexlink~~/, $indexlink || '')
1134 html = html_reload_to_thumbnails
1137 ios = File.open("#{dest_dir}/index.html", "w")
1141 #- substitute "return to albums" and previous/next correctly
1142 if xmldir.child_byname_notattr('image', 'deleted') || xmldir.child_byname_notattr('video', 'deleted')
1143 for sizeobj in $images_size
1144 substInFile("#{dest_dir}/thumbnails-#{size2js(sizeobj['name'])}.html") { |line|
1145 sub_previous_next_album(previous_album, next_album, line)
1146 if xmldir.elements['dir']
1147 line.sub!(/~~return_to_albums~~/, '<a href="index.html">' + utf8(_('return to albums')) + '</a>')
1149 if xmldir.parent.name == 'dir'
1150 line.sub!(/~~return_to_albums~~/, '<a href="../index.html">' + utf8(_('return to albums')) + '</a>')
1152 line.sub!(/~~return_to_albums~~/, '')
1157 if xmldir.child_byname_notattr('image', 'deleted')
1158 substInFile("#{dest_dir}/image-#{size2js(sizeobj['name'])}.html") { |line|
1159 sub_previous_next_album(previous_album, next_album, line)
1166 msg 3, _(" all done.")
1173 build_html_skeletons