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 [ '--made-with', '-n', GetoptLong::REQUIRED_ARGUMENT, _("Specify the HTML markup to use on the bottom of pages") ],
57 [ '--empty-comments','-e', GetoptLong::NO_ARGUMENT, _("Prefer empty comments over filename when creating new albums") ],
59 [ '--mproc', '-m', GetoptLong::REQUIRED_ARGUMENT, _("Specify the number of processors for multi-processors machines") ],
61 [ '--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)") ],
63 [ '--verbose-level', '-v', GetoptLong::REQUIRED_ARGUMENT, _("Set max verbosity level (0: errors, 1: warnings, 2: important messages, 3: other messages)") ],
64 [ '--info-pipe', '-i', GetoptLong::REQUIRED_ARGUMENT, _("Name a file where to write information about what's going on (used by the GUI)") ],
67 #- default values for some globals
71 $ignore_videos = false
76 puts _("Usage: %s [OPTION]...") % File.basename($0)
78 printf " %3s, %-18s %s\n", ary[1], ary[0], ary[3]
83 parser = GetoptLong.new
84 parser.set_options(*$options.collect { |ary| ary[0..2] })
86 parser.each_option do |name, arg|
93 puts _("Booh version %s
95 Copyright (c) 2005 Guillaume Cottenceau.
96 This is free software; see the source for copying conditions. There is NO
97 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.") % $VERSION
102 $source = File.expand_path(arg.sub(%r|/$|, ''))
103 if !File.directory?($source)
104 die _("Argument to --source must be a directory")
107 $dest = File.expand_path(arg.sub(%r|/$|, ''))
108 if File.exists?($dest) && !File.directory?($dest)
109 die _("If --destination exists, it must be a directory")
111 if $dest != make_dest_filename($dest)
112 die _("Sorry, destination directory can't contain non simple alphanumeric characters.")
115 # system("rm -rf #{$dest}")
120 arg = File.expand_path(arg)
121 if File.readable?(arg)
122 $xmldoc = REXML::Document.new File.new(arg)
125 die _('Config file does not exist or is unreadable.')
128 arg = File.expand_path(arg)
130 if File.directory?(arg)
131 die _("Config skeleton file (%s) already exists and is a directory! Please change the filename.") % arg
133 msg 1, _("Config skeleton file already exists, backuping to %s.backup") % arg
134 File.rename(arg, "#{arg}.backup")
137 $config_writeto = arg
139 when '--merge-config'
140 arg = File.expand_path(arg)
141 if File.readable?(arg)
142 msg 2, _("Merge config notice: backuping current config file to %s.backup") % arg
143 $xmldoc = REXML::Document.new File.new(arg)
144 File.rename(arg, "#{arg}.backup")
145 $config_writeto = arg
146 $mode = 'merge_config'
148 die _('Config file does not exist or is unreadable.')
150 when '--merge-config-onedir'
151 arg = File.expand_path(arg)
152 if File.readable?(arg)
153 msg 2, _("Merge config notice: backuping current config file to %s.backup") % arg
154 $xmldoc = REXML::Document.new File.new(arg)
155 File.rename(arg, "#{arg}.backup")
156 $config_writeto = arg
157 $mode = 'merge_config_onedir'
159 die _('Config file does not exist or is unreadable.')
161 when '--merge-config-subdirs'
162 arg = File.expand_path(arg)
163 if File.readable?(arg)
164 msg 2, _("Merge config notice: backuping current config file to %s.backup") % arg
165 $xmldoc = REXML::Document.new File.new(arg)
166 File.rename(arg, "#{arg}.backup")
167 $config_writeto = arg
168 $mode = 'merge_config_subdirs'
170 die _('Config file does not exist or is unreadable.')
173 arg = File.expand_path(arg)
174 if !File.readable?(arg)
175 die _('Specified directory to merge with --dir is not readable')
180 arg = File.expand_path(arg)
181 if File.readable?(arg)
182 msg 2, _("Use config notice: backuping current config file to %s.backup") % arg
183 $xmldoc = REXML::Document.new File.new(arg)
184 File.rename(arg, "#{arg}.backup")
185 $config_writeto = arg
186 $mode = 'use_config_changetheme'
188 die _('Config file does not exist or is unreadable.')
194 when '--thumbnails-per-row'
197 when '--optimize-for-32'
198 $optimize_for_32 = true
203 when '--empty-comments'
204 $empty_comments = true
216 when '--verbose-level'
217 $verbose_level = arg.to_i
220 $info_pipe = File.open(arg, File::WRONLY)
221 $info_pipe.sync = true
230 if !$source && $xmldoc
231 $source = from_utf8($xmldoc.root.attributes['source'])
232 $dest = from_utf8($xmldoc.root.attributes['destination'])
233 $theme ||= $xmldoc.root.attributes['theme']
234 $limit_sizes ||= $xmldoc.root.attributes['limit-sizes']
235 if $mode == 'use_config' || $mode =~ /^merge_config/
236 $optimize_for_32 = !$xmldoc.root.attributes['optimize-for-32'].nil?
237 $N_per_row = $xmldoc.root.attributes['thumbnails-per-row']
238 $madewith = $xmldoc.root.attributes['made-with']
242 if $mode == 'merge_config_onedir' && !$onedir
243 die _("Missing --dir for --merge-config-onedir")
245 if $mode == 'merge_config_subdirs' && !$onedir
246 die _("Missing --dir for --merge-config-subdirs")
254 die _("Missing --destination parameter.")
260 select_theme($theme, $limit_sizes, $optimize_for_32, $N_per_row)
263 additional_params = ''
265 additional_params += "limit-sizes='#{$limit_sizes}'"
268 additional_params += " optimize-for-32='true'"
271 additional_params += " thumbnails-per-row='#{$N_per_row}'"
274 additional_params += " made-with='#{$madewith}'"
276 $xmldoc = Document.new "<booh version='#{$VERSION}' source='#{utf8($source)}' destination='#{utf8($dest)}' theme='#{$theme}' #{additional_params}/>"
277 $xmldoc << XMLDecl.new(XMLDecl::DEFAULT_VERSION, $CURRENT_CHARSET)
281 if $mode == 'merge_config' || $mode == 'use_config_changetheme'
282 $xmldoc.root.add_attribute('theme', $theme)
283 $xmldoc.root.add_attribute('version', $VERSION)
285 $xmldoc.root.add_attribute('limit-sizes', $limit_sizes)
287 $xmldoc.root.delete_attribute('limit-sizes')
290 $xmldoc.root.add_attribute('optimize-for-32', 'true')
292 $xmldoc.root.delete_attribute('optimize-for-32')
295 $xmldoc.root.add_attribute('thumbnails-per-row', $N_per_row)
297 $xmldoc.root.delete_attribute('thumbnails-per-row')
300 $xmldoc.root.add_attribute('made-with', $madewith)
302 $xmldoc.root.delete_attribute('made-with')
307 $madewith = $madewith.gsub('%booh', '"http://zarb.org/~gc/html/booh.html"')
320 $info_pipe.puts(value)
324 def check_installation
325 if !system("which convert >/dev/null 2>/dev/null")
326 die _("The program 'convert' is needed. Please install it.
327 It is generally available with the 'ImageMagick' software package.")
329 if !system("which identify >/dev/null 2>/dev/null")
330 msg 1, _("the program 'identify' is needed to get images sizes and EXIF data. Please install it.
331 It is generally available with the 'ImageMagick' software package.")
334 missing = %w(transcode mencoder).delete_if { |prg| system("which #{prg} >/dev/null 2>/dev/null") }
336 msg 1, _("the following program(s) are needed to handle videos: '%s'. Videos will be ignored.") % missing.join(', ')
337 $ignore_videos = true
341 def replace_line(surround, keyword, line)
343 contents = eval "$#{keyword}"
344 line.sub!(/#{surround}#{keyword}#{surround}/, contents)
346 die _("No '%s' found for substitution") % keyword
350 def build_html_skeletons
351 $html_images = File.open("#{$FPATH}/themes/#{$theme}/skeleton_image.html").readlines
352 $html_thumbnails = File.open("#{$FPATH}/themes/#{$theme}/skeleton_thumbnails.html").readlines
353 $html_index = File.open("#{$FPATH}/themes/#{$theme}/skeleton_index.html").readlines
354 for line in $html_images + $html_thumbnails + $html_index
355 while line =~ /~~~(\w+)~~~/
356 replace_line('~~~', $1, line)
361 def find_caption_value(xmldir, filename)
362 if cap = xmldir.elements["*[@filename='#{utf8(filename)}']"].attributes['caption']
363 return cap.gsub("\n", '<br/>')
369 def find_captions(xmldir, images)
370 return images.collect { |img| find_caption_value(xmldir, img) }
373 #- stolen from CVSspam
375 text.sub(/[^a-zA-Z0-9\-,.*_\/]/) do
376 "%#{sprintf('%2X', $&[0])}"
381 return $limit_sizes =~ /original/ ? $images_size + [ { 'name' => 'original' } ] : $images_size
384 def html_reload_to_thumbnails
385 html_reload_to_thumbnails = $preferred_size_reloader.clone
386 html_reload_to_thumbnails.gsub!(/~~theme~~/, $theme)
387 html_reload_to_thumbnails.gsub!(/~~default_size~~/, $default_size['name'])
388 html_reload_to_thumbnails.gsub!(/~~all_sizes~~/, all_images_sizes.collect { |s| "\"#{size2js(s['name'])}\"" }.join(', '))
389 return html_reload_to_thumbnails
392 def discover_iterations(iterations, line)
393 if line =~ /~~iterate(\d)_open(_max(\d+|N))?~~/
394 for iter in iterations.values
397 iter['close_wait'] = $1.to_i
400 max = $3 == 'N' ? ($N_per_row || $default_N) : $3
401 iterations[$1.to_i] = { 'open' => true, 'max' => max, 'opening' => '', 'closing' => '' }
403 line.sub!(/.*/, '~~thumbnails~~')
407 elsif line =~ /~~iterate(\d)_close~~/
408 iterations[$1.to_i]['open'] = false;
409 iterations[$1.to_i]['close'] = true;
412 for iter in iterations.values
414 iter['opening'] += line
417 if !iter['close'] && iter['close_wait'] && iterations[iter['close_wait']]['close']
418 iter['closing'] += line
425 def reset_iterations(iterations)
426 for iter in iterations.values
431 def run_iterations(iterations, amount)
434 for level in iterations.keys.sort
435 if iterations[level]['value'] == 0
436 html += iterations[level]['opening']
437 elsif level == iterations.keys.max
438 if !iterations[level]['max'] || iterations[level]['max'] && iterations[level]['value'] + amount <= iterations[level]['max'].to_i
439 html += iterations[level]['opening']
444 iterations[level]['value'] += amount
445 if iterations[level]['max'] && iterations[level]['value'] > iterations[level]['max'].to_i
446 iterations[level]['value'] = 0
447 iterations[level-1]['value'] = 0
448 html += iterations[level-1]['closing']
452 return html + run_iterations(iterations, amount)
458 def close_iterations(iterations)
460 for level in iterations.keys.sort.reverse
461 html += iterations[level]['closing']
466 def img_element(fullpath)
467 if size = get_image_size(fullpath)
468 sizespec = 'width="' + size[:x].to_s + '" height="' + size[:y].to_s + '"'
472 return '<img src="' + File.basename(fullpath) + '" ' + sizespec + ' class="image" alt="image"/>'
476 return name.gsub(/-/, '')
479 def substitute_html_sizes(html, sizeobj, type)
481 if $images_size.length > 1 || (type == 'image' && $limit_sizes =~ /original/)
482 for sizeobj2 in $images_size
483 if sizeobj != sizeobj2
484 if type == 'thumbnails'
485 sizestrings << '<a href="thumbnails-' + size2js(sizeobj2['name']) + '.html">' + sizename(sizeobj2['name']) + '</a>'
487 sizestrings << '<a id="link' + size2js(sizeobj2['name']) + '">' + sizename(sizeobj2['name']) + '</a>'
490 sizestrings << sizename(sizeobj2['name'])
493 if type == 'image' && $limit_sizes =~ /original/
494 sizestrings << '<a id="linkoriginal" target="newframe">' + sizename('original') + '</a>'
497 html.sub!(/~~sizes~~(.+)~~/) { sizestrings.join($1) }
500 def xmldir2destdir(xmldir)
501 return make_dest_filename(from_utf8(File.basename(xmldir.attributes['path'])))
504 def find_previous_album(xmldir)
507 #- move to previous dir element if exists
508 if prevelem = xmldir.previous_element_byname_notattr('dir', 'deleted')
510 relative_pos += '../' + xmldir2destdir(xmldir) + '/'
512 #- after having moved to previous dir, we need to go down last subdir until the last one
513 while child = xmldir.elements['dir']
514 while nextchild = child.next_element_byname_notattr('dir', 'deleted')
517 relative_pos += xmldir2destdir(child) + '/'
521 #- previous dir doesn't exist, move to previous dir element if exists
522 xmldir = xmldir.parent
523 if xmldir.name == 'dir' && !xmldir.attributes['deleted']
524 relative_pos += '../'
529 end while !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
530 return File.reduce_path(relative_pos)
533 def find_next_album(xmldir)
536 #- first child dir element (catches when initial xmldir has both thumbnails and subdirs)
537 if firstchild = xmldir.child_byname_notattr('dir', 'deleted')
539 relative_pos += xmldir2destdir(xmldir) + '/'
541 elsif nextbro = xmldir.next_element_byname_notattr('dir', 'deleted')
543 relative_pos += '../' + xmldir2destdir(xmldir) + '/'
545 #- go up until we have a next brother or we are finished
547 xmldir = xmldir.parent
548 relative_pos += '../'
549 end while xmldir && !xmldir.next_element_byname_notattr('dir', 'deleted')
551 xmldir = xmldir.next_element_byname('dir')
552 relative_pos += '../' + xmldir2destdir(xmldir) + '/'
557 end while !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
558 return File.reduce_path(relative_pos)
561 def sub_previous_next_album(previous_album, next_album, html)
563 html.gsub!(/~~previous_album~~/, '<a href="' + previous_album + 'thumbnails.html">' + utf8(_('previous album')) + '</a>')
564 html.gsub!(/~~ifprevious_album\?~~(.+?)~~fi~~/) { $1 }
566 html.gsub!(/~~previous_album~~/, '')
567 html.gsub!(/~~ifprevious_album\?~~(.+?)~~fi~~/, '')
570 html.gsub!(/~~next_album~~/, '<a href="' + next_album + 'thumbnails.html">' + utf8(_('next album')) + '</a>')
571 html.gsub!(/~~ifnext_album\?~~(.+?)~~fi~~/) { $1 }
573 html.gsub!(/~~next_album~~/, '')
574 html.gsub!(/~~ifnext_album\?~~(.+?)~~fi~~/, '')
581 #- preprocess the path->dir, rexml is very slow with that; we seem to improve speed by 7%
583 $xmldoc.elements.each('//dir') { |elem|
584 optxpath[elem.attributes['path']] = elem
588 if $mode == 'merge_config_onedir'
589 examined_dirs = [ $onedir ]
590 elsif $mode == 'merge_config_subdirs'
591 examined_dirs = `find '#{$onedir}' -type d -follow`.sort.collect { |v| v.chomp }.delete_if { |v| optxpath.has_key?(utf8(v)) }
593 examined_dirs = `find '#{$source}' -type d -follow`.sort.collect { |v| v.chomp }
594 if $mode == 'merge_config'
595 $xmldoc.elements.each('//dir') { |elem|
596 if ! examined_dirs.include?(elem.attributes['path'])
597 msg 2, _("Merging config: removing directory %s from config, isn't on filesystem anymore") % elem.attributes['path']
603 info("directories: #{examined_dirs.length}, sizes: #{$images_size.length}")
605 examined_dirs.each { |dir|
606 if File.basename(dir) =~ /^\./
607 msg 1, _("Ignoring directory %s, begins with a dot (indicating a hidden directory)") % dir
612 die _("Source directory or sub-directories can't contain a single-quote character, sorry: %s") % dir
615 #- place xml document on proper node if exists, else create
616 xmldir = optxpath[utf8(dir)]
617 if $mode == 'use_config' || $mode == 'use_config_changetheme'
618 if !xmldir || (xmldir.attributes['already-generated'] && !$force) || xmldir.attributes['deleted']
619 info("walking: #{dir}|#{$source}, 0 elements")
623 if $mode == 'gen_config' || (($mode == 'merge_config' || $mode == 'merge_config_subdirs') && !xmldir)
624 #- add the <dir..> element if necessary
625 parent = File.dirname(dir)
626 xmldir = $xmldoc.elements["//dir[@path='#{utf8(parent)}']"]
628 xmldir = $xmldoc.root
630 #- need to remove the already-generated mark of the parent because of the sub-albums page containing now one more element
631 xmldir.delete_attribute('already-generated')
632 xmldir = optxpath[utf8(dir)] = xmldir.add_element('dir', { 'path' => utf8(dir) })
635 xmldir.delete_attribute('already-generated')
637 #- read images/videos entries from config or from directories depending on mode
639 if $mode == 'use_config' || $mode == 'use_config_changetheme'
640 msg 2, _("Handling %s from config list...") % dir
641 xmldir.elements.each { |element|
642 if %w(image video).include?(element.name) && !element.attributes['deleted']
643 entries << from_utf8(element.attributes['filename'])
647 msg 2, _("Examining %s...") % dir
648 entries = Dir.entries(dir).sort
649 #- populate config in case of gen_config, add new files in case of merge_config
651 if file =~ /['"\[\]]/
652 msg 1, _("Ignoring %s, contains one of forbidden characters: '\"[]") % "#{dir}/#{file}"
654 type = entry2type(file)
655 if type && !xmldir.elements["#{type}[@filename='#{utf8(file)}']"]
656 xmldir.add_element type, { "filename" => utf8(file), "caption" => $empty_comments ? '' : utf8(file.sub(/\.[^\.]+$/, '')[0..17]) }
660 if $mode != 'gen_config'
661 #- cleanup removed files from config and reread entries from config to get proper ordering
663 xmldir.elements.each { |element|
664 fullpath = "#{dir}/#{from_utf8(element.attributes['filename'])}"
665 if %w(image video).include?(element.name)
666 if !File.readable?(fullpath)
667 msg 1, _("Config merge: removing %s from config; use the backup file to retrieve caption info if this was a mistake") % fullpath
668 xmldir.delete(element)
669 elsif !element.attributes['deleted']
670 entries << from_utf8(element.attributes['filename'])
674 #- if there is no more elements here, there is no album here anymore
675 if !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
676 xmldir.delete_attribute('thumbnails-caption')
677 xmldir.delete_attribute('thumbnails-captionfile')
681 images = entries.find_all { |e| entry2type(e) == 'image' }
682 msg 3, _("\t%s images") % images.length
683 videos = entries.find_all { |e| entry2type(e) == 'video' }
684 msg 3, _("\t%s videos") % videos.length
685 info("walking: #{dir}|#{$source}, #{images.length + videos.length} elements")
687 dest_dir = make_dest_filename(dir.sub(/^#{Regexp.quote($source)}/, $dest))
688 system("mkdir -p '#{dest_dir}'")
690 #- pass through if there are no images and videos
691 if images.size == 0 && videos.size == 0
693 #- cleanup old images/videos, especially if this directory contained images/videos previously.
694 themestuff = Dir.entries("#{$FPATH}/themes/#{$theme}").
695 find_all { |e| !%w(. .. skeleton_image.html skeleton_thumbnails.html skeleton_index.html metadata CVS).include?(e) }
696 if $mode != 'gen_config'
698 if xmldir.attributes['thumbnails-caption']
699 rightful_images << 'thumbnails-thumbnail.jpg'
701 xmldir.elements.each('dir') { |child|
702 if child.attributes['deleted']
705 subdir = make_dest_filename(from_utf8(File.basename(child.attributes['path'])))
706 rightful_images << "thumbnails-#{subdir}.jpg"
708 to_del = Dir.entries(dest_dir).find_all { |e| !File.directory?("#{dest_dir}/#{e}") && !rightful_images.include?(e) } - themestuff
710 system("rm -f " + to_del.collect { |e| "#{dest_dir}/#{e}" }.join(' '))
714 #- copy any resource file that goes with the theme (css, images..)
715 themestuff.each { |entry|
716 if !File.exists?("#{dest_dir}/#{entry}")
717 psys("cp '#{$FPATH}/themes/#{$theme}/#{entry}' '#{dest_dir}'")
724 msg 2, _("Outputting in %s...") % dest_dir
726 #- populate data structure with sizes from theme
727 for sizeobj in $images_size
728 fullscreen_images ||= {}
729 fullscreen_images[sizeobj['name']] = []
730 thumbnail_images ||= {}
731 thumbnail_images[sizeobj['name']] = []
732 thumbnail_videos ||= {}
733 thumbnail_videos[sizeobj['name']] = []
735 #- a special dummy size to keep 'references' to thumbnails in case of panorama, because the GUI will use the regular thumbnails
736 thumbnail_images['dont-delete-file-for-gui'] = []
737 if $limit_sizes =~ /original/
738 fullscreen_images['original'] = []
741 images.size >= 1 and msg 3, _("\tcreating images thumbnails...")
743 #- create thumbnails for images
745 info("processing element")
746 base_dest_img = dest_dir + '/' + make_dest_filename(img.sub(/\.[^\.]+$/, ''))
748 thumbnail_dest_img = base_dest_img + "-#{$default_size['thumbnails']}.jpg"
749 gen_thumbnails_element("#{dir}/#{img}", xmldir, true, [ { 'filename' => thumbnail_dest_img, 'size' => $default_size['thumbnails'] } ])
752 elem = xmldir.elements["image[@filename='#{utf8(img)}']"]
753 for sizeobj in $images_size
754 size_fullscreen = sizeobj['fullscreen']
755 size_thumbnails = sizeobj['thumbnails']
756 fullscreen_dest_img = base_dest_img + "-#{size_fullscreen}.jpg"
757 fullscreen_images[sizeobj['name']] << File.basename(fullscreen_dest_img)
758 todo << { 'filename' => fullscreen_dest_img, 'size' => size_fullscreen }
759 if pano = pano_amount(elem)
760 thumbnail_images['dont-delete-file-for-gui'] << File.basename(base_dest_img + "-#{size_thumbnails}.jpg")
761 size_thumbnails = size_thumbnails.sub(/(\d+)/) { ($1.to_i * pano).to_i }
763 thumbnail_dest_img = base_dest_img + "-#{size_thumbnails}.jpg"
764 thumbnail_images[sizeobj['name']] << File.basename(thumbnail_dest_img)
765 todo << { 'filename' => thumbnail_dest_img, 'size' => size_thumbnails }
767 gen_thumbnails_element("#{dir}/#{img}", xmldir, true, todo)
768 if $limit_sizes =~ /original/
769 fullscreen_images['original'] << img
771 destimg = "#{dest_dir}/#{img}"
772 if $limit_sizes =~ /original/ && !File.exists?(destimg)
774 if ! sys("ln '#{dir}/#{img}' '#{destimg}'")
775 $hardlinks_ok = false
779 psys("cp '#{dir}/#{img}' '#{destimg}'")
785 videos.size >= 1 and msg 3, _("\tcreating videos thumbnails...")
787 #- create thumbnails for videos
788 videos.each { |video|
789 info("processing element")
791 thumbnail_dest_img = dest_dir + '/' + make_dest_filename(video.sub(/\.[^\.]+$/, '')) + "-#{$default_size['thumbnails']}.jpg"
792 gen_thumbnails_element("#{dir}/#{video}", xmldir, true, [ { 'filename' => thumbnail_dest_img, 'size' => $default_size['thumbnails'] } ])
795 for sizeobj in $images_size
796 size_thumbnails = sizeobj['thumbnails']
797 thumbnail_dest_img = dest_dir + '/' + make_dest_filename(video.sub(/\.[^\.]+$/, '')) + "-#{size_thumbnails}.jpg"
798 thumbnail_videos[sizeobj['name']] << File.basename(thumbnail_dest_img)
799 todo << { 'filename' => thumbnail_dest_img, 'size' => size_thumbnails }
801 gen_thumbnails_element("#{dir}/#{video}", xmldir, true, todo)
803 destvideo = "#{dest_dir}/#{video}"
804 if !File.exists?(destvideo)
806 if ! sys("ln '#{dir}/#{video}' '#{destvideo}'")
807 $hardlinks_ok = false
811 psys("cp '#{dir}/#{video}' '#{destvideo}'")
817 themestuff = Dir.entries("#{$FPATH}/themes/#{$theme}").
818 find_all { |e| !%w(. .. skeleton_image.html skeleton_thumbnails.html skeleton_index.html metadata CVS).include?(e) }
820 #- cleanup old images/videos (for when removing elements or sizes)
821 all_elements = fullscreen_images.collect { |e| e[1] }.flatten.
822 concat(thumbnail_images.collect { |e| e[1] }.flatten).
823 concat(thumbnail_videos.collect { |e| e[1] }.flatten).
825 to_del = Dir.entries(dest_dir).find_all { |e| !File.directory?("#{dest_dir}/#{e}") && !all_elements.include?(e) && e !~ /^thumbnails-\w+\.jpg/ } - themestuff
827 msg 3, _("\tcleaning up: #{to_del.join(', ')}")
828 system("rm -f " + to_del.collect { |e| "#{dest_dir}/#{e}" }.join(' '))
831 #- copy any resource file that goes with the theme (css, images..)
832 themestuff.each { |entry|
833 if !File.exists?("#{dest_dir}/#{entry}")
834 psys("cp '#{$FPATH}/themes/#{$theme}/#{entry}' '#{dest_dir}'")
838 #- generate .htaccess file if needed
839 if auth_user_file = xmldir.attributes['password-protect']
840 msg 3, _("\tgenerating password protection file #{dest_dir}/.htaccess")
841 ios = File.open("#{dest_dir}/.htaccess", "w")
842 ios.write("AuthType Basic\nAuthName \"protected area\"\nAuthUserFile #{auth_user_file}\nrequire valid-user\n")
846 msg 3, _("\tgenerating HTML pages...")
848 #- generate thumbnails.html (page with thumbnails)
849 for sizeobj in $images_size
850 info("processing size")
851 html = $html_thumbnails.collect { |l| l.clone }
854 i.sub!(/~~run_slideshow~~/, images.size <= 1 ? '' : '<a href="image-' + size2js(sizeobj['name']) + '.html#run_slideshow=1">' + utf8(_('Run slideshow!'))+'</a>')
855 i.sub!(/~~title~~/, xmldir.attributes['thumbnails-caption'] || utf8(File.basename(dir)))
856 substitute_html_sizes(i, sizeobj, 'thumbnails')
857 discover_iterations(iterations, i)
860 reset_iterations(iterations)
862 type = images.include?(file) ? 'image' : videos.include?(file) ? 'video' : nil
864 if type == 'image' && elem = xmldir.elements["image[@filename='#{utf8(file)}']"]
865 if pano = pano_amount(elem)
866 html_thumbnails += run_iterations(iterations, pano)
867 html_thumbnails.gsub!(/~~colspan~~/) { 'colspan="' + pano.ceil.to_s + '"' }
869 html_thumbnails += run_iterations(iterations, 1)
870 html_thumbnails.gsub!(/~~colspan~~/, '')
873 html_thumbnails += run_iterations(iterations, 1)
874 html_thumbnails.gsub!(/~~colspan~~/, '')
877 index = images.index(file)
878 html_thumbnails.gsub!(/~~image_iteration~~/,
879 '<a href="image-' + size2js(sizeobj['name']) + '.html#current=' + fullscreen_images[sizeobj['name']][index] +
880 '" name="' + fullscreen_images[sizeobj['name']][index] + '">' +
881 img_element("#{dest_dir}/#{thumbnail_images[sizeobj['name']][index]}") + '</a>')
882 html_thumbnails.gsub!(/~~caption_iteration~~/,
883 find_caption_value(xmldir, images[index]) || utf8(images[index]))
884 html_thumbnails.gsub!(/~~ifimage\?~~(.+?)~~fi~~/) { $1 }
885 html_thumbnails.gsub!(/~~ifvideo\?~~(.+?)~~fi~~/, '')
886 elsif type == 'video'
887 index = videos.index(file)
888 if File.exists?("#{dest_dir}/#{thumbnail_videos[sizeobj['name']][index]}")
889 html_thumbnails.gsub!(/~~image_iteration~~/,
890 '<a href="' + videos[index] + '">' + img_element("#{dest_dir}/#{thumbnail_videos[sizeobj['name']][index]}") + '</a>')
892 html_thumbnails.gsub!(/~~image_iteration~~/,
893 '<a href="' + videos[index] + '">' + utf8(_("(no preview)")) + '</a>')
895 html_thumbnails.gsub!(/~~caption_iteration~~/,
896 find_caption_value(xmldir, videos[index]) || utf8(videos[index]))
897 html_thumbnails.gsub!(/~~ifimage\?~~(.+?)~~fi~~/, '')
898 html_thumbnails.gsub!(/~~ifvideo\?~~(.+?)~~fi~~/) { $1 }
902 html_thumbnails += close_iterations(iterations)
904 i.sub!(/~~thumbnails~~/, html_thumbnails)
905 i.gsub!(/~~theme~~/, $theme)
906 i.gsub!(/~~current_size~~/, sizeobj['name'])
907 i.gsub!(/~~current_size_js~~/, size2js(sizeobj['name']))
908 i.gsub!(/~~madewith~~/, $madewith || '')
910 ios = File.open("#{dest_dir}/thumbnails-#{size2js(sizeobj['name'])}.html", "w")
915 info("finished processing sizes")
917 #- generate "main" thumbnails.html page that will reload to correct size thanks to cookie
918 ios = File.open("#{dest_dir}/thumbnails.html", "w")
919 ios.write(html_reload_to_thumbnails)
922 #- generate image.html (page with fullscreen images)
924 captions4js = find_captions(xmldir, images).collect { |e| e ? '"' + e.gsub('"', '\"') + '"' : '""' }.join(', ')
926 for sizeobj in $images_size
927 html = $html_images.collect { |l| l.clone }
928 images4js = fullscreen_images[sizeobj['name']].collect { |e| "\"#{e}\"" }.join(', ')
931 for sizeobj2 in all_images_sizes
932 if sizeobj != sizeobj2
933 otherimages4js += "var images_#{size2js(sizeobj2['name'])} = new Array(" + fullscreen_images[sizeobj2['name']].collect { |e| "\"#{e}\"" }.join(', ') + ")\n"
934 othersizes << "\"#{size2js(sizeobj2['name'])}\""
938 i.gsub!(/~~images~~/, images4js)
939 i.gsub!(/~~other_images~~/, otherimages4js)
940 i.gsub!(/~~other_sizes~~/, othersizes.join(', '))
941 i.gsub!(/~~captions~~/, captions4js)
942 i.gsub!(/~~title~~/, xmldir.attributes['thumbnails-caption'] || utf8(File.basename(dir)))
943 i.gsub!(/~~thumbnails~~/, '<a href="thumbnails-' + size2js(sizeobj['name']) + '.html" id="thumbnails">' + utf8(_('return to thumbnails')) + '</a>')
944 i.gsub!(/~~theme~~/, $theme)
945 i.gsub!(/~~current_size~~/, size2js(sizeobj['name']))
946 i.gsub!(/~~madewith~~/, $madewith || '')
947 substitute_html_sizes(i, sizeobj, 'image')
949 ios = File.open("#{dest_dir}/image-#{size2js(sizeobj['name'])}.html", "w")
959 #- add attributes to <dir..> elements needing so
960 if $mode != 'use_config'
961 msg 3, _("\tfixating configuration file...")
962 $xmldoc.elements.each('//dir') { |element|
963 path = captionpath = element.attributes['path']
964 descendant_element = element.elements['descendant::image'] || element.elements['descendant::video']
965 if !descendant_element
966 msg 3, _("\t\tremoving %s, no element in it") % path
967 element.remove #- means we have a directory with nothing interesting in it
969 captionfile = "#{descendant_element.parent.attributes['path']}/#{descendant_element.attributes['filename']}"
970 basename = File.basename(path)
971 if element.elements['dir']
972 if !element.attributes['subdirs-caption']
973 element.add_attribute('subdirs-caption', basename)
975 if !element.attributes['subdirs-captionfile']
976 element.add_attribute('subdirs-captionfile', captionfile)
979 if element.child_byname_notattr('image', 'deleted') || element.child_byname_notattr('video', 'deleted')
980 if !element.attributes['thumbnails-caption']
981 element.add_attribute('thumbnails-caption', basename)
983 if !element.attributes['thumbnails-captionfile']
984 element.add_attribute('thumbnails-captionfile', captionfile)
991 #- write down to disk config if necessary
993 ios = File.open($config_writeto, "w")
994 $xmldoc.write(ios, 0)
999 msg 3, _(" completed necessary stuff for GUI, exiting.")
1003 #- second pass to create index.html files and previous/next links
1004 info("creating index.html")
1005 msg 3, _("\trescanning directories to generate all `index.html' files...")
1007 #- recompute the memoization because elements mights have been removed (the ones with no element in them)
1009 $xmldoc.elements.each('//dir') { |elem|
1010 optxpath[elem.attributes['path']] = elem
1013 examined_dirs.each { |dir|
1014 info("index.html: #{dir}|#{$source}")
1016 xmldir = optxpath[utf8(dir)]
1017 if !xmldir || (xmldir.attributes['already-generated'] && !$force) || xmldir.attributes['deleted']
1020 dest_dir = make_dest_filename(dir.sub(/^#{Regexp.quote($source)}/, $dest))
1022 previous_album = find_previous_album(xmldir)
1023 next_album = find_next_album(xmldir)
1025 if xmldir.elements['dir']
1026 html = $html_index.collect { |l| l.clone }
1029 caption = xmldir.attributes['subdirs-caption']
1030 i.gsub!(/~~title~~/, caption)
1031 if xmldir.parent.name == 'dir'
1034 parent = xmldir.parent
1035 while parent.name == 'dir'
1036 parentcaption = parent.attributes['subdirs-caption']
1037 nav = "<a href='#{path}/index.html'>#{parentcaption}</a> #{utf8(_(" > "))} #{nav}"
1039 parent = parent.parent
1041 i.gsub!(/~~ifnavigation\?~~(.+?)~~fi~~/) { $1 }
1042 i.gsub!(/~~navigation~~/, nav + caption)
1044 i.gsub!(/~~ifnavigation\?~~(.+?)~~fi~~/, '')
1046 discover_iterations(iterations, i)
1050 reset_iterations(iterations)
1052 #- deal with "current" album (directs to "thumbnails" page)
1053 if xmldir.attributes['thumbnails-caption']
1054 thumbnail = "#{dest_dir}/thumbnails-thumbnail.jpg"
1055 gen_thumbnails_subdir(from_utf8(xmldir.attributes['thumbnails-captionfile']), xmldir, false,
1056 [ { 'filename' => thumbnail, 'size' => $albums_thumbnail_size } ], 'thumbnails')
1057 html_index += run_iterations(iterations, 1)
1058 html_index.gsub!(/~~image_iteration~~/, "<a href='thumbnails.html'>" + img_element(thumbnail) + '</a>')
1059 html_index.gsub!(/~~caption_iteration~~/, xmldir.attributes['thumbnails-caption'])
1062 #- deal with sub-albums (direct to subdirs/index.html pages)
1063 xmldir.elements.each('dir') { |child|
1064 if child.attributes['deleted']
1067 subdir = make_dest_filename(from_utf8(File.basename(child.attributes['path'])))
1068 thumbnail = "#{dest_dir}/thumbnails-#{subdir}.jpg"
1069 html_index += run_iterations(iterations, 1)
1070 captionfile, caption = find_subalbum_caption_info(child)
1071 gen_thumbnails_subdir(captionfile, child, false,
1072 [ { 'filename' => thumbnail, 'size' => $albums_thumbnail_size } ], find_subalbum_info_type(child))
1073 html_index.gsub!(/~~caption_iteration~~/, caption)
1074 html_index.gsub!(/~~image_iteration~~/, "<a href='#{make_dest_filename(subdir)}/index.html'>" + img_element(thumbnail) + '</a>')
1077 html_index += close_iterations(iterations)
1080 i.gsub!(/~~thumbnails~~/, html_index)
1081 i.gsub!(/~~madewith~~/, $madewith || '')
1085 html = html_reload_to_thumbnails
1088 ios = File.open("#{dest_dir}/index.html", "w")
1092 #- substitute "return to albums" and previous/next correctly
1093 if xmldir.child_byname_notattr('image', 'deleted') || xmldir.child_byname_notattr('video', 'deleted')
1094 for sizeobj in $images_size
1095 substInFile("#{dest_dir}/thumbnails-#{size2js(sizeobj['name'])}.html") { |line|
1096 sub_previous_next_album(previous_album, next_album, line)
1097 if xmldir.elements['dir']
1098 line.sub!(/~~return_to_albums~~/, '<a href="index.html">' + utf8(_('return to albums')) + '</a>')
1100 if xmldir.parent.name == 'dir'
1101 line.sub!(/~~return_to_albums~~/, '<a href="../index.html">' + utf8(_('return to albums')) + '</a>')
1103 line.sub!(/~~return_to_albums~~/, '')
1108 if xmldir.child_byname_notattr('image', 'deleted')
1109 substInFile("#{dest_dir}/image-#{size2js(sizeobj['name'])}.html") { |line|
1110 sub_previous_next_album(previous_album, next_album, line)
1117 msg 3, _(" all done.")
1124 build_html_skeletons