try to use hard links when creating an album including "original" size to space diskspace
[booh] / bin / booh-backend
1 #! /usr/bin/ruby
2 #
3 #                         *  BOOH  *
4 #
5 # A.k.a `Best web-album Of the world, Or your money back, Humerus'.
6 #
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.
11 #
12 #
13 # Copyright (c) 2005 Guillaume Cottenceau <gc3 at bluewin.ch>
14 #
15 # This software may be freely redistributed under the terms of the GNU
16 # public license version 2.
17 #
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.
21
22 require 'getoptlong'
23 require 'gettext'
24 include GetText
25 require 'rexml/document'
26 include REXML
27
28 require 'booh/booh-lib'
29 require 'booh/html-merges'
30
31 #- bind text domain as soon as possible because some _() functions are called early to build data structures
32 bindtextdomain("booh")
33
34 #- options
35 $options = [
36     [ '--help',          '-h', GetoptLong::NO_ARGUMENT,       _("Get help message") ],
37     [ '--version',       '-V', GetoptLong::NO_ARGUMENT,       _("Print version and exit") ],
38
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") ],
42
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 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") ],
52
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") ],
58
59     [ '--mproc',         '-m', GetoptLong::REQUIRED_ARGUMENT, _("Specify the number of processors for multi-processors machines") ],
60
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)") ],
62
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)") ],
65 ]
66
67 #- default values for some globals 
68 $switches = []
69 $stdout.sync = true
70 $no_identify = false
71 $ignore_videos = false
72 $forgui = false
73 $hardlinks_ok = true
74
75 def usage
76     puts _("Usage: %s [OPTION]...") % File.basename($0)
77     $options.each { |ary|
78         printf " %3s, %-18s %s\n", ary[1], ary[0], ary[3]
79     }
80 end
81
82 def handle_options
83     parser = GetoptLong.new
84     parser.set_options(*$options.collect { |ary| ary[0..2] })
85     begin
86         parser.each_option do |name, arg|
87             case name
88             when '--help'
89                 usage
90                 exit(0)
91
92             when '--version'
93                 puts _("Booh version %s
94
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
98
99                 exit(0)
100
101             when '--source'
102                 $source = File.expand_path(arg.sub(%r|/$|, ''))
103                 if !File.directory?($source)
104                     die _("Argument to --source must be a directory")
105                 end
106             when '--destination'
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")
110                 end
111                 if $dest != make_dest_filename($dest)
112                     die _("Sorry, destination directory can't contain non simple alphanumeric characters.")
113                 end
114 #            when '--clean'
115 #                system("rm -rf #{$dest}")
116
117             when '--theme'
118                 $theme = arg
119             when '--config'
120                 arg = File.expand_path(arg)
121                 if File.readable?(arg)
122                     $xmldoc = REXML::Document.new File.new(arg)
123                     $mode = 'use_config'
124                 else
125                     die _('Config file does not exist or is unreadable.')
126                 end
127             when '--config-skel'
128                 arg = File.expand_path(arg)
129                 if File.exists?(arg)
130                     if File.directory?(arg)
131                         die _("Config skeleton file (%s) already exists and is a directory! Please change the filename.") % arg
132                     else
133                         msg 1, _("Config skeleton file already exists, backuping to %s.backup") % arg
134                         File.rename(arg, "#{arg}.backup")
135                     end
136                 end
137                 $config_writeto = arg
138                 $mode = 'gen_config'
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'
147                 else
148                     die _('Config file does not exist or is unreadable.')
149                 end
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'
158                 else
159                     die _('Config file does not exist or is unreadable.')
160                 end
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'
169                 else
170                     die _('Config file does not exist or is unreadable.')
171                 end
172             when '--dir'
173                 arg = File.expand_path(arg)
174                 if !File.readable?(arg)
175                     die _('Specified directory to merge with --dir is not readable')
176                 else
177                     $onedir = arg
178                 end
179             when '--use-config'
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'
187                 else
188                     die _('Config file does not exist or is unreadable.')
189                 end
190
191             when '--sizes'
192                 $limit_sizes = arg
193
194             when '--thumbnails-per-row'
195                 $N_per_row = arg
196
197             when '--optimize-for-32'
198                 $optimize_for_32 = true
199
200             when '--made-with'
201                 $madewith = arg
202
203             when '--empty-comments'
204                 $empty_comments = true
205
206             when '--force'
207                 $force = true
208
209             when '--mproc'
210                 $mproc = arg.to_i
211                 $pids = []
212
213             when '--for-gui'
214                 $forgui = true
215
216             when '--verbose-level'
217                 $verbose_level = arg.to_i
218
219             when '--info-pipe'
220                 $info_pipe = File.open(arg, File::WRONLY)
221                 $info_pipe.sync = true
222             end
223         end
224     rescue
225         puts $!
226         usage
227         exit(1)
228     end
229
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']
239         end
240     end
241
242     if $mode == 'merge_config_onedir' && !$onedir
243         die _("Missing --dir for --merge-config-onedir")
244     end
245     if $mode == 'merge_config_subdirs' && !$onedir
246         die _("Missing --dir for --merge-config-subdirs")
247     end
248
249     if !$source
250         usage
251         exit(0)
252     end
253     if !$dest
254         die _("Missing --destination parameter.")
255     end
256     if !$theme
257         $theme = 'simple'
258     end
259
260     select_theme($theme, $limit_sizes, $optimize_for_32, $N_per_row)
261
262     if !$xmldoc
263         additional_params = ''
264         if $limit_sizes
265             additional_params += "limit-sizes='#{$limit_sizes}'"
266         end
267         if $optimize_for_32
268             additional_params += " optimize-for-32='true'"
269         end
270         if $N_per_row
271             additional_params += " thumbnails-per-row='#{$N_per_row}'"
272         end
273         if $madewith
274             additional_params += " made-with='#{$madewith}'"
275         end
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)
278         $mode = 'gen_config'
279     end
280
281     if $mode == 'merge_config' || $mode == 'use_config_changetheme'
282         $xmldoc.root.add_attribute('theme', $theme)
283         $xmldoc.root.add_attribute('version', $VERSION)
284         if $limit_sizes
285             $xmldoc.root.add_attribute('limit-sizes', $limit_sizes)
286         else
287             $xmldoc.root.delete_attribute('limit-sizes')
288         end
289         if $optimize_for_32
290             $xmldoc.root.add_attribute('optimize-for-32', 'true')
291         else
292             $xmldoc.root.delete_attribute('optimize-for-32')
293         end
294         if $N_per_row
295             $xmldoc.root.add_attribute('thumbnails-per-row', $N_per_row)
296         else
297             $xmldoc.root.delete_attribute('thumbnails-per-row')
298         end
299         if $madewith
300             $xmldoc.root.add_attribute('made-with', $madewith)
301         else
302             $xmldoc.root.delete_attribute('made-with')
303         end
304     end
305
306     if $madewith
307         $madewith = $madewith.gsub('%booh', '"http://zarb.org/~gc/html/booh.html"')
308     end
309 end
310
311 def read_config
312     $config = {}
313 end
314
315 def write_config
316 end
317
318 def info(value)
319     if $info_pipe
320         $info_pipe.puts(value)
321     end
322 end
323
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.")
328     end
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.")
332         $no_identify = true
333     end
334     missing = %w(transcode mencoder).delete_if { |prg| system("which #{prg} >/dev/null 2>/dev/null") }
335     if missing != []
336         msg 1, _("the following program(s) are needed to handle videos: '%s'. Videos will be ignored.") % missing.join(', ')
337         $ignore_videos = true
338     end
339 end
340
341 def replace_line(surround, keyword, line)
342     begin
343         contents = eval "$#{keyword}"
344         line.sub!(/#{surround}#{keyword}#{surround}/, contents)
345     rescue TypeError
346         die _("No '%s' found for substitution") % keyword
347     end
348 end
349
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)
357         end
358     end
359 end
360
361 def find_caption_value(xmldir, filename)
362     if cap = xmldir.elements["*[@filename='#{utf8(filename)}']"].attributes['caption']
363         return cap.gsub("\n", '<br/>')
364     else
365         return nil
366     end
367 end
368
369 def find_captions(xmldir, images)
370     return images.collect { |img| find_caption_value(xmldir, img) }
371 end
372
373 #- stolen from CVSspam
374 def urlencode(text)
375   text.sub(/[^a-zA-Z0-9\-,.*_\/]/) do
376     "%#{sprintf('%2X', $&[0])}"
377   end
378 end
379
380 def all_images_sizes
381     return $limit_sizes =~ /original/ ? $images_size + [ { 'name' => 'original' } ] : $images_size
382 end
383
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
390 end
391
392 def discover_iterations(iterations, line)
393     if line =~ /~~iterate(\d)_open(_max(\d+|N))?~~/
394         for iter in iterations.values
395             if iter['open']
396                 iter['open'] = false
397                 iter['close_wait'] = $1.to_i
398             end
399         end
400         max = $3 == 'N' ? ($N_per_row || $default_N) : $3
401         iterations[$1.to_i] = { 'open' => true, 'max' => max, 'opening' => '', 'closing' => '' }
402         if $1.to_i == 1
403             line.sub!(/.*/, '~~thumbnails~~')
404         else
405             line.sub!(/.*/, '')
406         end
407     elsif line =~ /~~iterate(\d)_close~~/
408         iterations[$1.to_i]['open']  = false;
409         iterations[$1.to_i]['close'] = true;
410         line.sub!(/.*/, '')
411     else
412         for iter in iterations.values
413             if iter['open']
414                 iter['opening'] += line
415                 line.sub!(/.*/, '')
416             end
417             if !iter['close'] && iter['close_wait'] && iterations[iter['close_wait']]['close']
418                 iter['closing'] += line
419                 line.sub!(/.*/, '')
420             end
421         end
422     end
423 end
424
425 def reset_iterations(iterations)
426     for iter in iterations.values
427         iter['value'] = 0
428     end
429 end
430
431 def run_iterations(iterations, amount)
432     html = ''
433     should_rerun = false
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']
440             else
441                 should_rerun = true
442             end
443         end
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']
449         end
450     end
451     if should_rerun
452         return html + run_iterations(iterations, amount)
453     else
454         return html
455     end
456 end
457
458 def close_iterations(iterations)
459     html = ''
460     for level in iterations.keys.sort.reverse
461         html += iterations[level]['closing']
462     end
463     return html
464 end
465
466 def img_element(fullpath)
467     if size = get_image_size(fullpath)
468         sizespec = 'width="' + size[:x].to_s + '" height="' + size[:y].to_s + '"'
469     else
470         sizespec = ''
471     end
472     return '<img src="' + File.basename(fullpath) + '" ' + sizespec + ' class="image"/>'
473 end
474
475 def size2js(name)
476     return name.gsub(/-/, '')
477 end
478
479 def substitute_html_sizes(html, sizeobj, type)
480     sizestrings = []
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>'
486                 else
487                     sizestrings << '<a id="link' + size2js(sizeobj2['name']) + '">' + sizename(sizeobj2['name']) + '</a>'
488                 end
489             else
490                 sizestrings << sizename(sizeobj2['name'])
491             end
492         end
493         if type == 'image' && $limit_sizes =~ /original/
494             sizestrings << '<a id="linkoriginal" target="newframe">' + sizename('original') + '</a>'
495         end
496     end
497     html.sub!(/~~sizes~~(.+)~~/) { sizestrings.join($1) }
498 end
499
500 def xmldir2destdir(xmldir)
501     return make_dest_filename(from_utf8(File.basename(xmldir.attributes['path'])))
502 end
503
504 def find_previous_album(xmldir)
505     relative_pos = ''
506     begin
507         #- move to previous dir element if exists
508         if prevelem = xmldir.previous_element_byname_notattr('dir', 'deleted')
509             xmldir = prevelem
510             relative_pos += '../' + xmldir2destdir(xmldir) + '/'
511             child = nil
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')
515                     child = nextchild
516                 end
517                 relative_pos += xmldir2destdir(child) + '/'
518                 xmldir = child
519             end
520         else
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 += '../'
525             else
526                 return nil
527             end
528         end
529     end while !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
530     return File.reduce_path(relative_pos)
531 end
532
533 def find_next_album(xmldir)
534     relative_pos = ''
535     begin
536         #- first child dir element (catches when initial xmldir has both thumbnails and subdirs)
537         if firstchild = xmldir.child_byname_notattr('dir', 'deleted')
538             xmldir = firstchild
539             relative_pos += xmldir2destdir(xmldir) + '/'
540         #- next brother
541         elsif nextbro = xmldir.next_element_byname_notattr('dir', 'deleted')
542             xmldir = nextbro
543             relative_pos += '../' + xmldir2destdir(xmldir) + '/'
544         else
545             #- go up until we have a next brother or we are finished
546             begin
547                 xmldir = xmldir.parent
548                 relative_pos += '../'
549             end while xmldir && !xmldir.next_element_byname_notattr('dir', 'deleted')
550             if xmldir
551                 xmldir = xmldir.next_element_byname('dir')
552                 relative_pos += '../' + xmldir2destdir(xmldir) + '/'
553             else
554                 return nil
555             end
556         end
557     end while !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
558     return File.reduce_path(relative_pos)
559 end
560
561 def sub_previous_next_album(previous_album, next_album, html)
562     if previous_album
563         html.gsub!(/~~previous_album~~/, '<a href="' + previous_album + 'thumbnails.html">' + utf8(_('previous album')) + '</a>')
564         html.gsub!(/~~ifprevious_album\?~~(.+?)~~fi~~/) { $1 }
565     else
566         html.gsub!(/~~previous_album~~/, '')
567         html.gsub!(/~~ifprevious_album\?~~(.+?)~~fi~~/, '')
568     end
569     if next_album
570         html.gsub!(/~~next_album~~/, '<a href="' + next_album + 'thumbnails.html">' + utf8(_('next album')) + '</a>')
571         html.gsub!(/~~ifnext_album\?~~(.+?)~~fi~~/) { $1 }
572     else
573         html.gsub!(/~~next_album~~/, '')
574         html.gsub!(/~~ifnext_album\?~~(.+?)~~fi~~/, '')
575     end
576     return html
577 end
578
579 def walk_source_dir
580
581     #- preprocess the path->dir, rexml is very slow with that; we seem to improve speed by 7%
582     optxpath = {}
583     $xmldoc.elements.each('//dir') { |elem|
584         optxpath[elem.attributes['path']] = elem
585     }
586
587     examined_dirs = nil
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)) }
592     else
593         examined_dirs = `find '#{$source}' -type d -follow`.sort
594     end
595     info("directories: #{examined_dirs.length}, sizes: #{$images_size.length}")
596
597     examined_dirs.each { |dir|
598         dir.chomp!
599         if File.basename(dir) =~ /^\./
600             msg 1, _("Ignoring directory %s, begins with a dot (indicating a hidden directory)") % dir
601             next
602         end
603
604         if dir =~ /'/
605             die _("Source directory or sub-directories can't contain a single-quote character, sorry: %s") % dir
606         end
607
608         #- place xml document on proper node if exists, else create
609         xmldir = optxpath[utf8(dir)]
610         if $mode == 'use_config' || $mode == 'use_config_changetheme'
611             if !xmldir || (xmldir.attributes['already-generated'] && !$force) || xmldir.attributes['deleted']
612                 info("walking: #{dir}|#{$source}, 0 elements")
613                 next
614             end
615         else
616             if $mode == 'gen_config' || (($mode == 'merge_config' || $mode == 'merge_config_subdirs') && !xmldir)
617                 #- add the <dir..> element if necessary
618                 parent = File.dirname(dir)
619                 xmldir = $xmldoc.elements["//dir[@path='#{utf8(parent)}']"]
620                 if !xmldir
621                     xmldir = $xmldoc.root
622                 end
623                 #- need to remove the already-generated mark of the parent because of the sub-albums page containing now one more element
624                 xmldir.delete_attribute('already-generated')
625                 xmldir = optxpath[utf8(dir)] = xmldir.add_element('dir', { 'path' => utf8(dir) })
626             end
627         end
628         xmldir.delete_attribute('already-generated')
629
630         #- read images/videos entries from config or from directories depending on mode
631         entries = []
632         if $mode == 'use_config' || $mode == 'use_config_changetheme'
633             msg 2, _("Handling %s from config list...") % dir
634             xmldir.elements.each { |element|
635                 if %w(image video).include?(element.name) && !element.attributes['deleted']
636                     entries << from_utf8(element.attributes['filename'])
637                 end
638             }
639         else
640             msg 2, _("Examining %s...") % dir
641             entries = Dir.entries(dir).sort
642             #- populate config in case of gen_config, add new files in case of merge_config
643             for file in entries
644                 if file =~ /['"\[\]]/
645                     msg 1, _("Ignoring %s, contains one of forbidden characters: '\"[]") % "#{dir}/#{file}"
646                 else
647                     type = entry2type(file)
648                     if type && !xmldir.elements["#{type}[@filename='#{utf8(file)}']"]
649                         xmldir.add_element type, { "filename" => utf8(file), "caption" => $empty_comments ? '' : utf8(file.sub(/\.[^\.]+$/, '')[0..17]) }
650                     end
651                 end
652             end
653             if $mode != 'gen_config'
654                 #- cleanup removed files from config and reread entries from config to get proper ordering
655                 entries = []
656                 xmldir.elements.each { |element|
657                     fullpath = "#{dir}/#{from_utf8(element.attributes['filename'])}"
658                     if %w(image video).include?(element.name)
659                         if !File.readable?(fullpath)
660                             msg 1, _("Config merge: removing %s from config; use the backup file to retrieve caption info if this was a mistake") % fullpath
661                             xmldir.delete(element)
662                         elsif !element.attributes['deleted']
663                             entries << from_utf8(element.attributes['filename'])
664                         end
665                     end
666                 }
667                 #- if there is no more elements here, there is no album here anymore
668                 if !xmldir.child_byname_notattr('image', 'deleted') && !xmldir.child_byname_notattr('video', 'deleted')
669                     xmldir.delete_attribute('thumbnails-caption')
670                     xmldir.delete_attribute('thumbnails-captionfile')
671                 end
672             end
673         end
674         images = entries.find_all { |e| entry2type(e) == 'image' }
675         msg 3, _("\t%s images") % images.length
676         videos = entries.find_all { |e| entry2type(e) == 'video' }
677         msg 3, _("\t%s videos") % videos.length
678         info("walking: #{dir}|#{$source}, #{images.length + videos.length} elements")
679
680         dest_dir = make_dest_filename(dir.sub(/^#{Regexp.quote($source)}/, $dest))
681         system("mkdir -p '#{dest_dir}'")
682
683         #- pass through if there are no images and videos
684         if images.size == 0 && videos.size == 0
685             if !$forgui
686                 #- cleanup old images/videos, especially if this directory contained images/videos previously.
687                 themestuff = Dir.entries("#{$FPATH}/themes/#{$theme}").
688                                 find_all { |e| !%w(. .. skeleton_image.html skeleton_thumbnails.html skeleton_index.html metadata CVS).include?(e) }
689                 if $mode != 'gen_config'
690                     rightful_images = []
691                     if xmldir.attributes['thumbnails-caption']
692                         rightful_images << 'thumbnails-thumbnail.jpg'
693                     end
694                     xmldir.elements.each('dir') { |child|
695                         if child.attributes['deleted']
696                             next
697                         end
698                         subdir = make_dest_filename(from_utf8(File.basename(child.attributes['path'])))
699                         rightful_images << "thumbnails-#{subdir}.jpg"
700                     }
701                     to_del = Dir.entries(dest_dir).find_all { |e| !File.directory?("#{dest_dir}/#{e}") && !rightful_images.include?(e) } - themestuff
702                     if to_del.size > 0
703                         system("rm -f " + to_del.collect { |e| "#{dest_dir}/#{e}" }.join(' '))
704                     end
705                 end
706                 
707                 #- copy any resource file that goes with the theme (css, images..)
708                 themestuff.each { |entry|
709                     if !File.exists?("#{dest_dir}/#{entry}")
710                         psys("cp '#{$FPATH}/themes/#{$theme}/#{entry}' '#{dest_dir}'")
711                     end
712                 }
713             end
714             next
715         end
716
717         msg 2, _("Outputting in %s...") % dest_dir
718
719         #- populate data structure with sizes from theme
720         for sizeobj in $images_size
721             fullscreen_images ||= {}
722             fullscreen_images[sizeobj['name']] = []
723             thumbnail_images ||= {}
724             thumbnail_images[sizeobj['name']] = []
725             thumbnail_videos ||= {}
726             thumbnail_videos[sizeobj['name']] = []
727         end
728         #- a special dummy size to keep 'references' to thumbnails in case of panorama, because the GUI will use the regular thumbnails
729         thumbnail_images['dont-delete-file-for-gui'] = []
730         if $limit_sizes =~ /original/
731             fullscreen_images['original'] = []
732         end
733
734         images.size >= 1 and msg 3, _("\tcreating images thumbnails...")
735
736         #- create thumbnails for images
737         images.each { |img|
738             info("processing element")
739             base_dest_img = dest_dir + '/' + make_dest_filename(img.sub(/\.[^\.]+$/, ''))
740             if $forgui
741                 thumbnail_dest_img = base_dest_img + "-#{$default_size['thumbnails']}.jpg"
742                 gen_thumbnails_element("#{dir}/#{img}", xmldir, true, [ { 'filename' => thumbnail_dest_img, 'size' => $default_size['thumbnails'] } ])
743             else
744                 todo = []
745                 elem = xmldir.elements["image[@filename='#{utf8(img)}']"]
746                 for sizeobj in $images_size
747                     size_fullscreen = sizeobj['fullscreen']
748                     size_thumbnails = sizeobj['thumbnails']
749                     fullscreen_dest_img = base_dest_img + "-#{size_fullscreen}.jpg"
750                     fullscreen_images[sizeobj['name']] << File.basename(fullscreen_dest_img)
751                     todo << { 'filename' => fullscreen_dest_img, 'size' => size_fullscreen }
752                     if pano = pano_amount(elem)
753                         thumbnail_images['dont-delete-file-for-gui'] << File.basename(base_dest_img + "-#{size_thumbnails}.jpg")
754                         size_thumbnails = size_thumbnails.sub(/(\d+)/) { ($1.to_i * pano).to_i }
755                     end
756                     thumbnail_dest_img = base_dest_img + "-#{size_thumbnails}.jpg"
757                     thumbnail_images[sizeobj['name']] << File.basename(thumbnail_dest_img)
758                     todo << { 'filename' => thumbnail_dest_img,  'size' => size_thumbnails }
759                 end
760                 gen_thumbnails_element("#{dir}/#{img}", xmldir, true, todo)
761                 if $limit_sizes =~ /original/
762                     fullscreen_images['original'] << img
763                 end
764                 destimg = "#{dest_dir}/#{img}"
765                 if $limit_sizes =~ /original/ && !File.exists?(destimg)
766                     if $hardlinks_ok
767                         if ! sys("ln '#{dir}/#{img}' '#{destimg}'")
768                             $hardlinks_ok = false
769                         end
770                     end
771                     if ! $hardlinks_ok
772                         psys("cp '#{dir}/#{img}' '#{destimg}'")
773                     end
774                 end
775             end
776         }
777
778         videos.size >= 1 and msg 3, _("\tcreating videos thumbnails...")
779
780         #- create thumbnails for videos
781         videos.each { |video|
782             info("processing element")
783             if $forgui
784                 thumbnail_dest_img = dest_dir + '/' + make_dest_filename(video.sub(/\.[^\.]+$/, '')) + "-#{$default_size['thumbnails']}.jpg"
785                 gen_thumbnails_element("#{dir}/#{video}", xmldir, true, [ { 'filename' => thumbnail_dest_img, 'size' => $default_size['thumbnails'] } ])
786             else
787                 todo = []
788                 for sizeobj in $images_size
789                     size_thumbnails = sizeobj['thumbnails']
790                     thumbnail_dest_img = dest_dir + '/' + make_dest_filename(video.sub(/\.[^\.]+$/, '')) + "-#{size_thumbnails}.jpg"
791                     thumbnail_videos[sizeobj['name']] << File.basename(thumbnail_dest_img)
792                     todo << { 'filename' => thumbnail_dest_img, 'size' => size_thumbnails }
793                 end
794                 gen_thumbnails_element("#{dir}/#{video}", xmldir, true, todo)
795             end
796             destvideo = "#{dest_dir}/#{video}"
797             if !File.exists?(destvideo)
798                 psys("cp '#{dir}/#{video}' '#{destvideo}'")
799             end
800         }
801
802         if !$forgui
803             themestuff = Dir.entries("#{$FPATH}/themes/#{$theme}").
804                              find_all { |e| !%w(. .. skeleton_image.html skeleton_thumbnails.html skeleton_index.html metadata CVS).include?(e) }
805
806             #- cleanup old images/videos (for when removing elements or sizes)
807             all_elements = fullscreen_images.collect { |e| e[1] }.flatten.
808                      concat(thumbnail_images.collect { |e| e[1] }.flatten).
809                      concat(thumbnail_videos.collect { |e| e[1] }.flatten).
810                      concat(videos)
811             to_del = Dir.entries(dest_dir).find_all { |e| !File.directory?("#{dest_dir}/#{e}") && !all_elements.include?(e) && e !~ /^thumbnails-\w+\.jpg/ } - themestuff
812             if to_del.size > 0
813                 msg 3, _("\tcleaning up: #{to_del.join(', ')}")
814                 system("rm -f " + to_del.collect { |e| "#{dest_dir}/#{e}" }.join(' '))
815             end
816
817             #- copy any resource file that goes with the theme (css, images..)
818             themestuff.each { |entry|
819                 if !File.exists?("#{dest_dir}/#{entry}")
820                     psys("cp '#{$FPATH}/themes/#{$theme}/#{entry}' '#{dest_dir}'")
821                 end
822             }
823
824             #- generate .htaccess file if needed
825             if auth_user_file = xmldir.attributes['password-protect']
826                 msg 3, _("\tgenerating password protection file #{dest_dir}/.htaccess")
827                 ios = File.open("#{dest_dir}/.htaccess", "w")
828                 ios.write("AuthType Basic\nAuthName \"protected area\"\nAuthUserFile #{auth_user_file}\nrequire valid-user\n")
829                 ios.close
830             end
831
832             msg 3, _("\tgenerating HTML pages...")
833
834             #- generate thumbnails.html (page with thumbnails)
835             for sizeobj in $images_size
836                 info("processing size")
837                 html = $html_thumbnails.collect { |l| l.clone }
838                 iterations = {}
839                 for i in html
840                     i.sub!(/~~run_slideshow~~/, images.size <= 1 ? '' : '<a href="image-' + size2js(sizeobj['name']) + '.html#run_slideshow=1">' + utf8(_('Run slideshow!'))+'</a>')
841                     i.sub!(/~~title~~/, xmldir.attributes['thumbnails-caption'] || utf8(File.basename(dir)))
842                     substitute_html_sizes(i, sizeobj, 'thumbnails')
843                     discover_iterations(iterations, i)
844                 end
845                 html_thumbnails = ''
846                 reset_iterations(iterations)
847                 for file in entries
848                     type = images.include?(file) ? 'image' : videos.include?(file) ? 'video' : nil
849                     if type
850                         if type == 'image' && elem = xmldir.elements["image[@filename='#{utf8(file)}']"]
851                             if  pano = pano_amount(elem)
852                                 html_thumbnails += run_iterations(iterations, pano)
853                                 html_thumbnails.gsub!(/~~colspan~~/) { 'colspan="' + pano.ceil.to_s + '"' }
854                             else
855                                 html_thumbnails += run_iterations(iterations, 1)
856                                 html_thumbnails.gsub!(/~~colspan~~/, '')
857                             end
858                         else 
859                             html_thumbnails += run_iterations(iterations, 1)
860                             html_thumbnails.gsub!(/~~colspan~~/, '')
861                         end
862                         if type == 'image'
863                             index = images.index(file)
864                             html_thumbnails.gsub!(/~~image_iteration~~/,
865                                                   '<a href="image-' + size2js(sizeobj['name']) + '.html#current=' + fullscreen_images[sizeobj['name']][index] +
866                                                       '" name="' + fullscreen_images[sizeobj['name']][index] + '">' +
867                                                       img_element("#{dest_dir}/#{thumbnail_images[sizeobj['name']][index]}") + '</a>')
868                             html_thumbnails.gsub!(/~~caption_iteration~~/,
869                                                   find_caption_value(xmldir, images[index]) || utf8(images[index]))
870                             html_thumbnails.gsub!(/~~ifimage\?~~(.+?)~~fi~~/) { $1 }
871                             html_thumbnails.gsub!(/~~ifvideo\?~~(.+?)~~fi~~/, '')
872                         elsif type == 'video'
873                             index = videos.index(file)
874                             if File.exists?("#{dest_dir}/#{thumbnail_videos[sizeobj['name']][index]}")
875                                 html_thumbnails.gsub!(/~~image_iteration~~/,
876                                                       '<a href="' + videos[index] + '">' + img_element("#{dest_dir}/#{thumbnail_videos[sizeobj['name']][index]}") + '</a>')
877                             else
878                                 html_thumbnails.gsub!(/~~image_iteration~~/,
879                                                       '<a href="' + videos[index] + '">' + utf8(_("(no preview)")) + '</a>')
880                             end
881                             html_thumbnails.gsub!(/~~caption_iteration~~/,
882                                                   find_caption_value(xmldir, videos[index]) || utf8(videos[index]))
883                             html_thumbnails.gsub!(/~~ifimage\?~~(.+?)~~fi~~/, '')
884                             html_thumbnails.gsub!(/~~ifvideo\?~~(.+?)~~fi~~/) { $1 }
885                         end
886                     end
887                 end
888                 html_thumbnails += close_iterations(iterations)
889                 for i in html
890                     i.sub!(/~~thumbnails~~/, html_thumbnails)
891                     i.gsub!(/~~theme~~/, $theme)
892                     i.gsub!(/~~current_size~~/, sizeobj['name'])
893                     i.gsub!(/~~current_size_js~~/, size2js(sizeobj['name']))
894                     i.gsub!(/~~madewith~~/, $madewith || '')
895                 end
896                 ios = File.open("#{dest_dir}/thumbnails-#{size2js(sizeobj['name'])}.html", "w")
897                 ios.write(html)
898                 ios.close
899             end
900
901             info("finished processing sizes")
902
903             #- generate "main" thumbnails.html page that will reload to correct size thanks to cookie
904             ios = File.open("#{dest_dir}/thumbnails.html", "w")
905             ios.write(html_reload_to_thumbnails)
906             ios.close
907
908             #- generate image.html (page with fullscreen images)
909             if images.size > 0
910                 captions4js = find_captions(xmldir, images).collect { |e| e ? '"' + e.gsub('"', '\"') + '"' : '""' }.join(', ')
911
912                 for sizeobj in $images_size
913                     html = $html_images.collect { |l| l.clone }
914                     images4js = fullscreen_images[sizeobj['name']].collect { |e| "\"#{e}\"" }.join(', ')
915                     otherimages4js = ''
916                     othersizes = []
917                     for sizeobj2 in all_images_sizes
918                         if sizeobj != sizeobj2
919                             otherimages4js += "var images_#{size2js(sizeobj2['name'])} = new Array(" + fullscreen_images[sizeobj2['name']].collect { |e| "\"#{e}\"" }.join(', ') + ")\n"
920                             othersizes << "\"#{size2js(sizeobj2['name'])}\""
921                         end
922                     end
923                     for i in html
924                         i.gsub!(/~~images~~/, images4js)
925                         i.gsub!(/~~other_images~~/, otherimages4js)
926                         i.gsub!(/~~other_sizes~~/, othersizes.join(', '))
927                         i.gsub!(/~~captions~~/, captions4js)
928                         i.gsub!(/~~title~~/, xmldir.attributes['thumbnails-caption'] || utf8(File.basename(dir)))
929                         i.gsub!(/~~thumbnails~~/, '<a href="thumbnails-' + size2js(sizeobj['name']) + '.html" id="thumbnails">' + utf8(_('return to thumbnails')) + '</a>')
930                         i.gsub!(/~~theme~~/, $theme)
931                         i.gsub!(/~~current_size~~/, size2js(sizeobj['name']))
932                         i.gsub!(/~~madewith~~/, $madewith || '')
933                         substitute_html_sizes(i, sizeobj, 'image')
934                     end
935                     ios = File.open("#{dest_dir}/image-#{size2js(sizeobj['name'])}.html", "w")
936                     ios.write(html)
937                     ios.close
938                 end
939             end
940         end
941     }
942
943     msg 3, ''
944
945     #- add attributes to <dir..> elements needing so
946     if $mode != 'use_config'
947         msg 3, _("\tfixating configuration file...")
948         $xmldoc.elements.each('//dir') { |element|
949             path = captionpath = element.attributes['path']
950             descendant_element = element.elements['descendant::image'] || element.elements['descendant::video']
951             if !descendant_element
952                 msg 3, _("\t\tremoving %s, no element in it") % path
953                 element.remove  #- means we have a directory with nothing interesting in it
954             else
955                 captionfile = "#{descendant_element.parent.attributes['path']}/#{descendant_element.attributes['filename']}"
956                 basename = File.basename(path)
957                 if element.elements['dir']
958                     if !element.attributes['subdirs-caption']
959                         element.add_attribute('subdirs-caption', basename)
960                     end
961                     if !element.attributes['subdirs-captionfile']
962                         element.add_attribute('subdirs-captionfile', captionfile)
963                     end
964                 end
965                 if element.child_byname_notattr('image', 'deleted') || element.child_byname_notattr('video', 'deleted')
966                     if !element.attributes['thumbnails-caption']
967                         element.add_attribute('thumbnails-caption', basename)
968                     end
969                     if !element.attributes['thumbnails-captionfile']
970                         element.add_attribute('thumbnails-captionfile', captionfile)
971                     end
972                 end
973             end
974         }
975     end
976
977     #- write down to disk config if necessary
978     if $config_writeto
979         ios = File.open($config_writeto, "w")
980         $xmldoc.write(ios, 0)
981         ios.close
982     end
983
984     if $forgui
985         msg 3, _(" completed necessary stuff for GUI, exiting.")
986         return
987     end
988
989     #- second pass to create index.html files and previous/next links
990     info("creating index.html")
991     msg 3, _("\trescanning directories to generate all `index.html' files...")
992
993     #- recompute the memoization because elements mights have been removed (the ones with no element in them)
994     optxpath = {}
995     $xmldoc.elements.each('//dir') { |elem|
996         optxpath[elem.attributes['path']] = elem
997     }
998
999     examined_dirs.each { |dir|
1000         dir.chomp!
1001         info("index.html: #{dir}|#{$source}")
1002
1003         xmldir = optxpath[utf8(dir)]
1004         if !xmldir || (xmldir.attributes['already-generated'] && !$force) || xmldir.attributes['deleted']
1005             next
1006         end
1007         dest_dir = make_dest_filename(dir.sub(/^#{Regexp.quote($source)}/, $dest))
1008
1009         previous_album = find_previous_album(xmldir)
1010         next_album = find_next_album(xmldir)
1011
1012         if xmldir.elements['dir']
1013             html = $html_index.collect { |l| l.clone }
1014             iterations = {}
1015             for i in html
1016                 caption = xmldir.attributes['subdirs-caption']
1017                 i.gsub!(/~~title~~/, caption)
1018                 if xmldir.parent.name == 'dir'
1019                     nav = ''
1020                     path = '..'
1021                     parent = xmldir.parent
1022                     while parent.name == 'dir'
1023                         parentcaption = parent.attributes['subdirs-caption']
1024                         nav = "<a href='#{path}/index.html'>#{parentcaption}</a> #{utf8(_(" > "))} #{nav}"
1025                         path += '/..'
1026                         parent = parent.parent
1027                     end
1028                     i.gsub!(/~~ifnavigation\?~~(.+?)~~fi~~/) { $1 }
1029                     i.gsub!(/~~navigation~~/, nav + caption)
1030                 else
1031                     i.gsub!(/~~ifnavigation\?~~(.+?)~~fi~~/, '')
1032                 end
1033                 discover_iterations(iterations, i)
1034             end
1035             
1036             html_index = ''
1037             reset_iterations(iterations)
1038             
1039             #- deal with "current" album (directs to "thumbnails" page)
1040             if xmldir.attributes['thumbnails-caption']
1041                 thumbnail = "#{dest_dir}/thumbnails-thumbnail.jpg"
1042                 gen_thumbnails_subdir(from_utf8(xmldir.attributes['thumbnails-captionfile']), xmldir, false,
1043                                       [ { 'filename' => thumbnail, 'size' => $albums_thumbnail_size } ], 'thumbnails')
1044                 html_index += run_iterations(iterations, 1)
1045                 html_index.gsub!(/~~image_iteration~~/, "<a href='thumbnails.html'>" + img_element(thumbnail) + '</a>')
1046                 html_index.gsub!(/~~caption_iteration~~/, xmldir.attributes['thumbnails-caption'])
1047             end
1048
1049             #- deal with sub-albums (direct to subdirs/index.html pages)
1050             xmldir.elements.each('dir') { |child|
1051                 if child.attributes['deleted']
1052                     next
1053                 end
1054                 subdir = make_dest_filename(from_utf8(File.basename(child.attributes['path'])))
1055                 thumbnail = "#{dest_dir}/thumbnails-#{subdir}.jpg"
1056                 html_index += run_iterations(iterations, 1)
1057                 captionfile, caption = find_subalbum_caption_info(child)
1058                 gen_thumbnails_subdir(captionfile, child, false,
1059                                       [ { 'filename' => thumbnail, 'size' => $albums_thumbnail_size } ], find_subalbum_info_type(child))
1060                 html_index.gsub!(/~~caption_iteration~~/, caption)
1061                 html_index.gsub!(/~~image_iteration~~/, "<a href='#{make_dest_filename(subdir)}/index.html'>" + img_element(thumbnail) + '</a>')
1062             }
1063
1064             html_index += close_iterations(iterations)
1065
1066             for i in html
1067                 i.gsub!(/~~thumbnails~~/, html_index)
1068                 i.gsub!(/~~madewith~~/, $madewith || '')
1069             end
1070             
1071         else
1072             html = html_reload_to_thumbnails
1073         end
1074
1075         ios = File.open("#{dest_dir}/index.html", "w")
1076         ios.write(html)
1077         ios.close
1078
1079         #- substitute "return to albums" and previous/next correctly
1080         if xmldir.child_byname_notattr('image', 'deleted') || xmldir.child_byname_notattr('video', 'deleted')
1081             for sizeobj in $images_size
1082                 substInFile("#{dest_dir}/thumbnails-#{size2js(sizeobj['name'])}.html") { |line|
1083                     sub_previous_next_album(previous_album, next_album, line)
1084                     if xmldir.elements['dir']
1085                         line.sub!(/~~return_to_albums~~/, '<a href="index.html">' + utf8(_('return to albums')) + '</a>')
1086                     else
1087                         if xmldir.parent.name == 'dir'
1088                             line.sub!(/~~return_to_albums~~/, '<a href="../index.html">' + utf8(_('return to albums')) + '</a>')
1089                         else
1090                             line.sub!(/~~return_to_albums~~/, '')
1091                         end
1092                     end
1093                     line
1094                 }
1095                 if xmldir.child_byname_notattr('image', 'deleted')
1096                     substInFile("#{dest_dir}/image-#{size2js(sizeobj['name'])}.html") { |line|
1097                         sub_previous_next_album(previous_album, next_album, line)
1098                     }
1099                 end
1100             end
1101         end
1102     }
1103
1104     msg 3, _(" all done.")
1105 end
1106
1107 handle_options
1108 read_config
1109 check_installation
1110
1111 build_html_skeletons
1112
1113 walk_source_dir