mason/.perl-lib/TrivGal.pm (Image::scale): Return encoded URL.
[tgal] / mason / .perl-lib / TrivGal.pm
CommitLineData
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
26package TrivGal;
27
28use autodie qw{:all};
29
30use Errno;
31use Exporter qw{import};
6ac5dde2 32use File::stat;
bda837fc 33use Image::ExifTool qw{};
6ac5dde2
MW
34use Image::Imlib2;
35use User::pwent;
36use POSIX;
37
38our @EXPORT;
39sub export (@) { push @EXPORT, @_; }
40
41###--------------------------------------------------------------------------
42### Internal utilities.
43
44sub read_or_set ($\$@) {
45 my ($me, $ref, @args) = @_;
46 if (@args == 0) { return $$ref; }
47 elsif (@args == 1) { $$ref = $args[0]; return $me; }
48 elsif (@args > 1) { die "too many arguments"; }
49}
50
51###--------------------------------------------------------------------------
52### Random utilities.
53
54export qw{join_paths};
55sub join_paths (@) {
56 my @p = @_;
57 my $p = "";
58 ELT: for my $e (@p) {
e9eac06d
MW
59 $e =~ s#^/{2,}#/#;
60 $e =~ s#([^/])/+$#$1#;
6ac5dde2 61 if ($e eq "") { next ELT; }
e9eac06d 62 elsif ($p eq "" || $e =~ m#^/#) { $p = $e; }
6ac5dde2
MW
63 else { $p = "$p/$e"; }
64 }
65 return $p;
66}
67
68export qw{split_path};
69sub split_path ($) {
70 my ($path) = @_;
71
9fc5e8c1
MW
72 my ($dir, $base, $ext) =
73 $path =~ m#^ (?: (.*) /)?
74 (?: ([^/]*) \.)?
75 ([^./]*) $#x;
6ac5dde2
MW
76 if (defined $base) { $ext = ".$ext"; }
77 else { $base = $ext; $ext = ""; }
78 return ($dir, $base, $ext);
79}
80
81export qw{urlencode};
82sub urlencode ($) {
83 my ($u) = @_;
e9eac06d 84 $u =~ s#([^0-9a-zA-Z_./~-])#sprintf "%%%02x", ord $1#eg;
6ac5dde2
MW
85 return $u;
86}
87
88export qw{urldecode};
89sub urldecode ($) {
90 my ($u) = @_;
e9eac06d 91 $u =~ s#\%([0-9a-fA-F]{2})#chr hex $1#eg;
6ac5dde2
MW
92 return $u;
93}
94
95###--------------------------------------------------------------------------
96### Image types.
97
98our %TYPE;
99
100package TrivGal::ImageType {
101 sub new ($$) {
102 my ($cls, $ext) = @_;
103 return $TYPE{$ext} = bless { ext => $ext }, $cls;
104 }
105 sub ext ($) {
106 my ($me, @args) = @_;
107 return $me->{ext};
108 }
109 sub mimetype ($@) {
110 my ($me, @args) = @_;
111 return TrivGal::read_or_set $me, $me->{mimetype}, @args;
112 }
113 sub imlibfmt ($@) {
114 my ($me, @args) = @_;
115 return TrivGal::read_or_set $me, $me->{imlibfmt}, @args;
116 }
65e4ebfd 117}
6ac5dde2
MW
118
119TrivGal::ImageType->new(".jpg")->mimetype("image/jpeg")->imlibfmt("jpeg");
120TrivGal::ImageType->new(".png")->mimetype("image/png")->imlibfmt("png");
121
122###--------------------------------------------------------------------------
123### Configuration.
124
125export qw{$SCOPE $SUFFIX};
126our $SCOPE //= $::SCOPE;
127our $SUFFIX //= $::SUFFIX;
128
129export qw{$IMGROOT $CACHE $TMP};
130our $IMGROOT //= "$ENV{HOME}/publish/$SCOPE-html$SUFFIX/tgal-images";
131our $CACHE //=
132 ($ENV{XDG_CACHE_HOME} // "$ENV{HOME}/.cache") .
133 "/tgal/$SCOPE$SUFFIX";
134our $TMP //= "$CACHE/tmp";
135
136export qw{$ROOTURL $IMGURL $CACHEURL $STATICURL $SCRIPTURL};
137my $user = getpwuid($>)->name;
138our $ROOTURL //= "/~$user";
139our $IMGURL //= "$ROOTURL/tgal-images";
140our $CACHEURL //= "$ROOTURL/tgal-cache";
141our $STATICURL //= "$ROOTURL/tgal-static";
142our $SCRIPTURL;
143
a38a867d
MW
144export qw{$SRCURL};
145our $SRCURL = "https://git.distorted.org.uk/~mdw/tgal/";
146
6ac5dde2 147export qw{%SIZE};
1408b7a2
MW
148our %SIZE = (smallthumb => 96,
149 medthumb => 144,
150 bigthumb => 228,
151 view => 1200);
6ac5dde2
MW
152
153export qw{init};
154my $initp = 0;
155sub init () {
156 my $m = HTML::Mason::Request->instance;
157 my $r = $m->cgi_request;
158
159 $m->interp->set_escape(u => sub { my ($r) = @_; $$r = urlencode $$r; });
160
161 return unless !$initp;
162
163 $SCRIPTURL //= $r->subprocess_env("SCRIPT_NAME");
164 $initp = 1;
165}
166
167###--------------------------------------------------------------------------
168### Temporary files.
169
170export qw{clean_temp_files};
171sub clean_temp_files () {
172 my $d;
173
174 eval { opendir $d, $TMP; };
175 if ($@) {
176 if ($@->isa("autodie::exception") && $@->errno == ENOENT) { return; }
177 else { die $@; }
178 }
179 my $now = time;
180 FILE: while (my $name = readdir $d) {
181 next FILE unless $name =~ /^t(\d+)\-/;
182 my $pid = $1;
183 next FILE if kill 0, $pid;
184 my $f = "$TMP/$name";
185 my $st = stat $name;
186 next FILE if $now - $st->mtime() < 300;
187 unlink $f;
188 }
189 closedir $d;
190}
191
192###--------------------------------------------------------------------------
193### Scaled images.
194
bda837fc
MW
195my %ORIENT =
196 (1 => [0, 0],
197 2 => [0, 1],
198 3 => [2, 0],
199 4 => [2, 1],
200 5 => [3, 1],
201 6 => [1, 0],
202 7 => [1, 1],
203 8 => [3, 0]);
204
4e74ddf4
MW
205package TrivGal::Image {
206 use File::Path qw{make_path};
207 use File::stat;
208
209 sub new ($$) {
210 my ($cls, $path) = @_;
211 my $imgpath = "$IMGROOT/$path";
212 my $st = stat $imgpath or die "no image `$path'";
213 return bless {
214 path => $path,
215 mtime => $st->mtime,
216 img => undef
217 }, $cls;
218 }
219
220 sub scale ($$) {
221 my ($me, $scale) = @_;
1b3d6791 222 my $m = HTML::Mason::Request->instance;
4e74ddf4
MW
223
224 my $path = $me->{path};
225 my $sz = $SIZE{$scale} or die "unknown scale `$scale'";
226 my $thumb = "$CACHE/scale.$sz/$path";
1b3d6791
MW
227 my $thumburl =
228 $m->interp->apply_escapes("$CACHEURL/scale.$sz/$path", "u");
4e74ddf4
MW
229 my $st = stat $thumb;
230 if (defined $st && $st->mtime > $me->{mtime}) { return $thumburl; }
231
232 my ($dir, $base, $ext) = TrivGal::split_path $thumb;
233 my $ty = $TYPE{lc $ext} or die "unknown type `$ext'";
234
235 my $img = $me->{img};
236 unless (defined $img) {
237 my $imgpath = "$IMGROOT/$path";
bda837fc
MW
238 my $exif = new Image::ExifTool;
239 $exif->ExtractInfo($imgpath);
240 my $orient = $exif->GetValue("Orientation", "ValueConv");
4e74ddf4 241 $img = $me->{img} = Image::Imlib2->load($imgpath);
bda837fc
MW
242 if (defined $orient) {
243 my ($rot, $flip) = @{$ORIENT{$orient}};
244 if ($rot) { $img->image_orientate($rot); }
f6158607 245 if ($flip) { $img->flip_horizontal(); }
bda837fc 246 }
4e74ddf4
MW
247 }
248
249 my ($wd, $ht) = ($img->width, $img->height);
250 my $max = $wd > $ht ? $wd : $ht;
251 if ($max <= $sz) { return "$IMGURL/$path"; }
252 my $sc = $sz/$max;
253 my $scaled = $img->create_scaled_image($sc*$wd, $sc*$ht);
254
255 $scaled->image_set_format($ty->imlibfmt);
256 $scaled->set_quality(90);
227d23a0 257 my $new = "$TMP/t$$-$ext";
4e74ddf4
MW
258 make_path $TMP;
259 $scaled->save($new);
260 make_path $dir;
261 rename $new, $thumb;
262 return $thumburl;
263 }
6ac5dde2
MW
264}
265
266###--------------------------------------------------------------------------
267### Directory listings.
268
269package TrivGal::Item {
270 sub new ($$) {
271 my ($cls, $name) = @_;
272 return bless { name => $name }, $cls;
273 }
274 sub name ($@) {
275 my ($me, @args) = @_;
276 return TrivGal::read_or_set $me, $me->{name}, @args;
277 }
278 sub comment ($@) {
279 my ($me, @args) = @_;
280 return TrivGal::read_or_set $me, $me->{comment}, @args;
281 }
65e4ebfd 282}
6ac5dde2
MW
283
284export qw{listdir};
285sub listdir ($) {
286 my ($path) = @_;
287 my (@d, @f);
288 my $ix = undef;
289
24f4eac3 290 $path =~ s#/$##;
6ac5dde2
MW
291 if (-f "$path/.tgal.index") {
292 open my $f, "<", "$path/.tgal.index";
293 my $item = undef;
294 my $comment = undef;
295 LINE: while (<$f>) {
296 chomp;
297 next LINE if /^\s*(\#|$)/;
298 if (s/^\s+//) {
299 die "no item" unless $item;
300 $comment = defined $comment ? $comment . "\n" . $_ : $_;
301 } else {
302 if ($item && $comment) { $item->comment($comment); }
9fc5e8c1
MW
303 my ($indexp, $name, $c) =
304 /^ (! \s+)? # index flag
305 (\S+) \s* # filename
306 (\S | \S.*\S )? # start of the comment
307 \s*
308 $/x;
6ac5dde2
MW
309 $name = urldecode $name;
310 my $list;
0485371e 311 $item = TrivGal::Item->new($name);
e9eac06d 312 if ($name =~ m#/$#) {
6ac5dde2
MW
313 $list = \@d;
314 die "can't index a folder" if $indexp;
315 } else {
316 $list = \@f;
317 my ($dir, $base, $ext) = TrivGal::split_path $name;
318 die "unknown image type" unless $TYPE{lc $ext};
319 if ($indexp) {
320 die "two index images" if defined $ix;
321 $ix = $item;
322 }
323 }
6ac5dde2
MW
324 $comment = $c;
325 push @$list, $item;
326 }
327 }
328 if ($item && $comment) { $item->comment($comment); }
329 close $f;
330 } else {
ebe19115 331 my $st = stat $path;
32fc7001
MW
332 unless ($st->mode&0004) { return ([], [], undef); }
333
6ac5dde2
MW
334 opendir $d, $path;
335 my @e = readdir $d;
336 closedir $d;
337
338 ENT: for my $e (sort @e) {
339 my ($dir, $base, $ext) = split_path $e;
340 my $dotp = $e =~ /^\./;
341 my $st = stat "$path/$e";
342 my $list = undef;
32fc7001 343 if ($dotp) { }
24f4eac3 344 elsif (-d $st) { $list = \@d; $e .= "/"; }
6ac5dde2
MW
345 elsif ($TYPE{lc $ext} && -f $st) { $list = \@f; }
346 $list and push @$list, TrivGal::Item->new($e);
347 }
348 $ix = $f[0] if @f;
349 }
350
351 return (\@d, \@f, $ix);
352}
353
354export qw{contents};
355sub contents ($) {
356 my ($file) = @_;
357 my $contents = "";
358 my $f;
359 local $@;
360 eval { open $f, "<", "$file"; };
361 if ($@) {
362 if ($@->isa("autodie::exception") && $@->errno == ENOENT)
363 { return undef; }
364 die $@;
365 }
366 while (sysread $f, $buf, 16384) { $contents .= $buf; }
367 close $f;
368 return $contents;
369}
370
371export qw{find_covering_file};
372sub find_covering_file ($$$) {
373 my ($top, $path, $name) = @_;
374 for (;;) {
375 my $stuff = contents "$top/$path/$name"; return $stuff if defined $stuff;
376 if ($path eq "") { return undef; }
e9eac06d 377 if ($path =~ m#^(.*)/[^/]+/?#) { $path = $1; }
6ac5dde2
MW
378 else { $path = ""; }
379 }
380}
381
382###----- That's all, folks --------------------------------------------------
383
384clean_temp_files;
385
3861;