TPSGI.pm 28 KB

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