TPSGI.pm 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. package TPSGI;
  2. # Abstract: Abstraction layer around starman to become a general purpose HTTP server
  3. use strict;
  4. use warnings;
  5. use feature qw{state};
  6. use Cwd();
  7. use Carp::Always;
  8. use POSIX();
  9. use Mojo::File;
  10. use Plack::MIME;
  11. use IO::Compress::Gzip;
  12. use Time::HiRes qw{usleep gettimeofday tv_interval};
  13. # For CGI features
  14. use HTTP::Parser::XS qw{HEADERS_AS_HASHREF};
  15. use CGI::Emulate::PSGI;
  16. use Date::Format qw{strftime};
  17. use List::Util();
  18. use File::Find;
  19. use Sys::Hostname();
  20. use Plack::MIME ();
  21. use DateTime::Format::HTTP();
  22. use File::Touch;
  23. use File::Path;
  24. use Cwd qw{abs_path};
  25. use File::Basename qw{dirname basename};
  26. use Log::Dispatch;
  27. use Log::Dispatch::Screen;
  28. use Log::Dispatch::FileRotate;
  29. use Config::Simple;
  30. #1MB chunks
  31. our $CHUNK_SEP = 'perlfsSep666YOLO42069';
  32. our $CHUNK_SIZE = 1024000;
  33. our %content_types = (
  34. text => "text/plain",
  35. html => "text/html",
  36. json => "application/json",
  37. blob => "application/octet-stream",
  38. xml => "text/xml",
  39. xsl => "text/xsl",
  40. css => "text/css",
  41. rss => "application/rss+xml",
  42. email => "multipart/related",
  43. );
  44. our %byct = reverse %content_types;
  45. our %cache_control = (
  46. revalidate => "no-cache, max-age=0",
  47. nocache => "no-store",
  48. static => "public, max-age=604800, immutable",
  49. );
  50. #TODO consider integrating libfile
  51. #Stuff that isn't in upstream finders
  52. my %extra_types = (
  53. '.docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
  54. );
  55. my $ct = 'Content-type';
  56. #memoize
  57. my $rq;
  58. my $cur_query = {};
  59. sub log {
  60. my $self = shift;
  61. state $log;
  62. return $log if $log;
  63. my $LOGNAME = abs_path('.').'/log/tpsgi.log';
  64. $LOGNAME = $self->{custom_log} if $self->{custom_log};
  65. my $LOGDIR = dirname($LOGNAME);
  66. File::Path::make_path($LOGDIR) unless -d $LOGDIR;
  67. File::Touch::touch($LOGNAME) unless -f $LOGNAME;
  68. my $LEVEL = $self->{verbose} ? 'debug' : 'info';
  69. # By default only log requests & warnings.
  70. # Otherwise emit debug messages.
  71. my $rotate = Log::Dispatch::FileRotate->new(
  72. name => 'tcms',
  73. filename => $LOGNAME,
  74. min_level => $LEVEL,
  75. 'mode' => 'append',
  76. size => 10 * 1024 * 1024,
  77. max => 6,
  78. );
  79. # Only send fatal events/errors to stdout
  80. my $screen = Log::Dispatch::Screen->new(
  81. name => 'screen',
  82. min_level => $LEVEL,
  83. );
  84. $log = Log::Dispatch->new();
  85. $log->add($rotate);
  86. $log->add($screen);
  87. foreach my $logger (@{$self->{loggers}}) {
  88. $log->add($logger->new( min_level => $LEVEL, log_dir => $LOGDIR ));
  89. }
  90. $log->info( $self->_log("Opening Log $LOGNAME at $LEVEL level") );
  91. return $log;
  92. }
  93. sub _log {
  94. my ( $self, $msg ) = @_;
  95. $msg //= "No message passed. This is almost certainly a bug. ";
  96. #XXX Log lines must start as an ISO8601 date, anything else breaks fail2ban's beautiful mind
  97. my $tstamp = POSIX::strftime "%Y-%m-%dT%H:%M:%SZ", gmtime;
  98. return "[Worker $$] $tstamp : $self->{ip} $msg\n";
  99. }
  100. # Logger short cuts
  101. sub DEBUG {
  102. my $self = shift;
  103. $self->log->debug( $self->_log( shift ) );
  104. }
  105. sub INFO {
  106. my $self = shift;
  107. $self->log->info( $self->_log( shift ) );
  108. }
  109. sub NOTE {
  110. my $self = shift;
  111. $self->log->notice( $self->_log( shift ) );
  112. }
  113. sub WARN {
  114. my $self = shift;
  115. $self->log->warning( $self->_log( shift ) );
  116. }
  117. sub ERROR {
  118. my $self = shift;
  119. $self->log->error( $self->_log( shift ) );
  120. }
  121. sub CRIT {
  122. my $self = shift;
  123. $self->log->critical( $self->_log( shift ) );
  124. }
  125. sub ALERT {
  126. my $self = shift;
  127. $self->log->alert( $self->_log( shift ) );
  128. }
  129. sub EMERG {
  130. my $self = shift;
  131. $self->log->emergency( $self->_log( shift ) );
  132. }
  133. sub FATAL {
  134. my $self = shift;
  135. $self->log->log_and_die( level => 'emergency', message => $self->_log( shift ) );
  136. }
  137. =head1 new(%options)
  138. Options are:
  139. custom_log
  140. verbose
  141. routers
  142. loggers
  143. authn
  144. =cut
  145. sub new {
  146. my ($class, %options) = @_;
  147. my %routes;
  148. no strict 'refs';
  149. foreach my $route (@{$options{routers}}) {
  150. # The router needs to exist and have nonzero numbers of routes.
  151. my ($package) = basename($route) =~ m/(\S+)\.pm$/;
  152. my $r = "$package\:\:routes";
  153. local $@;
  154. my $success = eval { require $route; 1; };
  155. if ($success) {
  156. my $pkg_routes = *$r{HASH};
  157. @routes{keys(%$pkg_routes)} = values(%$pkg_routes);
  158. } else {
  159. die "Could not load $route!\n$@\n";
  160. }
  161. }
  162. use strict 'refs';
  163. # Set the pattern used to discover the route if needed later.
  164. foreach my $route (keys(%routes)) {
  165. $routes{$route}{pattern} = $route;
  166. }
  167. $options{indices} //=[];
  168. $options{indices} = [@{$options{indices}},qw{index.html index.htm index.cgi}];
  169. $options{routes} = \%routes;
  170. $options{ip} = '0.0.0.0';
  171. return bless(\%options, $class);
  172. }
  173. sub indices {
  174. my $self = shift;
  175. return $self->{indices};
  176. }
  177. sub routes {
  178. my $self = shift;
  179. return $self->{routes};
  180. }
  181. =head2 serve
  182. Serve a file, with options to stream and cache the output.
  183. =cut
  184. sub serve {
  185. my ( $self, $fullpath, $path, $start, $streaming, $ranges, $last_fetch, $deflate ) = @_;
  186. $last_fetch ||= 0;
  187. $deflate ||= 0;
  188. my $mf = Mojo::File->new($path);
  189. my $ext = '.' . $mf->extname();
  190. my $ft;
  191. if ($ext) {
  192. $ft = Plack::MIME->mime_type($ext) if $ext;
  193. $ft ||= $extra_types{$ext} if exists $extra_types{$ext};
  194. }
  195. $ft ||= $content_types{text};
  196. my @headers = ( $ct => $ft );
  197. #TODO use static Cache-Control for everything but JS/CSS?
  198. push( @headers, 'Cache-control' => $cache_control{revalidate} );
  199. push( @headers, 'Accept-Ranges' => 'bytes' );
  200. my $mt = ( stat($path) )[9];
  201. my $sz = ( stat(_) )[7];
  202. my @gm = gmtime($mt);
  203. my $now_string = strftime( "%a, %d %b %Y %H:%M:%S GMT", @gm );
  204. my $code = $mt > $last_fetch ? 200 : 304;
  205. push( @headers, "Last-Modified" => $now_string );
  206. push( @headers, 'Vary' => 'Accept-Encoding' );
  207. if ( open( my $fh, '<', $path ) ) {
  208. return $self->_range( $fullpath, $fh, $ranges, $sz, @headers ) if @$ranges && $streaming;
  209. # Transfer-encoding: chunked
  210. return sub {
  211. my $responder = shift;
  212. push( @headers, 'Content-Length' => $sz );
  213. my $writer = $responder->( [ $code, \@headers ] );
  214. while ( $fh->read( my $buf, $CHUNK_SIZE ) ) {
  215. $writer->write($buf);
  216. }
  217. close $fh;
  218. $writer->close;
  219. }
  220. if $streaming && $sz > $CHUNK_SIZE;
  221. #Return data in the event the caller does not support deflate
  222. if ( !$deflate ) {
  223. push( @headers, "Content-Length" => $sz );
  224. # Append server-timing headers
  225. my $tot = tv_interval($start) * 1000;
  226. push( @headers, 'Server-Timing' => "file;dur=$tot" );
  227. return [ $code, \@headers, $fh ];
  228. }
  229. #Compress everything less than 1MB
  230. push( @headers, "Content-Encoding" => "gzip" );
  231. my $dfh;
  232. IO::Compress::Gzip::gzip( $fh => \$dfh );
  233. print $IO::Compress::Gzip::GzipError if $IO::Compress::Gzip::GzipError;
  234. push( @headers, "Content-Length" => length($dfh) );
  235. $self->INFO("GET 200 $fullpath");
  236. # Append server-timing headers
  237. my $tot = tv_interval($start) * 1000;
  238. push( @headers, 'Server-Timing' => "file;dur=$tot" );
  239. return [ $code, \@headers, [$dfh] ];
  240. }
  241. $self->INFO("GET 403 $fullpath");
  242. return [ 403, [ $ct => $content_types{text} ], ["Forbidden"] ];
  243. }
  244. sub _range {
  245. my ( $self, $fullpath, $fh, $ranges, $sz, %headers ) = @_;
  246. # Set mode
  247. my $primary_ct = "Content-Type: $headers{'Content-type'}";
  248. my $is_multipart = scalar(@$ranges) > 1;
  249. if ($is_multipart) {
  250. $headers{'Content-type'} = "multipart/byteranges; boundary=$CHUNK_SEP";
  251. }
  252. my $code = 206;
  253. my $fc = '';
  254. # Calculate the content-length up-front. We have to fix unspecified lengths first, and reject bad requests.
  255. foreach my $range (@$ranges) {
  256. $range->[1] //= $sz - 1;
  257. $self->INFO("GET 416 $fullpath");
  258. return [ 416, [%headers], ["Requested range not satisfiable"] ] if $range->[0] > $sz || $range->[0] < 0 || $range->[1] < 0 || $range->[0] > $range->[1];
  259. }
  260. $headers{'Content-Length'} = List::Util::sum( map { my $arr = $_; $arr->[1] + 1, -$arr->[0] } @$ranges );
  261. #XXX Add the entity header lengths to the value - should hash-ify this to DRY
  262. if ($is_multipart) {
  263. foreach my $range (@$ranges) {
  264. $headers{'Content-Length'} += length("$fc--$CHUNK_SEP\n$primary_ct\nContent-Range: bytes $range->[0]-$range->[1]/$sz\n\n");
  265. $fc = "\n";
  266. }
  267. $headers{'Content-Length'} += length("\n--$CHUNK_SEP\--\n");
  268. $fc = '';
  269. }
  270. return sub {
  271. my $responder = shift;
  272. my $writer;
  273. foreach my $range (@$ranges) {
  274. $headers{'Content-Range'} = "bytes $range->[0]-$range->[1]/$sz" unless $is_multipart;
  275. $writer //= $responder->( [ $code, [%headers] ] );
  276. $writer->write("$fc--$CHUNK_SEP\n$primary_ct\nContent-Range: bytes $range->[0]-$range->[1]/$sz\n\n") if $is_multipart;
  277. $fc = "\n";
  278. my $len = List::Util::min( $sz, $range->[1] + 1 ) - $range->[0];
  279. $fh->seek( $range->[0], 0 );
  280. while ($len) {
  281. $fh->read( my $buf, List::Util::min( $len, $CHUNK_SIZE ) );
  282. $writer->write($buf);
  283. # Adjust for amount written
  284. $len = List::Util::max( $len - $CHUNK_SIZE, 0 );
  285. }
  286. }
  287. $fh->close();
  288. $writer->write("\n--$CHUNK_SEP\--\n") if $is_multipart;
  289. $writer->close;
  290. };
  291. }
  292. sub _generic {
  293. my ( $type, $code ) = @_;
  294. return [$code, [$ct => $content_types{html}], ["$type"]];
  295. }
  296. =head2 notfound, forbidden, badrequest, toolong, error
  297. If you need to return these HTTP errors, return these within a route:
  298. sub route {
  299. my ($self, $query) = @_;
  300. ...
  301. return $self->notfound($query);
  302. }
  303. =cut
  304. sub notfound {
  305. my ($self, $query, $body) = @_;
  306. $self->INFO("$query->{method} 404 $query->{fullpath}");
  307. $body //= 'Not Found';
  308. return _generic( $body, 404 );
  309. }
  310. sub forbidden {
  311. my ($self, $query, $body) = @_;
  312. $self->INFO("$query->{method} 403 $query->{fullpath}");
  313. $body //= 'Forbidden';
  314. return _generic( 'Forbidden', 403 );
  315. }
  316. sub badrequest {
  317. my ($self, $query, $body) = @_;
  318. $self->INFO("$query->{method} 400 $query->{fullpath}");
  319. $body //= 'Bad Request';
  320. return _generic( $body, 400 );
  321. }
  322. sub toolong {
  323. my ($self, $query, $body) = @_;
  324. $self->INFO("$query->{method} 419 $query->{fullpath}");
  325. $body //= 'URI too long';
  326. return _generic( $body, 419 );
  327. }
  328. sub error {
  329. my ($self, $query, $body) = @_;
  330. my $method = $query->{method} // "?";
  331. my $fp = $query->{fullpath} // "?";
  332. $body //= 'Internal Server Error';
  333. $self->INFO("$method 500 $fp");
  334. return _generic( $body, 500 );
  335. }
  336. sub unavailable {
  337. my ($self, $query, $body) = @_;
  338. $self->INFO("$query->{method} 503 $query->{fullpath}");
  339. $body //= 'Service Unavailable';
  340. return _generic( $body, 503 );
  341. }
  342. my %etags;
  343. my $domain;
  344. sub app {
  345. my $self = shift;
  346. # Start the server timing clock
  347. my $start = [gettimeofday];
  348. my $env = shift;
  349. # Discard the path used in the log, it's too long and enough 4xx error code = ban
  350. return $self->toolong({ method => $env->{REQUEST_METHOD}, fullpath => '...' }) if length( $env->{REQUEST_URI} ) > 2048;
  351. # Various stuff important for logging requests
  352. $domain //= eval { Sys::Hostname::hostname() } // $env->{HTTP_X_FORWARDED_HOST} || $env->{HTTP_HOST};
  353. my $path = $env->{PATH_INFO};
  354. my $port = $env->{HTTP_X_FORWARDED_PORT} // $env->{HTTP_PORT};
  355. my $pport = defined $port ? ":$port" : "";
  356. my $scheme = $env->{'psgi.url_scheme'} // 'http';
  357. my $method = $env->{REQUEST_METHOD};
  358. # It's important that we log what the user ACTUALLY requested rather than the rewritten path later on.
  359. my $fullpath = "$scheme://$domain$pport$path";
  360. # sigdie can now "do the right thing"
  361. $self->{cur_query} = { route => $path, fullpath => $path, method => $method };
  362. # Check eTags. If we don't know about it, just assume it's good and lazily fill the cache
  363. # XXX yes, this allows cache poisoning...but only for logged in users!
  364. if ( $env->{HTTP_IF_NONE_MATCH} ) {
  365. $self->INFO("$env->{REQUEST_METHOD} 304 $fullpath");
  366. return [ 304, [], [''] ] if $env->{HTTP_IF_NONE_MATCH} eq ( $etags{ $env->{REQUEST_URI} } || '' );
  367. $etags{ $env->{REQUEST_URI} } = $env->{HTTP_IF_NONE_MATCH} unless exists $etags{ $env->{REQUEST_URI} };
  368. }
  369. # TODO: Actually do something with the language passed to the renderer
  370. my $lang = $env->{HTTP_ACCEPT_LANGUAGE};
  371. #TODO: Actually do something with the acceptable output formats in the renderer
  372. my $accept = $env->{HTTP_ACCEPT};
  373. my $last_fetch = 0;
  374. if ( $env->{HTTP_IF_MODIFIED_SINCE} ) {
  375. $last_fetch = DateTime::Format::HTTP->parse_datetime( $env->{HTTP_IF_MODIFIED_SINCE} )->epoch();
  376. }
  377. # Figure out if we want compression or not
  378. my $alist = $env->{HTTP_ACCEPT_ENCODING} || '';
  379. $alist =~ s/\s//g;
  380. my @accept_encodings;
  381. @accept_encodings = split( /,/, $alist );
  382. my $deflate = grep { 'gzip' eq $_ } @accept_encodings;
  383. # Set the IP of the request so we can fail2ban
  384. $self->{ip} = $env->{HTTP_X_FORWARDED_FOR} || $env->{REMOTE_ADDR} || $self->{ip};
  385. my $streaming = $env->{'psgi.streaming'};
  386. # If we have an actual route, just use it.
  387. my $r = $self->routes;
  388. my $route_actual = $r->{$path};
  389. # Might be a regexed route.
  390. if (!$route_actual) {
  391. my $matched = List::Util::first { exists $r->{$_}{pattern} && $path =~ m/^$r->{$_}{pattern}$/ } keys(%$r);
  392. $route_actual = $r->{$matched} if $matched;
  393. }
  394. return $self->route( $route_actual, $env, $fullpath, $path, $start, $last_fetch, $deflate ) if $route_actual;
  395. # Do a case insensitive match, because osx and windows
  396. my $file_possible = $self->mangle_filename("www/$path");
  397. my $file_actual = $file_possible if -f $file_possible;
  398. # Dirindices
  399. if (-d $file_possible) {
  400. foreach my $index (@{$self->indices}) {
  401. next if $file_actual;
  402. my $dirindex = $self->mangle_filename("www$path/$index");
  403. $dirindex =~ s|//|/|g;
  404. $file_actual = $dirindex if -f $dirindex;
  405. }
  406. }
  407. my $file_is_cgi = appears_executable($file_actual);
  408. return $self->cgi( $env, $fullpath, $file_actual, $last_fetch, $deflate) if $file_is_cgi;
  409. $self->INFO("Attempting to serve $fullpath [".($file_possible // "")."]");
  410. my @ranges = parse_ranges($env);
  411. return $self->serve( $fullpath, $file_actual, $start, $streaming, \@ranges, $last_fetch, $deflate ) if $file_actual;
  412. return $self->notfound($self->{cur_query});
  413. }
  414. sub mangle_filename {
  415. my ($self,$path) = @_;
  416. # XXX yes, you can have case sensitive OSX, but basically nobody enables that ever
  417. $path = lc($path) if List::Util::any { $^O eq $_ } qw{darwin MSWin32 dos};
  418. $self->DEBUG("Path mangled to $path");
  419. return $path;
  420. }
  421. sub parse_ranges {
  422. my $env = shift;
  423. # Handle HTTP range/streaming requests
  424. my $range = $env->{HTTP_RANGE} || "bytes=0-" if $env->{HTTP_RANGE} || $env->{HTTP_IF_RANGE};
  425. my @ranges;
  426. if ($range) {
  427. $range =~ s/bytes=//g;
  428. push(
  429. @ranges,
  430. map {
  431. [ split( /-/, $_ ) ];
  432. } split( /,/, $range )
  433. );
  434. }
  435. return @ranges;
  436. }
  437. my @executable_extensions = qw{cgi sh exe pl php py};
  438. sub appears_executable {
  439. my $subj = shift;
  440. # Definitely not executable if it does not exist!
  441. return 0 unless $subj;
  442. return 0 unless -x $subj;
  443. my ($extension) = $subj =~ m/\.(\S+)$/;
  444. return 1 if !$extension;
  445. return 1 if grep { $extension eq $_ } @executable_extensions;
  446. return 0;
  447. }
  448. # Handle actual routes
  449. sub route {
  450. my ($self, $route, $env, $fullpath, $path, $start, $last_fetch, $deflate ) = @_;
  451. my $content_type = $env->{CONTENT_TYPE};
  452. # It is the responsibility of each route to respond to HEAD requests correctly
  453. return $self->badrequest($self->{cur_query}) unless List::Util::any { $_ eq $env->{REQUEST_METHOD} } ('HEAD', $route->{method});
  454. my $callback;
  455. if (exists $route->{callbacks}{'*'}) {
  456. $callback = $route->{callbacks}{'*'};
  457. } else {
  458. return $self->badrequest($self->{cur_query}) unless exists $route->{callbacks}{$content_type};
  459. $callback = $route->{callbacks}{$content_type};
  460. }
  461. # Provide static renders if available.
  462. my $streaming = $env->{'psgi.streaming'};
  463. return $self->static( $fullpath, "$fullpath.z", $start, $streaming ) if -f "statics/$fullpath.z" && $deflate;
  464. return $self->static( $fullpath, $fullpath, $start, $streaming ) if -f "statics/$fullpath";
  465. # Build the query data for passing to a route.
  466. # GET, POST, URI captures, then explicit data overrides.
  467. my $query = $self->extract_query($path, $route, $env);
  468. # allow this stuff to survive down to the end of some routes
  469. $query->{last_fetched} = $last_fetch;
  470. $query->{deflate} = $deflate;
  471. $query->{streaming} = $streaming;
  472. my @ranges = parse_ranges($env);
  473. $query->{ranges} = \@ranges;
  474. $query->{start} = $start;
  475. # Put things to tv_interval in here for Server-Timing
  476. $query->{fullpath} = $fullpath;
  477. $query->{method} = $route->{method};
  478. # This allows for better error handlers if we die in the route.
  479. $self->{cur_query} = $query;
  480. # Setup the CGI vars they expect IF requested
  481. local %ENV = (%ENV, CGI::Emulate::PSGI->emulate_environment($env)) if $route->{env};
  482. {
  483. my $output = $callback->($self, $query);
  484. # If it's streaming, just hand it off
  485. return $output if ref $output eq 'CODE';
  486. die "$fullpath returned no or malformed data!" unless ref $output eq 'ARRAY' && @$output == 3;
  487. my $pport = defined $query->{port} ? ":$query->{port}" : "";
  488. my %headers = @{$output->[1]};
  489. my $bytes = $headers{'Content-Length'} // '?';
  490. $self->INFO("$env->{REQUEST_METHOD} $output->[0] $bytes $fullpath");
  491. # Append server-timing headers if they aren't present
  492. my $tot = tv_interval($start) * 1000;
  493. push( @{ $output->[1] }, 'Server-Timing' => "app;dur=$tot" ) unless List::Util::any { $_ eq 'Server-Timing' } @{ $output->[1] };
  494. return $output;
  495. }
  496. }
  497. sub extract_query {
  498. my ($self, $path, $route, $env) = @_;
  499. my $query = URL::Encode::url_params_mixed( $env->{QUERY_STRING} ) if $env->{QUERY_STRING};
  500. #Actually parse the POSTDATA and dump it into the QUERY object if this is a POST
  501. if ( $env->{REQUEST_METHOD} eq 'POST' ) {
  502. my $body = HTTP::Body->new( $env->{CONTENT_TYPE}, $env->{CONTENT_LENGTH} );
  503. while ( $env->{'psgi.input'}->read( my $buf, $CHUNK_SIZE ) ) {
  504. $body->add($buf);
  505. }
  506. @$query{ keys( %{ $body->param } ) } = values( %{ $body->param } );
  507. @$query{ keys( %{ $body->upload } ) } = values( %{ $body->upload } );
  508. }
  509. if (ref $route->{captures} eq 'ARRAY') {
  510. my @captures = $path =~ m/^$route->{pattern}$/;
  511. @$query{@{$route->{captures}}} = @captures;
  512. }
  513. if (ref $route->{data} eq 'HASH') {
  514. @$query{keys(%{$route->{data}})} = values(%{$route->{data}});
  515. }
  516. return $query;
  517. }
  518. # Read until we are done with headers, then pass off the filehandle to PSGI for streaming.
  519. # TODO support compression
  520. sub cgi {
  521. my ( $self, $env, $fullpath, $file_actual, $last_fetch, $deflate) = @_;
  522. $self->INFO("Handoff $fullpath to $file_actual for cgi exec");
  523. # Setup the CGI vars they expect
  524. local %ENV = (%ENV, CGI::Emulate::PSGI->emulate_environment($env));
  525. my $pid = open(my $out, '-|', "$file_actual");
  526. my ($code, %headers) = extract_headers($out, $last_fetch);
  527. $code //= 500;
  528. return sub {
  529. my $responder = shift;
  530. my $writer = $responder->( [ $code, [%headers] ] );
  531. while ( $out->read( my $buf, $CHUNK_SIZE ) ) {
  532. $writer->write($buf);
  533. }
  534. $writer->close;
  535. # Wait on the CGI script to do whatever it's doing after closing stdout
  536. close $out;
  537. waitpid($pid, 0);
  538. };
  539. }
  540. sub stream_raw_http {
  541. my ($self, $data, $output, $last_fetch, $to_fork, $callback) = @_;
  542. open(my $out, '+<', undef) or die "I couldn't open anon filehandle, which can only happen if you don't compile perl with PerlIO";
  543. $out->autoflush(1);
  544. print $out $output;
  545. my $pid = _fork($to_fork, $out);
  546. # If we can't emit headers within ~250ms something's wrong
  547. my $timeout = 250 * 1000;
  548. my ($code,%headers);
  549. for (0..$timeout) {
  550. seek($out, 0,0);
  551. ($code, %headers) = extract_headers($out, $last_fetch, 1);
  552. usleep 1 unless %headers;
  553. last if %headers;
  554. }
  555. die "Failed to emit headers within timeout" unless %headers;
  556. # Append server-timing headers
  557. $self->checkpoint($data, 'emitHeader');
  558. $headers{'Server-Timing'} = $self->build_server_timing($data);
  559. $code //= 500;
  560. $self->INFO("$self->{cur_query}{method} $code $self->{cur_query}{fullpath}");
  561. # If the page doesn't load within 30 seconds, don't load it
  562. $timeout = 3000000;
  563. return sub {
  564. my $responder = shift;
  565. my $writer = $responder->( [ $code, [%headers] ] );
  566. my $SEEK_SET = $out->tell();
  567. for (0..$timeout) {
  568. $out->seek($SEEK_SET, 0);
  569. $out->read( my $buf, $CHUNK_SIZE );
  570. $writer->write($buf);
  571. #If we read anything, advance the pointer
  572. $SEEK_SET = $out->tell() if $buf;
  573. last if waitpid($pid, 1) > 0;
  574. usleep 1000;
  575. }
  576. $writer->close;
  577. close($out);
  578. waitpid($pid, 0);
  579. $self->INFO("Response written in ".(tv_interval($data->{start}))." s");
  580. # Wait on the script to do whatever it's doing after closing stdout
  581. $callback->() if ref $callback eq 'CODE';
  582. };
  583. }
  584. sub _fork {
  585. my ($callback, $fh) = @_;
  586. select $fh;
  587. $|=1;
  588. my $pid = fork();
  589. die "Could not fork child" unless defined $pid;
  590. if ($pid == 0) {
  591. $callback->();
  592. exit 0;
  593. }
  594. select STDOUT;
  595. return $pid;
  596. }
  597. =head2 extract_headers($fh, $last_fetch)
  598. Extract the headers from a filehandle. Set the 'Last Modified' header appropriately based on the output of `stat` on the filehandle.
  599. Returns a code and parsed headers hash. Code will be 304 if the file hasn't changed since $last_fetch, otherwise will be the code in the parsed headers.
  600. =cut
  601. sub extract_headers {
  602. my ($fh, $last_fetch, $is_ref) = @_;
  603. my $headers = '';
  604. # NOTE: this is relying on while advancing the file pointer
  605. while (<$fh>) {
  606. last if $_ eq "\n";
  607. $headers .= $_;
  608. }
  609. my ( undef, undef, $status, undef, $headers_parsed ) = HTTP::Parser::XS::parse_http_response( "$headers\n", HEADERS_AS_HASHREF );
  610. my $code = $status // 200;
  611. $headers_parsed //= {};
  612. if (!$is_ref) {
  613. my $mt = ( stat($fh) )[9];
  614. my @gm = gmtime($mt);
  615. my $now_string = strftime( "%a, %d %b %Y %H:%M:%S GMT", @gm );
  616. $code = $mt > $last_fetch ? $status : 304;
  617. $headers_parsed->{"Last-Modified"} = $now_string;
  618. }
  619. return ($code, %$headers_parsed);
  620. }
  621. sub static {
  622. my ( $self, $fullpath, $path, $start, $streaming, $last_fetch ) = @_;
  623. $self->DEBUG("Rendering static for $path");
  624. # XXX because of psgi I can't just vomit the file directly
  625. if ( open( my $fh, '<', "statics/$path" ) ) {
  626. my ($code, $headers_parsed) = (200, {});
  627. ($code, %$headers_parsed) = extract_headers($fh, $last_fetch );
  628. # Append server-timing headers
  629. my $tot = tv_interval($start) * 1000;
  630. $headers_parsed->{'Server-Timing'} = "static;dur=$tot";
  631. #XXX uwsgi just opens the file *again* when we already have a filehandle if it has a path.
  632. # starman by comparison doesn't violate the principle of least astonishment here.
  633. # This is probably a performance optimization, but makes the kind of micromanagement I need to do inconvenient.
  634. # As such, we will just return a stream.
  635. $self->INFO("GET 200 $headers_parsed->{'Content-Length'} $fullpath");
  636. return sub {
  637. my $responder = shift;
  638. #push(@headers, 'Content-Length' => $sz);
  639. my $writer = $responder->( [ $code, [%$headers_parsed] ] );
  640. while ( $fh->read( my $buf, $CHUNK_SIZE ) ) {
  641. $writer->write($buf);
  642. }
  643. close $fh;
  644. $writer->close;
  645. }
  646. if $streaming;
  647. return [ $code, [%$headers_parsed], $fh ];
  648. }
  649. return $self->forbidden($self->{current_query});
  650. }
  651. sub get_config {
  652. my %options = (
  653. verbose => 0,
  654. custom_log => undef,
  655. routers => [],
  656. loggers => [],
  657. auth => undef,
  658. domain => '',
  659. user => '',
  660. );
  661. $ENV{HOME} ||= Cwd::getcwd();
  662. my $config_file = "$ENV{HOME}/.tpsgi.ini";
  663. if (-f $config_file) {
  664. my $conf = Config::Simple->new($config_file);
  665. my %config;
  666. %config = %{$conf->param(-block => 'default')} if $conf;
  667. # Merge the configuration with the options
  668. foreach my $opt (keys(%options)) {
  669. if ( ref $options{$opt} eq 'ARRAY' ) {
  670. next unless exists $config{$opt};
  671. my @arrayed = ref $config{$opt} eq 'ARRAY' ? @{$config{$opt}} : ($config{$opt});
  672. push(@{$options{$opt}}, @arrayed);
  673. next;
  674. }
  675. $options{$opt} = $config{$opt} if exists $config{$opt};
  676. }
  677. }
  678. return %options;
  679. }
  680. # Convenience method to keep track of server-timing
  681. sub checkpoint {
  682. my ($self, $data, $name) = @_;
  683. $data->{checkpoints} //= [[ start => $data->{start} ]];
  684. push(@{$data->{checkpoints}}, [ $name => [gettimeofday] ]);
  685. }
  686. sub build_server_timing {
  687. my ($self, $data) = @_;
  688. my @st;
  689. my $last_interval;
  690. foreach my $checkpoint (@{$data->{checkpoints}}) {
  691. if ($last_interval) {
  692. my $dur = tv_interval($last_interval, $checkpoint->[1]) * 1000;
  693. push(@st, "$checkpoint->[0];dur=$dur");
  694. }
  695. $last_interval = $checkpoint->[1];
  696. }
  697. my $tot = tv_interval($data->{start}) * 1000;
  698. push(@st, "tot;dur=$tot");
  699. return join(', ', @st);
  700. }
  701. 1;