1 # Copyright (C) 2019-2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Standalone PSGI app to provide syntax highlighting as-a-service
5 # via "highlight" Perl module ("libhighlight-perl" in Debian).
7 # This allows exposing highlight as a persistent HTTP service for
8 # other scripts via HTTP PUT requests. PATH_INFO will be used
9 # as a hint for detecting the language for highlight.
11 # The following example using curl(1) will do the right thing
12 # regarding the file extension:
14 # curl -HExpect: -T /path/to/file http://example.com/
16 # You can also force a file extension by giving a path
17 # (in this case, "c") via:
19 # curl -HExpect: -T /path/to/file http://example.com/x.c
21 package PublicInbox::WwwHighlight;
24 use parent qw(PublicInbox::HlMod);
25 use PublicInbox::Linkify qw();
26 use PublicInbox::Hval qw(ascii_html);
27 use PublicInbox::WwwStatic qw(r);
29 # TODO: support highlight(1) for distros which don't package the
30 # SWIG extension. Also, there may be admins who don't want to
31 # have ugly SWIG-generated code in a long-lived Perl process.
33 # another slurp API hogging up all my memory :<
34 # This is capped by whatever the PSGI server allows,
35 # $ENV{GIT_HTTP_MAX_REQUEST_BUFFER} for PublicInbox::HTTP (10 MB)
36 sub read_in_full ($) {
39 my $in = $env->{'psgi.input'};
42 my $len = $env->{CONTENT_LENGTH} || 8192;
44 my $r = $in->read($buf, $len, $off);
45 last unless defined $r;
46 return \$buf if $r == 0;
49 $env->{'psgi.errors'}->print("input read error: $!\n");
53 # entry point for PSGI
55 my ($self, $env) = @_;
56 my $req_method = $env->{REQUEST_METHOD};
58 return r(405) if $req_method ne 'PUT';
60 my $bref = read_in_full($env) or return r(500);
61 my $l = PublicInbox::Linkify->new;
62 $l->linkify_1($$bref);
63 if (my $res = $self->do_hl($bref, $env->{PATH_INFO})) {
66 $$bref = ascii_html($$bref);
68 $l->linkify_2($$bref);
70 my $h = [ 'Content-Type', 'text/html; charset=UTF-8' ];
71 push @$h, 'Content-Length', length($$bref);
73 [ 200, $h, [ $$bref ] ]