cbead63b3ac86891af414a05223789e448c2fd37
[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.conv("UTF-8", $CURRENT_CHARSET, string)
59         rescue
60             return "???"
61         end
62     end
63
64     def utf8cut(string, maxlen)
65         begin
66             return Iconv.conv("UTF-8", $CURRENT_CHARSET, string[0..maxlen-1])
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.conv($CURRENT_CHARSET, "UTF-8", string)
96     end
97
98     def from_utf8_safe(string)
99         begin
100             return Iconv.conv($CURRENT_CHARSET, "UTF-8", string)
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     $video_thumbnail_directory_lock = Monitor.new
345
346     def gen_video_thumbnail(orig, colorswap, seektime)
347         if colorswap
348             #- ignored for the moment. is mplayer subject to blue faces problem?
349         end
350         #- it's not possible to specify a basename for the output jpeg file with mplayer (file will be named 00000001.jpg); as this can
351         #- be called from multiple threads, we must come up with a unique directory where to put the file
352         tmpfile = Tempfile.new("boohvideotmp")
353         $video_thumbnail_directory_lock.synchronize {
354             tmpdirname = tmpfile.path
355             tmpfile.close!
356             begin
357                 Dir.mkdir(tmpdirname)
358             rescue Errno::EEXIST
359                 raise "Tmp directory #{tmpdirname} already exists"
360             end
361         }
362         cmd = "mplayer '#{orig}' -nosound -vo jpeg:outdir='#{tmpdirname}' -frames 1 -ss #{seektime} -slave >/dev/null 2>/dev/null"
363         sys(cmd)
364         if ! File.exists?("#{tmpdirname}/00000001.jpg")
365             msg 0, _("specified seektime too large? that may also be another probleme. try another value.")
366             Dir.rmdir(tmpdirname)
367             return nil
368         end
369         return tmpdirname
370     end
371
372     def gen_thumbnails(orig, allow_background, dests, felem, attributes_prefix)
373         if !dests.detect { |dest| !File.exists?(dest['filename']) } 
374             return true
375         end
376
377         convert_options = ''
378         dest_dir = make_dest_filename(File.dirname(dests[0]['filename']))
379
380         if entry2type(orig) == 'image'
381             if felem
382                 if whitebalance = rexml_thread_protect { felem.attributes["#{attributes_prefix}white-balance"] }
383                     neworig = "#{dest_dir}/#{File.basename(orig)}-whitebalance#{whitebalance}.jpg"
384                     cmd = "booh-fix-whitebalance '#{orig}' '#{neworig}' #{whitebalance}"
385                     sys(cmd)
386                     if File.exists?(neworig)
387                         orig = neworig
388                     end
389                 end
390                 if gammacorrect = rexml_thread_protect { felem.attributes["#{attributes_prefix}gamma-correction"] }
391                     neworig = "#{dest_dir}/#{File.basename(orig)}-gammacorrect#{gammacorrect}.jpg"
392                     cmd = "booh-gamma-correction '#{orig}' '#{neworig}' #{gammacorrect}"
393                     sys(cmd)
394                     if File.exists?(neworig)
395                         orig = neworig
396                     end
397                 end
398                 rotate = rexml_thread_protect { felem.attributes["#{attributes_prefix}rotate"] }
399                 if !rotate
400                     rexml_thread_protect { felem.add_attribute("#{attributes_prefix}rotate", rotate = guess_rotate(orig).to_s) }
401                 end
402                 convert_options += "-rotate #{rotate} "
403                 if rexml_thread_protect { felem.attributes["#{attributes_prefix}enhance"] }
404                     convert_options += ($config['convert-enhance'] || $convert_enhance) + " "
405                 end
406             end
407             for dest in dests
408                 if !File.exists?(dest['filename'])
409                     cmd = nil
410                     cmd ||= "#{$convert} #{convert_options}-size #{dest['size']} -resize '#{dest['size']}>' '#{orig}' '#{dest['filename']}'"
411                     if allow_background
412                         psys(cmd)
413                     else
414                         sys(cmd)
415                     end
416                 end
417             end
418             if neworig
419                 if allow_background
420                     waitjobs
421                 end
422                 begin
423                     File.delete(neworig)
424                 rescue Errno::ENOENT
425                     #- can happen on race conditions for generating multiple times a thumbnail for a given image. for the moment,
426                     #- silently ignore, it is not a so big deal.
427                 end
428             end
429             return true
430
431         elsif entry2type(orig) == 'video'
432             if felem
433                 #- seektime is an attribute that allows to specify where the frame to use for the thumbnail must be taken
434                 seektime = rexml_thread_protect { felem.attributes["#{attributes_prefix}seektime"] }
435                 if ! seektime
436                     rexml_thread_protect { felem.add_attribute("#{attributes_prefix}seektime", seektime = "0") }
437                 end
438                 seektime = seektime.to_f
439                 if rotate = rexml_thread_protect { felem.attributes["#{attributes_prefix}rotate"] }
440                     convert_options += "-rotate #{rotate} "
441                 end
442                 if rexml_thread_protect { felem.attributes["#{attributes_prefix}enhance"] }
443                     convert_options += ($config['convert-enhance'] || $convert_enhance) + " "
444                 end
445             end
446             for dest in dests
447                 if ! File.exists?(dest['filename'])
448                     tmpdir = gen_video_thumbnail(orig, felem && rexml_thread_protect { felem.attributes["#{attributes_prefix}color-swap"] }, seektime)
449                     if tmpdir.nil?
450                         return false
451                     end
452                     tmpfile = "#{tmpdir}/00000001.jpg"
453                     alltmpfiles = [ tmpfile ]
454                     if felem && whitebalance = rexml_thread_protect { felem.attributes["#{attributes_prefix}white-balance"] }
455                         if whitebalance.to_f != 0
456                             neworig = "#{tmpdir}/whitebalance#{whitebalance}.jpg"
457                             cmd = "booh-fix-whitebalance '#{tmpfile}' '#{neworig}' #{whitebalance}"
458                             sys(cmd)
459                             if File.exists?(neworig)
460                                 tmpfile = neworig
461                                 alltmpfiles << neworig
462                             end
463                         end
464                     end
465                     if felem && gammacorrect = rexml_thread_protect { felem.attributes["#{attributes_prefix}gamma-correction"] }
466                         if gammacorrect.to_f != 0
467                             neworig = "#{tmpdir}/gammacorrect#{gammacorrect}.jpg"
468                             cmd = "booh-gamma-correction '#{tmpfile}' '#{neworig}' #{gammacorrect}"
469                             sys(cmd)
470                             if File.exists?(neworig)
471                                 tmpfile = neworig
472                                 alltmpfiles << neworig
473                             end
474                         end
475                     end
476                     sys("#{$convert} #{convert_options}-size #{dest['size']} -resize #{dest['size']} '#{tmpfile}' '#{dest['filename']}'")
477                     alltmpfiles.each { |file| File.delete(file) }
478                     Dir.rmdir(tmpdir)
479                 end
480             end
481             return true
482         end
483     end
484
485     def invornil(obj, methodname)
486         if obj == nil
487             return nil
488         else
489             return obj.method(methodname).call
490         end
491     end
492
493     def find_subalbum_info_type(xmldir)
494         #- first look for subdirs info; if not, means there is no subdir
495         if xmldir.attributes['subdirs-caption']
496             return 'subdirs'
497         else
498             return 'thumbnails'
499         end
500     end
501
502     def find_subalbum_caption_info(xmldir)
503         type = find_subalbum_info_type(xmldir)
504         return [ from_utf8(xmldir.attributes["#{type}-captionfile"]), xmldir.attributes["#{type}-caption"] ]
505     end
506
507     def file_size(path)
508         begin
509             return File.size(path)
510         rescue
511             return -1
512         end
513     end
514
515     def max(a, b)
516         a > b ? a : b
517     end
518
519     def clamp(n, a, b)
520         n < a ? a : n > b ? b : n
521     end
522
523     def pano_amount(elem)
524         if pano_amount = elem.attributes['pano-amount']
525             if $N_per_row
526                 return clamp(pano_amount.to_f, 1, $N_per_row.to_i)
527             else
528                 return clamp(pano_amount.to_f, 1, $default_N.to_i)
529             end
530         else
531             return nil
532         end
533     end
534
535     def substInFile(name)
536         newcontent = IO.readlines(name).collect { |l| yield l }
537         ios = File.open(name, "w")
538         ios.write(newcontent)
539         ios.close
540     end
541
542     $xmlaccesslock = Monitor.new
543
544     def rexml_thread_protect(&proc)
545         $xmlaccesslock.synchronize {
546             proc.call
547         }
548     end
549
550     def check_multi_binaries(input)
551         #- e.g. check at least one binary from '/usr/bin/gimp-remote %f || /usr/bin/gimp %f' is available
552         for attempts in input.split('||')
553             binary = attempts.split.first
554             if binary && File.executable?(binary)
555                 return nil
556             end
557         end
558         #- return last tried binary for error message
559         return binary
560     end
561
562     def check_browser
563         if last_failed_binary = check_multi_binaries($config['browser'])
564             show_popup($main_window, utf8(_("The configured browser seems to be unavailable.
565 You should fix this in Edit/Preferences so that you can open URLs.
566
567 Problem was: '%s' is not an executable file.") % last_failed_binary), { :pos_centered => true, :not_transient => true })
568             return false
569         else
570             return true
571         end
572     end
573
574     def open_url(url)
575         if check_browser
576             cmd = $config['browser'].gsub('%f', "'#{url}'") + ' &'
577             msg 2, cmd
578             system(cmd)
579         end
580     end
581
582     def get_license
583         return <<"EOF"
584                     GNU GENERAL PUBLIC LICENSE
585                        Version 2, June 1991
586
587  Copyright (C) 1989, 1991 Free Software Foundation, Inc.
588                           675 Mass Ave, Cambridge, MA 02139, USA
589  Everyone is permitted to copy and distribute verbatim copies
590  of this license document, but changing it is not allowed.
591
592                             Preamble
593
594   The licenses for most software are designed to take away your
595 freedom to share and change it.  By contrast, the GNU General Public
596 License is intended to guarantee your freedom to share and change free
597 software--to make sure the software is free for all its users.  This
598 General Public License applies to most of the Free Software
599 Foundation's software and to any other program whose authors commit to
600 using it.  (Some other Free Software Foundation software is covered by
601 the GNU Library General Public License instead.)  You can apply it to
602 your programs, too.
603
604   When we speak of free software, we are referring to freedom, not
605 price.  Our General Public Licenses are designed to make sure that you
606 have the freedom to distribute copies of free software (and charge for
607 this service if you wish), that you receive source code or can get it
608 if you want it, that you can change the software or use pieces of it
609 in new free programs; and that you know you can do these things.
610
611   To protect your rights, we need to make restrictions that forbid
612 anyone to deny you these rights or to ask you to surrender the rights.
613 These restrictions translate to certain responsibilities for you if you
614 distribute copies of the software, or if you modify it.
615
616   For example, if you distribute copies of such a program, whether
617 gratis or for a fee, you must give the recipients all the rights that
618 you have.  You must make sure that they, too, receive or can get the
619 source code.  And you must show them these terms so they know their
620 rights.
621
622   We protect your rights with two steps: (1) copyright the software, and
623 (2) offer you this license which gives you legal permission to copy,
624 distribute and/or modify the software.
625
626   Also, for each author's protection and ours, we want to make certain
627 that everyone understands that there is no warranty for this free
628 software.  If the software is modified by someone else and passed on, we
629 want its recipients to know that what they have is not the original, so
630 that any problems introduced by others will not reflect on the original
631 authors' reputations.
632
633   Finally, any free program is threatened constantly by software
634 patents.  We wish to avoid the danger that redistributors of a free
635 program will individually obtain patent licenses, in effect making the
636 program proprietary.  To prevent this, we have made it clear that any
637 patent must be licensed for everyone's free use or not licensed at all.
638
639   The precise terms and conditions for copying, distribution and
640 modification follow.
641
642
643                     GNU GENERAL PUBLIC LICENSE
644    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
645
646   0. This License applies to any program or other work which contains
647 a notice placed by the copyright holder saying it may be distributed
648 under the terms of this General Public License.  The "Program", below,
649 refers to any such program or work, and a "work based on the Program"
650 means either the Program or any derivative work under copyright law:
651 that is to say, a work containing the Program or a portion of it,
652 either verbatim or with modifications and/or translated into another
653 language.  (Hereinafter, translation is included without limitation in
654 the term "modification".)  Each licensee is addressed as "you".
655
656 Activities other than copying, distribution and modification are not
657 covered by this License; they are outside its scope.  The act of
658 running the Program is not restricted, and the output from the Program
659 is covered only if its contents constitute a work based on the
660 Program (independent of having been made by running the Program).
661 Whether that is true depends on what the Program does.
662
663   1. You may copy and distribute verbatim copies of the Program's
664 source code as you receive it, in any medium, provided that you
665 conspicuously and appropriately publish on each copy an appropriate
666 copyright notice and disclaimer of warranty; keep intact all the
667 notices that refer to this License and to the absence of any warranty;
668 and give any other recipients of the Program a copy of this License
669 along with the Program.
670
671 You may charge a fee for the physical act of transferring a copy, and
672 you may at your option offer warranty protection in exchange for a fee.
673
674   2. You may modify your copy or copies of the Program or any portion
675 of it, thus forming a work based on the Program, and copy and
676 distribute such modifications or work under the terms of Section 1
677 above, provided that you also meet all of these conditions:
678
679     a) You must cause the modified files to carry prominent notices
680     stating that you changed the files and the date of any change.
681
682     b) You must cause any work that you distribute or publish, that in
683     whole or in part contains or is derived from the Program or any
684     part thereof, to be licensed as a whole at no charge to all third
685     parties under the terms of this License.
686
687     c) If the modified program normally reads commands interactively
688     when run, you must cause it, when started running for such
689     interactive use in the most ordinary way, to print or display an
690     announcement including an appropriate copyright notice and a
691     notice that there is no warranty (or else, saying that you provide
692     a warranty) and that users may redistribute the program under
693     these conditions, and telling the user how to view a copy of this
694     License.  (Exception: if the Program itself is interactive but
695     does not normally print such an announcement, your work based on
696     the Program is not required to print an announcement.)
697
698
699 These requirements apply to the modified work as a whole.  If
700 identifiable sections of that work are not derived from the Program,
701 and can be reasonably considered independent and separate works in
702 themselves, then this License, and its terms, do not apply to those
703 sections when you distribute them as separate works.  But when you
704 distribute the same sections as part of a whole which is a work based
705 on the Program, the distribution of the whole must be on the terms of
706 this License, whose permissions for other licensees extend to the
707 entire whole, and thus to each and every part regardless of who wrote it.
708
709 Thus, it is not the intent of this section to claim rights or contest
710 your rights to work written entirely by you; rather, the intent is to
711 exercise the right to control the distribution of derivative or
712 collective works based on the Program.
713
714 In addition, mere aggregation of another work not based on the Program
715 with the Program (or with a work based on the Program) on a volume of
716 a storage or distribution medium does not bring the other work under
717 the scope of this License.
718
719   3. You may copy and distribute the Program (or a work based on it,
720 under Section 2) in object code or executable form under the terms of
721 Sections 1 and 2 above provided that you also do one of the following:
722
723     a) Accompany it with the complete corresponding machine-readable
724     source code, which must be distributed under the terms of Sections
725     1 and 2 above on a medium customarily used for software interchange; or,
726
727     b) Accompany it with a written offer, valid for at least three
728     years, to give any third party, for a charge no more than your
729     cost of physically performing source distribution, a complete
730     machine-readable copy of the corresponding source code, to be
731     distributed under the terms of Sections 1 and 2 above on a medium
732     customarily used for software interchange; or,
733
734     c) Accompany it with the information you received as to the offer
735     to distribute corresponding source code.  (This alternative is
736     allowed only for noncommercial distribution and only if you
737     received the program in object code or executable form with such
738     an offer, in accord with Subsection b above.)
739
740 The source code for a work means the preferred form of the work for
741 making modifications to it.  For an executable work, complete source
742 code means all the source code for all modules it contains, plus any
743 associated interface definition files, plus the scripts used to
744 control compilation and installation of the executable.  However, as a
745 special exception, the source code distributed need not include
746 anything that is normally distributed (in either source or binary
747 form) with the major components (compiler, kernel, and so on) of the
748 operating system on which the executable runs, unless that component
749 itself accompanies the executable.
750
751 If distribution of executable or object code is made by offering
752 access to copy from a designated place, then offering equivalent
753 access to copy the source code from the same place counts as
754 distribution of the source code, even though third parties are not
755 compelled to copy the source along with the object code.
756
757
758   4. You may not copy, modify, sublicense, or distribute the Program
759 except as expressly provided under this License.  Any attempt
760 otherwise to copy, modify, sublicense or distribute the Program is
761 void, and will automatically terminate your rights under this License.
762 However, parties who have received copies, or rights, from you under
763 this License will not have their licenses terminated so long as such
764 parties remain in full compliance.
765
766   5. You are not required to accept this License, since you have not
767 signed it.  However, nothing else grants you permission to modify or
768 distribute the Program or its derivative works.  These actions are
769 prohibited by law if you do not accept this License.  Therefore, by
770 modifying or distributing the Program (or any work based on the
771 Program), you indicate your acceptance of this License to do so, and
772 all its terms and conditions for copying, distributing or modifying
773 the Program or works based on it.
774
775   6. Each time you redistribute the Program (or any work based on the
776 Program), the recipient automatically receives a license from the
777 original licensor to copy, distribute or modify the Program subject to
778 these terms and conditions.  You may not impose any further
779 restrictions on the recipients' exercise of the rights granted herein.
780 You are not responsible for enforcing compliance by third parties to
781 this License.
782
783   7. If, as a consequence of a court judgment or allegation of patent
784 infringement or for any other reason (not limited to patent issues),
785 conditions are imposed on you (whether by court order, agreement or
786 otherwise) that contradict the conditions of this License, they do not
787 excuse you from the conditions of this License.  If you cannot
788 distribute so as to satisfy simultaneously your obligations under this
789 License and any other pertinent obligations, then as a consequence you
790 may not distribute the Program at all.  For example, if a patent
791 license would not permit royalty-free redistribution of the Program by
792 all those who receive copies directly or indirectly through you, then
793 the only way you could satisfy both it and this License would be to
794 refrain entirely from distribution of the Program.
795
796 If any portion of this section is held invalid or unenforceable under
797 any particular circumstance, the balance of the section is intended to
798 apply and the section as a whole is intended to apply in other
799 circumstances.
800
801 It is not the purpose of this section to induce you to infringe any
802 patents or other property right claims or to contest validity of any
803 such claims; this section has the sole purpose of protecting the
804 integrity of the free software distribution system, which is
805 implemented by public license practices.  Many people have made
806 generous contributions to the wide range of software distributed
807 through that system in reliance on consistent application of that
808 system; it is up to the author/donor to decide if he or she is willing
809 to distribute software through any other system and a licensee cannot
810 impose that choice.
811
812 This section is intended to make thoroughly clear what is believed to
813 be a consequence of the rest of this License.
814
815
816   8. If the distribution and/or use of the Program is restricted in
817 certain countries either by patents or by copyrighted interfaces, the
818 original copyright holder who places the Program under this License
819 may add an explicit geographical distribution limitation excluding
820 those countries, so that distribution is permitted only in or among
821 countries not thus excluded.  In such case, this License incorporates
822 the limitation as if written in the body of this License.
823
824   9. The Free Software Foundation may publish revised and/or new versions
825 of the General Public License from time to time.  Such new versions will
826 be similar in spirit to the present version, but may differ in detail to
827 address new problems or concerns.
828
829 Each version is given a distinguishing version number.  If the Program
830 specifies a version number of this License which applies to it and "any
831 later version", you have the option of following the terms and conditions
832 either of that version or of any later version published by the Free
833 Software Foundation.  If the Program does not specify a version number of
834 this License, you may choose any version ever published by the Free Software
835 Foundation.
836
837   10. If you wish to incorporate parts of the Program into other free
838 programs whose distribution conditions are different, write to the author
839 to ask for permission.  For software which is copyrighted by the Free
840 Software Foundation, write to the Free Software Foundation; we sometimes
841 make exceptions for this.  Our decision will be guided by the two goals
842 of preserving the free status of all derivatives of our free software and
843 of promoting the sharing and reuse of software generally.
844
845                             NO WARRANTY
846
847   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
848 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
849 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
850 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
851 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
852 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
853 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
854 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
855 REPAIR OR CORRECTION.
856
857   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
858 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
859 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
860 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
861 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
862 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
863 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
864 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
865 POSSIBILITY OF SUCH DAMAGES.
866 EOF
867     end
868
869     def call_about
870         Gtk::AboutDialog.set_url_hook { |dialog, url| open_url(url) }
871         Gtk::AboutDialog.show($main_window, { :name => 'booh',
872                                               :version => $VERSION,
873                                               :copyright => 'Copyright (c) 2005-2010 Guillaume Cottenceau',
874                                               :license => get_license,
875                                               :website => 'http://booh.org/',
876                                               :authors => [ 'Guillaume Cottenceau' ],
877                                               :artists => [ 'Ayo73' ],
878                                               :comments => utf8(_("''The Web-Album of choice for discriminating Linux users''")),
879                                               :translator_credits => utf8(_('Esperanto: Stephane Fillod
880 Japanese: Masao Mutoh
881 German: Roland Eckert
882 French: Guillaume Cottenceau')),
883                                               :logo => Gdk::Pixbuf.new("#{$FPATH}/images/logo.png") })
884     end
885
886     def smartsort(entries, sort_criterions)
887         #- sort "entries" according to "sort_criterions" but find a good fallback for all entries without a
888         #- criterion value (still next to the item they were next to)
889         sorted_entries = sort_criterions.keys.sort { |a,b| sort_criterions[a] <=> sort_criterions[b] }
890         for i in 0 .. entries.size - 1
891             if ! sorted_entries.include?(entries[i])
892                 j = i - 1
893                 while j > 0 && ! sorted_entries.include?(entries[j])
894                     j -= 1
895                 end
896                 sorted_entries[(sorted_entries.index(entries[j]) || -1 ) + 1, 0] = entries[i]
897             end
898         end
899         return sorted_entries
900     end
901
902     def defer_translation(msg)
903         return "@@#{msg}@@"
904     end
905
906     def create_window
907         w = Gtk::Window.new
908         w.icon_list = [ Gdk::Pixbuf.new("#{$FPATH}/images/booh-16x16.png"),
909                         Gdk::Pixbuf.new("#{$FPATH}/images/booh-32x32.png"),
910                         Gdk::Pixbuf.new("#{$FPATH}/images/booh-48x48.png") ]
911         return w
912     end
913
914 end
915
916 class Object
917     def to_b
918         if !self || self.to_s == 'false'
919             return false
920         else
921             return true
922         end
923     end
924 end
925
926 class File
927     def File.reduce_path(path)
928         return path.gsub(/\w+\/\.\.\//, '')
929     end
930 end
931
932 module Enumerable
933     def collect_with_index
934         out = []
935         each_with_index { |e,i|
936             out << yield(e,i)
937         }
938         return out
939     end
940 end
941
942 class Array
943     def sum
944         retval = 0
945         each { |v| retval += v.to_i }
946         return retval
947     end
948 end
949
950 class REXML::Element
951     def previous_element_byname(name)
952         n = self
953         while n = n.previous_element
954             if n.name == name
955                 return n
956             end
957         end
958         return nil
959     end
960
961     def previous_element_byname_notattr(name, attr)
962         n = self
963         while n = n.previous_element
964             if n.name == name && !n.attributes[attr]
965                 return n
966             end
967         end
968         return nil
969     end
970
971     def next_element_byname(name)
972         n = self
973         while n = n.next_element
974             if n.name == name
975                 return n
976             end
977         end
978         return nil
979     end
980
981     def next_element_byname_notattr(name, attr)
982         n = self
983         while n = n.next_element
984             if n.name == name && !n.attributes[attr]
985                 return n
986             end
987         end
988         return nil
989     end
990
991     def child_byname_notattr(name, attr)
992         elements.each(name) { |element|
993             if !element.attributes[attr]
994                 return element
995             end
996         }
997         return nil
998     end
999 end
1000
1001