TPSGI.pm 30 KB

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