]> www.average.org Git - mkgallery.git/blob - mkgallery.pl
wip on rss
[mkgallery.git] / mkgallery.pl
1 #!/usr/bin/perl
2
3 # $Id$
4
5 # Recursively create image gallery index and slideshow wrappings.
6 # Makes use of (slightly modified) "lightbox" Javascript/CSS as published
7 # at http://www.huddletogether.com/projects/lightbox/
8
9 # Copyright (c) 2006 Eugene G. Crosser
10
11 #  This software is provided 'as-is', without any express or implied
12 #  warranty.  In no event will the authors be held liable for any damages
13 #  arising from the use of this software.
14 #
15 #  Permission is granted to anyone to use this software for any purpose,
16 #  including commercial applications, and to alter it and redistribute it
17 #  freely, subject to the following restrictions:
18 #
19 #  1. The origin of this software must not be misrepresented; you must not
20 #     claim that you wrote the original software. If you use this software
21 #     in a product, an acknowledgment in the product documentation would be
22 #     appreciated but is not required.
23 #  2. Altered source versions must be plainly marked as such, and must not be
24 #     misrepresented as being the original software.
25 #  3. This notice may not be removed or altered from any source distribution.
26
27 package FsObj;
28
29 use strict;
30 use Carp;
31 use POSIX qw/getcwd strftime/;
32 use CGI qw/:html *table *Tr *center *div *Link/;
33 use Image::Info qw/image_info dim/;
34 use Term::ReadLine;
35 use Getopt::Long;
36 use Encode;
37 use encoding 'utf-8';
38 binmode(STDOUT, ":utf8");
39
40 my $haveimagick = eval { require Image::Magick; };
41 { package Image::Magick; }      # to make perl compiler happy
42
43 my $haverssxml = eval { require XML::RSS; };
44 { package XML::RSS; }           # to make perl compiler happy
45
46 my @sizes = (160, 640);
47
48 ######################################################################
49
50 my $incpath;
51 my $rssobj;
52 my $debug = 0;
53 my $asktitle = 0;
54 my $noasktitle = 0;
55 my $rssfile = "";
56
57 charset("utf-8");
58
59 unless (GetOptions(
60                 'help'=>\&help,
61                 'incpath'=>\$incpath,
62                 'asktitle'=>\$asktitle,
63                 'noasktitle'=>\$noasktitle,
64                 'rssfile=s'=>\$rssfile,
65                 'debug'=>\$debug)) {
66         &help;
67 }
68
69 if ($rssfile && ! $haverssxml) {
70         print STDERR "You need to get XML::RSS from CPAN to use --rssfile\n";
71         exit 1;
72 }
73
74 my $term = new Term::ReadLine "Edit Title";
75
76 FsObj->new(getcwd)->iterate;
77
78 if ($rssobj) {
79         my $itemstodel = @{$rssobj->{'rss'}->{'items'}} - 15;
80         while ($itemstodel-- > 0) {
81                 pop(@{$rssobj->{'rss'}->{'items'}})
82         }
83         $rssobj->{'rss'}->save($rssobj->{'file'});
84 }
85
86 sub help {
87
88         print STDERR <<__END__;
89 usage: $0 [options]
90  --help:        print help message and exit
91  --incpath:     do not try to find .include diretory upstream, use
92                 specified path (absolute or relavive).  Use with causion.
93  --debug:       print a lot of debugging info to stdout as you run
94  --asktitle:    ask to edit album titles even if there are ".title" files
95  --noasktitle:  don't ask to enter album titles even where ".title"
96                 files are absent.  Use partial directory names as titles.
97  --rssfile=...: build RSS feed for newly added "albums", give name of rss file
98 __END__
99
100         exit 1;
101 }
102
103 sub new {
104         my $this = shift;
105         my $class;
106         my $self;
107         if (ref($this)) {
108                 $class = ref($this);
109                 my $parent = $this;
110                 my $name = shift;
111                 my $fullpath = $parent->{-fullpath}.'/'.$name;
112                 $self = {
113                                 -parent=>$parent,
114                                 -root=>$parent->{-root},
115                                 -base=>$name,
116                                 -fullpath=>$fullpath,
117                                 -inc=>'../'.$parent->{-inc},
118                                 -rss=>'../'.$parent->{-rss},
119                         };
120         } else {
121                 $class = $this;
122                 my $root=shift;
123                 $self = {
124                                 -root=>$root,
125                                 -fullpath=>$root,
126                                 -inc=>getinc($root),
127                                 -rss=>getrss($root),
128                         };
129         }
130         bless $self, $class;
131         if ($debug) {
132                 print "new $class:\n";
133                 foreach my $k(keys %$self) {
134                         print "\t$k\t=\t$self->{$k}\n";
135                 }
136         }
137         return $self;
138 }
139
140 sub getinc {
141         my $fullpath=shift;     # this is not a method
142         my $depth=20;           # arbitrary max depth
143
144         if ($incpath) {
145                 return $incpath."/.include";
146         }
147
148         my $inc=".include";
149         while ( ! -d $fullpath."/".$inc ) {
150                 $inc = "../".$inc;
151                 last unless ($depth-- > 0);
152         }
153         if ($depth > 0) {
154                 return $inc.'/';                # prefix with trailing slash
155         } else {
156                 return 'NO-.INCLUDE-IN-PATH/';  # won't work anyway
157         }
158 }
159
160 sub getrss {
161         my $fullpath=shift;     # this is not a method
162         my $depth=20;           # arbitrary max depth
163
164         return "" unless $rssfile;
165
166         my $rss=$rssfile;
167         while ( ! -f $fullpath."/".$rss ) {
168                 $rss = "../".$rss;
169                 last unless ($depth-- > 0);
170         }
171         if ($depth > 0) {
172                 $rssobj->{'file'} = $rss;
173                 $rssobj->{'rss'} = new XML::RSS (version=>2);
174                 $rssobj->{'rss'}->parsefile($rss);
175                 return $rss;
176         } else {
177                 print STDERR "There is no $rssfile in this or parent ".
178                         "directories, you must create one with mkgalrss.pl\n";
179                 exit 1;
180         }
181 }
182
183 sub iterate {
184         my $self = shift;
185         my $fullpath .= $self->{-fullpath};
186         print "iterate in dir $fullpath\n" if ($debug);
187
188         my $youngest=0;
189         my @rdirlist;
190         my @rimglist;
191         my $D;
192         unless (opendir($D,$fullpath)) {
193                 warn "cannot opendir $fullpath: $!";
194                 return;
195         }
196         while (my $de = readdir($D)) {
197                 next if ($de =~ /^\./);
198                 my $child = $self->new($de);
199                 my @stat = stat($child->{-fullpath});
200                 $youngest = $stat[9] if ($youngest < $stat[9]);
201                 if ($child->isdir) {
202                         push(@rdirlist,$child);
203                 } elsif ($child->isimg) {
204                         push(@rimglist,$child);
205                 }
206         }
207         closedir($D);
208         my @dirlist = sort {$a->{-base} cmp $b->{-base}} @rdirlist;
209         undef @rdirlist; # inplace sorting would be handy here
210         my @imglist = sort {$a->{-base} cmp $b->{-base}} @rimglist;
211         undef @rimglist; # optimize away unsorted versions
212         $self->{-firstimg} = $imglist[0];
213
214         print "Dir: $self->{-fullpath}\n" if ($debug);
215
216 # 1. first of all, fill title for this directory and create hidden subdirs
217
218         $self->initdir;
219
220 # 2. recurse into subdirectories to get their titles filled
221 #    before we start writing out subalbum list
222
223         foreach my $dir(@dirlist) {
224                 $dir->iterate;
225         }
226
227 # 3. iterate through images to build cross-links,
228
229         my $previmg = undef;
230         foreach my $img(@imglist) {
231                 # list-linking must be done before generating
232                 # aux html because aux pages rely on prev/next refs
233                 if ($previmg) {
234                         $previmg->{-nextimg} = $img;
235                         $img->{-previmg} = $previmg;
236                 }
237                 $previmg=$img;
238         }
239
240 # 4. create scaled versions and aux html pages
241
242         foreach my $img(@imglist) {
243                 # scaled versions must be generated before aux html
244                 # and main image index because they both rely on
245                 # refs to scaled images and they may be just original
246                 # images, this is not known before we try scaling.
247                 $img->makescaled;
248                 # finally, make aux html pages
249                 $img->makeaux;
250         }
251
252 # no need to go beyond this point if the directory timestamp did not
253 # change since we built index.html file last time.
254
255         my @istat = stat($self->{-fullpath}.'/index.html');
256         return unless ($youngest > $istat[9]);
257
258 # 5. start building index.html for the directory
259
260         $self->startindex;
261
262 # 6. iterate through subdirectories to build subalbums list
263
264         if (@dirlist) {
265                 $self->startsublist;
266                 foreach my $dir(@dirlist) {
267                         $dir->sub_entry;
268                 }
269                 $self->endsublist;
270         }
271
272 # 7. iterate through images to build thumb list
273
274         if (@imglist) {
275                 $self->startimglist;
276                 foreach my $img(@imglist) {
277                         print "Img: $img->{-fullpath}\n" if ($debug);
278                         $img->img_entry;
279                 }
280                 $self->endimglist;
281         }
282
283 # 8. comlplete building index.html for the directory
284
285         $self->endindex;
286 }
287
288 sub isdir {
289         my $self = shift;
290         return ( -d $self->{-fullpath} );
291 }
292
293 sub isimg {
294         my $self = shift;
295         my $fullpath = $self->{-fullpath};
296         return 0 unless ( -f $fullpath );
297         my $info = image_info($fullpath);
298         if (my $error = $info->{error}) {
299                 if (($error !~ "Unrecognized file format") &&
300                     ($error !~ "Can't read head")) {
301                         warn "File \"$fullpath\": $error\n";
302                 }
303                 return 0;
304         }
305
306         tryapp12($info) unless ($info->{'ExifVersion'});
307
308         $self->{-isimg} = 1;
309         $self->{-info} = $info;
310         return 1;
311 }
312
313 sub tryapp12 {
314         my $info = shift;       # this is not a method
315         my $app12;
316         # dirty hack to take care of Image::Info parser strangeness
317         foreach my $k(keys %$info) {
318                 $app12=substr($k,6).$info->{$k} if ($k =~ /^App12-/);
319         }
320         return unless ($app12); # bad luck
321         my $seenfirstline=0;
322         foreach my $ln(split /[\r\n]+/,$app12) {
323                 $ln =~ s/[[:^print:]\000]/ /g;
324                 unless ($seenfirstline) {
325                         $seenfirstline=1;
326                         $info->{'Make'}=$ln;
327                         next;
328                 }
329                 my ($k,$v)=split /=/,$ln,2;
330                 if ($k eq 'TimeDate') {
331                         $info->{'DateTime'} =
332                                 strftime("%Y:%m:%d %H:%M:%S", localtime($v))
333                                                         unless ($v < 0);
334                 } elsif ($k eq 'Shutter') {
335                         $info->{'ExposureTime'} = '1/'.int(1000000/$v+.5);
336                 } elsif ($k eq 'Flash') {
337                         $info->{'Flash'} = $v?'Flash fired':'Flash did not fire';
338                 } elsif ($k eq 'Type') {
339                         $info->{'Model'} = $v;
340                 } elsif ($k eq 'Version') {
341                         $info->{'Software'} = $v;
342                 } elsif ($k eq 'Fnumber') {
343                         $info->{'FNumber'} = $v;
344                 }
345         }
346 }
347
348 sub initdir {
349         my $self = shift;
350         my $fullpath = $self->{-fullpath};
351         for my $subdir(@sizes, 'html') {
352                 my $tdir=sprintf "%s/.%s",$self->{-fullpath},$subdir;
353                 mkdir($tdir,0755) unless ( -d $tdir );
354         }
355         $self->edittitle;
356 }
357
358 sub edittitle {
359         my $self = shift;
360         my $fullpath = $self->{-fullpath};
361         my $title;
362         my $T;
363         if (open($T,'<'.$fullpath.'/.title')) {
364                 $title = <$T>;
365                 $title =~ s/[\r\n]*$//;
366                 close($T);
367         }
368         if ($asktitle || (!$title && !$noasktitle)) {
369                 my $prompt = $self->{-base};
370                 $prompt = '/' unless ($prompt);
371                 my $OUT = $term->OUT || \*STDOUT;
372                 print $OUT "Enter title for $fullpath\n";
373                 $title = $term->readline($prompt.' >',$title);
374                 $term->addhistory($title) if ($title);
375                 if (open($T,'>'.$fullpath.'/.title')) {
376                         print $T $title,"\n";
377                         close($T);
378                 }
379         }
380         unless ($title) {
381                 $title=substr($fullpath,length($self->{-root}));
382         }
383         $self->{-title}=$title;
384         print "title in $fullpath is $title\n" if ($debug);
385 }
386
387 sub makescaled {
388         my $self = shift;
389         my $fn = $self->{-fullpath};
390         my $name = $self->{-base};
391         my $dn = $self->{-parent}->{-fullpath};
392         my ($w, $h) = dim($self->{-info});
393         my $max = ($w > $h)?$w:$h;
394
395         foreach my $size(@sizes) {
396                 my $nref = '.'.$size.'/'.$name;
397                 my $nfn = $dn.'/'.$nref;
398                 my $factor=$size/$max;
399                 if ($factor >= 1) {
400                         $self->{$size} = $name; # unscaled version will do
401                 } else {
402                         $self->{$size} = $nref;
403                         if (isnewer($fn,$nfn)) {
404                                 doscaling($fn,$nfn,$factor,$w,$h);
405                         }
406                 }
407         }
408 }
409
410 sub isnewer {
411         my ($fn1,$fn2) = @_;                    # this is not a method
412         my @stat1=stat($fn1);
413         my @stat2=stat($fn2);
414         return (!@stat2 || ($stat1[9] > $stat2[9]));
415         # true if $fn2 is absent or is older than $fn1
416 }
417
418 sub doscaling {
419         my ($src,$dest,$factor,$w,$h) = @_;     # this is not a method
420
421         my $err=1;
422         if ($haveimagick) {
423                 my $im = new Image::Magick;
424                 print "doscaling $src -> $dest by $factor\n" if ($debug);
425                 if ($err = $im->Read($src)) {
426                         warn "ImageMagick: read \"$src\": $err";
427                 } else {
428                         $im->Scale(width=>$w*$factor,height=>$h*$factor);
429                         $err=$im->Write($dest);
430                         warn "ImageMagick: write \"$dest\": $err" if ($err);
431                 }
432                 undef $im;
433         }
434         if ($err) {     # fallback to command-line tools
435                 system("djpeg \"$src\" | pnmscale \"$factor\" | cjpeg >\"$dest\"");
436         }
437 }
438
439 sub makeaux {
440         my $self = shift;
441         my $name = $self->{-base};
442         my $dn = $self->{-parent}->{-fullpath};
443         my $pref = $self->{-previmg}->{-base};
444         my $nref = $self->{-nextimg}->{-base};
445         my $inc = $self->{-inc};
446         my $title = $self->{-info}->{'Comment'};
447         $title = $name unless ($title);
448
449         print "slide: \"$title\": \"$pref\"->\"$name\"->\"$nref\"\n" if ($debug);
450
451         # slideshow
452         for my $refresh('static', 'slide') {
453                 my $fn = sprintf("%s/.html/%s-%s.html",$dn,$name,$refresh);
454                 if (isnewer($self->{-fullpath},$fn)) {
455                         my $imgsrc = '../'.$self->{$sizes[1]};
456                         my $fwdref;
457                         my $bakref;
458                         if ($nref) {
459                                 $fwdref = sprintf("%s-%s.html",$nref,$refresh);
460                         } else {
461                                 $fwdref = '../index.html';
462                         }
463                         if ($pref) {
464                                 $bakref = sprintf("%s-%s.html",$pref,$refresh);
465                         } else {
466                                 $bakref = '../index.html';
467                         }
468                         my $toggleref;
469                         my $toggletext;
470                         if ($refresh eq 'slide') {
471                                 $toggleref=sprintf("%s-static.html",$name);
472                                 $toggletext = 'Stop!';
473                         } else {
474                                 $toggleref=sprintf("%s-slide.html",$name);
475                                 $toggletext = 'Play-&gt;';
476                         }
477                         my $F;
478                         unless (open($F,'>'.$fn)) {
479                                 warn "cannot open \"$fn\": $!";
480                                 next;
481                         }
482                         binmode($F, ":utf8");
483                         if ($refresh eq 'slide') {
484                                 print $F start_html(
485                                         -encoding=>"utf-8",
486                                         -title=>$title,
487                                         -bgcolor=>"#808080",
488                                         -head=>meta({-http_equiv=>'Refresh',
489                                                 -content=>"3; url=$fwdref"}),
490                                         -style=>{-src=>$inc."gallery.css"},
491                                         ),"\n";
492                                                 
493                         } else {
494                                 print $F start_html(-title=>$title,
495                                         -encoding=>"utf-8",
496                                         -bgcolor=>"#808080",
497                                         -style=>{-src=>$inc."gallery.css"},
498                                         ),"\n";
499                         }
500                         print $F start_center,"\n",
501                                 h1($title),"\n",
502                                 start_table({-class=>'navi'}),start_Tr,"\n",
503                                 td(a({-href=>"../index.html"},"Index")),"\n",
504                                 td(a({-href=>$bakref},"&lt;&lt;Prev")),"\n",
505                                 td(a({-href=>$toggleref},$toggletext)),"\n",
506                                 td(a({-href=>$fwdref},"Next&gt;&gt;")),"\n",
507                                 end_Tr,
508                                 end_table,"\n",
509                                 table({-class=>'picframe'},
510                                         Tr(td(img({-src=>$imgsrc})))),"\n",
511                                 end_center,"\n",
512                                 end_html,"\n";
513                         close($F);
514                 }
515         }
516
517         # info html
518         my $fn = sprintf("%s/.html/%s-info.html",$dn,$name);
519         if (isnewer($self->{-fullpath},$fn)) {
520                 my $F;
521                 unless (open($F,'>'.$fn)) {
522                         warn "cannot open \"$fn\": $!";
523                         return;
524                 }
525                 my $imgsrc = sprintf("../.%s/%s",$sizes[0],$name);
526                 print $F start_html(-title=>$title,
527                                 -encoding=>"utf-8",
528                                 -style=>{-src=>$inc."gallery.css"},),"\n",
529                         start_center,"\n",
530                         h1($title),"\n",
531                         table({-class=>'ipage'},
532                                 Tr(td(img({-src=>$imgsrc})),
533                                         td($self->infotable))),
534                         a({-href=>'../index.html'},'Index'),"\n",
535                         end_center,"\n",
536                         end_html,"\n";
537                 close($F);
538         }
539 }
540
541 sub startindex {
542         my $self = shift;
543         my $fn = $self->{-fullpath}.'/index.html';
544         my $block = $self->{-fullpath}.'/.noindex';
545         $fn = '/dev/null' if ( -f $block );
546         my $IND;
547         unless (open($IND,'>'.$fn)) {
548                 warn "cannot open $fn: $!";
549                 return;
550         }
551         binmode($IND, ":utf8");
552         $self->{-IND} = $IND;
553
554         my $inc = $self->{-inc};
555         my $title = $self->{-title};
556         my $rsslink="";
557         if ($self->{-rss}) {
558                 $rsslink=Link({-rel=>'alternate',
559                                 -type=>'application/rss+xml',
560                                 -title=>'RSS',
561                                 -href=>$self->{-rss}});
562         }
563         print $IND start_html(-title => $title,
564                         -encoding=>"utf-8",
565                         -head=>$rsslink,
566                         -style=>{-src=>[$inc."gallery.css",
567                                         $inc."lightbox.css"]},
568                         -script=>[{-code=>"var incPrefix='$inc';"},
569                                 {-src=>$inc."gallery.js"},
570                                 {-src=>$inc."lightbox.js"}]),
571                 a({-href=>"../index.html"},"UP"),"\n",
572                 start_center,"\n",
573                 h1($title),"\n",
574                 "\n";
575 }
576
577 sub endindex {
578         my $self = shift;
579         my $IND = $self->{-IND};
580
581         print $IND end_center,end_html,"\n";
582
583         close($IND) if ($IND);
584         undef $self->{-IND};
585         if ($rssobj) {
586                 my $rsstitle=sprintf "%s [%d images, %d subalbums]",
587                                 $self->{-title},
588                                 $self->{-numofimgs},
589                                 $self->{-numofsubs};
590                 my $rsslink=$rssobj->{'rss'}->channel('link')."index.html";
591                 $rssobj->{'rss'}->add_item(
592                         title           => $self->{-title},
593                         link            => $rsslink,
594                         description     => $rsstitle,
595                 );
596         }
597 }
598
599 sub startsublist {
600         my $self = shift;
601         my $IND = $self->{-IND};
602
603         print $IND h2("Albums"),"\n",start_table,"\n";
604 }
605
606 sub sub_entry {
607         my $self = shift;
608         my $IND = $self->{-parent}->{-IND};
609         my $name = $self->{-base};
610         my $title = $self->{-title};
611
612         $self->{-parent}->{-numofsubs}++;
613         print $IND Tr(td(a({-href=>$name.'/index.html'},$name)),
614                         td(a({-href=>$name.'/index.html'},$title))),"\n";
615 }
616
617 sub endsublist {
618         my $self = shift;
619         my $IND = $self->{-IND};
620
621         print $IND end_table,"\n",br({-clear=>'all'}),hr,"\n\n";
622 }
623
624 sub startimglist {
625         my $self = shift;
626         my $IND = $self->{-IND};
627         my $first = $self->{-firstimg}->{-base};
628         my $slideref = sprintf(".html/%s-slide.html",$first);
629
630         print $IND h2("Images"),"\n",
631                 a({-href=>$slideref},'Slideshow'),
632                 "\n";
633 }
634
635 sub img_entry {
636         my $self = shift;
637         my $IND = $self->{-parent}->{-IND};
638         my $name = $self->{-base};
639         my $title = $self->{-info}->{'Comment'};
640         $title = $name unless ($title);
641         my $thumb = $self->{$sizes[0]};
642         my $medium = $self->{$sizes[1]};
643         my $info = $self->{-info};
644         my ($w, $h) = dim($info);
645
646         $self->{-parent}->{-numofimgs}++;
647         print $IND start_div({-class=>'ibox',-id=>$name,
648                                 -OnClick=>"HideIbox('$name');"}),"\n",
649                 start_div({-class=>'iboxtitle'}),
650                 span({-style=>'float: left;'},b("Info for $name")),
651                 span({-style=>'float: right;'},
652                         a({-href=>"#",-OnClick=>"HideIbox('$name');"},"Close")),
653                 br({-clear=>'all'}),"\n",
654                 end_div,"\n",
655                 $self->infotable,
656                 end_div,"\n";
657
658         print $IND table({-class=>'slide'},Tr(td(
659                 a({-href=>".html/$name-info.html",-title=>'Image Info',
660                         -onClick=>"return showIbox('$name');"},$title),
661                 br,
662                 a({-href=>$medium,-rel=>"lightbox",-title=>$title},
663                         img({-src=>$thumb})),
664                 br,
665                 a({-href=>$name,-title=>'Original Image'},"($w x $h)"),
666                 br))),"\n";
667 }
668
669 sub endimglist {
670         my $self = shift;
671         my $IND = $self->{-IND};
672
673         print $IND br({-clear=>'all'}),hr,"\n\n";
674 }
675
676 sub infotable {
677         my $self = shift;
678         my $info = $self->{-info};
679         my $msg='';
680
681         my @infokeys=(
682                 'DateTime',
683                 'ExposureTime',
684                 'FNumber',
685                 'Flash',
686                 'ISOSpeedRatings',
687                 'MeteringMode',
688                 'ExposureProgram',
689                 'FocalLength',
690                 'FileSource',
691                 'Make',
692                 'Model',
693                 'Software',
694         );
695         $msg.=start_table({-class=>'infotable'})."\n";
696         foreach my $k(@infokeys) {
697                 $msg.=Tr(td($k.":"),td($info->{$k}))."\n" if ($info->{$k});
698         }
699         $msg.=end_table."\n";
700 }
701