Add NetBSD-style 2-clause BSD license.

[git.ikiwiki.info.git] / IkiWiki / Plugin / img.pm

diff --git a/IkiWiki/Plugin/img.pm b/IkiWiki/Plugin/img.pm
index b1c9db80c969055edc59227b5c79d83945b7b911..9ae85c4e682839d7a2179785e1c4e504d6ecc866 100644 (file)
--- a/IkiWiki/Plugin/img.pm
+++ b/IkiWiki/Plugin/img.pm
@@ -5,64 +5,99 @@ package IkiWiki::Plugin::img;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 
 my %imgdefaults;
 
 
 my %imgdefaults;
 

-sub import { #{{{
+sub import {
+       hook(type => "getsetup", id => "img", call => \&getsetup);

        hook(type => "preprocess", id => "img", call => \&preprocess, scan => 1);
        hook(type => "preprocess", id => "img", call => \&preprocess, scan => 1);

-} #}}}
+}

 
 

-sub preprocess (@) { #{{{
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+}
+
+sub preprocess (@) {

        my ($image) = $_[0] =~ /$config{wiki_file_regexp}/; # untaint
        my %params=@_;
 
        my ($image) = $_[0] =~ /$config{wiki_file_regexp}/; # untaint
        my %params=@_;
 

-       if (! exists $imgdefaults{$params{page}}) {
-               $imgdefaults{$params{page}} = {};
+       if (exists $imgdefaults{$params{page}}) {
+               foreach my $key (keys %{$imgdefaults{$params{page}}}) {
+                       if (! exists $params{$key}) {
+                               $params{$key}=$imgdefaults{$params{page}}->{$key};
+                       }
+               }
+       }
+
+       if (! exists $params{size}) {
+               $params{size}='full';

        }
        }

-       my $size = $params{size} || $imgdefaults{$params{page}}->{size} || 'full';
-       my $alt = $params{alt} || $imgdefaults{$params{page}}->{alt} || '';

 
        if ($image eq 'defaults') {
 
        if ($image eq 'defaults') {

-               $imgdefaults{$params{page}} = {
-                       size => $size,
-                       alt => $alt,
-               };
+               $imgdefaults{$params{page}} = \%params;

                return '';
        }
 
                return '';
        }
 

-       push @{$links{$params{page}}}, $image;
+       add_link($params{page}, $image);
+
+       # optimisation: detect scan mode, and avoid generating the image
+       if (! defined wantarray) {
+               return;
+       }
+

        my $file = bestlink($params{page}, $image);
        my $file = bestlink($params{page}, $image);

+       my $srcfile = srcfile($file, 1);
+       if (! length $file || ! defined $srcfile) {
+               return htmllink($params{page}, $params{destpage}, $image);
+       }

 
        my $dir = $params{page};
        my $base = IkiWiki::basename($file);
 
        eval q{use Image::Magick};
 
        my $dir = $params{page};
        my $base = IkiWiki::basename($file);
 
        eval q{use Image::Magick};

-       error($@) if $@;
+       error gettext("Image::Magick is not installed") if $@;

        my $im = Image::Magick->new;
        my $imglink;
        my $r;
 
        my $im = Image::Magick->new;
        my $imglink;
        my $r;
 

-       if ($size ne 'full') {
-               my ($w, $h) = ($size =~ /^(\d+)x(\d+)$/);
-               return "[[img ".sprintf(gettext('bad size "%s"'), $size)."]]"
-                       unless (defined $w && defined $h);
+       my ($dwidth, $dheight);
+
+       if ($params{size} ne 'full') {
+               add_depends($params{page}, $image);
+
+               my ($w, $h) = ($params{size} =~ /^(\d*)x(\d*)$/);
+               error sprintf(gettext('wrong size format "%s" (should be WxH)'), $params{size})
+                       unless (defined $w && defined $h &&
+                               (length $w || length $h));

 
                my $outfile = "$config{destdir}/$dir/${w}x${h}-$base";
                $imglink = "$dir/${w}x${h}-$base";
                
                will_render($params{page}, $imglink);
 
 
                my $outfile = "$config{destdir}/$dir/${w}x${h}-$base";
                $imglink = "$dir/${w}x${h}-$base";
                
                will_render($params{page}, $imglink);
 

-               if (-e $outfile && (-M srcfile($file) >= -M $outfile)) {
+               if (-e $outfile && (-M $srcfile >= -M $outfile)) {

                        $r = $im->Read($outfile);
                        $r = $im->Read($outfile);

-                       return "[[img ".sprintf(gettext("failed to read %s: %s"), $outfile, $r)."]]" if $r;
+                       error sprintf(gettext("failed to read %s: %s"), $outfile, $r) if $r;

                }
                else {
                }
                else {

-                       $r = $im->Read(srcfile($file));
-                       return "[[img ".sprintf(gettext("failed to read %s: %s"), $file, $r)."]]" if $r;
+                       $r = $im->Read($srcfile);
+                       error sprintf(gettext("failed to read %s: %s"), $file, $r) if $r;
+
+                       # don't resize any larger
+                       my ($rw, $rh) = ($w, $h);
+                       if ((length $rw && $rw > $im->Get("width")) ||
+                           (length $rh && $rh > $im->Get("height"))) {
+                               $rw=$im->Get("width");
+                               $rh=$im->Get("height");
+                       }

 
 

-                       $r = $im->Resize(geometry => "${w}x${h}");
-                       return "[[img ".sprinftf(gettext("failed to resize: %s"), $r)."]]" if $r;
+                       $r = $im->Resize(geometry => "${rw}x${rh}");
+                       error sprintf(gettext("failed to resize: %s"), $r) if $r;

 
                        # don't actually write file in preview mode
                        if (! $params{preview}) {
 
                        # don't actually write file in preview mode
                        if (! $params{preview}) {


@@ -73,15 +108,36 @@ sub preprocess (@) { #{{{
                                $imglink = $file;
                        }
                }
                                $imglink = $file;
                        }
                }

+
+               # since we don't really resize larger, set the display
+               # size, so the browser can scale the image up if necessary
+               if (length $w && length $h) {
+                       ($dwidth, $dheight)=($w, $h);
+               }
+               # avoid division by zero on 0x0 image
+               elsif ($im->Get("width") == 0 || $im->Get("height") == 0) {
+                       ($dwidth, $dheight)=(0, 0);
+               }
+               # calculate unspecified size from the other one, preserving
+               # aspect ratio
+               elsif (length $w) {
+                       $dwidth=$w;
+                       $dheight=$w / $im->Get("width") * $im->Get("height");
+               }
+               elsif (length $h) {
+                       $dheight=$h;
+                       $dwidth=$h / $im->Get("height") * $im->Get("width");
+               }
+

        }
        else {
        }
        else {

-               $r = $im->Read(srcfile($file));
-               return "[[img ".sprintf(gettext("failed to read %s: %s"), $file, $r)."]]" if $r;
+               $r = $im->Read($srcfile);
+               error sprintf(gettext("failed to read %s: %s"), $file, $r) if $r;

                $imglink = $file;
                $imglink = $file;

+               $dwidth = $im->Get("width");
+               $dheight = $im->Get("height");

        }
 
        }
 

-       add_depends($imglink, $params{page});
-

        my ($fileurl, $imgurl);
        if (! $params{preview}) {
                $fileurl=urlto($file, $params{destpage});
        my ($fileurl, $imgurl);
        if (! $params{preview}) {
                $fileurl=urlto($file, $params{destpage});


@@ -93,12 +149,45 @@ sub preprocess (@) { #{{{
        }
 
        if (! defined($im->Get("width")) || ! defined($im->Get("height"))) {
        }
 
        if (! defined($im->Get("width")) || ! defined($im->Get("height"))) {

-               return "[[img ".sprintf(gettext("failed to determine size of image %s"), $file)."]]";
+               error sprintf(gettext("failed to determine size of image %s"), $file)
+       }
+
+       my $imgtag='<img src="'.$imgurl.
+               '" width="'.$dwidth.
+               '" height="'.$dheight.'"'.
+               (exists $params{alt} ? ' alt="'.$params{alt}.'"' : '').
+               (exists $params{title} ? ' title="'.$params{title}.'"' : '').
+               (exists $params{align} ? ' align="'.$params{align}.'"' : '').
+               (exists $params{class} ? ' class="'.$params{class}.'"' : '').
+               (exists $params{id} ? ' id="'.$params{id}.'"' : '').
+               ' />';
+
+       if (! defined $params{link} || lc($params{link}) eq 'yes') {
+               $imgtag='<a href="'.$fileurl.'">'.$imgtag.'</a>';
+       }
+       elsif ($params{link} =~ /^\w+:\/\//) {
+               $imgtag='<a href="'.$params{link}.'">'.$imgtag.'</a>';
+       }
+       else {
+               my $b = bestlink($params{page}, $params{link});
+       
+               if (length $b) {
+                       add_depends($params{page}, $b);
+                       $imgtag=htmllink($params{page}, $params{destpage},
+                               $params{link}, linktext => $imgtag,
+                               noimageinline => 1);
+               }

        }
 
        }
 

-       return '<a href="'.$fileurl.'"><img src="'.$imgurl.
-               '" alt="'.$alt.'" width="'.$im->Get("width").
-               '" height="'.$im->Get("height").'" /></a>';
-} #}}}
+       if (exists $params{caption}) {
+               return '<table class="img">'.
+                       '<caption>'.$params{caption}.'</caption>'.
+                       '<tr><td>'.$imgtag.'</td></tr>'.
+                       '</table>';
+       }
+       else {
+               return $imgtag;
+       }
+}

 
 1
 
 1