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