c861d707527df787de6224a82704a7805a576568
[ikiwiki.git] / 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
69         eval q{use Image::Magick};
70         error gettext("Image::Magick is not installed") if $@;
71         my $im = Image::Magick->new();
72         my $imglink;
73         my $r = $im->Read($srcfile);
74         error sprintf(gettext("failed to read %s: %s"), $file, $r) if $r;
75         
76         my ($dwidth, $dheight);
77
78         if ($params{size} ne 'full') {
79                 my ($w, $h) = ($params{size} =~ /^(\d*)x(\d*)$/);
80                 error sprintf(gettext('wrong size format "%s" (should be WxH)'), $params{size})
81                         unless (defined $w && defined $h &&
82                                 (length $w || length $h));
83                 
84                 if ((length $w && $w > $im->Get("width")) ||
85                     (length $h && $h > $im->Get("height"))) {
86                         # resizing larger
87                         $imglink = $file;
88
89                         # don't generate larger image, just set display size
90                         if (length $w && length $h) {
91                                 ($dwidth, $dheight)=($w, $h);
92                         }
93                         # avoid division by zero on 0x0 image
94                         elsif ($im->Get("width") == 0 || $im->Get("height") == 0) {
95                                 ($dwidth, $dheight)=(0, 0);
96                         }
97                         # calculate unspecified size from the other one, preserving
98                         # aspect ratio
99                         elsif (length $w) {
100                                 $dwidth=$w;
101                                 $dheight=$w / $im->Get("width") * $im->Get("height");
102                         }
103                         elsif (length $h) {
104                                 $dheight=$h;
105                                 $dwidth=$h / $im->Get("height") * $im->Get("width");
106                         }
107                 }
108                 else {
109                         # resizing smaller
110                         my $outfile = "$config{destdir}/$dir/${w}x${h}-$base";
111                         $imglink = "$dir/${w}x${h}-$base";
112                 
113                         will_render($params{page}, $imglink);
114
115                         if (-e $outfile && (-M $srcfile >= -M $outfile)) {
116                                 $im = Image::Magick->new;
117                                 $r = $im->Read($outfile);
118                                 error sprintf(gettext("failed to read %s: %s"), $outfile, $r) if $r;
119                         }
120                         else {
121                                 $r = $im->Resize(geometry => "${w}x${h}");
122                                 error sprintf(gettext("failed to resize: %s"), $r) if $r;
123
124                                 # don't actually write resized file in preview mode;
125                                 # rely on width and height settings
126                                 if (! $params{preview}) {
127                                         $im->set($issvg ? (magick => 'png') : ());
128                                         my @blob = $im->ImageToBlob();
129                                         writefile($imglink, $config{destdir}, $blob[0], 1);
130                                 }
131                                 else {
132                                         $imglink = $file;
133                                 }
134                         }
135
136                         # always get the true size of the resized image
137                         $dwidth  = $im->Get("width"); 
138                         $dheight = $im->Get("height");
139                 }
140         }
141         else {
142                 $imglink = $file;
143                 $dwidth = $im->Get("width");
144                 $dheight = $im->Get("height");
145         }
146         
147         if (! defined($dwidth) || ! defined($dheight)) {
148                 error sprintf(gettext("failed to determine size of image %s"), $file)
149         }
150
151         my ($fileurl, $imgurl);
152         if (! $params{preview}) {
153                 $fileurl=urlto($file, $params{destpage});
154                 $imgurl=urlto($imglink, $params{destpage});
155         }
156         else {
157                 $fileurl=urlto($file);
158                 $imgurl=urlto($imglink);
159         }
160
161         if (! exists $params{class}) {
162                 $params{class}="img";
163         }
164
165         my $attrs='';
166         foreach my $attr (qw{alt title class id hspace vspace}) {
167                 if (exists $params{$attr}) {
168                         $attrs.=" $attr=\"$params{$attr}\"";
169                 }
170         }
171         
172         my $imgtag='<img src="'.$imgurl.
173                 '" width="'.$dwidth.
174                 '" height="'.$dheight.'"'.
175                 $attrs.
176                 (exists $params{align} && ! exists $params{caption} ? ' align="'.$params{align}.'"' : '').
177                 ' />';
178
179         my $link;
180         if (! defined $params{link}) {
181                 $link=$fileurl;
182         }
183         elsif ($params{link} =~ /^\w+:\/\//) {
184                 $link=$params{link};
185         }
186
187         if (defined $link) {
188                 $imgtag='<a href="'.$link.'">'.$imgtag.'</a>';
189         }
190         else {
191                 my $b = bestlink($params{page}, $params{link});
192         
193                 if (length $b) {
194                         add_depends($params{page}, $b, deptype("presence"));
195                         $imgtag=htmllink($params{page}, $params{destpage},
196                                 $params{link}, linktext => $imgtag,
197                                 noimageinline => 1,
198                         );
199                 }
200         }
201
202         if (exists $params{caption}) {
203                 return '<table class="img'.
204                         (exists $params{align} ? " align-$params{align}" : "").
205                         '">'.
206                         '<caption>'.$params{caption}.'</caption>'.
207                         '<tr><td>'.$imgtag.'</td></tr>'.
208                         '</table>';
209         }
210         else {
211                 return $imgtag;
212         }
213 }
214
215 1