Commit | Line | Data |
---|---|---|
6ac5dde2 MW |
1 | ### -*-cperl-*- |
2 | ### | |
3 | ### Main output for Trivial Gallery. | |
4 | ### | |
5 | ### (c) 2021 Mark Wooding | |
6 | ### | |
7 | ||
8 | ###----- Licensing notice --------------------------------------------------- | |
9 | ### | |
10 | ### This file is part of Trivial Gallery. | |
11 | ### | |
12 | ### Trivial Gallery is free software: you can redistribute it and/or modify | |
13 | ### it under the terms of the GNU Affero General Public License as | |
14 | ### published by the Free Software Foundation; either version 3 of the | |
15 | ### License, or (at your option) any later version. | |
16 | ### | |
17 | ### Trivial Gallery is distributed in the hope that it will be useful, but | |
18 | ### WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
20 | ### Affero General Public License for more details. | |
21 | ### | |
22 | ### You should have received a copy of the GNU Affero General Public | |
23 | ### License along with Trivial Gallery. If not, see | |
24 | ### <https://www.gnu.org/licenses/>. | |
25 | ||
26 | package TrivGal; | |
27 | ||
28 | use autodie qw{:all}; | |
29 | ||
30 | use Errno; | |
31 | use Exporter qw{import}; | |
6ac5dde2 | 32 | use File::stat; |
bda837fc | 33 | use Image::ExifTool qw{}; |
6ac5dde2 | 34 | use Image::Imlib2; |
8b97a4e3 | 35 | use Image::Size qw{}; |
6ac5dde2 MW |
36 | use User::pwent; |
37 | use POSIX; | |
38 | ||
39 | our @EXPORT; | |
40 | sub export (@) { push @EXPORT, @_; } | |
41 | ||
42 | ###-------------------------------------------------------------------------- | |
43 | ### Internal utilities. | |
44 | ||
45 | sub read_or_set ($\$@) { | |
46 | my ($me, $ref, @args) = @_; | |
47 | if (@args == 0) { return $$ref; } | |
48 | elsif (@args == 1) { $$ref = $args[0]; return $me; } | |
49 | elsif (@args > 1) { die "too many arguments"; } | |
50 | } | |
51 | ||
52 | ###-------------------------------------------------------------------------- | |
53 | ### Random utilities. | |
54 | ||
55 | export qw{join_paths}; | |
56 | sub join_paths (@) { | |
57 | my @p = @_; | |
58 | my $p = ""; | |
59 | ELT: for my $e (@p) { | |
e9eac06d MW |
60 | $e =~ s#^/{2,}#/#; |
61 | $e =~ s#([^/])/+$#$1#; | |
6ac5dde2 | 62 | if ($e eq "") { next ELT; } |
e9eac06d | 63 | elsif ($p eq "" || $e =~ m#^/#) { $p = $e; } |
6ac5dde2 MW |
64 | else { $p = "$p/$e"; } |
65 | } | |
66 | return $p; | |
67 | } | |
68 | ||
69 | export qw{split_path}; | |
70 | sub split_path ($) { | |
71 | my ($path) = @_; | |
72 | ||
9fc5e8c1 MW |
73 | my ($dir, $base, $ext) = |
74 | $path =~ m#^ (?: (.*) /)? | |
75 | (?: ([^/]*) \.)? | |
76 | ([^./]*) $#x; | |
6ac5dde2 MW |
77 | if (defined $base) { $ext = ".$ext"; } |
78 | else { $base = $ext; $ext = ""; } | |
79 | return ($dir, $base, $ext); | |
80 | } | |
81 | ||
82 | export qw{urlencode}; | |
83 | sub urlencode ($) { | |
84 | my ($u) = @_; | |
e9eac06d | 85 | $u =~ s#([^0-9a-zA-Z_./~-])#sprintf "%%%02x", ord $1#eg; |
6ac5dde2 MW |
86 | return $u; |
87 | } | |
88 | ||
89 | export qw{urldecode}; | |
90 | sub urldecode ($) { | |
91 | my ($u) = @_; | |
e9eac06d | 92 | $u =~ s#\%([0-9a-fA-F]{2})#chr hex $1#eg; |
6ac5dde2 MW |
93 | return $u; |
94 | } | |
95 | ||
96 | ###-------------------------------------------------------------------------- | |
97 | ### Image types. | |
98 | ||
99 | our %TYPE; | |
100 | ||
101 | package TrivGal::ImageType { | |
102 | sub new ($$) { | |
103 | my ($cls, $ext) = @_; | |
104 | return $TYPE{$ext} = bless { ext => $ext }, $cls; | |
105 | } | |
106 | sub ext ($) { | |
107 | my ($me, @args) = @_; | |
108 | return $me->{ext}; | |
109 | } | |
110 | sub mimetype ($@) { | |
111 | my ($me, @args) = @_; | |
112 | return TrivGal::read_or_set $me, $me->{mimetype}, @args; | |
113 | } | |
114 | sub imlibfmt ($@) { | |
115 | my ($me, @args) = @_; | |
116 | return TrivGal::read_or_set $me, $me->{imlibfmt}, @args; | |
117 | } | |
65e4ebfd | 118 | } |
6ac5dde2 MW |
119 | |
120 | TrivGal::ImageType->new(".jpg")->mimetype("image/jpeg")->imlibfmt("jpeg"); | |
121 | TrivGal::ImageType->new(".png")->mimetype("image/png")->imlibfmt("png"); | |
122 | ||
123 | ###-------------------------------------------------------------------------- | |
124 | ### Configuration. | |
125 | ||
126 | export qw{$SCOPE $SUFFIX}; | |
127 | our $SCOPE //= $::SCOPE; | |
128 | our $SUFFIX //= $::SUFFIX; | |
129 | ||
130 | export qw{$IMGROOT $CACHE $TMP}; | |
131 | our $IMGROOT //= "$ENV{HOME}/publish/$SCOPE-html$SUFFIX/tgal-images"; | |
132 | our $CACHE //= | |
133 | ($ENV{XDG_CACHE_HOME} // "$ENV{HOME}/.cache") . | |
134 | "/tgal/$SCOPE$SUFFIX"; | |
135 | our $TMP //= "$CACHE/tmp"; | |
136 | ||
137 | export qw{$ROOTURL $IMGURL $CACHEURL $STATICURL $SCRIPTURL}; | |
138 | my $user = getpwuid($>)->name; | |
139 | our $ROOTURL //= "/~$user"; | |
140 | our $IMGURL //= "$ROOTURL/tgal-images"; | |
141 | our $CACHEURL //= "$ROOTURL/tgal-cache"; | |
142 | our $STATICURL //= "$ROOTURL/tgal-static"; | |
143 | our $SCRIPTURL; | |
144 | ||
a38a867d MW |
145 | export qw{$SRCURL}; |
146 | our $SRCURL = "https://git.distorted.org.uk/~mdw/tgal/"; | |
147 | ||
6ac5dde2 | 148 | export qw{%SIZE}; |
1408b7a2 MW |
149 | our %SIZE = (smallthumb => 96, |
150 | medthumb => 144, | |
151 | bigthumb => 228, | |
40c686c2 MW |
152 | small => 480, |
153 | embed => 720, | |
1408b7a2 | 154 | view => 1200); |
6ac5dde2 MW |
155 | |
156 | export qw{init}; | |
157 | my $initp = 0; | |
158 | sub init () { | |
159 | my $m = HTML::Mason::Request->instance; | |
160 | my $r = $m->cgi_request; | |
161 | ||
162 | $m->interp->set_escape(u => sub { my ($r) = @_; $$r = urlencode $$r; }); | |
163 | ||
164 | return unless !$initp; | |
165 | ||
166 | $SCRIPTURL //= $r->subprocess_env("SCRIPT_NAME"); | |
167 | $initp = 1; | |
168 | } | |
169 | ||
170 | ###-------------------------------------------------------------------------- | |
171 | ### Temporary files. | |
172 | ||
173 | export qw{clean_temp_files}; | |
174 | sub clean_temp_files () { | |
175 | my $d; | |
176 | ||
177 | eval { opendir $d, $TMP; }; | |
178 | if ($@) { | |
179 | if ($@->isa("autodie::exception") && $@->errno == ENOENT) { return; } | |
180 | else { die $@; } | |
181 | } | |
182 | my $now = time; | |
183 | FILE: while (my $name = readdir $d) { | |
184 | next FILE unless $name =~ /^t(\d+)\-/; | |
185 | my $pid = $1; | |
186 | next FILE if kill 0, $pid; | |
187 | my $f = "$TMP/$name"; | |
188 | my $st = stat $name; | |
189 | next FILE if $now - $st->mtime() < 300; | |
190 | unlink $f; | |
191 | } | |
192 | closedir $d; | |
193 | } | |
194 | ||
195 | ###-------------------------------------------------------------------------- | |
196 | ### Scaled images. | |
197 | ||
bda837fc MW |
198 | my %ORIENT = |
199 | (1 => [0, 0], | |
200 | 2 => [0, 1], | |
201 | 3 => [2, 0], | |
202 | 4 => [2, 1], | |
203 | 5 => [3, 1], | |
204 | 6 => [1, 0], | |
205 | 7 => [1, 1], | |
206 | 8 => [3, 0]); | |
207 | ||
4e74ddf4 MW |
208 | package TrivGal::Image { |
209 | use File::Path qw{make_path}; | |
210 | use File::stat; | |
211 | ||
212 | sub new ($$) { | |
213 | my ($cls, $path) = @_; | |
214 | my $imgpath = "$IMGROOT/$path"; | |
215 | my $st = stat $imgpath or die "no image `$path'"; | |
216 | return bless { | |
4fcd273f | 217 | path => $path, imgpath => $imgpath, |
4e74ddf4 | 218 | mtime => $st->mtime, |
8b97a4e3 MW |
219 | img => undef, |
220 | _wd => undef, _ht => undef, | |
221 | sz => undef | |
4e74ddf4 MW |
222 | }, $cls; |
223 | } | |
224 | ||
8b97a4e3 MW |
225 | sub _getsz ($) { |
226 | my ($me) = @_; | |
227 | return if defined $me->{_wd}; | |
228 | ||
229 | my ($wd, $ht, $err) = Image::Size::imgsize $me->{imgpath}; | |
230 | defined $wd or die "failed to read size of `$me->{path}': $err"; | |
231 | my $sz = $wd; if ($sz < $ht) { $sz = $ht; } | |
232 | @$me{"_wd", "_ht", "sz"} = ($wd, $ht, $sz); | |
233 | } | |
234 | ||
235 | sub sz ($) { my ($me) = @_; $me->_getsz; return $me->{sz}; } | |
236 | ||
784bdf8f MW |
237 | sub scale ($$;$) { |
238 | my ($me, $scale, $forcep) = @_; | |
1b3d6791 | 239 | my $m = HTML::Mason::Request->instance; |
4e74ddf4 MW |
240 | |
241 | my $path = $me->{path}; | |
242 | my $sz = $SIZE{$scale} or die "unknown scale `$scale'"; | |
351bb9a6 MW |
243 | my $url; |
244 | ||
373818eb | 245 | if ($me->sz <= $sz) |
351bb9a6 MW |
246 | { $url = $m->interp->apply_escapes("$IMGURL/$path", "u"); } |
247 | else { | |
248 | my $tail = "scale.$sz/$path"; | |
249 | my $thumb = "$CACHE/$tail"; | |
250 | my $thumburl = $m->interp->apply_escapes("$CACHEURL/$tail", "u"); | |
251 | ||
252 | my $st = stat $thumb; | |
253 | if ($st && $st->mtime > $me->{mtime}) | |
254 | { $url = $thumburl; } | |
255 | elsif (!$forcep) { | |
256 | $url = | |
257 | $m->interp->apply_escapes("$SCRIPTURL/$path", "u") . | |
258 | "?scale=$scale"; | |
259 | } else { | |
351bb9a6 MW |
260 | my $img = $me->{img}; |
261 | unless (defined $img) { | |
262 | my $exif = new Image::ExifTool; | |
263 | $exif->ExtractInfo($me->{imgpath}); | |
264 | my $orient = $exif->GetValue("Orientation", "ValueConv"); | |
265 | $img = $me->{img} = Image::Imlib2->load($me->{imgpath}); | |
266 | if (defined $orient) { | |
267 | my ($rot, $flip) = @{$ORIENT{$orient}}; | |
268 | if ($rot) { $img->image_orientate($rot); } | |
269 | if ($flip) { $img->flip_horizontal(); } | |
270 | } | |
271 | } | |
272 | ||
603ed7ab MW |
273 | my ($dir, undef, $ext) = TrivGal::split_path $thumb; |
274 | my $ty = $TYPE{lc $ext} or die "unknown type `$ext'"; | |
351bb9a6 MW |
275 | my $sc = $sz/$me->sz; |
276 | my $scaled = $img->create_scaled_image($sc*$wd, $sc*$ht); | |
277 | ||
278 | $scaled->image_set_format($ty->imlibfmt); | |
279 | $scaled->set_quality(90); | |
280 | my $new = "$TMP/t$$-$ext"; | |
281 | make_path $TMP, { mode => 0771 }; | |
282 | $scaled->save($new); | |
283 | make_path $dir, { mode => 0771 }; | |
284 | rename $new, $thumb; | |
285 | $url = $thumburl; | |
bda837fc | 286 | } |
4e74ddf4 MW |
287 | } |
288 | ||
351bb9a6 | 289 | return $url; |
4e74ddf4 | 290 | } |
6ac5dde2 MW |
291 | } |
292 | ||
293 | ###-------------------------------------------------------------------------- | |
294 | ### Directory listings. | |
295 | ||
296 | package TrivGal::Item { | |
297 | sub new ($$) { | |
298 | my ($cls, $name) = @_; | |
299 | return bless { name => $name }, $cls; | |
300 | } | |
301 | sub name ($@) { | |
302 | my ($me, @args) = @_; | |
303 | return TrivGal::read_or_set $me, $me->{name}, @args; | |
304 | } | |
305 | sub comment ($@) { | |
306 | my ($me, @args) = @_; | |
307 | return TrivGal::read_or_set $me, $me->{comment}, @args; | |
308 | } | |
65e4ebfd | 309 | } |
6ac5dde2 MW |
310 | |
311 | export qw{listdir}; | |
312 | sub listdir ($) { | |
313 | my ($path) = @_; | |
314 | my (@d, @f); | |
315 | my $ix = undef; | |
316 | ||
24f4eac3 | 317 | $path =~ s#/$##; |
6ac5dde2 MW |
318 | if (-f "$path/.tgal.index") { |
319 | open my $f, "<", "$path/.tgal.index"; | |
320 | my $item = undef; | |
321 | my $comment = undef; | |
322 | LINE: while (<$f>) { | |
323 | chomp; | |
324 | next LINE if /^\s*(\#|$)/; | |
325 | if (s/^\s+//) { | |
326 | die "no item" unless $item; | |
327 | $comment = defined $comment ? $comment . "\n" . $_ : $_; | |
328 | } else { | |
329 | if ($item && $comment) { $item->comment($comment); } | |
9940cc5a | 330 | my ($flags, $name, $c) = |
6e51720c | 331 | /^ (?: ([-!]+) \s+)? # flags |
9fc5e8c1 MW |
332 | (\S+) \s* # filename |
333 | (\S | \S.*\S )? # start of the comment | |
334 | \s* | |
335 | $/x; | |
9940cc5a | 336 | my $indexp = $flags =~ /!/; |
6e51720c | 337 | my $hidep = $flags =~ /-/; |
6ac5dde2 MW |
338 | $name = urldecode $name; |
339 | my $list; | |
0485371e | 340 | $item = TrivGal::Item->new($name); |
e9eac06d | 341 | if ($name =~ m#/$#) { |
6ac5dde2 MW |
342 | $list = \@d; |
343 | die "can't index a folder" if $indexp; | |
344 | } else { | |
345 | $list = \@f; | |
d8ab1dea | 346 | my (undef, undef, $ext) = split_path $name; |
6ac5dde2 MW |
347 | die "unknown image type" unless $TYPE{lc $ext}; |
348 | if ($indexp) { | |
349 | die "two index images" if defined $ix; | |
350 | $ix = $item; | |
351 | } | |
352 | } | |
6ac5dde2 | 353 | $comment = $c; |
6e51720c | 354 | push @$list, $item unless $hidep; |
6ac5dde2 MW |
355 | } |
356 | } | |
357 | if ($item && $comment) { $item->comment($comment); } | |
358 | close $f; | |
359 | } else { | |
ebe19115 | 360 | my $st = stat $path; |
32fc7001 MW |
361 | unless ($st->mode&0004) { return ([], [], undef); } |
362 | ||
6ac5dde2 MW |
363 | opendir $d, $path; |
364 | my @e = readdir $d; | |
365 | closedir $d; | |
366 | ||
367 | ENT: for my $e (sort @e) { | |
d8ab1dea | 368 | my (undef, undef, $ext) = split_path $e; |
6ac5dde2 MW |
369 | my $dotp = $e =~ /^\./; |
370 | my $st = stat "$path/$e"; | |
371 | my $list = undef; | |
32fc7001 | 372 | if ($dotp) { } |
24f4eac3 | 373 | elsif (-d $st) { $list = \@d; $e .= "/"; } |
6ac5dde2 MW |
374 | elsif ($TYPE{lc $ext} && -f $st) { $list = \@f; } |
375 | $list and push @$list, TrivGal::Item->new($e); | |
376 | } | |
377 | $ix = $f[0] if @f; | |
378 | } | |
379 | ||
380 | return (\@d, \@f, $ix); | |
381 | } | |
382 | ||
383 | export qw{contents}; | |
384 | sub contents ($) { | |
385 | my ($file) = @_; | |
386 | my $contents = ""; | |
387 | my $f; | |
388 | local $@; | |
389 | eval { open $f, "<", "$file"; }; | |
390 | if ($@) { | |
391 | if ($@->isa("autodie::exception") && $@->errno == ENOENT) | |
392 | { return undef; } | |
393 | die $@; | |
394 | } | |
395 | while (sysread $f, $buf, 16384) { $contents .= $buf; } | |
396 | close $f; | |
397 | return $contents; | |
398 | } | |
399 | ||
400 | export qw{find_covering_file}; | |
401 | sub find_covering_file ($$$) { | |
402 | my ($top, $path, $name) = @_; | |
403 | for (;;) { | |
404 | my $stuff = contents "$top/$path/$name"; return $stuff if defined $stuff; | |
405 | if ($path eq "") { return undef; } | |
e9eac06d | 406 | if ($path =~ m#^(.*)/[^/]+/?#) { $path = $1; } |
6ac5dde2 MW |
407 | else { $path = ""; } |
408 | } | |
409 | } | |
410 | ||
411 | ###----- That's all, folks -------------------------------------------------- | |
412 | ||
413 | clean_temp_files; | |
414 | ||
415 | 1; |