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