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; |
aeca06d4 | 33 | use Graphics::Magick; |
bda837fc | 34 | use Image::ExifTool qw{}; |
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, | |
3de03c7a MW |
151 | bigthumb => 216, |
152 | tiny => 320, | |
40c686c2 MW |
153 | small => 480, |
154 | embed => 720, | |
3de03c7a MW |
155 | medium => 1080, |
156 | big => 1600, | |
157 | large => 2400, | |
158 | huge => 3600, | |
159 | vast => 5400, | |
160 | immense => 8100); | |
6ac5dde2 MW |
161 | |
162 | export qw{init}; | |
163 | my $initp = 0; | |
164 | sub init () { | |
165 | my $m = HTML::Mason::Request->instance; | |
166 | my $r = $m->cgi_request; | |
167 | ||
168 | $m->interp->set_escape(u => sub { my ($r) = @_; $$r = urlencode $$r; }); | |
169 | ||
170 | return unless !$initp; | |
171 | ||
172 | $SCRIPTURL //= $r->subprocess_env("SCRIPT_NAME"); | |
173 | $initp = 1; | |
174 | } | |
175 | ||
176 | ###-------------------------------------------------------------------------- | |
177 | ### Temporary files. | |
178 | ||
179 | export qw{clean_temp_files}; | |
180 | sub clean_temp_files () { | |
181 | my $d; | |
182 | ||
183 | eval { opendir $d, $TMP; }; | |
184 | if ($@) { | |
185 | if ($@->isa("autodie::exception") && $@->errno == ENOENT) { return; } | |
186 | else { die $@; } | |
187 | } | |
188 | my $now = time; | |
189 | FILE: while (my $name = readdir $d) { | |
190 | next FILE unless $name =~ /^t(\d+)\-/; | |
191 | my $pid = $1; | |
192 | next FILE if kill 0, $pid; | |
193 | my $f = "$TMP/$name"; | |
194 | my $st = stat $name; | |
195 | next FILE if $now - $st->mtime() < 300; | |
196 | unlink $f; | |
197 | } | |
198 | closedir $d; | |
199 | } | |
200 | ||
201 | ###-------------------------------------------------------------------------- | |
202 | ### Scaled images. | |
203 | ||
bda837fc MW |
204 | my %ORIENT = |
205 | (1 => [0, 0], | |
206 | 2 => [0, 1], | |
207 | 3 => [2, 0], | |
208 | 4 => [2, 1], | |
209 | 5 => [3, 1], | |
210 | 6 => [1, 0], | |
211 | 7 => [1, 1], | |
212 | 8 => [3, 0]); | |
213 | ||
4e74ddf4 MW |
214 | package TrivGal::Image { |
215 | use File::Path qw{make_path}; | |
216 | use File::stat; | |
217 | ||
218 | sub new ($$) { | |
219 | my ($cls, $path) = @_; | |
220 | my $imgpath = "$IMGROOT/$path"; | |
221 | my $st = stat $imgpath or die "no image `$path'"; | |
222 | return bless { | |
4fcd273f | 223 | path => $path, imgpath => $imgpath, |
4e74ddf4 | 224 | mtime => $st->mtime, |
8b97a4e3 | 225 | img => undef, |
5d6997b3 MW |
226 | rot => undef, flip => undef, |
227 | wd => undef, ht => undef, | |
8b97a4e3 MW |
228 | _wd => undef, _ht => undef, |
229 | sz => undef | |
4e74ddf4 MW |
230 | }, $cls; |
231 | } | |
232 | ||
8b97a4e3 MW |
233 | sub _getsz ($) { |
234 | my ($me) = @_; | |
235 | return if defined $me->{_wd}; | |
236 | ||
237 | my ($wd, $ht, $err) = Image::Size::imgsize $me->{imgpath}; | |
238 | defined $wd or die "failed to read size of `$me->{path}': $err"; | |
239 | my $sz = $wd; if ($sz < $ht) { $sz = $ht; } | |
240 | @$me{"_wd", "_ht", "sz"} = ($wd, $ht, $sz); | |
241 | } | |
242 | ||
5d6997b3 MW |
243 | sub _getexif ($) { |
244 | my ($me) = @_; | |
245 | return if defined $me->{wd}; | |
246 | ||
247 | $me->_getsz; | |
248 | my $exif = new Image::ExifTool; $exif->ExtractInfo($me->{imgpath}); | |
249 | my $orient = $exif->GetValue("Orientation", "ValueConv"); | |
250 | my ($wd, $ht) = @$me{"_wd", "_ht"}; | |
251 | my ($rot, $flip); | |
252 | if (defined $orient) { ($rot, $flip) = $ORIENT{$orient}->@*; } | |
253 | else { ($rot, $flip) = (0, 0); } | |
254 | if ($rot%2) { ($wd, $ht) = ($ht, $wd); } | |
255 | @$me{"rot", "flip", "wd", "ht"} = ($rot, $flip, $wd, $ht); | |
256 | } | |
257 | ||
8b97a4e3 | 258 | sub sz ($) { my ($me) = @_; $me->_getsz; return $me->{sz}; } |
5d6997b3 MW |
259 | sub wd ($) { my ($me) = @_; $me->_getexif; return $me->{wd}; } |
260 | sub ht ($) { my ($me) = @_; $me->_getexif; return $me->{ht}; } | |
8b97a4e3 | 261 | |
aeca06d4 MW |
262 | sub _check_gm ($) { |
263 | my ($rc) = @_; | |
264 | "$rc" and die "failed to hack `$me->{img}': $rc"; | |
265 | } | |
266 | ||
784bdf8f MW |
267 | sub scale ($$;$) { |
268 | my ($me, $scale, $forcep) = @_; | |
1b3d6791 | 269 | my $m = HTML::Mason::Request->instance; |
4e74ddf4 MW |
270 | |
271 | my $path = $me->{path}; | |
272 | my $sz = $SIZE{$scale} or die "unknown scale `$scale'"; | |
351bb9a6 MW |
273 | my $url; |
274 | ||
373818eb | 275 | if ($me->sz <= $sz) |
351bb9a6 MW |
276 | { $url = $m->interp->apply_escapes("$IMGURL/$path", "u"); } |
277 | else { | |
278 | my $tail = "scale.$sz/$path"; | |
279 | my $thumb = "$CACHE/$tail"; | |
280 | my $thumburl = $m->interp->apply_escapes("$CACHEURL/$tail", "u"); | |
281 | ||
282 | my $st = stat $thumb; | |
283 | if ($st && $st->mtime > $me->{mtime}) | |
284 | { $url = $thumburl; } | |
285 | elsif (!$forcep) { | |
286 | $url = | |
287 | $m->interp->apply_escapes("$SCRIPTURL/$path", "u") . | |
288 | "?scale=$scale"; | |
289 | } else { | |
351bb9a6 MW |
290 | my $img = $me->{img}; |
291 | unless (defined $img) { | |
aeca06d4 MW |
292 | $img = $me->{img} = Graphics::Magick->new; |
293 | _check_gm $img->Read($me->{imgpath}); | |
351bb9a6 MW |
294 | } |
295 | ||
603ed7ab | 296 | my ($dir, undef, $ext) = TrivGal::split_path $thumb; |
aeca06d4 MW |
297 | $img = $img->Clone; |
298 | my $new = "$TMP/t$$-thumb$ext"; | |
299 | _check_gm $img->Resize(geometry => $sz); | |
351bb9a6 | 300 | make_path $TMP, { mode => 0771 }; |
aeca06d4 | 301 | _check_gm $img->Write($new); |
351bb9a6 MW |
302 | make_path $dir, { mode => 0771 }; |
303 | rename $new, $thumb; | |
304 | $url = $thumburl; | |
bda837fc | 305 | } |
4e74ddf4 MW |
306 | } |
307 | ||
351bb9a6 | 308 | return $url; |
4e74ddf4 | 309 | } |
6ac5dde2 MW |
310 | } |
311 | ||
312 | ###-------------------------------------------------------------------------- | |
313 | ### Directory listings. | |
314 | ||
315 | package TrivGal::Item { | |
316 | sub new ($$) { | |
317 | my ($cls, $name) = @_; | |
318 | return bless { name => $name }, $cls; | |
319 | } | |
320 | sub name ($@) { | |
321 | my ($me, @args) = @_; | |
322 | return TrivGal::read_or_set $me, $me->{name}, @args; | |
323 | } | |
324 | sub comment ($@) { | |
325 | my ($me, @args) = @_; | |
326 | return TrivGal::read_or_set $me, $me->{comment}, @args; | |
327 | } | |
65e4ebfd | 328 | } |
6ac5dde2 MW |
329 | |
330 | export qw{listdir}; | |
331 | sub listdir ($) { | |
332 | my ($path) = @_; | |
333 | my (@d, @f); | |
334 | my $ix = undef; | |
335 | ||
24f4eac3 | 336 | $path =~ s#/$##; |
6ac5dde2 MW |
337 | if (-f "$path/.tgal.index") { |
338 | open my $f, "<", "$path/.tgal.index"; | |
339 | my $item = undef; | |
340 | my $comment = undef; | |
341 | LINE: while (<$f>) { | |
342 | chomp; | |
343 | next LINE if /^\s*(\#|$)/; | |
344 | if (s/^\s+//) { | |
345 | die "no item" unless $item; | |
346 | $comment = defined $comment ? $comment . "\n" . $_ : $_; | |
347 | } else { | |
348 | if ($item && $comment) { $item->comment($comment); } | |
9940cc5a | 349 | my ($flags, $name, $c) = |
6e51720c | 350 | /^ (?: ([-!]+) \s+)? # flags |
9fc5e8c1 MW |
351 | (\S+) \s* # filename |
352 | (\S | \S.*\S )? # start of the comment | |
353 | \s* | |
354 | $/x; | |
9940cc5a | 355 | my $indexp = $flags =~ /!/; |
6e51720c | 356 | my $hidep = $flags =~ /-/; |
6ac5dde2 MW |
357 | $name = urldecode $name; |
358 | my $list; | |
0485371e | 359 | $item = TrivGal::Item->new($name); |
e9eac06d | 360 | if ($name =~ m#/$#) { |
6ac5dde2 MW |
361 | $list = \@d; |
362 | die "can't index a folder" if $indexp; | |
363 | } else { | |
364 | $list = \@f; | |
d8ab1dea | 365 | my (undef, undef, $ext) = split_path $name; |
6ac5dde2 MW |
366 | die "unknown image type" unless $TYPE{lc $ext}; |
367 | if ($indexp) { | |
368 | die "two index images" if defined $ix; | |
369 | $ix = $item; | |
370 | } | |
371 | } | |
6ac5dde2 | 372 | $comment = $c; |
6e51720c | 373 | push @$list, $item unless $hidep; |
6ac5dde2 MW |
374 | } |
375 | } | |
376 | if ($item && $comment) { $item->comment($comment); } | |
377 | close $f; | |
378 | } else { | |
ebe19115 | 379 | my $st = stat $path; |
32fc7001 MW |
380 | unless ($st->mode&0004) { return ([], [], undef); } |
381 | ||
6ac5dde2 MW |
382 | opendir $d, $path; |
383 | my @e = readdir $d; | |
384 | closedir $d; | |
385 | ||
386 | ENT: for my $e (sort @e) { | |
d8ab1dea | 387 | my (undef, undef, $ext) = split_path $e; |
6ac5dde2 MW |
388 | my $dotp = $e =~ /^\./; |
389 | my $st = stat "$path/$e"; | |
390 | my $list = undef; | |
32fc7001 | 391 | if ($dotp) { } |
24f4eac3 | 392 | elsif (-d $st) { $list = \@d; $e .= "/"; } |
6ac5dde2 MW |
393 | elsif ($TYPE{lc $ext} && -f $st) { $list = \@f; } |
394 | $list and push @$list, TrivGal::Item->new($e); | |
395 | } | |
396 | $ix = $f[0] if @f; | |
397 | } | |
398 | ||
399 | return (\@d, \@f, $ix); | |
400 | } | |
401 | ||
402 | export qw{contents}; | |
403 | sub contents ($) { | |
404 | my ($file) = @_; | |
405 | my $contents = ""; | |
406 | my $f; | |
407 | local $@; | |
408 | eval { open $f, "<", "$file"; }; | |
409 | if ($@) { | |
410 | if ($@->isa("autodie::exception") && $@->errno == ENOENT) | |
411 | { return undef; } | |
412 | die $@; | |
413 | } | |
414 | while (sysread $f, $buf, 16384) { $contents .= $buf; } | |
415 | close $f; | |
416 | return $contents; | |
417 | } | |
418 | ||
419 | export qw{find_covering_file}; | |
420 | sub find_covering_file ($$$) { | |
421 | my ($top, $path, $name) = @_; | |
422 | for (;;) { | |
423 | my $stuff = contents "$top/$path/$name"; return $stuff if defined $stuff; | |
424 | if ($path eq "") { return undef; } | |
e9eac06d | 425 | if ($path =~ m#^(.*)/[^/]+/?#) { $path = $1; } |
6ac5dde2 MW |
426 | else { $path = ""; } |
427 | } | |
428 | } | |
429 | ||
430 | ###----- That's all, folks -------------------------------------------------- | |
431 | ||
432 | clean_temp_files; | |
433 | ||
434 | 1; |