5 # Recursively create image gallery index and slideshow wrappings.
6 # Makes use of modified "slideshow" javascript by Samuel Birch
7 # http://www.phatfusion.net/slideshow/
9 # Copyright (c) 2006-2008 Eugene G. Crosser
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.
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:
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.
31 use POSIX qw/getcwd strftime/;
32 use CGI qw/:html *table *Tr *td *center *div *Link/;
33 use Image::Info qw/image_info dim/;
38 binmode(STDOUT, ":utf8");
40 my $haveimagick = eval { require Image::Magick; };
41 { package Image::Magick; } # to make perl compiler happy
43 my $haverssxml = eval { require XML::RSS; };
44 { package XML::RSS; } # to make perl compiler happy
46 my @sizes = (160, 640, 1600);
48 ######################################################################
62 'asktitle'=>\$asktitle,
63 'noasktitle'=>\$noasktitle,
64 'rssfile=s'=>\$rssfile,
69 if ($rssfile && ! $haverssxml) {
70 print STDERR "You need to get XML::RSS from CPAN to use --rssfile\n";
74 my $term = new Term::ReadLine "Edit Title";
76 FsObj->new(getcwd)->iterate;
77 if ($rssobj) { $rssobj->{'rss'}->save($rssobj->{'file'}); }
81 print STDERR <<__END__;
83 --help: print help message and exit
84 --incpath: do not try to find .gallery2 diretory upstream, use
85 specified path (absolute or relavive). Use with causion.
86 --debug: print a lot of debugging info to stdout as you run
87 --asktitle: ask to edit album titles even if there are ".title" files
88 --noasktitle: don't ask to enter album titles even where ".title"
89 files are absent. Use partial directory names as titles.
90 --rssfile=...: build RSS feed for newly added "albums", give name of rss file
104 my $fullpath = $parent->{-fullpath}.'/'.$name;
107 -root=>$parent->{-root},
109 -fullpath=>$fullpath,
110 -inc=>'../'.$parent->{-inc},
111 -rss=>'../'.$parent->{-rss},
125 print "new $class:\n";
126 foreach my $k(keys %$self) {
127 print "\t$k\t=\t$self->{$k}\n";
134 my $fullpath=shift; # this is not a method
135 my $depth=20; # arbitrary max depth
138 return $incpath."/.gallery2";
142 while ( ! -d $fullpath."/".$inc ) {
144 last unless ($depth-- > 0);
147 return $inc.'/'; # prefix with trailing slash
149 return 'NO-.INCLUDE-IN-PATH/'; # won't work anyway
154 my $fullpath=shift; # this is not a method
155 my $depth=20; # arbitrary max depth
157 return "" unless $rssfile;
160 while ( ! -f $fullpath."/".$rss ) {
162 last unless ($depth-- > 0);
165 $rssobj->{'file'} = $rss;
166 $rssobj->{'rss'} = new XML::RSS (version=>2);
167 $rssobj->{'rss'}->parsefile($rss);
168 my $itemstodel = @{$rssobj->{'rss'}->{'items'}} - 15;
169 while ($itemstodel-- > 0) {
170 pop(@{$rssobj->{'rss'}->{'items'}})
172 $rssobj->{'rss'}->save($rssobj->{'file'});
175 print STDERR "There is no $rssfile in this or parent ".
176 "directories, you must create one with mkgalrss.pl\n";
183 my $fullpath .= $self->{-fullpath};
184 print "iterate in dir $fullpath\n" if ($debug);
190 unless (opendir($D,$fullpath)) {
191 warn "cannot opendir $fullpath: $!";
194 while (my $de = readdir($D)) {
195 next if ($de =~ /^\./);
196 my $child = $self->new($de);
197 my @stat = stat($child->{-fullpath});
198 $youngest = $stat[9] if ($youngest < $stat[9]);
200 push(@rdirlist,$child);
201 } elsif ($child->isimg) {
202 push(@rimglist,$child);
206 my @dirlist = sort {$a->{-base} cmp $b->{-base}} @rdirlist;
207 undef @rdirlist; # inplace sorting would be handy here
208 my @imglist = sort {$a->{-base} cmp $b->{-base}} @rimglist;
209 undef @rimglist; # optimize away unsorted versions
210 $self->{-firstimg} = $imglist[0];
212 print "Dir: $self->{-fullpath}\n" if ($debug);
214 # 1. first of all, fill title for this directory and create hidden subdirs
218 # 2. recurse into subdirectories to get their titles filled
219 # before we start writing out subalbum list
221 foreach my $dir(@dirlist) {
225 # 3. iterate through images to build cross-links,
228 foreach my $img(@imglist) {
229 # list-linking must be done before generating
230 # aux html because aux pages rely on prev/next refs
232 $previmg->{-nextimg} = $img;
233 $img->{-previmg} = $previmg;
238 # 4. create scaled versions and aux html pages
240 foreach my $img(@imglist) {
241 # scaled versions must be generated before aux html
242 # and main image index because they both rely on
243 # refs to scaled images and they may be just original
244 # images, this is not known before we try scaling.
246 # finally, make aux html pages
250 # no need to go beyond this point if the directory timestamp did not
251 # change since we built index.html file last time.
253 my @istat = stat($self->{-fullpath}.'/index.html');
254 return unless ($youngest > $istat[9]);
256 # 5. start building index.html for the directory
260 # 6. iterate through subdirectories to build subalbums list
264 foreach my $dir(@dirlist) {
270 # 7. iterate through images to build thumb list
274 foreach my $img(@imglist) {
275 print "Img: $img->{-fullpath}\n" if ($debug);
281 # 8. comlplete building index.html for the directory
288 return ( -d $self->{-fullpath} );
293 my $fullpath = $self->{-fullpath};
294 return 0 unless ( -f $fullpath );
295 my $info = image_info($fullpath);
296 if (my $error = $info->{error}) {
297 if (($error !~ "Unrecognized file format") &&
298 ($error !~ "Can't read head")) {
299 warn "File \"$fullpath\": $error\n";
304 tryapp12($info) unless ($info->{'ExifVersion'});
307 $self->{-info} = $info;
312 my $info = shift; # this is not a method
314 # dirty hack to take care of Image::Info parser strangeness
315 foreach my $k(keys %$info) {
316 $app12=substr($k,6).$info->{$k} if ($k =~ /^App12-/);
318 return unless ($app12); # bad luck
320 foreach my $ln(split /[\r\n]+/,$app12) {
321 $ln =~ s/[[:^print:]\000]/ /g;
322 unless ($seenfirstline) {
327 my ($k,$v)=split /=/,$ln,2;
328 if ($k eq 'TimeDate') {
329 $info->{'DateTime'} =
330 strftime("%Y:%m:%d %H:%M:%S", localtime($v))
332 } elsif ($k eq 'Shutter') {
333 $info->{'ExposureTime'} = '1/'.int(1000000/$v+.5);
334 } elsif ($k eq 'Flash') {
335 $info->{'Flash'} = $v?'Flash fired':'Flash did not fire';
336 } elsif ($k eq 'Type') {
337 $info->{'Model'} = $v;
338 } elsif ($k eq 'Version') {
339 $info->{'Software'} = $v;
340 } elsif ($k eq 'Fnumber') {
341 $info->{'FNumber'} = $v;
348 my $fullpath = $self->{-fullpath};
349 for my $subdir(@sizes, 'html') {
350 my $tdir=sprintf "%s/.%s",$self->{-fullpath},$subdir;
351 mkdir($tdir,0755) unless ( -d $tdir );
358 my $fullpath = $self->{-fullpath};
361 if (open($T,'<'.$fullpath.'/.title')) {
363 $title =~ s/[\r\n]*$//;
366 if ($asktitle || (!$title && !$noasktitle)) {
367 my $prompt = $self->{-base};
368 $prompt = '/' unless ($prompt);
369 my $OUT = $term->OUT || \*STDOUT;
370 print $OUT "Enter title for $fullpath\n";
371 $title = $term->readline($prompt.' >',$title);
372 $term->addhistory($title) if ($title);
373 if (open($T,'>'.$fullpath.'/.title')) {
374 print $T $title,"\n";
379 $title=substr($fullpath,length($self->{-root}));
381 $self->{-title}=$title;
382 print "title in $fullpath is $title\n" if ($debug);
387 my $fn = $self->{-fullpath};
388 my $name = $self->{-base};
389 my $dn = $self->{-parent}->{-fullpath};
390 my ($w, $h) = dim($self->{-info});
391 my $max = ($w > $h)?$w:$h;
393 foreach my $size(@sizes) {
394 my $nref = '.'.$size.'/'.$name;
395 my $nfn = $dn.'/'.$nref;
396 my $factor=$size/$max;
398 $self->{$size}->{'url'} = $name; # unscaled version
399 $self->{$size}->{'dim'} = [$w, $h];
401 $self->{$size}->{'url'} = $nref;
402 $self->{$size}->{'dim'} = [int($w*$factor+.5),
404 if (isnewer($fn,$nfn)) {
405 doscaling($fn,$nfn,$factor,$w,$h);
412 my ($fn1,$fn2) = @_; # this is not a method
413 my @stat1=stat($fn1);
414 my @stat2=stat($fn2);
415 return (!@stat2 || ($stat1[9] > $stat2[9]));
416 # true if $fn2 is absent or is older than $fn1
420 my ($src,$dest,$factor,$w,$h) = @_; # this is not a method
424 my $im = new Image::Magick;
425 print "doscaling $src -> $dest by $factor\n" if ($debug);
426 if ($err = $im->Read($src)) {
427 warn "ImageMagick: read \"$src\": $err";
429 $im->Scale(width=>$w*$factor,height=>$h*$factor);
430 $err=$im->Write($dest);
431 warn "ImageMagick: write \"$dest\": $err" if ($err);
435 if ($err) { # fallback to command-line tools
436 system("djpeg \"$src\" | pnmscale \"$factor\" | cjpeg >\"$dest\"");
442 my $name = $self->{-base};
443 my $dn = $self->{-parent}->{-fullpath};
444 my $pref = $self->{-previmg}->{-base};
445 my $nref = $self->{-nextimg}->{-base};
446 my $inc = $self->{-inc};
447 my $title = $self->{-info}->{'Comment'};
448 $title = $name unless ($title);
450 print "slide: \"$title\": \"$pref\"->\"$name\"->\"$nref\"\n" if ($debug);
453 for my $refresh('static', 'slide') {
454 my $fn = sprintf("%s/.html/%s-%s.html",$dn,$name,$refresh);
455 if (isnewer($self->{-fullpath},$fn)) {
456 my $imgsrc = '../'.$self->{$sizes[1]}->{'url'};
460 $fwdref = sprintf("%s-%s.html",$nref,$refresh);
462 $fwdref = '../index.html';
465 $bakref = sprintf("%s-%s.html",$pref,$refresh);
467 $bakref = '../index.html';
471 if ($refresh eq 'slide') {
472 $toggleref=sprintf("%s-static.html",$name);
473 $toggletext = 'Stop!';
475 $toggleref=sprintf("%s-slide.html",$name);
476 $toggletext = 'Play->';
479 unless (open($F,'>'.$fn)) {
480 warn "cannot open \"$fn\": $!";
483 binmode($F, ":utf8");
484 if ($refresh eq 'slide') {
489 -head=>meta({-http_equiv=>'Refresh',
490 -content=>"3; url=$fwdref"}),
491 -style=>{-src=>$inc."gallery.css"},
493 comment("Created by ".$version),"\n";
496 print $F start_html(-title=>$title,
499 -style=>{-src=>$inc."gallery.css"},
501 comment("Created by ".$version),"\n";
503 print $F start_table({-class=>'navi'}),start_Tr,"\n",
504 td(a({-href=>"../index.html"},"Index")),"\n",
505 td(a({-href=>$bakref},"<<Prev")),"\n",
506 td(a({-href=>$toggleref},$toggletext)),"\n",
507 td(a({-href=>$fwdref},"Next>>")),"\n",
508 td({-class=>'title'},$title),"\n",
511 center(table({-class=>'picframe'},
512 Tr(td(img({-src=>$imgsrc}))))),"\n",
519 my $fn = sprintf("%s/.html/%s-info.html",$dn,$name);
520 if (isnewer($self->{-fullpath},$fn)) {
522 unless (open($F,'>'.$fn)) {
523 warn "cannot open \"$fn\": $!";
526 my $imgsrc = sprintf("../.%s/%s",$sizes[0],$name);
527 print $F start_html(-title=>$title,
529 -style=>{-src=>$inc."gallery.css"},
531 {-src=>$inc."mootools.js"},
532 {-src=>$inc."urlparser.js"},
533 {-src=>$inc."infopage.js"},
535 comment("Created by ".$version),"\n",
538 table({-class=>'ipage'},
539 Tr(td(img({-src=>$imgsrc})),
540 td($self->infotable))),
541 a({-href=>'../index.html',-class=>'conceal'},
551 my $fn = $self->{-fullpath}.'/index.html';
552 my $block = $self->{-fullpath}.'/.noindex';
553 $fn = '/dev/null' if ( -f $block );
555 unless (open($IND,'>'.$fn)) {
556 warn "cannot open $fn: $!";
559 binmode($IND, ":utf8");
560 $self->{-IND} = $IND;
562 my $inc = $self->{-inc};
563 my $title = $self->{-title};
566 $rsslink=Link({-rel=>'alternate',
567 -type=>'application/rss+xml',
569 -href=>$self->{-rss}});
571 print $IND start_html(-title => $title,
574 -style=>{-src=>$inc."gallery.css"},
576 {-src=>$inc."mootools.js"},
577 {-src=>$inc."overlay.js"},
578 {-src=>$inc."urlparser.js"},
579 {-src=>$inc."multibox.js"},
580 {-src=>$inc."showwin.js"},
581 {-src=>$inc."controls.js"},
582 {-src=>$inc."show.js"},
583 {-src=>$inc."gallery.js"},
585 comment("Created by ".$version),"\n",
586 start_div({-class => 'indexContainer',
587 -id => 'indexContainer'}),
588 a({-href=>"../index.html"},"UP"),"\n",
596 my $IND = $self->{-IND};
598 print $IND end_center,end_div,end_html,"\n";
600 close($IND) if ($IND);
603 my $rsstitle=sprintf "%s [%d images, %d subalbums]",
607 my $rsslink=$rssobj->{'rss'}->channel('link')."index.html";
608 $rssobj->{'rss'}->add_item(
609 title => $self->{-title},
611 description => $rsstitle,
618 my $IND = $self->{-IND};
620 print $IND h2("Albums"),"\n",start_table,"\n";
625 my $IND = $self->{-parent}->{-IND};
626 my $name = $self->{-base};
627 my $title = $self->{-title};
629 $self->{-parent}->{-numofsubs}++;
630 print $IND Tr(td(a({-href=>$name.'/index.html'},$name)),
631 td(a({-href=>$name.'/index.html'},$title))),"\n";
636 my $IND = $self->{-IND};
638 print $IND end_table,"\n",br({-clear=>'all'}),hr,"\n\n";
643 my $IND = $self->{-IND};
644 my $first = $self->{-firstimg}->{-base};
645 my $slideref = sprintf(".html/%s-slide.html",$first);
647 print $IND h2("Images ",
648 a({-href=>$slideref,-class=>'showStart',-id=>$first},
649 '> slideshow')),"\n";
654 my $IND = $self->{-parent}->{-IND};
655 my $name = $self->{-base};
656 my $title = $self->{-info}->{'Comment'};
657 $title = $name unless ($title);
658 my $thumb = $self->{$sizes[0]}->{'url'};
659 my $info = $self->{-info};
660 my ($w, $h) = dim($info);
662 my $i=0+$self->{-parent}->{-numofimgs};
663 $self->{-parent}->{-numofimgs}++;
665 print $IND a({-name=>$name}),"\n",
666 start_table({-class=>'slide'}),start_Tr,start_td,"\n",
667 div({-class=>'slidetitle',-id=>$name},
668 "\n ",a({-href=>".html/$name-info.html",
669 -title=>'Image Info: '.$name,
672 div({-class=>'slideimage',-id=>$name},
673 "\n ",a({-href=>".html/$name-static.html",
677 img({-src=>$thumb})),"\n"),"\n",
678 start_div({-class=>'varimages',-id=>$name,-title=>$title}),"\n";
679 foreach my $sz(@sizes) {
680 my $src=$self->{$sz}->{'url'};
681 my $w=$self->{$sz}->{'dim'}->[0];
682 my $h=$self->{$sz}->{'dim'}->[1];
683 print $IND " ",a({-href=>$src,
685 -title=>"Reduced to ".$w."x".$h},
688 print $IND " ",a({-href=>$name,
689 -title=>'Original'},$w."x".$h),
691 end_td,end_Tr,end_table,"\n";
696 my $IND = $self->{-IND};
698 print $IND br({-clear=>'all'}),hr,"\n\n";
703 my $info = $self->{-info};
720 $msg.=start_table({-class=>'infotable'})."\n";
721 foreach my $k(@infokeys) {
722 $msg.=Tr(td($k.":"),td($info->{$k}))."\n" if ($info->{$k});
724 $msg.=end_table."\n";