IkiWiki/Plugin/img.pm

   1 #!/usr/bin/perl
   2 # Ikiwiki enhanced image handling plugin
   3 # Christian Mock cm@tahina.priv.at 20061002
   4 package IkiWiki::Plugin::img;
   5
   6 use warnings;
   7 use strict;
   8 use IkiWiki 3.00;
   9
  10 my %imgdefaults;
  11
  12 sub import {
  13         hook(type => "getsetup", id => "img", call => \&getsetup);
  14         hook(type => "preprocess", id => "img", call => \&preprocess, scan => 1);
  15 }
  16
  17 sub getsetup () {
  18         return
  19                 plugin => {
  20                         safe => 1,
  21                         rebuild => undef,
  22                         section => "widget",
  23                 },
  24 }
  25
  26 sub preprocess (@) {
  27         my ($image) = $_[0] =~ /$config{wiki_file_regexp}/; # untaint
  28         my %params=@_;
  29
  30         if (! defined $image) {
  31                 error("bad image filename");
  32         }
  33
  34         if (exists $imgdefaults{$params{page}}) {
  35                 foreach my $key (keys %{$imgdefaults{$params{page}}}) {
  36                         if (! exists $params{$key}) {
  37                                 $params{$key}=$imgdefaults{$params{page}}->{$key};
  38                         }
  39                 }
  40         }
  41
  42         if (! exists $params{size} || ! length $params{size}) {
  43                 $params{size}='full';
  44         }
  45
  46         if ($image eq 'defaults') {
  47                 $imgdefaults{$params{page}} = \%params;
  48                 return '';
  49         }
  50
  51         add_link($params{page}, $image);
  52         add_depends($params{page}, $image);
  53
  54         # optimisation: detect scan mode, and avoid generating the image
  55         if (! defined wantarray) {
  56                 return;
  57         }
  58
  59         my $file = bestlink($params{page}, $image);
  60         my $srcfile = srcfile($file, 1);
  61         if (! length $file || ! defined $srcfile) {
  62                 return htmllink($params{page}, $params{destpage}, $image);
  63         }
  64
  65         my $dir = $params{page};
  66         my $base = IkiWiki::basename($file);
  67         my $issvg = $base=~s/\.svg$/.png/i;
  68         my $ispdf = $base=~s/\.pdf$/.png/i;
  69
  70         eval q{use Image::Magick};
  71         error gettext("Image::Magick is not installed") if $@;
  72         my $im = Image::Magick->new();
  73         my $imglink;
  74         my $r = $im->Read($srcfile);
  75         error sprintf(gettext("failed to read %s: %s"), $file, $r) if $r;
  76
  77         my ($dwidth, $dheight);
  78
  79         if ($params{size} ne 'full') {
  80                 my ($w, $h) = ($params{size} =~ /^(\d*)x(\d*)$/);
  81                 error sprintf(gettext('wrong size format "%s" (should be WxH)'), $params{size})
  82                         unless (defined $w && defined $h &&
  83                                 (length $w || length $h));
  84
  85                 if ((length $w && $w > $im->Get("width")) ||
  86                     (length $h && $h > $im->Get("height"))) {
  87                         # resizing larger
  88                         $imglink = $file;
  89
  90                         # don't generate larger image, just set display size
  91                         if (length $w && length $h) {
  92                                 ($dwidth, $dheight)=($w, $h);
  93                         }
  94                         # avoid division by zero on 0x0 image
  95                         elsif ($im->Get("width") == 0 || $im->Get("height") == 0) {
  96                                 ($dwidth, $dheight)=(0, 0);
  97                         }
  98                         # calculate unspecified size from the other one, preserving
  99                         # aspect ratio
 100                         elsif (length $w) {
 101                                 $dwidth=$w;
 102                                 $dheight=$w / $im->Get("width") * $im->Get("height");
 103                         }
 104                         elsif (length $h) {
 105                                 $dheight=$h;
 106                                 $dwidth=$h / $im->Get("height") * $im->Get("width");
 107                         }
 108                 }
 109                 else {
 110                         # resizing smaller
 111                         my $outfile = "$config{destdir}/$dir/${w}x${h}-$base";
 112                         $imglink = "$dir/${w}x${h}-$base";
 113
 114                         will_render($params{page}, $imglink);
 115
 116                         if (-e $outfile && (-M $srcfile >= -M $outfile)) {
 117                                 $im = Image::Magick->new;
 118                                 $r = $im->Read($outfile);
 119                                 error sprintf(gettext("failed to read %s: %s"), $outfile, $r) if $r;
 120                         }
 121                         else {
 122                                 $r = $im->Resize(geometry => "${w}x${h}");
 123                                 error sprintf(gettext("failed to resize: %s"), $r) if $r;
 124
 125                                 # don't actually write resized file in preview mode;
 126                                 # rely on width and height settings
 127                                 if (! $params{preview}) {
 128                                         $im->set(($issvg || $ispdf) ? (magick => 'png') : ());
 129                                         my @blob = $im->ImageToBlob();
 130                                         writefile($imglink, $config{destdir}, $blob[0], 1);
 131                                 }
 132                                 else {
 133                                         $imglink = $file;
 134                                 }
 135                         }
 136
 137                         # always get the true size of the resized image
 138                         $dwidth  = $im->Get("width");
 139                         $dheight = $im->Get("height");
 140                 }
 141         }
 142         else {
 143                 $imglink = $file;
 144                 $dwidth = $im->Get("width");
 145                 $dheight = $im->Get("height");
 146         }
 147
 148         if (! defined($dwidth) || ! defined($dheight)) {
 149                 error sprintf(gettext("failed to determine size of image %s"), $file)
 150         }
 151
 152         my ($fileurl, $imgurl);
 153         if (! $params{preview}) {
 154                 $fileurl=urlto($file, $params{destpage});
 155                 $imgurl=urlto($imglink, $params{destpage});
 156         }
 157         else {
 158                 $fileurl=urlto($file);
 159                 $imgurl=urlto($imglink);
 160         }
 161
 162         if (! exists $params{class}) {
 163                 $params{class}="img";
 164         }
 165
 166         my $attrs='';
 167         foreach my $attr (qw{alt title class id hspace vspace}) {
 168                 if (exists $params{$attr}) {
 169                         $attrs.=" $attr=\"$params{$attr}\"";
 170                 }
 171         }
 172
 173         my $imgtag='<img src="'.$imgurl.
 174                 '" width="'.$dwidth.
 175                 '" height="'.$dheight.'"'.
 176                 $attrs.
 177                 (exists $params{align} && ! exists $params{caption} ? ' align="'.$params{align}.'"' : '').
 178                 ' />';
 179
 180         my $link;
 181         if (! defined $params{link}) {
 182                 $link=$fileurl;
 183         }
 184         elsif ($params{link} =~ /^\w+:\/\//) {
 185                 $link=$params{link};
 186         }
 187
 188         if (defined $link) {
 189                 $imgtag='<a href="'.$link.'">'.$imgtag.'</a>';
 190         }
 191         else {
 192                 my $b = bestlink($params{page}, $params{link});
 193
 194                 if (length $b) {
 195                         add_depends($params{page}, $b, deptype("presence"));
 196                         $imgtag=htmllink($params{page}, $params{destpage},
 197                                 $params{link}, linktext => $imgtag,
 198                                 noimageinline => 1,
 199                         );
 200                 }
 201         }
 202
 203         if (exists $params{caption}) {
 204                 return '<table class="img'.
 205                         (exists $params{align} ? " align-$params{align}" : "").
 206                         '">'.
 207                         '<caption>'.$params{caption}.'</caption>'.
 208                         '<tr><td>'.$imgtag.'</td></tr>'.
 209                         '</table>';
 210         }
 211         else {
 212                 return $imgtag;
 213         }
 214 }
 215
 216 1