TPSGI.pm 27 KB

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