]> Sergey Matveev's repositories - public-inbox.git/blob - public-inbox.cgi
add example for CGI with Ruby WEBrick
[public-inbox.git] / public-inbox.cgi
1 #!/usr/bin/perl -w
2 # Copyright (C) 2014, Eric Wong <normalperson@yhbt.net> and all contributors
3 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
4 #
5 # We focus on the lowest common denominators here:
6 # - targeted at text-only console browsers (lynx, w3m, etc..)
7 # - Only basic HTML, CSS only for line-wrapping <pre> text content for GUIs
8 # - No JavaScript, graphics or icons allowed.
9 # - Must not rely on static content
10 # - UTF-8 is only for user-content, 7-bit US-ASCII for us
11
12 use 5.008;
13 use strict;
14 use warnings;
15 use CGI qw(:cgi :escapeHTML -nosticky); # PSGI/FastCGI/mod_perl compat
16 use Encode qw(decode_utf8);
17 use PublicInbox::Config;
18 use URI::Escape qw(uri_escape uri_unescape);
19 use Digest::SHA qw(sha1_hex);
20 our $LISTNAME_RE = qr!\A/([\w\.\-]+)!;
21 our $pi_config;
22 BEGIN {
23         $pi_config = PublicInbox::Config->new;
24         # TODO: detect and reload config as needed
25         if ($ENV{MOD_PERL}) {
26                 CGI->compile;
27         }
28 }
29
30 my $ret = main();
31
32 my ($status, $headers, $body) = @$ret;
33 set_binmode($headers);
34 if (@ARGV && $ARGV[0] eq 'static') {
35         print $body;
36 } else { # CGI
37         print "Status: $status\r\n";
38         while (my ($k, $v) = each %$headers) {
39                 print "$k: $v\r\n";
40         }
41         print "\r\n", $body;
42 }
43
44 # TODO: plack support
45
46 # private functions below
47
48 sub main {
49         # some servers (Ruby webrick) include scheme://host[:port] here,
50         # which confuses CGI.pm when generating self_url.
51         # RFC 3875 does not mention REQUEST_URI at all,
52         # so nuke it since CGI.pm functions without it.
53         delete $ENV{REQUEST_URI};
54
55         my $cgi = CGI->new;
56         my %ctx;
57         if ($cgi->request_method !~ /\AGET|HEAD\z/) {
58                 return r("405 Method Not Allowed");
59         }
60         my $path_info = decode_utf8($cgi->path_info);
61
62         # top-level indices and feeds
63         if ($path_info eq "/") {
64                 r404();
65         } elsif ($path_info =~ m!$LISTNAME_RE\z!o) {
66                 invalid_list(\%ctx, $1) || redirect_list_index(\%ctx, $cgi);
67         } elsif ($path_info =~ m!$LISTNAME_RE(?:/|/index\.html)?\z!o) {
68                 invalid_list(\%ctx, $1) || get_index(\%ctx, $cgi, 1);
69         } elsif ($path_info =~ m!$LISTNAME_RE/(?:all\.html)?\z!o) {
70                 invalid_list(\%ctx, $1) || get_index(\%ctx, $cgi, 0);
71         } elsif ($path_info =~ m!$LISTNAME_RE/index\.atom\.xml\z!o) {
72                 invalid_list(\%ctx, $1) || get_atom(\%ctx, $cgi, 1);
73         } elsif ($path_info =~ m!$LISTNAME_RE/all\.atom\.xml\z!o) {
74                 invalid_list(\%ctx, $1) || get_atom(\%ctx, $cgi, 0);
75
76         # single-message pages
77         } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.txt\z!o) {
78                 invalid_list_mid(\%ctx, $1, $2) || get_mid_txt(\%ctx, $cgi);
79         } elsif ($path_info =~ m!$LISTNAME_RE/m/(\S+)\.html\z!o) {
80                 invalid_list_mid(\%ctx, $1, $2) || get_mid_html(\%ctx, $cgi);
81
82         # full-message page
83         } elsif ($path_info =~ m!$LISTNAME_RE/f/(\S+)\.html\z!o) {
84                 invalid_list_mid(\%ctx, $1, $2) || get_full_html(\%ctx, $cgi);
85
86         # convenience redirect
87         } elsif ($path_info =~ m!$LISTNAME_RE/(?:m|f)/(\S+)\z!o) {
88                 invalid_list_mid(\%ctx, $1, $2) || redirect_mid(\%ctx, $cgi);
89
90         } else {
91                 r404();
92         }
93 }
94
95 sub r404 { r("404 Not Found") }
96
97 # simple response for errors
98 sub r { [ $_[0], { 'Content-Type' => 'text/plain' }, $_[0]."\n" ] }
99
100 # returns undef if valid, array ref response if invalid
101 sub invalid_list {
102         my ($ctx, $listname) = @_;
103         my $git_dir = $pi_config->get($listname, "mainrepo");
104         if (defined $git_dir) {
105                 $ctx->{git_dir} = $git_dir;
106                 $ctx->{listname} = $listname;
107                 return undef;
108         }
109         r404();
110 }
111
112 # returns undef if valid, array ref response if invalid
113 sub invalid_list_mid {
114         my ($ctx, $listname, $mid) = @_;
115         my $ret = invalid_list($ctx, $listname, $mid) and return $ret;
116         $ctx->{mid} = uri_unescape($mid);
117         undef;
118 }
119
120 # /$LISTNAME/index.atom.xml                     -> Atom feed
121 # /$LISTNAME/all.atom.xml                       -> Atom feed, includes replies
122 sub get_atom {
123         my ($ctx, $cgi, $top) = @_;
124         require PublicInbox::Feed;
125         [ '200 OK', { 'Content-Type' => 'application/xml' },
126           PublicInbox::Feed->generate({
127                         git_dir => $ctx->{git_dir},
128                         listname => $ctx->{listname},
129                         pi_config => $pi_config,
130                         cgi => $cgi,
131                         top => $top,
132                 })
133         ];
134 }
135
136 # /$LISTNAME/?before=$GIT_COMMIT                 -> HTML only
137 sub get_index {
138         my ($ctx, $cgi, $top) = @_;
139         require PublicInbox::Feed;
140         [ '200 OK', { 'Content-Type' => 'text/html' },
141           PublicInbox::Feed->generate_html_index({
142                         git_dir => $ctx->{git_dir},
143                         listname => $ctx->{listname},
144                         pi_config => $pi_config,
145                         cgi => $cgi,
146                         top => $top,
147                 })
148         ];
149 }
150
151 # just returns a string ref for the blob in the current ctx
152 sub mid2blob {
153         my ($ctx) = @_;
154         local $ENV{GIT_DIR} = $ctx->{git_dir};
155         my $hex = sha1_hex($ctx->{mid});
156         $hex =~ /\A([a-f0-9]{2})([a-f0-9]{38})\z/i or
157                         die "BUG: not a SHA-1 hex: $hex";
158         my $blob = `git cat-file blob HEAD:$1/$2 2>/dev/null`;
159         $? == 0 ? \$blob : undef;
160 }
161
162 # /$LISTNAME/m/$MESSAGE_ID.txt                    -> raw original
163 sub get_mid_txt {
164         my ($ctx, $cgi) = @_;
165         my $x = mid2blob($ctx);
166         $x ? [ "200 OK", {'Content-Type' => 'text/plain'}, $$x ] : r404();
167 }
168
169 # /$LISTNAME/m/$MESSAGE_ID.html                   -> HTML content (short quotes)
170 sub get_mid_html {
171         my ($ctx, $cgi) = @_;
172         my $x = mid2blob($ctx);
173         return r404() unless $x;
174
175         my $pfx = "../f/" . uri_escape($ctx->{mid}) . ".html";
176         require PublicInbox::View;
177         require Email::MIME;
178         [ "200 OK", {'Content-Type' => 'text/html'},
179                 PublicInbox::View->as_html(Email::MIME->new($$x), $pfx)];
180 }
181
182 # /$LISTNAME/f/$MESSAGE_ID.html                   -> HTML content (fullquotes)
183 sub get_full_html {
184         my ($ctx, $cgi) = @_;
185         my $x = mid2blob($ctx);
186         return r404() unless $x;
187         require PublicInbox::View;
188         require Email::MIME;
189         [ "200 OK", {'Content-Type' => 'text/html'},
190                 PublicInbox::View->as_html(Email::MIME->new($$x))];
191 }
192
193 sub redirect_list_index {
194         my ($ctx, $cgi) = @_;
195         do_redirect($cgi->self_url . "/");
196 }
197
198 sub redirect_mid {
199         my ($ctx, $cgi) = @_;
200         my $url = $cgi->self_url;
201         $url =~ s!/f/!/m/!;
202         do_redirect($url . '.html');
203 }
204
205 sub do_redirect {
206         my ($url) = @_;
207         [ '301 Moved Permanently',
208           { Location => $url, 'Content-Type' => 'text/plain' },
209           "Redirecting to $url\n"
210         ]
211 }
212
213 # only used for CGI and static file generation modes
214 sub set_binmode {
215         my ($headers) = @_;
216         if ($headers->{'Content-Type'} eq 'text/plain') {
217                 # no way to validate raw messages, mixed encoding is possible.
218                 binmode STDOUT;
219         } else { # strict encoding for HTML and XML
220                 binmode STDOUT, ':encoding(UTF-8)';
221         }
222 }