6b55ce4e0265fe5aea5e090b69c936466310c789
[booh] / lib / booh / booh-lib.rb
1 #                         *  BOOH  *
2 #
3 # A.k.a `Best web-album Of the world, Or your money back, Humerus'.
4 #
5 # The acronyn sucks, however this is a tribute to Dragon Ball by
6 # Akira Toriyama, where the last enemy beaten by heroes of Dragon
7 # Ball is named "Boo". But there was already a free software project
8 # called Boo, so this one will be it "Booh". Or whatever.
9 #
10 #
11 # Copyright (c) 2004-2009 Guillaume Cottenceau
12 #
13 # This software may be freely redistributed under the terms of the GNU
14 # public license version 2.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20 require 'iconv'
21 require 'timeout'
22 require 'tempfile'
23 require 'monitor'
24
25 require 'booh/rexml/document'
26
27 require 'gettext'
28 include GetText
29 bindtextdomain("booh")
30
31 require 'booh/config.rb'
32 require 'booh/version.rb'
33 begin
34     require 'gtk2'
35 rescue LoadError
36     $no_gtk2 = true
37 end
38 begin
39     require 'booh/libadds'
40 rescue LoadError
41     $no_libadds = true
42 end
43
44 module Booh
45     $verbose_level = 2
46     $CURRENT_CHARSET = `locale charmap`.chomp
47     #- check charset availability. a locale configuration of C or POSIX yields the unsupported 'ANSI_X3.4-1968'.
48     begin
49         REXML::XMLDecl.new(REXML::XMLDecl::DEFAULT_VERSION, $CURRENT_CHARSET)
50     rescue
51         $CURRENT_CHARSET = 'UTF-8'
52     end
53     $convert = 'convert -interlace line +profile "*"'
54     $convert_enhance = '-contrast -enhance -normalize'
55
56     def utf8(string)
57         return Iconv::iconv("UTF-8", $CURRENT_CHARSET, string).to_s
58     end
59
60     def utf8cut(string, maxlen)
61         begin
62             return Iconv::iconv("UTF-8", $CURRENT_CHARSET, string[0..maxlen-1]).to_s
63         rescue Iconv::InvalidCharacter
64             return utf8cut(string, maxlen-1)
65         end
66     end
67
68     def sizename(key, translate)
69         #- fake for gettext to find these; if themes need more sizes, english name for them should be added here
70         sizenames = { 'small' => N_("small"), 'medium' => N_("medium"), 'large' => N_("large"),
71                       'x-large' => N_("x-large"), 'xx-large' => N_("xx-large"),
72                       'original' => N_("original") }
73         sizename = sizenames[key] || key
74         if translate
75             return utf8(_(sizename))
76         else
77             return sizename
78         end
79     end
80
81     SUPPORTED_LANGUAGES = %w(en de fr ja eo)
82
83     def langname(lang)
84         langnames = { 'en' => _("english"), 'de' => _("german"), 'fr' => _("french"), 'ja' => _("japanese"), 'eo' => _("esperanto") }
85         return langnames[lang]
86     end
87     
88     def from_utf8(string)
89         return Iconv::iconv($CURRENT_CHARSET, "UTF-8", string).to_s
90     end
91
92     def from_utf8_safe(string)
93         begin
94             return Iconv::iconv($CURRENT_CHARSET, "UTF-8", string).to_s
95         rescue Iconv::IllegalSequence
96             return ''
97         end
98     end
99
100     def make_dest_filename_old(orig_filename)
101         #- we remove non alphanumeric characters but need to do that
102         #- cleverly to not end up with two similar dest filenames. we won't
103         #- urlencode because urldecode might happen in the browser.
104         return orig_filename.unpack("C*").collect { |v| v.chr =~ /[a-zA-Z\-_0-9\.\/]/ ? v.chr : sprintf("%2X", v) }.to_s
105     end
106
107     def make_dest_filename(orig_filename)
108         #- we remove non alphanumeric characters but need to do that
109         #- cleverly to not end up with two similar dest filenames. we won't
110         #- urlencode because urldecode might happen in the browser.
111         return orig_filename.unpack("C*").collect { |v| v.chr =~ /[a-zA-Z\-_0-9\.\/]/ ? v.chr : sprintf("~%02X", v) }.to_s
112     end
113
114     def msg(verbose_level, msg)
115         if verbose_level <= $verbose_level
116             if verbose_level == 0
117                 warn _("\t***ERROR***: %s\n") % msg
118             elsif verbose_level == 1
119                 warn _("\tWarning: %s\n") % msg
120             else
121                 puts msg
122             end
123         end
124     end
125
126     def msg_(verbose_level, msg)
127         if verbose_level <= $verbose_level
128             if verbose_level == 0
129                 warn _("\t***ERROR***: %s") % msg
130             elsif verbose_level == 1
131                 warn _("\tWarning: %s") % msg
132             else
133                 print msg
134             end
135         end
136     end
137
138     def die_(msg)
139         puts msg
140         exit 1
141     end
142
143     def select_theme(name, limit_sizes, optimizefor32, nperrow)
144         $theme = name
145         msg 3, _("Selecting theme '%s'") % $theme
146         $themedir = "#{$FPATH}/themes/#{$theme}"
147         if !File.directory?($themedir)
148             themedir2 = File.expand_path("~/.booh-themes/#{$theme}")
149             if !File.directory?(themedir2)
150                 die_ _("Theme was not found (tried %s and %s directories).") % [ $themedir, themedir2 ]
151             end
152             $themedir = themedir2
153         end
154         eval File.open("#{$themedir}/metadata/parameters.rb").readlines.join
155
156         if limit_sizes
157             if limit_sizes != 'all'
158                 sizes = limit_sizes.split(/,/)
159                 $images_size = $images_size.find_all { |e| sizes.include?(e['name']) }
160                 if $images_size.length == 0
161                     die_ _("Can't carry on, no valid size selected.")
162                 end
163             end
164         else
165             $images_size = $images_size.find_all { |e| !e['optional'] }
166         end
167
168         if optimizefor32
169             $images_size.each { |e|
170                 e['fullscreen'].gsub!(/(\d+x)(\d+)/) { $1 + ($2.to_f*8/9).to_i.to_s }
171                 e['thumbnails'].gsub!(/(\d+x)(\d+)/) { $1 + ($2.to_f*8/9).to_i.to_s }
172             }
173             $albums_thumbnail_size.gsub!(/(\d+x)(\d+)/) { $1 + ($2.to_f*8/9).to_i.to_s }
174         end
175
176         if nperrow && nperrow != $default_N
177             ratio = nperrow.to_f / $default_N.to_f
178             $images_size.each { |e|
179                 e['thumbnails'].gsub!(/(\d+)x(\d+)/) { ($1.to_f/ratio).to_i.to_s + 'x' + ($2.to_f/ratio).to_i.to_s }
180             }
181         end
182
183         $default_size = $images_size.detect { |sizeobj| sizeobj['default'] }
184         if $default_size == nil
185             $default_size = $images_size[0]
186         end
187     end
188
189     def entry2type(entry)
190         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-bmp.so
191         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-gif.so
192         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-ico.so
193         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-jpeg.so
194         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-png.so
195         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-pnm.so
196         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-ras.so
197         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-tiff.so
198         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-xbm.so
199         #- /usr/lib/gdk-pixbuf/loaders/libpixbufloader-xpm.so
200         if entry =~ /\.(bmp|gif|ico|jpg|jpe|png|pnm|tif|xbm|xpm)$/i && entry !~ /['"\[\]]/
201             return 'image'
202         elsif !$ignore_videos && entry =~ /\.(mov|avi|mpg|mpeg|mpe|wmv|asx|3gp|mp4)$/i && entry !~ /['"\[\]]/
203             #- might consider using file magic later..
204             return 'video'
205         else
206             return nil
207         end
208     end
209
210     def sys(cmd)
211         msg 2, cmd
212         system(cmd)
213     end
214
215     def waitjob
216         finished = Process.wait2
217         $pids.delete(finished[0])
218         $pids = $pids.find_all { |pid| Process.waitpid(pid, Process::WNOHANG) == nil }
219     end
220
221     def waitjobs
222         while $pids && $pids.length > 0
223             waitjob
224         end
225     end
226
227     #- parallelizable sys
228     def psys(cmd)
229         if $mproc
230             if pid = fork
231                 $pids << pid
232             else
233                 msg 2, cmd + ' &'
234                 system(cmd)
235                 exit 0
236             end
237             if $pids.length == $mproc
238                 waitjob
239             end
240         else
241             sys(cmd)
242         end
243     end
244
245     def get_image_size(fullpath)
246         if !$no_identify
247             if $sizes_cache.nil?
248                 $sizes_cache = {}
249             end
250             if $sizes_cache[fullpath].nil?
251                 #- identify is slow, try with gdk if available (negligible vs 35ms)
252                 if $no_gtk2
253                     if `identify '#{fullpath}'` =~ / JPEG (\d+)x(\d+) /
254                         $sizes_cache[fullpath] = { :x => $1.to_i, :y => $2.to_i }
255                     end
256                 else
257                     format, width, height = Gdk::Pixbuf.get_file_info(fullpath)
258                     if width
259                         $sizes_cache[fullpath] = { :x => width, :y => height }
260                     end
261                 end
262             end
263             return $sizes_cache[fullpath]
264         else
265             return nil
266         end
267     end
268
269     #- commify from http://pleac.sourceforge.net/ (pleac rulz)
270     def commify(n)
271         n.to_s =~ /([^\.]*)(\..*)?/
272         int, dec = $1.reverse, $2 ? $2 : ""
273         sep = _(",")
274         while int.gsub!(/(#{Regexp.quote(sep)}|\.|^)(\d{3})(\d)/, '\1\2' + sep + '\3')
275         end
276         int.reverse + dec
277     end
278
279     def guess_rotate(filename)
280         #- identify is slow, try with libexiv2 if available (4ms vs 35ms)
281         if $no_libadds
282             if $no_identify
283                 return 0
284             end
285             orientation = `identify -format "%[EXIF:orientation]" '#{filename}'`.chomp.to_i
286         else
287             orientation = Exif.orientation(filename)
288         end
289
290         if orientation == 6
291             angle = 90
292         elsif orientation == 8
293             angle = -90
294         else
295             return 0
296         end
297
298         #- remove rotate if image is obviously already in portrait (situation can come from gthumb)
299         size = get_image_size(filename)
300         if size && size[:x] < size[:y]
301             return 0
302         else
303             return angle
304         end
305     end
306
307     def angle_to_exif_orientation(angle)
308         if angle == 90
309             return 6
310         elsif angle == 270 || angle == -90
311             return 8
312         else
313             return 0
314         end
315     end
316
317     def rotate_pixbuf(pixbuf, angle)
318         return pixbuf.rotate(angle ==  90 ? Gdk::Pixbuf::ROTATE_CLOCKWISE :
319                              angle == 180 ? Gdk::Pixbuf::ROTATE_UPSIDEDOWN :
320                              (angle == 270 || angle == -90) ? Gdk::Pixbuf::ROTATE_COUNTERCLOCKWISE :
321                                             Gdk::Pixbuf::ROTATE_NONE)
322     end
323
324     def gen_thumbnails_element(orig, xmldirorelem, allow_background, dests)
325         rexml_thread_protect {
326             if xmldirorelem.name == 'dir'
327                 xmldirorelem = xmldirorelem.elements["*[@filename='#{utf8(File.basename(orig))}']"]
328             end
329         }
330         gen_thumbnails(orig, allow_background, dests, xmldirorelem, '')
331     end
332
333     def gen_thumbnails_subdir(orig, xmldirorelem, allow_background, dests, type)
334         #- type can be `subdirs' or `thumbnails' 
335         gen_thumbnails(orig, allow_background, dests, xmldirorelem, type + '-')
336     end
337
338     def gen_video_thumbnail(orig, colorswap, seektime)
339         if colorswap
340             #- ignored for the moment. is mplayer subject to blue faces problem?
341         end
342         #- it's not possible to specify a basename for the output jpeg file with mplayer (file will be named 00000001.jpg); as this can
343         #- be called from multiple threads, we must come up with a unique directory where to put the file
344         tmpfile = Tempfile.new("boohvideotmp")
345         Thread.critical = true
346         tmpdirname = tmpfile.path
347         tmpfile.close!
348         begin
349             Dir.mkdir(tmpdirname)
350         rescue Errno::EEXIST
351             raise "Tmp directory #{tmpdirname} already exists"
352         ensure
353             Thread.critical = false
354         end
355         cmd = "mplayer '#{orig}' -nosound -vo jpeg:outdir='#{tmpdirname}' -frames 1 -ss #{seektime} -slave >/dev/null 2>/dev/null"
356         sys(cmd)
357         if ! File.exists?("#{tmpdirname}/00000001.jpg")
358             msg 0, _("specified seektime too large? that may also be another probleme. try another value.")
359             Dir.rmdir(tmpdirname)
360             return nil
361         end
362         return tmpdirname
363     end
364
365     def gen_thumbnails(orig, allow_background, dests, felem, attributes_prefix)
366         if !dests.detect { |dest| !File.exists?(dest['filename']) } 
367             return true
368         end
369
370         convert_options = ''
371         dest_dir = make_dest_filename(File.dirname(dests[0]['filename']))
372
373         if entry2type(orig) == 'image'
374             if felem
375                 if whitebalance = rexml_thread_protect { felem.attributes["#{attributes_prefix}white-balance"] }
376                     neworig = "#{dest_dir}/#{File.basename(orig)}-whitebalance#{whitebalance}.jpg"
377                     cmd = "booh-fix-whitebalance '#{orig}' '#{neworig}' #{whitebalance}"
378                     sys(cmd)
379                     if File.exists?(neworig)
380                         orig = neworig
381                     end
382                 end
383                 if gammacorrect = rexml_thread_protect { felem.attributes["#{attributes_prefix}gamma-correction"] }
384                     neworig = "#{dest_dir}/#{File.basename(orig)}-gammacorrect#{gammacorrect}.jpg"
385                     cmd = "booh-gamma-correction '#{orig}' '#{neworig}' #{gammacorrect}"
386                     sys(cmd)
387                     if File.exists?(neworig)
388                         orig = neworig
389                     end
390                 end
391                 rotate = rexml_thread_protect { felem.attributes["#{attributes_prefix}rotate"] }
392                 if !rotate
393                     rexml_thread_protect { felem.add_attribute("#{attributes_prefix}rotate", rotate = guess_rotate(orig).to_s) }
394                 end
395                 convert_options += "-rotate #{rotate} "
396                 if rexml_thread_protect { felem.attributes["#{attributes_prefix}enhance"] }
397                     convert_options += ($config['convert-enhance'] || $convert_enhance) + " "
398                 end
399             end
400             for dest in dests
401                 if !File.exists?(dest['filename'])
402                     cmd = nil
403                     cmd ||= "#{$convert} #{convert_options}-size #{dest['size']} -resize '#{dest['size']}>' '#{orig}' '#{dest['filename']}'"
404                     if allow_background
405                         psys(cmd)
406                     else
407                         sys(cmd)
408                     end
409                 end
410             end
411             if neworig
412                 if allow_background
413                     waitjobs
414                 end
415                 begin
416                     File.delete(neworig)
417                 rescue Errno::ENOENT
418                     #- can happen on race conditions for generating multiple times a thumbnail for a given image. for the moment,
419                     #- silently ignore, it is not a so big deal.
420                 end
421             end
422             return true
423
424         elsif entry2type(orig) == 'video'
425             if felem
426                 #- seektime is an attribute that allows to specify where the frame to use for the thumbnail must be taken
427                 seektime = rexml_thread_protect { felem.attributes["#{attributes_prefix}seektime"] }
428                 if ! seektime
429                     rexml_thread_protect { felem.add_attribute("#{attributes_prefix}seektime", seektime = "0") }
430                 end
431                 seektime = seektime.to_f
432                 if rotate = rexml_thread_protect { felem.attributes["#{attributes_prefix}rotate"] }
433                     convert_options += "-rotate #{rotate} "
434                 end
435                 if rexml_thread_protect { felem.attributes["#{attributes_prefix}enhance"] }
436                     convert_options += ($config['convert-enhance'] || $convert_enhance) + " "
437                 end
438             end
439             for dest in dests
440                 if ! File.exists?(dest['filename'])
441                     tmpdir = gen_video_thumbnail(orig, felem && rexml_thread_protect { felem.attributes["#{attributes_prefix}color-swap"] }, seektime)
442                     if tmpdir.nil?
443                         return false
444                     end
445                     tmpfile = "#{tmpdir}/00000001.jpg"
446                     alltmpfiles = [ tmpfile ]
447                     if felem && whitebalance = rexml_thread_protect { felem.attributes["#{attributes_prefix}white-balance"] }
448                         if whitebalance.to_f != 0
449                             neworig = "#{tmpdir}/whitebalance#{whitebalance}.jpg"
450                             cmd = "booh-fix-whitebalance '#{tmpfile}' '#{neworig}' #{whitebalance}"
451                             sys(cmd)
452                             if File.exists?(neworig)
453                                 tmpfile = neworig
454                                 alltmpfiles << neworig
455                             end
456                         end
457                     end
458                     if felem && gammacorrect = rexml_thread_protect { felem.attributes["#{attributes_prefix}gamma-correction"] }
459                         if gammacorrect.to_f != 0
460                             neworig = "#{tmpdir}/gammacorrect#{gammacorrect}.jpg"
461                             cmd = "booh-gamma-correction '#{tmpfile}' '#{neworig}' #{gammacorrect}"
462                             sys(cmd)
463                             if File.exists?(neworig)
464                                 tmpfile = neworig
465                                 alltmpfiles << neworig
466                             end
467                         end
468                     end
469                     sys("#{$convert} #{convert_options}-size #{dest['size']} -resize #{dest['size']} '#{tmpfile}' '#{dest['filename']}'")
470                     alltmpfiles.each { |file| File.delete(file) }
471                     Dir.rmdir(tmpdir)
472                 end
473             end
474             return true
475         end
476     end
477
478     def invornil(obj, methodname)
479         if obj == nil
480             return nil
481         else
482             return obj.method(methodname).call
483         end
484     end
485
486     def find_subalbum_info_type(xmldir)
487         #- first look for subdirs info; if not, means there is no subdir
488         if xmldir.attributes['subdirs-caption']
489             return 'subdirs'
490         else
491             return 'thumbnails'
492         end
493     end
494
495     def find_subalbum_caption_info(xmldir)
496         type = find_subalbum_info_type(xmldir)
497         return [ from_utf8(xmldir.attributes["#{type}-captionfile"]), xmldir.attributes["#{type}-caption"] ]
498     end
499
500     def file_size(path)
501         begin
502             return File.size(path)
503         rescue
504             return -1
505         end
506     end
507
508     def max(a, b)
509         a > b ? a : b
510     end
511
512     def clamp(n, a, b)
513         n < a ? a : n > b ? b : n
514     end
515
516     def pano_amount(elem)
517         if pano_amount = elem.attributes['pano-amount']
518             if $N_per_row
519                 return clamp(pano_amount.to_f, 1, $N_per_row.to_i)
520             else
521                 return clamp(pano_amount.to_f, 1, $default_N.to_i)
522             end
523         else
524             return nil
525         end
526     end
527
528     def substInFile(name)
529         newcontent = IO.readlines(name).collect { |l| yield l }
530         ios = File.open(name, "w")
531         ios.write(newcontent)
532         ios.close
533     end
534
535     $xmlaccesslock = Monitor.new
536
537     def rexml_thread_protect(&proc)
538         $xmlaccesslock.synchronize {
539             proc.call
540         }
541     end
542
543     def check_browser
544         browser_binary = $config['browser'].split.first
545         if browser_binary && !File.executable?(browser_binary)
546             show_popup($main_window, utf8(_("The configured browser seems to be unavailable.
547 You should fix this in Edit/Preferences so that you can open URLs.
548
549 Problem was: '%s' is not an executable file.") % browser_binary), { :pos_centered => true, :not_transient => true })
550             return false
551         else
552             return true
553         end
554     end
555
556     def open_url(url)
557         if check_browser
558             cmd = $config['browser'].gsub('%f', "'#{url}'") + ' &'
559             msg 2, cmd
560             system(cmd)
561         end
562     end
563
564     def get_license
565         return <<"EOF"
566                     GNU GENERAL PUBLIC LICENSE
567                        Version 2, June 1991
568
569  Copyright (C) 1989, 1991 Free Software Foundation, Inc.
570                           675 Mass Ave, Cambridge, MA 02139, USA
571  Everyone is permitted to copy and distribute verbatim copies
572  of this license document, but changing it is not allowed.
573
574                             Preamble
575
576   The licenses for most software are designed to take away your
577 freedom to share and change it.  By contrast, the GNU General Public
578 License is intended to guarantee your freedom to share and change free
579 software--to make sure the software is free for all its users.  This
580 General Public License applies to most of the Free Software
581 Foundation's software and to any other program whose authors commit to
582 using it.  (Some other Free Software Foundation software is covered by
583 the GNU Library General Public License instead.)  You can apply it to
584 your programs, too.
585
586   When we speak of free software, we are referring to freedom, not
587 price.  Our General Public Licenses are designed to make sure that you
588 have the freedom to distribute copies of free software (and charge for
589 this service if you wish), that you receive source code or can get it
590 if you want it, that you can change the software or use pieces of it
591 in new free programs; and that you know you can do these things.
592
593   To protect your rights, we need to make restrictions that forbid
594 anyone to deny you these rights or to ask you to surrender the rights.
595 These restrictions translate to certain responsibilities for you if you
596 distribute copies of the software, or if you modify it.
597
598   For example, if you distribute copies of such a program, whether
599 gratis or for a fee, you must give the recipients all the rights that
600 you have.  You must make sure that they, too, receive or can get the
601 source code.  And you must show them these terms so they know their
602 rights.
603
604   We protect your rights with two steps: (1) copyright the software, and
605 (2) offer you this license which gives you legal permission to copy,
606 distribute and/or modify the software.
607
608   Also, for each author's protection and ours, we want to make certain
609 that everyone understands that there is no warranty for this free
610 software.  If the software is modified by someone else and passed on, we
611 want its recipients to know that what they have is not the original, so
612 that any problems introduced by others will not reflect on the original
613 authors' reputations.
614
615   Finally, any free program is threatened constantly by software
616 patents.  We wish to avoid the danger that redistributors of a free
617 program will individually obtain patent licenses, in effect making the
618 program proprietary.  To prevent this, we have made it clear that any
619 patent must be licensed for everyone's free use or not licensed at all.
620
621   The precise terms and conditions for copying, distribution and
622 modification follow.
623
624
625                     GNU GENERAL PUBLIC LICENSE
626    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
627
628   0. This License applies to any program or other work which contains
629 a notice placed by the copyright holder saying it may be distributed
630 under the terms of this General Public License.  The "Program", below,
631 refers to any such program or work, and a "work based on the Program"
632 means either the Program or any derivative work under copyright law:
633 that is to say, a work containing the Program or a portion of it,
634 either verbatim or with modifications and/or translated into another
635 language.  (Hereinafter, translation is included without limitation in
636 the term "modification".)  Each licensee is addressed as "you".
637
638 Activities other than copying, distribution and modification are not
639 covered by this License; they are outside its scope.  The act of
640 running the Program is not restricted, and the output from the Program
641 is covered only if its contents constitute a work based on the
642 Program (independent of having been made by running the Program).
643 Whether that is true depends on what the Program does.
644
645   1. You may copy and distribute verbatim copies of the Program's
646 source code as you receive it, in any medium, provided that you
647 conspicuously and appropriately publish on each copy an appropriate
648 copyright notice and disclaimer of warranty; keep intact all the
649 notices that refer to this License and to the absence of any warranty;
650 and give any other recipients of the Program a copy of this License
651 along with the Program.
652
653 You may charge a fee for the physical act of transferring a copy, and
654 you may at your option offer warranty protection in exchange for a fee.
655
656   2. You may modify your copy or copies of the Program or any portion
657 of it, thus forming a work based on the Program, and copy and
658 distribute such modifications or work under the terms of Section 1
659 above, provided that you also meet all of these conditions:
660
661     a) You must cause the modified files to carry prominent notices
662     stating that you changed the files and the date of any change.
663
664     b) You must cause any work that you distribute or publish, that in
665     whole or in part contains or is derived from the Program or any
666     part thereof, to be licensed as a whole at no charge to all third
667     parties under the terms of this License.
668
669     c) If the modified program normally reads commands interactively
670     when run, you must cause it, when started running for such
671     interactive use in the most ordinary way, to print or display an
672     announcement including an appropriate copyright notice and a
673     notice that there is no warranty (or else, saying that you provide
674     a warranty) and that users may redistribute the program under
675     these conditions, and telling the user how to view a copy of this
676     License.  (Exception: if the Program itself is interactive but
677     does not normally print such an announcement, your work based on
678     the Program is not required to print an announcement.)
679
680
681 These requirements apply to the modified work as a whole.  If
682 identifiable sections of that work are not derived from the Program,
683 and can be reasonably considered independent and separate works in
684 themselves, then this License, and its terms, do not apply to those
685 sections when you distribute them as separate works.  But when you
686 distribute the same sections as part of a whole which is a work based
687 on the Program, the distribution of the whole must be on the terms of
688 this License, whose permissions for other licensees extend to the
689 entire whole, and thus to each and every part regardless of who wrote it.
690
691 Thus, it is not the intent of this section to claim rights or contest
692 your rights to work written entirely by you; rather, the intent is to
693 exercise the right to control the distribution of derivative or
694 collective works based on the Program.
695
696 In addition, mere aggregation of another work not based on the Program
697 with the Program (or with a work based on the Program) on a volume of
698 a storage or distribution medium does not bring the other work under
699 the scope of this License.
700
701   3. You may copy and distribute the Program (or a work based on it,
702 under Section 2) in object code or executable form under the terms of
703 Sections 1 and 2 above provided that you also do one of the following:
704
705     a) Accompany it with the complete corresponding machine-readable
706     source code, which must be distributed under the terms of Sections
707     1 and 2 above on a medium customarily used for software interchange; or,
708
709     b) Accompany it with a written offer, valid for at least three
710     years, to give any third party, for a charge no more than your
711     cost of physically performing source distribution, a complete
712     machine-readable copy of the corresponding source code, to be
713     distributed under the terms of Sections 1 and 2 above on a medium
714     customarily used for software interchange; or,
715
716     c) Accompany it with the information you received as to the offer
717     to distribute corresponding source code.  (This alternative is
718     allowed only for noncommercial distribution and only if you
719     received the program in object code or executable form with such
720     an offer, in accord with Subsection b above.)
721
722 The source code for a work means the preferred form of the work for
723 making modifications to it.  For an executable work, complete source
724 code means all the source code for all modules it contains, plus any
725 associated interface definition files, plus the scripts used to
726 control compilation and installation of the executable.  However, as a
727 special exception, the source code distributed need not include
728 anything that is normally distributed (in either source or binary
729 form) with the major components (compiler, kernel, and so on) of the
730 operating system on which the executable runs, unless that component
731 itself accompanies the executable.
732
733 If distribution of executable or object code is made by offering
734 access to copy from a designated place, then offering equivalent
735 access to copy the source code from the same place counts as
736 distribution of the source code, even though third parties are not
737 compelled to copy the source along with the object code.
738
739
740   4. You may not copy, modify, sublicense, or distribute the Program
741 except as expressly provided under this License.  Any attempt
742 otherwise to copy, modify, sublicense or distribute the Program is
743 void, and will automatically terminate your rights under this License.
744 However, parties who have received copies, or rights, from you under
745 this License will not have their licenses terminated so long as such
746 parties remain in full compliance.
747
748   5. You are not required to accept this License, since you have not
749 signed it.  However, nothing else grants you permission to modify or
750 distribute the Program or its derivative works.  These actions are
751 prohibited by law if you do not accept this License.  Therefore, by
752 modifying or distributing the Program (or any work based on the
753 Program), you indicate your acceptance of this License to do so, and
754 all its terms and conditions for copying, distributing or modifying
755 the Program or works based on it.
756
757   6. Each time you redistribute the Program (or any work based on the
758 Program), the recipient automatically receives a license from the
759 original licensor to copy, distribute or modify the Program subject to
760 these terms and conditions.  You may not impose any further
761 restrictions on the recipients' exercise of the rights granted herein.
762 You are not responsible for enforcing compliance by third parties to
763 this License.
764
765   7. If, as a consequence of a court judgment or allegation of patent
766 infringement or for any other reason (not limited to patent issues),
767 conditions are imposed on you (whether by court order, agreement or
768 otherwise) that contradict the conditions of this License, they do not
769 excuse you from the conditions of this License.  If you cannot
770 distribute so as to satisfy simultaneously your obligations under this
771 License and any other pertinent obligations, then as a consequence you
772 may not distribute the Program at all.  For example, if a patent
773 license would not permit royalty-free redistribution of the Program by
774 all those who receive copies directly or indirectly through you, then
775 the only way you could satisfy both it and this License would be to
776 refrain entirely from distribution of the Program.
777
778 If any portion of this section is held invalid or unenforceable under
779 any particular circumstance, the balance of the section is intended to
780 apply and the section as a whole is intended to apply in other
781 circumstances.
782
783 It is not the purpose of this section to induce you to infringe any
784 patents or other property right claims or to contest validity of any
785 such claims; this section has the sole purpose of protecting the
786 integrity of the free software distribution system, which is
787 implemented by public license practices.  Many people have made
788 generous contributions to the wide range of software distributed
789 through that system in reliance on consistent application of that
790 system; it is up to the author/donor to decide if he or she is willing
791 to distribute software through any other system and a licensee cannot
792 impose that choice.
793
794 This section is intended to make thoroughly clear what is believed to
795 be a consequence of the rest of this License.
796
797
798   8. If the distribution and/or use of the Program is restricted in
799 certain countries either by patents or by copyrighted interfaces, the
800 original copyright holder who places the Program under this License
801 may add an explicit geographical distribution limitation excluding
802 those countries, so that distribution is permitted only in or among
803 countries not thus excluded.  In such case, this License incorporates
804 the limitation as if written in the body of this License.
805
806   9. The Free Software Foundation may publish revised and/or new versions
807 of the General Public License from time to time.  Such new versions will
808 be similar in spirit to the present version, but may differ in detail to
809 address new problems or concerns.
810
811 Each version is given a distinguishing version number.  If the Program
812 specifies a version number of this License which applies to it and "any
813 later version", you have the option of following the terms and conditions
814 either of that version or of any later version published by the Free
815 Software Foundation.  If the Program does not specify a version number of
816 this License, you may choose any version ever published by the Free Software
817 Foundation.
818
819   10. If you wish to incorporate parts of the Program into other free
820 programs whose distribution conditions are different, write to the author
821 to ask for permission.  For software which is copyrighted by the Free
822 Software Foundation, write to the Free Software Foundation; we sometimes
823 make exceptions for this.  Our decision will be guided by the two goals
824 of preserving the free status of all derivatives of our free software and
825 of promoting the sharing and reuse of software generally.
826
827                             NO WARRANTY
828
829   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
830 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
831 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
832 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
833 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
834 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
835 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
836 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
837 REPAIR OR CORRECTION.
838
839   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
840 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
841 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
842 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
843 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
844 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
845 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
846 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
847 POSSIBILITY OF SUCH DAMAGES.
848 EOF
849     end
850
851     def call_about
852         Gtk::AboutDialog.set_url_hook { |dialog, url| open_url(url) }
853         Gtk::AboutDialog.show($main_window, { :name => 'booh',
854                                               :version => $VERSION,
855                                               :copyright => 'Copyright (c) 2005-2009 Guillaume Cottenceau',
856                                               :license => get_license,
857                                               :website => 'http://booh.org/',
858                                               :authors => [ 'Guillaume Cottenceau' ],
859                                               :artists => [ 'Ayo73' ],
860                                               :comments => utf8(_("''The Web-Album of choice for discriminating Linux users''")),
861                                               :translator_credits => utf8(_('Esperanto: Stephane Fillod
862 Japanese: Masao Mutoh
863 German: Roland Eckert
864 French: Guillaume Cottenceau')),
865                                               :logo => Gdk::Pixbuf.new("#{$FPATH}/images/logo.png") })
866     end
867
868     def smartsort(entries, sort_criterions)
869         #- sort "entries" according to "sort_criterions" but find a good fallback for all entries without a
870         #- criterion value (still next to the item they were next to)
871         sorted_entries = sort_criterions.keys.sort { |a,b| sort_criterions[a] <=> sort_criterions[b] }
872         for i in 0 .. entries.size - 1
873             if ! sorted_entries.include?(entries[i])
874                 j = i - 1
875                 while j > 0 && ! sorted_entries.include?(entries[j])
876                     j -= 1
877                 end
878                 sorted_entries[(sorted_entries.index(entries[j]) || -1 ) + 1, 0] = entries[i]
879             end
880         end
881         return sorted_entries
882     end
883
884     def defer_translation(msg)
885         return "@@#{msg}@@"
886     end
887
888     def create_window
889         w = Gtk::Window.new
890         w.icon_list = [ Gdk::Pixbuf.new("#{$FPATH}/images/booh-16x16.png"),
891                         Gdk::Pixbuf.new("#{$FPATH}/images/booh-32x32.png"),
892                         Gdk::Pixbuf.new("#{$FPATH}/images/booh-48x48.png") ]
893         return w
894     end
895
896 end
897
898 class Object
899     def to_b
900         if !self || self.to_s == 'false'
901             return false
902         else
903             return true
904         end
905     end
906 end
907
908 class File
909     def File.reduce_path(path)
910         return path.gsub(/\w+\/\.\.\//, '')
911     end
912 end
913
914 module Enumerable
915     def collect_with_index
916         out = []
917         each_with_index { |e,i|
918             out << yield(e,i)
919         }
920         return out
921     end
922 end
923
924 class Array
925     def sum
926         retval = 0
927         each { |v| retval += v.to_i }
928         return retval
929     end
930 end
931
932 class REXML::Element
933     def previous_element_byname(name)
934         n = self
935         while n = n.previous_element
936             if n.name == name
937                 return n
938             end
939         end
940         return nil
941     end
942
943     def previous_element_byname_notattr(name, attr)
944         n = self
945         while n = n.previous_element
946             if n.name == name && !n.attributes[attr]
947                 return n
948             end
949         end
950         return nil
951     end
952
953     def next_element_byname(name)
954         n = self
955         while n = n.next_element
956             if n.name == name
957                 return n
958             end
959         end
960         return nil
961     end
962
963     def next_element_byname_notattr(name, attr)
964         n = self
965         while n = n.next_element
966             if n.name == name && !n.attributes[attr]
967                 return n
968             end
969         end
970         return nil
971     end
972
973     def child_byname_notattr(name, attr)
974         elements.each(name) { |element|
975             if !element.attributes[attr]
976                 return element
977             end
978         }
979         return nil
980     end
981 end
982
983