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